blob: ef914061511ec833c706a38ddf47cac8ad52d93a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Tim Schmielau4e57b682005-10-30 15:03:48 -080013#include <linux/types.h>
Andy Whitcroft60c20fb2009-01-02 13:49:04 +000014
15#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <asm/page.h>
17
18/*
19 * Counters of the input lines (CTS, DSR, RI, CD) interrupts
20 */
21
22struct async_icount {
23 __u32 cts, dsr, rng, dcd, tx, rx;
24 __u32 frame, parity, overrun, brk;
25 __u32 buf_overrun;
26};
27
28/*
29 * The size of the serial xmit buffer is 1 page, or 4096 bytes
30 */
31#define SERIAL_XMIT_SIZE PAGE_SIZE
32
33#endif
34
35struct serial_struct {
36 int type;
37 int line;
38 unsigned int port;
39 int irq;
40 int flags;
41 int xmit_fifo_size;
42 int custom_divisor;
43 int baud_base;
44 unsigned short close_delay;
45 char io_type;
46 char reserved_char[1];
47 int hub6;
48 unsigned short closing_wait; /* time to wait before closing */
49 unsigned short closing_wait2; /* no longer used... */
50 unsigned char *iomem_base;
51 unsigned short iomem_reg_shift;
52 unsigned int port_high;
53 unsigned long iomap_base; /* cookie passed into ioremap */
54};
55
56/*
57 * For the close wait times, 0 means wait forever for serial port to
58 * flush its output. 65535 means don't wait at all.
59 */
60#define ASYNC_CLOSING_WAIT_INF 0
61#define ASYNC_CLOSING_WAIT_NONE 65535
62
63/*
64 * These are the supported serial types.
65 */
66#define PORT_UNKNOWN 0
67#define PORT_8250 1
68#define PORT_16450 2
69#define PORT_16550 3
70#define PORT_16550A 4
71#define PORT_CIRRUS 5 /* usurped by cyclades.c */
72#define PORT_16650 6
73#define PORT_16650V2 7
74#define PORT_16750 8
75#define PORT_STARTECH 9 /* usurped by cyclades.c */
76#define PORT_16C950 10 /* Oxford Semiconductor */
77#define PORT_16654 11
78#define PORT_16850 12
79#define PORT_RSA 13 /* RSA-DV II/S card */
Philippe Langlais71cad052010-08-31 14:19:09 +020080#define PORT_MAX 13
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
82#define SERIAL_IO_PORT 0
83#define SERIAL_IO_HUB6 1
84#define SERIAL_IO_MEM 2
85
86struct serial_uart_config {
87 char *name;
88 int dfl_xmit_fifo_size;
89 int flags;
90};
91
92#define UART_CLEAR_FIFO 0x01
93#define UART_USE_FIFO 0x02
94#define UART_STARTECH 0x04
95#define UART_NATSEMI 0x08
96
97/*
98 * Definitions for async_struct (and serial_struct) flags field
Jiri Slaby70beaed2009-06-11 12:39:12 +010099 *
100 * Define ASYNCB_* for convenient use with {test,set,clear}_bit.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 */
Jiri Slaby70beaed2009-06-11 12:39:12 +0100102#define ASYNCB_HUP_NOTIFY 0 /* Notify getty on hangups and closes
103 * on the callout port */
104#define ASYNCB_FOURPORT 1 /* Set OU1, OUT2 per AST Fourport settings */
105#define ASYNCB_SAK 2 /* Secure Attention Key (Orange book) */
106#define ASYNCB_SPLIT_TERMIOS 3 /* Separate termios for dialin/callout */
107#define ASYNCB_SPD_HI 4 /* Use 56000 instead of 38400 bps */
108#define ASYNCB_SPD_VHI 5 /* Use 115200 instead of 38400 bps */
109#define ASYNCB_SKIP_TEST 6 /* Skip UART test during autoconfiguration */
110#define ASYNCB_AUTO_IRQ 7 /* Do automatic IRQ during
111 * autoconfiguration */
112#define ASYNCB_SESSION_LOCKOUT 8 /* Lock out cua opens based on session */
113#define ASYNCB_PGRP_LOCKOUT 9 /* Lock out cua opens based on pgrp */
114#define ASYNCB_CALLOUT_NOHUP 10 /* Don't do hangups for cua device */
115#define ASYNCB_HARDPPS_CD 11 /* Call hardpps when CD goes high */
116#define ASYNCB_SPD_SHI 12 /* Use 230400 instead of 38400 bps */
117#define ASYNCB_LOW_LATENCY 13 /* Request low latency behaviour */
118#define ASYNCB_BUGGY_UART 14 /* This is a buggy UART, skip some safety
119 * checks. Note: can be dangerous! */
120#define ASYNCB_AUTOPROBE 15 /* Port was autoprobed by PCI or PNP code */
121#define ASYNCB_LAST_USER 15
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Jiri Slaby70beaed2009-06-11 12:39:12 +0100123/* Internal flags used only by kernel */
124#define ASYNCB_INITIALIZED 31 /* Serial port was initialized */
Alan Coxccce6de2009-09-19 13:13:30 -0700125#define ASYNCB_SUSPENDED 30 /* Serial port is suspended */
Jiri Slaby70beaed2009-06-11 12:39:12 +0100126#define ASYNCB_NORMAL_ACTIVE 29 /* Normal device is active */
127#define ASYNCB_BOOT_AUTOCONF 28 /* Autoconfigure port on bootup */
128#define ASYNCB_CLOSING 27 /* Serial port is closing */
129#define ASYNCB_CTS_FLOW 26 /* Do CTS flow control */
130#define ASYNCB_CHECK_CD 25 /* i.e., CLOCAL */
131#define ASYNCB_SHARE_IRQ 24 /* for multifunction cards, no longer used */
132#define ASYNCB_CONS_FLOW 23 /* flow control for console */
133#define ASYNCB_BOOT_ONLYMCA 22 /* Probe only if MCA bus */
134#define ASYNCB_FIRST_KERNEL 22
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Jiri Slaby70beaed2009-06-11 12:39:12 +0100136#define ASYNC_HUP_NOTIFY (1U << ASYNCB_HUP_NOTIFY)
Alan Coxccce6de2009-09-19 13:13:30 -0700137#define ASYNC_SUSPENDED (1U << ASYNCB_SUSPENDED)
Jiri Slaby70beaed2009-06-11 12:39:12 +0100138#define ASYNC_FOURPORT (1U << ASYNCB_FOURPORT)
139#define ASYNC_SAK (1U << ASYNCB_SAK)
140#define ASYNC_SPLIT_TERMIOS (1U << ASYNCB_SPLIT_TERMIOS)
141#define ASYNC_SPD_HI (1U << ASYNCB_SPD_HI)
142#define ASYNC_SPD_VHI (1U << ASYNCB_SPD_VHI)
143#define ASYNC_SKIP_TEST (1U << ASYNCB_SKIP_TEST)
144#define ASYNC_AUTO_IRQ (1U << ASYNCB_AUTO_IRQ)
145#define ASYNC_SESSION_LOCKOUT (1U << ASYNCB_SESSION_LOCKOUT)
146#define ASYNC_PGRP_LOCKOUT (1U << ASYNCB_PGRP_LOCKOUT)
147#define ASYNC_CALLOUT_NOHUP (1U << ASYNCB_CALLOUT_NOHUP)
148#define ASYNC_HARDPPS_CD (1U << ASYNCB_HARDPPS_CD)
149#define ASYNC_SPD_SHI (1U << ASYNCB_SPD_SHI)
150#define ASYNC_LOW_LATENCY (1U << ASYNCB_LOW_LATENCY)
151#define ASYNC_BUGGY_UART (1U << ASYNCB_BUGGY_UART)
152#define ASYNC_AUTOPROBE (1U << ASYNCB_AUTOPROBE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
John Villalovos93e3d582010-07-20 15:26:46 -0700154#define ASYNC_FLAGS ((1U << (ASYNCB_LAST_USER + 1)) - 1)
Jiri Slaby70beaed2009-06-11 12:39:12 +0100155#define ASYNC_USR_MASK (ASYNC_SPD_HI|ASYNC_SPD_VHI| \
156 ASYNC_CALLOUT_NOHUP|ASYNC_SPD_SHI|ASYNC_LOW_LATENCY)
157#define ASYNC_SPD_CUST (ASYNC_SPD_HI|ASYNC_SPD_VHI)
158#define ASYNC_SPD_WARP (ASYNC_SPD_HI|ASYNC_SPD_SHI)
159#define ASYNC_SPD_MASK (ASYNC_SPD_HI|ASYNC_SPD_VHI|ASYNC_SPD_SHI)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Jiri Slaby70beaed2009-06-11 12:39:12 +0100161#define ASYNC_INITIALIZED (1U << ASYNCB_INITIALIZED)
162#define ASYNC_NORMAL_ACTIVE (1U << ASYNCB_NORMAL_ACTIVE)
163#define ASYNC_BOOT_AUTOCONF (1U << ASYNCB_BOOT_AUTOCONF)
164#define ASYNC_CLOSING (1U << ASYNCB_CLOSING)
165#define ASYNC_CTS_FLOW (1U << ASYNCB_CTS_FLOW)
166#define ASYNC_CHECK_CD (1U << ASYNCB_CHECK_CD)
167#define ASYNC_SHARE_IRQ (1U << ASYNCB_SHARE_IRQ)
168#define ASYNC_CONS_FLOW (1U << ASYNCB_CONS_FLOW)
169#define ASYNC_BOOT_ONLYMCA (1U << ASYNCB_BOOT_ONLYMCA)
170#define ASYNC_INTERNAL_FLAGS (~((1U << ASYNCB_FIRST_KERNEL) - 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172/*
173 * Multiport serial configuration structure --- external structure
174 */
175struct serial_multiport_struct {
176 int irq;
177 int port1;
178 unsigned char mask1, match1;
179 int port2;
180 unsigned char mask2, match2;
181 int port3;
182 unsigned char mask3, match3;
183 int port4;
184 unsigned char mask4, match4;
185 int port_monitor;
186 int reserved[32];
187};
188
189/*
190 * Serial input interrupt line counters -- external structure
191 * Four lines can interrupt: CTS, DSR, RI, DCD
192 */
193struct serial_icounter_struct {
194 int cts, dsr, rng, dcd;
195 int rx, tx;
196 int frame, overrun, parity, brk;
197 int buf_overrun;
198 int reserved[9];
199};
200
Alan Coxc26c56c2008-10-13 10:37:48 +0100201/*
202 * Serial interface for controlling RS485 settings on chips with suitable
203 * support. Set with TIOCSRS485 and get with TIOCGRS485 if supported by your
204 * platform. The set function returns the new state, with any unsupported bits
205 * reverted appropriately.
206 */
207
208struct serial_rs485 {
209 __u32 flags; /* RS485 feature flags */
210#define SER_RS485_ENABLED (1 << 0)
211#define SER_RS485_RTS_ON_SEND (1 << 1)
212#define SER_RS485_RTS_AFTER_SEND (1 << 2)
Claudio Scordino1b633182010-07-20 15:26:47 -0700213#define SER_RS485_RTS_BEFORE_SEND (1 << 3)
Alan Coxc26c56c2008-10-13 10:37:48 +0100214 __u32 delay_rts_before_send; /* Milliseconds */
Claudio Scordino1b633182010-07-20 15:26:47 -0700215 __u32 delay_rts_after_send; /* Milliseconds */
216 __u32 padding[5]; /* Memory is cheap, new structs
Alan Coxc26c56c2008-10-13 10:37:48 +0100217 are a royal PITA .. */
218};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220#ifdef __KERNEL__
Russell King661f83a2005-07-16 09:30:53 +0100221#include <linux/compiler.h>
222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223#endif /* __KERNEL__ */
224#endif /* _LINUX_SERIAL_H */