1/*-
2 * Copyright (c) 2004 Poul-Henning Kamp
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * This file contains definitions which pertain to serial ports as such,
27 * (both async and sync), but which do not necessarily have anything to
28 * do with tty processing.
29 *
30 * $FreeBSD$
31 */
32
33#ifndef _SYS_SERIAL_H_
34#define	_SYS_SERIAL_H_
35
36
37/*
38 * Indentification of modem control signals.  These definitions match
39 * the TIOCMGET definitions in <sys/ttycom.h> shifted a bit down, and
40 * that identity is enforced with CTASSERT at the bottom of kern/tty.c
41 * Both the modem bits and delta bits must fit in 16 bit.
42 */
43#define	SER_DTR		0x0001		/* data terminal ready */
44#define	SER_RTS		0x0002		/* request to send */
45#define	SER_STX		0x0004		/* secondary transmit */
46#define	SER_SRX		0x0008		/* secondary receive */
47#define	SER_CTS		0x0010		/* clear to send */
48#define	SER_DCD		0x0020		/* data carrier detect */
49#define	SER_RI	 	0x0040		/* ring indicate */
50#define	SER_DSR		0x0080		/* data set ready */
51
52#define	SER_MASK_STATE	0x00ff
53
54/* Delta bits, used to indicate which signals should/was affected */
55#define	SER_DELTA(x)	((x) << 8)
56
57#define	SER_DDTR	SER_DELTA(SER_DTR)
58#define	SER_DRTS	SER_DELTA(SER_RTS)
59#define	SER_DSTX	SER_DELTA(SER_STX)
60#define	SER_DSRX	SER_DELTA(SER_SRX)
61#define	SER_DCTS	SER_DELTA(SER_CTS)
62#define	SER_DDCD	SER_DELTA(SER_DCD)
63#define	SER_DRI		SER_DELTA(SER_RI)
64#define	SER_DDSR	SER_DELTA(SER_DSR)
65
66#define	SER_MASK_DELTA	SER_DELTA(SER_MASK_STATE)
67
68#ifdef _KERNEL
69/*
70 * Specification of interrupt sources typical for serial ports. These are
71 * useful when some umbrella driver like scc(4) has enough knowledge of
72 * the hardware to obtain the set of pending interrupts but does not itself
73 * handle the interrupt. Each interrupt source can be given an interrupt
74 * resource for which inferior drivers can install handlers. The lower 16
75 * bits are kept free for the signals above.
76 */
77#define	SER_INT_OVERRUN	0x010000
78#define	SER_INT_BREAK	0x020000
79#define	SER_INT_RXREADY	0x040000
80#define	SER_INT_SIGCHG	0x080000
81#define	SER_INT_TXIDLE	0x100000
82
83#define	SER_INT_MASK	0xff0000
84#define	SER_INT_SIGMASK	(SER_MASK_DELTA | SER_MASK_STATE)
85
86#ifndef LOCORE
87typedef int serdev_intr_t(void*);
88#endif
89
90#endif	/* _KERNEL */
91
92#endif /* !_SYS_SERIAL_H_ */
93