2 * Copyright (c) 2004 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 __DEV_PCIDEV_HH__
34 #define __DEV_PCIDEV_HH__
36 #include "dev/io_device.hh"
37 #include "dev/pcireg.h"
38 #include "dev/platform.hh"
41 class MemoryController;
45 * This class encapulates the first 64 bytes of a singles PCI
46 * devices config space that in configured by the configuration file.
48 class PciConfigData : public SimObject
52 * Constructor to initialize the devices config space to 0.
54 PciConfigData(const std::string &name)
57 memset(config.data, 0, sizeof(config.data));
58 memset(BARAddrs, 0, sizeof(BARAddrs));
59 memset(BARSize, 0, sizeof(BARSize));
62 /** The first 64 bytes */
65 /** The size of the BARs */
68 /** The addresses of the BARs */
73 * PCI device, base implemnation is only config space.
74 * Each device is connected to a PCIConfigSpace device
75 * which returns -1 for everything but the pcidevs that
76 * register with it. This object registers with the PCIConfig space
79 class PciDev : public DmaDevice
86 MemoryController *mmu;
89 * A pointer to the configspace all object that calls us when
90 * a read comes to this particular device/function.
92 PciConfigAll *configSpace;
95 * A pointer to the object that contains the first 64 bytes of
98 PciConfigData *configData;
100 /** The bus number we are on */
103 /** The device number we have */
106 /** The function number */
107 uint32_t functionNum;
114 const Params *params() const { return _params; }
117 /** The current config space. Unlike the PciConfigData this is
118 * updated during simulation while continues to refelect what was
119 * in the config file.
123 /** The size of the BARs */
126 /** The current address mapping of the BARs */
131 PciConfigData *configData;
134 Addr pciToDma(Addr pciAddr) const
135 { return plat->pciToDma(pciAddr); }
139 { plat->postPciInt(configData->config.hdr.pci0.interruptLine); }
143 { plat->clearPciInt(configData->config.hdr.pci0.interruptLine); }
147 { return configData->config.hdr.pci0.interruptLine; }
151 * Constructor for PCI Dev. This function copies data from the
152 * config file object PCIConfigData and registers the device with
153 * a PciConfigAll object.
155 PciDev(Params *params);
157 virtual Fault read(MemReqPtr &req, uint8_t *data) {
160 virtual Fault write(MemReqPtr &req, const uint8_t *data) {
165 * Write to the PCI config space data that is stored locally. This may be
166 * overridden by the device but at some point it will eventually call this
167 * for normal operations that it does not need to override.
168 * @param offset the offset into config space
169 * @param size the size of the write
170 * @param data the data to write
172 virtual void WriteConfig(int offset, int size, uint32_t data);
176 * Read from the PCI config space data that is stored locally. This may be
177 * overridden by the device but at some point it will eventually call this
178 * for normal operations that it does not need to override.
179 * @param offset the offset into config space
180 * @param size the size of the read
181 * @param data pointer to the location where the read value should be stored
183 virtual void ReadConfig(int offset, int size, uint8_t *data);
186 * Serialize this object to the given output stream.
187 * @param os The stream to serialize to.
189 virtual void serialize(std::ostream &os);
192 * Reconstruct the state of this object from a checkpoint.
193 * @param cp The checkpoint use.
194 * @param section The section name of this object
196 virtual void unserialize(Checkpoint *cp, const std::string §ion);
199 #endif // __DEV_PCIDEV_HH__