Inheritance diagram for VirtioScsiController:

Collaboration diagram for VirtioScsiController:

Public Member Functions
	VirtioScsiController (Device *pci)

bool	initialiseController ()

void	shutdown ()

bool	sendCommand (size_t unit, uintptr_t command, uint8_t commandBytes, uintptr_t data, uint16_t dataBytes, bool writing) override

IrqDisposition	irq (irq_id_t number) override

Public Member Functions inherited from ScsiController
	ScsiController (Controller *pDev, bool startWorker=true)

bool	prepareDiskRemoval ()

void	cancelDiskRemoval ()

virtual bool	supportsConcurrentReads () const

virtual uint64_t	executeRequest (uint64_t p1, uint64_t p2, uint64_t p3, uint64_t p4, uint64_t p5, uint64_t p6, uint64_t p7, uint64_t p8)

Public Member Functions inherited from Controller
	Controller (Device *pDev)

virtual Type	getType ()

virtual void	getName (String &str)

virtual void	dump (String &str)

Public Member Functions inherited from Device
	Device (Device *p)

Device *	getParent () const

void	setParent (Device *p)

virtual const String &	getSpecificType ()

virtual void	setSpecificType (String str)

void	setPciPosition (uint32_t bus, uint32_t device, uint32_t func)

void	setPciIdentifiers (uint8_t classCode, uint8_t subclassCode, uint16_t vendorId, uint16_t deviceId, uint8_t progIf)

void	setPciConfigHeader (const PciBus::ConfigSpace &space)

PciBus::ConfigSpace	getPciConfigHeader () const

uint8_t	getPciClassCode ()

uint8_t	getPciSubclassCode ()

uint16_t	getPciVendorId ()

uint16_t	getPciDeviceId ()

uint8_t	getPciProgInterface ()

uint32_t	getPciBusPosition ()

uint32_t	getPciDevicePosition ()

uint32_t	getPciFunctionNumber ()

Device *	getPhysicalFunction () const

size_t	getVirtualFunctionIndex () const

void	setVirtualFunction (Device *physicalFunction, size_t index)

virtual Vector< Address * > &	addresses ()

virtual uintptr_t	getInterruptNumber ()

virtual void	setInterruptNumber (uintptr_t n)

void	addChild (Device *pDevice)

Device *	getChild (size_t n)

size_t	getNumChildren ()

void	removeChild (size_t n)

void	removeChild (Device *d)

void	replaceChild (Device src, Device dest)

Public Member Functions inherited from RequestQueue
	RequestQueue (const String &name)

virtual void	initialise ()

virtual void	destroy ()

MUST_USE_RESULT uint64_t	addRequest (size_t priority, uint64_t p1=0, uint64_t p2=0, uint64_t p3=0, uint64_t p4=0, uint64_t p5=0, uint64_t p6=0, uint64_t p7=0, uint64_t p8=0)

MUST_USE_RESULT uint64_t	addRequest (size_t priority, ActionOnDuplicate action, uint64_t p1=0, uint64_t p2=0, uint64_t p3=0, uint64_t p4=0, uint64_t p5=0, uint64_t p6=0, uint64_t p7=0, uint64_t p8=0)

uint64_t	addAsyncRequest (size_t priority, uint64_t p1=0, uint64_t p2=0, uint64_t p3=0, uint64_t p4=0, uint64_t p5=0, uint64_t p6=0, uint64_t p7=0, uint64_t p8=0)

MUST_USE_RESULT bool	publishAsyncRequest (size_t priority, uint64_t p1=0, uint64_t p2=0, uint64_t p3=0, uint64_t p4=0, uint64_t p5=0, uint64_t p6=0, uint64_t p7=0, uint64_t p8=0)

bool	canWaitForCompletion ()

MUST_USE_RESULT bool	waitForPreallocated (PreallocatedRequest &request)

MUST_USE_RESULT PreallocatedPublishResult	publishPreallocated (PreallocatedRequest &request, size_t priority, uint64_t p1=0, uint64_t p2=0, uint64_t p3=0, uint64_t p4=0, uint64_t p5=0, uint64_t p6=0, uint64_t p7=0, uint64_t p8=0)

MUST_USE_RESULT PreallocatedPublishResult	republishPreallocatedWhileReleasing (PreallocatedRequest &request, size_t priority, uint64_t p1=0, uint64_t p2=0, uint64_t p3=0, uint64_t p4=0, uint64_t p5=0, uint64_t p6=0, uint64_t p7=0, uint64_t p8=0)

MUST_USE_RESULT bool	halt ()

