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$ 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 */ 38 struct 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 */ 65 struct uart_class; 66 67 extern struct uart_class uart_imx_class __attribute__((weak)); 68 extern struct uart_class uart_ns8250_class __attribute__((weak)); 69 extern struct uart_class uart_quicc_class __attribute__((weak)); 70 extern struct uart_class uart_s3c2410_class __attribute__((weak)); 71 extern struct uart_class uart_sab82532_class __attribute__((weak)); 72 extern struct uart_class uart_sbbc_class __attribute__((weak)); 73 extern struct uart_class uart_z8530_class __attribute__((weak)); 74 extern struct uart_class uart_lpc_class __attribute__((weak)); 75 extern struct uart_class uart_pl011_class __attribute__((weak)); 76 extern struct uart_class uart_cdnc_class __attribute__((weak)); 77 extern struct uart_class uart_ti8250_class __attribute__((weak)); 78 79 #ifdef PC98 80 struct uart_class *uart_pc98_getdev(u_long port); 81 #endif 82 83 /* 84 * Device flags. 85 */ 86 #define UART_FLAGS_CONSOLE(f) ((f) & 0x10) 87 #define UART_FLAGS_DBGPORT(f) ((f) & 0x80) 88 #define UART_FLAGS_FCR_RX_LOW(f) ((f) & 0x100) 89 #define UART_FLAGS_FCR_RX_MEDL(f) ((f) & 0x200) 90 #define UART_FLAGS_FCR_RX_MEDH(f) ((f) & 0x400) 91 #define UART_FLAGS_FCR_RX_HIGH(f) ((f) & 0x800) 92 93 /* 94 * Data parity values (magical numbers related to ns8250). 95 */ 96 #define UART_PARITY_NONE 0 97 #define UART_PARITY_ODD 1 98 #define UART_PARITY_EVEN 3 99 #define UART_PARITY_MARK 5 100 #define UART_PARITY_SPACE 7 101 102 #endif /* _DEV_UART_H_ */ 103