uart.h revision 120452
1119815Smarcel/* 2119815Smarcel * Copyright (c) 2003 Marcel Moolenaar 3119815Smarcel * All rights reserved. 4119815Smarcel * 5119815Smarcel * Redistribution and use in source and binary forms, with or without 6119815Smarcel * modification, are permitted provided that the following conditions 7119815Smarcel * are met: 8119815Smarcel * 9119815Smarcel * 1. Redistributions of source code must retain the above copyright 10119815Smarcel * notice, this list of conditions and the following disclaimer. 11119815Smarcel * 2. Redistributions in binary form must reproduce the above copyright 12119815Smarcel * notice, this list of conditions and the following disclaimer in the 13119815Smarcel * documentation and/or other materials provided with the distribution. 14119815Smarcel * 15119815Smarcel * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16119815Smarcel * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17119815Smarcel * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18119815Smarcel * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19119815Smarcel * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20119815Smarcel * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21119815Smarcel * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22119815Smarcel * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23119815Smarcel * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24119815Smarcel * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25119815Smarcel * 26119815Smarcel * $FreeBSD: head/sys/dev/uart/uart.h 120452 2003-09-26 05:14:56Z marcel $ 27119815Smarcel */ 28119815Smarcel 29119815Smarcel#ifndef _DEV_UART_H_ 30119815Smarcel#define _DEV_UART_H_ 31119815Smarcel 32119815Smarcel/* 33119815Smarcel * Bus access structure. This structure holds the minimum information needed 34119815Smarcel * to access the UART. The rclk field, although not important to actually 35119815Smarcel * access the UART, is important for baudrate programming, delay loops and 36119815Smarcel * other timing related computations. 37119815Smarcel */ 38119815Smarcelstruct uart_bas { 39119815Smarcel bus_space_tag_t bst; 40119815Smarcel bus_space_handle_t bsh; 41120452Smarcel u_int chan; 42120452Smarcel u_int rclk; 43119815Smarcel u_int regshft; 44119815Smarcel}; 45119815Smarcel 46119815Smarcel#define uart_regofs(bas, reg) ((reg) << (bas)->regshft) 47119815Smarcel 48119815Smarcel#define uart_getreg(bas, reg) \ 49119815Smarcel bus_space_read_1((bas)->bst, (bas)->bsh, uart_regofs(bas, reg)) 50119815Smarcel#define uart_setreg(bas, reg, value) \ 51119815Smarcel bus_space_write_1((bas)->bst, (bas)->bsh, uart_regofs(bas, reg), value) 52119815Smarcel 53119815Smarcel/* 16-bit I/O (e.g. to divisor latch) */ 54119815Smarcel#define uart_getdreg(bas, reg) \ 55119815Smarcel bus_space_read_2((bas)->bst, (bas)->bsh, uart_regofs(bas, reg)) 56119815Smarcel#define uart_setdreg(bas, reg, value) \ 57119815Smarcel bus_space_write_2((bas)->bst, (bas)->bsh, uart_regofs(bas, reg), value) 58119815Smarcel 59119815Smarcel/* 60119815Smarcel * XXX we don't know the length of the bus space address range in use by 61119815Smarcel * the UART. Since barriers don't use the length field currently, we put 62119815Smarcel * a zero there for now. 63119815Smarcel */ 64119815Smarcel#define uart_barrier(bas) \ 65119815Smarcel bus_space_barrier((bas)->bst, (bas)->bsh, 0, 0, \ 66119815Smarcel BUS_SPACE_BARRIER_READ|BUS_SPACE_BARRIER_WRITE) 67119815Smarcel 68119815Smarcel/* 69119815Smarcel * Device flags. 70119815Smarcel */ 71119815Smarcel#define UART_FLAGS_CONSOLE(f) ((f) & 0x10) 72119815Smarcel#define UART_FLAGS_DBGPORT(f) ((f) & 0x80) 73119815Smarcel 74119815Smarcel/* 75119815Smarcel * Data parity values (magical numbers related to ns8250). 76119815Smarcel */ 77119815Smarcel#define UART_PARITY_NONE 0 78119815Smarcel#define UART_PARITY_ODD 1 79119815Smarcel#define UART_PARITY_EVEN 3 80119815Smarcel#define UART_PARITY_MARK 5 81119815Smarcel#define UART_PARITY_SPACE 7 82119815Smarcel 83119815Smarcel#endif /* _DEV_UART_H_ */ 84