MUST_USE_RESULT bool	resume ()

LifecycleState	getLifecycleState ()

bool	drain ()

Public Member Functions inherited from IrqHandler
virtual bool	acceptsSpuriousInterrupts () const

Protected Member Functions
size_t	getNumUnits () override

Protected Member Functions inherited from ScsiController
virtual void	cancelRequest (const Request &request)

void	shutdownDiskCaches ()

void	searchDisks ()

Protected Member Functions inherited from Device
	NOT_COPYABLE_OR_ASSIGNABLE (Device)

Protected Member Functions inherited from RequestQueue
virtual bool	workerPlacement (ThreadPlacement &) const

	RequestQueue (const RequestQueue &)

void	operator= (const RequestQueue &)

virtual bool	compareRequests (const Request &a, const Request &b)

int	work ()

NextRequestResult	getNextRequest (Request *&request)

bool	drainIntakeLocked (size_t priority)

void	publishRequest (Request *request)

Request *	findDuplicate (const Request &request)

void	discardRequest (Request *request)

uint64_t	addAsyncRequestInternal (size_t priority, uint64_t p1, uint64_t p2, uint64_t p3, uint64_t p4, uint64_t p5, uint64_t p6, uint64_t p7, uint64_t p8)

PreallocatedPublishResult	publishPreallocatedRequest (PreallocatedRequest &request, PreallocatedRequest::State availableState, size_t priority, uint64_t p1, uint64_t p2, uint64_t p3, uint64_t p4, uint64_t p5, uint64_t p6, uint64_t p7, uint64_t p8)

void	releasePreallocatedRequest (Request *request)

void	invokeCancelRequest (const Request &request)

bool	callbackActiveOnCurrentThread () const

void	releaseRequest (Request *request)

uint64_t	waitForRequest (Request *request)

bool	startWorker ()

bool	stopWorker ()

void	closePreallocatedAdmission ()

void	waitForPreallocatedPublishers ()

Protected Member Functions inherited from IrqHandler
virtual	~IrqHandler ()

Protected Member Functions inherited from IrqHandlerBase
virtual	~IrqHandlerBase ()

Private Types
enum class	Result { Success , DeviceError , TransportError }

Private Member Functions
Result	command (uint8_t target, const void cdb, size_t cdbBytes, void data, size_t dataBytes, bool writing, bool interruptProbe)

void	drainCompletions (bool fromInterrupt)

void	failController ()

Private Attributes
Device *	m_Pci

Virtio::PciTransport	m_Transport

Virtio::Queue	m_RequestQueue

MemoryRegion	m_Control

MemoryRegion	m_Data

Mutex	m_CommandLock

Mutex	m_IrqLock

Semaphore	m_Completion

irq_id_t	m_Irq

uint8_t	m_Targets [256]

size_t	m_UnitCount

size_t	m_CdbBytes

size_t	m_SenseBytes

size_t	m_CommandUsed

size_t	m_InterruptCompletions

bool	m_TransportInitialised

bool	m_Ready

bool	m_CommandSeen

bool	m_CommandValid

bool	m_Stopping

bool	m_Failed

bool	m_Shutdown

Additional Inherited Members
Public Types inherited from Device
enum	Type { Generic , Root , Disk , Bus , Display , Network , Sound , Console , Mouse , Controller , UsbController , UsbGeneric , UsbContainer }

typedef Device (	Callback) (Device *)

Public Types inherited from RequestQueue
enum class	OverrunStatus { Clear , Armed , Stalled , Overloaded }

enum class	PreallocatedPublishResult { Accepted , TokenBusy , QueueStopped , QueueFull , InvalidPriority }

enum	ActionOnDuplicate { Block , NewRequest , ReturnImmediately }

enum class	LifecycleState { Stopped , Accepting , Stopping , Destroyed }

Static Public Member Functions inherited from Device
static bool	treeLockHeldByCurrentThread ()

static void	foreach (Callback callback, Device *root=0)

template<class F , class... Args>
static void	foreach (pedigree_std::Callable< F > &callback, Device *root, Args... args)

static void	addToRoot (Device *device)

static void	searchByVendorId (uint16_t vendorId, void(callback)(Device ), Device *root=0)

static void	searchByVendorIdAndDeviceId (uint16_t vendorId, uint16_t deviceId, void(callback)(Device ), Device *root=0)

static void	searchByClass (uint16_t classCode, void(callback)(Device ), Device *root=0)

static void	searchByClassAndSubclass (uint16_t classCode, uint16_t subclassCode, void(callback)(Device ), Device *root=0)

