1201a1f34SAndrew Turner /*-
2201a1f34SAndrew Turner * SPDX-License-Identifier: BSD-2-Clause
3201a1f34SAndrew Turner *
4201a1f34SAndrew Turner * Copyright (c) 2020 Andrew Turner
5201a1f34SAndrew Turner *
6201a1f34SAndrew Turner * This work was supported by Innovate UK project 105694, "Digital Security
7201a1f34SAndrew Turner * by Design (DSbD) Technology Platform Prototype".
8201a1f34SAndrew Turner *
9201a1f34SAndrew Turner * Redistribution and use in source and binary forms, with or without
10201a1f34SAndrew Turner * modification, are permitted provided that the following conditions
11201a1f34SAndrew Turner * are met:
12201a1f34SAndrew Turner * 1. Redistributions of source code must retain the above copyright
13201a1f34SAndrew Turner * notice, this list of conditions and the following disclaimer.
14201a1f34SAndrew Turner * 2. Redistributions in binary form must reproduce the above copyright
15201a1f34SAndrew Turner * notice, this list of conditions and the following disclaimer in the
16201a1f34SAndrew Turner * documentation and/or other materials provided with the distribution.
17201a1f34SAndrew Turner *
18201a1f34SAndrew Turner * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19201a1f34SAndrew Turner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20201a1f34SAndrew Turner * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21201a1f34SAndrew Turner * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22201a1f34SAndrew Turner * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23201a1f34SAndrew Turner * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24201a1f34SAndrew Turner * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25201a1f34SAndrew Turner * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26201a1f34SAndrew Turner * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27201a1f34SAndrew Turner * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28201a1f34SAndrew Turner * SUCH DAMAGE.
29201a1f34SAndrew Turner */
30201a1f34SAndrew Turner
31201a1f34SAndrew Turner #include <sys/param.h>
32201a1f34SAndrew Turner #include <sys/systm.h>
33201a1f34SAndrew Turner #include <sys/bus.h>
34201a1f34SAndrew Turner #include <sys/kernel.h>
35201a1f34SAndrew Turner #include <sys/module.h>
36201a1f34SAndrew Turner #include <sys/sysctl.h>
37201a1f34SAndrew Turner
387e077ed0SAndrew Turner #include <dev/fdt/simplebus.h>
397e077ed0SAndrew Turner
40201a1f34SAndrew Turner #include <dev/ofw/ofw_bus.h>
41201a1f34SAndrew Turner #include <dev/ofw/ofw_bus_subr.h>
42201a1f34SAndrew Turner
43201a1f34SAndrew Turner #include <arm/broadcom/bcm2835/bcm2835_firmware.h>
44201a1f34SAndrew Turner #include <arm/broadcom/bcm2835/bcm2835_mbox.h>
45201a1f34SAndrew Turner #include <arm/broadcom/bcm2835/bcm2835_mbox_prop.h>
46201a1f34SAndrew Turner #include <arm/broadcom/bcm2835/bcm2835_vcbus.h>
47201a1f34SAndrew Turner
48201a1f34SAndrew Turner struct bcm2835_firmware_softc {
497e077ed0SAndrew Turner struct simplebus_softc sc;
50201a1f34SAndrew Turner phandle_t sc_mbox;
51201a1f34SAndrew Turner };
52201a1f34SAndrew Turner
53201a1f34SAndrew Turner static struct ofw_compat_data compat_data[] = {
54201a1f34SAndrew Turner {"raspberrypi,bcm2835-firmware", 1},
55201a1f34SAndrew Turner {NULL, 0}
56201a1f34SAndrew Turner };
57201a1f34SAndrew Turner
58201a1f34SAndrew Turner static int sysctl_bcm2835_firmware_get_revision(SYSCTL_HANDLER_ARGS);
59201a1f34SAndrew Turner
60201a1f34SAndrew Turner static int
bcm2835_firmware_probe(device_t dev)61201a1f34SAndrew Turner bcm2835_firmware_probe(device_t dev)
62201a1f34SAndrew Turner {
63201a1f34SAndrew Turner if (!ofw_bus_status_okay(dev))
64201a1f34SAndrew Turner return (ENXIO);
65201a1f34SAndrew Turner
66201a1f34SAndrew Turner if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
67201a1f34SAndrew Turner return (ENXIO);
68201a1f34SAndrew Turner
69201a1f34SAndrew Turner device_set_desc(dev, "BCM2835 Firmware");
70201a1f34SAndrew Turner return (BUS_PROBE_DEFAULT);
71201a1f34SAndrew Turner }
72201a1f34SAndrew Turner
73201a1f34SAndrew Turner static int
bcm2835_firmware_attach(device_t dev)74201a1f34SAndrew Turner bcm2835_firmware_attach(device_t dev)
75201a1f34SAndrew Turner {
76201a1f34SAndrew Turner struct bcm2835_firmware_softc *sc;
77201a1f34SAndrew Turner struct sysctl_ctx_list *ctx;
78201a1f34SAndrew Turner struct sysctl_oid *tree_node;
79201a1f34SAndrew Turner struct sysctl_oid_list *tree;
80201a1f34SAndrew Turner phandle_t node, mbox;
81201a1f34SAndrew Turner int rv;
82201a1f34SAndrew Turner
83201a1f34SAndrew Turner sc = device_get_softc(dev);
84201a1f34SAndrew Turner
85201a1f34SAndrew Turner node = ofw_bus_get_node(dev);
86201a1f34SAndrew Turner rv = OF_getencprop(node, "mboxes", &mbox, sizeof(mbox));
87201a1f34SAndrew Turner if (rv <= 0) {
88201a1f34SAndrew Turner device_printf(dev, "can't read mboxes property\n");
89201a1f34SAndrew Turner return (ENXIO);
90201a1f34SAndrew Turner }
91201a1f34SAndrew Turner sc->sc_mbox = mbox;
92201a1f34SAndrew Turner
93201a1f34SAndrew Turner OF_device_register_xref(OF_xref_from_node(node), dev);
94201a1f34SAndrew Turner
957e077ed0SAndrew Turner ctx = device_get_sysctl_ctx(dev);
967e077ed0SAndrew Turner tree_node = device_get_sysctl_tree(dev);
97201a1f34SAndrew Turner tree = SYSCTL_CHILDREN(tree_node);
98201a1f34SAndrew Turner SYSCTL_ADD_PROC(ctx, tree, OID_AUTO, "revision",
99201a1f34SAndrew Turner CTLTYPE_UINT | CTLFLAG_RD, sc, sizeof(*sc),
100201a1f34SAndrew Turner sysctl_bcm2835_firmware_get_revision, "IU",
101201a1f34SAndrew Turner "Firmware revision");
1027e077ed0SAndrew Turner
1037e077ed0SAndrew Turner /* The firmwaare doesn't have a ranges property */
1047e077ed0SAndrew Turner sc->sc.flags |= SB_FLAG_NO_RANGES;
1057e077ed0SAndrew Turner return (simplebus_attach(dev));
106201a1f34SAndrew Turner }
107201a1f34SAndrew Turner
108201a1f34SAndrew Turner int
bcm2835_firmware_property(device_t dev,uint32_t prop,void * data,size_t len)109201a1f34SAndrew Turner bcm2835_firmware_property(device_t dev, uint32_t prop, void *data, size_t len)
110201a1f34SAndrew Turner {
111201a1f34SAndrew Turner struct {
112201a1f34SAndrew Turner struct bcm2835_mbox_hdr hdr;
113201a1f34SAndrew Turner struct bcm2835_mbox_tag_hdr tag_hdr;
114201a1f34SAndrew Turner uint32_t data[];
115201a1f34SAndrew Turner } *msg_hdr;
116201a1f34SAndrew Turner size_t msg_len;
117201a1f34SAndrew Turner int err;
118201a1f34SAndrew Turner
119201a1f34SAndrew Turner /*
120201a1f34SAndrew Turner * The message is processed in 32-bit chunks so must be a multiple
121201a1f34SAndrew Turner * of 32-bits.
122201a1f34SAndrew Turner */
123201a1f34SAndrew Turner if ((len & (sizeof(uint32_t) - 1)) != 0)
124201a1f34SAndrew Turner return (EINVAL);
125201a1f34SAndrew Turner
126201a1f34SAndrew Turner msg_len = sizeof(*msg_hdr) + len + sizeof(uint32_t);
127201a1f34SAndrew Turner msg_hdr = malloc(sizeof(*msg_hdr) + msg_len + sizeof(uint32_t),
128201a1f34SAndrew Turner M_DEVBUF, M_WAITOK | M_ZERO);
129201a1f34SAndrew Turner
130201a1f34SAndrew Turner msg_hdr->hdr.buf_size = msg_len;
131201a1f34SAndrew Turner msg_hdr->hdr.code = BCM2835_MBOX_CODE_REQ;
132201a1f34SAndrew Turner msg_hdr->tag_hdr.tag = prop;
133201a1f34SAndrew Turner msg_hdr->tag_hdr.val_buf_size = len;
134201a1f34SAndrew Turner memcpy(msg_hdr->data, data, len);
135201a1f34SAndrew Turner msg_hdr->data[len / sizeof(uint32_t)] = 0;
136201a1f34SAndrew Turner
137201a1f34SAndrew Turner err = bcm2835_mbox_property(msg_hdr, msg_len);
138201a1f34SAndrew Turner if (err == 0) {
139201a1f34SAndrew Turner memcpy(data, msg_hdr->data, len);
140201a1f34SAndrew Turner }
141201a1f34SAndrew Turner
142201a1f34SAndrew Turner free(msg_hdr, M_DEVBUF);
143201a1f34SAndrew Turner
144201a1f34SAndrew Turner return (err);
145201a1f34SAndrew Turner }
146201a1f34SAndrew Turner
147201a1f34SAndrew Turner static int
sysctl_bcm2835_firmware_get_revision(SYSCTL_HANDLER_ARGS)148201a1f34SAndrew Turner sysctl_bcm2835_firmware_get_revision(SYSCTL_HANDLER_ARGS)
149201a1f34SAndrew Turner {
150201a1f34SAndrew Turner struct bcm2835_firmware_softc *sc = arg1;
151201a1f34SAndrew Turner uint32_t rev;
152201a1f34SAndrew Turner int err;
153201a1f34SAndrew Turner
1547e077ed0SAndrew Turner if (bcm2835_firmware_property(sc->sc.dev,
155201a1f34SAndrew Turner BCM2835_MBOX_TAG_FIRMWARE_REVISION, &rev, sizeof(rev)) != 0)
156201a1f34SAndrew Turner return (ENXIO);
157201a1f34SAndrew Turner
158201a1f34SAndrew Turner err = sysctl_handle_int(oidp, &rev, sizeof(rev), req);
159201a1f34SAndrew Turner if (err || !req->newptr) /* error || read request */
160201a1f34SAndrew Turner return (err);
161201a1f34SAndrew Turner
162201a1f34SAndrew Turner /* write request */
163201a1f34SAndrew Turner return (EINVAL);
164201a1f34SAndrew Turner }
165201a1f34SAndrew Turner
166201a1f34SAndrew Turner static device_method_t bcm2835_firmware_methods[] = {
167201a1f34SAndrew Turner /* Device interface */
168201a1f34SAndrew Turner DEVMETHOD(device_probe, bcm2835_firmware_probe),
169201a1f34SAndrew Turner DEVMETHOD(device_attach, bcm2835_firmware_attach),
170201a1f34SAndrew Turner
171201a1f34SAndrew Turner DEVMETHOD_END
172201a1f34SAndrew Turner };
173201a1f34SAndrew Turner
1747e077ed0SAndrew Turner DEFINE_CLASS_1(bcm2835_firmware, bcm2835_firmware_driver,
1757e077ed0SAndrew Turner bcm2835_firmware_methods, sizeof(struct bcm2835_firmware_softc),
1767e077ed0SAndrew Turner simplebus_driver);
177201a1f34SAndrew Turner
17882d4dc06SJohn Baldwin EARLY_DRIVER_MODULE(bcm2835_firmware, simplebus, bcm2835_firmware_driver, 0, 0,
17982d4dc06SJohn Baldwin BUS_PASS_BUS + BUS_PASS_ORDER_LATE);
1800083fb5dSAndrew Turner MODULE_DEPEND(bcm2835_firmware, mbox, 1, 1, 1);
181