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