serial_core.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:13k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

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