serial_core.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567
  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. #include <linux/serial.h>
  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_RM9000 16 /* PMC-Sierra RM9xxx internal UART */
  43. #define PORT_OCTEON 17 /* Cavium OCTEON internal UART */
  44. #define PORT_AR7 18 /* Texas Instruments AR7 internal UART */
  45. #define PORT_MAX_8250 18 /* max port ID */
  46. /*
  47. * ARM specific type numbers. These are not currently guaranteed
  48. * to be implemented, and will change in the future. These are
  49. * separate so any additions to the old serial.c that occur before
  50. * we are merged can be easily merged here.
  51. */
  52. #define PORT_PXA 31
  53. #define PORT_AMBA 32
  54. #define PORT_CLPS711X 33
  55. #define PORT_SA1100 34
  56. #define PORT_UART00 35
  57. #define PORT_21285 37
  58. /* Sparc type numbers. */
  59. #define PORT_SUNZILOG 38
  60. #define PORT_SUNSAB 39
  61. /* DEC */
  62. #define PORT_DZ 46
  63. #define PORT_ZS 47
  64. /* Parisc type numbers. */
  65. #define PORT_MUX 48
  66. /* Atmel AT91 / AT32 SoC */
  67. #define PORT_ATMEL 49
  68. /* Macintosh Zilog type numbers */
  69. #define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
  70. #define PORT_PMAC_ZILOG 51
  71. /* SH-SCI */
  72. #define PORT_SCI 52
  73. #define PORT_SCIF 53
  74. #define PORT_IRDA 54
  75. /* Samsung S3C2410 SoC and derivatives thereof */
  76. #define PORT_S3C2410 55
  77. /* SGI IP22 aka Indy / Challenge S / Indigo 2 */
  78. #define PORT_IP22ZILOG 56
  79. /* Sharp LH7a40x -- an ARM9 SoC series */
  80. #define PORT_LH7A40X 57
  81. /* PPC CPM type number */
  82. #define PORT_CPM 58
  83. /* MPC52xx type numbers */
  84. #define PORT_MPC52xx 59
  85. /* IBM icom */
  86. #define PORT_ICOM 60
  87. /* Samsung S3C2440 SoC */
  88. #define PORT_S3C2440 61
  89. /* Motorola i.MX SoC */
  90. #define PORT_IMX 62
  91. /* Marvell MPSC */
  92. #define PORT_MPSC 63
  93. /* TXX9 type number */
  94. #define PORT_TXX9 64
  95. /* NEC VR4100 series SIU/DSIU */
  96. #define PORT_VR41XX_SIU 65
  97. #define PORT_VR41XX_DSIU 66
  98. /* Samsung S3C2400 SoC */
  99. #define PORT_S3C2400 67
  100. /* M32R SIO */
  101. #define PORT_M32R_SIO 68
  102. /*Digi jsm */
  103. #define PORT_JSM 69
  104. #define PORT_PNX8XXX 70
  105. /* Hilscher netx */
  106. #define PORT_NETX 71
  107. /* SUN4V Hypervisor Console */
  108. #define PORT_SUNHV 72
  109. #define PORT_S3C2412 73
  110. /* Xilinx uartlite */
  111. #define PORT_UARTLITE 74
  112. /* Blackfin bf5xx */
  113. #define PORT_BFIN 75
  114. /* Micrel KS8695 */
  115. #define PORT_KS8695 76
  116. /* Broadcom SB1250, etc. SOC */
  117. #define PORT_SB1250_DUART 77
  118. /* Freescale ColdFire */
  119. #define PORT_MCF 78
  120. /* Blackfin SPORT */
  121. #define PORT_BFIN_SPORT 79
  122. /* MN10300 on-chip UART numbers */
  123. #define PORT_MN10300 80
  124. #define PORT_MN10300_CTS 81
  125. #define PORT_SC26XX 82
  126. /* SH-SCI */
  127. #define PORT_SCIFA 83
  128. #define PORT_S3C6400 84
  129. /* NWPSERIAL */
  130. #define PORT_NWPSERIAL 85
  131. /* MAX3100 */
  132. #define PORT_MAX3100 86
  133. /* Timberdale UART */
  134. #define PORT_TIMBUART 87
  135. /* Qualcomm MSM SoCs */
  136. #define PORT_MSM 88
  137. /* BCM63xx family SoCs */
  138. #define PORT_BCM63XX 89
  139. /* Aeroflex Gaisler GRLIB APBUART */
  140. #define PORT_APBUART 90
  141. #ifdef __KERNEL__
  142. #include <linux/compiler.h>
  143. #include <linux/interrupt.h>
  144. #include <linux/circ_buf.h>
  145. #include <linux/spinlock.h>
  146. #include <linux/sched.h>
  147. #include <linux/tty.h>
  148. #include <linux/mutex.h>
  149. #include <linux/sysrq.h>
  150. struct uart_port;
  151. struct serial_struct;
  152. struct device;
  153. /*
  154. * This structure describes all the operations that can be
  155. * done on the physical hardware.
  156. */
  157. struct uart_ops {
  158. unsigned int (*tx_empty)(struct uart_port *);
  159. void (*set_mctrl)(struct uart_port *, unsigned int mctrl);
  160. unsigned int (*get_mctrl)(struct uart_port *);
  161. void (*stop_tx)(struct uart_port *);
  162. void (*start_tx)(struct uart_port *);
  163. void (*send_xchar)(struct uart_port *, char ch);
  164. void (*stop_rx)(struct uart_port *);
  165. void (*enable_ms)(struct uart_port *);
  166. void (*break_ctl)(struct uart_port *, int ctl);
  167. int (*startup)(struct uart_port *);
  168. void (*shutdown)(struct uart_port *);
  169. void (*flush_buffer)(struct uart_port *);
  170. void (*set_termios)(struct uart_port *, struct ktermios *new,
  171. struct ktermios *old);
  172. void (*set_ldisc)(struct uart_port *);
  173. void (*pm)(struct uart_port *, unsigned int state,
  174. unsigned int oldstate);
  175. int (*set_wake)(struct uart_port *, unsigned int state);
  176. /*
  177. * Return a string describing the type of the port
  178. */
  179. const char *(*type)(struct uart_port *);
  180. /*
  181. * Release IO and memory resources used by the port.
  182. * This includes iounmap if necessary.
  183. */
  184. void (*release_port)(struct uart_port *);
  185. /*
  186. * Request IO and memory resources used by the port.
  187. * This includes iomapping the port if necessary.
  188. */
  189. int (*request_port)(struct uart_port *);
  190. void (*config_port)(struct uart_port *, int);
  191. int (*verify_port)(struct uart_port *, struct serial_struct *);
  192. int (*ioctl)(struct uart_port *, unsigned int, unsigned long);
  193. #ifdef CONFIG_CONSOLE_POLL
  194. void (*poll_put_char)(struct uart_port *, unsigned char);
  195. int (*poll_get_char)(struct uart_port *);
  196. #endif
  197. };
  198. #define UART_CONFIG_TYPE (1 << 0)
  199. #define UART_CONFIG_IRQ (1 << 1)
  200. struct uart_icount {
  201. __u32 cts;
  202. __u32 dsr;
  203. __u32 rng;
  204. __u32 dcd;
  205. __u32 rx;
  206. __u32 tx;
  207. __u32 frame;
  208. __u32 overrun;
  209. __u32 parity;
  210. __u32 brk;
  211. __u32 buf_overrun;
  212. };
  213. typedef unsigned int __bitwise__ upf_t;
  214. struct uart_port {
  215. spinlock_t lock; /* port lock */
  216. unsigned long iobase; /* in/out[bwl] */
  217. unsigned char __iomem *membase; /* read/write[bwl] */
  218. unsigned int (*serial_in)(struct uart_port *, int);
  219. void (*serial_out)(struct uart_port *, int, int);
  220. unsigned int irq; /* irq number */
  221. unsigned long irqflags; /* irq flags */
  222. unsigned int uartclk; /* base uart clock */
  223. unsigned int fifosize; /* tx fifo size */
  224. unsigned char x_char; /* xon/xoff char */
  225. unsigned char regshift; /* reg offset shift */
  226. unsigned char iotype; /* io access style */
  227. unsigned char unused1;
  228. #define UPIO_PORT (0)
  229. #define UPIO_HUB6 (1)
  230. #define UPIO_MEM (2)
  231. #define UPIO_MEM32 (3)
  232. #define UPIO_AU (4) /* Au1x00 type IO */
  233. #define UPIO_TSI (5) /* Tsi108/109 type IO */
  234. #define UPIO_DWAPB (6) /* DesignWare APB UART */
  235. #define UPIO_RM9000 (7) /* RM9000 type IO */
  236. unsigned int read_status_mask; /* driver specific */
  237. unsigned int ignore_status_mask; /* driver specific */
  238. struct uart_state *state; /* pointer to parent state */
  239. struct uart_icount icount; /* statistics */
  240. struct console *cons; /* struct console, if any */
  241. #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
  242. unsigned long sysrq; /* sysrq timeout */
  243. #endif
  244. upf_t flags;
  245. #define UPF_FOURPORT ((__force upf_t) (1 << 1))
  246. #define UPF_SAK ((__force upf_t) (1 << 2))
  247. #define UPF_SPD_MASK ((__force upf_t) (0x1030))
  248. #define UPF_SPD_HI ((__force upf_t) (0x0010))
  249. #define UPF_SPD_VHI ((__force upf_t) (0x0020))
  250. #define UPF_SPD_CUST ((__force upf_t) (0x0030))
  251. #define UPF_SPD_SHI ((__force upf_t) (0x1000))
  252. #define UPF_SPD_WARP ((__force upf_t) (0x1010))
  253. #define UPF_SKIP_TEST ((__force upf_t) (1 << 6))
  254. #define UPF_AUTO_IRQ ((__force upf_t) (1 << 7))
  255. #define UPF_HARDPPS_CD ((__force upf_t) (1 << 11))
  256. #define UPF_LOW_LATENCY ((__force upf_t) (1 << 13))
  257. #define UPF_BUGGY_UART ((__force upf_t) (1 << 14))
  258. #define UPF_NO_TXEN_TEST ((__force upf_t) (1 << 15))
  259. #define UPF_MAGIC_MULTIPLIER ((__force upf_t) (1 << 16))
  260. #define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
  261. #define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
  262. /* The exact UART type is known and should not be probed. */
  263. #define UPF_FIXED_TYPE ((__force upf_t) (1 << 27))
  264. #define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
  265. #define UPF_FIXED_PORT ((__force upf_t) (1 << 29))
  266. #define UPF_DEAD ((__force upf_t) (1 << 30))
  267. #define UPF_IOREMAP ((__force upf_t) (1 << 31))
  268. #define UPF_CHANGE_MASK ((__force upf_t) (0x17fff))
  269. #define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
  270. unsigned int mctrl; /* current modem ctrl settings */
  271. unsigned int timeout; /* character-based timeout */
  272. unsigned int type; /* port type */
  273. const struct uart_ops *ops;
  274. unsigned int custom_divisor;
  275. unsigned int line; /* port index */
  276. resource_size_t mapbase; /* for ioremap */
  277. struct device *dev; /* parent device */
  278. unsigned char hub6; /* this should be in the 8250 driver */
  279. unsigned char suspended;
  280. unsigned char unused[2];
  281. void *private_data; /* generic platform data pointer */
  282. };
  283. /*
  284. * This is the state information which is persistent across opens.
  285. */
  286. struct uart_state {
  287. struct tty_port port;
  288. int pm_state;
  289. struct circ_buf xmit;
  290. struct tasklet_struct tlet;
  291. struct uart_port *uart_port;
  292. };
  293. #define UART_XMIT_SIZE PAGE_SIZE
  294. /* number of characters left in xmit buffer before we ask for more */
  295. #define WAKEUP_CHARS 256
  296. struct module;
  297. struct tty_driver;
  298. struct uart_driver {
  299. struct module *owner;
  300. const char *driver_name;
  301. const char *dev_name;
  302. int major;
  303. int minor;
  304. int nr;
  305. struct console *cons;
  306. /*
  307. * these are private; the low level driver should not
  308. * touch these; they should be initialised to NULL
  309. */
  310. struct uart_state *state;
  311. struct tty_driver *tty_driver;
  312. };
  313. void uart_write_wakeup(struct uart_port *port);
  314. /*
  315. * Baud rate helpers.
  316. */
  317. void uart_update_timeout(struct uart_port *port, unsigned int cflag,
  318. unsigned int baud);
  319. unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
  320. struct ktermios *old, unsigned int min,
  321. unsigned int max);
  322. unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
  323. /*
  324. * Console helpers.
  325. */
  326. struct uart_port *uart_get_console(struct uart_port *ports, int nr,
  327. struct console *c);
  328. void uart_parse_options(char *options, int *baud, int *parity, int *bits,
  329. int *flow);
  330. int uart_set_options(struct uart_port *port, struct console *co, int baud,
  331. int parity, int bits, int flow);
  332. struct tty_driver *uart_console_device(struct console *co, int *index);
  333. void uart_console_write(struct uart_port *port, const char *s,
  334. unsigned int count,
  335. void (*putchar)(struct uart_port *, int));
  336. /*
  337. * Port/driver registration/removal
  338. */
  339. int uart_register_driver(struct uart_driver *uart);
  340. void uart_unregister_driver(struct uart_driver *uart);
  341. int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
  342. int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
  343. int uart_match_port(struct uart_port *port1, struct uart_port *port2);
  344. /*
  345. * Power Management
  346. */
  347. int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
  348. int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
  349. #define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
  350. #define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
  351. #define uart_circ_chars_pending(circ) \
  352. (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
  353. #define uart_circ_chars_free(circ) \
  354. (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
  355. static inline int uart_tx_stopped(struct uart_port *port)
  356. {
  357. struct tty_struct *tty = port->state->port.tty;
  358. if(tty->stopped || tty->hw_stopped)
  359. return 1;
  360. return 0;
  361. }
  362. /*
  363. * The following are helper functions for the low level drivers.
  364. */
  365. static inline int
  366. uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
  367. {
  368. #ifdef SUPPORT_SYSRQ
  369. if (port->sysrq) {
  370. if (ch && time_before(jiffies, port->sysrq)) {
  371. handle_sysrq(ch, port->state->port.tty);
  372. port->sysrq = 0;
  373. return 1;
  374. }
  375. port->sysrq = 0;
  376. }
  377. #endif
  378. return 0;
  379. }
  380. #ifndef SUPPORT_SYSRQ
  381. #define uart_handle_sysrq_char(port,ch) uart_handle_sysrq_char(port, 0)
  382. #endif
  383. /*
  384. * We do the SysRQ and SAK checking like this...
  385. */
  386. static inline int uart_handle_break(struct uart_port *port)
  387. {
  388. struct uart_state *state = port->state;
  389. #ifdef SUPPORT_SYSRQ
  390. if (port->cons && port->cons->index == port->line) {
  391. if (!port->sysrq) {
  392. port->sysrq = jiffies + HZ*5;
  393. return 1;
  394. }
  395. port->sysrq = 0;
  396. }
  397. #endif
  398. if (port->flags & UPF_SAK)
  399. do_SAK(state->port.tty);
  400. return 0;
  401. }
  402. /**
  403. * uart_handle_dcd_change - handle a change of carrier detect state
  404. * @uport: uart_port structure for the open port
  405. * @status: new carrier detect status, nonzero if active
  406. */
  407. static inline void
  408. uart_handle_dcd_change(struct uart_port *uport, unsigned int status)
  409. {
  410. struct uart_state *state = uport->state;
  411. struct tty_port *port = &state->port;
  412. uport->icount.dcd++;
  413. #ifdef CONFIG_HARD_PPS
  414. if ((uport->flags & UPF_HARDPPS_CD) && status)
  415. hardpps();
  416. #endif
  417. if (port->flags & ASYNC_CHECK_CD) {
  418. if (status)
  419. wake_up_interruptible(&port->open_wait);
  420. else if (port->tty)
  421. tty_hangup(port->tty);
  422. }
  423. }
  424. /**
  425. * uart_handle_cts_change - handle a change of clear-to-send state
  426. * @uport: uart_port structure for the open port
  427. * @status: new clear to send status, nonzero if active
  428. */
  429. static inline void
  430. uart_handle_cts_change(struct uart_port *uport, unsigned int status)
  431. {
  432. struct tty_port *port = &uport->state->port;
  433. struct tty_struct *tty = port->tty;
  434. uport->icount.cts++;
  435. if (port->flags & ASYNC_CTS_FLOW) {
  436. if (tty->hw_stopped) {
  437. if (status) {
  438. tty->hw_stopped = 0;
  439. uport->ops->start_tx(uport);
  440. uart_write_wakeup(uport);
  441. }
  442. } else {
  443. if (!status) {
  444. tty->hw_stopped = 1;
  445. uport->ops->stop_tx(uport);
  446. }
  447. }
  448. }
  449. }
  450. #include <linux/tty_flip.h>
  451. static inline void
  452. uart_insert_char(struct uart_port *port, unsigned int status,
  453. unsigned int overrun, unsigned int ch, unsigned int flag)
  454. {
  455. struct tty_struct *tty = port->state->port.tty;
  456. if ((status & port->ignore_status_mask & ~overrun) == 0)
  457. tty_insert_flip_char(tty, ch, flag);
  458. /*
  459. * Overrun is special. Since it's reported immediately,
  460. * it doesn't affect the current character.
  461. */
  462. if (status & ~port->ignore_status_mask & overrun)
  463. tty_insert_flip_char(tty, 0, TTY_OVERRUN);
  464. }
  465. /*
  466. * UART_ENABLE_MS - determine if port should enable modem status irqs
  467. */
  468. #define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
  469. (cflag) & CRTSCTS || \
  470. !((cflag) & CLOCAL))
  471. #endif
  472. #endif /* LINUX_SERIAL_CORE_H */