smartmontools SVN Rev 5645
Utility to control and monitor storage systems with "S.M.A.R.T."
Public Member Functions | Private Member Functions | Private Attributes | List of all members
os_win32::win_ata_device Class Reference
Collaboration diagram for os_win32::win_ata_device:
Collaboration graph
[legend]

Public Member Functions

 win_ata_device (smart_interface *intf, const char *dev_name, const char *req_type)
 
virtual ~win_ata_device ()
 
virtual bool open () override
 Open device, return false on error.
 
virtual bool is_powered_down () override
 Early test if device is powered up or down.
 
virtual bool ata_pass_through (const ata_cmd_in &in, ata_cmd_out &out) override
 ATA pass through.
 
virtual bool ata_identify_is_cached () const override
 Return true if OS caches ATA identify sector.
 
- Public Member Functions inherited from ata_device
virtual bool ata_pass_through (const ata_cmd_in &in, ata_cmd_out &out)=0
 ATA pass through.
 
bool ata_pass_through (const ata_cmd_in &in)
 ATA pass through without output registers.
 
virtual bool ata_identify_is_cached () const
 Return true if OS caches ATA identify sector.
 
- 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_deviceto_ata ()
 Downcast to ATA device.
 
const ata_deviceto_ata () const
 Downcast to ATA device (const).
 
scsi_deviceto_scsi ()
 Downcast to SCSI device.
 
const scsi_deviceto_scsi () const
 Downcast to SCSI device (const).
 
nvme_deviceto_nvme ()
 Downcast to NVMe device.
 
const nvme_deviceto_nvme () const
 Downcast to NVMe device (const).
 
const device_infoget_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_infoget_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_deviceautodetect_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.
 
- Public Member Functions inherited from os_win32::win_smart_device
 win_smart_device ()
 
virtual ~win_smart_device ()
 
virtual bool is_open () const
 Return true if device is open.
 
virtual bool close ()
 Close device, return false on error.
 

Private Member Functions

bool open (bool query_device)
 
bool open (int phydrive, int logdrive, const char *options, int port, bool query_device)
 

Private Attributes

std::string m_options
 
bool m_usr_options
 
bool m_admin
 
int m_phydrive
 
bool m_id_is_cached
 
bool m_is_3ware
 
int m_port
 
int m_smartver_state
 

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 ata_device
enum  {
  supports_data_out = 0x01 , supports_smart_status = 0x02 , supports_output_regs = 0x04 , supports_multi_sector = 0x08 ,
  supports_48bit_hi_null = 0x10 , supports_48bit = 0x20
}
 Flags for ata_cmd_is_supported(). More...
 
- Protected Types inherited from smart_device
enum  do_not_use_in_implementation_classes { never_called }
 Dummy enum for dummy constructor. More...
 
- Protected Member Functions inherited from ata_device
bool ata_cmd_is_supported (const ata_cmd_in &in, unsigned flags, const char *type=0)
 Check command input parameters.
 
bool ata_cmd_is_ok (const ata_cmd_in &in, bool data_out_support=false, bool multi_sector_support=false, bool ata_48bit_support=false)
 Check command input parameters (old version).
 
void hide_ata (bool hide=true)
 Hide/unhide ATA interface.
 
 ata_device ()
 Default constructor, registers device as ATA.
 
- 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_infoset_info ()
 R/W access to device info struct.
 
smart_interfacesmi ()
 Get interface which produced this object.
 
const smart_interfacesmi () const
 Get interface which produced this object (const).
 
- Protected Member Functions inherited from os_win32::win_smart_device
void set_fh (HANDLE fh)
 Set handle for open() in derived classes.
 
HANDLE get_fh () const
 Return handle for derived classes.
 

Detailed Description

Definition at line 1395 of file os_win32.cpp.

Constructor & Destructor Documentation

◆ win_ata_device()

os_win32::win_ata_device::win_ata_device ( smart_interface intf,
const char *  dev_name,
const char *  req_type 
)

Definition at line 1428 of file os_win32.cpp.

◆ ~win_ata_device()

os_win32::win_ata_device::~win_ata_device ( )
virtual

Definition at line 1440 of file os_win32.cpp.

Member Function Documentation

◆ ata_identify_is_cached()

bool os_win32::win_ata_device::ata_identify_is_cached ( ) const
overridevirtual

Return true if OS caches ATA identify sector.

Default implementation returns false.

Reimplemented from ata_device.

Definition at line 1952 of file os_win32.cpp.

◆ ata_pass_through()

bool os_win32::win_ata_device::ata_pass_through ( const ata_cmd_in in,
ata_cmd_out out 
)
overridevirtual

ATA pass through.

Return false on error. Must be implemented in derived class.

Implements ata_device.

Definition at line 1630 of file os_win32.cpp.

◆ is_powered_down()

bool os_win32::win_ata_device::is_powered_down ( )
overridevirtual

Early test if device is powered up or down.

Can be used without calling 'open()' first! Return true when device is powered down, false when powered up. If this function is not implemented or the mode cannot be determined, return false. Default implementation returns false.

Reimplemented from smart_device.

Definition at line 1613 of file os_win32.cpp.

◆ open() [1/3]

bool os_win32::win_ata_device::open ( )
overridevirtual

Open device, return false on error.

Implements smart_device.

Definition at line 1454 of file os_win32.cpp.

◆ open() [2/3]

bool os_win32::win_ata_device::open ( bool  query_device)
private

Definition at line 1460 of file os_win32.cpp.

◆ open() [3/3]

bool os_win32::win_ata_device::open ( int  phydrive,
int  logdrive,
const char *  options,
int  port,
bool  query_device 
)
private

Definition at line 1492 of file os_win32.cpp.

Member Data Documentation

◆ m_admin

bool os_win32::win_ata_device::m_admin
private

Definition at line 1419 of file os_win32.cpp.

◆ m_id_is_cached

bool os_win32::win_ata_device::m_id_is_cached
private

Definition at line 1421 of file os_win32.cpp.

◆ m_is_3ware

bool os_win32::win_ata_device::m_is_3ware
private

Definition at line 1422 of file os_win32.cpp.

◆ m_options

std::string os_win32::win_ata_device::m_options
private

Definition at line 1417 of file os_win32.cpp.

◆ m_phydrive

int os_win32::win_ata_device::m_phydrive
private

Definition at line 1420 of file os_win32.cpp.

◆ m_port

int os_win32::win_ata_device::m_port
private

Definition at line 1423 of file os_win32.cpp.

◆ m_smartver_state

int os_win32::win_ata_device::m_smartver_state
private

Definition at line 1424 of file os_win32.cpp.

◆ m_usr_options

bool os_win32::win_ata_device::m_usr_options
private

Definition at line 1418 of file os_win32.cpp.


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