1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2003 Matthew N. Dodd <winter@jurai.net>
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 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD: stable/12/sys/x86/bios/vpd.c 366651 2020-10-12 17:43:38Z freqlabs $");
31
32 /*
33 * VPD decoder for IBM systems (Thinkpads)
34 * http://www-1.ibm.com/support/docview.wss?uid=psg1MIGR-45120
35 */
36
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/socket.h>
41 #include <sys/sysctl.h>
42
43 #include <sys/module.h>
44 #include <sys/bus.h>
45
46 #include <machine/bus.h>
47 #include <machine/resource.h>
48 #include <sys/rman.h>
49
50 #include <vm/vm.h>
51 #include <vm/vm_param.h>
52 #include <vm/pmap.h>
53 #include <machine/md_var.h>
54 #include <machine/pc/bios.h>
55
56 /*
57 * Vital Product Data
58 */
59 struct vpd {
60 u_int16_t Header; /* 0x55AA */
61 u_int8_t Signature[3]; /* Always 'VPD' */
62 u_int8_t Length; /* Sructure Length */
63
64 u_int8_t Reserved[7]; /* Reserved */
65
66 u_int8_t BuildID[9]; /* BIOS Build ID */
67 u_int8_t BoxSerial[7]; /* Box Serial Number */
68 u_int8_t PlanarSerial[11]; /* Motherboard Serial Number */
69 u_int8_t MachType[7]; /* Machine Type/Model */
70 u_int8_t Checksum; /* Checksum */
71 } __packed;
72
73 struct vpd_softc {
74 device_t dev;
75 struct resource * res;
76 int rid;
77
78 struct vpd * vpd;
79
80 struct sysctl_ctx_list ctx;
81
82 char BuildID[10];
83 char BoxSerial[8];
84 char PlanarSerial[12];
85 char MachineType[5];
86 char MachineModel[4];
87 };
88
89 #define VPD_START 0xf0000
90 #define VPD_STEP 0x10
91 #define VPD_OFF 2
92 #define VPD_LEN 3
93 #define VPD_SIG "VPD"
94
95 #define RES2VPD(res) ((struct vpd *)rman_get_virtual(res))
96 #define ADDR2VPD(addr) ((struct vpd *)BIOS_PADDRTOVADDR(addr))
97
98 static devclass_t vpd_devclass;
99
100 static void vpd_identify (driver_t *, device_t);
101 static int vpd_probe (device_t);
102 static int vpd_attach (device_t);
103 static int vpd_detach (device_t);
104 static int vpd_modevent (module_t, int, void *);
105
106 static int vpd_cksum (struct vpd *);
107
108 static SYSCTL_NODE(_hw, OID_AUTO, vpd, CTLFLAG_RD, NULL, NULL);
109 static SYSCTL_NODE(_hw_vpd, OID_AUTO, machine, CTLFLAG_RD, NULL, NULL);
110 static SYSCTL_NODE(_hw_vpd_machine, OID_AUTO, type, CTLFLAG_RD, NULL, NULL);
111 static SYSCTL_NODE(_hw_vpd_machine, OID_AUTO, model, CTLFLAG_RD, NULL, NULL);
112 static SYSCTL_NODE(_hw_vpd, OID_AUTO, build_id, CTLFLAG_RD, NULL, NULL);
113 static SYSCTL_NODE(_hw_vpd, OID_AUTO, serial, CTLFLAG_RD, NULL, NULL);
114 static SYSCTL_NODE(_hw_vpd_serial, OID_AUTO, box, CTLFLAG_RD, NULL, NULL);
115 static SYSCTL_NODE(_hw_vpd_serial, OID_AUTO, planar, CTLFLAG_RD, NULL, NULL);
116
117 static void
vpd_identify(driver_t * driver,device_t parent)118 vpd_identify (driver_t *driver, device_t parent)
119 {
120 device_t child;
121 u_int32_t addr;
122 int length;
123 int rid;
124
125 if (!device_is_alive(parent))
126 return;
127
128 addr = bios_sigsearch(VPD_START, VPD_SIG, VPD_LEN, VPD_STEP, VPD_OFF);
129 if (addr != 0) {
130 rid = 0;
131 length = ADDR2VPD(addr)->Length;
132
133 child = BUS_ADD_CHILD(parent, 5, "vpd", -1);
134 device_set_driver(child, driver);
135 bus_set_resource(child, SYS_RES_MEMORY, rid, addr, length);
136 device_set_desc(child, "Vital Product Data Area");
137 }
138
139 return;
140 }
141
142 static int
vpd_probe(device_t dev)143 vpd_probe (device_t dev)
144 {
145 struct resource *res;
146 int rid;
147 int error;
148
149 error = 0;
150 rid = 0;
151 res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
152 if (res == NULL) {
153 device_printf(dev, "Unable to allocate memory resource.\n");
154 error = ENOMEM;
155 goto bad;
156 }
157
158 if (vpd_cksum(RES2VPD(res)))
159 device_printf(dev, "VPD checksum failed. BIOS update may be required.\n");
160
161 bad:
162 if (res)
163 bus_release_resource(dev, SYS_RES_MEMORY, rid, res);
164 return (error);
165 }
166
167 static int
vpd_attach(device_t dev)168 vpd_attach (device_t dev)
169 {
170 struct vpd_softc *sc;
171 char unit[4];
172 int error;
173
174 sc = device_get_softc(dev);
175 error = 0;
176
177 sc->dev = dev;
178 sc->rid = 0;
179 sc->res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->rid,
180 RF_ACTIVE);
181 if (sc->res == NULL) {
182 device_printf(dev, "Unable to allocate memory resource.\n");
183 error = ENOMEM;
184 goto bad;
185 }
186 sc->vpd = RES2VPD(sc->res);
187
188 snprintf(unit, sizeof(unit), "%d", device_get_unit(sc->dev));
189 snprintf(sc->MachineType, 5, "%.4s", sc->vpd->MachType);
190 snprintf(sc->MachineModel, 4, "%.3s", sc->vpd->MachType+4);
191 snprintf(sc->BuildID, 10, "%.9s", sc->vpd->BuildID);
192 snprintf(sc->BoxSerial, 8, "%.7s", sc->vpd->BoxSerial);
193 snprintf(sc->PlanarSerial, 12, "%.11s", sc->vpd->PlanarSerial);
194
195 sysctl_ctx_init(&sc->ctx);
196 SYSCTL_ADD_STRING(&sc->ctx,
197 SYSCTL_STATIC_CHILDREN(_hw_vpd_machine_type), OID_AUTO,
198 unit, CTLFLAG_RD, sc->MachineType, 0, NULL);
199 SYSCTL_ADD_STRING(&sc->ctx,
200 SYSCTL_STATIC_CHILDREN(_hw_vpd_machine_model), OID_AUTO,
201 unit, CTLFLAG_RD, sc->MachineModel, 0, NULL);
202 SYSCTL_ADD_STRING(&sc->ctx,
203 SYSCTL_STATIC_CHILDREN(_hw_vpd_build_id), OID_AUTO,
204 unit, CTLFLAG_RD, sc->BuildID, 0, NULL);
205 SYSCTL_ADD_STRING(&sc->ctx,
206 SYSCTL_STATIC_CHILDREN(_hw_vpd_serial_box), OID_AUTO,
207 unit, CTLFLAG_RD, sc->BoxSerial, 0, NULL);
208 SYSCTL_ADD_STRING(&sc->ctx,
209 SYSCTL_STATIC_CHILDREN(_hw_vpd_serial_planar), OID_AUTO,
210 unit, CTLFLAG_RD, sc->PlanarSerial, 0, NULL);
211
212 device_printf(dev, "Machine Type: %.4s, Model: %.3s, Build ID: %.9s\n",
213 sc->MachineType, sc->MachineModel, sc->BuildID);
214 device_printf(dev, "Box Serial: %.7s, Planar Serial: %.11s\n",
215 sc->BoxSerial, sc->PlanarSerial);
216
217 return (0);
218 bad:
219 if (sc->res)
220 bus_release_resource(dev, SYS_RES_MEMORY, sc->rid, sc->res);
221 return (error);
222 }
223
224 static int
vpd_detach(device_t dev)225 vpd_detach (device_t dev)
226 {
227 struct vpd_softc *sc;
228
229 sc = device_get_softc(dev);
230
231 if (sc->res)
232 bus_release_resource(dev, SYS_RES_MEMORY, sc->rid, sc->res);
233
234 sysctl_ctx_free(&sc->ctx);
235
236 return (0);
237 }
238
239 static int
vpd_modevent(mod,what,arg)240 vpd_modevent (mod, what, arg)
241 module_t mod;
242 int what;
243 void * arg;
244 {
245 device_t * devs;
246 int count;
247 int i;
248
249 switch (what) {
250 case MOD_LOAD:
251 break;
252 case MOD_UNLOAD:
253 devclass_get_devices(vpd_devclass, &devs, &count);
254 for (i = 0; i < count; i++) {
255 device_delete_child(device_get_parent(devs[i]), devs[i]);
256 }
257 break;
258 default:
259 break;
260 }
261
262 return (0);
263 }
264
265 static device_method_t vpd_methods[] = {
266 /* Device interface */
267 DEVMETHOD(device_identify, vpd_identify),
268 DEVMETHOD(device_probe, vpd_probe),
269 DEVMETHOD(device_attach, vpd_attach),
270 DEVMETHOD(device_detach, vpd_detach),
271 { 0, 0 }
272 };
273
274 static driver_t vpd_driver = {
275 "vpd",
276 vpd_methods,
277 sizeof(struct vpd_softc),
278 };
279
280 DRIVER_MODULE(vpd, nexus, vpd_driver, vpd_devclass, vpd_modevent, 0);
281 MODULE_VERSION(vpd, 1);
282
283 /*
284 * Perform a checksum over the VPD structure, starting with
285 * the BuildID. (Jean Delvare <khali@linux-fr.org>)
286 */
287 static int
vpd_cksum(struct vpd * v)288 vpd_cksum (struct vpd *v)
289 {
290 u_int8_t *ptr;
291 u_int8_t cksum;
292 int i;
293
294 ptr = (u_int8_t *)v;
295 cksum = 0;
296 for (i = offsetof(struct vpd, BuildID); i < v->Length ; i++)
297 cksum += ptr[i];
298 return (cksum);
299 }
300