4 * Home page of code is: http://smartmontools.sourceforge.net
6 * Copyright (C) 2008-9 Christian Franke <smartmontools-support@lists.sourceforge.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2, or (at your option)
13 * You should have received a copy of the GNU General Public License
14 * (for example COPYING); If not, see <http://www.gnu.org/licenses/>.
18 #ifndef DEV_INTERFACE_H
19 #define DEV_INTERFACE_H
21 #define DEV_INTERFACE_H_CVSID "$Id: dev_interface.h 2915 2009-09-18 21:17:37Z chrfranke $\n"
27 #if !defined(__GNUC__) && !defined(__attribute__)
28 #define __attribute__(x) /**/
31 #ifdef _MSC_VER // Disable MSVC warning
32 #pragma warning(disable:4250) // 'class1' : inherits 'class2::member' via dominance
35 /////////////////////////////////////////////////////////////////////////////
36 // Common functionality for all device types
38 // Forward declarations
39 class smart_interface
;
43 /// Base class for all devices
48 /// Device info strings
52 device_info(const char * d_name
, const char * d_type
, const char * r_type
)
53 : dev_name(d_name
), info_name(d_name
),
54 dev_type(d_type
), req_type(r_type
)
57 std::string dev_name
; ///< Device (path)name
58 std::string info_name
; ///< Informal name
59 std::string dev_type
; ///< Actual device type
60 std::string req_type
; ///< Device type requested by user, empty if none
63 /// Error (number,message) pair
65 explicit error_info(int n
= 0)
67 error_info(int n
, const char * m
)
70 { no
= 0; msg
.erase(); }
72 int no
; ///< Error number
73 std::string msg
; ///< Error message
78 /// Constructor to init interface and device info.
79 /// Must be called in implementation classes.
80 smart_device(smart_interface
* intf
, const char * dev_name
,
81 const char * dev_type
, const char * req_type
);
83 /// Dummy enum for dummy constructor.
84 enum do_not_use_in_implementation_classes
{ never_called
};
85 /// Dummy constructor for abstract classes.
86 /// Must never be called in implementation classes.
87 smart_device(do_not_use_in_implementation_classes
);
90 virtual ~smart_device() throw();
94 ///////////////////////////////////////////////
95 // Dynamic downcasts to actual device flavor
97 /// Return true if ATA device
99 { return !!m_ata_ptr
; }
100 /// Return true if SCSI device
102 { return !!m_scsi_ptr
; }
104 /// Downcast to ATA device.
105 ata_device
* to_ata()
106 { return m_ata_ptr
; }
107 /// Downcast to ATA device (const).
108 const ata_device
* to_ata() const
109 { return m_ata_ptr
; }
110 /// Downcast to SCSI device.
111 scsi_device
* to_scsi()
112 { return m_scsi_ptr
; }
113 /// Downcast to ATA device (const).
114 const scsi_device
* to_scsi() const
115 { return m_scsi_ptr
; }
117 ///////////////////////////////////////////////
118 // Device information
120 /// Get device info struct.
121 const device_info
& get_info() const
124 /// Get device (path)name.
125 const char * get_dev_name() const
126 { return m_info
.dev_name
.c_str(); }
127 /// Get informal name.
128 const char * get_info_name() const
129 { return m_info
.info_name
.c_str(); }
131 const char * get_dev_type() const
132 { return m_info
.dev_type
.c_str(); }
133 /// Get type requested by user, empty if none.
134 const char * get_req_type() const
135 { return m_info
.req_type
.c_str(); }
138 /// R/W access to device info struct.
139 device_info
& set_info()
143 ///////////////////////////////////////////////
144 // Last error information
146 /// Get last error info struct.
147 const error_info
& get_err() const
149 /// Get last error number.
150 int get_errno() const
152 /// Get last error message.
153 const char * get_errmsg() const
154 { return m_err
.msg
.c_str(); }
156 /// Set last error number and message.
157 /// Printf()-like formatting is supported.
158 /// Returns false always to allow use as a return expression.
159 bool set_err(int no
, const char * msg
, ...)
160 __attribute__ ((format (printf
, 3, 4)));
162 /// Set last error info struct.
163 bool set_err(const error_info
& err
)
164 { m_err
= err
; return false; }
166 /// Clear last error info.
170 /// Set last error number and default message.
171 /// Message is retrieved from interface's get_msg_for_errno(no).
172 bool set_err(int no
);
176 ///////////////////////////////////////////////
178 // Must be implemented in derived class
180 /// Return true if device is open.
181 virtual bool is_open() const = 0;
183 /// Open device, return false on error.
184 virtual bool open() = 0;
186 /// Close device, return false on error.
187 virtual bool close() = 0;
189 /// Open device with autodetection support.
190 /// May return another device for further access.
191 /// In this case, the original pointer is no longer valid.
192 /// Default Implementation calls 'open()' and returns 'this'.
193 virtual smart_device
* autodetect_open();
195 ///////////////////////////////////////////////
196 // Support for tunnelled devices
198 /// Return true if other device is owned by this device.
199 /// Default implementation returns false.
200 virtual bool owns(const smart_device
* dev
) const;
202 /// Release ownership of other device.
203 /// Default implementation does nothing.
204 virtual void release(const smart_device
* dev
);
207 /// Set dynamic downcast for ATA
208 void this_is_ata(ata_device
* ata
);
211 /// Set dynamic downcast for SCSI
212 void this_is_scsi(scsi_device
* scsi
);
215 /// Get interface which produced this object.
216 smart_interface
* smi()
218 /// Get interface which produced this object (const).
219 const smart_interface
* smi() const
224 smart_interface
* m_intf
;
226 ata_device
* m_ata_ptr
;
227 scsi_device
* m_scsi_ptr
;
230 // Prevent copy/assigment
231 smart_device(const smart_device
&);
232 void operator=(const smart_device
&);
236 /////////////////////////////////////////////////////////////////////////////
237 // ATA specific interface
239 /// ATA register value and info whether is has been ever set
240 // (Automatically set by first assignment)
245 : m_val(0x00), m_is_set(false) { }
247 ata_register
& operator=(unsigned char val
)
248 { m_val
= val
; m_is_set
= true; return * this; }
250 unsigned char val() const
252 operator unsigned char() const
259 unsigned char m_val
; ///< Register value
260 bool m_is_set
; ///< true if set
263 /// ATA Input registers (for 28-bit commands)
266 // ATA-6/7 register names // ATA-3/4/5 // ATA-8
267 ata_register features
; // features // features
268 ata_register sector_count
; // sector count // count
269 ata_register lba_low
; // sector number // ]
270 ata_register lba_mid
; // cylinder low // ] lba
271 ata_register lba_high
; // cylinder high // ]
272 ata_register device
; // device/head // device
273 ata_register command
; // command // command
275 /// Return true if any register is set
277 { return (features
.is_set() || sector_count
.is_set()
278 || lba_low
.is_set() || lba_mid
.is_set() || lba_high
.is_set()
279 || device
.is_set() || command
.is_set()); }
282 /// ATA Output registers (for 28-bit commands)
286 ata_register sector_count
;
287 ata_register lba_low
;
288 ata_register lba_mid
;
289 ata_register lba_high
;
293 /// Return true if any register is set
295 { return (error
.is_set() || sector_count
.is_set()
296 || lba_low
.is_set() || lba_mid
.is_set() || lba_high
.is_set()
297 || device
.is_set() || status
.is_set()); }
301 /// 16-bit alias to a 8-bit ATA register pair.
302 class ata_reg_alias_16
305 ata_reg_alias_16(ata_register
& lo
, ata_register
& hi
)
306 : m_lo(lo
), m_hi(hi
) { }
308 ata_reg_alias_16
& operator=(unsigned short val
)
309 { m_lo
= (unsigned char) val
;
310 m_hi
= (unsigned char)(val
>> 8);
313 unsigned short val() const
314 { return m_lo
| (m_hi
<< 8); }
315 operator unsigned short() const
316 { return m_lo
| (m_hi
<< 8); }
319 ata_register
& m_lo
, & m_hi
;
321 // References must not be copied.
322 ata_reg_alias_16(const ata_reg_alias_16
&);
323 void operator=(const ata_reg_alias_16
&);
327 /// ATA Input registers for 48-bit commands
328 // See section 4.14 of T13/1532D Volume 1 Revision 4b
330 // Uses ATA-6/7 method to specify 16-bit registers as
331 // recent (low byte) and previous (high byte) content of
334 // (ATA-8 ACS does not longer follow this scheme, it uses
335 // abstract registers with sufficient size and leaves the
336 // actual mapping to the transport layer.)
338 struct ata_in_regs_48bit
339 : public ata_in_regs
// "most recently written" registers
341 ata_in_regs prev
; ///< "previous content"
343 // 16-bit aliases for above pair.
344 ata_reg_alias_16 features_16
;
345 ata_reg_alias_16 sector_count_16
;
346 ata_reg_alias_16 lba_low_16
;
347 ata_reg_alias_16 lba_mid_16
;
348 ata_reg_alias_16 lba_high_16
;
350 /// Return true if 48-bit command
351 bool is_48bit_cmd() const
352 { return prev
.is_set(); }
354 /// Return true if 48-bit command with any nonzero high byte
355 bool is_real_48bit_cmd() const
356 { return ( prev
.features
|| prev
.sector_count
357 || prev
.lba_low
|| prev
.lba_mid
|| prev
.lba_high
); }
363 /// ATA Output registers for 48-bit commands
364 struct ata_out_regs_48bit
365 : public ata_out_regs
// read with HOB=0
367 ata_out_regs prev
; ///< read with HOB=1
369 // 16-bit aliases for above pair.
370 ata_reg_alias_16 sector_count_16
;
371 ata_reg_alias_16 lba_low_16
;
372 ata_reg_alias_16 lba_mid_16
;
373 ata_reg_alias_16 lba_high_16
;
375 ata_out_regs_48bit();
379 /// Flags for each ATA output register
380 struct ata_out_regs_flags
382 bool error
, sector_count
, lba_low
, lba_mid
, lba_high
, device
, status
;
384 /// Return true if any flag is set.
386 { return ( error
|| sector_count
|| lba_low
387 || lba_mid
|| lba_high
|| device
|| status
); }
389 /// Default constructor clears all flags.
391 : error(false), sector_count(false), lba_low(false), lba_mid(false),
392 lba_high(false), device(false), status(false) { }
396 /// ATA pass through input parameters
399 ata_in_regs_48bit in_regs
; ///< Input registers
400 ata_out_regs_flags out_needed
; ///< True if output register value needed
401 enum { no_data
= 0, data_in
, data_out
} direction
; ///< I/O direction
402 void * buffer
; ///< Pointer to data buffer
403 unsigned size
; ///< Size of buffer
405 /// Prepare for 28-bit DATA IN command
406 void set_data_in(void * buf
, unsigned nsectors
)
409 in_regs
.sector_count
= nsectors
;
411 size
= nsectors
* 512;
414 /// Prepare for 28-bit DATA OUT command
415 void set_data_out(const void * buf
, unsigned nsectors
)
417 buffer
= const_cast<void *>(buf
);
418 in_regs
.sector_count
= nsectors
;
419 direction
= data_out
;
420 size
= nsectors
* 512;
423 /// Prepare for 48-bit DATA IN command
424 void set_data_in_48bit(void * buf
, unsigned nsectors
)
427 // Note: This also sets 'in_regs.is_48bit_cmd()'
428 in_regs
.sector_count_16
= nsectors
;
430 size
= nsectors
* 512;
436 /// ATA pass through output parameters
439 ata_out_regs_48bit out_regs
; ///< Output registers
444 /// ATA device access
446 : virtual public /*extends*/ smart_device
449 /// ATA pass through.
450 /// Return false on error.
451 /// Must be implemented in derived class.
452 virtual bool ata_pass_through(const ata_cmd_in
& in
, ata_cmd_out
& out
) = 0;
454 /// ATA pass through without output registers.
455 /// Return false on error.
456 /// Calls ata_pass_through(in, dummy), cannot be reimplemented.
457 bool ata_pass_through(const ata_cmd_in
& in
);
459 /// Return true if OS caches ATA identify sector.
460 /// Default implementation returns false.
461 virtual bool ata_identify_is_cached() const;
464 /// Check command input parameters.
465 /// Calls set_err(...) accordingly.
466 bool ata_cmd_is_ok(const ata_cmd_in
& in
,
467 bool data_out_support
= false,
468 bool multi_sector_support
= false,
469 bool ata_48bit_support
= false);
471 /// Default constructor, registers device as ATA.
473 : smart_device(never_called
)
474 { this_is_ata(this); }
478 /////////////////////////////////////////////////////////////////////////////
479 // SCSI specific interface
483 /// SCSI device access
485 : virtual public /*extends*/ smart_device
488 /// SCSI pass through.
489 /// Returns false on error.
490 virtual bool scsi_pass_through(scsi_cmnd_io
* iop
) = 0;
493 /// Default constructor, registers device as SCSI.
495 : smart_device(never_called
)
496 { this_is_scsi(this); }
500 /////////////////////////////////////////////////////////////////////////////
502 // Set dynamic downcasts
503 // Note that due to virtual inheritance,
504 // (ata == this) does not imply ((void*)ata == (void*)this))
506 inline void smart_device::this_is_ata(ata_device
* ata
)
508 m_ata_ptr
= (ata
== this ? ata
: 0);
511 inline void smart_device::this_is_scsi(scsi_device
* scsi
)
513 m_scsi_ptr
= (scsi
== this ? scsi
: 0);
517 /////////////////////////////////////////////////////////////////////////////
520 /// List of devices for DEVICESCAN
521 class smart_device_list
528 ~smart_device_list() throw()
530 for (unsigned i
= 0; i
< m_list
.size(); i
++)
535 unsigned size() const
536 { return m_list
.size(); }
541 for (unsigned i
= 0; i
< m_list
.size(); i
++)
547 void add(smart_device
* dev
)
548 { m_list
.push_back(dev
); }
550 void push_back(smart_device
* dev
)
551 { m_list
.push_back(dev
); }
553 smart_device
* at(unsigned i
)
554 { return m_list
.at(i
); }
556 const smart_device
* at(unsigned i
) const
557 { return m_list
.at(i
); }
559 smart_device
* release(unsigned i
)
561 smart_device
* dev
= m_list
.at(i
);
568 std::vector
<smart_device
*> m_list
;
570 // Prevent copy/assigment
571 smart_device_list(const smart_device_list
&);
572 void operator=(const smart_device_list
&);
576 /////////////////////////////////////////////////////////////////////////////
579 /// The platform interface abstraction
580 class smart_interface
583 /// Initialize platform interface and register with smi().
584 /// Must be implemented by platform module and register interface with set()
590 virtual ~smart_interface() throw()
593 /// Return info string about build host and/or OS version.
594 /// Default implementation returns SMARTMONTOOLS_BUILD_HOST.
595 virtual std::string
get_os_version_str();
597 /// Return valid args for device type option/directive.
598 /// Default implementation returns "ata, scsi, sat, usb*..."
599 /// concatenated with result from get_valid_custom_dev_types_str().
600 virtual std::string
get_valid_dev_types_str();
602 /// Return example string for program 'appname'.
603 /// Default implementation returns empty string.
604 /// For the migration of print_smartctl_examples(),
605 /// function is allowed to print examples to stdout.
606 /// TODO: Remove this hack.
607 virtual std::string
get_app_examples(const char * appname
);
609 ///////////////////////////////////////////////
610 // Last error information
612 /// Get last error info struct.
613 const smart_device::error_info
& get_err() const
615 /// Get last error number.
616 int get_errno() const
618 /// Get last error message.
619 const char * get_errmsg() const
620 { return m_err
.msg
.c_str(); }
622 /// Set last error number and message.
623 /// Printf()-like formatting is supported.
624 void set_err(int no
, const char * msg
, ...)
625 __attribute__ ((format (printf
, 3, 4)));
627 /// Set last error info struct.
628 void set_err(const smart_device::error_info
& err
)
631 /// Clear last error info.
635 /// Set last error number and default message.
636 /// Message is retrieved from get_msg_for_errno(no).
637 void set_err(int no
);
639 /// Set last error number and default message to any error_info.
640 /// Used by set_err(no).
641 void set_err_var(smart_device::error_info
* err
, int no
);
643 /// Convert error number into message, used by set_err(no).
644 /// Default implementation returns strerror(no).
645 virtual const char * get_msg_for_errno(int no
);
647 ///////////////////////////////////////////////////////////////////////////
650 /// Return device object for device 'name' with some 'type'.
651 /// 'type' is 0 if not specified by user.
652 /// Return 0 on error.
653 /// Default implementation selects between ata, scsi and custom device.
654 virtual smart_device
* get_smart_device(const char * name
, const char * type
);
656 /// Fill 'devlist' with devices of some 'type' with devices names.
657 /// specified by some optional 'pattern'.
658 /// Return false on error.
659 virtual bool scan_smart_devices(smart_device_list
& devlist
, const char * type
,
660 const char * pattern
= 0) = 0;
663 /// Return standard ATA device.
664 virtual ata_device
* get_ata_device(const char * name
, const char * type
) = 0;
666 /// Return standard SCSI device.
667 virtual scsi_device
* get_scsi_device(const char * name
, const char * type
) = 0;
669 /// Autodetect device if no device type specified.
670 virtual smart_device
* autodetect_smart_device(const char * name
) = 0;
672 /// Return device for platform specific 'type'.
673 /// Default implementation returns 0.
674 virtual smart_device
* get_custom_smart_device(const char * name
, const char * type
);
676 /// Return valid 'type' args accepted by above.
677 /// This is called in get_valid_dev_types_str().
678 /// Default implementation returns empty string.
679 virtual std::string
get_valid_custom_dev_types_str();
681 /// Return ATA->SCSI filter for SAT or USB.
682 /// Override only if platform needs special handling.
683 virtual ata_device
* get_sat_device(const char * type
, scsi_device
* scsidev
);
684 //{ implemented in scsiata.cpp }
687 /// Try to detect a SAT device behind a SCSI interface.
688 /// Inquiry data can be passed if available.
689 /// Return appropriate device if yes, otherwise 0.
690 /// Override only if platform needs special handling.
691 virtual ata_device
* autodetect_sat_device(scsi_device
* scsidev
,
692 const unsigned char * inqdata
, unsigned inqsize
);
693 //{ implemented in scsiata.cpp }
695 /// Get type name for USB device with known VENDOR:PRODUCT ID.
696 /// Return name if device known and supported, otherwise 0.
697 virtual const char * get_usb_dev_type_by_id(int vendor_id
, int product_id
,
699 //{ implemented in scsiata.cpp }
702 /// Set interface to use, must be called from init().
703 static void set(smart_interface
* intf
)
704 { s_instance
= intf
; }
708 smart_device::error_info m_err
;
710 friend smart_interface
* smi(); // below
711 static smart_interface
* s_instance
; ///< Pointer to the interface object.
713 // Prevent copy/assigment
714 smart_interface(const smart_interface
&);
715 void operator=(const smart_interface
&);
719 /////////////////////////////////////////////////////////////////////////////
722 /// Global access to the (usually singleton) smart_interface
723 inline smart_interface
* smi()
724 { return smart_interface::s_instance
; }
726 /////////////////////////////////////////////////////////////////////////////
728 #endif // DEV_INTERFACE_H