2 * Copyright 2012 Red Hat Inc.
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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.
25 #include <core/object.h>
26 #include <core/device.h>
27 #include <core/subdev.h>
28 #include <core/option.h>
30 #include <subdev/bios.h>
31 #include <subdev/bios/bmp.h>
32 #include <subdev/bios/bit.h>
35 nvbios_checksum(const u8 *data, int size)
44 nvbios_findstr(const u8 *data, int size, const char *str, int len)
48 for (i = 0; i <= (size - len); i++) {
49 for (j = 0; j < len; j++)
50 if ((char)data[i + j] != str[j])
59 #if defined(__powerpc__)
61 nouveau_bios_shadow_of(struct nouveau_bios *bios)
63 struct pci_dev *pdev = nv_device(bios)->pdev;
64 struct device_node *dn;
68 dn = pci_device_to_OF_node(pdev);
70 nv_info(bios, "Unable to get the OF node\n");
74 data = of_get_property(dn, "NVDA,BMP", &size);
77 bios->data = kmalloc(bios->size, GFP_KERNEL);
79 memcpy(bios->data, data, size);
85 nouveau_bios_shadow_pramin(struct nouveau_bios *bios)
87 struct nouveau_device *device = nv_device(bios);
92 if (device->card_type >= NV_50) {
93 if ( device->card_type < NV_C0 ||
94 !(nv_rd32(bios, 0x022500) & 0x00000001))
95 addr = (u64)(nv_rd32(bios, 0x619f04) & 0xffffff00) << 8;
98 addr = (u64)nv_rd32(bios, 0x001700) << 16;
102 bar0 = nv_mask(bios, 0x001700, 0xffffffff, addr >> 16);
105 /* bail if no rom signature */
106 if (nv_rd08(bios, 0x700000) != 0x55 ||
107 nv_rd08(bios, 0x700001) != 0xaa)
110 bios->size = nv_rd08(bios, 0x700002) * 512;
114 bios->data = kmalloc(bios->size, GFP_KERNEL);
116 for (i = 0; i < bios->size; i++)
117 nv_wo08(bios, i, nv_rd08(bios, 0x700000 + i));
121 if (device->card_type >= NV_50)
122 nv_wr32(bios, 0x001700, bar0);
126 nouveau_bios_shadow_prom(struct nouveau_bios *bios)
128 struct nouveau_device *device = nv_device(bios);
133 /* there is no prom on nv4x IGP's */
134 if (device->card_type == NV_40 && device->chipset >= 0x4c)
137 /* enable access to rom */
138 if (device->card_type >= NV_50)
142 access = nv_mask(bios, pcireg, 0x00000001, 0x00000000);
144 /* bail if no rom signature, with a workaround for a PROM reading
145 * issue on some chipsets. the first read after a period of
146 * inactivity returns the wrong result, so retry the first header
147 * byte a few times before giving up as a workaround
151 if (nv_rd08(bios, 0x300000) == 0x55)
155 if (!i || nv_rd08(bios, 0x300001) != 0xaa)
158 /* additional check (see note below) - read PCI record header */
159 pcir = nv_rd08(bios, 0x300018) |
160 nv_rd08(bios, 0x300019) << 8;
161 if (nv_rd08(bios, 0x300000 + pcir) != 'P' ||
162 nv_rd08(bios, 0x300001 + pcir) != 'C' ||
163 nv_rd08(bios, 0x300002 + pcir) != 'I' ||
164 nv_rd08(bios, 0x300003 + pcir) != 'R')
167 /* read entire bios image to system memory */
168 bios->size = nv_rd08(bios, 0x300002) * 512;
172 bios->data = kmalloc(bios->size, GFP_KERNEL);
174 for (i = 0; i < bios->size; i++)
175 nv_wo08(bios, i, nv_rd08(bios, 0x300000 + i));
179 /* disable access to rom */
180 nv_wr32(bios, pcireg, access);
183 #if defined(CONFIG_ACPI) && defined(CONFIG_X86)
184 int nouveau_acpi_get_bios_chunk(uint8_t *bios, int offset, int len);
185 bool nouveau_acpi_rom_supported(struct pci_dev *pdev);
188 nouveau_acpi_rom_supported(struct pci_dev *pdev) {
193 nouveau_acpi_get_bios_chunk(uint8_t *bios, int offset, int len) {
199 nouveau_bios_shadow_acpi(struct nouveau_bios *bios)
201 struct pci_dev *pdev = nv_device(bios)->pdev;
204 if (!nouveau_acpi_rom_supported(pdev)) {
210 bios->data = kmalloc(4096, GFP_KERNEL);
212 if (nouveau_acpi_get_bios_chunk(bios->data, 0, 4096) == 4096)
213 bios->size = bios->data[2] * 512;
220 bios->data = kmalloc(bios->size, GFP_KERNEL);
222 /* disobey the acpi spec - much faster on at least w530 ... */
223 ret = nouveau_acpi_get_bios_chunk(bios->data, 0, bios->size);
224 if (ret != bios->size ||
225 nvbios_checksum(bios->data, bios->size)) {
226 /* ... that didn't work, ok, i'll be good now */
227 for (i = 0; i < bios->size; i += cnt) {
228 cnt = min((bios->size - i), (u32)4096);
229 ret = nouveau_acpi_get_bios_chunk(bios->data, i, cnt);
238 nouveau_bios_shadow_pci(struct nouveau_bios *bios)
240 struct pci_dev *pdev = nv_device(bios)->pdev;
243 if (!pci_enable_rom(pdev)) {
244 void __iomem *rom = pci_map_rom(pdev, &size);
246 bios->data = kmalloc(size, GFP_KERNEL);
248 memcpy_fromio(bios->data, rom, size);
253 pci_unmap_rom(pdev, rom);
255 pci_disable_rom(pdev);
260 nouveau_bios_shadow_platform(struct nouveau_bios *bios)
262 struct pci_dev *pdev = nv_device(bios)->pdev;
265 void __iomem *rom = pci_platform_rom(pdev, &size);
267 bios->data = kmalloc(size, GFP_KERNEL);
269 memcpy_fromio(bios->data, rom, size);
276 nouveau_bios_score(struct nouveau_bios *bios, const bool writeable)
278 if (bios->size < 3 || !bios->data || bios->data[0] != 0x55 ||
279 bios->data[1] != 0xAA) {
280 nv_info(bios, "... signature not found\n");
284 if (nvbios_checksum(bios->data,
285 min_t(u32, bios->data[2] * 512, bios->size))) {
286 nv_info(bios, "... checksum invalid\n");
287 /* if a ro image is somewhat bad, it's probably all rubbish */
288 return writeable ? 2 : 1;
291 nv_info(bios, "... appears to be valid\n");
297 void (*shadow)(struct nouveau_bios *);
305 nouveau_bios_shadow(struct nouveau_bios *bios)
307 struct methods shadow_methods[] = {
308 #if defined(__powerpc__)
309 { "OpenFirmware", nouveau_bios_shadow_of, true, 0, 0, NULL },
311 { "PRAMIN", nouveau_bios_shadow_pramin, true, 0, 0, NULL },
312 { "PROM", nouveau_bios_shadow_prom, false, 0, 0, NULL },
313 { "ACPI", nouveau_bios_shadow_acpi, true, 0, 0, NULL },
314 { "PCIROM", nouveau_bios_shadow_pci, true, 0, 0, NULL },
315 { "PLATFORM", nouveau_bios_shadow_platform, true, 0, 0, NULL },
318 struct methods *mthd, *best;
319 const struct firmware *fw;
324 optarg = nouveau_stropt(nv_device(bios)->cfgopt, "NvBios", &optlen);
325 source = optarg ? kstrndup(optarg, optlen, GFP_KERNEL) : NULL;
327 /* try to match one of the built-in methods */
328 mthd = shadow_methods;
330 if (strcasecmp(source, mthd->desc))
332 nv_info(bios, "source: %s\n", mthd->desc);
335 mthd->score = nouveau_bios_score(bios, mthd->rw);
340 } while ((++mthd)->shadow);
342 /* attempt to load firmware image */
343 ret = request_firmware(&fw, source, &nv_device(bios)->pdev->dev);
345 bios->size = fw->size;
346 bios->data = kmemdup(fw->data, fw->size, GFP_KERNEL);
347 release_firmware(fw);
349 nv_info(bios, "image: %s\n", source);
350 if (nouveau_bios_score(bios, 1)) {
359 nv_error(bios, "source \'%s\' invalid\n", source);
363 mthd = shadow_methods;
365 nv_info(bios, "checking %s for image...\n", mthd->desc);
367 mthd->score = nouveau_bios_score(bios, mthd->rw);
368 mthd->size = bios->size;
369 mthd->data = bios->data;
371 } while (mthd->score != 3 && (++mthd)->shadow);
373 mthd = shadow_methods;
376 if (mthd->score > best->score) {
380 } while ((++mthd)->shadow);
383 nv_info(bios, "using image from %s\n", best->desc);
384 bios->size = best->size;
385 bios->data = best->data;
389 nv_error(bios, "unable to locate usable image\n");
394 nouveau_bios_rd08(struct nouveau_object *object, u64 addr)
396 struct nouveau_bios *bios = (void *)object;
397 return bios->data[addr];
401 nouveau_bios_rd16(struct nouveau_object *object, u64 addr)
403 struct nouveau_bios *bios = (void *)object;
404 return get_unaligned_le16(&bios->data[addr]);
408 nouveau_bios_rd32(struct nouveau_object *object, u64 addr)
410 struct nouveau_bios *bios = (void *)object;
411 return get_unaligned_le32(&bios->data[addr]);
415 nouveau_bios_wr08(struct nouveau_object *object, u64 addr, u8 data)
417 struct nouveau_bios *bios = (void *)object;
418 bios->data[addr] = data;
422 nouveau_bios_wr16(struct nouveau_object *object, u64 addr, u16 data)
424 struct nouveau_bios *bios = (void *)object;
425 put_unaligned_le16(data, &bios->data[addr]);
429 nouveau_bios_wr32(struct nouveau_object *object, u64 addr, u32 data)
431 struct nouveau_bios *bios = (void *)object;
432 put_unaligned_le32(data, &bios->data[addr]);
436 nouveau_bios_ctor(struct nouveau_object *parent,
437 struct nouveau_object *engine,
438 struct nouveau_oclass *oclass, void *data, u32 size,
439 struct nouveau_object **pobject)
441 struct nouveau_bios *bios;
442 struct bit_entry bit_i;
445 ret = nouveau_subdev_create(parent, engine, oclass, 0,
446 "VBIOS", "bios", &bios);
447 *pobject = nv_object(bios);
451 ret = nouveau_bios_shadow(bios);
455 /* detect type of vbios we're dealing with */
456 bios->bmp_offset = nvbios_findstr(bios->data, bios->size,
457 "\xff\x7f""NV\0", 5);
458 if (bios->bmp_offset) {
459 nv_info(bios, "BMP version %x.%x\n",
460 bmp_version(bios) >> 8,
461 bmp_version(bios) & 0xff);
464 bios->bit_offset = nvbios_findstr(bios->data, bios->size,
466 if (bios->bit_offset)
467 nv_info(bios, "BIT signature found\n");
469 /* determine the vbios version number */
470 if (!bit_entry(bios, 'i', &bit_i) && bit_i.length >= 4) {
471 bios->version.major = nv_ro08(bios, bit_i.offset + 3);
472 bios->version.chip = nv_ro08(bios, bit_i.offset + 2);
473 bios->version.minor = nv_ro08(bios, bit_i.offset + 1);
474 bios->version.micro = nv_ro08(bios, bit_i.offset + 0);
475 bios->version.patch = nv_ro08(bios, bit_i.offset + 4);
477 if (bmp_version(bios)) {
478 bios->version.major = nv_ro08(bios, bios->bmp_offset + 13);
479 bios->version.chip = nv_ro08(bios, bios->bmp_offset + 12);
480 bios->version.minor = nv_ro08(bios, bios->bmp_offset + 11);
481 bios->version.micro = nv_ro08(bios, bios->bmp_offset + 10);
484 nv_info(bios, "version %02x.%02x.%02x.%02x.%02x\n",
485 bios->version.major, bios->version.chip,
486 bios->version.minor, bios->version.micro, bios->version.patch);
492 nouveau_bios_dtor(struct nouveau_object *object)
494 struct nouveau_bios *bios = (void *)object;
496 nouveau_subdev_destroy(&bios->base);
500 nouveau_bios_init(struct nouveau_object *object)
502 struct nouveau_bios *bios = (void *)object;
503 return nouveau_subdev_init(&bios->base);
507 nouveau_bios_fini(struct nouveau_object *object, bool suspend)
509 struct nouveau_bios *bios = (void *)object;
510 return nouveau_subdev_fini(&bios->base, suspend);
513 struct nouveau_oclass
514 nouveau_bios_oclass = {
515 .handle = NV_SUBDEV(VBIOS, 0x00),
516 .ofuncs = &(struct nouveau_ofuncs) {
517 .ctor = nouveau_bios_ctor,
518 .dtor = nouveau_bios_dtor,
519 .init = nouveau_bios_init,
520 .fini = nouveau_bios_fini,
521 .rd08 = nouveau_bios_rd08,
522 .rd16 = nouveau_bios_rd16,
523 .rd32 = nouveau_bios_rd32,
524 .wr08 = nouveau_bios_wr08,
525 .wr16 = nouveau_bios_wr16,
526 .wr32 = nouveau_bios_wr32,