/*
* dev_interface.h
*
- * Home page of code is: http://smartmontools.sourceforge.net
+ * Home page of code is: http://www.smartmontools.org
*
- * Copyright (C) 2008-11 Christian Franke <smartmontools-support@lists.sourceforge.net>
+ * Copyright (C) 2008-15 Christian Franke
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
#ifndef DEV_INTERFACE_H
#define DEV_INTERFACE_H
-#define DEV_INTERFACE_H_CVSID "$Id: dev_interface.h 3256 2011-02-08 22:13:41Z chrfranke $\n"
+#define DEV_INTERFACE_H_CVSID "$Id: dev_interface.h 4152 2015-10-17 16:08:21Z chrfranke $\n"
+
+#include "utility.h"
#include <stdexcept>
#include <string>
#include <vector>
-#if !defined(__GNUC__) && !defined(__attribute__)
-#define __attribute__(x) /**/
-#endif
-
-#ifdef _MSC_VER // Disable MSVC warning
-#pragma warning(disable:4250) // 'class1' : inherits 'class2::member' via dominance
-#endif
-
/////////////////////////////////////////////////////////////////////////////
// Common functionality for all device types
enum do_not_use_in_implementation_classes { never_called };
/// Dummy constructor for abstract classes.
/// Must never be called in implementation classes.
- smart_device(do_not_use_in_implementation_classes);
+ explicit smart_device(do_not_use_in_implementation_classes);
public:
virtual ~smart_device() throw();
const char * get_errmsg() const
{ return m_err.msg.c_str(); }
+ /// Return true if last error indicates an unsupported system call.
+ /// Default implementation returns true on ENOSYS and ENOTSUP.
+ virtual bool is_syscall_unsup() const;
+
/// Set last error number and message.
/// Printf()-like formatting is supported.
/// Returns false always to allow use as a return expression.
bool set_err(int no, const char * msg, ...)
- __attribute__ ((format (printf, 3, 4)));
+ __attribute_format_printf(3, 4);
/// Set last error info struct.
bool set_err(const error_info & err)
/// Open device with autodetection support.
/// May return another device for further access.
/// In this case, the original pointer is no longer valid.
- /// Default Implementation calls 'open()' and returns 'this'.
+ /// Default implementation calls 'open()' and returns 'this'.
virtual smart_device * autodetect_open();
///////////////////////////////////////////////
virtual void release(const smart_device * dev);
protected:
- /// Set dynamic downcast for ATA
- void this_is_ata(ata_device * ata);
- // {see below;}
-
- /// Set dynamic downcast for SCSI
- void this_is_scsi(scsi_device * scsi);
- // {see below;}
-
/// Get interface which produced this object.
smart_interface * smi()
{ return m_intf; }
private:
smart_interface * m_intf;
device_info m_info;
+ error_info m_err;
+
+ // Pointers for to_ata(), to_scsi(),
+ // set by ATA/SCSI interface classes.
+ friend class ata_device;
ata_device * m_ata_ptr;
+ friend class scsi_device;
scsi_device * m_scsi_ptr;
- error_info m_err;
// Prevent copy/assigment
smart_device(const smart_device &);
virtual bool ata_identify_is_cached() const;
protected:
+ /// Flags for ata_cmd_is_supported().
+ enum {
+ supports_data_out = 0x01, // PIO DATA OUT
+ supports_smart_status = 0x02, // read output registers for SMART STATUS only
+ supports_output_regs = 0x04, // read output registers for all commands
+ supports_multi_sector = 0x08, // more than one sector (1 DRQ/sector variant)
+ supports_48bit_hi_null = 0x10, // 48-bit commands with null high bytes only
+ supports_48bit = 0x20, // all 48-bit commands
+ };
+
/// Check command input parameters.
+ /// Return false if required features are not implemented.
/// Calls set_err(...) accordingly.
+ bool ata_cmd_is_supported(const ata_cmd_in & in, unsigned flags,
+ const char * type = 0);
+
+ /// Check command input parameters (old version).
+ // TODO: Remove if no longer used.
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);
+ bool ata_48bit_support = false)
+ {
+ return ata_cmd_is_supported(in,
+ (data_out_support ? supports_data_out : 0) |
+ supports_output_regs |
+ (multi_sector_support ? supports_multi_sector : 0) |
+ (ata_48bit_support ? supports_48bit : 0));
+ }
+
+ /// Hide/unhide ATA interface.
+ void hide_ata(bool hide = true)
+ { m_ata_ptr = (!hide ? this : 0); }
/// Default constructor, registers device as ATA.
ata_device()
: smart_device(never_called)
- { this_is_ata(this); }
+ { hide_ata(false); }
};
virtual bool scsi_pass_through(scsi_cmnd_io * iop) = 0;
protected:
+ /// Hide/unhide SCSI interface.
+ void hide_scsi(bool hide = true)
+ { m_scsi_ptr = (!hide ? this : 0); }
+
/// Default constructor, registers device as SCSI.
scsi_device()
: smart_device(never_called)
- { this_is_scsi(this); }
+ { hide_scsi(false); }
};
-/////////////////////////////////////////////////////////////////////////////
-
-// Set dynamic downcasts
-// Note that due to virtual inheritance,
-// (ata == this) does not imply ((void*)ata == (void*)this))
-
-inline void smart_device::this_is_ata(ata_device * ata)
-{
- m_ata_ptr = (ata == this ? ata : 0);
-}
-
-inline void smart_device::this_is_scsi(scsi_device * scsi)
-{
- m_scsi_ptr = (scsi == this ? scsi : 0);
-}
-
-
/////////////////////////////////////////////////////////////////////////////
/// Smart pointer class for device pointers
/// TODO: Remove this hack.
virtual std::string get_app_examples(const char * appname);
+ /// Get microseconds since some unspecified starting point.
+ /// Used only for command duration measurements in debug outputs.
+ /// Returns -1 if unsupported.
+ /// Default implementation uses clock_gettime(), gettimeofday() or ftime().
+ virtual int64_t get_timer_usec();
+
+ /// Disable/Enable system auto standby/sleep mode.
+ /// Return false if unsupported or if system is running
+ /// on battery.
+ /// Default implementation returns false.
+ virtual bool disable_system_auto_standby(bool disable);
+
+
///////////////////////////////////////////////
// Last error information
/// Set last error number and message.
/// Printf()-like formatting is supported.
- void set_err(int no, const char * msg, ...)
- __attribute__ ((format (printf, 3, 4)));
+ /// Returns false always to allow use as a return expression.
+ bool set_err(int no, const char * msg, ...)
+ __attribute_format_printf(3, 4);
/// Set last error info struct.
- void set_err(const smart_device::error_info & err)
- { m_err = err; }
+ bool set_err(const smart_device::error_info & err)
+ { m_err = err; return false; }
/// Clear last error info.
void clear_err()
/// Set last error number and default message.
/// Message is retrieved from get_msg_for_errno(no).
- void set_err(int no);
+ bool set_err(int no);
/// Set last error number and default message to any error_info.
/// Used by set_err(no).
- void set_err_var(smart_device::error_info * err, int no);
+ bool set_err_var(smart_device::error_info * err, int no);
/// Convert error number into message, used by set_err(no).
/// Default implementation returns strerror(no).
projects / mirror_smartmontools-debian.git / blobdiff