xref: /f-stack/freebsd/arm64/intel/firmware.c (revision 22ce4aff)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2019 Ruslan Bukin <[email protected]>
5  *
6  * This software was developed by SRI International and the University of
7  * Cambridge Computer Laboratory (Department of Computer Science and
8  * Technology) under DARPA contract HR0011-18-C-0016 ("ECATS"), as part of the
9  * DARPA SSITH research programme.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
35 
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/module.h>
40 
41 #include <dev/fdt/simplebus.h>
42 #include <dev/fdt/fdt_common.h>
43 #include <dev/ofw/ofw_bus_subr.h>
44 
45 struct firmware_softc {
46 	struct simplebus_softc	simplebus_sc;
47 	device_t		dev;
48 };
49 
50 static int
firmware_probe(device_t dev)51 firmware_probe(device_t dev)
52 {
53 	phandle_t node;
54 
55 	node = ofw_bus_get_node(dev);
56 
57 	/*
58 	 * The firmware node has no property compatible.
59 	 * Look for a known child.
60 	 */
61 	if (!fdt_depth_search_compatible(node, "intel,stratix10-svc", 0))
62 		return (ENXIO);
63 
64 	if (!ofw_bus_status_okay(dev))
65 		return (ENXIO);
66 
67 	device_set_desc(dev, "Firmware node");
68 
69 	return (BUS_PROBE_DEFAULT);
70 }
71 
72 static int
firmware_attach(device_t dev)73 firmware_attach(device_t dev)
74 {
75 	struct firmware_softc *sc;
76 	phandle_t node;
77 
78 	sc = device_get_softc(dev);
79 	sc->dev = dev;
80 
81 	node = ofw_bus_get_node(dev);
82 	if (node == -1)
83 		return (ENXIO);
84 
85 	simplebus_init(dev, node);
86 
87 	/*
88 	 * Allow devices to identify.
89 	 */
90 	bus_generic_probe(dev);
91 
92 	/*
93 	 * Now walk the OFW tree and attach top-level devices.
94 	 */
95 	for (node = OF_child(node); node > 0; node = OF_peer(node))
96 		simplebus_add_device(dev, node, 0, NULL, -1, NULL);
97 
98 	return (bus_generic_attach(dev));
99 }
100 
101 static int
firmware_detach(device_t dev)102 firmware_detach(device_t dev)
103 {
104 
105 	return (0);
106 }
107 
108 static device_method_t firmware_methods[] = {
109 	DEVMETHOD(device_probe,		firmware_probe),
110 	DEVMETHOD(device_attach,	firmware_attach),
111 	DEVMETHOD(device_detach,	firmware_detach),
112 	DEVMETHOD_END
113 };
114 
115 DEFINE_CLASS_1(firmware, firmware_driver, firmware_methods,
116     sizeof(struct firmware_softc), simplebus_driver);
117 
118 static devclass_t firmware_devclass;
119 
120 EARLY_DRIVER_MODULE(firmware, simplebus, firmware_driver, firmware_devclass,
121     0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
122 MODULE_VERSION(firmware, 1);
123