#include <dma_device.hh>

Inheritance diagram for gem5::DmaPort:

Classes
struct	DmaReqState

Public Member Functions
	DmaPort (ClockedObject dev, System s, uint32_t sid=0, uint32_t ssid=0)

void	dmaAction (Packet::Command cmd, Addr addr, int size, Event event, uint8_t data, Tick delay, Request::Flags flag=0)

void	dmaAction (Packet::Command cmd, Addr addr, int size, Event event, uint8_t data, uint32_t sid, uint32_t ssid, Tick delay, Request::Flags flag=0)

void	abortPending ()

bool	dmaPending () const

DrainState	drain () override
	Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

Public Member Functions inherited from gem5::RequestPort
	RequestPort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
	Request port.

	RequestPort (const std::string &name, PortID id=InvalidPortID)

virtual	~RequestPort ()

void	bind (Port &peer) override
	Bind this request port to a response port.

void	unbind () override
	Unbind this request port and the associated response port.

virtual bool	isSnooping () const
	Determine if this request port is snooping or not.

AddrRangeList	getAddrRanges () const
	Get the address ranges of the connected responder port.

void	printAddr (Addr a)
	Inject a PrintReq for the given address to print the state of that address throughout the memory system.

Tick	sendAtomic (PacketPtr pkt)
	Send an atomic request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses.

Tick	sendAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor)
	Send an atomic request packet like above, but also request a backdoor to the data being accessed.

void	sendFunctional (PacketPtr pkt) const
	Send a functional request packet, where the data is instantly updated everywhere in the memory system, without affecting the current state of any block or moving the block.

void	sendMemBackdoorReq (const MemBackdoorReq &req, MemBackdoorPtr &backdoor)
	Send a request for a back door to a range of memory.

bool	sendTimingReq (PacketPtr pkt)
	Attempt to send a timing request to the responder port by calling its corresponding receive function.

bool	tryTiming (PacketPtr pkt) const
	Check if the responder can handle a timing request.

bool	sendTimingSnoopResp (PacketPtr pkt)
	Attempt to send a timing snoop response packet to the response port by calling its corresponding receive function.

virtual void	sendRetryResp ()
	Send a retry to the response port that previously attempted a sendTimingResp to this request port and failed.

Public Member Functions inherited from gem5::Port
virtual	~Port ()
	Virtual destructor due to inheritance.

Port &	getPeer ()
	Return a reference to this port's peer.

const std::string	name () const
	Return port name (for DPRINTF).

PortID	getId () const
	Get the port id.

bool	isConnected () const
	Is this port currently connected to a peer?

void	takeOverFrom (Port *old)
	A utility function to make it easier to swap out ports.

Public Member Functions inherited from gem5::Drainable
DrainState	drainState () const
	Return the current drain state of an object.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Attributes
ClockedObject *const	device
	The device that owns this port.

System *const	sys
	The system that device/port are in.

const RequestorID	requestorId
	Id for all requests.

Protected Member Functions
bool	recvTimingResp (PacketPtr pkt) override
	Receive a timing response from the peer.

void	recvReqRetry () override
	Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on the peer) and was unsuccessful.

Protected Member Functions inherited from gem5::RequestPort
virtual void	recvRangeChange ()
	Called to receive an address range change from the peer response port.

Tick	recvAtomicSnoop (PacketPtr pkt) override
	Default implementations.

void	recvFunctionalSnoop (PacketPtr pkt) override
	Receive a functional snoop request packet from the peer.

void	recvTimingSnoopReq (PacketPtr pkt) override
	Receive a timing snoop request from the peer.

void	recvRetrySnoopResp () override
	Called by the peer if sendTimingSnoopResp was called on this protocol (causing recvTimingSnoopResp to be called on the peer) and was unsuccessful.

Protected Member Functions inherited from gem5::Port
void	reportUnbound () const

	Port (const std::string &_name, PortID _id)
	Abstract base class for ports.

Protected Member Functions inherited from gem5::AtomicRequestProtocol
Tick	send (AtomicResponseProtocol *peer, PacketPtr pkt)
	Send an atomic request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses.

Tick	sendBackdoor (AtomicResponseProtocol *peer, PacketPtr pkt, MemBackdoorPtr &backdoor)
	Send an atomic request packet like above, but also request a backdoor to the data being accessed.

Protected Member Functions inherited from gem5::TimingRequestProtocol
bool	sendReq (TimingResponseProtocol *peer, PacketPtr pkt)
	Attempt to send a timing request to the peer by calling its corresponding receive function.

