1 /*- 2 * Copyright (c) 2003, 2004 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_CPU_H_ 30 #define _DEV_UART_CPU_H_ 31 32 #include <sys/kdb.h> 33 #include <sys/lock.h> 34 #include <sys/mutex.h> 35 36 struct uart_softc; 37 38 /* 39 * Low-level operations for use by console and/or debug port support. 40 */ 41 struct uart_ops { 42 int (*probe)(struct uart_bas *); 43 void (*init)(struct uart_bas *, int, int, int, int); 44 void (*term)(struct uart_bas *); 45 void (*putc)(struct uart_bas *, int); 46 int (*rxready)(struct uart_bas *); 47 int (*getc)(struct uart_bas *, struct mtx *); 48 }; 49 50 extern bus_space_tag_t uart_bus_space_io; 51 extern bus_space_tag_t uart_bus_space_mem; 52 53 /* 54 * Console and debug port device info. 55 */ 56 struct uart_devinfo { 57 SLIST_ENTRY(uart_devinfo) next; 58 struct uart_ops *ops; 59 struct uart_bas bas; 60 int baudrate; 61 int databits; 62 int stopbits; 63 int parity; 64 int type; 65 #define UART_DEV_CONSOLE 0 66 #define UART_DEV_DBGPORT 1 67 #define UART_DEV_KEYBOARD 2 68 int (*attach)(struct uart_softc*); 69 int (*detach)(struct uart_softc*); 70 void *cookie; /* Type dependent use. */ 71 struct mtx *hwmtx; 72 struct uart_softc *sc; /* valid only from start of attach */ 73 }; 74 75 int uart_cpu_eqres(struct uart_bas *, struct uart_bas *); 76 int uart_cpu_getdev(int, struct uart_devinfo *); 77 78 int uart_getenv(int, struct uart_devinfo *, struct uart_class *); 79 const char *uart_getname(struct uart_class *); 80 struct uart_ops *uart_getops(struct uart_class *); 81 int uart_getrange(struct uart_class *); 82 u_int uart_getregshift(struct uart_class *); 83 u_int uart_getregiowidth(struct uart_class *); 84 85 void uart_add_sysdev(struct uart_devinfo *); 86 87 /* 88 * Operations for low-level access to the UART. Primarily for use 89 * by console and debug port logic. 90 */ 91 92 static __inline void 93 uart_lock(struct mtx *hwmtx) 94 { 95 if (!kdb_active && hwmtx != NULL) 96 mtx_lock_spin(hwmtx); 97 } 98 99 static __inline void 100 uart_unlock(struct mtx *hwmtx) 101 { 102 if (!kdb_active && hwmtx != NULL) 103 mtx_unlock_spin(hwmtx); 104 } 105 106 static __inline int 107 uart_probe(struct uart_devinfo *di) 108 { 109 int res; 110 111 uart_lock(di->hwmtx); 112 res = di->ops->probe(&di->bas); 113 uart_unlock(di->hwmtx); 114 return (res); 115 } 116 117 static __inline void 118 uart_init(struct uart_devinfo *di) 119 { 120 uart_lock(di->hwmtx); 121 di->ops->init(&di->bas, di->baudrate, di->databits, di->stopbits, 122 di->parity); 123 uart_unlock(di->hwmtx); 124 } 125 126 static __inline void 127 uart_term(struct uart_devinfo *di) 128 { 129 uart_lock(di->hwmtx); 130 di->ops->term(&di->bas); 131 uart_unlock(di->hwmtx); 132 } 133 134 static __inline void 135 uart_putc(struct uart_devinfo *di, int c) 136 { 137 uart_lock(di->hwmtx); 138 di->ops->putc(&di->bas, c); 139 uart_unlock(di->hwmtx); 140 } 141 142 static __inline int 143 uart_rxready(struct uart_devinfo *di) 144 { 145 int res; 146 147 uart_lock(di->hwmtx); 148 res = di->ops->rxready(&di->bas); 149 uart_unlock(di->hwmtx); 150 return (res); 151 } 152 153 static __inline int 154 uart_poll(struct uart_devinfo *di) 155 { 156 int res; 157 158 uart_lock(di->hwmtx); 159 if (di->ops->rxready(&di->bas)) 160 res = di->ops->getc(&di->bas, NULL); 161 else 162 res = -1; 163 uart_unlock(di->hwmtx); 164 return (res); 165 } 166 167 static __inline int 168 uart_getc(struct uart_devinfo *di) 169 { 170 171 return (di->ops->getc(&di->bas, di->hwmtx)); 172 } 173 174 void uart_grab(struct uart_devinfo *di); 175 void uart_ungrab(struct uart_devinfo *di); 176 177 #endif /* _DEV_UART_CPU_H_ */ 178