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 (OF_getprop(options, "output-device", buf, sizeof(buf)) == -1) 101 return (-1); 102 if (!strcmp(dev, "keyboard") && !strcmp(buf, "screen")) { 103 if ((chosen = OF_finddevice("/chosen")) == -1) 104 return (-1); 105 if (OF_getprop(chosen, "stdin", &stdin, sizeof(stdin)) == -1) 106 return (-1); 107 if ((input = OF_instance_to_package(stdin)) == -1) 108 return (-1); 109 if (OF_getprop(chosen, "stdout", &stdout, sizeof(stdout)) == -1) 110 return (-1); 111 if (OF_instance_to_package(stdout) != input) 112 return (-1); 113 snprintf(dev, devsz, "ttya"); 114 } else { 115 if ((input = OF_finddevice(dev)) == -1) 116 return (-1); 117 if (OF_finddevice(buf) != input) 118 return (-1); 119 } 120 if (OF_getprop(input, "device_type", buf, sizeof(buf)) == -1) 121 return (-1); 122 if (strcmp(buf, "serial") != 0) 123 return (-1); 124 return (input); 125 } 126 127 /* 128 * Get the package handle of the UART that's selected as the debug port. 129 * Since there's no place for this in the OF, we use the kernel environment 130 * variable "hw.uart.dbgport". Note however that the variable is not a 131 * list of attributes. It's single device name or alias, as known by 132 * the OF. 133 */ 134 static phandle_t 135 uart_cpu_getdev_dbgport(phandle_t options, char *dev, size_t devsz) 136 { 137 char buf[32]; 138 phandle_t input; 139 140 if (!getenv_string("hw.uart.dbgport", dev, devsz)) 141 return (-1); 142 if ((input = OF_finddevice(dev)) == -1) 143 return (-1); 144 if (OF_getprop(input, "device_type", buf, sizeof(buf)) == -1) 145 return (-1); 146 if (strcmp(buf, "serial") != 0) 147 return (-1); 148 return (input); 149 } 150 151 /* 152 * Get the package handle of the UART that is selected as the keyboard port, 153 * if it's actually used to connect the keyboard according to the OF. I.e. 154 * this will return the UART used to connect the keyboard regardless whether 155 * it's stdin or not, however not in case the user or the OF gave preference 156 * to e.g. a PS/2 keyboard by setting /aliases/keyboard accordingly. 157 */ 158 static phandle_t 159 uart_cpu_getdev_keyboard(char *dev, size_t devsz) 160 { 161 char buf[32]; 162 phandle_t input; 163 164 if ((input = OF_finddevice("keyboard")) == -1) 165 return (-1); 166 if (OF_getprop(input, "device_type", buf, sizeof(buf)) == -1) 167 return (-1); 168 if (strcmp(buf, "serial") != 0) 169 return (-1); 170 if (OF_getprop(input, "name", dev, devsz) == -1) 171 return (-1); 172 /* 173 * So far this also matched PS/2 keyboard nodes so make sure it's 174 * one of the SCCs/UARTs known to be used to connect keyboards. 175 */ 176 if (strcmp(dev, "su") && strcmp(dev, "su_pnp") && strcmp(dev, "zs")) 177 return (-1); 178 return (input); 179 } 180 181 int 182 uart_cpu_getdev(int devtype, struct uart_devinfo *di) 183 { 184 char buf[32], dev[32], compat[32]; 185 phandle_t input, options; 186 bus_addr_t addr; 187 int baud, bits, error, space, stop; 188 char flag, par; 189 190 if ((options = OF_finddevice("/options")) == -1) 191 return (ENXIO); 192 switch (devtype) { 193 case UART_DEV_CONSOLE: 194 input = uart_cpu_getdev_console(options, dev, sizeof(dev)); 195 break; 196 case UART_DEV_DBGPORT: 197 input = uart_cpu_getdev_dbgport(options, dev, sizeof(dev)); 198 break; 199 case UART_DEV_KEYBOARD: 200 input = uart_cpu_getdev_keyboard(dev, sizeof(dev)); 201 break; 202 default: 203 input = -1; 204 break; 205 } 206 if (input == -1) 207 return (ENXIO); 208 error = OF_decode_addr(input, 0, &space, &addr); 209 if (error) 210 return (error); 211 212 /* Get the device class. */ 213 if (OF_getprop(input, "name", buf, sizeof(buf)) == -1) 214 return (ENXIO); 215 if (OF_getprop(input, "compatible", compat, sizeof(compat)) == -1) 216 compat[0] = '\0'; 217 di->bas.regshft = 0; 218 di->bas.rclk = 0; 219 if (!strcmp(buf, "se") || !strcmp(compat, "sab82532")) { 220 di->ops = uart_sab82532_ops; 221 /* SAB82532 are only known to be used for TTYs. */ 222 if ((di->bas.chan = uart_cpu_channel(dev)) == 0) 223 return (ENXIO); 224 addr += 64 * (di->bas.chan - 1); 225 } else if (!strcmp(buf, "zs")) { 226 di->ops = uart_z8530_ops; 227 if ((di->bas.chan = uart_cpu_channel(dev)) == 0) { 228 /* 229 * There's no way to determine from OF which 230 * channel has the keyboard. Should always be 231 * on channel 1 however. 232 */ 233 if (devtype == UART_DEV_KEYBOARD) 234 di->bas.chan = 1; 235 else 236 return (ENXIO); 237 } 238 di->bas.regshft = 1; 239 addr += 4 - 4 * (di->bas.chan - 1); 240 } else if (!strcmp(buf, "su") || !strcmp(buf, "su_pnp") || 241 !strcmp(compat, "su") || !strcmp(compat, "su16550")) { 242 di->ops = uart_ns8250_ops; 243 di->bas.chan = 0; 244 } else 245 return (ENXIO); 246 247 /* Fill in the device info. */ 248 di->bas.bst = &bst_store[devtype]; 249 di->bas.bsh = sparc64_fake_bustag(space, addr, di->bas.bst); 250 251 /* Get the line settings. */ 252 if (devtype == UART_DEV_KEYBOARD) 253 di->baudrate = 1200; 254 else 255 di->baudrate = 9600; 256 di->databits = 8; 257 di->stopbits = 1; 258 di->parity = UART_PARITY_NONE; 259 snprintf(buf, sizeof(buf), "%s-mode", dev); 260 if (OF_getprop(options, buf, buf, sizeof(buf)) == -1) 261 return (0); 262 if (sscanf(buf, "%d,%d,%c,%d,%c", &baud, &bits, &par, &stop, &flag) 263 != 5) 264 return (0); 265 di->baudrate = baud; 266 di->databits = bits; 267 di->stopbits = stop; 268 di->parity = (par == 'n') ? UART_PARITY_NONE : 269 (par == 'o') ? UART_PARITY_ODD : UART_PARITY_EVEN; 270 return (0); 271 } 272