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