device layer: This is your Logic unit This layer implements the SCSI functionality of the UFS Device One logic unit controls one or more disk partitions More...

Inheritance diagram for gem5::UFSHostDevice::UFSSCSIDevice:

Public Types
using	Callback = std::function<void()>

Public Member Functions
	UFSSCSIDevice (const UFSHostDeviceParams &p, uint32_t lun_id, const Callback &transfer_cb, const Callback &read_cb)
	Constructor and destructor.

	~UFSSCSIDevice ()

struct SCSIReply	SCSICMDHandle (uint32_t *SCSI_msg)
	SCSI command handle function; determines what the command is and returns a reply structure that allows the host device to continue with the transfer.

void	readFlash (uint8_t *readaddr, uint64_t offset, uint32_t size)
	Disk access functions.

void	writeFlash (uint8_t *writeaddr, uint64_t offset, uint32_t size)
	Write flash.

bool	finishedCommand () const
	finished command.

void	clearSignal ()
	Clear signal.

bool	finishedRead () const
	Finished read.

void	clearReadSignal ()
	Clear signal.

void	SSDReadStart (uint32_t total_read)
	Start the transactions to (and from) the disk The host will queue all the transactions.

void	SSDWriteStart ()
	SSD write start.

void	setTotalWrite (uint32_t total_write)
	Sets total amount of write transactions that needs to be made.

Public Attributes
transferDoneInfo	transferInfo
	End of transfer information.

std::deque< struct SCSIResumeInfo >	SCSIInfoQueue
	Information message queues, as there can be multiple messages queued for handling in this system.

std::deque< struct transferInfo >	SSDReadInfo
	SSDReadInfo: Structure from disk to dma, that contains data, and helper info to get it to the right place in the memory.

std::deque< struct transferInfo >	SSDWriteDoneInfo
	SSDWriteDoneInfo: Structure from dma to disk, that contains data, and helper info to get it to the right place in the memory.

Private Types
enum	SCSICommandSet { SCSIInquiry = 0x12 , SCSIRead6 = 0x08 , SCSIRead10 = 0x28 , SCSIRead16 = 0x88 , SCSIReadCapacity10 = 0x25 , SCSIReadCapacity16 = 0x9E , SCSIReportLUNs = 0xA0 , SCSIStartStop = 0x1B , SCSITestUnitReady = 0x00 , SCSIVerify10 = 0x2F , SCSIWrite6 = 0x0A , SCSIWrite10 = 0x2A , SCSIWrite16 = 0x8A , SCSIFormatUnit = 0x04 , SCSISendDiagnostic = 0x1D , SCSISynchronizeCache = 0x35 , SCSIModeSelect10 = 0x55 , SCSIModeSense6 = 0x1A , SCSIModeSense10 = 0x5A , SCSIRequestSense = 0x03 , SCSIUnmap = 0x42 , SCSIWriteBuffer = 0x3B , SCSIReadBuffer = 0x3C , SCSIMaintenanceIn = 0xA3 }

enum	SCSIStatusCodes { SCSIGood = 0x00 , SCSICheckCondition = 0x02 , SCSIConditionGood = 0x04 , SCSIBusy = 0x08 , SCSIIntermediateGood = 0x10 , SCSIIntermediatCGood = 0x14 , SCSIReservationConflict = 0x18 , SCSICommandTerminated = 0x22 , SCSITaskSetFull = 0x28 , SCSIACAActive = 0x30 , SCSITaskAborted = 0x40 }

enum	SCSISenseCodes { SCSINoSense = 0x00 , SCSIRecoverdError = 0x01 , SCSINotReady = 0x02 , SCSIMediumError = 0x03 , SCSIHardwareError = 0x04 , SCSIIllegalRequest = 0x05 , SCSIUnitAttention = 0x06 , SCSIDataProtect = 0x07 , SCSIBlankCheck = 0x08 , SCSIAbortedCommand = 0x0B , SCSIVolumeOverflow = 0x0D , SCSIMisCompare = 0x0E }

Private Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Private Member Functions
void	readCallback ()
	Functions to indicate that the action to the SSD has completed.

void	SSDReadDone ()
	SSD Read done; Determines if the final callback of the transaction should be made at the end of a read transfer.

void	SSDWriteDone ()
	SSD Write Done; This is the callback function for the memory model.

void	statusCheck (uint8_t status, uint8_t *sensecodelist)
	Status of SCSI.

