dev/pcidev.cc

   1 /*
   2  * Copyright (c) 2004-2005 The Regents of The University of Michigan
   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 are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /* @file
  30  * A single PCI device configuration space entry.
  31  */
  32
  33 #include <list>
  34 #include <sstream>
  35 #include <string>
  36 #include <vector>
  37
  38 #include "base/inifile.hh"
  39 #include "base/misc.hh"
  40 #include "base/str.hh"  // for to_number
  41 #include "base/trace.hh"
  42 #include "dev/pcidev.hh"
  43 #include "dev/pciconfigall.hh"
  44 #include "mem/bus/bus.hh"
  45 #include "mem/functional/memory_control.hh"
  46 #include "sim/builder.hh"
  47 #include "sim/param.hh"
  48 #include "sim/root.hh"
  49 #include "dev/tsunamireg.h"
  50
  51 using namespace std;
  52
  53 PciDev::PciDev(Params *p)
  54     : DmaDevice(p->name, p->plat), _params(p), plat(p->plat),
  55       configData(p->configData)
  56 {
  57     // copy the config data from the PciConfigData object
  58     if (configData) {
  59         memcpy(config.data, configData->config.data, sizeof(config.data));
  60         memcpy(BARSize, configData->BARSize, sizeof(BARSize));
  61         memcpy(BARAddrs, configData->BARAddrs, sizeof(BARAddrs));
  62     } else
  63         panic("NULL pointer to configuration data");
  64
  65     // Setup pointer in config space to point to this entry
  66     if (p->configSpace->deviceExists(p->deviceNum, p->functionNum))
  67         panic("Two PCI devices occuping same dev: %#x func: %#x",
  68               p->deviceNum, p->functionNum);
  69     else
  70         p->configSpace->registerDevice(p->deviceNum, p->functionNum, this);
  71 }
  72
  73 void
  74 PciDev::ReadConfig(int offset, int size, uint8_t *data)
  75 {
  76     union {
  77         uint8_t byte;
  78         uint16_t word;
  79         uint32_t dword;
  80     };
  81
  82     if (offset >= PCI_DEVICE_SPECIFIC)
  83         panic("Device specific PCI config space not implemented!\n");
  84
  85     dword = 0;
  86
  87     switch(size) {
  88       case sizeof(uint8_t):
  89         memcpy(&byte, &config.data[offset], size);
  90         *data = byte;
  91         break;
  92       case sizeof(uint16_t):
  93         memcpy(&byte, &config.data[offset], size);
  94         *(uint16_t*)data = htoa(word);
  95         break;
  96       case sizeof(uint32_t):
  97         memcpy(&byte, &config.data[offset], size);
  98         *(uint32_t*)data = htoa(dword);
  99         break;
 100       default:
 101         panic("Invalid PCI configuration read size!\n");
 102     }
 103
 104     DPRINTF(PCIDEV,
 105             "read device: %#x function: %#x register: %#x %d bytes: data: %#x\n",
 106             params()->deviceNum, params()->functionNum, offset, size,
 107             htoa(dword));
 108 }
 109
 110 void
 111 PciDev::WriteConfig(int offset, int size, uint32_t data)
 112 {
 113     if (offset >= PCI_DEVICE_SPECIFIC)
 114         panic("Device specific PCI config space not implemented!\n");
 115
 116     uint32_t barnum;
 117
 118     DPRINTF(PCIDEV,
 119             "write device: %#x function: %#x reg: %#x size: %d data: %#x\n",
 120             params()->deviceNum, params()->functionNum, offset, size,
 121             data);
 122
 123     barnum = (offset - PCI0_BASE_ADDR0) >> 2;
 124
 125     switch (size) {
 126       case sizeof(uint8_t): // 1-byte access
 127         uint8_t byte_value = data;
 128         switch (offset) {
 129           case PCI0_INTERRUPT_LINE:
 130           case PCI_CACHE_LINE_SIZE:
 131           case PCI_LATENCY_TIMER:
 132             *(uint8_t *)&config.data[offset] = htoa(byte_value);
 133             break;
 134           /* Do nothing for these read-only registers */
 135           case PCI0_INTERRUPT_PIN:
 136           case PCI0_MINIMUM_GRANT:
 137           case PCI0_MAXIMUM_LATENCY:
 138           case PCI_CLASS_CODE:
 139           case PCI_REVISION_ID:
 140             break;
 141           default:
 142             panic("writing to a read only register");
 143         }
 144         break;
 145
 146       case sizeof(uint16_t): // 2-byte access
 147         uint16_t half_value = data;
 148         switch (offset) {
 149           case PCI_COMMAND:
 150           case PCI_STATUS:
 151           case PCI_CACHE_LINE_SIZE:
 152             *(uint16_t *)&config.data[offset] = htoa(half_value);
 153             break;
 154
 155           default:
 156             panic("writing to a read only register");
 157         }
 158         break;
 159
 160       case sizeof(uint32_t): // 4-byte access
 161         uint32_t word_value = data;
 162         switch (offset) {
 163           case PCI0_BASE_ADDR0:
 164           case PCI0_BASE_ADDR1:
 165           case PCI0_BASE_ADDR2:
 166           case PCI0_BASE_ADDR3:
 167           case PCI0_BASE_ADDR4:
 168           case PCI0_BASE_ADDR5:
 169             // Writing 0xffffffff to a BAR tells the card to set the
 170             // value of the bar
 171             // to size of memory it needs
 172             if (word_value == 0xffffffff) {
 173                 // This is I/O Space, bottom two bits are read only
 174                 if (htoa(config.data[offset]) & 0x1) {
 175                     *(uint32_t *)&config.data[offset] = htoa(
 176                         (~(BARSize[barnum] - 1) & ~0x3) |
 177                         (htoa(config.data[offset]) & 0x3));
 178                 } else {
 179                     // This is memory space, bottom four bits are read only
 180                     *(uint32_t *)&config.data[offset] = htoa(
 181                         (~(BARSize[barnum] - 1) & ~0xF) |
 182                         (htoa(config.data[offset]) & 0xF));
 183                 }
 184             } else {
 185                 MemoryController *mmu = params()->mmu;
 186
 187                 // This is I/O Space, bottom two bits are read only
 188                 if(htoa(config.data[offset]) & 0x1) {
 189                     *(uint32_t *)&config.data[offset] =
 190                         htoa((word_value & ~0x3) |
 191                         (htoa(config.data[offset]) & 0x3));
 192
 193                     if (word_value &= ~0x1) {
 194                         Addr base_addr = (word_value & ~0x1) + TSUNAMI_PCI0_IO;
 195                         Addr base_size = BARSize[barnum];
 196
 197                         // It's never been set
 198                         if (BARAddrs[barnum] == 0)
 199                             mmu->add_child((FunctionalMemory *)this,
 200                                            RangeSize(base_addr, base_size));
 201                         else
 202                             mmu->update_child((FunctionalMemory *)this,
 203                                               RangeSize(BARAddrs[barnum],
 204                                                         base_size),
 205                                               RangeSize(base_addr, base_size));
 206
 207                         BARAddrs[barnum] = base_addr;
 208                     }
 209
 210                 } else {
 211                     // This is memory space, bottom four bits are read only
 212                     *(uint32_t *)&config.data[offset] =
 213                         htoa((word_value & ~0xF) |
 214                         (htoa(config.data[offset]) & 0xF));
 215
 216                     if (word_value & ~0x3) {
 217                         Addr base_addr = (word_value & ~0x3) +
 218                             TSUNAMI_PCI0_MEMORY;
 219
 220                         Addr base_size = BARSize[barnum];
 221
 222                         // It's never been set
 223                         if (BARAddrs[barnum] == 0)
 224                             mmu->add_child((FunctionalMemory *)this,
 225                                            RangeSize(base_addr, base_size));
 226                         else
 227                             mmu->update_child((FunctionalMemory *)this,
 228                                               RangeSize(BARAddrs[barnum],
 229                                                         base_size),
 230                                               RangeSize(base_addr, base_size));
 231
 232                         BARAddrs[barnum] = base_addr;
 233                     }
 234                  }
 235             }
 236             break;
 237
 238           case PCI0_ROM_BASE_ADDR:
 239             if (word_value == 0xfffffffe)
 240                 *(uint32_t *)&config.data[offset] = 0xffffffff;
 241             else
 242                 *(uint32_t *)&config.data[offset] = htoa(word_value);
 243             break;
 244
 245           case PCI_COMMAND:
 246             // This could also clear some of the error bits in the Status
 247             // register. However they should never get set, so lets ignore
 248             // it for now
 249             *(uint16_t *)&config.data[offset] = htoa(half_value);
 250             break;
 251
 252           default:
 253             DPRINTF(PCIDEV, "Writing to a read only register");
 254         }
 255         break;
 256
 257       default:
 258         panic("invalid access size");
 259     }
 260 }
 261
 262 void
 263 PciDev::serialize(ostream &os)
 264 {
 265     SERIALIZE_ARRAY(BARSize, 6);
 266     SERIALIZE_ARRAY(BARAddrs, 6);
 267     SERIALIZE_ARRAY(config.data, 64);
 268 }
 269
 270 void
 271 PciDev::unserialize(Checkpoint *cp, const std::string &section)
 272 {
 273     UNSERIALIZE_ARRAY(BARSize, 6);
 274     UNSERIALIZE_ARRAY(BARAddrs, 6);
 275     UNSERIALIZE_ARRAY(config.data, 64);
 276
 277     // Add the MMU mappings for the BARs
 278     for (int i=0; i < 6; i++) {
 279         if (BARAddrs[i] != 0)
 280             params()->mmu->add_child(this, RangeSize(BARAddrs[i], BARSize[i]));
 281     }
 282 }
 283
 284 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 285
 286 BEGIN_DECLARE_SIM_OBJECT_PARAMS(PciConfigData)
 287
 288     Param<uint16_t> VendorID;
 289     Param<uint16_t> DeviceID;
 290     Param<uint16_t> Command;
 291     Param<uint16_t> Status;
 292     Param<uint8_t> Revision;
 293     Param<uint8_t> ProgIF;
 294     Param<uint8_t> SubClassCode;
 295     Param<uint8_t> ClassCode;
 296     Param<uint8_t> CacheLineSize;
 297     Param<uint8_t> LatencyTimer;
 298     Param<uint8_t> HeaderType;
 299     Param<uint8_t> BIST;
 300     Param<uint32_t> BAR0;
 301     Param<uint32_t> BAR1;
 302     Param<uint32_t> BAR2;
 303     Param<uint32_t> BAR3;
 304     Param<uint32_t> BAR4;
 305     Param<uint32_t> BAR5;
 306     Param<uint32_t> CardbusCIS;
 307     Param<uint16_t> SubsystemVendorID;
 308     Param<uint16_t> SubsystemID;
 309     Param<uint32_t> ExpansionROM;
 310     Param<uint8_t> InterruptLine;
 311     Param<uint8_t> InterruptPin;
 312     Param<uint8_t> MinimumGrant;
 313     Param<uint8_t> MaximumLatency;
 314     Param<uint32_t> BAR0Size;
 315     Param<uint32_t> BAR1Size;
 316     Param<uint32_t> BAR2Size;
 317     Param<uint32_t> BAR3Size;
 318     Param<uint32_t> BAR4Size;
 319     Param<uint32_t> BAR5Size;
 320
 321 END_DECLARE_SIM_OBJECT_PARAMS(PciConfigData)
 322
 323 BEGIN_INIT_SIM_OBJECT_PARAMS(PciConfigData)
 324
 325     INIT_PARAM(VendorID, "Vendor ID"),
 326     INIT_PARAM(DeviceID, "Device ID"),
 327     INIT_PARAM_DFLT(Command, "Command Register", 0x00),
 328     INIT_PARAM_DFLT(Status, "Status Register", 0x00),
 329     INIT_PARAM_DFLT(Revision, "Device Revision", 0x00),
 330     INIT_PARAM_DFLT(ProgIF, "Programming Interface", 0x00),
 331     INIT_PARAM(SubClassCode, "Sub-Class Code"),
 332     INIT_PARAM(ClassCode, "Class Code"),
 333     INIT_PARAM_DFLT(CacheLineSize, "System Cacheline Size", 0x00),
 334     INIT_PARAM_DFLT(LatencyTimer, "PCI Latency Timer", 0x00),
 335     INIT_PARAM_DFLT(HeaderType, "PCI Header Type", 0x00),
 336     INIT_PARAM_DFLT(BIST, "Built In Self Test", 0x00),
 337     INIT_PARAM_DFLT(BAR0, "Base Address Register 0", 0x00),
 338     INIT_PARAM_DFLT(BAR1, "Base Address Register 1", 0x00),
 339     INIT_PARAM_DFLT(BAR2, "Base Address Register 2", 0x00),
 340     INIT_PARAM_DFLT(BAR3, "Base Address Register 3", 0x00),
 341     INIT_PARAM_DFLT(BAR4, "Base Address Register 4", 0x00),
 342     INIT_PARAM_DFLT(BAR5, "Base Address Register 5", 0x00),
 343     INIT_PARAM_DFLT(CardbusCIS, "Cardbus Card Information Structure", 0x00),
 344     INIT_PARAM_DFLT(SubsystemVendorID, "Subsystem Vendor ID", 0x00),
 345     INIT_PARAM_DFLT(SubsystemID, "Subsystem ID", 0x00),
 346     INIT_PARAM_DFLT(ExpansionROM, "Expansion ROM Base Address Register", 0x00),
 347     INIT_PARAM(InterruptLine, "Interrupt Line Register"),
 348     INIT_PARAM(InterruptPin, "Interrupt Pin Register"),
 349     INIT_PARAM_DFLT(MinimumGrant, "Minimum Grant", 0x00),
 350     INIT_PARAM_DFLT(MaximumLatency, "Maximum Latency", 0x00),
 351     INIT_PARAM_DFLT(BAR0Size, "Base Address Register 0 Size", 0x00),
 352     INIT_PARAM_DFLT(BAR1Size, "Base Address Register 1 Size", 0x00),
 353     INIT_PARAM_DFLT(BAR2Size, "Base Address Register 2 Size", 0x00),
 354     INIT_PARAM_DFLT(BAR3Size, "Base Address Register 3 Size", 0x00),
 355     INIT_PARAM_DFLT(BAR4Size, "Base Address Register 4 Size", 0x00),
 356     INIT_PARAM_DFLT(BAR5Size, "Base Address Register 5 Size", 0x00)
 357
 358 END_INIT_SIM_OBJECT_PARAMS(PciConfigData)
 359
 360 CREATE_SIM_OBJECT(PciConfigData)
 361 {
 362     PciConfigData *data = new PciConfigData(getInstanceName());
 363
 364     data->config.hdr.vendor = htoa(VendorID);
 365     data->config.hdr.device = htoa(DeviceID);
 366     data->config.hdr.command = htoa(Command);
 367     data->config.hdr.status = htoa(Status);
 368     data->config.hdr.revision = htoa(Revision);
 369     data->config.hdr.progIF = htoa(ProgIF);
 370     data->config.hdr.subClassCode = htoa(SubClassCode);
 371     data->config.hdr.classCode = htoa(ClassCode);
 372     data->config.hdr.cacheLineSize = htoa(CacheLineSize);
 373     data->config.hdr.latencyTimer = htoa(LatencyTimer);
 374     data->config.hdr.headerType = htoa(HeaderType);
 375     data->config.hdr.bist = htoa(BIST);
 376
 377     data->config.hdr.pci0.baseAddr0 = htoa(BAR0);
 378     data->config.hdr.pci0.baseAddr1 = htoa(BAR1);
 379     data->config.hdr.pci0.baseAddr2 = htoa(BAR2);
 380     data->config.hdr.pci0.baseAddr3 = htoa(BAR3);
 381     data->config.hdr.pci0.baseAddr4 = htoa(BAR4);
 382     data->config.hdr.pci0.baseAddr5 = htoa(BAR5);
 383     data->config.hdr.pci0.cardbusCIS = htoa(CardbusCIS);
 384     data->config.hdr.pci0.subsystemVendorID = htoa(SubsystemVendorID);
 385     data->config.hdr.pci0.subsystemID = htoa(SubsystemVendorID);
 386     data->config.hdr.pci0.expansionROM = htoa(ExpansionROM);
 387     data->config.hdr.pci0.interruptLine = htoa(InterruptLine);
 388     data->config.hdr.pci0.interruptPin = htoa(InterruptPin);
 389     data->config.hdr.pci0.minimumGrant = htoa(MinimumGrant);
 390     data->config.hdr.pci0.maximumLatency = htoa(MaximumLatency);
 391
 392     data->BARSize[0] = BAR0Size;
 393     data->BARSize[1] = BAR1Size;
 394     data->BARSize[2] = BAR2Size;
 395     data->BARSize[3] = BAR3Size;
 396     data->BARSize[4] = BAR4Size;
 397     data->BARSize[5] = BAR5Size;
 398
 399     return data;
 400 }
 401
 402 REGISTER_SIM_OBJECT("PciConfigData", PciConfigData)
 403
 404 #endif // DOXYGEN_SHOULD_SKIP_THIS