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 27 #include <sys/cdefs.h> 28 __FBSDID("$FreeBSD$"); 29 30 #include <sys/param.h> 31 #include <sys/systm.h> 32 33 #include <machine/bus.h> 34 #include <machine/bus_private.h> 35 36 #include <dev/ofw/openfirm.h> 37 #include <machine/ofw_machdep.h> 38 39 #include <dev/uart/uart.h> 40 #include <dev/uart/uart_cpu.h> 41 42 bus_space_tag_t uart_bus_space_io; 43 bus_space_tag_t uart_bus_space_mem; 44 45 static struct bus_space_tag bst_store[3]; 46 47 /* 48 * Determine which channel of a SCC a device referenced by an alias is. 49 * The information present in the OF device tree only allows to do this 50 * for "ttyX" aliases. If a device is a channel of a SCC its property 51 * in the /aliases node looks like one of these: 52 * ttya: '/central/fhc/zs@0,902000:a' 53 * ttyc: '/pci@1f,0/pci@1,1/ebus@1/se@14,400000:a' 54 */ 55 static int 56 uart_cpu_channel(char *dev) 57 { 58 char alias[64]; 59 phandle_t aliases; 60 int len; 61 62 strcpy(alias, dev); 63 if ((aliases = OF_finddevice("/aliases")) != -1) 64 OF_getprop(aliases, dev, alias, sizeof(alias)); 65 len = strlen(alias); 66 if (len < 2 || alias[len - 2] != ':' || alias[len - 1] < 'a' || 67 alias[len - 1] > 'b') 68 return (0); 69 return (alias[len - 1] - 'a' + 1); 70 } 71 72 int 73 uart_cpu_eqres(struct uart_bas *b1, struct uart_bas *b2) 74 { 75 76 return ((b1->bsh == b2->bsh) ? 1 : 0); 77 } 78 79 /* 80 * Get the package handle of the UART that is selected as the console, if 81 * the console is an UART of course. Note that we enforce that both stdin 82 * and stdout are selected. 83 * Note that the currently active console (i.e. /chosen/stdout and 84 * /chosen/stdin) may not be the same as the device selected in the 85 * environment (ie /options/output-device and /options/input-device) because 86 * keyboard and screen were selected but the keyboard was unplugged or the 87 * user has changed the environment. In the latter case I would assume that 88 * the user expects that FreeBSD uses the new console setting. 89 * For weirder configurations, use ofw_console(4). 90 */ 91 static phandle_t 92 uart_cpu_getdev_console(phandle_t options, char *dev, size_t devsz) 93 { 94 char buf[32]; 95 ihandle_t stdin, stdout; 96 phandle_t chosen, input; 97 98 if (OF_getprop(options, "input-device", dev, devsz) == -1) 99 return (-1); 100 if ((input = OF_finddevice(dev)) == -1) 101 return (-1); 102 if (OF_getprop(options, "output-device", buf, sizeof(buf)) == -1) 103 return (-1); 104 if (!strcmp(dev, "keyboard") && !strcmp(buf, "screen")) { 105 if ((chosen = OF_finddevice("/chosen")) == -1) 106 return (-1); 107 if (OF_getprop(chosen, "stdin", &stdin, sizeof(stdin)) == -1) 108 return (-1); 109 if ((input = OF_instance_to_package(stdin)) == -1) 110 return (-1); 111 if (OF_getprop(chosen, "stdout", &stdout, sizeof(stdout)) == -1) 112 return (-1); 113 if (OF_instance_to_package(stdout) != input) 114 return (-1); 115 snprintf(dev, devsz, "ttya"); 116 } else if (OF_finddevice(buf) != input) 117 return (-1); 118 if (OF_getprop(input, "device_type", buf, sizeof(buf)) == -1) 119 return (-1); 120 if (strcmp(buf, "serial") != 0) 121 return (-1); 122 return (input); 123 } 124 125 /* 126 * Get the package handle of the UART that's selected as the debug port. 127 * Since there's no place for this in the OF, we use the kernel environment 128 * variable "hw.uart.dbgport". Note however that the variable is not a 129 * list of attributes. It's single device name or alias, as known by 130 * the OF. 131 */ 132 static phandle_t 133 uart_cpu_getdev_dbgport(phandle_t options, char *dev, size_t devsz) 134 { 135 char buf[32]; 136 phandle_t input; 137 138 if (!getenv_string("hw.uart.dbgport", dev, devsz)) 139 return (-1); 140 if ((input = OF_finddevice(dev)) == -1) 141 return (-1); 142 if (OF_getprop(input, "device_type", buf, sizeof(buf)) == -1) 143 return (-1); 144 if (strcmp(buf, "serial") != 0) 145 return (-1); 146 return (input); 147 } 148 149 /* 150 * Get the package handle of the device that is selected as the keyboard 151 * port. 152 * XXX this also matches PS/2 keyboard controllers and most likely also 153 * USB keyboards. 154 */ 155 static phandle_t 156 uart_cpu_getdev_keyboard(phandle_t root, char *dev, size_t devsz) 157 { 158 char buf[32]; 159 phandle_t child, node; 160 161 child = OF_child(root); 162 while (child != 0 && child != -1) { 163 if (OF_getprop(child, "device_type", buf, sizeof(buf)) != -1 && 164 !strcmp(buf, "serial") && 165 OF_getprop(child, "keyboard", buf, sizeof(buf)) != -1) { 166 OF_getprop(child, "name", dev, devsz); 167 return (child); 168 } 169 if ((node = uart_cpu_getdev_keyboard(child, dev, devsz)) != -1) 170 return (node); 171 child = OF_peer(child); 172 } 173 return (-1); 174 } 175 176 int 177 uart_cpu_getdev(int devtype, struct uart_devinfo *di) 178 { 179 char buf[32], dev[32], compat[32]; 180 phandle_t input, options; 181 bus_addr_t addr; 182 int baud, bits, error, space, stop; 183 char flag, par; 184 185 if ((options = OF_finddevice("/options")) == -1) 186 return (ENXIO); 187 switch (devtype) { 188 case UART_DEV_CONSOLE: 189 input = uart_cpu_getdev_console(options, dev, sizeof(dev)); 190 break; 191 case UART_DEV_DBGPORT: 192 input = uart_cpu_getdev_dbgport(options, dev, sizeof(dev)); 193 break; 194 case UART_DEV_KEYBOARD: 195 input = uart_cpu_getdev_keyboard(OF_peer(0), dev, sizeof(dev)); 196 break; 197 default: 198 input = -1; 199 break; 200 } 201 if (input == -1) 202 return (ENXIO); 203 error = OF_decode_addr(input, &space, &addr); 204 if (error) 205 return (error); 206 207 /* Get the device class. */ 208 if (OF_getprop(input, "name", buf, sizeof(buf)) == -1) 209 return (ENXIO); 210 if (OF_getprop(input, "compatible", compat, sizeof(compat)) == -1) 211 compat[0] = '\0'; 212 di->bas.regshft = 0; 213 di->bas.rclk = 0; 214 if (!strcmp(buf, "se")) { 215 di->ops = uart_sab82532_ops; 216 /* SAB82532 are only known to be used for TTYs. */ 217 if ((di->bas.chan = uart_cpu_channel(dev)) == 0) 218 return (ENXIO); 219 addr += 64 * (di->bas.chan - 1); 220 } else if (!strcmp(buf, "zs")) { 221 di->ops = uart_z8530_ops; 222 if ((di->bas.chan = uart_cpu_channel(dev)) == 0) { 223 /* 224 * There's no way to determine from OF which 225 * channel has the keyboard. Should always be 226 * on channel 1 however. 227 */ 228 if (devtype == UART_DEV_KEYBOARD) 229 di->bas.chan = 1; 230 else 231 return (ENXIO); 232 } 233 di->bas.regshft = 1; 234 addr += 4 - 4 * (di->bas.chan - 1); 235 } else if (!strcmp(buf, "su") || !strcmp(buf, "su_pnp") || 236 !strcmp(compat, "su") || !strcmp(compat, "su16550")) { 237 di->ops = uart_ns8250_ops; 238 di->bas.chan = 0; 239 } else 240 return (ENXIO); 241 242 /* Fill in the device info. */ 243 di->bas.bst = &bst_store[devtype]; 244 di->bas.bsh = sparc64_fake_bustag(space, addr, di->bas.bst); 245 246 /* Get the line settings. */ 247 if (devtype == UART_DEV_KEYBOARD) 248 di->baudrate = 1200; 249 else 250 di->baudrate = 9600; 251 di->databits = 8; 252 di->stopbits = 1; 253 di->parity = UART_PARITY_NONE; 254 snprintf(buf, sizeof(buf), "%s-mode", dev); 255 if (OF_getprop(options, buf, buf, sizeof(buf)) == -1) 256 return (0); 257 if (sscanf(buf, "%d,%d,%c,%d,%c", &baud, &bits, &par, &stop, &flag) 258 != 5) 259 return (0); 260 di->baudrate = baud; 261 di->databits = bits; 262 di->stopbits = stop; 263 di->parity = (par == 'n') ? UART_PARITY_NONE : 264 (par == 'o') ? UART_PARITY_ODD : UART_PARITY_EVEN; 265 return (0); 266 } 267