void	setSignal ()
	set signal to indicate that the transaction has been completed.

void	setReadSignal ()
	set signal to indicate that the read action has been completed

Private Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected.

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

virtual void	startup ()
	startup() is the final initialization call before simulation.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Private Member Functions inherited from gem5::EventManager
EventQueue *	eventQueue () const

void	schedule (Event &event, Tick when)

void	deschedule (Event &event)

void	reschedule (Event &event, Tick when, bool always=false)

void	schedule (Event *event, Tick when)

void	deschedule (Event *event)

void	reschedule (Event *event, Tick when, bool always=false)

void	wakeupEventQueue (Tick when=(Tick) -1)
	This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

Private Member Functions inherited from gem5::Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

void	unserializeSection (CheckpointIn &cp, const std::string &name)

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

	Drainable ()

virtual	~Drainable ()

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

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

Private Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Private Member Functions inherited from gem5::Named
	Named (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

Private Attributes
DiskImage *	flashDisk
	The objects this model links to.

AbstractNVM *	flashDevice

const uint32_t	blkSize
	Logic unit dimensions.

const uint32_t	lunAvail

const uint64_t	diskSize

const uint32_t	capacityLower

const uint32_t	capacityUpper

struct LUNInfo	lunInfo
	Logic unit info; needed for SCSI Info messages and LU identification.

const uint32_t	lunID

bool	transferCompleted
	Signals to Host layer 1: signal for transaction completion 2: signal for read action completion.

bool	readCompleted

uint32_t	totalRead
	Total amount transactions that need to be made.

uint32_t	totalWrite

uint32_t	amountOfWriteTransfers
	transaction progress tracking

uint32_t	amountOfReadTransfers

Callback	signalDone
	Callbacks between Host and Device.

Callback	deviceReadCallback

Callback	memReadCallback
	Callbacks between Device and Memory.

Callback	memWriteCallback

Private Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Private Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

Static Private Attributes
static const unsigned int	UPIUHeaderDataIndWord0 = 0x0000C022

static const unsigned int	UPIUHeaderDataIndWord1 = 0x00000000

static const unsigned int	UPIUHeaderDataIndWord2 = 0x40000000

static const unsigned int	controlPage [3]
	These pages are SCSI specific.

static const unsigned int	recoveryPage [3]

static const unsigned int	cachingPage [5]

Additional Inherited Members
Static Private Member Functions inherited from gem5::SimObject
static void	serializeAll (const std::string &cpt_dir)
	Create a checkpoint by serializing all SimObjects in the system.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Private Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Detailed Description

device layer: This is your Logic unit This layer implements the SCSI functionality of the UFS Device One logic unit controls one or more disk partitions

Definition at line 559 of file ufs_device.hh.

Member Typedef Documentation

◆ Callback

using gem5::UFSHostDevice::UFSSCSIDevice::Callback = std::function<void()>

Definition at line 562 of file ufs_device.hh.

Member Enumeration Documentation

◆ SCSICommandSet

enum gem5::UFSHostDevice::UFSSCSIDevice::SCSICommandSet

private

Enumerator
SCSIInquiry
SCSIRead6
SCSIRead10
SCSIRead16
SCSIReadCapacity10
SCSIReadCapacity16
SCSIReportLUNs
SCSIStartStop
SCSITestUnitReady
SCSIVerify10
SCSIWrite6
SCSIWrite10
SCSIWrite16
SCSIFormatUnit
SCSISendDiagnostic
SCSISynchronizeCache
SCSIModeSelect10
SCSIModeSense6
SCSIModeSense10
SCSIRequestSense
SCSIUnmap
SCSIWriteBuffer
SCSIReadBuffer
SCSIMaintenanceIn

Definition at line 782 of file ufs_device.hh.

◆ SCSISenseCodes

enum gem5::UFSHostDevice::UFSSCSIDevice::SCSISenseCodes

private

Enumerator
SCSINoSense
SCSIRecoverdError
SCSINotReady
SCSIMediumError
SCSIHardwareError
SCSIIllegalRequest
SCSIUnitAttention
SCSIDataProtect
SCSIBlankCheck
SCSIAbortedCommand
SCSIVolumeOverflow
SCSIMisCompare

Definition at line 835 of file ufs_device.hh.

◆ SCSIStatusCodes

enum gem5::UFSHostDevice::UFSSCSIDevice::SCSIStatusCodes

private

Enumerator
SCSIGood
SCSICheckCondition
SCSIConditionGood
SCSIBusy
SCSIIntermediateGood
SCSIIntermediatCGood
SCSIReservationConflict
SCSICommandTerminated
SCSITaskSetFull
SCSIACAActive
SCSITaskAborted

Definition at line 816 of file ufs_device.hh.

Constructor & Destructor Documentation

◆ UFSSCSIDevice()

gem5::UFSHostDevice::UFSSCSIDevice::UFSSCSIDevice	(	const UFSHostDeviceParams &	p,
		uint32_t	lun_id,
		const Callback &	transfer_cb,
		const Callback &	read_cb )

Constructor and destructor.

Constructor and destructor functions of UFSHCM device.

These callbacks are used to communicate the events that are triggered upstream; e.g. from the Memory Device to the UFS SCSI Device or from the UFS SCSI device to the UFS host.

make ascii out of lun_id (and add more characters) UFS allows up to 8 logic units, so the numbering should work out

Definition at line 78 of file ufs_device.cc.

◆ ~UFSSCSIDevice()

gem5::UFSHostDevice::UFSSCSIDevice::~UFSSCSIDevice ( )

Definition at line 146 of file ufs_device.cc.

Member Function Documentation

◆ clearReadSignal()

void gem5::UFSHostDevice::UFSSCSIDevice::clearReadSignal ( )

inline

Clear signal.

Handle for the host to clear the read complete signal.

Definition at line 620 of file ufs_device.hh.

References readCompleted.

◆ clearSignal()

void gem5::UFSHostDevice::UFSSCSIDevice::clearSignal ( )

inline

Clear signal.

Handle for the host to clear the transfer complete signal.

Definition at line 605 of file ufs_device.hh.

References transferCompleted.

◆ finishedCommand()

bool gem5::UFSHostDevice::UFSSCSIDevice::finishedCommand ( ) const

inline

finished command.

Probe to find out wether this logic unit finished its transfer and triggered the callback; The host needs this to handle the final part of the transaction.

Definition at line 599 of file ufs_device.hh.

References transferCompleted.

◆ finishedRead()

bool gem5::UFSHostDevice::UFSSCSIDevice::finishedRead ( ) const

inline

Finished read.

Probe to find out which logic unit finished its read. This is needed, because multiple units can do transactions at the same time, and need to push back data at the right time in the right order. (because writes work the other way round, they do not need this mechanism)

Definition at line 614 of file ufs_device.hh.

References readCompleted.

◆ readCallback()

void gem5::UFSHostDevice::UFSSCSIDevice::readCallback ( )

private

Functions to indicate that the action to the SSD has completed.

Read callback, on the way from the disk to the DMA.

Read Call back; This is the callback function for the memory model

Called by the flash layer. Intermediate step to the host layer

Callback; make sure data is transfered upstream: UFSHostDevice::readCallback

Definition at line 2198 of file ufs_device.cc.

Referenced by UFSSCSIDevice().

◆ readFlash()

void gem5::UFSHostDevice::UFSSCSIDevice::readFlash	(	uint8_t *	readaddr,
		uint64_t	offset,
		uint32_t	size )

Disk access functions.

read from the flashdisk

These will transfer the data from/to the disk Read flash. read the data from the disk image. This function doesn't model timing behaviour

read from image, and get to memory

Definition at line 691 of file ufs_device.cc.

References gem5::X86ISA::count, gem5::ArmISA::offset, and SectorSize.

◆ SCSICMDHandle()

struct UFSHostDevice::SCSIReply gem5::UFSHostDevice::UFSSCSIDevice::SCSICMDHandle ( uint32_t * SCSI_msg )

SCSI command handle function; determines what the command is and returns a reply structure that allows the host device to continue with the transfer.

UFS specific SCSI handling function.

The following attributes may still be added: SCSI format unit, Send diagnostic and UNMAP; Synchronize Cache and buffer read/write could not be tested yet All parameters can be found in: Universal Flash Storage (UFS) JESD220 FEB 2011 (JEDEC) http://www.jedec.org/standards-documents/results/jesd220 (a JEDEC acount may be required {free of charge})

Create the standard SCSI reponse information These values might changes over the course of a transfer

Determine what the message is and fill the response packet

SCSI inquiry: tell about this specific logic unit

Read command. Number indicates the length of the command.

BE and not nicely aligned. Apart from that it only has information in five bits of the first byte that is relevant for this field.