src/devices/oprom/yabel/device.c

   1 /******************************************************************************
   2  * Copyright (c) 2004, 2008 IBM Corporation
   3  * Copyright (c) 2008, 2009 Pattrick Hueper <phueper@hueper.net>
   4  * All rights reserved.
   5  * This program and the accompanying materials
   6  * are made available under the terms of the BSD License
   7  * which accompanies this distribution, and is available at
   8  * http://www.opensource.org/licenses/bsd-license.php
   9  *
  10  * Contributors:
  11  *     IBM Corporation - initial implementation
  12  *****************************************************************************/
  13
  14
  15 #include "device.h"
  16 #include "compat/rtas.h"
  17 #include <string.h>
  18 #include "debug.h"
  19
  20 #include <device/device.h>
  21 #include <device/pci.h>
  22 #include <device/pci_ops.h>
  23 #include <device/resource.h>
  24
  25 /* the device we are working with... */
  26 biosemu_device_t bios_device;
  27 //max. 6 BARs and 1 Exp.ROM plus CfgSpace and 3 legacy ranges, plus 2 "special" memory ranges
  28 translate_address_t translate_address_array[13];
  29 u8 taa_last_entry;
  30
  31 typedef struct {
  32         u8 info;
  33         u8 bus;
  34         u8 devfn;
  35         u8 cfg_space_offset;
  36         u64 address;
  37         u64 size;
  38 } __attribute__ ((__packed__)) assigned_address_t;
  39
  40 #if CONFIG_PCI_OPTION_ROM_RUN_YABEL
  41 /* coreboot version */
  42
  43 static void
  44 biosemu_dev_get_addr_info(void)
  45 {
  46         int taa_index = 0;
  47         struct resource *r;
  48         u8 bus = bios_device.dev->bus->secondary;
  49         u16 devfn = bios_device.dev->path.pci.devfn;
  50
  51         bios_device.bus =  bus;
  52         bios_device.devfn = devfn;
  53
  54         DEBUG_PRINTF("bus: %x, devfn: %x\n", bus, devfn);
  55         for (r = bios_device.dev->resource_list; r; r = r->next) {
  56                 translate_address_array[taa_index].info = r->flags;
  57                 translate_address_array[taa_index].bus = bus;
  58                 translate_address_array[taa_index].devfn = devfn;
  59                 translate_address_array[taa_index].cfg_space_offset =
  60                     r->index;
  61                 translate_address_array[taa_index].address = r->base;
  62                 translate_address_array[taa_index].size = r->size;
  63                 /* dont translate addresses... all addresses are 1:1 */
  64                 translate_address_array[taa_index].address_offset = 0;
  65                 taa_index++;
  66         }
  67         /* Expansion ROM */
  68         translate_address_array[taa_index].info = IORESOURCE_MEM | IORESOURCE_READONLY;
  69         translate_address_array[taa_index].bus = bus;
  70         translate_address_array[taa_index].devfn = devfn;
  71         translate_address_array[taa_index].cfg_space_offset = 0x30;
  72         translate_address_array[taa_index].address = bios_device.img_addr;
  73         translate_address_array[taa_index].size = 0; /* TODO: do we need the size? */
  74         /* dont translate addresses... all addresses are 1:1 */
  75         translate_address_array[taa_index].address_offset = 0;
  76         taa_index++;
  77         /* legacy ranges if its a VGA card... */
  78         if ((bios_device.dev->class & 0xFF0000) == 0x030000) {
  79                 DEBUG_PRINTF("%s: VGA device found, adding legacy resources... \n", __func__);
  80                 /* I/O 0x3B0-0x3BB */
  81                 translate_address_array[taa_index].info = IORESOURCE_FIXED | IORESOURCE_IO;
  82                 translate_address_array[taa_index].bus = bus;
  83                 translate_address_array[taa_index].devfn = devfn;
  84                 translate_address_array[taa_index].cfg_space_offset = 0;
  85                 translate_address_array[taa_index].address = 0x3b0;
  86                 translate_address_array[taa_index].size = 0xc;
  87                 /* dont translate addresses... all addresses are 1:1 */
  88                 translate_address_array[taa_index].address_offset = 0;
  89                 taa_index++;
  90                 /* I/O 0x3C0-0x3DF */
  91                 translate_address_array[taa_index].info = IORESOURCE_FIXED | IORESOURCE_IO;
  92                 translate_address_array[taa_index].bus = bus;
  93                 translate_address_array[taa_index].devfn = devfn;
  94                 translate_address_array[taa_index].cfg_space_offset = 0;
  95                 translate_address_array[taa_index].address = 0x3c0;
  96                 translate_address_array[taa_index].size = 0x20;
  97                 /* dont translate addresses... all addresses are 1:1 */
  98                 translate_address_array[taa_index].address_offset = 0;
  99                 taa_index++;
 100                 /* Mem 0xA0000-0xBFFFF */
 101                 translate_address_array[taa_index].info = IORESOURCE_FIXED | IORESOURCE_MEM;
 102                 translate_address_array[taa_index].bus = bus;
 103                 translate_address_array[taa_index].devfn = devfn;
 104                 translate_address_array[taa_index].cfg_space_offset = 0;
 105                 translate_address_array[taa_index].address = 0xa0000;
 106                 translate_address_array[taa_index].size = 0x20000;
 107                 /* dont translate addresses... all addresses are 1:1 */
 108                 translate_address_array[taa_index].address_offset = 0;
 109                 taa_index++;
 110         }
 111         // store last entry index of translate_address_array
 112         taa_last_entry = taa_index - 1;
 113 #if CONFIG_X86EMU_DEBUG
 114         //dump translate_address_array
 115         printf("translate_address_array: \n");
 116         translate_address_t ta;
 117         int i;
 118         for (i = 0; i <= taa_last_entry; i++) {
 119                 ta = translate_address_array[i];
 120                 printf
 121                     ("%d: info: %08lx bus: %02x devfn: %02x cfg_space_offset: %02x\n\taddr: %016llx\n\toffs: %016llx\n\tsize: %016llx\n",
 122                      i, ta.info, ta.bus, ta.devfn, ta.cfg_space_offset,
 123                      ta.address, ta.address_offset, ta.size);
 124         }
 125 #endif
 126 }
 127 #else
 128 // use translate_address_dev and get_puid from net-snk's net_support.c
 129 void translate_address_dev(u64 *, phandle_t);
 130 u64 get_puid(phandle_t node);
 131
 132
 133 // scan all adresses assigned to the device ("assigned-addresses" and "reg")
 134 // store in translate_address_array for faster translation using dev_translate_address
 135 void
 136 biosemu_dev_get_addr_info(void)
 137 {
 138         // get bus/dev/fn from assigned-addresses
 139         int32_t len;
 140         //max. 6 BARs and 1 Exp.ROM plus CfgSpace and 3 legacy ranges
 141         assigned_address_t buf[11];
 142         len =
 143             of_getprop(bios_device.phandle, "assigned-addresses", buf,
 144                        sizeof(buf));
 145         bios_device.bus = buf[0].bus;
 146         bios_device.devfn = buf[0].devfn;
 147         DEBUG_PRINTF("bus: %x, devfn: %x\n", bios_device.bus,
 148                      bios_device.devfn);
 149         //store address translations for all assigned-addresses and regs in
 150         //translate_address_array for faster translation later on...
 151         int i = 0;
 152         // index to insert data into translate_address_array
 153         int taa_index = 0;
 154         u64 address_offset;
 155         for (i = 0; i < (len / sizeof(assigned_address_t)); i++, taa_index++) {
 156                 //copy all info stored in assigned-addresses
 157                 translate_address_array[taa_index].info = buf[i].info;
 158                 translate_address_array[taa_index].bus = buf[i].bus;
 159                 translate_address_array[taa_index].devfn = buf[i].devfn;
 160                 translate_address_array[taa_index].cfg_space_offset =
 161                     buf[i].cfg_space_offset;
 162                 translate_address_array[taa_index].address = buf[i].address;
 163                 translate_address_array[taa_index].size = buf[i].size;
 164                 // translate first address and store it as address_offset
 165                 address_offset = buf[i].address;
 166                 translate_address_dev(&address_offset, bios_device.phandle);
 167                 translate_address_array[taa_index].address_offset =
 168                     address_offset - buf[i].address;
 169         }
 170         //get "reg" property
 171         len = of_getprop(bios_device.phandle, "reg", buf, sizeof(buf));
 172         for (i = 0; i < (len / sizeof(assigned_address_t)); i++) {
 173                 if ((buf[i].size == 0) || (buf[i].cfg_space_offset != 0)) {
 174                         // we dont care for ranges with size 0 and
 175                         // BARs and Expansion ROM must be in assigned-addresses... so in reg
 176                         // we only look for those without config space offset set...
 177                         // i.e. the legacy ranges
 178                         continue;
 179                 }
 180                 //copy all info stored in assigned-addresses
 181                 translate_address_array[taa_index].info = buf[i].info;
 182                 translate_address_array[taa_index].bus = buf[i].bus;
 183                 translate_address_array[taa_index].devfn = buf[i].devfn;
 184                 translate_address_array[taa_index].cfg_space_offset =
 185                     buf[i].cfg_space_offset;
 186                 translate_address_array[taa_index].address = buf[i].address;
 187                 translate_address_array[taa_index].size = buf[i].size;
 188                 // translate first address and store it as address_offset
 189                 address_offset = buf[i].address;
 190                 translate_address_dev(&address_offset, bios_device.phandle);
 191                 translate_address_array[taa_index].address_offset =
 192                     address_offset - buf[i].address;
 193                 taa_index++;
 194         }
 195         // store last entry index of translate_address_array
 196         taa_last_entry = taa_index - 1;
 197 #if CONFIG_X86EMU_DEBUG
 198         //dump translate_address_array
 199         printf("translate_address_array: \n");
 200         translate_address_t ta;
 201         for (i = 0; i <= taa_last_entry; i++) {
 202                 ta = translate_address_array[i];
 203                 printf
 204                     ("%d: %02x%02x%02x%02x\n\taddr: %016llx\n\toffs: %016llx\n\tsize: %016llx\n",
 205                      i, ta.info, ta.bus, ta.devfn, ta.cfg_space_offset,
 206                      ta.address, ta.address_offset, ta.size);
 207         }
 208 #endif
 209 }
 210 #endif
 211
 212 // "special memory" is a hack to make some parts of memory fall through to real memory
 213 // (ie. no translation). Necessary if option ROMs attempt DMA there, map registers or
 214 // do similarily crazy things.
 215 void
 216 biosemu_add_special_memory(u32 start, u32 size)
 217 {
 218         int taa_index = ++taa_last_entry;
 219         translate_address_array[taa_index].info = IORESOURCE_FIXED | IORESOURCE_MEM;
 220         translate_address_array[taa_index].bus = 0;
 221         translate_address_array[taa_index].devfn = 0;
 222         translate_address_array[taa_index].cfg_space_offset = 0;
 223         translate_address_array[taa_index].address = start;
 224         translate_address_array[taa_index].size = size;
 225         /* dont translate addresses... all addresses are 1:1 */
 226         translate_address_array[taa_index].address_offset = 0;
 227 }
 228
 229 #if !CONFIG_PCI_OPTION_ROM_RUN_YABEL
 230 // to simulate accesses to legacy VGA Memory (0xA0000-0xBFFFF)
 231 // we look for the first prefetchable memory BAR, if no prefetchable BAR found,
 232 // we use the first memory BAR
 233 // dev_translate_addr will translate accesses to the legacy VGA Memory into the found vmem BAR
 234 static void
 235 biosemu_dev_find_vmem_addr(void)
 236 {
 237         int i = 0;
 238         translate_address_t ta;
 239         s8 tai_np = -1, tai_p = -1;     // translate_address_array index for non-prefetchable and prefetchable memory
 240         //search backwards to find first entry
 241         for (i = taa_last_entry; i >= 0; i--) {
 242                 ta = translate_address_array[i];
 243                 if ((ta.cfg_space_offset >= 0x10)
 244                     && (ta.cfg_space_offset <= 0x24)) {
 245                         //only BARs
 246                         if ((ta.info & 0x03) >= 0x02) {
 247                                 //32/64bit memory
 248                                 tai_np = i;
 249                                 if ((ta.info & 0x40) != 0) {
 250                                         // prefetchable
 251                                         tai_p = i;
 252                                 }
 253                         }
 254                 }
 255         }
 256         if (tai_p != -1) {
 257                 ta = translate_address_array[tai_p];
 258                 bios_device.vmem_addr = ta.address;
 259                 bios_device.vmem_size = ta.size;
 260                 DEBUG_PRINTF
 261                     ("%s: Found prefetchable Virtual Legacy Memory BAR: %llx, size: %llx\n",
 262                      __func__, bios_device.vmem_addr,
 263                      bios_device.vmem_size);
 264         } else if (tai_np != -1) {
 265                 ta = translate_address_array[tai_np];
 266                 bios_device.vmem_addr = ta.address;
 267                 bios_device.vmem_size = ta.size;
 268                 DEBUG_PRINTF
 269                     ("%s: Found non-prefetchable Virtual Legacy Memory BAR: %llx, size: %llx",
 270                      __func__, bios_device.vmem_addr,
 271                      bios_device.vmem_size);
 272         }
 273         // disable vmem
 274         //bios_device.vmem_size = 0;
 275 }
 276
 277 void
 278 biosemu_dev_get_puid(void)
 279 {
 280         // get puid
 281         bios_device.puid = get_puid(bios_device.phandle);
 282         DEBUG_PRINTF("puid: 0x%llx\n", bios_device.puid);
 283 }
 284 #endif
 285
 286 static void
 287 biosemu_dev_get_device_vendor_id(void)
 288 {
 289
 290         u32 pci_config_0;
 291 #if CONFIG_PCI_OPTION_ROM_RUN_YABEL
 292         pci_config_0 = pci_read_config32(bios_device.dev, 0x0);
 293 #else
 294         pci_config_0 =
 295             rtas_pci_config_read(bios_device.puid, 4, bios_device.bus,
 296                                  bios_device.devfn, 0x0);
 297 #endif
 298         bios_device.pci_device_id =
 299             (u16) ((pci_config_0 & 0xFFFF0000) >> 16);
 300         bios_device.pci_vendor_id = (u16) (pci_config_0 & 0x0000FFFF);
 301         DEBUG_PRINTF("PCI Device ID: %04x, PCI Vendor ID: %x\n",
 302                      bios_device.pci_device_id, bios_device.pci_vendor_id);
 303 }
 304
 305 /* Check whether the device has a valid Expansion ROM and search the PCI Data
 306  * Structure and any Expansion ROM Header (using dev_scan_exp_header()) for
 307  * needed information.  If the rom_addr parameter is != 0, it is the address of
 308  * the Expansion ROM image and will be used, if it is == 0, the Expansion ROM
 309  * BAR address will be used.
 310  */
 311 u8
 312 biosemu_dev_check_exprom(unsigned long rom_base_addr)
 313 {
 314         int i = 0;
 315         translate_address_t ta;
 316         u16 pci_ds_offset;
 317         pci_data_struct_t pci_ds;
 318         if (rom_base_addr == 0) {
 319                 // check for ExpROM Address (Offset 30) in taa
 320                 for (i = 0; i <= taa_last_entry; i++) {
 321                         ta = translate_address_array[i];
 322                         if (ta.cfg_space_offset == 0x30) {
 323                                 //translated address
 324                                 rom_base_addr = ta.address + ta.address_offset;
 325                                 break;
 326                         }
 327                 }
 328         }
 329         /* In the ROM there could be multiple Expansion ROM Images... start
 330          * searching them for an x86 image.
 331          */
 332         do {
 333                 if (rom_base_addr == 0) {
 334                         printf("Error: no Expansion ROM address found!\n");
 335                         return -1;
 336                 }
 337                 set_ci();
 338                 u16 rom_signature = in16le((void *) rom_base_addr);
 339                 clr_ci();
 340                 if (rom_signature != 0xaa55) {
 341                         printf
 342                             ("Error: invalid Expansion ROM signature: %02x!\n",
 343                              *((u16 *) rom_base_addr));
 344                         return -1;
 345                 }
 346                 set_ci();
 347                 // at offset 0x18 is the (16bit little-endian) pointer to the PCI Data Structure
 348                 pci_ds_offset = in16le((void *) (rom_base_addr + 0x18));
 349                 //copy the PCI Data Structure
 350                 memcpy(&pci_ds, (void *) (rom_base_addr + pci_ds_offset),
 351                        sizeof(pci_ds));
 352                 clr_ci();
 353 #if CONFIG_X86EMU_DEBUG
 354                 DEBUG_PRINTF("PCI Data Structure @%lx:\n",
 355                              rom_base_addr + pci_ds_offset);
 356                 dump((void *) &pci_ds, sizeof(pci_ds));
 357 #endif
 358                 if (strncmp((const char *) pci_ds.signature, "PCIR", 4) != 0) {
 359                         printf("Invalid PCI Data Structure found!\n");
 360                         break;
 361                 }
 362                 //little-endian conversion
 363                 pci_ds.vendor_id = in16le(&pci_ds.vendor_id);
 364                 pci_ds.device_id = in16le(&pci_ds.device_id);
 365                 pci_ds.img_length = in16le(&pci_ds.img_length);
 366                 pci_ds.pci_ds_length = in16le(&pci_ds.pci_ds_length);
 367                 if (pci_ds.vendor_id != bios_device.pci_vendor_id) {
 368                         printf
 369                             ("Image has invalid Vendor ID: %04x, expected: %04x\n",
 370                              pci_ds.vendor_id, bios_device.pci_vendor_id);
 371                         break;
 372                 }
 373                 if (pci_ds.device_id != bios_device.pci_device_id) {
 374                         printf
 375                             ("Image has invalid Device ID: %04x, expected: %04x\n",
 376                              pci_ds.device_id, bios_device.pci_device_id);
 377                         break;
 378                 }
 379                 DEBUG_PRINTF("Image Length: %d\n", pci_ds.img_length * 512);
 380                 DEBUG_PRINTF("Image Code Type: %d\n", pci_ds.code_type);
 381                 if (pci_ds.code_type == 0) {
 382                         //x86 image
 383                         //store image address and image length in bios_device struct
 384                         bios_device.img_addr = rom_base_addr;
 385                         bios_device.img_size = pci_ds.img_length * 512;
 386                         // we found the image, exit the loop
 387                         break;
 388                 } else {
 389                         // no x86 image, check next image (if any)
 390                         rom_base_addr += pci_ds.img_length * 512;
 391                 }
 392                 if ((pci_ds.indicator & 0x80) == 0x80) {
 393                         //last image found, exit the loop
 394                         DEBUG_PRINTF("Last PCI Expansion ROM Image found.\n");
 395                         break;
 396                 }
 397         }
 398         while (bios_device.img_addr == 0);
 399         // in case we did not find a valid x86 Expansion ROM Image
 400         if (bios_device.img_addr == 0) {
 401                 printf("Error: no valid x86 Expansion ROM Image found!\n");
 402                 return -1;
 403         }
 404         return 0;
 405 }
 406
 407 u8
 408 biosemu_dev_init(struct device * device)
 409 {
 410         u8 rval = 0;
 411         //init bios_device struct
 412         DEBUG_PRINTF("%s\n", __func__);
 413         memset(&bios_device, 0, sizeof(bios_device));
 414
 415 #if !CONFIG_PCI_OPTION_ROM_RUN_YABEL
 416         bios_device.ihandle = of_open(device_name);
 417         if (bios_device.ihandle == 0) {
 418                 DEBUG_PRINTF("%s is no valid device!\n", device_name);
 419                 return -1;
 420         }
 421         bios_device.phandle = of_finddevice(device_name);
 422 #else
 423         bios_device.dev = device;
 424 #endif
 425         biosemu_dev_get_addr_info();
 426 #if !CONFIG_PCI_OPTION_ROM_RUN_YABEL
 427         biosemu_dev_find_vmem_addr();
 428         biosemu_dev_get_puid();
 429 #endif
 430         biosemu_dev_get_device_vendor_id();
 431         return rval;
 432 }
 433
 434 // translate address function using translate_address_array assembled
 435 // by dev_get_addr_info... MUCH faster than calling translate_address_dev
 436 // and accessing client interface for every translation...
 437 // returns: 0 if addr not found in translate_address_array, 1 if found.
 438 u8
 439 biosemu_dev_translate_address(int type, unsigned long * addr)
 440 {
 441         int i = 0;
 442         translate_address_t ta;
 443 #if !CONFIG_PCI_OPTION_ROM_RUN_YABEL
 444         /* we dont need this hack for coreboot... we can access legacy areas */
 445         //check if it is an access to legacy VGA Mem... if it is, map the address
 446         //to the vmem BAR and then translate it...
 447         // (translation info provided by Ben Herrenschmidt)
 448         // NOTE: the translation seems to only work for NVIDIA cards... but it is needed
 449         // to make some NVIDIA cards work at all...
 450         if ((bios_device.vmem_size > 0)
 451             && ((*addr >= 0xA0000) && (*addr < 0xB8000))) {
 452                 *addr = (*addr - 0xA0000) * 4 + 2 + bios_device.vmem_addr;
 453         }
 454         if ((bios_device.vmem_size > 0)
 455             && ((*addr >= 0xB8000) && (*addr < 0xC0000))) {
 456                 u8 shift = *addr & 1;
 457                 *addr &= 0xfffffffe;
 458                 *addr = (*addr - 0xB8000) * 4 + shift + bios_device.vmem_addr;
 459         }
 460 #endif
 461         for (i = 0; i <= taa_last_entry; i++) {
 462                 ta = translate_address_array[i];
 463                 if ((*addr >= ta.address) && (*addr <= (ta.address + ta.size)) && (ta.info & type)) {
 464                         *addr += ta.address_offset;
 465                         return 1;
 466                 }
 467         }
 468         return 0;
 469 }