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, i;
  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) {
  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         bios->data = kmalloc(bios->size, GFP_KERNEL);
 108         if (bios->data) {
 109                 for (i = 0; i < bios->size; i++)
 110                         nv_wo08(bios, i, nv_rd08(bios, 0x700000 + i));
 111         }
 112
 113 out:
 114         if (device->card_type >= NV_50)
 115                 nv_wr32(bios, 0x001700, bar0);
 116 }
 117
 118 static void
 119 nouveau_bios_shadow_prom(struct nouveau_bios *bios)
 120 {
 121         struct nouveau_device *device = nv_device(bios);
 122         u32 pcireg, access;
 123         u16 pcir;
 124         int i;
 125
 126         /* enable access to rom */
 127         if (device->card_type >= NV_50)
 128                 pcireg = 0x088050;
 129         else
 130                 pcireg = 0x001850;
 131         access = nv_mask(bios, pcireg, 0x00000001, 0x00000000);
 132
 133         /* bail if no rom signature, with a workaround for a PROM reading
 134          * issue on some chipsets.  the first read after a period of
 135          * inactivity returns the wrong result, so retry the first header
 136          * byte a few times before giving up as a workaround
 137          */
 138         i = 16;
 139         do {
 140                 if (nv_rd08(bios, 0x300000) == 0x55)
 141                         break;
 142         } while (i--);
 143
 144         if (!i || nv_rd08(bios, 0x300001) != 0xaa)
 145                 goto out;
 146
 147         /* additional check (see note below) - read PCI record header */
 148         pcir = nv_rd08(bios, 0x300018) |
 149                nv_rd08(bios, 0x300019) << 8;
 150         if (nv_rd08(bios, 0x300000 + pcir) != 'P' ||
 151             nv_rd08(bios, 0x300001 + pcir) != 'C' ||
 152             nv_rd08(bios, 0x300002 + pcir) != 'I' ||
 153             nv_rd08(bios, 0x300003 + pcir) != 'R')
 154                 goto out;
 155
 156         /* read entire bios image to system memory */
 157         bios->size = nv_rd08(bios, 0x300002) * 512;
 158         bios->data = kmalloc(bios->size, GFP_KERNEL);
 159         if (bios->data) {
 160                 for (i = 0; i < bios->size; i++)
 161                         nv_wo08(bios, i, nv_rd08(bios, 0x300000 + i));
 162         }
 163
 164 out:
 165         /* disable access to rom */
 166         nv_wr32(bios, pcireg, access);
 167 }
 168
 169 #if defined(CONFIG_ACPI)
 170 int nouveau_acpi_get_bios_chunk(uint8_t *bios, int offset, int len);
 171 bool nouveau_acpi_rom_supported(struct pci_dev *pdev);
 172 #else
 173 static inline bool
 174 nouveau_acpi_rom_supported(struct pci_dev *pdev) {
 175         return false;
 176 }
 177
 178 static inline int
 179 nouveau_acpi_get_bios_chunk(uint8_t *bios, int offset, int len) {
 180         return -EINVAL;
 181 }
 182 #endif
 183
 184 static void
 185 nouveau_bios_shadow_acpi(struct nouveau_bios *bios)
 186 {
 187         struct pci_dev *pdev = nv_device(bios)->pdev;
 188         int ret, cnt, i;
 189         u8  data[3];
 190
 191         if (!nouveau_acpi_rom_supported(pdev))
 192                 return;
 193
 194         bios->size = 0;
 195         if (nouveau_acpi_get_bios_chunk(data, 0, 3) == 3)
 196                 bios->size = data[2] * 512;
 197
 198         bios->data = kmalloc(bios->size, GFP_KERNEL);
 199         for (i = 0; bios->data && i < bios->size; i += cnt) {
 200                 cnt = min((bios->size - i), (u32)4096);
 201                 ret = nouveau_acpi_get_bios_chunk(bios->data, i, cnt);
 202                 if (ret != cnt)
 203                         break;
 204         }
 205 }
 206
 207 static void
 208 nouveau_bios_shadow_pci(struct nouveau_bios *bios)
 209 {
 210         struct pci_dev *pdev = nv_device(bios)->pdev;
 211         size_t size;
 212
 213         if (!pci_enable_rom(pdev)) {
 214                 void __iomem *rom = pci_map_rom(pdev, &size);
 215                 if (rom && size) {
 216                         bios->data = kmalloc(size, GFP_KERNEL);
 217                         if (bios->data) {
 218                                 memcpy_fromio(bios->data, rom, size);
 219                                 bios->size = size;
 220                         }
 221                 }
 222                 if (rom)
 223                         pci_unmap_rom(pdev, rom);
 224
 225                 pci_disable_rom(pdev);
 226         }
 227 }
 228
 229 static int
 230 nouveau_bios_score(struct nouveau_bios *bios, const bool writeable)
 231 {
 232         if (!bios->data || bios->data[0] != 0x55 || bios->data[1] != 0xAA) {
 233                 nv_info(bios, "... signature not found\n");
 234                 return 0;
 235         }
 236
 237         if (nvbios_checksum(bios->data, bios->data[2] * 512)) {
 238                 nv_info(bios, "... checksum invalid\n");
 239                 /* if a ro image is somewhat bad, it's probably all rubbish */
 240                 return writeable ? 2 : 1;
 241         }
 242
 243         nv_info(bios, "... appears to be valid\n");
 244         return 3;
 245 }
 246
 247 struct methods {
 248         const char desc[16];
 249         void (*shadow)(struct nouveau_bios *);
 250         const bool rw;
 251         int score;
 252         u32 size;
 253         u8 *data;
 254 };
 255
 256 static int
 257 nouveau_bios_shadow(struct nouveau_bios *bios)
 258 {
 259         struct methods shadow_methods[] = {
 260 #if defined(__powerpc__)
 261                 { "OpenFirmware", nouveau_bios_shadow_of, true, 0, 0, NULL },
 262 #endif
 263                 { "PRAMIN", nouveau_bios_shadow_pramin, true, 0, 0, NULL },
 264                 { "PROM", nouveau_bios_shadow_prom, false, 0, 0, NULL },
 265                 { "ACPI", nouveau_bios_shadow_acpi, true, 0, 0, NULL },
 266                 { "PCIROM", nouveau_bios_shadow_pci, true, 0, 0, NULL },
 267                 {}
 268         };
 269         struct methods *mthd, *best;
 270         const struct firmware *fw;
 271         const char *optarg;
 272         int optlen, ret;
 273         char *source;
 274
 275         optarg = nouveau_stropt(nv_device(bios)->cfgopt, "NvBios", &optlen);
 276         source = optarg ? kstrndup(optarg, optlen, GFP_KERNEL) : NULL;
 277         if (source) {
 278                 /* try to match one of the built-in methods */
 279                 mthd = shadow_methods;
 280                 do {
 281                         if (strcasecmp(source, mthd->desc))
 282                                 continue;
 283                         nv_info(bios, "source: %s\n", mthd->desc);
 284
 285                         mthd->shadow(bios);
 286                         mthd->score = nouveau_bios_score(bios, mthd->rw);
 287                         if (mthd->score) {
 288                                 kfree(source);
 289                                 return 0;
 290                         }
 291                 } while ((++mthd)->shadow);
 292
 293                 /* attempt to load firmware image */
 294                 ret = request_firmware(&fw, source, &nv_device(bios)->pdev->dev);
 295                 if (ret == 0) {
 296                         bios->size = fw->size;
 297                         bios->data = kmemdup(fw->data, fw->size, GFP_KERNEL);
 298                         release_firmware(fw);
 299
 300                         nv_info(bios, "image: %s\n", source);
 301                         if (nouveau_bios_score(bios, 1)) {
 302                                 kfree(source);
 303                                 return 0;
 304                         }
 305
 306                         kfree(bios->data);
 307                         bios->data = NULL;
 308                 }
 309
 310                 nv_error(bios, "source \'%s\' invalid\n", source);
 311                 kfree(source);
 312         }
 313
 314         mthd = shadow_methods;
 315         do {
 316                 nv_info(bios, "checking %s for image...\n", mthd->desc);
 317                 mthd->shadow(bios);
 318                 mthd->score = nouveau_bios_score(bios, mthd->rw);
 319                 mthd->size = bios->size;
 320                 mthd->data = bios->data;
 321                 bios->data = NULL;
 322         } while (mthd->score != 3 && (++mthd)->shadow);
 323
 324         mthd = shadow_methods;
 325         best = mthd;
 326         do {
 327                 if (mthd->score > best->score) {
 328                         kfree(best->data);
 329                         best = mthd;
 330                 }
 331         } while ((++mthd)->shadow);
 332
 333         if (best->score) {
 334                 nv_info(bios, "using image from %s\n", best->desc);
 335                 bios->size = best->size;
 336                 bios->data = best->data;
 337                 return 0;
 338         }
 339
 340         nv_error(bios, "unable to locate usable image\n");
 341         return -EINVAL;
 342 }
 343
 344 static u8
 345 nouveau_bios_rd08(struct nouveau_object *object, u32 addr)
 346 {
 347         struct nouveau_bios *bios = (void *)object;
 348         return bios->data[addr];
 349 }
 350
 351 static u16
 352 nouveau_bios_rd16(struct nouveau_object *object, u32 addr)
 353 {
 354         struct nouveau_bios *bios = (void *)object;
 355         return get_unaligned_le16(&bios->data[addr]);
 356 }
 357
 358 static u32
 359 nouveau_bios_rd32(struct nouveau_object *object, u32 addr)
 360 {
 361         struct nouveau_bios *bios = (void *)object;
 362         return get_unaligned_le32(&bios->data[addr]);
 363 }
 364
 365 static void
 366 nouveau_bios_wr08(struct nouveau_object *object, u32 addr, u8 data)
 367 {
 368         struct nouveau_bios *bios = (void *)object;
 369         bios->data[addr] = data;
 370 }
 371
 372 static void
 373 nouveau_bios_wr16(struct nouveau_object *object, u32 addr, u16 data)
 374 {
 375         struct nouveau_bios *bios = (void *)object;
 376         put_unaligned_le16(data, &bios->data[addr]);
 377 }
 378
 379 static void
 380 nouveau_bios_wr32(struct nouveau_object *object, u32 addr, u32 data)
 381 {
 382         struct nouveau_bios *bios = (void *)object;
 383         put_unaligned_le32(data, &bios->data[addr]);
 384 }
 385
 386 static int
 387 nouveau_bios_ctor(struct nouveau_object *parent,
 388                   struct nouveau_object *engine,
 389                   struct nouveau_oclass *oclass, void *data, u32 size,
 390                   struct nouveau_object **pobject)
 391 {
 392         struct nouveau_bios *bios;
 393         struct bit_entry bit_i;
 394         int ret;
 395
 396         ret = nouveau_subdev_create(parent, engine, oclass, 0,
 397                                     "VBIOS", "bios", &bios);
 398         *pobject = nv_object(bios);
 399         if (ret)
 400                 return ret;
 401
 402         ret = nouveau_bios_shadow(bios);
 403         if (ret)
 404                 return ret;
 405
 406         /* detect type of vbios we're dealing with */
 407         bios->bmp_offset = nvbios_findstr(bios->data, bios->size,
 408                                           "\xff\x7f""NV\0", 5);
 409         if (bios->bmp_offset) {
 410                 nv_info(bios, "BMP version %x.%x\n",
 411                         bmp_version(bios) >> 8,
 412                         bmp_version(bios) & 0xff);
 413         }
 414
 415         bios->bit_offset = nvbios_findstr(bios->data, bios->size,
 416                                           "\xff\xb8""BIT", 5);
 417         if (bios->bit_offset)
 418                 nv_info(bios, "BIT signature found\n");
 419
 420         /* determine the vbios version number */
 421         if (!bit_entry(bios, 'i', &bit_i) && bit_i.length >= 4) {
 422                 bios->version.major = nv_ro08(bios, bit_i.offset + 3);
 423                 bios->version.chip  = nv_ro08(bios, bit_i.offset + 2);
 424                 bios->version.minor = nv_ro08(bios, bit_i.offset + 1);
 425                 bios->version.micro = nv_ro08(bios, bit_i.offset + 0);
 426         } else
 427         if (bmp_version(bios)) {
 428                 bios->version.major = nv_ro08(bios, bios->bmp_offset + 13);
 429                 bios->version.chip  = nv_ro08(bios, bios->bmp_offset + 12);
 430                 bios->version.minor = nv_ro08(bios, bios->bmp_offset + 11);
 431                 bios->version.micro = nv_ro08(bios, bios->bmp_offset + 10);
 432         }
 433
 434         nv_info(bios, "version %02x.%02x.%02x.%02x\n",
 435                 bios->version.major, bios->version.chip,
 436                 bios->version.minor, bios->version.micro);
 437
 438         return 0;
 439 }
 440
 441 static void
 442 nouveau_bios_dtor(struct nouveau_object *object)
 443 {
 444         struct nouveau_bios *bios = (void *)object;
 445         kfree(bios->data);
 446         nouveau_subdev_destroy(&bios->base);
 447 }
 448
 449 static int
 450 nouveau_bios_init(struct nouveau_object *object)
 451 {
 452         struct nouveau_bios *bios = (void *)object;
 453         return nouveau_subdev_init(&bios->base);
 454 }
 455
 456 static int
 457 nouveau_bios_fini(struct nouveau_object *object, bool suspend)
 458 {
 459         struct nouveau_bios *bios = (void *)object;
 460         return nouveau_subdev_fini(&bios->base, suspend);
 461 }
 462
 463 struct nouveau_oclass
 464 nouveau_bios_oclass = {
 465         .handle = NV_SUBDEV(VBIOS, 0x00),
 466         .ofuncs = &(struct nouveau_ofuncs) {
 467                 .ctor = nouveau_bios_ctor,
 468                 .dtor = nouveau_bios_dtor,
 469                 .init = nouveau_bios_init,
 470                 .fini = nouveau_bios_fini,
 471                 .rd08 = nouveau_bios_rd08,
 472                 .rd16 = nouveau_bios_rd16,
 473                 .rd32 = nouveau_bios_rd32,
 474                 .wr08 = nouveau_bios_wr08,
 475                 .wr16 = nouveau_bios_wr16,
 476                 .wr32 = nouveau_bios_wr32,
 477         },
 478 };