uart_bus.h revision 286469
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_bus.h 286469 2015-08-08 20:11:47Z ian $ 27 */ 28 29#ifndef _DEV_UART_BUS_H_ 30#define _DEV_UART_BUS_H_ 31 32#ifndef KLD_MODULE 33#include "opt_uart.h" 34#endif 35 36#include <sys/serial.h> 37#include <sys/timepps.h> 38 39/* Drain and flush targets. */ 40#define UART_DRAIN_RECEIVER 0x0001 41#define UART_DRAIN_TRANSMITTER 0x0002 42#define UART_FLUSH_RECEIVER UART_DRAIN_RECEIVER 43#define UART_FLUSH_TRANSMITTER UART_DRAIN_TRANSMITTER 44 45/* Received character status bits. */ 46#define UART_STAT_BREAK 0x0100 47#define UART_STAT_FRAMERR 0x0200 48#define UART_STAT_OVERRUN 0x0400 49#define UART_STAT_PARERR 0x0800 50 51#ifdef UART_PPS_ON_CTS 52#define UART_SIG_DPPS SER_DCTS 53#define UART_SIG_PPS SER_CTS 54#else 55#define UART_SIG_DPPS SER_DDCD 56#define UART_SIG_PPS SER_DCD 57#endif 58 59/* UART_IOCTL() requests */ 60#define UART_IOCTL_BREAK 1 61#define UART_IOCTL_IFLOW 2 62#define UART_IOCTL_OFLOW 3 63#define UART_IOCTL_BAUD 4 64 65/* 66 * UART class & instance (=softc) 67 */ 68struct uart_class { 69 KOBJ_CLASS_FIELDS; 70 struct uart_ops *uc_ops; /* Low-level console operations. */ 71 u_int uc_range; /* Bus space address range. */ 72 u_int uc_rclk; /* Default rclk for this device. */ 73 u_int uc_rshift; /* Default regshift for this device. */ 74}; 75 76struct uart_softc { 77 KOBJ_FIELDS; 78 struct uart_class *sc_class; 79 struct uart_bas sc_bas; 80 device_t sc_dev; 81 82 struct mtx sc_hwmtx_s; /* Spinlock protecting hardware. */ 83 struct mtx *sc_hwmtx; 84 85 struct resource *sc_rres; /* Register resource. */ 86 int sc_rrid; 87 int sc_rtype; /* SYS_RES_{IOPORT|MEMORY}. */ 88 struct resource *sc_ires; /* Interrupt resource. */ 89 void *sc_icookie; 90 int sc_irid; 91 struct callout sc_timer; 92 93 int sc_callout:1; /* This UART is opened for callout. */ 94 int sc_fastintr:1; /* This UART uses fast interrupts. */ 95 int sc_hwiflow:1; /* This UART has HW input flow ctl. */ 96 int sc_hwoflow:1; /* This UART has HW output flow ctl. */ 97 int sc_leaving:1; /* This UART is going away. */ 98 int sc_opened:1; /* This UART is open for business. */ 99 int sc_polled:1; /* This UART has no interrupts. */ 100 int sc_txbusy:1; /* This UART is transmitting. */ 101 int sc_isquelch:1; /* This UART has input squelched. */ 102 int sc_testintr:1; /* This UART is under int. testing. */ 103 104 struct uart_devinfo *sc_sysdev; /* System device (or NULL). */ 105 106 int sc_altbrk; /* State for alt break sequence. */ 107 uint32_t sc_hwsig; /* Signal state. Used by HW driver. */ 108 109 /* Receiver data. */ 110 uint16_t *sc_rxbuf; 111 int sc_rxbufsz; 112 int sc_rxput; 113 int sc_rxget; 114 int sc_rxfifosz; /* Size of RX FIFO. */ 115 116 /* Transmitter data. */ 117 uint8_t *sc_txbuf; 118 int sc_txdatasz; 119 int sc_txfifosz; /* Size of TX FIFO and buffer. */ 120 121 /* Pulse capturing support (PPS). */ 122 struct pps_state sc_pps; 123 124 /* Upper layer data. */ 125 void *sc_softih; 126 uint32_t sc_ttypend; 127 union { 128 /* TTY specific data. */ 129 struct { 130 struct tty *tp; 131 } u_tty; 132 /* Keyboard specific data. */ 133 struct { 134 } u_kbd; 135 } sc_u; 136}; 137 138extern devclass_t uart_devclass; 139extern const char uart_driver_name[]; 140 141int uart_bus_attach(device_t dev); 142int uart_bus_detach(device_t dev); 143int uart_bus_resume(device_t dev); 144serdev_intr_t *uart_bus_ihand(device_t dev, int ipend); 145int uart_bus_ipend(device_t dev); 146int uart_bus_probe(device_t dev, int regshft, int rclk, int rid, int chan); 147int uart_bus_sysdev(device_t dev); 148 149void uart_sched_softih(struct uart_softc *, uint32_t); 150 151int uart_tty_attach(struct uart_softc *); 152int uart_tty_detach(struct uart_softc *); 153struct mtx *uart_tty_getlock(struct uart_softc *); 154void uart_tty_intr(void *arg); 155 156/* 157 * Receive buffer operations. 158 */ 159static __inline int 160uart_rx_empty(struct uart_softc *sc) 161{ 162 163 return ((sc->sc_rxget == sc->sc_rxput) ? 1 : 0); 164} 165 166static __inline int 167uart_rx_full(struct uart_softc *sc) 168{ 169 170 return ((sc->sc_rxput + 1 < sc->sc_rxbufsz) ? 171 (sc->sc_rxput + 1 == sc->sc_rxget) : (sc->sc_rxget == 0)); 172} 173 174static __inline int 175uart_rx_get(struct uart_softc *sc) 176{ 177 int ptr, xc; 178 179 ptr = sc->sc_rxget; 180 if (ptr == sc->sc_rxput) 181 return (-1); 182 xc = sc->sc_rxbuf[ptr++]; 183 sc->sc_rxget = (ptr < sc->sc_rxbufsz) ? ptr : 0; 184 return (xc); 185} 186 187static __inline int 188uart_rx_next(struct uart_softc *sc) 189{ 190 int ptr; 191 192 ptr = sc->sc_rxget; 193 if (ptr == sc->sc_rxput) 194 return (-1); 195 ptr += 1; 196 sc->sc_rxget = (ptr < sc->sc_rxbufsz) ? ptr : 0; 197 return (0); 198} 199 200static __inline int 201uart_rx_peek(struct uart_softc *sc) 202{ 203 int ptr; 204 205 ptr = sc->sc_rxget; 206 return ((ptr == sc->sc_rxput) ? -1 : sc->sc_rxbuf[ptr]); 207} 208 209static __inline int 210uart_rx_put(struct uart_softc *sc, int xc) 211{ 212 int ptr; 213 214 ptr = (sc->sc_rxput + 1 < sc->sc_rxbufsz) ? sc->sc_rxput + 1 : 0; 215 if (ptr == sc->sc_rxget) 216 return (ENOSPC); 217 sc->sc_rxbuf[sc->sc_rxput] = xc; 218 sc->sc_rxput = ptr; 219 return (0); 220} 221 222#endif /* _DEV_UART_BUS_H_ */ 223