src/dev/isa_fake.cc

   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  * Isa Fake Device implementation
  33  */
  34
  35 #include "base/trace.hh"
  36 #include "dev/isa_fake.hh"
  37 #include "mem/packet.hh"
  38 #include "mem/packet_access.hh"
  39 #include "sim/builder.hh"
  40 #include "sim/system.hh"
  41
  42 using namespace std;
  43
  44 IsaFake::IsaFake(Params *p)
  45     : BasicPioDevice(p)
  46 {
  47     if (!params()->retBadAddr)
  48         pioSize = p->pio_size;
  49
  50     retData8 = params()->retData8;
  51     retData16 = params()->retData16;
  52     retData32 = params()->retData32;
  53     retData64 = params()->retData64;
  54 }
  55
  56 Tick
  57 IsaFake::read(PacketPtr pkt)
  58 {
  59     assert(pkt->result == Packet::Unknown);
  60
  61     if (params()->warnAccess != "")
  62         warn("Device %s accessed by read to address %#x size=%d\n",
  63                 name(), pkt->getAddr(), pkt->getSize());
  64     if (params()->retBadAddr) {
  65         DPRINTF(Tsunami, "read to bad address va=%#x size=%d\n",
  66                 pkt->getAddr(), pkt->getSize());
  67         pkt->result = Packet::BadAddress;
  68     } else {
  69         assert(pkt->getAddr() >= pioAddr && pkt->getAddr() < pioAddr + pioSize);
  70         DPRINTF(Tsunami, "read  va=%#x size=%d\n",
  71                 pkt->getAddr(), pkt->getSize());
  72         switch (pkt->getSize()) {
  73           case sizeof(uint64_t):
  74              pkt->set(retData64);
  75              break;
  76           case sizeof(uint32_t):
  77              pkt->set(retData32);
  78              break;
  79           case sizeof(uint16_t):
  80              pkt->set(retData16);
  81              break;
  82           case sizeof(uint8_t):
  83              pkt->set(retData8);
  84              break;
  85           default:
  86             panic("invalid access size!\n");
  87         }
  88         pkt->result = Packet::Success;
  89     }
  90     return pioDelay;
  91 }
  92
  93 Tick
  94 IsaFake::write(PacketPtr pkt)
  95 {
  96     if (params()->warnAccess != "") {
  97         uint64_t data;
  98         switch (pkt->getSize()) {
  99           case sizeof(uint64_t):
 100             data = pkt->get<uint64_t>();
 101             break;
 102           case sizeof(uint32_t):
 103             data = pkt->get<uint32_t>();
 104             break;
 105           case sizeof(uint16_t):
 106             data = pkt->get<uint16_t>();
 107             break;
 108           case sizeof(uint8_t):
 109             data = pkt->get<uint8_t>();
 110             break;
 111           default:
 112             panic("invalid access size!\n");
 113         }
 114         warn("Device %s accessed by write to address %#x size=%d data=%#x\n",
 115                 name(), pkt->getAddr(), pkt->getSize(), data);
 116     }
 117     if (params()->retBadAddr) {
 118         DPRINTF(Tsunami, "write to bad address va=%#x size=%d \n",
 119                 pkt->getAddr(), pkt->getSize());
 120         pkt->result = Packet::BadAddress;
 121     } else {
 122         DPRINTF(Tsunami, "write - va=%#x size=%d \n",
 123                 pkt->getAddr(), pkt->getSize());
 124
 125         if (params()->updateData) {
 126             switch (pkt->getSize()) {
 127               case sizeof(uint64_t):
 128                 retData64 = pkt->get<uint64_t>();
 129                 break;
 130               case sizeof(uint32_t):
 131                 retData32 = pkt->get<uint32_t>();
 132                 break;
 133               case sizeof(uint16_t):
 134                 retData16 = pkt->get<uint16_t>();
 135                 break;
 136               case sizeof(uint8_t):
 137                 retData8 = pkt->get<uint8_t>();
 138                 break;
 139               default:
 140                 panic("invalid access size!\n");
 141             }
 142         }
 143         pkt->result = Packet::Success;
 144     }
 145     return pioDelay;
 146 }
 147
 148 BEGIN_DECLARE_SIM_OBJECT_PARAMS(IsaFake)
 149
 150     Param<Addr> pio_addr;
 151     Param<Tick> pio_latency;
 152     Param<Addr> pio_size;
 153     Param<bool> ret_bad_addr;
 154     Param<bool> update_data;
 155     Param<std::string> warn_access;
 156     Param<uint8_t> ret_data8;
 157     Param<uint16_t> ret_data16;
 158     Param<uint32_t> ret_data32;
 159     Param<uint64_t> ret_data64;
 160     SimObjectParam<Platform *> platform;
 161     SimObjectParam<System *> system;
 162
 163 END_DECLARE_SIM_OBJECT_PARAMS(IsaFake)
 164
 165 BEGIN_INIT_SIM_OBJECT_PARAMS(IsaFake)
 166
 167     INIT_PARAM(pio_addr, "Device Address"),
 168     INIT_PARAM(pio_latency, "Programmed IO latency"),
 169     INIT_PARAM(pio_size, "Size of address range"),
 170     INIT_PARAM(ret_bad_addr, "Return pkt status BadAddr"),
 171     INIT_PARAM(update_data, "Update returned data"),
 172     INIT_PARAM(warn_access, "Warn if this device is touched"),
 173     INIT_PARAM(ret_data8, "Data to return if not bad addr"),
 174     INIT_PARAM(ret_data16, "Data to return if not bad addr"),
 175     INIT_PARAM(ret_data32, "Data to return if not bad addr"),
 176     INIT_PARAM(ret_data64, "Data to return if not bad addr"),
 177     INIT_PARAM(platform, "platform"),
 178     INIT_PARAM(system, "system object")
 179
 180 END_INIT_SIM_OBJECT_PARAMS(IsaFake)
 181
 182 CREATE_SIM_OBJECT(IsaFake)
 183 {
 184     IsaFake::Params *p = new IsaFake::Params;
 185     p->name = getInstanceName();
 186     p->pio_addr = pio_addr;
 187     p->pio_delay = pio_latency;
 188     p->pio_size = pio_size;
 189     p->retBadAddr = ret_bad_addr;
 190     p->updateData = update_data;
 191     p->warnAccess = warn_access;
 192     p->retData8= ret_data8;
 193     p->retData16 = ret_data16;
 194     p->retData32 = ret_data32;
 195     p->retData64 = ret_data64;
 196     p->platform = platform;
 197     p->system = system;
 198     return new IsaFake(p);
 199 }
 200
 201 REGISTER_SIM_OBJECT("IsaFake", IsaFake)