serial_core.h 14 KB

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