static void	searchByClassSubclassAndProgInterface (uint16_t classCode, uint16_t subclassCode, uint8_t progInterface, void(callback)(Device ), Device *root=0)

Protected Types inherited from RequestQueue
enum class	NextRequestResult { Item , Empty , Retry }

Static Protected Member Functions inherited from Device
static Device &	root ()

Static Protected Member Functions inherited from RequestQueue
static int	trampoline (void *p)

static void	completeRequest (Request *request, uint64_t returnValue, bool rejected)

static void	retainRequest (Request *request)

Protected Attributes inherited from Device
Vector< Address * >	m_Addresses

Vector< Device * >	m_Children

Device *	m_pParent

Device *	m_PhysicalFunction

size_t	m_VirtualFunctionIndex

uintptr_t	m_InterruptNumber

String	m_SpecificType

PciBus::ConfigSpace	m_ConfigHeader

uint8_t	m_ClassCode

uint8_t	m_SubclassCode

uint16_t	m_VendorId

uint16_t	m_DeviceId

uint8_t	m_ProgInterface

uint32_t	m_PciBusPos

uint32_t	m_PciDevicePos

uint32_t	m_PciFunctionNum

Protected Attributes inherited from RequestQueue
IntakeLane	m_IntakeLanes [REQUEST_QUEUE_NUM_PRIORITIES]

Request *	m_pRequestQueue [REQUEST_QUEUE_NUM_PRIORITIES]

Request *	m_pRequestQueueTail [REQUEST_QUEUE_NUM_PRIORITIES]

Request *	m_pActiveRequest

Atomic< size_t >	m_State

Mutex	m_LifecycleMutex

WaitQueue	m_RequestQueueWaiters

WaitQueue	m_WorkerWaiters

Thread *	m_pThread

Atomic< PerProcessorScheduler * >	m_pWorkerScheduler

SchedulerWorkerWake	m_WorkerWake

Atomic< size_t >	m_bWorkerReady

Atomic< size_t >	m_bWorkerActive

size_t	m_WorkerProgressGeneration

RequestQueueOverrunChecker	m_OverrunChecker

Timer *	m_pOverrunTimer

Atomic< size_t >	m_PublicationState

size_t	m_nMaxAsyncRequests

Atomic< size_t >	m_nAsyncRequests

Atomic< size_t >	m_nTotalRequests

Atomic< size_t >	m_nActiveRequests

NormalStaticString	m_Name

Static Protected Attributes inherited from Device
static Device	m_Root

static Mutex	m_TreeLock

Static Protected Attributes inherited from RequestQueue
static constexpr size_t	PublicationClosed = static_cast<size_t>(1) << ((sizeof(size_t) * 8) - 1)

static constexpr size_t	PublicationCountMask = ~PublicationClosed

Detailed Description

Definition at line 14 of file VirtioScsiController.h.

Member Enumeration Documentation

◆ Result

enum class VirtioScsiController::Result

strongprivate

Definition at line 32 of file VirtioScsiController.h.

Constructor & Destructor Documentation

◆ VirtioScsiController()

VirtioScsiController::VirtioScsiController ( Device * pci )

explicit

Definition at line 48 of file VirtioScsiController.cc.

◆ ~VirtioScsiController()

VirtioScsiController::~VirtioScsiController ( )

override

Definition at line 71 of file VirtioScsiController.cc.

Member Function Documentation

◆ command()

VirtioScsiController::Result VirtioScsiController::command	(	uint8_t	target,
		const void *	cdb,
		size_t	cdbBytes,
		void *	data,
		size_t	dataBytes,
		bool	writing,
		bool	interruptProbe
	)

private

Definition at line 208 of file VirtioScsiController.cc.

◆ drainCompletions()

void VirtioScsiController::drainCompletions ( bool fromInterrupt )

private

Definition at line 153 of file VirtioScsiController.cc.

◆ failController()

void VirtioScsiController::failController ( )

private

Definition at line 192 of file VirtioScsiController.cc.

◆ getNumUnits()

size_t VirtioScsiController::getNumUnits ( )

inlineoverrideprotectedvirtual

Implements ScsiController.

Definition at line 27 of file VirtioScsiController.h.

◆ initialiseController()

bool VirtioScsiController::initialiseController ( )

Definition at line 75 of file VirtioScsiController.cc.

◆ irq()

IrqDisposition VirtioScsiController::irq ( irq_id_t number )

overridevirtual

Handles a pending IRQ in thread context.

Implements IrqHandler.

