dev/tsunami_pchip.hh

   1 /*
   2  * Copyright (c) 2004 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  * Tsunami PChip
  31  */
  32
  33 #ifndef __TSUNAMI_PCHIP_HH__
  34 #define __TSUNAMI_PCHIP_HH__
  35
  36 #include "mem/functional_mem/functional_memory.hh"
  37 #include "dev/tsunami.hh"
  38
  39 /*
  40  * Tsunami PChip
  41  */
  42 class TsunamiPChip : public FunctionalMemory
  43 {
  44   private:
  45     /** The base address of this device */
  46     Addr addr;
  47
  48     /** The size of mappad from the above address */
  49     static const Addr size = 0xfff;
  50
  51   protected:
  52     /**
  53      * pointer to the tsunami object.
  54      * This is our access to all the other tsunami
  55      * devices.
  56      */
  57     Tsunami *tsunami;
  58
  59     /** Pchip control register */
  60     uint64_t pctl;
  61
  62     /** Window Base addresses */
  63     uint64_t wsba[4];
  64
  65     /** Window masks */
  66     uint64_t wsm[4];
  67
  68     /** Translated Base Addresses */
  69     uint64_t tba[4];
  70
  71   public:
  72     /**
  73      * Register the PChip with the mmu and init all wsba, wsm, and tba to 0
  74      * @param name the name of thes device
  75      * @param t a pointer to the tsunami device
  76      * @param a the address which we respond to
  77      * @param mmu the mmu we are to register with
  78      */
  79     TsunamiPChip(const std::string &name, Tsunami *t, Addr a,
  80                  MemoryController *mmu);
  81
  82     /**
  83      * Translate a PCI bus address to a memory address for DMA.
  84      * @todo Andrew says this needs to be fixed. What's wrong with it?
  85      * @param busAddr PCI address to translate.
  86      * @return memory system address
  87      */
  88     Addr translatePciToDma(Addr busAddr);
  89
  90      /**
  91       * Process a read to the PChip.
  92       * @param req Contains the address to read from.
  93       * @param data A pointer to write the read data to.
  94       * @return The fault condition of the access.
  95       */
  96     virtual Fault read(MemReqPtr &req, uint8_t *data);
  97
  98     /**
  99       * Process a write to the PChip.
 100       * @param req Contains the address to write to.
 101       * @param data The data to write.
 102       * @return The fault condition of the access.
 103       */
 104     virtual Fault write(MemReqPtr &req, const uint8_t *data);
 105
 106     /**
 107      * Serialize this object to the given output stream.
 108      * @param os The stream to serialize to.
 109      */
 110     virtual void serialize(std::ostream &os);
 111
 112     /**
 113      * Reconstruct the state of this object from a checkpoint.
 114      * @param cp The checkpoint use.
 115      * @param section The section name of this object
 116      */
 117     virtual void unserialize(Checkpoint *cp, const std::string &section);
 118 };
 119
 120 #endif // __TSUNAMI_PCHIP_HH__