io_device.hh revision 8796:a2ae5c378d0a
113996Sgiacomo.travaglini@arm.com/* 213996Sgiacomo.travaglini@arm.com * Copyright (c) 2004-2005 The Regents of The University of Michigan 313996Sgiacomo.travaglini@arm.com * All rights reserved. 413996Sgiacomo.travaglini@arm.com * 513996Sgiacomo.travaglini@arm.com * Redistribution and use in source and binary forms, with or without 613996Sgiacomo.travaglini@arm.com * modification, are permitted provided that the following conditions are 713996Sgiacomo.travaglini@arm.com * met: redistributions of source code must retain the above copyright 813996Sgiacomo.travaglini@arm.com * notice, this list of conditions and the following disclaimer; 913996Sgiacomo.travaglini@arm.com * redistributions in binary form must reproduce the above copyright 1013996Sgiacomo.travaglini@arm.com * notice, this list of conditions and the following disclaimer in the 1113996Sgiacomo.travaglini@arm.com * documentation and/or other materials provided with the distribution; 1213996Sgiacomo.travaglini@arm.com * neither the name of the copyright holders nor the names of its 1313996Sgiacomo.travaglini@arm.com * contributors may be used to endorse or promote products derived from 1413996Sgiacomo.travaglini@arm.com * this software without specific prior written permission. 1513996Sgiacomo.travaglini@arm.com * 1613996Sgiacomo.travaglini@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1713996Sgiacomo.travaglini@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1813996Sgiacomo.travaglini@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1913996Sgiacomo.travaglini@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2013996Sgiacomo.travaglini@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2113996Sgiacomo.travaglini@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2213996Sgiacomo.travaglini@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2313996Sgiacomo.travaglini@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2413996Sgiacomo.travaglini@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2513996Sgiacomo.travaglini@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2613996Sgiacomo.travaglini@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2713996Sgiacomo.travaglini@arm.com * 2813996Sgiacomo.travaglini@arm.com * Authors: Ali Saidi 2913996Sgiacomo.travaglini@arm.com * Nathan Binkert 3013996Sgiacomo.travaglini@arm.com */ 3113996Sgiacomo.travaglini@arm.com 3213996Sgiacomo.travaglini@arm.com#ifndef __DEV_IO_DEVICE_HH__ 3313996Sgiacomo.travaglini@arm.com#define __DEV_IO_DEVICE_HH__ 3413996Sgiacomo.travaglini@arm.com 3513996Sgiacomo.travaglini@arm.com#include "base/fast_alloc.hh" 3613996Sgiacomo.travaglini@arm.com#include "mem/mem_object.hh" 3713996Sgiacomo.travaglini@arm.com#include "mem/packet.hh" 3813996Sgiacomo.travaglini@arm.com#include "mem/tport.hh" 3913996Sgiacomo.travaglini@arm.com#include "params/BasicPioDevice.hh" 4013996Sgiacomo.travaglini@arm.com#include "params/DmaDevice.hh" 4113996Sgiacomo.travaglini@arm.com#include "params/PioDevice.hh" 4213996Sgiacomo.travaglini@arm.com#include "sim/sim_object.hh" 4313996Sgiacomo.travaglini@arm.com 4413996Sgiacomo.travaglini@arm.comclass Event; 4513996Sgiacomo.travaglini@arm.comclass PioDevice; 4613996Sgiacomo.travaglini@arm.comclass DmaDevice; 4713996Sgiacomo.travaglini@arm.comclass System; 4813996Sgiacomo.travaglini@arm.com 4913996Sgiacomo.travaglini@arm.com/** 5013996Sgiacomo.travaglini@arm.com * The PioPort class is a programmed i/o port that all devices that are 5113996Sgiacomo.travaglini@arm.com * sensitive to an address range use. The port takes all the memory 5213996Sgiacomo.travaglini@arm.com * access types and roles them into one read() and write() call that the device 5313996Sgiacomo.travaglini@arm.com * must respond to. The device must also provide the addressRanges() function 5413996Sgiacomo.travaglini@arm.com * with which it returns the address ranges it is interested in. 5513996Sgiacomo.travaglini@arm.com */ 5613996Sgiacomo.travaglini@arm.comclass PioPort : public SimpleTimingPort 5713996Sgiacomo.travaglini@arm.com{ 5813996Sgiacomo.travaglini@arm.com protected: 5913996Sgiacomo.travaglini@arm.com /** The device that this port serves. */ 6013996Sgiacomo.travaglini@arm.com PioDevice *device; 6113996Sgiacomo.travaglini@arm.com 6213996Sgiacomo.travaglini@arm.com virtual Tick recvAtomic(PacketPtr pkt); 6313996Sgiacomo.travaglini@arm.com 6413996Sgiacomo.travaglini@arm.com virtual void getDeviceAddressRanges(AddrRangeList &resp, 6513996Sgiacomo.travaglini@arm.com bool &snoop); 6613996Sgiacomo.travaglini@arm.com 6713996Sgiacomo.travaglini@arm.com public: 6813996Sgiacomo.travaglini@arm.com 6913996Sgiacomo.travaglini@arm.com PioPort(PioDevice *dev, System *s, std::string pname = "-pioport"); 7013996Sgiacomo.travaglini@arm.com}; 7113996Sgiacomo.travaglini@arm.com 7213996Sgiacomo.travaglini@arm.com 7313996Sgiacomo.travaglini@arm.comclass DmaPort : public Port 7413996Sgiacomo.travaglini@arm.com{ 7513996Sgiacomo.travaglini@arm.com protected: 7613996Sgiacomo.travaglini@arm.com struct DmaReqState : public Packet::SenderState, public FastAlloc 7713996Sgiacomo.travaglini@arm.com { 7813996Sgiacomo.travaglini@arm.com /** Event to call on the device when this transaction (all packets) 7913996Sgiacomo.travaglini@arm.com * complete. */ 8013996Sgiacomo.travaglini@arm.com Event *completionEvent; 8113996Sgiacomo.travaglini@arm.com 8213996Sgiacomo.travaglini@arm.com /** Where we came from for some sanity checking. */ 8313996Sgiacomo.travaglini@arm.com Port *outPort; 8413996Sgiacomo.travaglini@arm.com 8513996Sgiacomo.travaglini@arm.com /** Total number of bytes that this transaction involves. */ 8613996Sgiacomo.travaglini@arm.com Addr totBytes; 8713996Sgiacomo.travaglini@arm.com 8813996Sgiacomo.travaglini@arm.com /** Number of bytes that have been acked for this transaction. */ 8913996Sgiacomo.travaglini@arm.com Addr numBytes; 9013996Sgiacomo.travaglini@arm.com 9113996Sgiacomo.travaglini@arm.com /** Amount to delay completion of dma by */ 9213996Sgiacomo.travaglini@arm.com Tick delay; 9313996Sgiacomo.travaglini@arm.com 9413996Sgiacomo.travaglini@arm.com 9513996Sgiacomo.travaglini@arm.com DmaReqState(Event *ce, Port *p, Addr tb, Tick _delay) 9613996Sgiacomo.travaglini@arm.com : completionEvent(ce), outPort(p), totBytes(tb), numBytes(0), 9713996Sgiacomo.travaglini@arm.com delay(_delay) 9813996Sgiacomo.travaglini@arm.com {} 9913996Sgiacomo.travaglini@arm.com }; 10013996Sgiacomo.travaglini@arm.com 10113996Sgiacomo.travaglini@arm.com MemObject *device; 10213996Sgiacomo.travaglini@arm.com std::list<PacketPtr> transmitList; 10313996Sgiacomo.travaglini@arm.com 10413996Sgiacomo.travaglini@arm.com /** The system that device/port are in. This is used to select which mode 10513996Sgiacomo.travaglini@arm.com * we are currently operating in. */ 10613996Sgiacomo.travaglini@arm.com System *sys; 10713996Sgiacomo.travaglini@arm.com 10813996Sgiacomo.travaglini@arm.com /** Number of outstanding packets the dma port has. */ 10913996Sgiacomo.travaglini@arm.com int pendingCount; 11013996Sgiacomo.travaglini@arm.com 11113996Sgiacomo.travaglini@arm.com /** If a dmaAction is in progress. */ 11213996Sgiacomo.travaglini@arm.com int actionInProgress; 11313996Sgiacomo.travaglini@arm.com 11413996Sgiacomo.travaglini@arm.com /** If we need to drain, keep the drain event around until we're done 11513996Sgiacomo.travaglini@arm.com * here.*/ 11613996Sgiacomo.travaglini@arm.com Event *drainEvent; 11713996Sgiacomo.travaglini@arm.com 11813996Sgiacomo.travaglini@arm.com /** time to wait between sending another packet, increases as NACKs are 11913996Sgiacomo.travaglini@arm.com * recived, decreases as responses are recived. */ 12013996Sgiacomo.travaglini@arm.com Tick backoffTime; 12113996Sgiacomo.travaglini@arm.com 12213996Sgiacomo.travaglini@arm.com /** Minimum time that device should back off for after failed sendTiming */ 12313996Sgiacomo.travaglini@arm.com Tick minBackoffDelay; 12413996Sgiacomo.travaglini@arm.com 12513996Sgiacomo.travaglini@arm.com /** Maximum time that device should back off for after failed sendTiming */ 12613996Sgiacomo.travaglini@arm.com Tick maxBackoffDelay; 12713996Sgiacomo.travaglini@arm.com 12813996Sgiacomo.travaglini@arm.com /** If the port is currently waiting for a retry before it can send whatever 12913996Sgiacomo.travaglini@arm.com * it is that it's sending. */ 13013996Sgiacomo.travaglini@arm.com bool inRetry; 13113996Sgiacomo.travaglini@arm.com 13213996Sgiacomo.travaglini@arm.com /** Port accesses a cache which requires snooping */ 13313996Sgiacomo.travaglini@arm.com bool recvSnoops; 13413996Sgiacomo.travaglini@arm.com 13513996Sgiacomo.travaglini@arm.com /** Records snoop response so we only reply once to a status change */ 13613996Sgiacomo.travaglini@arm.com bool snoopRangeSent; 13713996Sgiacomo.travaglini@arm.com 13813996Sgiacomo.travaglini@arm.com virtual bool recvTiming(PacketPtr pkt); 13913996Sgiacomo.travaglini@arm.com virtual Tick recvAtomic(PacketPtr pkt) 14013996Sgiacomo.travaglini@arm.com { 14113996Sgiacomo.travaglini@arm.com if (recvSnoops) return 0; 14213996Sgiacomo.travaglini@arm.com 14313996Sgiacomo.travaglini@arm.com panic("dma port shouldn't be used for pio access."); M5_DUMMY_RETURN 14413996Sgiacomo.travaglini@arm.com } 14513996Sgiacomo.travaglini@arm.com virtual void recvFunctional(PacketPtr pkt) 14613996Sgiacomo.travaglini@arm.com { 14713996Sgiacomo.travaglini@arm.com if (recvSnoops) return; 14813996Sgiacomo.travaglini@arm.com 14913996Sgiacomo.travaglini@arm.com panic("dma port shouldn't be used for pio access."); 15013996Sgiacomo.travaglini@arm.com } 15113996Sgiacomo.travaglini@arm.com 15213996Sgiacomo.travaglini@arm.com virtual void recvStatusChange(Status status) 15313996Sgiacomo.travaglini@arm.com { 15413996Sgiacomo.travaglini@arm.com if (recvSnoops) { 15513996Sgiacomo.travaglini@arm.com if (status == RangeChange) { 15613996Sgiacomo.travaglini@arm.com if (!snoopRangeSent) { 15713996Sgiacomo.travaglini@arm.com snoopRangeSent = true; 15813996Sgiacomo.travaglini@arm.com sendStatusChange(Port::RangeChange); 15913996Sgiacomo.travaglini@arm.com } 16013996Sgiacomo.travaglini@arm.com return; 16113996Sgiacomo.travaglini@arm.com } 16213996Sgiacomo.travaglini@arm.com panic("Unexpected recvStatusChange\n"); 16313996Sgiacomo.travaglini@arm.com } 16413996Sgiacomo.travaglini@arm.com } 16513996Sgiacomo.travaglini@arm.com 16613996Sgiacomo.travaglini@arm.com virtual void recvRetry() ; 16713996Sgiacomo.travaglini@arm.com 16813996Sgiacomo.travaglini@arm.com virtual void getDeviceAddressRanges(AddrRangeList &resp, 16913996Sgiacomo.travaglini@arm.com bool &snoop) 17013996Sgiacomo.travaglini@arm.com { resp.clear(); snoop = recvSnoops; } 17113996Sgiacomo.travaglini@arm.com 17213996Sgiacomo.travaglini@arm.com void queueDma(PacketPtr pkt, bool front = false); 17313996Sgiacomo.travaglini@arm.com void sendDma(); 17413996Sgiacomo.travaglini@arm.com 17513996Sgiacomo.travaglini@arm.com /** event to give us a kick every time we backoff time is reached. */ 17613996Sgiacomo.travaglini@arm.com EventWrapper<DmaPort, &DmaPort::sendDma> backoffEvent; 17713996Sgiacomo.travaglini@arm.com 17813996Sgiacomo.travaglini@arm.com public: 17913996Sgiacomo.travaglini@arm.com DmaPort(MemObject *dev, System *s, Tick min_backoff, Tick max_backoff, 18013996Sgiacomo.travaglini@arm.com bool recv_snoops = false); 18113996Sgiacomo.travaglini@arm.com 18213996Sgiacomo.travaglini@arm.com void dmaAction(Packet::Command cmd, Addr addr, int size, Event *event, 18313996Sgiacomo.travaglini@arm.com uint8_t *data, Tick delay, Request::Flags flag = 0); 18413996Sgiacomo.travaglini@arm.com 18513996Sgiacomo.travaglini@arm.com bool dmaPending() { return pendingCount > 0; } 18613996Sgiacomo.travaglini@arm.com 18713996Sgiacomo.travaglini@arm.com unsigned cacheBlockSize() const { return peerBlockSize(); } 18813996Sgiacomo.travaglini@arm.com unsigned int drain(Event *de); 18913996Sgiacomo.travaglini@arm.com}; 19013996Sgiacomo.travaglini@arm.com 19113996Sgiacomo.travaglini@arm.com/** 19213996Sgiacomo.travaglini@arm.com * This device is the base class which all devices senstive to an address range 19313996Sgiacomo.travaglini@arm.com * inherit from. There are three pure virtual functions which all devices must 19413996Sgiacomo.travaglini@arm.com * implement addressRanges(), read(), and write(). The magic do choose which 19513996Sgiacomo.travaglini@arm.com * mode we are in, etc is handled by the PioPort so the device doesn't have to 19613996Sgiacomo.travaglini@arm.com * bother. 19713996Sgiacomo.travaglini@arm.com */ 19813996Sgiacomo.travaglini@arm.comclass PioDevice : public MemObject 19913996Sgiacomo.travaglini@arm.com{ 20013996Sgiacomo.travaglini@arm.com protected: 20113996Sgiacomo.travaglini@arm.com System *sys; 20213996Sgiacomo.travaglini@arm.com 20313996Sgiacomo.travaglini@arm.com /** The pioPort that handles the requests for us and provides us requests 20413996Sgiacomo.travaglini@arm.com * that it sees. */ 20513996Sgiacomo.travaglini@arm.com PioPort *pioPort; 20613996Sgiacomo.travaglini@arm.com 20713996Sgiacomo.travaglini@arm.com virtual void addressRanges(AddrRangeList &range_list) = 0; 20813996Sgiacomo.travaglini@arm.com 20913996Sgiacomo.travaglini@arm.com /** Pure virtual function that the device must implement. Called 21013996Sgiacomo.travaglini@arm.com * when a read command is recieved by the port. 21113996Sgiacomo.travaglini@arm.com * @param pkt Packet describing this request 21213996Sgiacomo.travaglini@arm.com * @return number of ticks it took to complete 21313996Sgiacomo.travaglini@arm.com */ 21413996Sgiacomo.travaglini@arm.com virtual Tick read(PacketPtr pkt) = 0; 21513996Sgiacomo.travaglini@arm.com 21613996Sgiacomo.travaglini@arm.com /** Pure virtual function that the device must implement. Called when a 21713996Sgiacomo.travaglini@arm.com * write command is recieved by the port. 21813996Sgiacomo.travaglini@arm.com * @param pkt Packet describing this request 21913996Sgiacomo.travaglini@arm.com * @return number of ticks it took to complete 22013996Sgiacomo.travaglini@arm.com */ 22113996Sgiacomo.travaglini@arm.com virtual Tick write(PacketPtr pkt) = 0; 22213996Sgiacomo.travaglini@arm.com 22313996Sgiacomo.travaglini@arm.com public: 22413996Sgiacomo.travaglini@arm.com typedef PioDeviceParams Params; 22513996Sgiacomo.travaglini@arm.com PioDevice(const Params *p); 22613996Sgiacomo.travaglini@arm.com virtual ~PioDevice(); 22713996Sgiacomo.travaglini@arm.com 22813996Sgiacomo.travaglini@arm.com const Params * 22913996Sgiacomo.travaglini@arm.com params() const 23013996Sgiacomo.travaglini@arm.com { 23113996Sgiacomo.travaglini@arm.com return dynamic_cast<const Params *>(_params); 23213996Sgiacomo.travaglini@arm.com } 23313996Sgiacomo.travaglini@arm.com 23413996Sgiacomo.travaglini@arm.com virtual void init(); 23513996Sgiacomo.travaglini@arm.com 23613996Sgiacomo.travaglini@arm.com virtual unsigned int drain(Event *de); 23713996Sgiacomo.travaglini@arm.com 23813996Sgiacomo.travaglini@arm.com virtual Port *getPort(const std::string &if_name, int idx = -1); 23913996Sgiacomo.travaglini@arm.com 24013996Sgiacomo.travaglini@arm.com friend class PioPort; 24113996Sgiacomo.travaglini@arm.com 24213996Sgiacomo.travaglini@arm.com}; 24313996Sgiacomo.travaglini@arm.com 24413996Sgiacomo.travaglini@arm.comclass BasicPioDevice : public PioDevice 24513996Sgiacomo.travaglini@arm.com{ 24613996Sgiacomo.travaglini@arm.com protected: 24713996Sgiacomo.travaglini@arm.com /** Address that the device listens to. */ 24813996Sgiacomo.travaglini@arm.com Addr pioAddr; 24913996Sgiacomo.travaglini@arm.com 25013996Sgiacomo.travaglini@arm.com /** Size that the device's address range. */ 25113996Sgiacomo.travaglini@arm.com Addr pioSize; 25213996Sgiacomo.travaglini@arm.com 25313996Sgiacomo.travaglini@arm.com /** Delay that the device experinces on an access. */ 25413996Sgiacomo.travaglini@arm.com Tick pioDelay; 25513996Sgiacomo.travaglini@arm.com 25613996Sgiacomo.travaglini@arm.com public: 25713996Sgiacomo.travaglini@arm.com typedef BasicPioDeviceParams Params; 25813996Sgiacomo.travaglini@arm.com BasicPioDevice(const Params *p); 25913996Sgiacomo.travaglini@arm.com 26013996Sgiacomo.travaglini@arm.com const Params * 26113996Sgiacomo.travaglini@arm.com params() const 26213996Sgiacomo.travaglini@arm.com { 26313996Sgiacomo.travaglini@arm.com return dynamic_cast<const Params *>(_params); 26413996Sgiacomo.travaglini@arm.com } 26513996Sgiacomo.travaglini@arm.com 26613996Sgiacomo.travaglini@arm.com /** return the address ranges that this device responds to. 26713996Sgiacomo.travaglini@arm.com * @param range_list range list to populate with ranges 26813996Sgiacomo.travaglini@arm.com */ 26913996Sgiacomo.travaglini@arm.com void addressRanges(AddrRangeList &range_list); 27013996Sgiacomo.travaglini@arm.com 27113996Sgiacomo.travaglini@arm.com}; 27213996Sgiacomo.travaglini@arm.com 27313996Sgiacomo.travaglini@arm.comclass DmaDevice : public PioDevice 27413996Sgiacomo.travaglini@arm.com{ 27513996Sgiacomo.travaglini@arm.com protected: 27613996Sgiacomo.travaglini@arm.com DmaPort *dmaPort; 27713996Sgiacomo.travaglini@arm.com 27813996Sgiacomo.travaglini@arm.com public: 27913996Sgiacomo.travaglini@arm.com typedef DmaDeviceParams Params; 28013996Sgiacomo.travaglini@arm.com DmaDevice(const Params *p); 28113996Sgiacomo.travaglini@arm.com virtual ~DmaDevice(); 28213996Sgiacomo.travaglini@arm.com 28313996Sgiacomo.travaglini@arm.com const Params * 28413996Sgiacomo.travaglini@arm.com params() const 28513996Sgiacomo.travaglini@arm.com { 28613996Sgiacomo.travaglini@arm.com return dynamic_cast<const Params *>(_params); 28713996Sgiacomo.travaglini@arm.com } 28813996Sgiacomo.travaglini@arm.com 28913996Sgiacomo.travaglini@arm.com void dmaWrite(Addr addr, int size, Event *event, uint8_t *data, Tick delay = 0) 29013996Sgiacomo.travaglini@arm.com { 29113996Sgiacomo.travaglini@arm.com dmaPort->dmaAction(MemCmd::WriteReq, addr, size, event, data, delay); 29213996Sgiacomo.travaglini@arm.com } 29313996Sgiacomo.travaglini@arm.com 29413996Sgiacomo.travaglini@arm.com void dmaRead(Addr addr, int size, Event *event, uint8_t *data, Tick delay = 0) 29513996Sgiacomo.travaglini@arm.com { 29613996Sgiacomo.travaglini@arm.com dmaPort->dmaAction(MemCmd::ReadReq, addr, size, event, data, delay); 29713996Sgiacomo.travaglini@arm.com } 29813996Sgiacomo.travaglini@arm.com 29913996Sgiacomo.travaglini@arm.com bool dmaPending() { return dmaPort->dmaPending(); } 30013996Sgiacomo.travaglini@arm.com 30113996Sgiacomo.travaglini@arm.com virtual unsigned int drain(Event *de); 30213996Sgiacomo.travaglini@arm.com 30313996Sgiacomo.travaglini@arm.com unsigned cacheBlockSize() const { return dmaPort->cacheBlockSize(); } 30413996Sgiacomo.travaglini@arm.com 30513996Sgiacomo.travaglini@arm.com virtual Port *getPort(const std::string &if_name, int idx = -1); 30613996Sgiacomo.travaglini@arm.com 30713996Sgiacomo.travaglini@arm.com friend class DmaPort; 30813996Sgiacomo.travaglini@arm.com}; 30913996Sgiacomo.travaglini@arm.com 31013996Sgiacomo.travaglini@arm.com 31113996Sgiacomo.travaglini@arm.com#endif // __DEV_IO_DEVICE_HH__ 31213996Sgiacomo.travaglini@arm.com