dev/pciconfigall.hh

   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 /*
  30  * @file
  31  * PCI Config space implementation.
  32  */
  33
  34 #ifndef __PCICONFIGALL_HH__
  35 #define __PCICONFIGALL_HH__
  36
  37 #include "dev/pcireg.h"
  38 #include "base/range.hh"
  39 #include "dev/io_device.hh"
  40
  41
  42 static const uint32_t MAX_PCI_DEV = 32;
  43 static const uint32_t MAX_PCI_FUNC = 8;
  44
  45 class PciDev;
  46
  47 /**
  48  * PCI Config Space
  49  * All of PCI config space needs to return -1 on Tsunami, except
  50  * the devices that exist. This device maps the entire bus config
  51  * space and passes the requests on to TsunamiPCIDev devices as
  52  * appropriate.
  53  */
  54 class PciConfigAll : public BasicPioDevice
  55 {
  56   private:
  57     /**
  58       * Pointers to all the devices that are registered with this
  59       * particular config space.
  60       */
  61     PciDev* devices[MAX_PCI_DEV][MAX_PCI_FUNC];
  62
  63   public:
  64     /**
  65      * Constructor for PCIConfigAll
  66      * @param p parameters structure
  67      */
  68     PciConfigAll(Params *p);
  69
  70     /**
  71      * Check if a device exists.
  72      * @param pcidev PCI device to check
  73      * @param pcifunc PCI function to check
  74      * @return true if device exists, false otherwise
  75      */
  76     bool deviceExists(uint32_t pcidev, uint32_t pcifunc)
  77                      { return devices[pcidev][pcifunc] != NULL ? true : false; }
  78
  79     /**
  80      * Registers a device with the config space object.
  81      * @param pcidev PCI device to register
  82      * @param pcifunc PCI function to register
  83      * @param device device to register
  84      */
  85     void registerDevice(uint8_t pcidev, uint8_t pcifunc, PciDev *device)
  86                         { devices[pcidev][pcifunc] = device; }
  87
  88     /**
  89      * Read something in PCI config space. If the device does not exist
  90      * -1 is returned, if the device does exist its PciDev::ReadConfig (or the
  91      * virtual function that overrides) it is called.
  92      * @param pkt Contains the address of the field to read.
  93      * @return Amount of time to do the read
  94      */
  95     virtual Tick read(Packet *pkt);
  96
  97     /**
  98      * Write to PCI config spcae. If the device does not exit the simulator
  99      * panics. If it does it is passed on the PciDev::WriteConfig (or the virtual
 100      * function that overrides it).
 101      * @param req Contains the address to write to.
 102      * @param data The data to write.
 103      * @return The fault condition of the access.
 104      */
 105
 106     virtual Tick write(Packet *pkt);
 107
 108     /**
 109      * Start up function to check if more than one person is using an interrupt line
 110      * and print a warning if such a case exists
 111      */
 112     virtual void startup();
 113
 114     /**
 115      * Serialize this object to the given output stream.
 116      * @param os The stream to serialize to.
 117      */
 118     virtual void serialize(std::ostream &os);
 119
 120     /**
 121      * Reconstruct the state of this object from a checkpoint.
 122      * @param cp The checkpoint use.
 123      * @param section The section name of this object
 124      */
 125     virtual void unserialize(Checkpoint *cp, const std::string &section);
 126 };
 127
 128 #endif // __PCICONFIGALL_HH__