uart.h revision 330897 
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2003 Marcel Moolenaar
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 *
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $FreeBSD: stable/11/sys/dev/uart/uart.h 330897 2018-03-14 03:19:51Z eadler $
29 */
30
31#ifndef _DEV_UART_H_
32#define _DEV_UART_H_
33
34/*
35 * Bus access structure. This structure holds the minimum information needed
36 * to access the UART. The rclk field, although not important to actually
37 * access the UART, is important for baudrate programming, delay loops and
38 * other timing related computations.
39 */
40struct uart_bas {
41	bus_space_tag_t bst;
42	bus_space_handle_t bsh;
43	u_int	chan;
44	u_int	rclk;
45	u_int	regshft;
46};
47
48#define	uart_regofs(bas, reg)		((reg) << (bas)->regshft)
49
50#define	uart_getreg(bas, reg)		\
51	bus_space_read_1((bas)->bst, (bas)->bsh, uart_regofs(bas, reg))
52#define	uart_setreg(bas, reg, value)	\
53	bus_space_write_1((bas)->bst, (bas)->bsh, uart_regofs(bas, reg), value)
54
55/*
56 * XXX we don't know the length of the bus space address range in use by
57 * the UART. Since barriers don't use the length field currently, we put
58 * a zero there for now.
59 */
60#define uart_barrier(bas)		\
61	bus_space_barrier((bas)->bst, (bas)->bsh, 0, 0,		\
62	    BUS_SPACE_BARRIER_READ|BUS_SPACE_BARRIER_WRITE)
63
64/*
65 * UART device classes.
66 */
67struct uart_class;
68
69extern struct uart_class uart_ns8250_class __attribute__((weak));
70extern struct uart_class uart_quicc_class __attribute__((weak));
71extern struct uart_class uart_s3c2410_class __attribute__((weak));
72extern struct uart_class uart_sab82532_class __attribute__((weak));
73extern struct uart_class uart_sbbc_class __attribute__((weak));
74extern struct uart_class uart_z8530_class __attribute__((weak));
75
76#ifdef PC98
77struct uart_class *uart_pc98_getdev(u_long port);
78#endif
79
80/*
81 * Device flags.
82 */
83#define	UART_FLAGS_CONSOLE(f)		((f) & 0x10)
84#define	UART_FLAGS_DBGPORT(f)		((f) & 0x80)
85#define	UART_FLAGS_FCR_RX_LOW(f)	((f) & 0x100)
86#define	UART_FLAGS_FCR_RX_MEDL(f)	((f) & 0x200)
87#define	UART_FLAGS_FCR_RX_MEDH(f)	((f) & 0x400)
88#define	UART_FLAGS_FCR_RX_HIGH(f)	((f) & 0x800)
89
90/*
91 * Data parity values (magical numbers related to ns8250).
92 */
93#define	UART_PARITY_NONE		0
94#define	UART_PARITY_ODD			1
95#define	UART_PARITY_EVEN		3
96#define	UART_PARITY_MARK		5
97#define	UART_PARITY_SPACE		7
98
99#endif /* _DEV_UART_H_ */
100