xref: /freebsd/sys/dev/uart/uart_bus_fdt.c (revision 8ef24a0d4b28fe230e20637f56869cc4148cd2ca)
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/systm.h>
37 #include <sys/bus.h>
38 #include <sys/kernel.h>
39 #include <sys/module.h>
40 
41 #include <machine/bus.h>
42 
43 #include <dev/fdt/fdt_common.h>
44 #include <dev/ofw/ofw_bus.h>
45 #include <dev/ofw/ofw_bus_subr.h>
46 #include <dev/uart/uart.h>
47 #include <dev/uart/uart_bus.h>
48 #include <dev/uart/uart_cpu.h>
49 #include <dev/uart/uart_cpu_fdt.h>
50 
51 static int uart_fdt_probe(device_t);
52 
53 static device_method_t uart_fdt_methods[] = {
54 	/* Device interface */
55 	DEVMETHOD(device_probe,		uart_fdt_probe),
56 	DEVMETHOD(device_attach,	uart_bus_attach),
57 	DEVMETHOD(device_detach,	uart_bus_detach),
58 	{ 0, 0 }
59 };
60 
61 static driver_t uart_fdt_driver = {
62 	uart_driver_name,
63 	uart_fdt_methods,
64 	sizeof(struct uart_softc),
65 };
66 
67 int
68 uart_fdt_get_clock(phandle_t node, pcell_t *cell)
69 {
70 
71 	/* clock-frequency is a FreeBSD-only extension. */
72 	if ((OF_getencprop(node, "clock-frequency", cell,
73 	    sizeof(*cell))) <= 0) {
74 		/* Try to retrieve parent 'bus-frequency' */
75 		/* XXX this should go to simple-bus fixup or so */
76 		if ((OF_getencprop(OF_parent(node), "bus-frequency", cell,
77 		    sizeof(*cell))) <= 0)
78 			*cell = 0;
79 	}
80 
81 	return (0);
82 }
83 
84 int
85 uart_fdt_get_shift(phandle_t node, pcell_t *cell)
86 {
87 
88 	if ((OF_getencprop(node, "reg-shift", cell, sizeof(*cell))) <= 0)
89 		return (-1);
90 	return (0);
91 }
92 
93 static uintptr_t
94 uart_fdt_find_device(device_t dev)
95 {
96 	struct ofw_compat_data **cd;
97 	const struct ofw_compat_data *ocd;
98 
99 	SET_FOREACH(cd, uart_fdt_class_and_device_set) {
100 		ocd = ofw_bus_search_compatible(dev, *cd);
101 		if (ocd->ocd_data != 0)
102 			return (ocd->ocd_data);
103 	}
104 	return (0);
105 }
106 
107 static int
108 uart_fdt_probe(device_t dev)
109 {
110 	struct uart_softc *sc;
111 	phandle_t node;
112 	pcell_t clock, shift;
113 	int err;
114 
115 	sc = device_get_softc(dev);
116 
117 	if (!ofw_bus_status_okay(dev))
118 		return (ENXIO);
119 
120 	sc->sc_class = (struct uart_class *)uart_fdt_find_device(dev);
121 	if (sc->sc_class == NULL)
122 		return (ENXIO);
123 
124 	node = ofw_bus_get_node(dev);
125 
126 	if ((err = uart_fdt_get_clock(node, &clock)) != 0)
127 		return (err);
128 	if (uart_fdt_get_shift(node, &shift) != 0)
129 		shift = uart_getregshift(sc->sc_class);
130 
131 	return (uart_bus_probe(dev, (int)shift, (int)clock, 0, 0));
132 }
133 
134 DRIVER_MODULE(uart, simplebus, uart_fdt_driver, uart_devclass, 0, 0);
135 DRIVER_MODULE(uart, ofwbus, uart_fdt_driver, uart_devclass, 0, 0);
136