[deliverable/linux.git] / include / linux / serial.h

/*
 * include/linux/serial.h
 *
 * Copyright (C) 1992 by Theodore Ts'o.
 * 
 * Redistribution of this file is permitted under the terms of the GNU 
 * Public License (GPL)
 */

#ifndef _LINUX_SERIAL_H
#define _LINUX_SERIAL_H

#ifdef __KERNEL__
#include <linux/types.h>
#include <asm/page.h>

/*
 * Counters of the input lines (CTS, DSR, RI, CD) interrupts
 */

struct async_icount {
	__u32	cts, dsr, rng, dcd, tx, rx;
	__u32	frame, parity, overrun, brk;
	__u32	buf_overrun;
};

/*
 * The size of the serial xmit buffer is 1 page, or 4096 bytes
 */
#define SERIAL_XMIT_SIZE PAGE_SIZE

#endif

struct serial_struct {
	int	type;
	int	line;
	unsigned int	port;
	int	irq;
	int	flags;
	int	xmit_fifo_size;
	int	custom_divisor;
	int	baud_base;
	unsigned short	close_delay;
	char	io_type;
	char	reserved_char[1];
	int	hub6;
	unsigned short	closing_wait; /* time to wait before closing */
	unsigned short	closing_wait2; /* no longer used... */
	unsigned char	*iomem_base;
	unsigned short	iomem_reg_shift;
	unsigned int	port_high;
	unsigned long	iomap_base;	/* cookie passed into ioremap */
};

/*
 * For the close wait times, 0 means wait forever for serial port to
 * flush its output.  65535 means don't wait at all.
 */
#define ASYNC_CLOSING_WAIT_INF	0
#define ASYNC_CLOSING_WAIT_NONE	65535

/*
 * These are the supported serial types.
 */
#define PORT_UNKNOWN	0
#define PORT_8250	1
#define PORT_16450	2
#define PORT_16550	3
#define PORT_16550A	4
#define PORT_CIRRUS     5	/* usurped by cyclades.c */
#define PORT_16650	6
#define PORT_16650V2	7
#define PORT_16750	8
#define PORT_STARTECH	9	/* usurped by cyclades.c */
#define PORT_16C950	10	/* Oxford Semiconductor */
#define PORT_16654	11
#define PORT_16850	12
#define PORT_RSA	13	/* RSA-DV II/S card */
#define PORT_MAX	13

#define SERIAL_IO_PORT	0
#define SERIAL_IO_HUB6	1
#define SERIAL_IO_MEM	2

struct serial_uart_config {
	char	*name;
	int	dfl_xmit_fifo_size;
	int	flags;
};

#define UART_CLEAR_FIFO		0x01
#define UART_USE_FIFO		0x02
#define UART_STARTECH		0x04
#define UART_NATSEMI		0x08

/*
 * Definitions for async_struct (and serial_struct) flags field
 */
#define ASYNC_HUP_NOTIFY 0x0001 /* Notify getty on hangups and closes 
				   on the callout port */
#define ASYNC_FOURPORT  0x0002	/* Set OU1, OUT2 per AST Fourport settings */
#define ASYNC_SAK	0x0004	/* Secure Attention Key (Orange book) */
#define ASYNC_SPLIT_TERMIOS 0x0008 /* Separate termios for dialin/callout */

#define ASYNC_SPD_MASK	0x1030
#define ASYNC_SPD_HI	0x0010	/* Use 56000 instead of 38400 bps */

#define ASYNC_SPD_VHI	0x0020  /* Use 115200 instead of 38400 bps */
#define ASYNC_SPD_CUST	0x0030  /* Use user-specified divisor */

#define ASYNC_SKIP_TEST	0x0040 /* Skip UART test during autoconfiguration */
#define ASYNC_AUTO_IRQ  0x0080 /* Do automatic IRQ during autoconfiguration */
#define ASYNC_SESSION_LOCKOUT 0x0100 /* Lock out cua opens based on session */
#define ASYNC_PGRP_LOCKOUT    0x0200 /* Lock out cua opens based on pgrp */
#define ASYNC_CALLOUT_NOHUP   0x0400 /* Don't do hangups for cua device */

