uart.h revision 266095
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: stable/10/sys/dev/uart/uart.h 266095 2014-05-14 23:17:33Z ian $ 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 chan; 42 u_int rclk; 43 u_int regshft; 44}; 45 46#define uart_regofs(bas, reg) ((reg) << (bas)->regshft) 47 48#define uart_getreg(bas, reg) \ 49 bus_space_read_1((bas)->bst, (bas)->bsh, uart_regofs(bas, reg)) 50#define uart_setreg(bas, reg, value) \ 51 bus_space_write_1((bas)->bst, (bas)->bsh, uart_regofs(bas, reg), value) 52 53/* 54 * XXX we don't know the length of the bus space address range in use by 55 * the UART. Since barriers don't use the length field currently, we put 56 * a zero there for now. 57 */ 58#define uart_barrier(bas) \ 59 bus_space_barrier((bas)->bst, (bas)->bsh, 0, 0, \ 60 BUS_SPACE_BARRIER_READ|BUS_SPACE_BARRIER_WRITE) 61 62/* 63 * UART device classes. 64 */ 65struct uart_class; 66 67extern struct uart_class uart_imx_class __attribute__((weak)); 68extern struct uart_class uart_ns8250_class __attribute__((weak)); 69extern struct uart_class uart_quicc_class __attribute__((weak)); 70extern struct uart_class uart_s3c2410_class __attribute__((weak)); 71extern struct uart_class uart_sab82532_class __attribute__((weak)); 72extern struct uart_class uart_sbbc_class __attribute__((weak)); 73extern struct uart_class uart_z8530_class __attribute__((weak)); 74extern struct uart_class uart_lpc_class __attribute__((weak)); 75extern struct uart_class uart_pl011_class __attribute__((weak)); 76extern struct uart_class uart_cdnc_class __attribute__((weak)); 77extern struct uart_class uart_ti8250_class __attribute__((weak)); 78extern struct uart_class uart_vybrid_class __attribute__((weak)); 79extern struct uart_class at91_usart_class __attribute__((weak)); 80 81#ifdef FDT 82struct ofw_compat_data; 83extern const struct ofw_compat_data *uart_fdt_compat_data; 84#endif 85 86#ifdef PC98 87struct uart_class *uart_pc98_getdev(u_long port); 88#endif 89 90/* 91 * Device flags. 92 */ 93#define UART_FLAGS_CONSOLE(f) ((f) & 0x10) 94#define UART_FLAGS_DBGPORT(f) ((f) & 0x80) 95#define UART_FLAGS_FCR_RX_LOW(f) ((f) & 0x100) 96#define UART_FLAGS_FCR_RX_MEDL(f) ((f) & 0x200) 97#define UART_FLAGS_FCR_RX_MEDH(f) ((f) & 0x400) 98#define UART_FLAGS_FCR_RX_HIGH(f) ((f) & 0x800) 99 100/* 101 * Data parity values (magical numbers related to ns8250). 102 */ 103#define UART_PARITY_NONE 0 104#define UART_PARITY_ODD 1 105#define UART_PARITY_EVEN 3 106#define UART_PARITY_MARK 5 107#define UART_PARITY_SPACE 7 108 109#endif /* _DEV_UART_H_ */ 110