sys/x86/bios/vpd.c

   1 /*-
   2  * Copyright (c) 2003 Matthew N. Dodd <winter@jurai.net>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 /*
  31  * VPD decoder for IBM systems (Thinkpads)
  32  * http://www-1.ibm.com/support/docview.wss?uid=psg1MIGR-45120
  33  */
  34
  35 #include <sys/param.h>
  36 #include <sys/systm.h>
  37 #include <sys/kernel.h>
  38 #include <sys/socket.h>
  39 #include <sys/sysctl.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 <vm/vm.h>
  49 #include <vm/vm_param.h>
  50 #include <vm/pmap.h>
  51 #include <machine/md_var.h>
  52 #include <machine/pc/bios.h>
  53
  54 /*
  55  * Vital Product Data
  56  */
  57 struct vpd {
  58         u_int16_t       Header;                 /* 0x55AA */
  59         u_int8_t        Signature[3];           /* Always 'VPD' */
  60         u_int8_t        Length;                 /* Sructure Length */
  61
  62         u_int8_t        Reserved[7];            /* Reserved */
  63
  64         u_int8_t        BuildID[9];             /* BIOS Build ID */
  65         u_int8_t        BoxSerial[7];           /* Box Serial Number */
  66         u_int8_t        PlanarSerial[11];       /* Motherboard Serial Number */
  67         u_int8_t        MachType[7];            /* Machine Type/Model */
  68         u_int8_t        Checksum;               /* Checksum */
  69 } __packed;
  70
  71 struct vpd_softc {
  72         device_t                dev;
  73         struct resource *       res;
  74         int                     rid;
  75
  76         struct vpd *            vpd;
  77
  78         struct sysctl_ctx_list  ctx;
  79
  80         char            BuildID[10];
  81         char            BoxSerial[8];
  82         char            PlanarSerial[12];
  83         char            MachineType[5];
  84         char            MachineModel[4];
  85 };
  86
  87 #define VPD_START       0xf0000
  88 #define VPD_STEP        0x10
  89 #define VPD_OFF         2
  90 #define VPD_LEN         3
  91 #define VPD_SIG         "VPD"
  92
  93 #define RES2VPD(res)    ((struct vpd *)rman_get_virtual(res))
  94 #define ADDR2VPD(addr)  ((struct vpd *)BIOS_PADDRTOVADDR(addr))
  95
  96 static devclass_t vpd_devclass;
  97
  98 static void     vpd_identify    (driver_t *, device_t);
  99 static int      vpd_probe       (device_t);
 100 static int      vpd_attach      (device_t);
 101 static int      vpd_detach      (device_t);
 102 static int      vpd_modevent    (module_t, int, void *);
 103
 104 static int      vpd_cksum       (struct vpd *);
 105
 106 static SYSCTL_NODE(_hw, OID_AUTO, vpd, CTLFLAG_RD, NULL, NULL);
 107 static SYSCTL_NODE(_hw_vpd, OID_AUTO, machine, CTLFLAG_RD, NULL, NULL);
 108 static SYSCTL_NODE(_hw_vpd_machine, OID_AUTO, type, CTLFLAG_RD, NULL, NULL);
 109 static SYSCTL_NODE(_hw_vpd_machine, OID_AUTO, model, CTLFLAG_RD, NULL, NULL);
 110 static SYSCTL_NODE(_hw_vpd, OID_AUTO, build_id, CTLFLAG_RD, NULL, NULL);
 111 static SYSCTL_NODE(_hw_vpd, OID_AUTO, serial, CTLFLAG_RD, NULL, NULL);
 112 static SYSCTL_NODE(_hw_vpd_serial, OID_AUTO, box, CTLFLAG_RD, NULL, NULL);
 113 static SYSCTL_NODE(_hw_vpd_serial, OID_AUTO, planar, CTLFLAG_RD, NULL, NULL);
 114
 115 static void
 116 vpd_identify (driver_t *driver, device_t parent)
 117 {
 118         device_t child;
 119         u_int32_t addr;
 120         int length;
 121         int rid;
 122
 123         if (!device_is_alive(parent))
 124                 return;
 125
 126         addr = bios_sigsearch(VPD_START, VPD_SIG, VPD_LEN, VPD_STEP, VPD_OFF);
 127         if (addr != 0) {
 128                 rid = 0;
 129                 length = ADDR2VPD(addr)->Length;
 130
 131                 child = BUS_ADD_CHILD(parent, 5, "vpd", -1);
 132                 device_set_driver(child, driver);
 133                 bus_set_resource(child, SYS_RES_MEMORY, rid, addr, length);
 134                 device_set_desc(child, "Vital Product Data Area");
 135         }
 136
 137         return;
 138 }
 139
 140 static int
 141 vpd_probe (device_t dev)
 142 {
 143         struct resource *res;
 144         int rid;
 145         int error;
 146
 147         error = 0;
 148         rid = 0;
 149         res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 150         if (res == NULL) {
 151                 device_printf(dev, "Unable to allocate memory resource.\n");
 152                 error = ENOMEM;
 153                 goto bad;
 154         }
 155
 156         if (vpd_cksum(RES2VPD(res)))
 157                 device_printf(dev, "VPD checksum failed.  BIOS update may be required.\n");
 158
 159 bad:
 160         if (res)
 161                 bus_release_resource(dev, SYS_RES_MEMORY, rid, res);
 162         return (error);
 163 }
 164
 165 static int
 166 vpd_attach (device_t dev)
 167 {
 168         struct vpd_softc *sc;
 169         char unit[4];
 170         int error;
 171
 172         sc = device_get_softc(dev);
 173         error = 0;
 174
 175         sc->dev = dev;
 176         sc->rid = 0;
 177         sc->res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->rid,
 178                 RF_ACTIVE);
 179         if (sc->res == NULL) {
 180                 device_printf(dev, "Unable to allocate memory resource.\n");
 181                 error = ENOMEM;
 182                 goto bad;
 183         }
 184         sc->vpd = RES2VPD(sc->res);
 185
 186         snprintf(unit, sizeof(unit), "%d", device_get_unit(sc->dev));
 187         snprintf(sc->MachineType, 5, "%.4s", sc->vpd->MachType);
 188         snprintf(sc->MachineModel, 4, "%.3s", sc->vpd->MachType+4);
 189         snprintf(sc->BuildID, 10, "%.9s", sc->vpd->BuildID);
 190         snprintf(sc->BoxSerial, 8, "%.7s", sc->vpd->BoxSerial);
 191         snprintf(sc->PlanarSerial, 12, "%.11s", sc->vpd->PlanarSerial);
 192
 193         sysctl_ctx_init(&sc->ctx);
 194         SYSCTL_ADD_STRING(&sc->ctx,
 195                 SYSCTL_STATIC_CHILDREN(_hw_vpd_machine_type), OID_AUTO,
 196                 unit, CTLFLAG_RD|CTLFLAG_DYN, sc->MachineType, 0, NULL);
 197         SYSCTL_ADD_STRING(&sc->ctx,
 198                 SYSCTL_STATIC_CHILDREN(_hw_vpd_machine_model), OID_AUTO,
 199                 unit, CTLFLAG_RD|CTLFLAG_DYN, sc->MachineModel, 0, NULL);
 200         SYSCTL_ADD_STRING(&sc->ctx,
 201                 SYSCTL_STATIC_CHILDREN(_hw_vpd_build_id), OID_AUTO,
 202                 unit, CTLFLAG_RD|CTLFLAG_DYN, sc->BuildID, 0, NULL);
 203         SYSCTL_ADD_STRING(&sc->ctx,
 204                 SYSCTL_STATIC_CHILDREN(_hw_vpd_serial_box), OID_AUTO,
 205                 unit, CTLFLAG_RD|CTLFLAG_DYN, sc->BoxSerial, 0, NULL);
 206         SYSCTL_ADD_STRING(&sc->ctx,
 207                 SYSCTL_STATIC_CHILDREN(_hw_vpd_serial_planar), OID_AUTO,
 208                 unit, CTLFLAG_RD|CTLFLAG_DYN, sc->PlanarSerial, 0, NULL);
 209
 210         device_printf(dev, "Machine Type: %.4s, Model: %.3s, Build ID: %.9s\n",
 211                 sc->MachineType, sc->MachineModel, sc->BuildID);
 212         device_printf(dev, "Box Serial: %.7s, Planar Serial: %.11s\n",
 213                 sc->BoxSerial, sc->PlanarSerial);
 214
 215         return (0);
 216 bad:
 217         if (sc->res)
 218                 bus_release_resource(dev, SYS_RES_MEMORY, sc->rid, sc->res);
 219         return (error);
 220 }
 221
 222 static int
 223 vpd_detach (device_t dev)
 224 {
 225         struct vpd_softc *sc;
 226
 227         sc = device_get_softc(dev);
 228
 229         if (sc->res)
 230                 bus_release_resource(dev, SYS_RES_MEMORY, sc->rid, sc->res);
 231
 232         sysctl_ctx_free(&sc->ctx);
 233
 234         return (0);
 235 }
 236
 237 static int
 238 vpd_modevent (mod, what, arg)
 239         module_t        mod;
 240         int             what;
 241         void *          arg;
 242 {
 243         device_t *      devs;
 244         int             count;
 245         int             i;
 246
 247         switch (what) {
 248         case MOD_LOAD:
 249                 break;
 250         case MOD_UNLOAD:
 251                 devclass_get_devices(vpd_devclass, &devs, &count);
 252                 for (i = 0; i < count; i++) {
 253                         device_delete_child(device_get_parent(devs[i]), devs[i]);
 254                 }
 255                 break;
 256         default:
 257                 break;
 258         }
 259
 260         return (0);
 261 }
 262
 263 static device_method_t vpd_methods[] = {
 264         /* Device interface */
 265         DEVMETHOD(device_identify,      vpd_identify),
 266         DEVMETHOD(device_probe,         vpd_probe),
 267         DEVMETHOD(device_attach,        vpd_attach),
 268         DEVMETHOD(device_detach,        vpd_detach),
 269         { 0, 0 }
 270 };
 271
 272 static driver_t vpd_driver = {
 273         "vpd",
 274         vpd_methods,
 275         sizeof(struct vpd_softc),
 276 };
 277
 278 DRIVER_MODULE(vpd, nexus, vpd_driver, vpd_devclass, vpd_modevent, 0);
 279 MODULE_VERSION(vpd, 1);
 280
 281 /*
 282  * Perform a checksum over the VPD structure, starting with
 283  * the BuildID.  (Jean Delvare <khali@linux-fr.org>)
 284  */
 285 static int
 286 vpd_cksum (struct vpd *v)
 287 {
 288         u_int8_t *ptr;
 289         u_int8_t cksum;
 290         int i;
 291
 292         ptr = (u_int8_t *)v;
 293         cksum = 0;
 294         for (i = offsetof(struct vpd, BuildID); i < v->Length ; i++)
 295                 cksum += ptr[i];
 296         return (cksum);
 297 }