#define ASYNC_HARDPPS_CD	0x0800	/* Call hardpps when CD goes high  */

#define ASYNC_SPD_SHI	0x1000	/* Use 230400 instead of 38400 bps */
#define ASYNC_SPD_WARP	0x1010	/* Use 460800 instead of 38400 bps */

#define ASYNC_LOW_LATENCY 0x2000 /* Request low latency behaviour */

#define ASYNC_BUGGY_UART  0x4000 /* This is a buggy UART, skip some safety
				  * checks.  Note: can be dangerous! */

#define ASYNC_AUTOPROBE	 0x8000 /* Port was autoprobed by PCI or PNP code */

#define ASYNC_FLAGS	0x7FFF	/* Possible legal async flags */
#define ASYNC_USR_MASK	0x3430	/* Legal flags that non-privileged
				 * users can set or reset */

/* Internal flags used only by kernel/chr_drv/serial.c */
#define ASYNC_INITIALIZED	0x80000000 /* Serial port was initialized */
#define ASYNC_NORMAL_ACTIVE	0x20000000 /* Normal device is active */
#define ASYNC_BOOT_AUTOCONF	0x10000000 /* Autoconfigure port on bootup */
#define ASYNC_CLOSING		0x08000000 /* Serial port is closing */
#define ASYNC_CTS_FLOW		0x04000000 /* Do CTS flow control */
#define ASYNC_CHECK_CD		0x02000000 /* i.e., CLOCAL */
#define ASYNC_SHARE_IRQ		0x01000000 /* for multifunction cards
					     --- no longer used */
#define ASYNC_CONS_FLOW		0x00800000 /* flow control for console  */

#define ASYNC_BOOT_ONLYMCA	0x00400000 /* Probe only if MCA bus */
#define ASYNC_INTERNAL_FLAGS	0xFFC00000 /* Internal flags */

/*
 * Multiport serial configuration structure --- external structure
 */
struct serial_multiport_struct {
	int		irq;
	int		port1;
	unsigned char	mask1, match1;
	int		port2;
	unsigned char	mask2, match2;
	int		port3;
	unsigned char	mask3, match3;
	int		port4;
	unsigned char	mask4, match4;
	int		port_monitor;
	int	reserved[32];
};

/*
 * Serial input interrupt line counters -- external structure
 * Four lines can interrupt: CTS, DSR, RI, DCD
 */
struct serial_icounter_struct {
	int cts, dsr, rng, dcd;
	int rx, tx;
	int frame, overrun, parity, brk;
	int buf_overrun;
	int reserved[9];
};

/*
 * Serial interface for controlling RS485 settings on chips with suitable
 * support. Set with TIOCSRS485 and get with TIOCGRS485 if supported by your
 * platform. The set function returns the new state, with any unsupported bits
 * reverted appropriately.
 */

struct serial_rs485 {
	__u32	flags;			/* RS485 feature flags */
#define SER_RS485_ENABLED		(1 << 0)
#define SER_RS485_RTS_ON_SEND		(1 << 1)
#define SER_RS485_RTS_AFTER_SEND	(1 << 2)
	__u32	delay_rts_before_send;	/* Milliseconds */
	__u32	padding[6];		/* Memory is cheap, new structs
					   are a royal PITA .. */
};

#ifdef __KERNEL__
#include <linux/compiler.h>

#endif /* __KERNEL__ */
#endif /* _LINUX_SERIAL_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* include/linux/serial.h
	3	*
	4	* Copyright (C) 1992 by Theodore Ts'o.
	5	*
	6	* Redistribution of this file is permitted under the terms of the GNU
	7	* Public License (GPL)
	8	*/
	9
	10	#ifndef _LINUX_SERIAL_H
	11	#define _LINUX_SERIAL_H
	12
	13	#ifdef __KERNEL__
