xref: /freebsd/sys/dev/uart/uart_cpu_fdt.c (revision c9dbb1cc52b063bbd9ab078a7afc89a8696da659)
1 /*-
2  * Copyright (c) 2009-2010 The FreeBSD Foundation
3  * All rights reserved.
4  *
5  * This software was developed by Semihalf under sponsorship from
6  * the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include "opt_platform.h"
34 
35 #include <sys/param.h>
36 #include <sys/bus.h>
37 #include <sys/kernel.h>
38 #include <sys/module.h>
39 #include <sys/systm.h>
40 
41 #include <vm/vm.h>
42 #include <vm/pmap.h>
43 
44 #include <machine/bus.h>
45 #ifndef __aarch64__
46 #include <machine/fdt.h>
47 #endif
48 
49 #include <dev/fdt/fdt_common.h>
50 #include <dev/ofw/ofw_bus.h>
51 #include <dev/ofw/ofw_bus_subr.h>
52 #include <dev/uart/uart.h>
53 #include <dev/uart/uart_bus.h>
54 #include <dev/uart/uart_cpu.h>
55 #include <dev/uart/uart_cpu_fdt.h>
56 
57 #ifdef __aarch64__
58 extern bus_space_tag_t fdtbus_bs_tag;
59 #endif
60 
61 /*
62  * UART console routines.
63  */
64 bus_space_tag_t uart_bus_space_io;
65 bus_space_tag_t uart_bus_space_mem;
66 
67 int
68 uart_cpu_eqres(struct uart_bas *b1, struct uart_bas *b2)
69 {
70 
71 	if (b1->bst != b2->bst)
72 		return (0);
73 	if (pmap_kextract(b1->bsh) == 0)
74 		return (0);
75 	if (pmap_kextract(b2->bsh) == 0)
76 		return (0);
77 	return ((pmap_kextract(b1->bsh) == pmap_kextract(b2->bsh)) ? 1 : 0);
78 }
79 
80 static int
81 phandle_chosen_propdev(phandle_t chosen, const char *name, phandle_t *node)
82 {
83 	char buf[64];
84 
85 	if (OF_getprop(chosen, name, buf, sizeof(buf)) <= 0)
86 		return (ENXIO);
87 	if ((*node = OF_finddevice(buf)) == -1)
88 		return (ENXIO);
89 
90 	return (0);
91 }
92 
93 static const struct ofw_compat_data *
94 uart_fdt_find_compatible(phandle_t node, const struct ofw_compat_data *cd)
95 {
96 	const struct ofw_compat_data *ocd;
97 
98 	for (ocd = cd; ocd->ocd_str != NULL; ocd++) {
99 		if (fdt_is_compatible(node, ocd->ocd_str))
100 			return (ocd);
101 	}
102 	return (NULL);
103 }
104 
105 static uintptr_t
106 uart_fdt_find_by_node(phandle_t node, int class_list)
107 {
108 	struct ofw_compat_data **cd;
109 	const struct ofw_compat_data *ocd;
110 
111 	if (class_list) {
112 		SET_FOREACH(cd, uart_fdt_class_set) {
113 			ocd = uart_fdt_find_compatible(node, *cd);
114 			if ((ocd != NULL) && (ocd->ocd_data != 0))
115 				return (ocd->ocd_data);
116 		}
117 	} else {
118 		SET_FOREACH(cd, uart_fdt_class_and_device_set) {
119 			ocd = uart_fdt_find_compatible(node, *cd);
120 			if ((ocd != NULL) && (ocd->ocd_data != 0))
121 				return (ocd->ocd_data);
122 		}
123 	}
124 	return (0);
125 }
126 
127 int
128 uart_cpu_getdev(int devtype, struct uart_devinfo *di)
129 {
130 	const char *propnames[] = {"stdout-path", "linux,stdout-path", "stdout",
131 	    "stdin-path", "stdin", NULL};
132 	const char **name;
133 	struct uart_class *class;
134 	phandle_t node, chosen;
135 	pcell_t shift, br, rclk;
136 	u_long start, size, pbase, psize;
137 	char *cp;
138 	int err;
139 
140 	uart_bus_space_mem = fdtbus_bs_tag;
141 	uart_bus_space_io = NULL;
142 
143 	/* Allow overriding the FDT using the environment. */
144 	class = &uart_ns8250_class;
145 	err = uart_getenv(devtype, di, class);
146 	if (!err)
147 		return (0);
148 
149 	if (devtype != UART_DEV_CONSOLE)
150 		return (ENXIO);
151 
152 	/* Has the user forced a specific device node? */
153 	cp = kern_getenv("hw.fdt.console");
154 	if (cp == NULL) {
155 		/*
156 		 * Retrieve /chosen/std{in,out}.
157 		 */
158 		node = -1;
159 		if ((chosen = OF_finddevice("/chosen")) != -1) {
160 			for (name = propnames; *name != NULL; name++) {
161 				if (phandle_chosen_propdev(chosen, *name,
162 				    &node) == 0)
163 					break;
164 			}
165 		}
166 		if (chosen == -1 || *name == NULL)
167 			node = OF_finddevice("serial0"); /* Last ditch */
168 	} else {
169 		node = OF_finddevice(cp);
170 	}
171 
172 	if (node == -1) /* Can't find anything */
173 		return (ENXIO);
174 
175 	/*
176 	 * Check old style of UART definition first. Unfortunately, the common
177 	 * FDT processing is not possible if we have clock, power domains and
178 	 * pinmux stuff.
179 	 */
180 	class = (struct uart_class *)uart_fdt_find_by_node(node, 0);
181 	if (class != NULL) {
182 		if ((err = uart_fdt_get_clock(node, &rclk)) != 0)
183 			return (err);
184 	} else {
185 		/* Check class only linker set */
186 		class =
187 		    (struct uart_class *)uart_fdt_find_by_node(node, 1);
188 		if (class == NULL)
189 			return (ENXIO);
190 		rclk = 0;
191 	}
192 
193 	/*
194 	 * Retrieve serial attributes.
195 	 */
196 	if (uart_fdt_get_shift(node, &shift) != 0)
197 		shift = uart_getregshift(class);
198 
199 	if (OF_getprop(node, "current-speed", &br, sizeof(br)) <= 0)
200 		br = 0;
201 	else
202 		br = fdt32_to_cpu(br);
203 
204 	/*
205 	 * Finalize configuration.
206 	 */
207 	di->bas.chan = 0;
208 	di->bas.regshft = (u_int)shift;
209 	di->baudrate = br;
210 	di->bas.rclk = (u_int)rclk;
211 	di->ops = uart_getops(class);
212 	di->databits = 8;
213 	di->stopbits = 1;
214 	di->parity = UART_PARITY_NONE;
215 	di->bas.bst = uart_bus_space_mem;
216 
217 	err = fdt_regsize(node, &start, &size);
218 	if (err)
219 		return (ENXIO);
220 	err = fdt_get_range(OF_parent(node), 0, &pbase, &psize);
221 	if (err)
222 		pbase = 0;
223 
224 	start += pbase;
225 
226 	return (bus_space_map(di->bas.bst, start, size, 0, &di->bas.bsh));
227 }
228