1 /*-
2 * Copyright (c) 2009, Nathan Whitehorn <nwhitehorn@FreeBSD.org>
3 * Copyright (c) 2013 The FreeBSD Foundation
4 * All rights reserved.
5 *
6 * Portions of this software were developed by Oleksandr Rybalko
7 * under sponsorship from the FreeBSD Foundation.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice unmodified, this list of conditions, and the following
14 * disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD: releng/11.2/sys/dev/spibus/ofw_spibus.c 332942 2018-04-24 17:00:08Z ian $");
33
34 #include <sys/param.h>
35 #include <sys/bus.h>
36 #include <sys/kernel.h>
37 #include <sys/libkern.h>
38 #include <sys/lock.h>
39 #include <sys/module.h>
40 #include <sys/mutex.h>
41
42 #include <dev/fdt/fdt_common.h>
43 #include <dev/spibus/spi.h>
44 #include <dev/spibus/spibusvar.h>
45 #include <dev/ofw/ofw_bus.h>
46 #include <dev/ofw/ofw_bus_subr.h>
47 #include <dev/ofw/openfirm.h>
48
49 #include "spibus_if.h"
50
51 struct ofw_spibus_devinfo {
52 struct spibus_ivar opd_dinfo;
53 struct ofw_bus_devinfo opd_obdinfo;
54 };
55
56 /* Methods */
57 static device_probe_t ofw_spibus_probe;
58 static device_attach_t ofw_spibus_attach;
59 static device_t ofw_spibus_add_child(device_t dev, u_int order,
60 const char *name, int unit);
61 static const struct ofw_bus_devinfo *ofw_spibus_get_devinfo(device_t bus,
62 device_t dev);
63
64 static int
65 ofw_spibus_probe(device_t dev)
66 {
67
68 if (ofw_bus_get_node(dev) == -1)
69 return (ENXIO);
70 device_set_desc(dev, "OFW SPI bus");
71
72 return (BUS_PROBE_DEFAULT);
73 }
74
75 static int
76 ofw_spibus_attach(device_t dev)
77 {
78 struct spibus_softc *sc = device_get_softc(dev);
79 struct ofw_spibus_devinfo *dinfo;
80 phandle_t child;
81 pcell_t clock, paddr;
82 device_t childdev;
83
84 sc->dev = dev;
85
86 bus_generic_probe(dev);
87 bus_enumerate_hinted_children(dev);
88
89 /*
90 * Attach those children represented in the device tree.
91 */
92 for (child = OF_child(ofw_bus_get_node(dev)); child != 0;
93 child = OF_peer(child)) {
94 /*
95 * Try to get the CS number first from the spi-chipselect
96 * property, then try the reg property.
97 */
98 if (OF_getencprop(child, "spi-chipselect", &paddr,
99 sizeof(paddr)) == -1) {
100 if (OF_getencprop(child, "reg", &paddr,
101 sizeof(paddr)) == -1)
102 continue;
103 }
104
105 /*
106 * Get the maximum clock frequency for device, zero means
107 * use the default bus speed.
108 *
109 * XXX Note that the current (2018-04-07) dts bindings say that
110 * spi-max-frequency is a required property (but says nothing of
111 * how to interpret a value of zero).
112 */
113 if (OF_getencprop(child, "spi-max-frequency", &clock,
114 sizeof(clock)) == -1)
115 clock = 0;
116
117 /*
118 * Now set up the SPI and OFW bus layer devinfo and add it
119 * to the bus.
120 */
121 dinfo = malloc(sizeof(struct ofw_spibus_devinfo), M_DEVBUF,
122 M_NOWAIT | M_ZERO);
123 if (dinfo == NULL)
124 continue;
125 dinfo->opd_dinfo.cs = paddr;
126 dinfo->opd_dinfo.clock = clock;
127 if (ofw_bus_gen_setup_devinfo(&dinfo->opd_obdinfo, child) !=
128 0) {
129 free(dinfo, M_DEVBUF);
130 continue;
131 }
132 childdev = device_add_child(dev, NULL, -1);
133 device_set_ivars(childdev, dinfo);
134 }
135
136 return (bus_generic_attach(dev));
137 }
138
139 static device_t
140 ofw_spibus_add_child(device_t dev, u_int order, const char *name, int unit)
141 {
142 device_t child;
143 struct ofw_spibus_devinfo *devi;
144
145 child = device_add_child_ordered(dev, order, name, unit);
146 if (child == NULL)
147 return (child);
148 devi = malloc(sizeof(struct ofw_spibus_devinfo), M_DEVBUF,
149 M_NOWAIT | M_ZERO);
150 if (devi == NULL) {
151 device_delete_child(dev, child);
152 return (0);
153 }
154
155 /*
156 * NULL all the OFW-related parts of the ivars for non-OFW
157 * children.
158 */
159 devi->opd_obdinfo.obd_node = -1;
160 devi->opd_obdinfo.obd_name = NULL;
161 devi->opd_obdinfo.obd_compat = NULL;
162 devi->opd_obdinfo.obd_type = NULL;
163 devi->opd_obdinfo.obd_model = NULL;
164
165 device_set_ivars(child, devi);
166
167 return (child);
168 }
169
170 static const struct ofw_bus_devinfo *
171 ofw_spibus_get_devinfo(device_t bus, device_t dev)
172 {
173 struct ofw_spibus_devinfo *dinfo;
174
175 dinfo = device_get_ivars(dev);
176 return (&dinfo->opd_obdinfo);
177 }
178
179 static device_method_t ofw_spibus_methods[] = {
180 /* Device interface */
181 DEVMETHOD(device_probe, ofw_spibus_probe),
182 DEVMETHOD(device_attach, ofw_spibus_attach),
183
184 /* Bus interface */
185 DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str),
186 DEVMETHOD(bus_add_child, ofw_spibus_add_child),
187
188 /* ofw_bus interface */
189 DEVMETHOD(ofw_bus_get_devinfo, ofw_spibus_get_devinfo),
190 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
191 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
192 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
193 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
194 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
195
196 DEVMETHOD_END
197 };
198
199 static devclass_t ofwspibus_devclass;
200
201 DEFINE_CLASS_1(spibus, ofw_spibus_driver, ofw_spibus_methods,
202 sizeof(struct spibus_softc), spibus_driver);
203 DRIVER_MODULE(ofw_spibus, spi, ofw_spibus_driver, ofwspibus_devclass, 0, 0);
204 MODULE_VERSION(ofw_spibus, 1);
205 MODULE_DEPEND(ofw_spibus, spibus, 1, 1, 1);
Cache object: fb865d7db33844963b97aacc39c0effe
|