headers: move module_bug_finalize()/module_bug_cleanup() definitions into module.h
[linux-2.6] / include / linux / serial.h
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 #include <linux/types.h>
14
15 #ifdef __KERNEL__
16 #include <asm/page.h>
17
18 /*
19  * Counters of the input lines (CTS, DSR, RI, CD) interrupts
20  */
21
22 struct async_icount {
23         __u32   cts, dsr, rng, dcd, tx, rx;
24         __u32   frame, parity, overrun, brk;
25         __u32   buf_overrun;
26 };
27
28 /*
29  * The size of the serial xmit buffer is 1 page, or 4096 bytes
30  */
31 #define SERIAL_XMIT_SIZE PAGE_SIZE
32
33 #endif
34
35 struct serial_struct {
36         int     type;
37         int     line;
38         unsigned int    port;
39         int     irq;
40         int     flags;
41         int     xmit_fifo_size;
42         int     custom_divisor;
43         int     baud_base;
44         unsigned short  close_delay;
45         char    io_type;
46         char    reserved_char[1];
47         int     hub6;
48         unsigned short  closing_wait; /* time to wait before closing */
49         unsigned short  closing_wait2; /* no longer used... */
50         unsigned char   *iomem_base;
51         unsigned short  iomem_reg_shift;
52         unsigned int    port_high;
53         unsigned long   iomap_base;     /* cookie passed into ioremap */
54 };
55
56 /*
57  * For the close wait times, 0 means wait forever for serial port to
58  * flush its output.  65535 means don't wait at all.
59  */
60 #define ASYNC_CLOSING_WAIT_INF  0
61 #define ASYNC_CLOSING_WAIT_NONE 65535
62
63 /*
64  * These are the supported serial types.
65  */
66 #define PORT_UNKNOWN    0
67 #define PORT_8250       1
68 #define PORT_16450      2
69 #define PORT_16550      3
70 #define PORT_16550A     4
71 #define PORT_CIRRUS     5       /* usurped by cyclades.c */
72 #define PORT_16650      6
73 #define PORT_16650V2    7
74 #define PORT_16750      8
75 #define PORT_STARTECH   9       /* usurped by cyclades.c */
76 #define PORT_16C950     10      /* Oxford Semiconductor */
77 #define PORT_16654      11
78 #define PORT_16850      12
79 #define PORT_RSA        13      /* RSA-DV II/S card */
80 #define PORT_MAX        13
81
82 #define SERIAL_IO_PORT  0
83 #define SERIAL_IO_HUB6  1
84 #define SERIAL_IO_MEM   2
85
86 struct serial_uart_config {
87         char    *name;
88         int     dfl_xmit_fifo_size;
89         int     flags;
90 };
91
92 #define UART_CLEAR_FIFO         0x01
93 #define UART_USE_FIFO           0x02
94 #define UART_STARTECH           0x04
95 #define UART_NATSEMI            0x08
96
97 /*
98  * Definitions for async_struct (and serial_struct) flags field
99  *
100  * Define ASYNCB_* for convenient use with {test,set,clear}_bit.
101  */
102 #define ASYNCB_HUP_NOTIFY        0 /* Notify getty on hangups and closes
103                                     * on the callout port */
104 #define ASYNCB_FOURPORT          1 /* Set OU1, OUT2 per AST Fourport settings */
105 #define ASYNCB_SAK               2 /* Secure Attention Key (Orange book) */
106 #define ASYNCB_SPLIT_TERMIOS     3 /* Separate termios for dialin/callout */
107 #define ASYNCB_SPD_HI            4 /* Use 56000 instead of 38400 bps */
108 #define ASYNCB_SPD_VHI           5 /* Use 115200 instead of 38400 bps */
109 #define ASYNCB_SKIP_TEST         6 /* Skip UART test during autoconfiguration */
110 #define ASYNCB_AUTO_IRQ          7 /* Do automatic IRQ during
111                                     * autoconfiguration */
112 #define ASYNCB_SESSION_LOCKOUT   8 /* Lock out cua opens based on session */
113 #define ASYNCB_PGRP_LOCKOUT      9 /* Lock out cua opens based on pgrp */
114 #define ASYNCB_CALLOUT_NOHUP    10 /* Don't do hangups for cua device */
115 #define ASYNCB_HARDPPS_CD       11 /* Call hardpps when CD goes high  */
116 #define ASYNCB_SPD_SHI          12 /* Use 230400 instead of 38400 bps */
117 #define ASYNCB_LOW_LATENCY      13 /* Request low latency behaviour */
118 #define ASYNCB_BUGGY_UART       14 /* This is a buggy UART, skip some safety
119                                     * checks.  Note: can be dangerous! */
120 #define ASYNCB_AUTOPROBE        15 /* Port was autoprobed by PCI or PNP code */
121 #define ASYNCB_LAST_USER        15
122
123 /* Internal flags used only by kernel */
124 #define ASYNCB_INITIALIZED      31 /* Serial port was initialized */
125 #define ASYNCB_NORMAL_ACTIVE    29 /* Normal device is active */
126 #define ASYNCB_BOOT_AUTOCONF    28 /* Autoconfigure port on bootup */
127 #define ASYNCB_CLOSING          27 /* Serial port is closing */
128 #define ASYNCB_CTS_FLOW         26 /* Do CTS flow control */
129 #define ASYNCB_CHECK_CD         25 /* i.e., CLOCAL */
130 #define ASYNCB_SHARE_IRQ        24 /* for multifunction cards, no longer used */
131 #define ASYNCB_CONS_FLOW        23 /* flow control for console  */
132 #define ASYNCB_BOOT_ONLYMCA     22 /* Probe only if MCA bus */
133 #define ASYNCB_FIRST_KERNEL     22
134
135 #define ASYNC_HUP_NOTIFY        (1U << ASYNCB_HUP_NOTIFY)
136 #define ASYNC_FOURPORT          (1U << ASYNCB_FOURPORT)
137 #define ASYNC_SAK               (1U << ASYNCB_SAK)
138 #define ASYNC_SPLIT_TERMIOS     (1U << ASYNCB_SPLIT_TERMIOS)
139 #define ASYNC_SPD_HI            (1U << ASYNCB_SPD_HI)
140 #define ASYNC_SPD_VHI           (1U << ASYNCB_SPD_VHI)
141 #define ASYNC_SKIP_TEST         (1U << ASYNCB_SKIP_TEST)
142 #define ASYNC_AUTO_IRQ          (1U << ASYNCB_AUTO_IRQ)
143 #define ASYNC_SESSION_LOCKOUT   (1U << ASYNCB_SESSION_LOCKOUT)
144 #define ASYNC_PGRP_LOCKOUT      (1U << ASYNCB_PGRP_LOCKOUT)
145 #define ASYNC_CALLOUT_NOHUP     (1U << ASYNCB_CALLOUT_NOHUP)
146 #define ASYNC_HARDPPS_CD        (1U << ASYNCB_HARDPPS_CD)
147 #define ASYNC_SPD_SHI           (1U << ASYNCB_SPD_SHI)
148 #define ASYNC_LOW_LATENCY       (1U << ASYNCB_LOW_LATENCY)
149 #define ASYNC_BUGGY_UART        (1U << ASYNCB_BUGGY_UART)
150 #define ASYNC_AUTOPROBE         (1U << ASYNCB_AUTOPROBE)
151
152 #define ASYNC_FLAGS             ((1U << ASYNCB_LAST_USER) - 1)
153 #define ASYNC_USR_MASK          (ASYNC_SPD_HI|ASYNC_SPD_VHI| \
154                 ASYNC_CALLOUT_NOHUP|ASYNC_SPD_SHI|ASYNC_LOW_LATENCY)
155 #define ASYNC_SPD_CUST          (ASYNC_SPD_HI|ASYNC_SPD_VHI)
156 #define ASYNC_SPD_WARP          (ASYNC_SPD_HI|ASYNC_SPD_SHI)
157 #define ASYNC_SPD_MASK          (ASYNC_SPD_HI|ASYNC_SPD_VHI|ASYNC_SPD_SHI)
158
159 #define ASYNC_INITIALIZED       (1U << ASYNCB_INITIALIZED)
160 #define ASYNC_NORMAL_ACTIVE     (1U << ASYNCB_NORMAL_ACTIVE)
161 #define ASYNC_BOOT_AUTOCONF     (1U << ASYNCB_BOOT_AUTOCONF)
162 #define ASYNC_CLOSING           (1U << ASYNCB_CLOSING)
163 #define ASYNC_CTS_FLOW          (1U << ASYNCB_CTS_FLOW)
164 #define ASYNC_CHECK_CD          (1U << ASYNCB_CHECK_CD)
165 #define ASYNC_SHARE_IRQ         (1U << ASYNCB_SHARE_IRQ)
166 #define ASYNC_CONS_FLOW         (1U << ASYNCB_CONS_FLOW)
167 #define ASYNC_BOOT_ONLYMCA      (1U << ASYNCB_BOOT_ONLYMCA)
168 #define ASYNC_INTERNAL_FLAGS    (~((1U << ASYNCB_FIRST_KERNEL) - 1))
169
170 /*
171  * Multiport serial configuration structure --- external structure
172  */
173 struct serial_multiport_struct {
174         int             irq;
175         int             port1;
176         unsigned char   mask1, match1;
177         int             port2;
178         unsigned char   mask2, match2;
179         int             port3;
180         unsigned char   mask3, match3;
181         int             port4;
182         unsigned char   mask4, match4;
183         int             port_monitor;
184         int     reserved[32];
185 };
186
187 /*
188  * Serial input interrupt line counters -- external structure
189  * Four lines can interrupt: CTS, DSR, RI, DCD
190  */
191 struct serial_icounter_struct {
192         int cts, dsr, rng, dcd;
193         int rx, tx;
194         int frame, overrun, parity, brk;
195         int buf_overrun;
196         int reserved[9];
197 };
198
199 /*
200  * Serial interface for controlling RS485 settings on chips with suitable
201  * support. Set with TIOCSRS485 and get with TIOCGRS485 if supported by your
202  * platform. The set function returns the new state, with any unsupported bits
203  * reverted appropriately.
204  */
205
206 struct serial_rs485 {
207         __u32   flags;                  /* RS485 feature flags */
208 #define SER_RS485_ENABLED               (1 << 0)
209 #define SER_RS485_RTS_ON_SEND           (1 << 1)
210 #define SER_RS485_RTS_AFTER_SEND        (1 << 2)
211         __u32   delay_rts_before_send;  /* Milliseconds */
212         __u32   padding[6];             /* Memory is cheap, new structs
213                                            are a royal PITA .. */
214 };
215
216 #ifdef __KERNEL__
217 #include <linux/compiler.h>
218
219 #endif /* __KERNEL__ */
220 #endif /* _LINUX_SERIAL_H */