a37858debaa77a3bb64b2d2e3155d0149a7867b4
[android-sdk/kernel-video.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
24 #include <linux/compiler.h>
25 #include <linux/interrupt.h>
26 #include <linux/circ_buf.h>
27 #include <linux/spinlock.h>
28 #include <linux/sched.h>
29 #include <linux/tty.h>
30 #include <linux/mutex.h>
31 #include <linux/sysrq.h>
32 #include <linux/pps_kernel.h>
33 #include <uapi/linux/serial_core.h>
35 #ifdef CONFIG_SERIAL_CORE_CONSOLE
36 #define uart_console(port) \
37         ((port)->cons && (port)->cons->index == (port)->line)
38 #else
39 #define uart_console(port)      (0)
40 #endif
42 struct uart_port;
43 struct serial_struct;
44 struct device;
46 /*
47  * This structure describes all the operations that can be
48  * done on the physical hardware.
49  */
50 struct uart_ops {
51         unsigned int    (*tx_empty)(struct uart_port *);
52         void            (*set_mctrl)(struct uart_port *, unsigned int mctrl);
53         unsigned int    (*get_mctrl)(struct uart_port *);
54         void            (*stop_tx)(struct uart_port *);
55         void            (*start_tx)(struct uart_port *);
56         void            (*throttle)(struct uart_port *);
57         void            (*unthrottle)(struct uart_port *);
58         void            (*send_xchar)(struct uart_port *, char ch);
59         void            (*stop_rx)(struct uart_port *);
60         void            (*enable_ms)(struct uart_port *);
61         void            (*break_ctl)(struct uart_port *, int ctl);
62         int             (*startup)(struct uart_port *);
63         void            (*shutdown)(struct uart_port *);
64         void            (*flush_buffer)(struct uart_port *);
65         void            (*set_termios)(struct uart_port *, struct ktermios *new,
66                                        struct ktermios *old);
67         void            (*set_ldisc)(struct uart_port *, int new);
68         void            (*pm)(struct uart_port *, unsigned int state,
69                               unsigned int oldstate);
70         int             (*set_wake)(struct uart_port *, unsigned int state);
72         /*
73          * Return a string describing the type of the port
74          */
75         const char *(*type)(struct uart_port *);
77         /*
78          * Release IO and memory resources used by the port.
79          * This includes iounmap if necessary.
80          */
81         void            (*release_port)(struct uart_port *);
83         /*
84          * Request IO and memory resources used by the port.
85          * This includes iomapping the port if necessary.
86          */
87         int             (*request_port)(struct uart_port *);
88         void            (*config_port)(struct uart_port *, int);
89         int             (*verify_port)(struct uart_port *, struct serial_struct *);
90         int             (*ioctl)(struct uart_port *, unsigned int, unsigned long);
91 #ifdef CONFIG_CONSOLE_POLL
92         int             (*poll_init)(struct uart_port *);
93         void    (*poll_put_char)(struct uart_port *, unsigned char);
94         int             (*poll_get_char)(struct uart_port *);
95 #endif
96 };
98 #define NO_POLL_CHAR            0x00ff0000
99 #define UART_CONFIG_TYPE        (1 << 0)
100 #define UART_CONFIG_IRQ         (1 << 1)
102 struct uart_icount {
103         __u32   cts;
104         __u32   dsr;
105         __u32   rng;
106         __u32   dcd;
107         __u32   rx;
108         __u32   tx;
109         __u32   frame;
110         __u32   overrun;
111         __u32   parity;
112         __u32   brk;
113         __u32   buf_overrun;
114 };
116 typedef unsigned int __bitwise__ upf_t;
118 struct uart_port {
119         spinlock_t              lock;                   /* port lock */
120         unsigned long           iobase;                 /* in/out[bwl] */
121         unsigned char __iomem   *membase;               /* read/write[bwl] */
122         unsigned int            (*serial_in)(struct uart_port *, int);
123         void                    (*serial_out)(struct uart_port *, int, int);
124         void                    (*set_termios)(struct uart_port *,
125                                                struct ktermios *new,
126                                                struct ktermios *old);
127         int                     (*handle_irq)(struct uart_port *);
128         void                    (*pm)(struct uart_port *, unsigned int state,
129                                       unsigned int old);
130         void                    (*handle_break)(struct uart_port *);
131         unsigned int            irq;                    /* irq number */
132         unsigned long           irqflags;               /* irq flags  */
133         unsigned int            uartclk;                /* base uart clock */
134         unsigned int            fifosize;               /* tx fifo size */
135         unsigned char           x_char;                 /* xon/xoff char */
136         unsigned char           regshift;               /* reg offset shift */
137         unsigned char           iotype;                 /* io access style */
138         unsigned char           unused1;
140 #define UPIO_PORT               (0)
141 #define UPIO_HUB6               (1)
142 #define UPIO_MEM                (2)
143 #define UPIO_MEM32              (3)
144 #define UPIO_AU                 (4)                     /* Au1x00 type IO */
145 #define UPIO_TSI                (5)                     /* Tsi108/109 type IO */
146 #define UPIO_RM9000             (6)                     /* RM9000 type IO */
148         unsigned int            read_status_mask;       /* driver specific */
149         unsigned int            ignore_status_mask;     /* driver specific */
150         struct uart_state       *state;                 /* pointer to parent state */
151         struct uart_icount      icount;                 /* statistics */
153         struct console          *cons;                  /* struct console, if any */
154 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
155         unsigned long           sysrq;                  /* sysrq timeout */
156 #endif
158         upf_t                   flags;
160 #define UPF_FOURPORT            ((__force upf_t) (1 << 1))
161 #define UPF_SAK                 ((__force upf_t) (1 << 2))
162 #define UPF_SPD_MASK            ((__force upf_t) (0x1030))
163 #define UPF_SPD_HI              ((__force upf_t) (0x0010))
164 #define UPF_SPD_VHI             ((__force upf_t) (0x0020))
165 #define UPF_SPD_CUST            ((__force upf_t) (0x0030))
166 #define UPF_SPD_SHI             ((__force upf_t) (0x1000))
167 #define UPF_SPD_WARP            ((__force upf_t) (0x1010))
168 #define UPF_SKIP_TEST           ((__force upf_t) (1 << 6))
169 #define UPF_AUTO_IRQ            ((__force upf_t) (1 << 7))
170 #define UPF_HARDPPS_CD          ((__force upf_t) (1 << 11))
171 #define UPF_LOW_LATENCY         ((__force upf_t) (1 << 13))
172 #define UPF_BUGGY_UART          ((__force upf_t) (1 << 14))
173 #define UPF_NO_TXEN_TEST        ((__force upf_t) (1 << 15))
174 #define UPF_MAGIC_MULTIPLIER    ((__force upf_t) (1 << 16))
175 /* Port has hardware-assisted h/w flow control (iow, auto-RTS *not* auto-CTS) */
176 #define UPF_HARD_FLOW           ((__force upf_t) (1 << 21))
177 /* Port has hardware-assisted s/w flow control */
178 #define UPF_SOFT_FLOW           ((__force upf_t) (1 << 22))
179 #define UPF_CONS_FLOW           ((__force upf_t) (1 << 23))
180 #define UPF_SHARE_IRQ           ((__force upf_t) (1 << 24))
181 #define UPF_EXAR_EFR            ((__force upf_t) (1 << 25))
182 #define UPF_BUG_THRE            ((__force upf_t) (1 << 26))
183 /* The exact UART type is known and should not be probed.  */
184 #define UPF_FIXED_TYPE          ((__force upf_t) (1 << 27))
185 #define UPF_BOOT_AUTOCONF       ((__force upf_t) (1 << 28))
186 #define UPF_FIXED_PORT          ((__force upf_t) (1 << 29))
187 #define UPF_DEAD                ((__force upf_t) (1 << 30))
188 #define UPF_IOREMAP             ((__force upf_t) (1 << 31))
190 #define UPF_CHANGE_MASK         ((__force upf_t) (0x17fff))
191 #define UPF_USR_MASK            ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
193         unsigned int            mctrl;                  /* current modem ctrl settings */
194         unsigned int            timeout;                /* character-based timeout */
195         unsigned int            type;                   /* port type */
196         const struct uart_ops   *ops;
197         unsigned int            custom_divisor;
198         unsigned int            line;                   /* port index */
199         resource_size_t         mapbase;                /* for ioremap */
200         struct device           *dev;                   /* parent device */
201         unsigned char           hub6;                   /* this should be in the 8250 driver */
202         unsigned char           suspended;
203         unsigned char           irq_wake;
204         unsigned char           unused[2];
205         void                    *private_data;          /* generic platform data pointer */
206 };
208 static inline int serial_port_in(struct uart_port *up, int offset)
210         return up->serial_in(up, offset);
213 static inline void serial_port_out(struct uart_port *up, int offset, int value)
215         up->serial_out(up, offset, value);
218 /*
219  * This is the state information which is persistent across opens.
220  */
221 struct uart_state {
222         struct tty_port         port;
224         int                     pm_state;
225         struct circ_buf         xmit;
227         struct uart_port        *uart_port;
228 };
230 #define UART_XMIT_SIZE  PAGE_SIZE
233 /* number of characters left in xmit buffer before we ask for more */
234 #define WAKEUP_CHARS            256
236 struct module;
237 struct tty_driver;
239 struct uart_driver {
240         struct module           *owner;
241         const char              *driver_name;
242         const char              *dev_name;
243         int                      major;
244         int                      minor;
245         int                      nr;
246         struct console          *cons;
248         /*
249          * these are private; the low level driver should not
250          * touch these; they should be initialised to NULL
251          */
252         struct uart_state       *state;
253         struct tty_driver       *tty_driver;
254 };
256 void uart_write_wakeup(struct uart_port *port);
258 /*
259  * Baud rate helpers.
260  */
261 void uart_update_timeout(struct uart_port *port, unsigned int cflag,
262                          unsigned int baud);
263 unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
264                                 struct ktermios *old, unsigned int min,
265                                 unsigned int max);
266 unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
268 /* Base timer interval for polling */
269 static inline int uart_poll_timeout(struct uart_port *port)
271         int timeout = port->timeout;
273         return timeout > 6 ? (timeout / 2 - 2) : 1;
276 /*
277  * Console helpers.
278  */
279 struct uart_port *uart_get_console(struct uart_port *ports, int nr,
280                                    struct console *c);
281 void uart_parse_options(char *options, int *baud, int *parity, int *bits,
282                         int *flow);
283 int uart_set_options(struct uart_port *port, struct console *co, int baud,
284                      int parity, int bits, int flow);
285 struct tty_driver *uart_console_device(struct console *co, int *index);
286 void uart_console_write(struct uart_port *port, const char *s,
287                         unsigned int count,
288                         void (*putchar)(struct uart_port *, int));
290 /*
291  * Port/driver registration/removal
292  */
293 int uart_register_driver(struct uart_driver *uart);
294 void uart_unregister_driver(struct uart_driver *uart);
295 int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
296 int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
297 int uart_match_port(struct uart_port *port1, struct uart_port *port2);
299 /*
300  * Power Management
301  */
302 int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
303 int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
305 #define uart_circ_empty(circ)           ((circ)->head == (circ)->tail)
306 #define uart_circ_clear(circ)           ((circ)->head = (circ)->tail = 0)
308 #define uart_circ_chars_pending(circ)   \
309         (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
311 #define uart_circ_chars_free(circ)      \
312         (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
314 static inline int uart_tx_stopped(struct uart_port *port)
316         struct tty_struct *tty = port->state->port.tty;
317         if(tty->stopped || tty->hw_stopped)
318                 return 1;
319         return 0;
322 /*
323  * The following are helper functions for the low level drivers.
324  */
326 extern void uart_handle_dcd_change(struct uart_port *uport,
327                 unsigned int status);
328 extern void uart_handle_cts_change(struct uart_port *uport,
329                 unsigned int status);
331 extern void uart_insert_char(struct uart_port *port, unsigned int status,
332                  unsigned int overrun, unsigned int ch, unsigned int flag);
334 #ifdef SUPPORT_SYSRQ
335 static inline int
336 uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
338         if (port->sysrq) {
339                 if (ch && time_before(jiffies, port->sysrq)) {
340                         handle_sysrq(ch);
341                         port->sysrq = 0;
342                         return 1;
343                 }
344                 port->sysrq = 0;
345         }
346         return 0;
348 #else
349 #define uart_handle_sysrq_char(port,ch) ({ (void)port; 0; })
350 #endif
352 /*
353  * We do the SysRQ and SAK checking like this...
354  */
355 static inline int uart_handle_break(struct uart_port *port)
357         struct uart_state *state = port->state;
359         if (port->handle_break)
360                 port->handle_break(port);
362 #ifdef SUPPORT_SYSRQ
363         if (port->cons && port->cons->index == port->line) {
364                 if (!port->sysrq) {
365                         port->sysrq = jiffies + HZ*5;
366                         return 1;
367                 }
368                 port->sysrq = 0;
369         }
370 #endif
371         if (port->flags & UPF_SAK)
372                 do_SAK(state->port.tty);
373         return 0;
376 /*
377  *      UART_ENABLE_MS - determine if port should enable modem status irqs
378  */
379 #define UART_ENABLE_MS(port,cflag)      ((port)->flags & UPF_HARDPPS_CD || \
380                                          (cflag) & CRTSCTS || \
381                                          !((cflag) & CLOCAL))
383 #endif /* LINUX_SERIAL_CORE_H */