drivers/gpu/drm/nouveau/core/subdev/bios/base.c

   1 /*
   2  * Copyright 2012 Red Hat Inc.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20  * OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * Authors: Ben Skeggs
  23  */
  24
  25 #include <core/object.h>
  26 #include <core/device.h>
  27 #include <core/subdev.h>
  28 #include <core/option.h>
  29
  30 #include <subdev/bios.h>
  31 #include <subdev/bios/bmp.h>
  32 #include <subdev/bios/bit.h>
  33
  34 u8
  35 nvbios_checksum(const u8 *data, int size)
  36 {
  37         u8 sum = 0;
  38         while (size--)
  39                 sum += *data++;
  40         return sum;
  41 }
  42
  43 u16
  44 nvbios_findstr(const u8 *data, int size, const char *str, int len)
  45 {
  46         int i, j;
  47
  48         for (i = 0; i <= (size - len); i++) {
  49                 for (j = 0; j < len; j++)
  50                         if ((char)data[i + j] != str[j])
  51                                 break;
  52                 if (j == len)
  53                         return i;
  54         }
  55
  56         return 0;
  57 }
  58
  59 #if defined(__powerpc__)
  60 static void
  61 nouveau_bios_shadow_of(struct nouveau_bios *bios)
  62 {
  63         struct pci_dev *pdev = nv_device(bios)->pdev;
  64         struct device_node *dn;
  65         const u32 *data;
  66         int size;
  67
  68         dn = pci_device_to_OF_node(pdev);
  69         if (!dn) {
  70                 nv_info(bios, "Unable to get the OF node\n");
  71                 return;
  72         }
  73
  74         data = of_get_property(dn, "NVDA,BMP", &size);
  75         if (data && size) {
  76                 bios->size = size;
  77                 bios->data = kmalloc(bios->size, GFP_KERNEL);
  78                 if (bios->data)
  79                         memcpy(bios->data, data, size);
  80         }
  81 }
  82 #endif
  83
  84 static void
  85 nouveau_bios_shadow_pramin(struct nouveau_bios *bios)
  86 {
  87         struct nouveau_device *device = nv_device(bios);
  88         u32 bar0 = 0;
  89         int i;
  90
  91         if (device->card_type >= NV_50) {
  92                 u64 addr = (u64)(nv_rd32(bios, 0x619f04) & 0xffffff00) << 8;
  93                 if (!addr) {
  94                         addr  = (u64)nv_rd32(bios, 0x001700) << 16;
  95                         addr += 0xf0000;
  96                 }
  97
  98                 bar0 = nv_mask(bios, 0x001700, 0xffffffff, addr >> 16);
  99         }
 100
 101         /* bail if no rom signature */
 102         if (nv_rd08(bios, 0x700000) != 0x55 ||
 103             nv_rd08(bios, 0x700001) != 0xaa)
 104                 goto out;
 105
 106         bios->size = nv_rd08(bios, 0x700002) * 512;
 107         if (!bios->size)
 108                 goto out;
 109
 110         bios->data = kmalloc(bios->size, GFP_KERNEL);
 111         if (bios->data) {
 112                 for (i = 0; i < bios->size; i++)
 113                         nv_wo08(bios, i, nv_rd08(bios, 0x700000 + i));
 114         }
 115
 116 out:
 117         if (device->card_type >= NV_50)
 118                 nv_wr32(bios, 0x001700, bar0);
 119 }
 120
 121 static void
 122 nouveau_bios_shadow_prom(struct nouveau_bios *bios)
 123 {
 124         struct nouveau_device *device = nv_device(bios);
 125         u32 pcireg, access;
 126         u16 pcir;
 127         int i;
 128
 129         /* enable access to rom */
 130         if (device->card_type >= NV_50)
 131                 pcireg = 0x088050;
 132         else
 133                 pcireg = 0x001850;
 134         access = nv_mask(bios, pcireg, 0x00000001, 0x00000000);
 135
 136         /* bail if no rom signature, with a workaround for a PROM reading
 137          * issue on some chipsets.  the first read after a period of
 138          * inactivity returns the wrong result, so retry the first header
 139          * byte a few times before giving up as a workaround
 140          */
 141         i = 16;
 142         do {
 143                 if (nv_rd08(bios, 0x300000) == 0x55)
 144                         break;
 145         } while (i--);
 146
 147         if (!i || nv_rd08(bios, 0x300001) != 0xaa)
 148                 goto out;
 149
 150         /* additional check (see note below) - read PCI record header */
 151         pcir = nv_rd08(bios, 0x300018) |
 152                nv_rd08(bios, 0x300019) << 8;
 153         if (nv_rd08(bios, 0x300000 + pcir) != 'P' ||
 154             nv_rd08(bios, 0x300001 + pcir) != 'C' ||
 155             nv_rd08(bios, 0x300002 + pcir) != 'I' ||
 156             nv_rd08(bios, 0x300003 + pcir) != 'R')
 157                 goto out;
 158
 159         /* read entire bios image to system memory */
 160         bios->size = nv_rd08(bios, 0x300002) * 512;
 161         if (!bios->size)
 162                 goto out;
 163
 164         bios->data = kmalloc(bios->size, GFP_KERNEL);
 165         if (bios->data) {
 166                 for (i = 0; i < bios->size; i++)
 167                         nv_wo08(bios, i, nv_rd08(bios, 0x300000 + i));
 168         }
 169
 170 out:
 171         /* disable access to rom */
 172         nv_wr32(bios, pcireg, access);
 173 }
 174
 175 #if defined(CONFIG_ACPI)
 176 int nouveau_acpi_get_bios_chunk(uint8_t *bios, int offset, int len);
 177 bool nouveau_acpi_rom_supported(struct pci_dev *pdev);
 178 #else
 179 static inline bool
 180 nouveau_acpi_rom_supported(struct pci_dev *pdev) {
 181         return false;
 182 }
 183
 184 static inline int
 185 nouveau_acpi_get_bios_chunk(uint8_t *bios, int offset, int len) {
 186         return -EINVAL;
 187 }
 188 #endif
 189
 190 static void
 191 nouveau_bios_shadow_acpi(struct nouveau_bios *bios)
 192 {
 193         struct pci_dev *pdev = nv_device(bios)->pdev;
 194         int ret, cnt, i;
 195
 196         if (!nouveau_acpi_rom_supported(pdev)) {
 197                 bios->data = NULL;
 198                 return;
 199         }
 200
 201         bios->size = 0;
 202         bios->data = kmalloc(4096, GFP_KERNEL);
 203         if (bios->data) {
 204                 if (nouveau_acpi_get_bios_chunk(bios->data, 0, 4096) == 4096)
 205                         bios->size = bios->data[2] * 512;
 206                 kfree(bios->data);
 207         }
 208
 209         if (!bios->size)
 210                 return;
 211
 212         bios->data = kmalloc(bios->size, GFP_KERNEL);
 213         if (bios->data) {
 214                 /* disobey the acpi spec - much faster on at least w530 ... */
 215                 ret = nouveau_acpi_get_bios_chunk(bios->data, 0, bios->size);
 216                 if (ret != bios->size ||
 217                     nvbios_checksum(bios->data, bios->size)) {
 218                         /* ... that didn't work, ok, i'll be good now */
 219                         for (i = 0; i < bios->size; i += cnt) {
 220                                 cnt = min((bios->size - i), (u32)4096);
 221                                 ret = nouveau_acpi_get_bios_chunk(bios->data, i, cnt);
 222                                 if (ret != cnt)
 223                                         break;
 224                         }
 225                 }
 226         }
 227 }
 228
 229 static void
 230 nouveau_bios_shadow_pci(struct nouveau_bios *bios)
 231 {
 232         struct pci_dev *pdev = nv_device(bios)->pdev;
 233         size_t size;
 234
 235         if (!pci_enable_rom(pdev)) {
 236                 void __iomem *rom = pci_map_rom(pdev, &size);
 237                 if (rom && size) {
 238                         bios->data = kmalloc(size, GFP_KERNEL);
 239                         if (bios->data) {
 240                                 memcpy_fromio(bios->data, rom, size);
 241                                 bios->size = size;
 242                         }
 243                 }
 244                 if (rom)
 245                         pci_unmap_rom(pdev, rom);
 246
 247                 pci_disable_rom(pdev);
 248         }
 249 }
 250
 251 static int
 252 nouveau_bios_score(struct nouveau_bios *bios, const bool writeable)
 253 {
 254         if (bios->size < 3 || !bios->data || bios->data[0] != 0x55 ||
 255                         bios->data[1] != 0xAA) {
 256                 nv_info(bios, "... signature not found\n");
 257                 return 0;
 258         }
 259
 260         if (nvbios_checksum(bios->data,
 261                         min_t(u32, bios->data[2] * 512, bios->size))) {
 262                 nv_info(bios, "... checksum invalid\n");
 263                 /* if a ro image is somewhat bad, it's probably all rubbish */
 264                 return writeable ? 2 : 1;
 265         }
 266
 267         nv_info(bios, "... appears to be valid\n");
 268         return 3;
 269 }
 270
 271 struct methods {
 272         const char desc[16];
 273         void (*shadow)(struct nouveau_bios *);
 274         const bool rw;
 275         int score;
 276         u32 size;
 277         u8 *data;
 278 };
 279
 280 static int
 281 nouveau_bios_shadow(struct nouveau_bios *bios)
 282 {
 283         struct methods shadow_methods[] = {
 284 #if defined(__powerpc__)
 285                 { "OpenFirmware", nouveau_bios_shadow_of, true, 0, 0, NULL },
 286 #endif
 287                 { "PRAMIN", nouveau_bios_shadow_pramin, true, 0, 0, NULL },
 288                 { "PROM", nouveau_bios_shadow_prom, false, 0, 0, NULL },
 289                 { "ACPI", nouveau_bios_shadow_acpi, true, 0, 0, NULL },
 290                 { "PCIROM", nouveau_bios_shadow_pci, true, 0, 0, NULL },
 291                 {}
 292         };
 293         struct methods *mthd, *best;
 294         const struct firmware *fw;
 295         const char *optarg;
 296         int optlen, ret;
 297         char *source;
 298
 299         optarg = nouveau_stropt(nv_device(bios)->cfgopt, "NvBios", &optlen);
 300         source = optarg ? kstrndup(optarg, optlen, GFP_KERNEL) : NULL;
 301         if (source) {
 302                 /* try to match one of the built-in methods */
 303                 mthd = shadow_methods;
 304                 do {
 305                         if (strcasecmp(source, mthd->desc))
 306                                 continue;
 307                         nv_info(bios, "source: %s\n", mthd->desc);
 308
 309                         mthd->shadow(bios);
 310                         mthd->score = nouveau_bios_score(bios, mthd->rw);
 311                         if (mthd->score) {
 312                                 kfree(source);
 313                                 return 0;
 314                         }
 315                 } while ((++mthd)->shadow);
 316
 317                 /* attempt to load firmware image */
 318                 ret = request_firmware(&fw, source, &nv_device(bios)->pdev->dev);
 319                 if (ret == 0) {
 320                         bios->size = fw->size;
 321                         bios->data = kmemdup(fw->data, fw->size, GFP_KERNEL);
 322                         release_firmware(fw);
 323
 324                         nv_info(bios, "image: %s\n", source);
 325                         if (nouveau_bios_score(bios, 1)) {
 326                                 kfree(source);
 327                                 return 0;
 328                         }
 329
 330                         kfree(bios->data);
 331                         bios->data = NULL;
 332                 }
 333
 334                 nv_error(bios, "source \'%s\' invalid\n", source);
 335                 kfree(source);
 336         }
 337
 338         mthd = shadow_methods;
 339         do {
 340                 nv_info(bios, "checking %s for image...\n", mthd->desc);
 341                 mthd->shadow(bios);
 342                 mthd->score = nouveau_bios_score(bios, mthd->rw);
 343                 mthd->size = bios->size;
 344                 mthd->data = bios->data;
 345                 bios->data = NULL;
 346         } while (mthd->score != 3 && (++mthd)->shadow);
 347
 348         mthd = shadow_methods;
 349         best = mthd;
 350         do {
 351                 if (mthd->score > best->score) {
 352                         kfree(best->data);
 353                         best = mthd;
 354                 }
 355         } while ((++mthd)->shadow);
 356
 357         if (best->score) {
 358                 nv_info(bios, "using image from %s\n", best->desc);
 359                 bios->size = best->size;
 360                 bios->data = best->data;
 361                 return 0;
 362         }
 363
 364         nv_error(bios, "unable to locate usable image\n");
 365         return -EINVAL;
 366 }
 367
 368 static u8
 369 nouveau_bios_rd08(struct nouveau_object *object, u64 addr)
 370 {
 371         struct nouveau_bios *bios = (void *)object;
 372         return bios->data[addr];
 373 }
 374
 375 static u16
 376 nouveau_bios_rd16(struct nouveau_object *object, u64 addr)
 377 {
 378         struct nouveau_bios *bios = (void *)object;
 379         return get_unaligned_le16(&bios->data[addr]);
 380 }
 381
 382 static u32
 383 nouveau_bios_rd32(struct nouveau_object *object, u64 addr)
 384 {
 385         struct nouveau_bios *bios = (void *)object;
 386         return get_unaligned_le32(&bios->data[addr]);
 387 }
 388
 389 static void
 390 nouveau_bios_wr08(struct nouveau_object *object, u64 addr, u8 data)
 391 {
 392         struct nouveau_bios *bios = (void *)object;
 393         bios->data[addr] = data;
 394 }
 395
 396 static void
 397 nouveau_bios_wr16(struct nouveau_object *object, u64 addr, u16 data)
 398 {
 399         struct nouveau_bios *bios = (void *)object;
 400         put_unaligned_le16(data, &bios->data[addr]);
 401 }
 402
 403 static void
 404 nouveau_bios_wr32(struct nouveau_object *object, u64 addr, u32 data)
 405 {
 406         struct nouveau_bios *bios = (void *)object;
 407         put_unaligned_le32(data, &bios->data[addr]);
 408 }
 409
 410 static int
 411 nouveau_bios_ctor(struct nouveau_object *parent,
 412                   struct nouveau_object *engine,
 413                   struct nouveau_oclass *oclass, void *data, u32 size,
 414                   struct nouveau_object **pobject)
 415 {
 416         struct nouveau_bios *bios;
 417         struct bit_entry bit_i;
 418         int ret;
 419
 420         ret = nouveau_subdev_create(parent, engine, oclass, 0,
 421                                     "VBIOS", "bios", &bios);
 422         *pobject = nv_object(bios);
 423         if (ret)
 424                 return ret;
 425
 426         ret = nouveau_bios_shadow(bios);
 427         if (ret)
 428                 return ret;
 429
 430         /* detect type of vbios we're dealing with */
 431         bios->bmp_offset = nvbios_findstr(bios->data, bios->size,
 432                                           "\xff\x7f""NV\0", 5);
 433         if (bios->bmp_offset) {
 434                 nv_info(bios, "BMP version %x.%x\n",
 435                         bmp_version(bios) >> 8,
 436                         bmp_version(bios) & 0xff);
 437         }
 438
 439         bios->bit_offset = nvbios_findstr(bios->data, bios->size,
 440                                           "\xff\xb8""BIT", 5);
 441         if (bios->bit_offset)
 442                 nv_info(bios, "BIT signature found\n");
 443
 444         /* determine the vbios version number */
 445         if (!bit_entry(bios, 'i', &bit_i) && bit_i.length >= 4) {
 446                 bios->version.major = nv_ro08(bios, bit_i.offset + 3);
 447                 bios->version.chip  = nv_ro08(bios, bit_i.offset + 2);
 448                 bios->version.minor = nv_ro08(bios, bit_i.offset + 1);
 449                 bios->version.micro = nv_ro08(bios, bit_i.offset + 0);
 450         } else
 451         if (bmp_version(bios)) {
 452                 bios->version.major = nv_ro08(bios, bios->bmp_offset + 13);
 453                 bios->version.chip  = nv_ro08(bios, bios->bmp_offset + 12);
 454                 bios->version.minor = nv_ro08(bios, bios->bmp_offset + 11);
 455                 bios->version.micro = nv_ro08(bios, bios->bmp_offset + 10);
 456         }
 457
 458         nv_info(bios, "version %02x.%02x.%02x.%02x\n",
 459                 bios->version.major, bios->version.chip,
 460                 bios->version.minor, bios->version.micro);
 461
 462         return 0;
 463 }
 464
 465 static void
 466 nouveau_bios_dtor(struct nouveau_object *object)
 467 {
 468         struct nouveau_bios *bios = (void *)object;
 469         kfree(bios->data);
 470         nouveau_subdev_destroy(&bios->base);
 471 }
 472
 473 static int
 474 nouveau_bios_init(struct nouveau_object *object)
 475 {
 476         struct nouveau_bios *bios = (void *)object;
 477         return nouveau_subdev_init(&bios->base);
 478 }
 479
 480 static int
 481 nouveau_bios_fini(struct nouveau_object *object, bool suspend)
 482 {
 483         struct nouveau_bios *bios = (void *)object;
 484         return nouveau_subdev_fini(&bios->base, suspend);
 485 }
 486
 487 struct nouveau_oclass
 488 nouveau_bios_oclass = {
 489         .handle = NV_SUBDEV(VBIOS, 0x00),
 490         .ofuncs = &(struct nouveau_ofuncs) {
 491                 .ctor = nouveau_bios_ctor,
 492                 .dtor = nouveau_bios_dtor,
 493                 .init = nouveau_bios_init,
 494                 .fini = nouveau_bios_fini,
 495                 .rd08 = nouveau_bios_rd08,
 496                 .rd16 = nouveau_bios_rd16,
 497                 .rd32 = nouveau_bios_rd32,
 498                 .wr08 = nouveau_bios_wr08,
 499                 .wr16 = nouveau_bios_wr16,
 500                 .wr32 = nouveau_bios_wr32,
 501         },
 502 };