Definition at line 170 of file VirtioScsiController.cc.

References Quiesced, and Semaphore::release().

◆ sendCommand()

bool VirtioScsiController::sendCommand	(	size_t	unit,
		uintptr_t	command,
		uint8_t	commandBytes,
		uintptr_t	data,
		uint16_t	dataBytes,
		bool	writing
	)

overridevirtual

Implements ScsiController.

Definition at line 307 of file VirtioScsiController.cc.

◆ shutdown()

void VirtioScsiController::shutdown ( )

Definition at line 316 of file VirtioScsiController.cc.

Member Data Documentation

◆ m_CdbBytes

size_t VirtioScsiController::m_CdbBytes

private

Definition at line 50 of file VirtioScsiController.h.

◆ m_CommandLock

Mutex VirtioScsiController::m_CommandLock

private

Definition at line 44 of file VirtioScsiController.h.

◆ m_CommandSeen

bool VirtioScsiController::m_CommandSeen

private

Definition at line 56 of file VirtioScsiController.h.

◆ m_CommandUsed

size_t VirtioScsiController::m_CommandUsed

private

Definition at line 52 of file VirtioScsiController.h.

◆ m_CommandValid

bool VirtioScsiController::m_CommandValid

private

Definition at line 57 of file VirtioScsiController.h.

◆ m_Completion

Semaphore VirtioScsiController::m_Completion

private

Definition at line 46 of file VirtioScsiController.h.

◆ m_Control

MemoryRegion VirtioScsiController::m_Control

private

Definition at line 42 of file VirtioScsiController.h.

◆ m_Data

MemoryRegion VirtioScsiController::m_Data

private

Definition at line 43 of file VirtioScsiController.h.

◆ m_Failed

bool VirtioScsiController::m_Failed

private

Definition at line 59 of file VirtioScsiController.h.

◆ m_InterruptCompletions

size_t VirtioScsiController::m_InterruptCompletions

private

Definition at line 53 of file VirtioScsiController.h.

◆ m_Irq

irq_id_t VirtioScsiController::m_Irq

private

Definition at line 47 of file VirtioScsiController.h.

◆ m_IrqLock

Mutex VirtioScsiController::m_IrqLock

private

Definition at line 45 of file VirtioScsiController.h.

◆ m_Pci

Device* VirtioScsiController::m_Pci

private

Definition at line 39 of file VirtioScsiController.h.

◆ m_Ready

bool VirtioScsiController::m_Ready

private

Definition at line 55 of file VirtioScsiController.h.

◆ m_RequestQueue

Virtio::Queue VirtioScsiController::m_RequestQueue

private

Definition at line 41 of file VirtioScsiController.h.

◆ m_SenseBytes

size_t VirtioScsiController::m_SenseBytes

private

Definition at line 51 of file VirtioScsiController.h.

◆ m_Shutdown

bool VirtioScsiController::m_Shutdown

private

Definition at line 60 of file VirtioScsiController.h.

◆ m_Stopping

bool VirtioScsiController::m_Stopping

private

Definition at line 58 of file VirtioScsiController.h.

◆ m_Targets

uint8_t VirtioScsiController::m_Targets[256]

private

Definition at line 48 of file VirtioScsiController.h.

◆ m_Transport

Virtio::PciTransport VirtioScsiController::m_Transport

private

Definition at line 40 of file VirtioScsiController.h.

◆ m_TransportInitialised

bool VirtioScsiController::m_TransportInitialised

private

Definition at line 54 of file VirtioScsiController.h.

◆ m_UnitCount

size_t VirtioScsiController::m_UnitCount

private

Definition at line 49 of file VirtioScsiController.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Result

Constructor & Destructor Documentation

◆ VirtioScsiController()

◆ ~VirtioScsiController()

Member Function Documentation

◆ command()

◆ drainCompletions()

◆ failController()

◆ getNumUnits()

◆ initialiseController()

◆ irq()

◆ sendCommand()

◆ shutdown()

Member Data Documentation

◆ m_CdbBytes

◆ m_CommandLock

◆ m_CommandSeen

◆ m_CommandUsed

◆ m_CommandValid

◆ m_Completion

◆ m_Control

◆ m_Data

◆ m_Failed

◆ m_InterruptCompletions

◆ m_Irq

◆ m_IrqLock

◆ m_Pci

◆ m_Ready

◆ m_RequestQueue

◆ m_SenseBytes

◆ m_Shutdown

◆ m_Stopping

◆ m_Targets

◆ m_Transport

◆ m_TransportInitialised

◆ m_UnitCount