bool	trySend (TimingResponseProtocol *peer, PacketPtr pkt) const
	Check if the peer can handle a timing request.

bool	sendSnoopResp (TimingResponseProtocol *peer, PacketPtr pkt)
	Attempt to send a timing snoop response packet to it's peer by calling its corresponding receive function.

void	sendRetryResp (TimingResponseProtocol *peer)
	Send a retry to the peer that previously attempted a sendTimingResp to this protocol and failed.

Protected Member Functions inherited from gem5::FunctionalRequestProtocol
void	send (FunctionalResponseProtocol *peer, PacketPtr pkt) const
	Send a functional request packet, where the data is instantly updated everywhere in the memory system, without affecting the current state of any block or moving the block.

void	sendMemBackdoorReq (FunctionalResponseProtocol *peer, const MemBackdoorReq &req, MemBackdoorPtr &backdoor)
	Send a request for a back door to a range of memory.

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Protected Attributes
std::deque< DmaReqState * >	transmitList
	Use a deque as we never do any insertion or removal in the middle.

EventFunctionWrapper	sendEvent
	Event used to schedule a future sending from the transmit list.

uint32_t	pendingCount = 0
	Number of outstanding packets the dma port has.

PacketPtr	inRetry = nullptr
	The packet (if any) waiting for a retry to send.

bool	retryPending = false
	Whether the other side expects us to wait for a retry.

const uint32_t	defaultSid
	Default streamId.

const uint32_t	defaultSSid
	Default substreamId.

const Addr	cacheLineSize

Protected Attributes inherited from gem5::RequestPort
SimObject &	owner

Protected Attributes inherited from gem5::Port
const PortID	id
	A numeric identifier to distinguish ports in a vector, and set to InvalidPortID in case this port is not part of a vector.

Port *	_peer
	A pointer to this port's peer.

bool	_connected
	Whether this port is currently connected to a peer port.

Private Member Functions
void	trySendTimingReq ()
	Take the first request on the transmit list and attempt to send a timing packet from it.

void	sendDma ()
	For timing, attempt to send the first item on the transmit list, and if it is successful and there are more packets waiting, then schedule the sending of the next packet.

bool	sendAtomicReq (DmaReqState *state)
	Send the next packet from a DMA request in atomic mode.

bool	sendAtomicBdReq (DmaReqState *state)
	Send the next packet from a DMA request in atomic mode, and request and/or use memory backdoors if possible.

void	handleRespPacket (PacketPtr pkt, Tick delay=0)
	Handle a response packet by updating the corresponding DMA request state to reflect the bytes received, and also update the pending request counter.

void	handleResp (DmaReqState *state, Addr addr, Addr size, Tick delay=0)

Private Attributes
AddrRangeMap< MemBackdoorPtr, 1 >	memBackdoors

Detailed Description

Definition at line 61 of file dma_device.hh.

Constructor & Destructor Documentation

◆ DmaPort()

gem5::DmaPort::DmaPort	(	ClockedObject *	dev,
		System *	s,
		uint32_t	sid = 0,
		uint32_t	ssid = 0 )

Definition at line 58 of file dma_device.cc.

References sendDma().

Member Function Documentation

◆ abortPending()

void gem5::DmaPort::abortPending ( )

Definition at line 218 of file dma_device.cc.

References gem5::curTick(), gem5::EventManager::deschedule(), device, inRetry, pendingCount, gem5::EventManager::schedule(), gem5::Event::scheduled(), sendEvent, gem5::Drainable::signalDrainDone(), state, and transmitList.

◆ dmaAction() [1/2]

void gem5::DmaPort::dmaAction	(	Packet::Command	cmd,
		Addr	addr,
		int	size,
		Event *	event,
		uint8_t *	data,
		Tick	delay,
		Request::Flags	flag = 0 )

◆ dmaAction() [2/2]

void gem5::DmaPort::dmaAction	(	Packet::Command	cmd,
		Addr	addr,
		int	size,
		Event *	event,
		uint8_t *	data,
		uint32_t	sid,
		uint32_t	ssid,
		Tick	delay,
		Request::Flags	flag = 0 )

Definition at line 189 of file dma_device.cc.

References gem5::X86ISA::addr, cacheLineSize, data, DPRINTF, gem5::MipsISA::event, requestorId, sendDma(), and transmitList.

◆ dmaPending()

bool gem5::DmaPort::dmaPending ( ) const

inline

