dev/pcidev.hh

   1 /*
   2  * Copyright (c) 2003 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  * Interface for devices using PCI configuration
  31  */
  32
  33 #ifndef __PCI_DEV_HH__
  34 #define __PCI_DEV_HH__
  35
  36 #include "dev/pcireg.h"
  37 #include "dev/io_device.hh"
  38
  39 class PciConfigAll;
  40 class MemoryController;
  41
  42 class PciConfigData : public SimObject
  43 {
  44   public:
  45     PciConfigData(const std::string &name)
  46         : SimObject(name)
  47     {
  48         memset(config.data, 0, sizeof(config.data));
  49         memset(BARAddrs, 0, sizeof(BARAddrs));
  50         memset(BARSize, 0, sizeof(BARSize));
  51     }
  52
  53     PCIConfig config;
  54     uint32_t BARSize[6];
  55     Addr BARAddrs[6];
  56 };
  57
  58 /**
  59  * PCI device, base implemnation is only config space.
  60  * Each device is connected to a PCIConfigSpace device
  61  * which returns -1 for everything but the pcidevs that
  62  * register with it. This object registers with the PCIConfig space
  63  * object.
  64  */
  65 class PciDev : public DmaDevice
  66 {
  67   protected:
  68     MemoryController *mmu;
  69     PciConfigAll *configSpace;
  70     PciConfigData *configData;
  71     uint32_t busNum;
  72     uint32_t deviceNum;
  73     uint32_t functionNum;
  74
  75     PCIConfig config;
  76     uint32_t BARSize[6];
  77     Addr BARAddrs[6];
  78
  79   public:
  80     PciDev(const std::string &name, MemoryController *mmu, PciConfigAll *cf,
  81            PciConfigData *cd, uint32_t bus, uint32_t dev, uint32_t func);
  82
  83     virtual Fault read(MemReqPtr &req, uint8_t *data) {
  84         return No_Fault;
  85     }
  86     virtual Fault write(MemReqPtr &req, const uint8_t *data) {
  87         return No_Fault;
  88     }
  89
  90     virtual void WriteConfig(int offset, int size, uint32_t data);
  91     virtual void ReadConfig(int offset, int size, uint8_t *data);
  92
  93     virtual void serialize(std::ostream &os);
  94     virtual void unserialize(Checkpoint *cp, const std::string &section);
  95 };
  96
  97 #endif // __PCI_DEV_HH__