NVMe device access. More...

#include <dev_interface.h>

Collaboration diagram for nvme_device:

[legend]

Public Member Functions
virtual bool	nvme_pass_through (const nvme_cmd_in &in, nvme_cmd_out &out)=0
	NVMe pass through.

unsigned	get_nsid () const
	Get namespace id.

Public Member Functions inherited from smart_device
virtual	~smart_device ()

bool	is_ata () const
	Return true if ATA device.

bool	is_scsi () const
	Return true if SCSI device.

bool	is_nvme () const
	Return true if NVMe device.

ata_device *	to_ata ()
	Downcast to ATA device.

const ata_device *	to_ata () const
	Downcast to ATA device (const).

scsi_device *	to_scsi ()
	Downcast to SCSI device.

const scsi_device *	to_scsi () const
	Downcast to SCSI device (const).

nvme_device *	to_nvme ()
	Downcast to NVMe device.

const nvme_device *	to_nvme () const
	Downcast to NVMe device (const).

const device_info &	get_info () const
	Get device info struct.

const char *	get_dev_name () const
	Get device (path)name.

const char *	get_info_name () const
	Get informal name.

const char *	get_dev_type () const
	Get device type.

const char *	get_req_type () const
	Get type requested by user, empty if none.

const error_info &	get_err () const
	Get last error info struct.

int	get_errno () const
	Get last error number.

const char *	get_errmsg () const
	Get last error message.

virtual bool	is_syscall_unsup () const
	Return true if last error indicates an unsupported system call.

bool	set_err (int no, const char *msg,...) __attribute_format_printf(3
	Set last error number and message.

bool bool	set_err (const error_info &err)
	Set last error info struct.

void	clear_err ()
	Clear last error info.

bool	set_err (int no)
	Set last error number and default message.

virtual bool	is_open () const =0
	Return true if device is open.

virtual bool	open ()=0
	Open device, return false on error.

virtual bool	close ()=0
	Close device, return false on error.

virtual smart_device *	autodetect_open ()
	Open device with autodetection support.

virtual bool	is_powered_down ()
	Early test if device is powered up or down.

virtual bool	owns (const smart_device *dev) const
	Return true if other device is owned by this device.

virtual void	release (const smart_device *dev)
	Release ownership of other device.

Protected Member Functions
void	hide_nvme (bool hide=true)
	Hide/unhide NVMe interface.

	nvme_device (unsigned nsid)
	Constructor requires namespace ID, registers device as NVMe.

void	set_nsid (unsigned nsid)
	Set namespace id.

bool	set_nvme_err (nvme_cmd_out &out, unsigned status, const char *msg=0)
	Set last error number and message if pass-through returns NVMe error status.

Protected Member Functions inherited from smart_device
	smart_device (smart_interface intf, const char dev_name, const char dev_type, const char req_type)
	Constructor to init interface and device info.

	smart_device (do_not_use_in_implementation_classes)
	Dummy constructor for abstract classes.

device_info &	set_info ()
	R/W access to device info struct.

smart_interface *	smi ()
	Get interface which produced this object.

const smart_interface *	smi () const
	Get interface which produced this object (const).

Private Attributes
unsigned	m_nsid

Additional Inherited Members
Static Public Member Functions inherited from smart_device
static int	get_num_objects ()
	Get current number of allocated 'smart_device' objects.

Protected Types inherited from smart_device
enum	do_not_use_in_implementation_classes { never_called }
	Dummy enum for dummy constructor. More...

Detailed Description

NVMe device access.

Definition at line 702 of file dev_interface.h.

Constructor & Destructor Documentation

◆ nvme_device()

nvme_device::nvme_device ( unsigned nsid )

inlineexplicitprotected

Constructor requires namespace ID, registers device as NVMe.

Definition at line 720 of file dev_interface.h.

Member Function Documentation

◆ get_nsid()

unsigned nvme_device::get_nsid ( ) const

inline

Get namespace id.

Definition at line 711 of file dev_interface.h.

◆ hide_nvme()

void nvme_device::hide_nvme ( bool hide = true )

inlineprotected

Hide/unhide NVMe interface.

Definition at line 716 of file dev_interface.h.

◆ nvme_pass_through()

virtual bool nvme_device::nvme_pass_through	(	const nvme_cmd_in &	in,
		nvme_cmd_out &	out
	)

pure virtual

NVMe pass through.

Return false on error.

Implemented in os::darwin_nvme_device, os_freebsd::freebsd_nvme_device, os_linux::linux_nvme_device, os_netbsd::netbsd_nvme_device, os_openbsd::openbsd_nvme_device, os_win32::win_nvme_device, os_win32::win10_nvme_device, snt::sntasmedia_device, snt::sntjmicron_device, and snt::sntrealtek_device.

◆ set_nsid()

void nvme_device::set_nsid ( unsigned nsid )

inlineprotected

Set namespace id.

Should be called in open() function if get_nsid() returns 0.

Definition at line 727 of file dev_interface.h.

◆ set_nvme_err()

bool nvme_device::set_nvme_err	(	nvme_cmd_out &	out,
		unsigned	status,
		const char *	msg = `0`
	)

protected

Set last error number and message if pass-through returns NVMe error status.

Returns false always to allow use as a return expression.

Definition at line 233 of file dev_interface.cpp.

Member Data Documentation

◆ m_nsid

unsigned nvme_device::m_nsid

private

Definition at line 735 of file dev_interface.h.

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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members