serial_core.h 13 KB

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