#include <dma_device.hh>

Inheritance diagram for DmaPort:

Classes
struct	DmaReqState

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

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

RequestPtr	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)

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. More...

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

virtual	~RequestPort ()

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

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

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

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

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

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. More...

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

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. More...

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

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

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

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

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

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

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

PortID	getId () const
	Get the port id. More...

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

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

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

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

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

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

const RequestorID	requestorId
	Id for all requests. More...

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

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. More...

void	queueDma (PacketPtr pkt)

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

Tick	recvAtomicSnoop (PacketPtr pkt) override
	Default implementations. More...

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

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

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. More...

Protected Member Functions inherited from Port
void	reportUnbound () const

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

Protected Member Functions inherited from 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. More...

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. More...

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

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

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

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

Protected Member Functions inherited from 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. More...

Protected Member Functions inherited from Drainable
	Drainable ()

virtual	~Drainable ()

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

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

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

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

uint32_t	pendingCount
	Number of outstanding packets the dma port has. More...

bool	inRetry
	If the port is currently waiting for a retry before it can send whatever it is that it's sending. More...

const uint32_t	defaultSid
	Default streamId. More...

const uint32_t	defaultSSid
	Default substreamId. More...

Protected Attributes inherited from RequestPort
SimObject &	owner

Protected Attributes inherited from 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. More...

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

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

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

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. More...

void	handleResp (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. More...

Detailed Description

Definition at line 55 of file dma_device.hh.

Constructor & Destructor Documentation

◆ DmaPort()

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

Definition at line 52 of file dma_device.cc.

References sendDma().

Member Function Documentation

◆ dmaAction() [1/2]

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

Definition at line 197 of file dma_device.cc.

References addr, data, defaultSid, defaultSSid, and MipsISA::event.

Referenced by DmaDevice::dmaRead(), DmaDevice::dmaWrite(), ArmISA::TableWalker::fetchDescriptor(), Pl111::fillFifo(), UFSHostDevice::readDevice(), DmaReadFifo::resumeFillTiming(), and UFSHostDevice::writeDevice().

◆ dmaAction() [2/2]

RequestPtr 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 148 of file dma_device.cc.

References addr, System::cacheLineSize(), data, Packet::dataStatic(), ContextSwitchTaskId::DMA, ChunkGenerator::done(), DPRINTF, MipsISA::event, queueDma(), requestorId, sendDma(), Packet::senderState, and sys.

◆ dmaPending()

bool DmaPort::dmaPending ( ) const

inline

Definition at line 160 of file dma_device.hh.

References pendingCount.

Referenced by DmaDevice::dmaPending().

◆ drain()

DrainState 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 Drainable.

Definition at line 130 of file dma_device.cc.

References DPRINTF, Drained, Draining, and pendingCount.

◆ handleResp()

void DmaPort::handleResp	(	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 63 of file dma_device.cc.

References Packet::cmdString(), DmaPort::DmaReqState::completionEvent, curTick(), DmaPort::DmaReqState::delay, device, ContextSwitchTaskId::DMA, DPRINTF, Packet::getAddr(), Packet::isResponse(), DmaPort::DmaReqState::numBytes, pendingCount, Packet::req, EventManager::schedule(), Event::scheduled(), Packet::senderState, Drainable::signalDrainDone(), and DmaPort::DmaReqState::totBytes.

Referenced by recvTimingResp(), and sendDma().

◆ queueDma()

void DmaPort::queueDma ( PacketPtr pkt )

protected

Definition at line 205 of file dma_device.cc.

References pendingCount, and transmitList.

Referenced by dmaAction().

◆ recvReqRetry()

void 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 TimingRequestProtocol.

Definition at line 141 of file dma_device.cc.

References transmitList, and trySendTimingReq().

◆ recvTimingResp()

bool DmaPort::recvTimingResp ( PacketPtr pkt )

overrideprotectedvirtual

Receive a timing response from the peer.

Implements TimingRequestProtocol.

Definition at line 106 of file dma_device.cc.

References Packet::cacheResponding(), handleResp(), Packet::hasSharers(), and Packet::req.

◆ sendDma()

void 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 244 of file dma_device.cc.

References ContextSwitchTaskId::DMA, DPRINTF, handleResp(), inRetry, System::isAtomicMode(), System::isTimingMode(), panic, Packet::req, Event::scheduled(), RequestPort::sendAtomic(), sendEvent, sys, transmitList, and trySendTimingReq().

Referenced by dmaAction(), and DmaPort().

◆ trySendTimingReq()

void DmaPort::trySendTimingReq ( )

private

Take the first packet of the transmit list and attempt to send it as a timing request.

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

Definition at line 215 of file dma_device.cc.

References Clocked::clockEdge(), Packet::cmdString(), device, ContextSwitchTaskId::DMA, DPRINTF, Packet::getAddr(), inRetry, EventManager::schedule(), sendEvent, RequestPort::sendTimingReq(), and transmitList.

Referenced by recvReqRetry(), and sendDma().

Member Data Documentation

◆ defaultSid

const uint32_t DmaPort::defaultSid

protected

Default streamId.

Definition at line 134 of file dma_device.hh.

Referenced by dmaAction().

◆ defaultSSid

const uint32_t DmaPort::defaultSSid

protected

Default substreamId.

Definition at line 137 of file dma_device.hh.

Referenced by dmaAction().

◆ device

ClockedObject* const DmaPort::device

The device that owns this port.

Definition at line 110 of file dma_device.hh.

Referenced by handleResp(), and trySendTimingReq().

◆ inRetry

bool DmaPort::inRetry

protected

If the port is currently waiting for a retry before it can send whatever it is that it's sending.

Definition at line 131 of file dma_device.hh.

Referenced by sendDma(), and trySendTimingReq().

◆ pendingCount

uint32_t DmaPort::pendingCount

protected

Number of outstanding packets the dma port has.

Definition at line 127 of file dma_device.hh.

Referenced by dmaPending(), drain(), handleResp(), and queueDma().

◆ requestorId

const RequestorID DmaPort::requestorId

Id for all requests.

Definition at line 117 of file dma_device.hh.

Referenced by dmaAction().

◆ sendEvent

EventFunctionWrapper DmaPort::sendEvent

protected

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

Definition at line 124 of file dma_device.hh.

Referenced by sendDma(), and trySendTimingReq().

◆ sys

System* const DmaPort::sys

The system that device/port are in.

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

Definition at line 114 of file dma_device.hh.

Referenced by dmaAction(), DmaReadFifo::resumeFill(), DmaReadFifo::resumeFillFunctional(), and sendDma().

◆ transmitList

std::deque<PacketPtr> DmaPort::transmitList

protected

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

Definition at line 121 of file dma_device.hh.

Referenced by queueDma(), 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

Detailed Description

Constructor & Destructor Documentation

◆ DmaPort()

Member Function Documentation

◆ dmaAction() [1/2]

◆ dmaAction() [2/2]

◆ dmaPending()

◆ drain()

◆ handleResp()

◆ queueDma()

◆ recvReqRetry()

◆ recvTimingResp()

◆ sendDma()

◆ trySendTimingReq()

Member Data Documentation

◆ defaultSid

◆ defaultSSid

◆ device

◆ inRetry

◆ pendingCount

◆ requestorId

◆ sendEvent

◆ sys

◆ transmitList