[PATCH] serial_core whitespace fix
[linux-2.6.git] / include / linux / serial_core.h
1 /*
2  *  linux/drivers/char/serial_core.h
3  *
4  *  Copyright (C) 2000 Deep Blue Solutions Ltd.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20 #ifndef LINUX_SERIAL_CORE_H
21 #define LINUX_SERIAL_CORE_H
22
23 /*
24  * The type definitions.  These are from Ted Ts'o's serial.h
25  */
26 #define PORT_UNKNOWN    0
27 #define PORT_8250       1
28 #define PORT_16450      2
29 #define PORT_16550      3
30 #define PORT_16550A     4
31 #define PORT_CIRRUS     5
32 #define PORT_16650      6
33 #define PORT_16650V2    7
34 #define PORT_16750      8
35 #define PORT_STARTECH   9
36 #define PORT_16C950     10
37 #define PORT_16654      11
38 #define PORT_16850      12
39 #define PORT_RSA        13
40 #define PORT_NS16550A   14
41 #define PORT_XSCALE     15
42 #define PORT_MAX_8250   15      /* max port ID */
43
44 /*
45  * ARM specific type numbers.  These are not currently guaranteed
46  * to be implemented, and will change in the future.  These are
47  * separate so any additions to the old serial.c that occur before
48  * we are merged can be easily merged here.
49  */
50 #define PORT_PXA        31
51 #define PORT_AMBA       32
52 #define PORT_CLPS711X   33
53 #define PORT_SA1100     34
54 #define PORT_UART00     35
55 #define PORT_21285      37
56
57 /* Sparc type numbers.  */
58 #define PORT_SUNZILOG   38
59 #define PORT_SUNSAB     39
60
61 /* NEC v850.  */
62 #define PORT_V850E_UART 40
63
64 /* DZ */
65 #define PORT_DZ         47
66
67 /* Parisc type numbers. */
68 #define PORT_MUX        48
69
70 /* Macintosh Zilog type numbers */
71 #define PORT_MAC_ZILOG  50      /* m68k : not yet implemented */
72 #define PORT_PMAC_ZILOG 51
73
74 /* SH-SCI */
75 #define PORT_SCI        52
76 #define PORT_SCIF       53
77 #define PORT_IRDA       54
78
79 /* Samsung S3C2410 SoC and derivatives thereof */
80 #define PORT_S3C2410    55
81
82 /* SGI IP22 aka Indy / Challenge S / Indigo 2 */
83 #define PORT_IP22ZILOG  56
84
85 /* Sharp LH7a40x -- an ARM9 SoC series */
86 #define PORT_LH7A40X    57
87
88 /* PPC CPM type number */
89 #define PORT_CPM        58
90
91 /* MPC52xx type numbers */
92 #define PORT_MPC52xx    59
93
94 /* IBM icom */
95 #define PORT_ICOM       60
96
97 /* Samsung S3C2440 SoC */
98 #define PORT_S3C2440    61
99
100 /* Motorola i.MX SoC */
101 #define PORT_IMX        62
102
103 /* Marvell MPSC */
104 #define PORT_MPSC       63
105
106 /* TXX9 type number */
107 #define PORT_TXX9       64
108
109 /* NEC VR4100 series SIU/DSIU */
110 #define PORT_VR41XX_SIU         65
111 #define PORT_VR41XX_DSIU        66
112
113 /* Samsung S3C2400 SoC */
114 #define PORT_S3C2400    67
115
116 /* M32R SIO */
117 #define PORT_M32R_SIO   68
118
119 /*Digi jsm */
120 #define PORT_JSM        65
121
122 #ifdef __KERNEL__
123
124 #include <linux/config.h>
125 #include <linux/compiler.h>
126 #include <linux/interrupt.h>
127 #include <linux/circ_buf.h>
128 #include <linux/spinlock.h>
129 #include <linux/sched.h>
130 #include <linux/tty.h>
131
132 struct uart_port;
133 struct uart_info;
134 struct serial_struct;
135 struct device;
136
137 /*
138  * This structure describes all the operations that can be
139  * done on the physical hardware.
140  */
141 struct uart_ops {
142         unsigned int    (*tx_empty)(struct uart_port *);
143         void            (*set_mctrl)(struct uart_port *, unsigned int mctrl);
144         unsigned int    (*get_mctrl)(struct uart_port *);
145         void            (*stop_tx)(struct uart_port *, unsigned int tty_stop);
146         void            (*start_tx)(struct uart_port *, unsigned int tty_start);
147         void            (*send_xchar)(struct uart_port *, char ch);
148         void            (*stop_rx)(struct uart_port *);
149         void            (*enable_ms)(struct uart_port *);
150         void            (*break_ctl)(struct uart_port *, int ctl);
151         int             (*startup)(struct uart_port *);
152         void            (*shutdown)(struct uart_port *);
153         void            (*set_termios)(struct uart_port *, struct termios *new,
154                                        struct termios *old);
155         void            (*pm)(struct uart_port *, unsigned int state,
156                               unsigned int oldstate);
157         int             (*set_wake)(struct uart_port *, unsigned int state);
158
159         /*
160          * Return a string describing the type of the port
161          */
162         const char *(*type)(struct uart_port *);
163
164         /*
165          * Release IO and memory resources used by the port.
166          * This includes iounmap if necessary.
167          */
168         void            (*release_port)(struct uart_port *);
169
170         /*
171          * Request IO and memory resources used by the port.
172          * This includes iomapping the port if necessary.
173          */
174         int             (*request_port)(struct uart_port *);
175         void            (*config_port)(struct uart_port *, int);
176         int             (*verify_port)(struct uart_port *, struct serial_struct *);
177         int             (*ioctl)(struct uart_port *, unsigned int, unsigned long);
178 };
179
180 #define UART_CONFIG_TYPE        (1 << 0)
181 #define UART_CONFIG_IRQ         (1 << 1)
182
183 struct uart_icount {
184         __u32   cts;
185         __u32   dsr;
186         __u32   rng;
187         __u32   dcd;
188         __u32   rx;
189         __u32   tx;
190         __u32   frame;
191         __u32   overrun;
192         __u32   parity;
193         __u32   brk;
194         __u32   buf_overrun;
195 };
196
197 struct uart_port {
198         spinlock_t              lock;                   /* port lock */
199         unsigned int            iobase;                 /* in/out[bwl] */
200         unsigned char __iomem   *membase;               /* read/write[bwl] */
201         unsigned int            irq;                    /* irq number */
202         unsigned int            uartclk;                /* base uart clock */
203         unsigned char           fifosize;               /* tx fifo size */
204         unsigned char           x_char;                 /* xon/xoff char */
205         unsigned char           regshift;               /* reg offset shift */
206         unsigned char           iotype;                 /* io access style */
207
208 #define UPIO_PORT               (0)
209 #define UPIO_HUB6               (1)
210 #define UPIO_MEM                (2)
211 #define UPIO_MEM32              (3)
212
213         unsigned int            read_status_mask;       /* driver specific */
214         unsigned int            ignore_status_mask;     /* driver specific */
215         struct uart_info        *info;                  /* pointer to parent info */
216         struct uart_icount      icount;                 /* statistics */
217
218         struct console          *cons;                  /* struct console, if any */
219 #ifdef CONFIG_SERIAL_CORE_CONSOLE
220         unsigned long           sysrq;                  /* sysrq timeout */
221 #endif
222
223         unsigned int            flags;
224
225 #define UPF_FOURPORT            (1 << 1)
226 #define UPF_SAK                 (1 << 2)
227 #define UPF_SPD_MASK            (0x1030)
228 #define UPF_SPD_HI              (0x0010)
229 #define UPF_SPD_VHI             (0x0020)
230 #define UPF_SPD_CUST            (0x0030)
231 #define UPF_SPD_SHI             (0x1000)
232 #define UPF_SPD_WARP            (0x1010)
233 #define UPF_SKIP_TEST           (1 << 6)
234 #define UPF_AUTO_IRQ            (1 << 7)
235 #define UPF_HARDPPS_CD          (1 << 11)
236 #define UPF_LOW_LATENCY         (1 << 13)
237 #define UPF_BUGGY_UART          (1 << 14)
238 #define UPF_AUTOPROBE           (1 << 15)
239 #define UPF_MAGIC_MULTIPLIER    (1 << 16)
240 #define UPF_BOOT_ONLYMCA        (1 << 22)
241 #define UPF_CONS_FLOW           (1 << 23)
242 #define UPF_SHARE_IRQ           (1 << 24)
243 #define UPF_BOOT_AUTOCONF       (1 << 28)
244 #define UPF_IOREMAP             (1 << 31)
245
246 #define UPF_CHANGE_MASK         (0x17fff)
247 #define UPF_USR_MASK            (UPF_SPD_MASK|UPF_LOW_LATENCY)
248
249         unsigned int            mctrl;                  /* current modem ctrl settings */
250         unsigned int            timeout;                /* character-based timeout */
251         unsigned int            type;                   /* port type */
252         struct uart_ops         *ops;
253         unsigned int            custom_divisor;
254         unsigned int            line;                   /* port index */
255         unsigned long           mapbase;                /* for ioremap */
256         struct device           *dev;                   /* parent device */
257         unsigned char           hub6;                   /* this should be in the 8250 driver */
258         unsigned char           unused[3];
259 };
260
261 /*
262  * This is the state information which is persistent across opens.
263  * The low level driver must not to touch any elements contained
264  * within.
265  */
266 struct uart_state {
267         unsigned int            close_delay;            /* msec */
268         unsigned int            closing_wait;           /* msec */
269
270 #define USF_CLOSING_WAIT_INF    (0)
271 #define USF_CLOSING_WAIT_NONE   (~0U)
272
273         int                     count;
274         int                     pm_state;
275         struct uart_info        *info;
276         struct uart_port        *port;
277
278         struct semaphore        sem;
279 };
280
281 #define UART_XMIT_SIZE  PAGE_SIZE
282 /*
283  * This is the state information which is only valid when the port
284  * is open; it may be freed by the core driver once the device has
285  * been closed.  Either the low level driver or the core can modify
286  * stuff here.
287  */
288 struct uart_info {
289         struct tty_struct       *tty;
290         struct circ_buf         xmit;
291         unsigned int            flags;
292
293 /*
294  * These are the flags that specific to info->flags, and reflect our
295  * internal state.  They can not be accessed via port->flags.  Low
296  * level drivers must not change these, but may query them instead.
297  */
298 #define UIF_CHECK_CD            (1 << 25)
299 #define UIF_CTS_FLOW            (1 << 26)
300 #define UIF_NORMAL_ACTIVE       (1 << 29)
301 #define UIF_INITIALIZED         (1 << 31)
302
303         int                     blocked_open;
304
305         struct tasklet_struct   tlet;
306
307         wait_queue_head_t       open_wait;
308         wait_queue_head_t       delta_msr_wait;
309 };
310
311 /* number of characters left in xmit buffer before we ask for more */
312 #define WAKEUP_CHARS            256
313
314 struct module;
315 struct tty_driver;
316
317 struct uart_driver {
318         struct module           *owner;
319         const char              *driver_name;
320         const char              *dev_name;
321         const char              *devfs_name;
322         int                      major;
323         int                      minor;
324         int                      nr;
325         struct console          *cons;
326
327         /*
328          * these are private; the low level driver should not
329          * touch these; they should be initialised to NULL
330          */
331         struct uart_state       *state;
332         struct tty_driver       *tty_driver;
333 };
334
335 void uart_write_wakeup(struct uart_port *port);
336
337 /*
338  * Baud rate helpers.
339  */
340 void uart_update_timeout(struct uart_port *port, unsigned int cflag,
341                          unsigned int baud);
342 unsigned int uart_get_baud_rate(struct uart_port *port, struct termios *termios,
343                                 struct termios *old, unsigned int min,
344                                 unsigned int max);
345 unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
346
347 /*
348  * Console helpers.
349  */
350 struct uart_port *uart_get_console(struct uart_port *ports, int nr,
351                                    struct console *c);
352 void uart_parse_options(char *options, int *baud, int *parity, int *bits,
353                         int *flow);
354 int uart_set_options(struct uart_port *port, struct console *co, int baud,
355                      int parity, int bits, int flow);
356 struct tty_driver *uart_console_device(struct console *co, int *index);
357
358 /*
359  * Port/driver registration/removal
360  */
361 int uart_register_driver(struct uart_driver *uart);
362 void uart_unregister_driver(struct uart_driver *uart);
363 void __deprecated uart_unregister_port(struct uart_driver *reg, int line);
364 int __deprecated uart_register_port(struct uart_driver *reg, struct uart_port *port);
365 int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
366 int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
367 int uart_match_port(struct uart_port *port1, struct uart_port *port2);
368
369 /*
370  * Power Management
371  */
372 int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
373 int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
374
375 #define uart_circ_empty(circ)           ((circ)->head == (circ)->tail)
376 #define uart_circ_clear(circ)           ((circ)->head = (circ)->tail = 0)
377
378 #define uart_circ_chars_pending(circ)   \
379         (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
380
381 #define uart_circ_chars_free(circ)      \
382         (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
383
384 #define uart_tx_stopped(port)           \
385         ((port)->info->tty->stopped || (port)->info->tty->hw_stopped)
386
387 /*
388  * The following are helper functions for the low level drivers.
389  */
390 #ifdef SUPPORT_SYSRQ
391 static inline int
392 uart_handle_sysrq_char(struct uart_port *port, unsigned int ch,
393                        struct pt_regs *regs)
394 {
395         if (port->sysrq) {
396                 if (ch && time_before(jiffies, port->sysrq)) {
397                         handle_sysrq(ch, regs, NULL);
398                         port->sysrq = 0;
399                         return 1;
400                 }
401                 port->sysrq = 0;
402         }
403         return 0;
404 }
405 #else
406 #define uart_handle_sysrq_char(port,ch,regs)    (0)
407 #endif
408
409 /*
410  * We do the SysRQ and SAK checking like this...
411  */
412 static inline int uart_handle_break(struct uart_port *port)
413 {
414         struct uart_info *info = port->info;
415 #ifdef SUPPORT_SYSRQ
416         if (port->cons && port->cons->index == port->line) {
417                 if (!port->sysrq) {
418                         port->sysrq = jiffies + HZ*5;
419                         return 1;
420                 }
421                 port->sysrq = 0;
422         }
423 #endif
424         if (info->flags & UPF_SAK)
425                 do_SAK(info->tty);
426         return 0;
427 }
428
429 /**
430  *      uart_handle_dcd_change - handle a change of carrier detect state
431  *      @port: uart_port structure for the open port
432  *      @status: new carrier detect status, nonzero if active
433  */
434 static inline void
435 uart_handle_dcd_change(struct uart_port *port, unsigned int status)
436 {
437         struct uart_info *info = port->info;
438
439         port->icount.dcd++;
440
441 #ifdef CONFIG_HARD_PPS
442         if ((port->flags & UPF_HARDPPS_CD) && status)
443                 hardpps();
444 #endif
445
446         if (info->flags & UIF_CHECK_CD) {
447                 if (status)
448                         wake_up_interruptible(&info->open_wait);
449                 else if (info->tty)
450                         tty_hangup(info->tty);
451         }
452 }
453
454 /**
455  *      uart_handle_cts_change - handle a change of clear-to-send state
456  *      @port: uart_port structure for the open port
457  *      @status: new clear to send status, nonzero if active
458  */
459 static inline void
460 uart_handle_cts_change(struct uart_port *port, unsigned int status)
461 {
462         struct uart_info *info = port->info;
463         struct tty_struct *tty = info->tty;
464
465         port->icount.cts++;
466
467         if (info->flags & UIF_CTS_FLOW) {
468                 if (tty->hw_stopped) {
469                         if (status) {
470                                 tty->hw_stopped = 0;
471                                 port->ops->start_tx(port, 0);
472                                 uart_write_wakeup(port);
473                         }
474                 } else {
475                         if (!status) {
476                                 tty->hw_stopped = 1;
477                                 port->ops->stop_tx(port, 0);
478                         }
479                 }
480         }
481 }
482
483 #include <linux/tty_flip.h>
484
485 static inline void
486 uart_insert_char(struct uart_port *port, unsigned int status,
487                  unsigned int overrun, unsigned int ch, unsigned int flag)
488 {
489         struct tty_struct *tty = port->info->tty;
490
491         if ((status & port->ignore_status_mask & ~overrun) == 0)
492                 tty_insert_flip_char(tty, ch, flag);
493
494         /*
495          * Overrun is special.  Since it's reported immediately,
496          * it doesn't affect the current character.
497          */
498         if (status & ~port->ignore_status_mask & overrun)
499                 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
500 }
501
502 /*
503  *      UART_ENABLE_MS - determine if port should enable modem status irqs
504  */
505 #define UART_ENABLE_MS(port,cflag)      ((port)->flags & UPF_HARDPPS_CD || \
506                                          (cflag) & CRTSCTS || \
507                                          !((cflag) & CLOCAL))
508
509 #endif
510
511 #endif /* LINUX_SERIAL_CORE_H */