Collaboration diagram for generic::generic_smart_interface:

[legend]

Public Member Functions
virtual std::string	get_app_examples (const char *appname)
	Return example string for program 'appname'.

virtual bool	scan_smart_devices (smart_device_list &devlist, const char type, const char pattern=0)
	Fill 'devlist' with devices of some 'type' with device names specified by some optional 'pattern'.

Public Member Functions inherited from smart_interface
	smart_interface ()

virtual	~smart_interface ()

virtual std::string	get_os_version_str ()
	Return info string about build host and/or OS version.

virtual std::string	get_valid_dev_types_str ()
	Return valid args for device type option/directive.

virtual std::string	get_app_examples (const char *appname)
	Return example string for program 'appname'.

virtual bool	disable_system_auto_standby (bool disable)
	Disable/Enable system auto standby/sleep mode.

const smart_device::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.

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

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

bool decltype(nullptr) bool	set_err (const smart_device::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.

bool	set_err_var (smart_device::error_info *err, int no)
	Set last error number and default message to any error_info.

virtual const char *	get_msg_for_errno (int no)
	Convert error number into message, used by set_err(no).

virtual smart_device *	get_smart_device (const char name, const char type)
	Return device object for device 'name' with some 'type'.

virtual bool	scan_smart_devices (smart_device_list &devlist, const char type, const char pattern=0)
	Fill 'devlist' with devices of some 'type' with device names specified by some optional 'pattern'.

virtual bool	scan_smart_devices (smart_device_list &devlist, const smart_devtype_list &types, const char *pattern=0)
	Fill 'devlist' with devices of all 'types' with device names specified by some optional 'pattern'.

virtual std::string	get_unique_dev_name (const char name, const char type) const
	Return unique device name which is (only) suitable for duplicate detection.

virtual bool	is_raid_dev_type (const char *type) const
	Return true if the 'type' string contains a RAID drive number.

virtual ata_device *	autodetect_sat_device (scsi_device scsidev, const unsigned char inqdata, unsigned inqsize)
	Try to detect a SAT device behind a SCSI interface.

virtual const char *	get_usb_dev_type_by_id (int vendor_id, int product_id, int version=-1)
	Get type name for USB device with known VENDOR:PRODUCT ID.

Protected Member Functions
virtual ata_device *	get_ata_device (const char name, const char type)
	Return standard ATA device.

virtual scsi_device *	get_scsi_device (const char name, const char type)
	Return standard SCSI device.

virtual smart_device *	autodetect_smart_device (const char *name)
	Autodetect device if no device type specified.

virtual smart_device *	get_custom_smart_device (const char name, const char type)
	Return device for platform specific 'type'.

virtual std::string	get_valid_custom_dev_types_str ()
	Return valid 'type' args accepted by above.

Protected Member Functions inherited from smart_interface
virtual ata_device *	get_ata_device (const char name, const char type)=0
	Return standard ATA device.

virtual scsi_device *	get_scsi_device (const char name, const char type)=0
	Return standard SCSI device.

virtual nvme_device *	get_nvme_device (const char name, const char type, unsigned nsid)
	Return standard NVMe device.

virtual smart_device *	autodetect_smart_device (const char *name)=0
	Autodetect device if no device type specified.

virtual smart_device *	get_custom_smart_device (const char name, const char type)
	Return device for platform specific 'type'.

virtual std::string	get_valid_custom_dev_types_str ()
	Return valid 'type' args accepted by above.

virtual smart_device *	get_scsi_passthrough_device (const char type, scsi_device scsidev)
	Return ATA->SCSI of NVMe->SCSI filter for a SAT, SNT or USB 'type'.

virtual ata_device *	get_sat_device (const char type, scsi_device scsidev)
	Return ATA->SCSI filter for a SAT or USB 'type'.

virtual nvme_device *	get_snt_device (const char type, scsi_device scsidev)
	Return NVMe->SCSI filter for a SNT or USB 'type'.

virtual ata_device *	get_intelliprop_device (const char type, ata_device atadev)
	Return filter for Intelliprop controllers.

virtual ata_device *	get_jmb39x_device (const char type, smart_device smartdev)
	Return JMB93x->ATA filter.

Additional Inherited Members
Static Public Member Functions inherited from smart_interface
static void	init ()
	Initialize platform interface and register with smi().

Static Protected Member Functions inherited from smart_interface
static void	set (smart_interface *intf)
	Set interface to use, must be called from init().

Detailed Description

Definition at line 105 of file os_generic.cpp.

Member Function Documentation

◆ autodetect_smart_device()

smart_device * generic::generic_smart_interface::autodetect_smart_device ( const char * name )

protectedvirtual

Autodetect device if no device type specified.

Implements smart_interface.

Definition at line 168 of file os_generic.cpp.

◆ get_app_examples()

std::string generic::generic_smart_interface::get_app_examples ( const char * appname )

virtual

Return example string for program 'appname'.

Default implementation returns empty string. For the migration of print_smartctl_examples(), function is allowed to print examples to stdout. TODO: Remove this hack.

Reimplemented from smart_interface.

Definition at line 141 of file os_generic.cpp.

◆ get_ata_device()

ata_device * generic::generic_smart_interface::get_ata_device	(	const char *	name,
		const char *	type
	)

protectedvirtual

Return standard ATA device.

Implements smart_interface.

Definition at line 150 of file os_generic.cpp.

◆ get_custom_smart_device()

smart_device * generic::generic_smart_interface::get_custom_smart_device	(	const char *	name,
		const char *	type
	)

protectedvirtual

Return device for platform specific 'type'.

Default implementation returns 0.

Reimplemented from smart_interface.

Definition at line 188 of file os_generic.cpp.

◆ get_scsi_device()

scsi_device * generic::generic_smart_interface::get_scsi_device	(	const char *	name,
		const char *	type
	)

protectedvirtual

Return standard SCSI device.

Implements smart_interface.

Definition at line 159 of file os_generic.cpp.

◆ get_valid_custom_dev_types_str()

std::string generic::generic_smart_interface::get_valid_custom_dev_types_str ( )

protectedvirtual

Return valid 'type' args accepted by above.

This is called in get_valid_dev_types_str(). Default implementation returns empty string.

Reimplemented from smart_interface.

Definition at line 195 of file os_generic.cpp.

◆ scan_smart_devices()

bool generic::generic_smart_interface::scan_smart_devices	(	smart_device_list &	devlist,
		const char *	type,
		const char *	pattern = `0`
	)

virtual

Fill 'devlist' with devices of some 'type' with device names specified by some optional 'pattern'.

Use platform specific default if 'type' is empty or 0. Return false on error. Default implementation returns false;

Reimplemented from smart_interface.

Definition at line 177 of file os_generic.cpp.

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

os_generic.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ autodetect_smart_device()

◆ get_app_examples()

◆ get_ata_device()

◆ get_custom_smart_device()

◆ get_scsi_device()

◆ get_valid_custom_dev_types_str()

◆ scan_smart_devices()