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
  49     static const Addr TsunamiPciBus0Config = ULL(0x801fe000000);
  50
  51     /** Pchip control register */
  52     uint64_t pctl;
  53
  54     /** Window Base addresses */
  55     uint64_t wsba[4];
  56
  57     /** Window masks */
  58     uint64_t wsm[4];
  59
  60     /** Translated Base Addresses */
  61     uint64_t tba[4];
  62
  63   public:
  64     struct Params : public BasicPioDevice::Params
  65     {
  66         Tsunami *tsunami;
  67     };
  68   protected:
  69     const Params *params() const { return (const Params*)_params; }
  70
  71   public:
  72     /**
  73      * Register the PChip with the mmu and init all wsba, wsm, and tba to 0
  74      * @param p pointer to the parameters struct
  75      */
  76     TsunamiPChip(Params *p);
  77
  78     /**
  79      * Translate a PCI bus address to a memory address for DMA.
  80      * @todo Andrew says this needs to be fixed. What's wrong with it?
  81      * @param busAddr PCI address to translate.
  82      * @return memory system address
  83      */
  84     Addr translatePciToDma(Addr busAddr);
  85
  86     Addr calcConfigAddr(int bus, int dev, int func);
  87
  88     virtual Tick read(Packet *pkt);
  89     virtual Tick write(Packet *pkt);
  90
  91     /**
  92      * Serialize this object to the given output stream.
  93      * @param os The stream to serialize to.
  94      */
  95     virtual void serialize(std::ostream &os);
  96
  97     /**
  98      * Reconstruct the state of this object from a checkpoint.
  99      * @param cp The checkpoint use.
 100      * @param section The section name of this object
 101      */
 102     virtual void unserialize(Checkpoint *cp, const std::string &section);
 103 };
 104
 105 #endif // __TSUNAMI_PCHIP_HH__