Home | History | Annotate | Download | only in linux
      1 /*
      2  * include/linux/serial.h
      3  *
      4  * Copyright (C) 1992 by Theodore Ts'o.
      5  *
      6  * Redistribution of this file is permitted under the terms of the GNU
      7  * Public License (GPL)
      8  */
      9 
     10 #ifndef _LINUX_SERIAL_H
     11 #define _LINUX_SERIAL_H
     12 
     13 #include <linux/types.h>
     14 
     15 
     16 struct serial_struct {
     17 	int	type;
     18 	int	line;
     19 	unsigned int	port;
     20 	int	irq;
     21 	int	flags;
     22 	int	xmit_fifo_size;
     23 	int	custom_divisor;
     24 	int	baud_base;
     25 	unsigned short	close_delay;
     26 	char	io_type;
     27 	char	reserved_char[1];
     28 	int	hub6;
     29 	unsigned short	closing_wait; /* time to wait before closing */
     30 	unsigned short	closing_wait2; /* no longer used... */
     31 	unsigned char	*iomem_base;
     32 	unsigned short	iomem_reg_shift;
     33 	unsigned int	port_high;
     34 	unsigned long	iomap_base;	/* cookie passed into ioremap */
     35 };
     36 
     37 /*
     38  * For the close wait times, 0 means wait forever for serial port to
     39  * flush its output.  65535 means don't wait at all.
     40  */
     41 #define ASYNC_CLOSING_WAIT_INF	0
     42 #define ASYNC_CLOSING_WAIT_NONE	65535
     43 
     44 /*
     45  * These are the supported serial types.
     46  */
     47 #define PORT_UNKNOWN	0
     48 #define PORT_8250	1
     49 #define PORT_16450	2
     50 #define PORT_16550	3
     51 #define PORT_16550A	4
     52 #define PORT_CIRRUS     5	/* usurped by cyclades.c */
     53 #define PORT_16650	6
     54 #define PORT_16650V2	7
     55 #define PORT_16750	8
     56 #define PORT_STARTECH	9	/* usurped by cyclades.c */
     57 #define PORT_16C950	10	/* Oxford Semiconductor */
     58 #define PORT_16654	11
     59 #define PORT_16850	12
     60 #define PORT_RSA	13	/* RSA-DV II/S card */
     61 #define PORT_MAX	13
     62 
     63 #define SERIAL_IO_PORT	0
     64 #define SERIAL_IO_HUB6	1
     65 #define SERIAL_IO_MEM	2
     66 
     67 struct serial_uart_config {
     68 	char	*name;
     69 	int	dfl_xmit_fifo_size;
     70 	int	flags;
     71 };
     72 
     73 #define UART_CLEAR_FIFO		0x01
     74 #define UART_USE_FIFO		0x02
     75 #define UART_STARTECH		0x04
     76 #define UART_NATSEMI		0x08
     77 
     78 /*
     79  * Definitions for async_struct (and serial_struct) flags field
     80  *
     81  * Define ASYNCB_* for convenient use with {test,set,clear}_bit.
     82  */
     83 #define ASYNCB_HUP_NOTIFY	 0 /* Notify getty on hangups and closes
     84 				    * on the callout port */
     85 #define ASYNCB_FOURPORT		 1 /* Set OU1, OUT2 per AST Fourport settings */
     86 #define ASYNCB_SAK		 2 /* Secure Attention Key (Orange book) */
     87 #define ASYNCB_SPLIT_TERMIOS	 3 /* Separate termios for dialin/callout */
     88 #define ASYNCB_SPD_HI		 4 /* Use 56000 instead of 38400 bps */
     89 #define ASYNCB_SPD_VHI		 5 /* Use 115200 instead of 38400 bps */
     90 #define ASYNCB_SKIP_TEST	 6 /* Skip UART test during autoconfiguration */
     91 #define ASYNCB_AUTO_IRQ		 7 /* Do automatic IRQ during
     92 				    * autoconfiguration */
     93 #define ASYNCB_SESSION_LOCKOUT	 8 /* Lock out cua opens based on session */
     94 #define ASYNCB_PGRP_LOCKOUT	 9 /* Lock out cua opens based on pgrp */
     95 #define ASYNCB_CALLOUT_NOHUP	10 /* Don't do hangups for cua device */
     96 #define ASYNCB_HARDPPS_CD	11 /* Call hardpps when CD goes high  */
     97 #define ASYNCB_SPD_SHI		12 /* Use 230400 instead of 38400 bps */
     98 #define ASYNCB_LOW_LATENCY	13 /* Request low latency behaviour */
     99 #define ASYNCB_BUGGY_UART	14 /* This is a buggy UART, skip some safety
    100 				    * checks.  Note: can be dangerous! */
    101 #define ASYNCB_AUTOPROBE	15 /* Port was autoprobed by PCI or PNP code */
    102 #define ASYNCB_LAST_USER	15
    103 
    104 /* Internal flags used only by kernel */
    105 #define ASYNCB_INITIALIZED	31 /* Serial port was initialized */
    106 #define ASYNCB_SUSPENDED	30 /* Serial port is suspended */
    107 #define ASYNCB_NORMAL_ACTIVE	29 /* Normal device is active */
    108 #define ASYNCB_BOOT_AUTOCONF	28 /* Autoconfigure port on bootup */
    109 #define ASYNCB_CLOSING		27 /* Serial port is closing */
    110 #define ASYNCB_CTS_FLOW		26 /* Do CTS flow control */
    111 #define ASYNCB_CHECK_CD		25 /* i.e., CLOCAL */
    112 #define ASYNCB_SHARE_IRQ	24 /* for multifunction cards, no longer used */
    113 #define ASYNCB_CONS_FLOW	23 /* flow control for console  */
    114 #define ASYNCB_BOOT_ONLYMCA	22 /* Probe only if MCA bus */
    115 #define ASYNCB_FIRST_KERNEL	22
    116 
    117 #define ASYNC_HUP_NOTIFY	(1U << ASYNCB_HUP_NOTIFY)
    118 #define ASYNC_SUSPENDED		(1U << ASYNCB_SUSPENDED)
    119 #define ASYNC_FOURPORT		(1U << ASYNCB_FOURPORT)
    120 #define ASYNC_SAK		(1U << ASYNCB_SAK)
    121 #define ASYNC_SPLIT_TERMIOS	(1U << ASYNCB_SPLIT_TERMIOS)
    122 #define ASYNC_SPD_HI		(1U << ASYNCB_SPD_HI)
    123 #define ASYNC_SPD_VHI		(1U << ASYNCB_SPD_VHI)
    124 #define ASYNC_SKIP_TEST		(1U << ASYNCB_SKIP_TEST)
    125 #define ASYNC_AUTO_IRQ		(1U << ASYNCB_AUTO_IRQ)
    126 #define ASYNC_SESSION_LOCKOUT	(1U << ASYNCB_SESSION_LOCKOUT)
    127 #define ASYNC_PGRP_LOCKOUT	(1U << ASYNCB_PGRP_LOCKOUT)
    128 #define ASYNC_CALLOUT_NOHUP	(1U << ASYNCB_CALLOUT_NOHUP)
    129 #define ASYNC_HARDPPS_CD	(1U << ASYNCB_HARDPPS_CD)
    130 #define ASYNC_SPD_SHI		(1U << ASYNCB_SPD_SHI)
    131 #define ASYNC_LOW_LATENCY	(1U << ASYNCB_LOW_LATENCY)
    132 #define ASYNC_BUGGY_UART	(1U << ASYNCB_BUGGY_UART)
    133 #define ASYNC_AUTOPROBE		(1U << ASYNCB_AUTOPROBE)
    134 
    135 #define ASYNC_FLAGS		((1U << (ASYNCB_LAST_USER + 1)) - 1)
    136 #define ASYNC_USR_MASK		(ASYNC_SPD_HI|ASYNC_SPD_VHI| \
    137 		ASYNC_CALLOUT_NOHUP|ASYNC_SPD_SHI|ASYNC_LOW_LATENCY)
    138 #define ASYNC_SPD_CUST		(ASYNC_SPD_HI|ASYNC_SPD_VHI)
    139 #define ASYNC_SPD_WARP		(ASYNC_SPD_HI|ASYNC_SPD_SHI)
    140 #define ASYNC_SPD_MASK		(ASYNC_SPD_HI|ASYNC_SPD_VHI|ASYNC_SPD_SHI)
    141 
    142 #define ASYNC_INITIALIZED	(1U << ASYNCB_INITIALIZED)
    143 #define ASYNC_NORMAL_ACTIVE	(1U << ASYNCB_NORMAL_ACTIVE)
    144 #define ASYNC_BOOT_AUTOCONF	(1U << ASYNCB_BOOT_AUTOCONF)
    145 #define ASYNC_CLOSING		(1U << ASYNCB_CLOSING)
    146 #define ASYNC_CTS_FLOW		(1U << ASYNCB_CTS_FLOW)
    147 #define ASYNC_CHECK_CD		(1U << ASYNCB_CHECK_CD)
    148 #define ASYNC_SHARE_IRQ		(1U << ASYNCB_SHARE_IRQ)
    149 #define ASYNC_CONS_FLOW		(1U << ASYNCB_CONS_FLOW)
    150 #define ASYNC_BOOT_ONLYMCA	(1U << ASYNCB_BOOT_ONLYMCA)
    151 #define ASYNC_INTERNAL_FLAGS	(~((1U << ASYNCB_FIRST_KERNEL) - 1))
    152 
    153 /*
    154  * Multiport serial configuration structure --- external structure
    155  */
    156 struct serial_multiport_struct {
    157 	int		irq;
    158 	int		port1;
    159 	unsigned char	mask1, match1;
    160 	int		port2;
    161 	unsigned char	mask2, match2;
    162 	int		port3;
    163 	unsigned char	mask3, match3;
    164 	int		port4;
    165 	unsigned char	mask4, match4;
    166 	int		port_monitor;
    167 	int	reserved[32];
    168 };
    169 
    170 /*
    171  * Serial input interrupt line counters -- external structure
    172  * Four lines can interrupt: CTS, DSR, RI, DCD
    173  */
    174 struct serial_icounter_struct {
    175 	int cts, dsr, rng, dcd;
    176 	int rx, tx;
    177 	int frame, overrun, parity, brk;
    178 	int buf_overrun;
    179 	int reserved[9];
    180 };
    181 
    182 /*
    183  * Serial interface for controlling RS485 settings on chips with suitable
    184  * support. Set with TIOCSRS485 and get with TIOCGRS485 if supported by your
    185  * platform. The set function returns the new state, with any unsupported bits
    186  * reverted appropriately.
    187  */
    188 
    189 struct serial_rs485 {
    190 	__u32	flags;			/* RS485 feature flags */
    191 #define SER_RS485_ENABLED		(1 << 0)	/* If enabled */
    192 #define SER_RS485_RTS_ON_SEND		(1 << 1)	/* Logical level for
    193 							   RTS pin when
    194 							   sending */
    195 #define SER_RS485_RTS_AFTER_SEND	(1 << 2)	/* Logical level for
    196 							   RTS pin after sent*/
    197 #define SER_RS485_RX_DURING_TX		(1 << 4)
    198 	__u32	delay_rts_before_send;	/* Delay before send (milliseconds) */
    199 	__u32	delay_rts_after_send;	/* Delay after send (milliseconds) */
    200 	__u32	padding[5];		/* Memory is cheap, new structs
    201 					   are a royal PITA .. */
    202 };
    203 
    204 #endif /* _LINUX_SERIAL_H */
    205