4e57b681	14	#include <linux/types.h>
1da177e4 LT	15	#include <asm/page.h>
	16
	17	/*
	18	* Counters of the input lines (CTS, DSR, RI, CD) interrupts
	19	*/
	20
	21	struct async_icount {
	22	__u32 cts, dsr, rng, dcd, tx, rx;
	23	__u32 frame, parity, overrun, brk;
	24	__u32 buf_overrun;
	25	};
	26
	27	/*
	28	* The size of the serial xmit buffer is 1 page, or 4096 bytes
	29	*/
	30	#define SERIAL_XMIT_SIZE PAGE_SIZE
	31
	32	#endif
	33
	34	struct serial_struct {
	35	int type;
	36	int line;
	37	unsigned int port;
	38	int irq;
	39	int flags;
	40	int xmit_fifo_size;
	41	int custom_divisor;
	42	int baud_base;
	43	unsigned short close_delay;
	44	char io_type;
	45	char reserved_char[1];
	46	int hub6;
	47	unsigned short closing_wait; /* time to wait before closing */
	48	unsigned short closing_wait2; /* no longer used... */
	49	unsigned char *iomem_base;
	50	unsigned short iomem_reg_shift;
	51	unsigned int port_high;
	52	unsigned long iomap_base; /* cookie passed into ioremap */
	53	};
	54
	55	/*
	56	* For the close wait times, 0 means wait forever for serial port to
	57	* flush its output. 65535 means don't wait at all.
	58	*/
	59	#define ASYNC_CLOSING_WAIT_INF 0
	60	#define ASYNC_CLOSING_WAIT_NONE 65535
	61
	62	/*
	63	* These are the supported serial types.
	64	*/
	65	#define PORT_UNKNOWN 0
	66	#define PORT_8250 1
	67	#define PORT_16450 2
	68	#define PORT_16550 3
	69	#define PORT_16550A 4
	70	#define PORT_CIRRUS 5 /* usurped by cyclades.c */
	71	#define PORT_16650 6
	72	#define PORT_16650V2 7
	73	#define PORT_16750 8
	74	#define PORT_STARTECH 9 /* usurped by cyclades.c */
	75	#define PORT_16C950 10 /* Oxford Semiconductor */
	76	#define PORT_16654 11
	77	#define PORT_16850 12
	78	#define PORT_RSA 13 /* RSA-DV II/S card */
