2 * Copyright (c) 2003 The Regents of The University of Michigan
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.
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.
30 * Interface for devices using PCI configuration
33 #ifndef __PCI_DEV_HH__
34 #define __PCI_DEV_HH__
36 #include "dev/pcireg.h"
37 #include "dev/io_device.hh"
40 class MemoryController;
44 * This class encapulates the first 64 bytes of a singles PCI
45 * devices config space that in configured by the configuration file.
47 class PciConfigData : public SimObject
51 * Constructor to initialize the devices config space to 0.
53 PciConfigData(const std::string &name)
56 memset(config.data, 0, sizeof(config.data));
57 memset(BARAddrs, 0, sizeof(BARAddrs));
58 memset(BARSize, 0, sizeof(BARSize));
61 /** The first 64 bytes */
64 /** The size of the BARs */
67 /** The addresses of the BARs */
72 * PCI device, base implemnation is only config space.
73 * Each device is connected to a PCIConfigSpace device
74 * which returns -1 for everything but the pcidevs that
75 * register with it. This object registers with the PCIConfig space
78 class PciDev : public DmaDevice
81 MemoryController *mmu;
82 /** A pointer to the configspace all object that calls
83 * us when a read comes to this particular device/function.
85 PciConfigAll *configSpace;
88 * A pointer to the object that contains the first 64 bytes of
91 PciConfigData *configData;
93 /** The bus number we are on */
96 /** The device number we have */
99 /** The function number */
100 uint32_t functionNum;
102 /** The current config space. Unlike the PciConfigData this is updated
103 * during simulation while continues to refelect what was in the config file.
107 /** The size of the BARs */
110 /** The current address mapping of the BARs */
115 * Constructor for PCI Dev. This function copies data from the config file
116 * object PCIConfigData and registers the device with a PciConfigAll object.
117 * @param name name of the object
118 * @param mmu a pointer to the memory controller
119 * @param cf a pointer to the config space object that this device need to
121 * @param cd A pointer to the config space values specified in the conig file
122 * @param bus the bus this device is on
123 * @param dev the device id of this device
124 * @param func the function number of this device
126 PciDev(const std::string &name, MemoryController *mmu, PciConfigAll *cf,
127 PciConfigData *cd, uint32_t bus, uint32_t dev, uint32_t func);
129 virtual Fault read(MemReqPtr &req, uint8_t *data) {
132 virtual Fault write(MemReqPtr &req, const uint8_t *data) {
137 * Write to the PCI config space data that is stored locally. This may be
138 * overridden by the device but at some point it will eventually call this
139 * for normal operations that it does not need to override.
140 * @param offset the offset into config space
141 * @param size the size of the write
142 * @param data the data to write
144 virtual void WriteConfig(int offset, int size, uint32_t data);
148 * Read from the PCI config space data that is stored locally. This may be
149 * overridden by the device but at some point it will eventually call this
150 * for normal operations that it does not need to override.
151 * @param offset the offset into config space
152 * @param size the size of the read
153 * @param data pointer to the location where the read value should be stored
155 virtual void ReadConfig(int offset, int size, uint8_t *data);
158 * Serialize this object to the given output stream.
159 * @param os The stream to serialize to.
161 virtual void serialize(std::ostream &os);
164 * Reconstruct the state of this object from a checkpoint.
165 * @param cp The checkpoint use.
166 * @param section The section name of this object
168 virtual void unserialize(Checkpoint *cp, const std::string §ion);
171 #endif // __PCI_DEV_HH__