Definition at line 213 of file dma_device.hh.

References pendingCount.

Referenced by gem5::DmaDevice::dmaPending().

◆ drain()

DrainState gem5::DmaPort::drain ( )

overridevirtual

Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

Draining is mostly used before forking and creating a check point.

This function notifies an object that it needs to drain its state.

If the object does not need further simulation to drain internal buffers, it returns DrainState::Drained and automatically switches to the Drained state. If the object needs more simulation, it returns DrainState::Draining and automatically enters the Draining state. Other return values are invalid.

Note: An object that has entered the Drained state can be disturbed by other objects in the system and consequently stop being drained. These perturbations are not visible in the drain state. The simulator therefore repeats the draining process until all objects return DrainState::Drained on the first call to drain().

Returns: DrainState::Drained if the object is drained at this point in time, DrainState::Draining if it needs further simulation.

Implements gem5::Drainable.

Definition at line 170 of file dma_device.cc.

References DPRINTF, gem5::Drained, gem5::Draining, and pendingCount.

◆ handleResp()

void gem5::DmaPort::handleResp	(	DmaReqState *	state,
		Addr	addr,
		Addr	size,
		Tick	delay = 0 )

private

Definition at line 83 of file dma_device.cc.

References gem5::X86ISA::addr, gem5::curTick(), device, DPRINTF, pendingCount, gem5::EventManager::schedule(), gem5::Drainable::signalDrainDone(), state, and gem5::MemCmd::toString().

Referenced by handleRespPacket(), and sendAtomicBdReq().

◆ handleRespPacket()

void gem5::DmaPort::handleRespPacket	(	PacketPtr	pkt,
		Tick	delay = 0 )

private

Handle a response packet by updating the corresponding DMA request state to reflect the bytes received, and also update the pending request counter.

If the DMA request that this packet is part of is complete, then signal the completion event if present, potentially with a delay added to it.

Parameters

pkt	Response packet to handler
delay	Additional delay for scheduling the completion event

Definition at line 67 of file dma_device.cc.

References gem5::Packet::getAddr(), handleResp(), gem5::Packet::isError(), gem5::Packet::isResponse(), gem5::Packet::req, gem5::Packet::senderState, state, and warn_if.

Referenced by recvTimingResp(), sendAtomicBdReq(), and sendAtomicReq().

◆ recvReqRetry()

void gem5::DmaPort::recvReqRetry ( )

overrideprotectedvirtual

Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on the peer) and was unsuccessful.

Implements gem5::TimingRequestProtocol.

Definition at line 181 of file dma_device.cc.

References retryPending, transmitList, and trySendTimingReq().

◆ recvTimingResp()

bool gem5::DmaPort::recvTimingResp ( PacketPtr pkt )

overrideprotectedvirtual

Receive a timing response from the peer.

Implements gem5::TimingRequestProtocol.

Definition at line 146 of file dma_device.cc.

References gem5::Packet::cacheResponding(), handleRespPacket(), gem5::Packet::hasSharers(), and gem5::Packet::req.

◆ sendAtomicBdReq()

bool gem5::DmaPort::sendAtomicBdReq ( DmaReqState * state )

private

Send the next packet from a DMA request in atomic mode, and request and/or use memory backdoors if possible.

Definition at line 312 of file dma_device.cc.

References gem5::PowerISA::bd, DPRINTF, handleResp(), handleRespPacket(), gem5::MemCmd::isRead(), memBackdoors, gem5::ArmISA::offset, panic, pendingCount, gem5::RequestPort::sendAtomicBackdoor(), and state.

Referenced by sendDma().

◆ sendAtomicReq()

bool gem5::DmaPort::sendAtomicReq ( DmaReqState * state )

private

Send the next packet from a DMA request in atomic mode.

Definition at line 297 of file dma_device.cc.

References DPRINTF, handleRespPacket(), pendingCount, gem5::RequestPort::sendAtomic(), and state.

Referenced by sendDma().

◆ sendDma()

void gem5::DmaPort::sendDma ( )

private

For timing, attempt to send the first item on the transmit list, and if it is successful and there are more packets waiting, then schedule the sending of the next packet.

For atomic, simply send and process everything on the transmit list.

Definition at line 385 of file dma_device.cc.

References gem5::System::bypassCaches(), gem5::ChunkGenerator::done(), DPRINTF, gem5::DmaPort::DmaReqState::gen, gem5::System::isAtomicMode(), gem5::System::isTimingMode(), panic, retryPending, gem5::Event::scheduled(), sendAtomicBdReq(), sendAtomicReq(), sendEvent, state, sys, transmitList, and trySendTimingReq().

