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 phandle_t uart_cpu_getdev_keyboard(phandle_t root);
46 
47 static struct bus_space_tag bst_store[3];
48 
49 static int
50 uart_cpu_channel(char *dev)
51 {
52 	char alias[64];
53 	phandle_t aliases;
54 	int len;
55 
56 	strcpy(alias, dev);
57 	if ((aliases = OF_finddevice("/aliases")) != -1)
58 		OF_getprop(aliases, dev, alias, sizeof(alias));
59 	len = strlen(alias);
60 	if (len < 2 || alias[len - 2] != ':' || alias[len - 1] < 'a' ||
61 	    alias[len - 1] > 'b')
62 		return (0);
63 	return (alias[len - 1] - 'a' + 1);
64 }
65 
66 int
67 uart_cpu_eqres(struct uart_bas *b1, struct uart_bas *b2)
68 {
69 
70 	return ((b1->bsh == b2->bsh) ? 1 : 0);
71 }
72 
73 static phandle_t
74 uart_cpu_getdev_keyboard(phandle_t root)
75 {
76 	phandle_t child;
77 	phandle_t node;
78 	char buf[32];
79 
80 	for (child = OF_child(root); child != 0 && child != -1;
81 	    child = OF_peer(child)) {
82 		if (OF_getprop(child, "device_type", buf, sizeof(buf)) != -1 &&
83 		    !strcmp(buf, "serial") &&
84 		    OF_getprop(child, "keyboard", buf, sizeof(buf)) != -1)
85 			return (child);
86 		if ((node = uart_cpu_getdev_keyboard(child)) != -1)
87 			return (node);
88 	}
89 	return (-1);
90 }
91 
92 int
93 uart_cpu_getdev(int devtype, struct uart_devinfo *di)
94 {
95 	char buf[32], dev[32], compat[32];
96 	phandle_t input, options, output;
97 	bus_addr_t addr;
98 	int baud, bits, error, space, stop;
99 	char flag, par;
100 
101 	/*
102 	 * Get the address of the UART that is selected as the console, if
103 	 * the console is an UART of course. Note that we enforce that both
104 	 * stdin and stdout are selected. For weird configurations, use
105 	 * ofw_console(4).
106 	 * Note that the currently active console (ie /chosen/stdout and
107 	 * /chosen/stdin) may not be the same as the device selected in the
108 	 * environment (ie /options/output-device and /options/input-device)
109 	 * because the user may have changed the environment. In that case
110 	 * I would assume that the user expects that FreeBSD uses the new
111 	 * console setting. There's choice choice, really.
112 	 */
113 	 if ((options = OF_finddevice("/options")) == -1)
114 		 return (ENXIO);
115 	if (devtype == UART_DEV_CONSOLE) {
116 		if (OF_getprop(options, "input-device", dev, sizeof(dev)) == -1)
117 			return (ENXIO);
118 		if ((input = OF_finddevice(dev)) == -1)
119 			return (ENXIO);
120 		if (OF_getprop(input, "device_type", buf, sizeof(buf)) == -1)
121 			return (ENXIO);
122 		if (strcmp(buf, "serial"))
123 			return (ENODEV);
124 		if (OF_getprop(options, "output-device", buf, sizeof(buf))
125 		    == -1)
126 			return (ENXIO);
127 		if ((output = OF_finddevice(buf)) == -1)
128 			return (ENXIO);
129 		if (input != output)
130 			return (ENXIO);
131 	} else if (devtype == UART_DEV_KEYBOARD) {
132 		if ((input = uart_cpu_getdev_keyboard(OF_peer(0))) == -1)
133 			return (ENXIO);
134 	} else
135 		return (ENODEV);
136 
137 	error = OF_decode_addr(input, &space, &addr);
138 	if (error)
139 		return (error);
140 
141 	/* Get the device class. */
142 	if (OF_getprop(input, "name", buf, sizeof(buf)) == -1)
143 		return (ENXIO);
144 	if (OF_getprop(input, "compatible", compat, sizeof(compat)) == -1)
145 		compat[0] = '\0';
146 	di->bas.regshft = 0;
147 	di->bas.rclk = 0;
148 	if (!strcmp(buf, "se")) {
149 		di->ops = uart_sab82532_ops;
150 		di->bas.chan = uart_cpu_channel(dev);
151 		addr += 64 * (di->bas.chan - 1);
152 	} else if (!strcmp(buf, "zs")) {
153 		di->ops = uart_z8530_ops;
154 		di->bas.chan = uart_cpu_channel(dev);
155 		di->bas.regshft = 1;
156 		addr += 4 - 4 * (di->bas.chan - 1);
157 	} else if (!strcmp(buf, "su") || !strcmp(buf, "su_pnp") ||
158 	    !strcmp(compat, "su") || !strcmp(compat, "su16550")) {
159 		di->ops = uart_ns8250_ops;
160 		di->bas.chan = 0;
161 	} else
162 		return (ENXIO);
163 
164 	/* Fill in the device info. */
165 	di->bas.bst = &bst_store[devtype];
166 	di->bas.bsh = sparc64_fake_bustag(space, addr, di->bas.bst);
167 
168 	/* Get the line settings. */
169 	if (devtype == UART_DEV_KEYBOARD)
170 		di->baudrate = 1200;
171 	else
172 		di->baudrate = 9600;
173 	di->databits = 8;
174 	di->stopbits = 1;
175 	di->parity = UART_PARITY_NONE;
176 	snprintf(buf, sizeof(buf), "%s-mode", dev);
177 	if (OF_getprop(options, buf, buf, sizeof(buf)) == -1)
178 		return (0);
179 	if (sscanf(buf, "%d,%d,%c,%d,%c", &baud, &bits, &par, &stop, &flag)
180 	    != 5)
181 		return (0);
182 	di->baudrate = baud;
183 	di->databits = bits;
184 	di->stopbits = stop;
185 	di->parity = (par == 'n') ? UART_PARITY_NONE :
186 	    (par == 'o') ? UART_PARITY_ODD : UART_PARITY_EVEN;
187 	return (0);
188 }
189