src/dev/tsunami_pchip.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  * Authors: Ali Saidi
  29  */
  30
  31 /** @file
  32  * Tsunami PCI interface CSRs
  33  */
  34
  35 #ifndef __TSUNAMI_PCHIP_HH__
  36 #define __TSUNAMI_PCHIP_HH__
  37
  38 #include "dev/tsunami.hh"
  39 #include "base/range.hh"
  40 #include "dev/io_device.hh"
  41
  42 /**
  43  * A very simple implementation of the Tsunami PCI interface chips.
  44  */
  45 class TsunamiPChip : public BasicPioDevice
  46 {
  47   protected:
  48     /** Pchip control register */
  49     uint64_t pctl;
  50
  51     /** Window Base addresses */
  52     uint64_t wsba[4];
  53
  54     /** Window masks */
  55     uint64_t wsm[4];
  56
  57     /** Translated Base Addresses */
  58     uint64_t tba[4];
  59
  60   public:
  61     struct Params : public BasicPioDevice::Params
  62     {
  63         Tsunami *tsunami;
  64     };
  65   protected:
  66     const Params *params() const { return (const Params*)_params; }
  67
  68   public:
  69     /**
  70      * Register the PChip with the mmu and init all wsba, wsm, and tba to 0
  71      * @param p pointer to the parameters struct
  72      */
  73     TsunamiPChip(Params *p);
  74
  75     /**
  76      * Translate a PCI bus address to a memory address for DMA.
  77      * @todo Andrew says this needs to be fixed. What's wrong with it?
  78      * @param busAddr PCI address to translate.
  79      * @return memory system address
  80      */
  81     Addr translatePciToDma(Addr busAddr);
  82
  83     virtual Tick read(Packet *pkt);
  84     virtual Tick write(Packet *pkt);
  85
  86     /**
  87      * Serialize this object to the given output stream.
  88      * @param os The stream to serialize to.
  89      */
  90     virtual void serialize(std::ostream &os);
  91
  92     /**
  93      * Reconstruct the state of this object from a checkpoint.
  94      * @param cp The checkpoint use.
  95      * @param section The section name of this object
  96      */
  97     virtual void unserialize(Checkpoint *cp, const std::string &section);
  98 };
  99
 100 #endif // __TSUNAMI_PCHIP_HH__