1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2007 Bruce M. Simpson.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 /*
30 * Driver to swallow up memory ranges reserved by CFE platform firmware.
31 * CFE on Sentry5 doesn't specify reserved ranges, so this is not useful
32 * at the present time.
33 * TODO: Don't attach this off nexus.
34 */
35
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/socket.h>
40
41 #include <sys/module.h>
42 #include <sys/bus.h>
43
44 #include <machine/bus.h>
45 #include <machine/resource.h>
46 #include <sys/rman.h>
47
48 #include <dev/cfe/cfe_api.h>
49 #include <dev/cfe/cfe_error.h>
50
51 #define MAX_CFE_RESERVATIONS 16
52
53 struct cferes_softc {
54 int rnum;
55 int rid[MAX_CFE_RESERVATIONS];
56 struct resource *res[MAX_CFE_RESERVATIONS];
57 };
58
59 static int
cferes_probe(device_t dev)60 cferes_probe(device_t dev)
61 {
62
63 return (BUS_PROBE_NOWILDCARD);
64 }
65
66 static int
cferes_attach(device_t dev)67 cferes_attach(device_t dev)
68 {
69
70 return (0);
71 }
72
73 static void
cferes_identify(driver_t * driver,device_t parent)74 cferes_identify(driver_t* driver, device_t parent)
75 {
76 device_t child;
77 int i;
78 struct resource *res;
79 int result;
80 int rid;
81 struct cferes_softc *sc;
82 uint64_t addr, len, type;
83
84 child = BUS_ADD_CHILD(parent, 100, "cferes", DEVICE_UNIT_ANY);
85 device_set_driver(child, driver);
86 sc = device_get_softc(child);
87
88 sc->rnum = 0;
89 for (i = 0; i < ~0U; i++) {
90 result = cfe_enummem(i, CFE_FLG_FULL_ARENA, &addr, &len, &type);
91 if (result < 0)
92 break;
93 if (type != CFE_MI_RESERVED) {
94 if (bootverbose)
95 printf("%s: skipping non reserved range 0x%0jx(%jd)\n",
96 device_getnameunit(child),
97 (uintmax_t)addr, (uintmax_t)len);
98 continue;
99 }
100
101 bus_set_resource(child, SYS_RES_MEMORY, sc->rnum, addr, len);
102 rid = sc->rnum;
103 res = bus_alloc_resource_any(child, SYS_RES_MEMORY, &rid, 0);
104 if (res == NULL) {
105 bus_delete_resource(child, SYS_RES_MEMORY, sc->rnum);
106 continue;
107 }
108 sc->rid[sc->rnum] = rid;
109 sc->res[sc->rnum] = res;
110
111 sc->rnum++;
112 if (sc->rnum == MAX_CFE_RESERVATIONS)
113 break;
114 }
115
116 if (sc->rnum == 0) {
117 device_delete_child(parent, child);
118 return;
119 }
120
121 device_set_desc(child, "CFE reserved memory");
122 }
123
124 static int
cferes_detach(device_t dev)125 cferes_detach(device_t dev)
126 {
127 int i;
128 struct cferes_softc *sc = device_get_softc(dev);
129
130 for (i = 0; i < sc->rnum; i++) {
131 bus_release_resource(dev, SYS_RES_MEMORY, sc->rid[i],
132 sc->res[i]);
133 }
134
135 return (0);
136 }
137
138 static device_method_t cferes_methods[] = {
139 /* Device interface */
140 DEVMETHOD(device_identify, cferes_identify),
141 DEVMETHOD(device_probe, cferes_probe),
142 DEVMETHOD(device_attach, cferes_attach),
143 DEVMETHOD(device_detach, cferes_detach),
144 DEVMETHOD(device_shutdown, bus_generic_shutdown),
145 DEVMETHOD(device_suspend, bus_generic_suspend),
146 DEVMETHOD(device_resume, bus_generic_resume),
147 DEVMETHOD_END
148 };
149
150 static driver_t cferes_driver = {
151 "cferes",
152 cferes_methods,
153 sizeof (struct cferes_softc)
154 };
155
156 static devclass_t cferes_devclass;
157
158 DRIVER_MODULE(cfe, nexus, cferes_driver, cferes_devclass, 0, 0);
159