79	#define PORT_MAX 13
80
81	#define SERIAL_IO_PORT 0
82	#define SERIAL_IO_HUB6 1
83	#define SERIAL_IO_MEM 2
84
85	struct serial_uart_config {
86	char *name;
87	int dfl_xmit_fifo_size;
88	int flags;
89	};
90
91	#define UART_CLEAR_FIFO 0x01
92	#define UART_USE_FIFO 0x02
93	#define UART_STARTECH 0x04
94	#define UART_NATSEMI 0x08
95
96	/*
97	* Definitions for async_struct (and serial_struct) flags field
98	*/
99	#define ASYNC_HUP_NOTIFY 0x0001 /* Notify getty on hangups and closes
100	on the callout port */
101	#define ASYNC_FOURPORT 0x0002 /* Set OU1, OUT2 per AST Fourport settings */
102	#define ASYNC_SAK 0x0004 /* Secure Attention Key (Orange book) */
103	#define ASYNC_SPLIT_TERMIOS 0x0008 /* Separate termios for dialin/callout */
104
105	#define ASYNC_SPD_MASK 0x1030
106	#define ASYNC_SPD_HI 0x0010 /* Use 56000 instead of 38400 bps */
107
108	#define ASYNC_SPD_VHI 0x0020 /* Use 115200 instead of 38400 bps */
109	#define ASYNC_SPD_CUST 0x0030 /* Use user-specified divisor */
110
111	#define ASYNC_SKIP_TEST 0x0040 /* Skip UART test during autoconfiguration */
112	#define ASYNC_AUTO_IRQ 0x0080 /* Do automatic IRQ during autoconfiguration */
113	#define ASYNC_SESSION_LOCKOUT 0x0100 /* Lock out cua opens based on session */
114	#define ASYNC_PGRP_LOCKOUT 0x0200 /* Lock out cua opens based on pgrp */
115	#define ASYNC_CALLOUT_NOHUP 0x0400 /* Don't do hangups for cua device */
116
117	#define ASYNC_HARDPPS_CD 0x0800 /* Call hardpps when CD goes high */
118
119	#define ASYNC_SPD_SHI 0x1000 /* Use 230400 instead of 38400 bps */
120	#define ASYNC_SPD_WARP 0x1010 /* Use 460800 instead of 38400 bps */
121
122	#define ASYNC_LOW_LATENCY 0x2000 /* Request low latency behaviour */
123
124	#define ASYNC_BUGGY_UART 0x4000 /* This is a buggy UART, skip some safety
125	* checks. Note: can be dangerous! */
126
127	#define ASYNC_AUTOPROBE 0x8000 /* Port was autoprobed by PCI or PNP code */
128
129	#define ASYNC_FLAGS 0x7FFF /* Possible legal async flags */
130	#define ASYNC_USR_MASK 0x3430 /* Legal flags that non-privileged
131	* users can set or reset */
132
133	/* Internal flags used only by kernel/chr_drv/serial.c */
134	#define ASYNC_INITIALIZED 0x80000000 /* Serial port was initialized */
135	#define ASYNC_NORMAL_ACTIVE 0x20000000 /* Normal device is active */
136	#define ASYNC_BOOT_AUTOCONF 0x10000000 /* Autoconfigure port on bootup */
137	#define ASYNC_CLOSING 0x08000000 /* Serial port is closing */
138	#define ASYNC_CTS_FLOW 0x04000000 /* Do CTS flow control */
139	#define ASYNC_CHECK_CD 0x02000000 /* i.e., CLOCAL */
140	#define ASYNC_SHARE_IRQ 0x01000000 /* for multifunction cards
141	--- no longer used */
142	#define ASYNC_CONS_FLOW 0x00800000 /* flow control for console */
143
144	#define ASYNC_BOOT_ONLYMCA 0x00400000 /* Probe only if MCA bus */
145	#define ASYNC_INTERNAL_FLAGS 0xFFC00000 /* Internal flags */
146
147	/*
148	* Multiport serial configuration structure --- external structure
149	*/
150	struct serial_multiport_struct {
151	int irq;
152	int port1;
153	unsigned char mask1, match1;
154	int port2;
155	unsigned char mask2, match2;
156	int port3;
157	unsigned char mask3, match3;
158	int port4;
159	unsigned char mask4, match4;
160	int port_monitor;
161	int reserved[32];
162	};
163
164	/*
165	* Serial input interrupt line counters -- external structure
166	* Four lines can interrupt: CTS, DSR, RI, DCD
167	*/
168	struct serial_icounter_struct {
169	int cts, dsr, rng, dcd;
170	int rx, tx;
171	int frame, overrun, parity, brk;
172	int buf_overrun;
173	int reserved[9];
174	};
175
c26c56c0 AC	176	/*
	177	* Serial interface for controlling RS485 settings on chips with suitable
	178	* support. Set with TIOCSRS485 and get with TIOCGRS485 if supported by your
	179	* platform. The set function returns the new state, with any unsupported bits
	180	* reverted appropriately.
	181	*/
	182
	183	struct serial_rs485 {
	184	__u32 flags; /* RS485 feature flags */
	185	#define SER_RS485_ENABLED (1 << 0)
	186	#define SER_RS485_RTS_ON_SEND (1 << 1)
	187	#define SER_RS485_RTS_AFTER_SEND (1 << 2)
	188	__u32 delay_rts_before_send; /* Milliseconds */
	189	__u32 padding[6]; /* Memory is cheap, new structs
	190	are a royal PITA .. */
	191	};
1da177e4 LT	192
1da177e4 LT	193	#ifdef __KERNEL__
661f83a6 RK	194	#include <linux/compiler.h>
661f83a6 RK	195
1da177e4 LT	196	#endif /* __KERNEL__ */
1da177e4 LT	197	#endif /* _LINUX_SERIAL_H */