Referenced by dmaAction(), and DmaPort().

◆ trySendTimingReq()

void gem5::DmaPort::trySendTimingReq ( )

private

Take the first request on the transmit list and attempt to send a timing packet from it.

If it is successful, schedule the sending of the next packet. Otherwise remember that we are waiting for a retry.

Definition at line 254 of file dma_device.cc.

References gem5::Clocked::clockEdge(), gem5::Packet::cmdString(), device, DPRINTF, gem5::Packet::getAddr(), inRetry, pendingCount, retryPending, gem5::EventManager::schedule(), sendEvent, gem5::RequestPort::sendTimingReq(), state, and transmitList.

Referenced by recvReqRetry(), and sendDma().

Member Data Documentation

◆ cacheLineSize

const Addr gem5::DmaPort::cacheLineSize

protected

Definition at line 190 of file dma_device.hh.

Referenced by dmaAction().

◆ defaultSid

const uint32_t gem5::DmaPort::defaultSid

protected

Default streamId.

Definition at line 185 of file dma_device.hh.

Referenced by dmaAction().

◆ defaultSSid

const uint32_t gem5::DmaPort::defaultSSid

protected

Default substreamId.

Definition at line 188 of file dma_device.hh.

Referenced by dmaAction().

◆ device

ClockedObject* const gem5::DmaPort::device

The device that owns this port.

Definition at line 157 of file dma_device.hh.

Referenced by abortPending(), handleResp(), and trySendTimingReq().

◆ inRetry

PacketPtr gem5::DmaPort::inRetry = nullptr

protected

The packet (if any) waiting for a retry to send.

Definition at line 177 of file dma_device.hh.

Referenced by abortPending(), and trySendTimingReq().

◆ memBackdoors

AddrRangeMap<MemBackdoorPtr, 1> gem5::DmaPort::memBackdoors

private

Definition at line 64 of file dma_device.hh.

Referenced by sendAtomicBdReq().

◆ pendingCount

uint32_t gem5::DmaPort::pendingCount = 0

protected

Number of outstanding packets the dma port has.

Definition at line 174 of file dma_device.hh.

Referenced by abortPending(), dmaPending(), drain(), handleResp(), sendAtomicBdReq(), sendAtomicReq(), and trySendTimingReq().

◆ requestorId

const RequestorID gem5::DmaPort::requestorId

Id for all requests.

Definition at line 164 of file dma_device.hh.

Referenced by dmaAction().

◆ retryPending

bool gem5::DmaPort::retryPending = false

protected

Whether the other side expects us to wait for a retry.

We may have decided not to actually send the packet by the time we get the retry.

Definition at line 182 of file dma_device.hh.

Referenced by recvReqRetry(), sendDma(), and trySendTimingReq().

◆ sendEvent

EventFunctionWrapper gem5::DmaPort::sendEvent

protected

Event used to schedule a future sending from the transmit list.

Definition at line 171 of file dma_device.hh.

Referenced by abortPending(), sendDma(), and trySendTimingReq().

◆ sys

System* const gem5::DmaPort::sys

The system that device/port are in.

This is used to select which mode we are currently operating in.

Definition at line 161 of file dma_device.hh.

Referenced by gem5::DmaReadFifo::resumeFill(), and sendDma().

◆ transmitList

std::deque<DmaReqState *> gem5::DmaPort::transmitList

protected

Use a deque as we never do any insertion or removal in the middle.

Definition at line 168 of file dma_device.hh.

Referenced by abortPending(), dmaAction(), recvReqRetry(), sendDma(), and trySendTimingReq().

The documentation for this class was generated from the following files:

dev/dma_device.hh
dev/dma_device.cc

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DmaPort()

Member Function Documentation

◆ abortPending()

◆ dmaAction() [1/2]

◆ dmaAction() [2/2]

◆ dmaPending()

◆ drain()

◆ handleResp()

◆ handleRespPacket()

◆ recvReqRetry()

◆ recvTimingResp()

◆ sendAtomicBdReq()

◆ sendAtomicReq()

◆ sendDma()

◆ trySendTimingReq()

Member Data Documentation

◆ cacheLineSize

◆ defaultSid

◆ defaultSSid

◆ device

◆ inRetry

◆ memBackdoors

◆ pendingCount

◆ requestorId

◆ retryPending

◆ sendEvent

◆ sys

◆ transmitList