gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
io_device.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, 2015 ARM Limited
3  * All rights reserved.
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Copyright (c) 2006 The Regents of The University of Michigan
15  * All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions are
19  * met: redistributions of source code must retain the above copyright
20  * notice, this list of conditions and the following disclaimer;
21  * redistributions in binary form must reproduce the above copyright
22  * notice, this list of conditions and the following disclaimer in the
23  * documentation and/or other materials provided with the distribution;
24  * neither the name of the copyright holders nor the names of its
25  * contributors may be used to endorse or promote products derived from
26  * this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  *
40  * Authors: Ali Saidi
41  * Nathan Binkert
42  */
43 
44 #include "dev/io_device.hh"
45 
46 #include "base/trace.hh"
47 #include "debug/AddrRanges.hh"
48 #include "sim/system.hh"
49 
51  : SimpleTimingPort(dev->name() + ".pio", dev), device(dev)
52 {
53 }
54 
55 Tick
57 {
58  // technically the packet only reaches us after the header delay,
59  // and typically we also need to deserialise any payload
60  Tick receive_delay = pkt->headerDelay + pkt->payloadDelay;
61  pkt->headerDelay = pkt->payloadDelay = 0;
62 
63  const Tick delay(pkt->isRead() ? device->read(pkt) : device->write(pkt));
64  assert(pkt->isResponse() || pkt->isError());
65  return delay + receive_delay;
66 }
67 
70 {
71  return device->getAddrRanges();
72 }
73 
75  : MemObject(p), sys(p->system), pioPort(this)
76 {}
77 
79 {
80 }
81 
82 void
84 {
85  if (!pioPort.isConnected())
86  panic("Pio port of %s not connected to anything!", name());
88 }
89 
91 PioDevice::getSlavePort(const std::string &if_name, PortID idx)
92 {
93  if (if_name == "pio") {
94  return pioPort;
95  }
96  return MemObject::getSlavePort(if_name, idx);
97 }
98 
100  : PioDevice(p), pioAddr(p->pio_addr), pioSize(size),
101  pioDelay(p->pio_latency)
102 {}
103 
106 {
107  assert(pioSize != 0);
108  AddrRangeList ranges;
109  DPRINTF(AddrRanges, "registering range: %#x-%#x\n", pioAddr, pioSize);
110  ranges.push_back(RangeSize(pioAddr, pioSize));
111  return ranges;
112 }
#define DPRINTF(x,...)
Definition: trace.hh:212
AddrRange RangeSize(Addr start, Addr size)
Definition: addr_range.hh:398
const std::string & name()
Definition: trace.cc:49
#define panic(...)
Definition: misc.hh:153
virtual Tick read(PacketPtr pkt)=0
Pure virtual function that the device must implement.
PioDeviceParams Params
Definition: io_device.hh:116
virtual BaseSlavePort & getSlavePort(const std::string &if_name, PortID idx=InvalidPortID)
Get a slave port with a given name and index.
Definition: mem_object.cc:58
virtual Tick recvAtomic(PacketPtr pkt)
Receive an atomic request packet from the master port.
Definition: io_device.cc:56
A BaseSlavePort is a protocol-agnostic slave port, responsible only for the structural connection to ...
Definition: port.hh:139
BasicPioDevice(const Params *p, Addr size)
Definition: io_device.cc:99
PioPort pioPort
The pioPort that handles the requests for us and provides us requests that it sees.
Definition: io_device.hh:91
The simple timing port uses a queued port to implement recvFunctional and recvTimingReq through recvA...
Definition: tport.hh:60
system
Definition: isa.cc:226
virtual Tick write(PacketPtr pkt)=0
Pure virtual function that the device must implement.
Addr pioSize
Size that the device's address range.
Definition: io_device.hh:142
uint32_t headerDelay
The extra delay from seeing the packet until the header is transmitted.
Definition: packet.hh:340
uint64_t Tick
Tick count type.
Definition: types.hh:63
virtual AddrRangeList getAddrRanges() const
Get a list of the non-overlapping address ranges the owner is responsible for.
Definition: io_device.cc:69
virtual AddrRangeList getAddrRanges() const =0
Every PIO device is obliged to provide an implementation that returns the address ranges the device r...
This device is the base class which all devices senstive to an address range inherit from...
Definition: io_device.hh:84
PioDevice * device
The device that this port serves.
Definition: io_device.hh:66
bool isRead() const
Definition: packet.hh:502
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:142
uint32_t payloadDelay
The extra pipelining delay from seeing the packet until the end of payload is transmitted by the comp...
Definition: packet.hh:358
virtual BaseSlavePort & getSlavePort(const std::string &if_name, PortID idx=InvalidPortID)
Get a slave port with a given name and index.
Definition: io_device.cc:91
A Packet is used to encapsulate a transfer between two objects in the memory system (e...
Definition: packet.hh:245
void sendRangeChange() const
Called by the owner to send a range change.
Definition: port.hh:410
virtual ~PioDevice()
Definition: io_device.cc:78
virtual AddrRangeList getAddrRanges() const
Determine the address ranges that this device responds to.
Definition: io_device.cc:105
virtual void init()
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: io_device.cc:83
int size()
Definition: pagetable.hh:146
virtual const std::string name() const
Definition: sim_object.hh:117
bool isError() const
Definition: packet.hh:528
The MemObject class extends the ClockedObject with accessor functions to get its master and slave por...
Definition: mem_object.hh:60
bool isConnected() const
Definition: port.cc:110
PioPort(PioDevice *dev)
Definition: io_device.cc:50
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:181
PioDevice(const Params *p)
Definition: io_device.cc:74
Bitfield< 0 > p
Addr pioAddr
Address that the device listens to.
Definition: io_device.hh:139
bool isResponse() const
Definition: packet.hh:506

Generated on Fri Jun 9 2017 13:03:46 for gem5 by doxygen 1.8.6