4 * Home page of code is: http://smartmontools.sourceforge.net
6 * Copyright (C) 2003-11 Bruce Allen <smartmontools-support@lists.sourceforge.net>
7 * Copyright (C) 2003-11 Doug Gilbert <dgilbert@interlog.com>
8 * Copyright (C) 2008-15 Christian Franke <smartmontools-support@lists.sourceforge.net>
10 * Original AACRaid code:
11 * Copyright (C) 2014 Raghava Aditya <raghava.aditya@pmcs.com>
13 * Original Areca code:
14 * Copyright (C) 2008-12 Hank Wu <hank@areca.com.tw>
15 * Copyright (C) 2008 Oliver Bock <brevilo@users.sourceforge.net>
17 * Original MegaRAID code:
18 * Copyright (C) 2008 Jordan Hargrave <jordan_hargrave@dell.com>
20 * 3ware code was derived from code that was:
22 * Written By: Adam Radford <linux@3ware.com>
23 * Modifications By: Joel Jacobson <linux@3ware.com>
24 * Arnaldo Carvalho de Melo <acme@conectiva.com.br>
25 * Brad Strand <linux@3ware.com>
27 * Copyright (C) 1999-2003 3ware Inc.
29 * Kernel compatablity By: Andre Hedrick <andre@suse.com>
30 * Non-Copyright (C) 2000 Andre Hedrick <andre@suse.com>
32 * Other ars of this file are derived from code that was
34 * Copyright (C) 1999-2000 Michael Cornwell <cornwell@acm.org>
35 * Copyright (C) 2000 Andre Hedrick <andre@linux-ide.org>
37 * This program is free software; you can redistribute it and/or modify
38 * it under the terms of the GNU General Public License as published by
39 * the Free Software Foundation; either version 2, or (at your option)
42 * You should have received a copy of the GNU General Public License
43 * (for example COPYING); If not, see <http://www.gnu.org/licenses/>.
45 * This code was originally developed as a Senior Thesis by Michael Cornwell
46 * at the Concurrent Systems Laboratory (now part of the Storage Systems
47 * Research Center), Jack Baskin School of Engineering, University of
48 * California, Santa Cruz. http://ssrc.soe.ucsc.edu/
52 // This file contains the linux-specific IOCTL parts of
53 // smartmontools. It includes one interface routine for ATA devices,
54 // one for SCSI devices, and one for ATA devices behind escalade
63 #include <scsi/scsi.h>
64 #include <scsi/scsi_ioctl.h>
68 #include <sys/ioctl.h>
70 #include <sys/utsname.h>
72 #include <stddef.h> // for offsetof()
74 #include <sys/types.h>
76 #ifndef makedev // old versions of types.h do not include sysmacros.h
77 #include <sys/sysmacros.h>
80 #include <selinux/selinux.h>
92 #include "dev_interface.h"
93 #include "dev_ata_cmd_set.h"
94 #include "dev_areca.h"
97 #define ENOTSUP ENOSYS
100 #define ARGUSED(x) ((void)(x))
102 const char * os_linux_cpp_cvsid
= "$Id: os_linux.cpp 4047 2015-03-22 16:16:24Z chrfranke $"
104 extern unsigned char failuretest_permissive
;
106 namespace os_linux
{ // No need to publish anything, name provided for Doxygen
108 /////////////////////////////////////////////////////////////////////////////
109 /// Shared open/close routines
111 class linux_smart_device
112 : virtual public /*implements*/ smart_device
115 explicit linux_smart_device(int flags
, int retry_flags
= -1)
116 : smart_device(never_called
),
118 m_flags(flags
), m_retry_flags(retry_flags
)
121 virtual ~linux_smart_device() throw();
123 virtual bool is_open() const;
127 virtual bool close();
130 /// Return filedesc for derived classes.
138 int m_fd
; ///< filedesc, -1 if not open.
139 int m_flags
; ///< Flags for ::open()
140 int m_retry_flags
; ///< Flags to retry ::open(), -1 if no retry
143 linux_smart_device::~linux_smart_device() throw()
149 bool linux_smart_device::is_open() const
154 bool linux_smart_device::open()
156 m_fd
= ::open(get_dev_name(), m_flags
);
158 if (m_fd
< 0 && errno
== EROFS
&& m_retry_flags
!= -1)
160 m_fd
= ::open(get_dev_name(), m_retry_flags
);
163 if (errno
== EBUSY
&& (m_flags
& O_EXCL
))
165 return set_err(EBUSY
,
166 "The requested controller is used exclusively by another process!\n"
167 "(e.g. smartctl or smartd)\n"
168 "Please quit the impeding process or try again later...");
169 return set_err((errno
==ENOENT
|| errno
==ENOTDIR
) ? ENODEV
: errno
);
173 // sets FD_CLOEXEC on the opened device file descriptor. The
174 // descriptor is otherwise leaked to other applications (mail
175 // sender) which may be considered a security risk and may result
176 // in AVC messages on SELinux-enabled systems.
177 if (-1 == fcntl(m_fd
, F_SETFD
, FD_CLOEXEC
))
178 // TODO: Provide an error printing routine in class smart_interface
179 pout("fcntl(set FD_CLOEXEC) failed, errno=%d [%s]\n", errno
, strerror(errno
));
185 // equivalent to close(file descriptor)
186 bool linux_smart_device::close()
188 int fd
= m_fd
; m_fd
= -1;
190 return set_err(errno
);
194 // examples for smartctl
195 static const char smartctl_examples
[] =
196 "=================================================== SMARTCTL EXAMPLES =====\n\n"
197 " smartctl --all /dev/sda (Prints all SMART information)\n\n"
198 " smartctl --smart=on --offlineauto=on --saveauto=on /dev/sda\n"
199 " (Enables SMART on first disk)\n\n"
200 " smartctl --test=long /dev/sda (Executes extended disk self-test)\n\n"
201 " smartctl --attributes --log=selftest --quietmode=errorsonly /dev/sda\n"
202 " (Prints Self-Test & Attribute errors)\n"
203 " smartctl --all --device=3ware,2 /dev/sda\n"
204 " smartctl --all --device=3ware,2 /dev/twe0\n"
205 " smartctl --all --device=3ware,2 /dev/twa0\n"
206 " smartctl --all --device=3ware,2 /dev/twl0\n"
207 " (Prints all SMART info for 3rd ATA disk on 3ware RAID controller)\n"
208 " smartctl --all --device=hpt,1/1/3 /dev/sda\n"
209 " (Prints all SMART info for the SATA disk attached to the 3rd PMPort\n"
210 " of the 1st channel on the 1st HighPoint RAID controller)\n"
211 " smartctl --all --device=areca,3/1 /dev/sg2\n"
212 " (Prints all SMART info for 3rd ATA disk of the 1st enclosure\n"
213 " on Areca RAID controller)\n"
216 /////////////////////////////////////////////////////////////////////////////
217 /// Linux ATA support
219 class linux_ata_device
220 : public /*implements*/ ata_device_with_command_set
,
221 public /*extends*/ linux_smart_device
224 linux_ata_device(smart_interface
* intf
, const char * dev_name
, const char * req_type
);
227 virtual int ata_command_interface(smart_command_set command
, int select
, char * data
);
230 linux_ata_device::linux_ata_device(smart_interface
* intf
, const char * dev_name
, const char * req_type
)
231 : smart_device(intf
, dev_name
, "ata", req_type
),
232 linux_smart_device(O_RDONLY
| O_NONBLOCK
)
237 // This is an interface routine meant to isolate the OS dependent
238 // parts of the code, and to provide a debugging interface. Each
239 // different port and OS needs to provide it's own interface. This
241 // DETAILED DESCRIPTION OF ARGUMENTS
242 // device: is the file descriptor provided by open()
243 // command: defines the different operations.
244 // select: additional input data if needed (which log, which type of
246 // data: location to write output data, if needed (512 bytes).
247 // Note: not all commands use all arguments.
249 // -1 if the command failed
250 // 0 if the command succeeded,
251 // STATUS_CHECK routine:
252 // -1 if the command failed
253 // 0 if the command succeeded and disk SMART status is "OK"
254 // 1 if the command succeeded and disk SMART status is "FAILING"
256 #define BUFFER_LENGTH (4+512)
258 int linux_ata_device::ata_command_interface(smart_command_set command
, int select
, char * data
)
260 unsigned char buff
[BUFFER_LENGTH
];
261 // positive: bytes to write to caller. negative: bytes to READ from
262 // caller. zero: non-data command
265 const int HDIO_DRIVE_CMD_OFFSET
= 4;
267 // See struct hd_drive_cmd_hdr in hdreg.h. Before calling ioctl()
268 // buff[0]: ATA COMMAND CODE REGISTER
269 // buff[1]: ATA SECTOR NUMBER REGISTER == LBA LOW REGISTER
270 // buff[2]: ATA FEATURES REGISTER
271 // buff[3]: ATA SECTOR COUNT REGISTER
273 // Note that on return:
274 // buff[2] contains the ATA SECTOR COUNT REGISTER
276 // clear out buff. Large enough for HDIO_DRIVE_CMD (4+512 bytes)
277 memset(buff
, 0, BUFFER_LENGTH
);
279 buff
[0]=ATA_SMART_CMD
;
281 case CHECK_POWER_MODE
:
282 buff
[0]=ATA_CHECK_POWER_MODE
;
286 buff
[2]=ATA_SMART_READ_VALUES
;
290 case READ_THRESHOLDS
:
291 buff
[2]=ATA_SMART_READ_THRESHOLDS
;
296 buff
[2]=ATA_SMART_READ_LOG_SECTOR
;
304 buff
[0]=ATA_IDENTIFY_DEVICE
;
309 buff
[0]=ATA_IDENTIFY_PACKET_DEVICE
;
314 buff
[2]=ATA_SMART_ENABLE
;
318 buff
[2]=ATA_SMART_DISABLE
;
322 // this command only says if SMART is working. It could be
323 // replaced with STATUS_CHECK below.
324 buff
[2]=ATA_SMART_STATUS
;
327 // NOTE: According to ATAPI 4 and UP, this command is obsolete
328 // select == 241 for enable but no data transfer. Use TASK ioctl.
329 buff
[1]=ATA_SMART_AUTO_OFFLINE
;
333 // select == 248 for enable but no data transfer. Use TASK ioctl.
334 buff
[1]=ATA_SMART_AUTOSAVE
;
337 case IMMEDIATE_OFFLINE
:
338 buff
[2]=ATA_SMART_IMMEDIATE_OFFLINE
;
342 // This command uses HDIO_DRIVE_TASK and has different syntax than
343 // the other commands.
344 buff
[1]=ATA_SMART_STATUS
;
347 pout("Unrecognized command %d in linux_ata_command_interface()\n"
348 "Please contact " PACKAGE_BUGREPORT
"\n", command
);
353 // This command uses the HDIO_DRIVE_TASKFILE ioctl(). This is the
354 // only ioctl() that can be used to WRITE data to the disk.
355 if (command
==WRITE_LOG
) {
356 unsigned char task
[sizeof(ide_task_request_t
)+512];
357 ide_task_request_t
*reqtask
=(ide_task_request_t
*) task
;
358 task_struct_t
*taskfile
=(task_struct_t
*) reqtask
->io_ports
;
361 memset(task
, 0, sizeof(task
));
364 taskfile
->feature
= ATA_SMART_WRITE_LOG_SECTOR
;
365 taskfile
->sector_count
= 1;
366 taskfile
->sector_number
= select
;
367 taskfile
->low_cylinder
= 0x4f;
368 taskfile
->high_cylinder
= 0xc2;
369 taskfile
->device_head
= 0;
370 taskfile
->command
= ATA_SMART_CMD
;
372 reqtask
->data_phase
= TASKFILE_OUT
;
373 reqtask
->req_cmd
= IDE_DRIVE_TASK_OUT
;
374 reqtask
->out_size
= 512;
375 reqtask
->in_size
= 0;
377 // copy user data into the task request structure
378 memcpy(task
+sizeof(ide_task_request_t
), data
, 512);
380 if ((retval
=ioctl(get_fd(), HDIO_DRIVE_TASKFILE
, task
))) {
382 pout("Kernel lacks HDIO_DRIVE_TASKFILE support; compile kernel with CONFIG_IDE_TASKFILE_IO set\n");
388 // There are two different types of ioctls(). The HDIO_DRIVE_TASK
390 if (command
==STATUS_CHECK
|| command
==AUTOSAVE
|| command
==AUTO_OFFLINE
){
393 // NOT DOCUMENTED in /usr/src/linux/include/linux/hdreg.h. You
394 // have to read the IDE driver source code. Sigh.
395 // buff[0]: ATA COMMAND CODE REGISTER
396 // buff[1]: ATA FEATURES REGISTER
397 // buff[2]: ATA SECTOR_COUNT
398 // buff[3]: ATA SECTOR NUMBER
399 // buff[4]: ATA CYL LO REGISTER
400 // buff[5]: ATA CYL HI REGISTER
401 // buff[6]: ATA DEVICE HEAD
403 unsigned const char normal_lo
=0x4f, normal_hi
=0xc2;
404 unsigned const char failed_lo
=0xf4, failed_hi
=0x2c;
408 if ((retval
=ioctl(get_fd(), HDIO_DRIVE_TASK
, buff
))) {
409 if (errno
==-EINVAL
) {
410 pout("Error SMART Status command via HDIO_DRIVE_TASK failed");
411 pout("Rebuild older linux 2.2 kernels with HDIO_DRIVE_TASK support added\n");
414 syserror("Error SMART Status command failed");
418 // Cyl low and Cyl high unchanged means "Good SMART status"
419 if (buff
[4]==normal_lo
&& buff
[5]==normal_hi
)
422 // These values mean "Bad SMART status"
423 if (buff
[4]==failed_lo
&& buff
[5]==failed_hi
)
426 // We haven't gotten output that makes sense; print out some debugging info
427 syserror("Error SMART Status command failed");
428 pout("Please get assistance from " PACKAGE_HOMEPAGE
"\n");
429 pout("Register values returned from SMART Status command are:\n");
430 pout("ST =0x%02x\n",(int)buff
[0]);
431 pout("ERR=0x%02x\n",(int)buff
[1]);
432 pout("NS =0x%02x\n",(int)buff
[2]);
433 pout("SC =0x%02x\n",(int)buff
[3]);
434 pout("CL =0x%02x\n",(int)buff
[4]);
435 pout("CH =0x%02x\n",(int)buff
[5]);
436 pout("SEL=0x%02x\n",(int)buff
[6]);
441 // Note to people doing ports to other OSes -- don't worry about
442 // this block -- you can safely ignore it. I have put it here
443 // because under linux when you do IDENTIFY DEVICE to a packet
444 // device, it generates an ugly kernel syslog error message. This
445 // is harmless but frightens users. So this block detects packet
446 // devices and make IDENTIFY DEVICE fail "nicely" without a syslog
449 // If you read only the ATA specs, it appears as if a packet device
450 // *might* respond to the IDENTIFY DEVICE command. This is
451 // misleading - it's because around the time that SFF-8020 was
452 // incorporated into the ATA-3/4 standard, the ATA authors were
453 // sloppy. See SFF-8020 and you will see that ATAPI devices have
454 // *always* had IDENTIFY PACKET DEVICE as a mandatory part of their
455 // command set, and return 'Command Aborted' to IDENTIFY DEVICE.
456 if (command
==IDENTIFY
|| command
==PIDENTIFY
){
457 unsigned short deviceid
[256];
458 // check the device identity, as seen when the system was booted
459 // or the device was FIRST registered. This will not be current
460 // if the user has subsequently changed some of the parameters. If
461 // device is a packet device, swap the command interpretations.
462 if (!ioctl(get_fd(), HDIO_GET_IDENTITY
, deviceid
) && (deviceid
[0] & 0x8000))
463 buff
[0]=(command
==IDENTIFY
)?ATA_IDENTIFY_PACKET_DEVICE
:ATA_IDENTIFY_DEVICE
;
467 // We are now doing the HDIO_DRIVE_CMD type ioctl.
468 if ((ioctl(get_fd(), HDIO_DRIVE_CMD
, buff
)))
471 // CHECK POWER MODE command returns information in the Sector Count
472 // register (buff[3]). Copy to return data buffer.
473 if (command
==CHECK_POWER_MODE
)
474 buff
[HDIO_DRIVE_CMD_OFFSET
]=buff
[2];
476 // if the command returns data then copy it back
478 memcpy(data
, buff
+HDIO_DRIVE_CMD_OFFSET
, copydata
);
483 // >>>>>> Start of general SCSI specific linux code
485 /* Linux specific code.
486 * Historically smartmontools (and smartsuite before it) used the
487 * SCSI_IOCTL_SEND_COMMAND ioctl which is available to all linux device
488 * nodes that use the SCSI subsystem. A better interface has been available
489 * via the SCSI generic (sg) driver but this involves the extra step of
490 * mapping disk devices (e.g. /dev/sda) to the corresponding sg device
491 * (e.g. /dev/sg2). In the linux kernel 2.6 series most of the facilities of
492 * the sg driver have become available via the SG_IO ioctl which is available
493 * on all SCSI devices (on SCSI tape devices from lk 2.6.6).
494 * So the strategy below is to find out if the SG_IO ioctl is available and
495 * if so use it; failing that use the older SCSI_IOCTL_SEND_COMMAND ioctl.
496 * Should work in 2.0, 2.2, 2.4 and 2.6 series linux kernels. */
498 #define MAX_DXFER_LEN 1024 /* can be increased if necessary */
499 #define SEND_IOCTL_RESP_SENSE_LEN 16 /* ioctl limitation */
500 #define SG_IO_RESP_SENSE_LEN 64 /* large enough see buffer */
501 #define LSCSI_DRIVER_MASK 0xf /* mask out "suggestions" */
502 #define LSCSI_DRIVER_SENSE 0x8 /* alternate CHECK CONDITION indication */
503 #define LSCSI_DID_ERROR 0x7 /* Need to work around aacraid driver quirk */
504 #define LSCSI_DRIVER_TIMEOUT 0x6
505 #define LSCSI_DID_TIME_OUT 0x3
506 #define LSCSI_DID_BUS_BUSY 0x2
507 #define LSCSI_DID_NO_CONNECT 0x1
509 #ifndef SCSI_IOCTL_SEND_COMMAND
510 #define SCSI_IOCTL_SEND_COMMAND 1
513 #define SG_IO_PRESENT_UNKNOWN 0
514 #define SG_IO_PRESENT_YES 1
515 #define SG_IO_PRESENT_NO 2
517 static int sg_io_cmnd_io(int dev_fd
, struct scsi_cmnd_io
* iop
, int report
,
519 static int sisc_cmnd_io(int dev_fd
, struct scsi_cmnd_io
* iop
, int report
);
521 static int sg_io_state
= SG_IO_PRESENT_UNKNOWN
;
523 /* Preferred implementation for issuing SCSI commands in linux. This
524 * function uses the SG_IO ioctl. Return 0 if command issued successfully
525 * (various status values should still be checked). If the SCSI command
526 * cannot be issued then a negative errno value is returned. */
527 static int sg_io_cmnd_io(int dev_fd
, struct scsi_cmnd_io
* iop
, int report
,
531 ARGUSED(dev_fd
); ARGUSED(iop
); ARGUSED(report
);
534 struct sg_io_hdr io_hdr
;
538 const unsigned char * ucp
= iop
->cmnd
;
541 const int sz
= (int)sizeof(buff
);
543 np
= scsi_get_opcode_name(ucp
[0]);
544 j
= snprintf(buff
, sz
, " [%s: ", np
? np
: "<unknown opcode>");
545 for (k
= 0; k
< (int)iop
->cmnd_len
; ++k
)
546 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "%02x ", ucp
[k
]);
548 (DXFER_TO_DEVICE
== iop
->dxfer_dir
) && (iop
->dxferp
)) {
549 int trunc
= (iop
->dxfer_len
> 256) ? 1 : 0;
551 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "]\n Outgoing "
552 "data, len=%d%s:\n", (int)iop
->dxfer_len
,
553 (trunc
? " [only first 256 bytes shown]" : ""));
554 dStrHex((const char *)iop
->dxferp
,
555 (trunc
? 256 : iop
->dxfer_len
) , 1);
558 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "]\n");
561 memset(&io_hdr
, 0, sizeof(struct sg_io_hdr
));
562 io_hdr
.interface_id
= 'S';
563 io_hdr
.cmd_len
= iop
->cmnd_len
;
564 io_hdr
.mx_sb_len
= iop
->max_sense_len
;
565 io_hdr
.dxfer_len
= iop
->dxfer_len
;
566 io_hdr
.dxferp
= iop
->dxferp
;
567 io_hdr
.cmdp
= iop
->cmnd
;
568 io_hdr
.sbp
= iop
->sensep
;
569 /* sg_io_hdr interface timeout has millisecond units. Timeout of 0
570 defaults to 60 seconds. */
571 io_hdr
.timeout
= ((0 == iop
->timeout
) ? 60 : iop
->timeout
) * 1000;
572 switch (iop
->dxfer_dir
) {
574 io_hdr
.dxfer_direction
= SG_DXFER_NONE
;
576 case DXFER_FROM_DEVICE
:
577 io_hdr
.dxfer_direction
= SG_DXFER_FROM_DEV
;
579 case DXFER_TO_DEVICE
:
580 io_hdr
.dxfer_direction
= SG_DXFER_TO_DEV
;
583 pout("do_scsi_cmnd_io: bad dxfer_dir\n");
586 iop
->resp_sense_len
= 0;
587 iop
->scsi_status
= 0;
589 if (ioctl(dev_fd
, SG_IO
, &io_hdr
) < 0) {
590 if (report
&& (! unknown
))
591 pout(" SG_IO ioctl failed, errno=%d [%s]\n", errno
,
595 iop
->resid
= io_hdr
.resid
;
596 iop
->scsi_status
= io_hdr
.status
;
598 pout(" scsi_status=0x%x, host_status=0x%x, driver_status=0x%x\n"
599 " info=0x%x duration=%d milliseconds resid=%d\n", io_hdr
.status
,
600 io_hdr
.host_status
, io_hdr
.driver_status
, io_hdr
.info
,
601 io_hdr
.duration
, io_hdr
.resid
);
603 if (DXFER_FROM_DEVICE
== iop
->dxfer_dir
) {
606 len
= iop
->dxfer_len
- iop
->resid
;
607 trunc
= (len
> 256) ? 1 : 0;
609 pout(" Incoming data, len=%d%s:\n", len
,
610 (trunc
? " [only first 256 bytes shown]" : ""));
611 dStrHex((const char*)iop
->dxferp
, (trunc
? 256 : len
),
614 pout(" Incoming data trimmed to nothing by resid\n");
619 if (io_hdr
.info
& SG_INFO_CHECK
) { /* error or warning */
620 int masked_driver_status
= (LSCSI_DRIVER_MASK
& io_hdr
.driver_status
);
622 if (0 != io_hdr
.host_status
) {
623 if ((LSCSI_DID_NO_CONNECT
== io_hdr
.host_status
) ||
624 (LSCSI_DID_BUS_BUSY
== io_hdr
.host_status
) ||
625 (LSCSI_DID_TIME_OUT
== io_hdr
.host_status
))
628 /* Check for DID_ERROR - workaround for aacraid driver quirk */
629 if (LSCSI_DID_ERROR
!= io_hdr
.host_status
) {
630 return -EIO
; /* catch all if not DID_ERR */
633 if (0 != masked_driver_status
) {
634 if (LSCSI_DRIVER_TIMEOUT
== masked_driver_status
)
636 else if (LSCSI_DRIVER_SENSE
!= masked_driver_status
)
639 if (LSCSI_DRIVER_SENSE
== masked_driver_status
)
640 iop
->scsi_status
= SCSI_STATUS_CHECK_CONDITION
;
641 iop
->resp_sense_len
= io_hdr
.sb_len_wr
;
642 if ((SCSI_STATUS_CHECK_CONDITION
== iop
->scsi_status
) &&
643 iop
->sensep
&& (iop
->resp_sense_len
> 0)) {
645 pout(" >>> Sense buffer, len=%d:\n",
646 (int)iop
->resp_sense_len
);
647 dStrHex((const char *)iop
->sensep
, iop
->resp_sense_len
, 1);
651 if (SCSI_STATUS_CHECK_CONDITION
== iop
->scsi_status
) {
652 if ((iop
->sensep
[0] & 0x7f) > 0x71)
653 pout(" status=%x: [desc] sense_key=%x asc=%x ascq=%x\n",
654 iop
->scsi_status
, iop
->sensep
[1] & 0xf,
655 iop
->sensep
[2], iop
->sensep
[3]);
657 pout(" status=%x: sense_key=%x asc=%x ascq=%x\n",
658 iop
->scsi_status
, iop
->sensep
[2] & 0xf,
659 iop
->sensep
[12], iop
->sensep
[13]);
662 pout(" status=0x%x\n", iop
->scsi_status
);
669 struct linux_ioctl_send_command
673 UINT8 buff
[MAX_DXFER_LEN
+ 16];
676 /* The Linux SCSI_IOCTL_SEND_COMMAND ioctl is primitive and it doesn't
677 * support: CDB length (guesses it from opcode), resid and timeout.
678 * Patches in Linux 2.4.21 and 2.5.70 to extend SEND DIAGNOSTIC timeout
679 * to 2 hours in order to allow long foreground extended self tests. */
680 static int sisc_cmnd_io(int dev_fd
, struct scsi_cmnd_io
* iop
, int report
)
682 struct linux_ioctl_send_command wrk
;
683 int status
, buff_offset
;
686 memcpy(wrk
.buff
, iop
->cmnd
, iop
->cmnd_len
);
687 buff_offset
= iop
->cmnd_len
;
690 const unsigned char * ucp
= iop
->cmnd
;
693 const int sz
= (int)sizeof(buff
);
695 np
= scsi_get_opcode_name(ucp
[0]);
696 j
= snprintf(buff
, sz
, " [%s: ", np
? np
: "<unknown opcode>");
697 for (k
= 0; k
< (int)iop
->cmnd_len
; ++k
)
698 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "%02x ", ucp
[k
]);
700 (DXFER_TO_DEVICE
== iop
->dxfer_dir
) && (iop
->dxferp
)) {
701 int trunc
= (iop
->dxfer_len
> 256) ? 1 : 0;
703 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "]\n Outgoing "
704 "data, len=%d%s:\n", (int)iop
->dxfer_len
,
705 (trunc
? " [only first 256 bytes shown]" : ""));
706 dStrHex((const char *)iop
->dxferp
,
707 (trunc
? 256 : iop
->dxfer_len
) , 1);
710 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "]\n");
713 switch (iop
->dxfer_dir
) {
718 case DXFER_FROM_DEVICE
:
720 if (iop
->dxfer_len
> MAX_DXFER_LEN
)
722 wrk
.outbufsize
= iop
->dxfer_len
;
724 case DXFER_TO_DEVICE
:
725 if (iop
->dxfer_len
> MAX_DXFER_LEN
)
727 memcpy(wrk
.buff
+ buff_offset
, iop
->dxferp
, iop
->dxfer_len
);
728 wrk
.inbufsize
= iop
->dxfer_len
;
732 pout("do_scsi_cmnd_io: bad dxfer_dir\n");
735 iop
->resp_sense_len
= 0;
736 iop
->scsi_status
= 0;
738 status
= ioctl(dev_fd
, SCSI_IOCTL_SEND_COMMAND
, &wrk
);
741 pout(" SCSI_IOCTL_SEND_COMMAND ioctl failed, errno=%d [%s]\n",
742 errno
, strerror(errno
));
748 if (DXFER_FROM_DEVICE
== iop
->dxfer_dir
) {
749 memcpy(iop
->dxferp
, wrk
.buff
, iop
->dxfer_len
);
751 int trunc
= (iop
->dxfer_len
> 256) ? 1 : 0;
753 pout(" Incoming data, len=%d%s:\n", (int)iop
->dxfer_len
,
754 (trunc
? " [only first 256 bytes shown]" : ""));
755 dStrHex((const char*)iop
->dxferp
,
756 (trunc
? 256 : iop
->dxfer_len
) , 1);
761 iop
->scsi_status
= status
& 0x7e; /* bits 0 and 7 used to be for vendors */
762 if (LSCSI_DRIVER_SENSE
== ((status
>> 24) & 0xf))
763 iop
->scsi_status
= SCSI_STATUS_CHECK_CONDITION
;
764 len
= (SEND_IOCTL_RESP_SENSE_LEN
< iop
->max_sense_len
) ?
765 SEND_IOCTL_RESP_SENSE_LEN
: iop
->max_sense_len
;
766 if ((SCSI_STATUS_CHECK_CONDITION
== iop
->scsi_status
) &&
767 iop
->sensep
&& (len
> 0)) {
768 memcpy(iop
->sensep
, wrk
.buff
, len
);
769 iop
->resp_sense_len
= len
;
771 pout(" >>> Sense buffer, len=%d:\n", (int)len
);
772 dStrHex((const char *)wrk
.buff
, len
, 1);
776 if (SCSI_STATUS_CHECK_CONDITION
== iop
->scsi_status
) {
777 pout(" status=%x: sense_key=%x asc=%x ascq=%x\n", status
& 0xff,
778 wrk
.buff
[2] & 0xf, wrk
.buff
[12], wrk
.buff
[13]);
781 pout(" status=0x%x\n", status
);
783 if (iop
->scsi_status
> 0)
787 pout(" ioctl status=0x%x but scsi status=0, fail with EIO\n",
789 return -EIO
; /* give up, assume no device there */
793 /* SCSI command transmission interface function, linux version.
794 * Returns 0 if SCSI command successfully launched and response
795 * received. Even when 0 is returned the caller should check
796 * scsi_cmnd_io::scsi_status for SCSI defined errors and warnings
797 * (e.g. CHECK CONDITION). If the SCSI command could not be issued
798 * (e.g. device not present or timeout) or some other problem
799 * (e.g. timeout) then returns a negative errno value */
800 static int do_normal_scsi_cmnd_io(int dev_fd
, struct scsi_cmnd_io
* iop
,
805 /* implementation relies on static sg_io_state variable. If not
806 * previously set tries the SG_IO ioctl. If that succeeds assume
807 * that SG_IO ioctl functional. If it fails with an errno value
808 * other than ENODEV (no device) or permission then assume
809 * SCSI_IOCTL_SEND_COMMAND is the only option. */
810 switch (sg_io_state
) {
811 case SG_IO_PRESENT_UNKNOWN
:
812 /* ignore report argument */
813 if (0 == (res
= sg_io_cmnd_io(dev_fd
, iop
, report
, 1))) {
814 sg_io_state
= SG_IO_PRESENT_YES
;
816 } else if ((-ENODEV
== res
) || (-EACCES
== res
) || (-EPERM
== res
))
817 return res
; /* wait until we see a device */
818 sg_io_state
= SG_IO_PRESENT_NO
;
819 /* drop through by design */
820 case SG_IO_PRESENT_NO
:
821 return sisc_cmnd_io(dev_fd
, iop
, report
);
822 case SG_IO_PRESENT_YES
:
823 return sg_io_cmnd_io(dev_fd
, iop
, report
, 0);
825 pout(">>>> do_scsi_cmnd_io: bad sg_io_state=%d\n", sg_io_state
);
826 sg_io_state
= SG_IO_PRESENT_UNKNOWN
;
827 return -EIO
; /* report error and reset state */
831 // >>>>>> End of general SCSI specific linux code
833 /////////////////////////////////////////////////////////////////////////////
834 /// Standard SCSI support
836 class linux_scsi_device
837 : public /*implements*/ scsi_device
,
838 public /*extends*/ linux_smart_device
841 linux_scsi_device(smart_interface
* intf
, const char * dev_name
,
842 const char * req_type
, bool scanning
= false);
844 virtual smart_device
* autodetect_open();
846 virtual bool scsi_pass_through(scsi_cmnd_io
* iop
);
849 bool m_scanning
; ///< true if created within scan_smart_devices
852 linux_scsi_device::linux_scsi_device(smart_interface
* intf
,
853 const char * dev_name
, const char * req_type
, bool scanning
/*= false*/)
854 : smart_device(intf
, dev_name
, "scsi", req_type
),
855 // If opened with O_RDWR, a SATA disk in standby mode
856 // may spin-up after device close().
857 linux_smart_device(O_RDONLY
| O_NONBLOCK
),
862 bool linux_scsi_device::scsi_pass_through(scsi_cmnd_io
* iop
)
864 int status
= do_normal_scsi_cmnd_io(get_fd(), iop
, scsi_debugmode
);
866 return set_err(-status
);
870 /////////////////////////////////////////////////////////////////////////////
871 /// PMC AacRAID support
873 class linux_aacraid_device
875 public /*extends */ linux_smart_device
878 linux_aacraid_device(smart_interface
*intf
, const char *dev_name
,
879 unsigned int host
, unsigned int channel
, unsigned int device
);
881 virtual ~linux_aacraid_device() throw();
885 virtual bool scsi_pass_through(scsi_cmnd_io
*iop
);
891 //Channel(Lun) of the device
899 linux_aacraid_device::linux_aacraid_device(smart_interface
*intf
,
900 const char *dev_name
, unsigned int host
, unsigned int channel
, unsigned int device
)
901 : smart_device(intf
,dev_name
,"aacraid","aacraid"),
902 linux_smart_device(O_RDWR
|O_NONBLOCK
),
903 aHost(host
), aLun(channel
), aId(device
)
905 set_info().info_name
= strprintf("%s [aacraid_disk_%02d_%02d_%d]",dev_name
,aHost
,aLun
,aId
);
906 set_info().dev_type
= strprintf("aacraid,%d,%d,%d",aHost
,aLun
,aId
);
909 linux_aacraid_device::~linux_aacraid_device() throw()
913 bool linux_aacraid_device::open()
915 //Create the character device name based on the host number
916 //Required for get stats from disks connected to different controllers
918 snprintf(dev_name
, sizeof(dev_name
), "/dev/aac%d", aHost
);
920 //Initial open of dev name to check if it exsists
921 int afd
= ::open(dev_name
,O_RDWR
);
923 if(afd
< 0 && errno
== ENOENT
) {
925 FILE *fp
= fopen("/proc/devices","r");
927 return set_err(errno
,"cannot open /proc/devices:%s",
933 while(fgets(line
,sizeof(line
),fp
) !=NULL
) {
935 if(sscanf(line
,"%d aac%n",&mjr
,&nc
) == 1
936 && nc
> 0 && '\n' == line
[nc
])
941 //work with /proc/devices is done
945 return set_err(ENOENT
, "aac entry not found in /proc/devices");
947 //Create misc device file in /dev/ used for communication with driver
948 if(mknod(dev_name
,S_IFCHR
,makedev(mjr
,aHost
)))
949 return set_err(errno
,"cannot create %s:%s",dev_name
,strerror(errno
));
951 afd
= ::open(dev_name
,O_RDWR
);
955 return set_err(errno
,"cannot open %s:%s",dev_name
,strerror(errno
));
961 bool linux_aacraid_device::scsi_pass_through(scsi_cmnd_io
*iop
)
963 int report
= scsi_debugmode
;
967 const unsigned char * ucp
= iop
->cmnd
;
970 const int sz
= (int)sizeof(buff
);
972 np
= scsi_get_opcode_name(ucp
[0]);
973 j
= snprintf(buff
, sz
, " [%s: ", np
? np
: "<unknown opcode>");
974 for (k
= 0; k
< (int)iop
->cmnd_len
; ++k
)
975 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "%02x ", ucp
[k
]);
977 (DXFER_TO_DEVICE
== iop
->dxfer_dir
) && (iop
->dxferp
)) {
978 int trunc
= (iop
->dxfer_len
> 256) ? 1 : 0;
980 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "]\n Outgoing "
981 "data, len=%d%s:\n", (int)iop
->dxfer_len
,
982 (trunc
? " [only first 256 bytes shown]" : ""));
983 dStrHex((const char *)iop
->dxferp
,
984 (trunc
? 256 : iop
->dxfer_len
) , 1);
987 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "]\n");
993 //return test commands
994 if (iop
->cmnd
[0] == 0x00)
997 user_aac_reply
*pReply
;
1000 // Create user 64 bit request
1001 user_aac_srb64
*pSrb
;
1002 uint8_t aBuff
[sizeof(user_aac_srb64
) + sizeof(user_aac_reply
)] = {0,};
1004 pSrb
= (user_aac_srb64
*)aBuff
;
1005 pSrb
->count
= sizeof(user_aac_srb64
) - sizeof(user_sgentry64
);
1007 #elif defined(ENVIRONMENT32)
1008 //Create user 32 bit request
1009 user_aac_srb32
*pSrb
;
1010 uint8_t aBuff
[sizeof(user_aac_srb32
) + sizeof(user_aac_reply
)] = {0,};
1012 pSrb
= (user_aac_srb32
*)aBuff
;
1013 pSrb
->count
= sizeof(user_aac_srb32
) - sizeof(user_sgentry32
);
1016 pSrb
->function
= SRB_FUNCTION_EXECUTE_SCSI
;
1017 //channel is 0 always
1023 pSrb
->retry_limit
= 0;
1024 pSrb
->cdb_size
= iop
->cmnd_len
;
1026 switch(iop
->dxfer_dir
) {
1028 pSrb
->flags
= SRB_NoDataXfer
;
1030 case DXFER_FROM_DEVICE
:
1031 pSrb
->flags
= SRB_DataIn
;
1033 case DXFER_TO_DEVICE
:
1034 pSrb
->flags
= SRB_DataOut
;
1037 pout("aacraid: bad dxfer_dir\n");
1038 return set_err(EINVAL
, "aacraid: bad dxfer_dir\n");
1041 if(iop
->dxfer_len
> 0) {
1043 #ifdef ENVIRONMENT64
1044 pSrb
->sg64
.count
= 1;
1045 pSrb
->sg64
.sg64
[0].addr64
.lo32
= ((intptr_t)iop
->dxferp
) &
1047 pSrb
->sg64
.sg64
[0].addr64
.hi32
= ((intptr_t)iop
->dxferp
) >> 32;
1049 pSrb
->sg64
.sg64
[0].length
= (uint32_t)iop
->dxfer_len
;
1050 pSrb
->count
+= pSrb
->sg64
.count
* sizeof(user_sgentry64
);
1051 #elif defined(ENVIRONMENT32)
1052 pSrb
->sg32
.count
= 1;
1053 pSrb
->sg32
.sg32
[0].addr32
= (intptr_t)iop
->dxferp
;
1055 pSrb
->sg32
.sg32
[0].length
= (uint32_t)iop
->dxfer_len
;
1056 pSrb
->count
+= pSrb
->sg32
.count
* sizeof(user_sgentry32
);
1061 pReply
= (user_aac_reply
*)(aBuff
+pSrb
->count
);
1063 memcpy(pSrb
->cdb
,iop
->cmnd
,iop
->cmnd_len
);
1067 rc
= ioctl(get_fd(),FSACTL_SEND_RAW_SRB
,pSrb
);
1070 return set_err(errno
, "aacraid send_raw_srb: %d.%d = %s",
1071 aLun
, aId
, strerror(errno
));
1073 /* see kernel aacraid.h and MSDN SCSI_REQUEST_BLOCK documentation */
1074 #define SRB_STATUS_SUCCESS 0x1
1075 #define SRB_STATUS_ERROR 0x4
1076 #define SRB_STATUS_NO_DEVICE 0x08
1077 #define SRB_STATUS_SELECTION_TIMEOUT 0x0a
1078 #define SRB_STATUS_AUTOSENSE_VALID 0x80
1080 iop
->scsi_status
= pReply
->scsi_status
;
1082 if (pReply
->srb_status
== (SRB_STATUS_AUTOSENSE_VALID
| SRB_STATUS_ERROR
)
1083 && iop
->scsi_status
== SCSI_STATUS_CHECK_CONDITION
) {
1084 memcpy(iop
->sensep
, pReply
->sense_data
, pReply
->sense_data_size
);
1085 iop
->resp_sense_len
= pReply
->sense_data_size
;
1086 return true; /* request completed with sense data */
1089 switch (pReply
->srb_status
& 0x3f) {
1091 case SRB_STATUS_SUCCESS
:
1092 return true; /* request completed successfully */
1094 case SRB_STATUS_NO_DEVICE
:
1095 return set_err(EIO
, "aacraid: Device %d %d does not exist", aLun
, aId
);
1097 case SRB_STATUS_SELECTION_TIMEOUT
:
1098 return set_err(EIO
, "aacraid: Device %d %d not responding", aLun
, aId
);
1101 return set_err(EIO
, "aacraid result: %d.%d = 0x%x",
1102 aLun
, aId
, pReply
->srb_status
);
1107 /////////////////////////////////////////////////////////////////////////////
1108 /// LSI MegaRAID support
1110 class linux_megaraid_device
1111 : public /* implements */ scsi_device
,
1112 public /* extends */ linux_smart_device
1115 linux_megaraid_device(smart_interface
*intf
, const char *name
,
1116 unsigned int bus
, unsigned int tgt
);
1118 virtual ~linux_megaraid_device() throw();
1120 virtual smart_device
* autodetect_open();
1122 virtual bool open();
1123 virtual bool close();
1125 virtual bool scsi_pass_through(scsi_cmnd_io
*iop
);
1128 unsigned int m_disknum
;
1129 unsigned int m_busnum
;
1133 bool (linux_megaraid_device::*pt_cmd
)(int cdblen
, void *cdb
, int dataLen
, void *data
,
1134 int senseLen
, void *sense
, int report
, int direction
);
1135 bool megasas_cmd(int cdbLen
, void *cdb
, int dataLen
, void *data
,
1136 int senseLen
, void *sense
, int report
, int direction
);
1137 bool megadev_cmd(int cdbLen
, void *cdb
, int dataLen
, void *data
,
1138 int senseLen
, void *sense
, int report
, int direction
);
1141 linux_megaraid_device::linux_megaraid_device(smart_interface
*intf
,
1142 const char *dev_name
, unsigned int bus
, unsigned int tgt
)
1143 : smart_device(intf
, dev_name
, "megaraid", "megaraid"),
1144 linux_smart_device(O_RDWR
| O_NONBLOCK
),
1145 m_disknum(tgt
), m_busnum(bus
), m_hba(0),
1148 set_info().info_name
= strprintf("%s [megaraid_disk_%02d]", dev_name
, m_disknum
);
1149 set_info().dev_type
= strprintf("megaraid,%d", tgt
);
1152 linux_megaraid_device::~linux_megaraid_device() throw()
1158 smart_device
* linux_megaraid_device::autodetect_open()
1160 int report
= scsi_debugmode
;
1166 // The code below is based on smartd.cpp:SCSIFilterKnown()
1167 if (strcmp(get_req_type(), "megaraid"))
1171 unsigned char req_buff
[64] = {0, };
1173 if (scsiStdInquiry(this, req_buff
, req_len
)) {
1175 set_err(EIO
, "INQUIRY failed");
1179 int avail_len
= req_buff
[4] + 5;
1180 int len
= (avail_len
< req_len
? avail_len
: req_len
);
1185 pout("Got MegaRAID inquiry.. %s\n", req_buff
+8);
1187 // Use INQUIRY to detect type
1190 ata_device
* newdev
= smi()->autodetect_sat_device(this, req_buff
, len
);
1191 if (newdev
) // NOTE: 'this' is now owned by '*newdev'
1195 // Nothing special found
1199 bool linux_megaraid_device::open()
1203 int report
= scsi_debugmode
;
1205 if(sscanf(get_dev_name(),"/dev/bus/%d", &m_hba
) == 0) {
1206 if (!linux_smart_device::open())
1208 /* Get device HBA */
1209 struct sg_scsi_id sgid
;
1210 if (ioctl(get_fd(), SG_GET_SCSI_ID
, &sgid
) == 0) {
1211 m_hba
= sgid
.host_no
;
1213 else if (ioctl(get_fd(), SCSI_IOCTL_GET_BUS_NUMBER
, &m_hba
) != 0) {
1215 linux_smart_device::close();
1216 return set_err(err
, "can't get bus number");
1217 } // we dont need this device anymore
1218 linux_smart_device::close();
1220 /* Perform mknod of device ioctl node */
1221 FILE * fp
= fopen("/proc/devices", "r");
1222 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
1224 if (sscanf(line
, "%d megaraid_sas_ioctl%n", &mjr
, &n1
) == 1 && n1
== 22) {
1225 n1
=mknod("/dev/megaraid_sas_ioctl_node", S_IFCHR
, makedev(mjr
, 0));
1227 pout("Creating /dev/megaraid_sas_ioctl_node = %d\n", n1
>= 0 ? 0 : errno
);
1228 if (n1
>= 0 || errno
== EEXIST
)
1231 else if (sscanf(line
, "%d megadev%n", &mjr
, &n1
) == 1 && n1
== 11) {
1232 n1
=mknod("/dev/megadev0", S_IFCHR
, makedev(mjr
, 0));
1234 pout("Creating /dev/megadev0 = %d\n", n1
>= 0 ? 0 : errno
);
1235 if (n1
>= 0 || errno
== EEXIST
)
1241 /* Open Device IOCTL node */
1242 if ((m_fd
= ::open("/dev/megaraid_sas_ioctl_node", O_RDWR
)) >= 0) {
1243 pt_cmd
= &linux_megaraid_device::megasas_cmd
;
1245 else if ((m_fd
= ::open("/dev/megadev0", O_RDWR
)) >= 0) {
1246 pt_cmd
= &linux_megaraid_device::megadev_cmd
;
1250 linux_smart_device::close();
1251 return set_err(err
, "cannot open /dev/megaraid_sas_ioctl_node or /dev/megadev0");
1257 bool linux_megaraid_device::close()
1261 m_fd
= -1; m_hba
= 0; pt_cmd
= 0;
1266 bool linux_megaraid_device::scsi_pass_through(scsi_cmnd_io
*iop
)
1268 int report
= scsi_debugmode
;
1272 const unsigned char * ucp
= iop
->cmnd
;
1275 const int sz
= (int)sizeof(buff
);
1277 np
= scsi_get_opcode_name(ucp
[0]);
1278 j
= snprintf(buff
, sz
, " [%s: ", np
? np
: "<unknown opcode>");
1279 for (k
= 0; k
< (int)iop
->cmnd_len
; ++k
)
1280 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "%02x ", ucp
[k
]);
1282 (DXFER_TO_DEVICE
== iop
->dxfer_dir
) && (iop
->dxferp
)) {
1283 int trunc
= (iop
->dxfer_len
> 256) ? 1 : 0;
1285 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "]\n Outgoing "
1286 "data, len=%d%s:\n", (int)iop
->dxfer_len
,
1287 (trunc
? " [only first 256 bytes shown]" : ""));
1288 dStrHex((const char *)iop
->dxferp
,
1289 (trunc
? 256 : iop
->dxfer_len
) , 1);
1292 j
+= snprintf(&buff
[j
], (sz
> j
? (sz
- j
) : 0), "]\n");
1296 // Controller rejects Test Unit Ready
1297 if (iop
->cmnd
[0] == 0x00)
1300 if (iop
->cmnd
[0] == SAT_ATA_PASSTHROUGH_12
|| iop
->cmnd
[0] == SAT_ATA_PASSTHROUGH_16
) {
1301 // Controller does not return ATA output registers in SAT sense data
1302 if (iop
->cmnd
[2] & (1 << 5)) // chk_cond
1303 return set_err(ENOSYS
, "ATA return descriptor not supported by controller firmware");
1305 // SMART WRITE LOG SECTOR causing media errors
1306 if ((iop
->cmnd
[0] == SAT_ATA_PASSTHROUGH_16
// SAT16 WRITE LOG
1307 && iop
->cmnd
[14] == ATA_SMART_CMD
&& iop
->cmnd
[3]==0 && iop
->cmnd
[4] == ATA_SMART_WRITE_LOG_SECTOR
) ||
1308 (iop
->cmnd
[0] == SAT_ATA_PASSTHROUGH_12
// SAT12 WRITE LOG
1309 && iop
->cmnd
[9] == ATA_SMART_CMD
&& iop
->cmnd
[3] == ATA_SMART_WRITE_LOG_SECTOR
))
1311 if(!failuretest_permissive
)
1312 return set_err(ENOSYS
, "SMART WRITE LOG SECTOR may cause problems, try with -T permissive to force");
1316 return (this->*pt_cmd
)(iop
->cmnd_len
, iop
->cmnd
,
1317 iop
->dxfer_len
, iop
->dxferp
,
1318 iop
->max_sense_len
, iop
->sensep
, report
, iop
->dxfer_dir
);
1321 /* Issue passthrough scsi command to PERC5/6 controllers */
1322 bool linux_megaraid_device::megasas_cmd(int cdbLen
, void *cdb
,
1323 int dataLen
, void *data
,
1324 int /*senseLen*/, void * /*sense*/, int /*report*/, int dxfer_dir
)
1326 struct megasas_pthru_frame
*pthru
;
1327 struct megasas_iocpacket uio
;
1330 memset(&uio
, 0, sizeof(uio
));
1331 pthru
= &uio
.frame
.pthru
;
1332 pthru
->cmd
= MFI_CMD_PD_SCSI_IO
;
1333 pthru
->cmd_status
= 0xFF;
1334 pthru
->scsi_status
= 0x0;
1335 pthru
->target_id
= m_disknum
;
1337 pthru
->cdb_len
= cdbLen
;
1339 switch (dxfer_dir
) {
1341 pthru
->flags
= MFI_FRAME_DIR_NONE
;
1343 case DXFER_FROM_DEVICE
:
1344 pthru
->flags
= MFI_FRAME_DIR_READ
;
1346 case DXFER_TO_DEVICE
:
1347 pthru
->flags
= MFI_FRAME_DIR_WRITE
;
1350 pout("megasas_cmd: bad dxfer_dir\n");
1351 return set_err(EINVAL
, "megasas_cmd: bad dxfer_dir\n");
1355 pthru
->sge_count
= 1;
1356 pthru
->data_xfer_len
= dataLen
;
1357 pthru
->sgl
.sge32
[0].phys_addr
= (intptr_t)data
;
1358 pthru
->sgl
.sge32
[0].length
= (uint32_t)dataLen
;
1360 memcpy(pthru
->cdb
, cdb
, cdbLen
);
1362 uio
.host_no
= m_hba
;
1365 uio
.sgl_off
= offsetof(struct megasas_pthru_frame
, sgl
);
1366 uio
.sgl
[0].iov_base
= data
;
1367 uio
.sgl
[0].iov_len
= dataLen
;
1372 rc
= ioctl(m_fd
, MEGASAS_IOC_FIRMWARE
, &uio
);
1373 if (pthru
->cmd_status
|| rc
!= 0) {
1374 if (pthru
->cmd_status
== 12) {
1375 return set_err(EIO
, "megasas_cmd: Device %d does not exist\n", m_disknum
);
1377 return set_err((errno
? errno
: EIO
), "megasas_cmd result: %d.%d = %d/%d",
1378 m_hba
, m_disknum
, errno
,
1384 /* Issue passthrough scsi commands to PERC2/3/4 controllers */
1385 bool linux_megaraid_device::megadev_cmd(int cdbLen
, void *cdb
,
1386 int dataLen
, void *data
,
1387 int /*senseLen*/, void * /*sense*/, int /*report*/, int /* dir */)
1389 struct uioctl_t uio
;
1392 /* Don't issue to the controller */
1396 memset(&uio
, 0, sizeof(uio
));
1397 uio
.inlen
= dataLen
;
1398 uio
.outlen
= dataLen
;
1400 memset(data
, 0, dataLen
);
1401 uio
.ui
.fcs
.opcode
= 0x80; // M_RD_IOCTL_CMD
1402 uio
.ui
.fcs
.adapno
= MKADAP(m_hba
);
1404 uio
.data
.pointer
= (uint8_t *)data
;
1406 uio
.mbox
.cmd
= MEGA_MBOXCMD_PASSTHRU
;
1407 uio
.mbox
.xferaddr
= (intptr_t)&uio
.pthru
;
1410 uio
.pthru
.timeout
= 2;
1411 uio
.pthru
.channel
= 0;
1412 uio
.pthru
.target
= m_disknum
;
1413 uio
.pthru
.cdblen
= cdbLen
;
1414 uio
.pthru
.reqsenselen
= MAX_REQ_SENSE_LEN
;
1415 uio
.pthru
.dataxferaddr
= (intptr_t)data
;
1416 uio
.pthru
.dataxferlen
= dataLen
;
1417 memcpy(uio
.pthru
.cdb
, cdb
, cdbLen
);
1419 rc
=ioctl(m_fd
, MEGAIOCCMD
, &uio
);
1420 if (uio
.pthru
.scsistatus
|| rc
!= 0) {
1421 return set_err((errno
? errno
: EIO
), "megadev_cmd result: %d.%d = %d/%d",
1422 m_hba
, m_disknum
, errno
,
1423 uio
.pthru
.scsistatus
);
1428 /////////////////////////////////////////////////////////////////////////////
1429 /// CCISS RAID support
1431 #ifdef HAVE_LINUX_CCISS_IOCTL_H
1433 class linux_cciss_device
1434 : public /*implements*/ scsi_device
,
1435 public /*extends*/ linux_smart_device
1438 linux_cciss_device(smart_interface
* intf
, const char * name
, unsigned char disknum
);
1440 virtual bool scsi_pass_through(scsi_cmnd_io
* iop
);
1443 unsigned char m_disknum
; ///< Disk number.
1446 linux_cciss_device::linux_cciss_device(smart_interface
* intf
,
1447 const char * dev_name
, unsigned char disknum
)
1448 : smart_device(intf
, dev_name
, "cciss", "cciss"),
1449 linux_smart_device(O_RDWR
| O_NONBLOCK
),
1452 set_info().info_name
= strprintf("%s [cciss_disk_%02d]", dev_name
, disknum
);
1455 bool linux_cciss_device::scsi_pass_through(scsi_cmnd_io
* iop
)
1457 int status
= cciss_io_interface(get_fd(), m_disknum
, iop
, scsi_debugmode
);
1459 return set_err(-status
);
1463 #endif // HAVE_LINUX_CCISS_IOCTL_H
1465 /////////////////////////////////////////////////////////////////////////////
1466 /// AMCC/3ware RAID support
1468 class linux_escalade_device
1469 : public /*implements*/ ata_device
,
1470 public /*extends*/ linux_smart_device
1473 enum escalade_type_t
{
1475 AMCC_3WARE_678K_CHAR
,
1476 AMCC_3WARE_9000_CHAR
,
1477 AMCC_3WARE_9700_CHAR
1480 linux_escalade_device(smart_interface
* intf
, const char * dev_name
,
1481 escalade_type_t escalade_type
, int disknum
);
1483 virtual bool open();
1485 virtual bool ata_pass_through(const ata_cmd_in
& in
, ata_cmd_out
& out
);
1488 escalade_type_t m_escalade_type
; ///< Controller type
1489 int m_disknum
; ///< Disk number.
1492 linux_escalade_device::linux_escalade_device(smart_interface
* intf
, const char * dev_name
,
1493 escalade_type_t escalade_type
, int disknum
)
1494 : smart_device(intf
, dev_name
, "3ware", "3ware"),
1495 linux_smart_device(O_RDONLY
| O_NONBLOCK
),
1496 m_escalade_type(escalade_type
), m_disknum(disknum
)
1498 set_info().info_name
= strprintf("%s [3ware_disk_%02d]", dev_name
, disknum
);
1501 /* This function will setup and fix device nodes for a 3ware controller. */
1502 #define MAJOR_STRING_LENGTH 3
1503 #define DEVICE_STRING_LENGTH 32
1504 #define NODE_STRING_LENGTH 16
1505 static int setup_3ware_nodes(const char *nodename
, const char *driver_name
)
1509 char majorstring
[MAJOR_STRING_LENGTH
+1];
1510 char device_name
[DEVICE_STRING_LENGTH
+1];
1511 char nodestring
[NODE_STRING_LENGTH
];
1512 struct stat stat_buf
;
1516 security_context_t orig_context
= NULL
;
1517 security_context_t node_context
= NULL
;
1518 int selinux_enabled
= is_selinux_enabled();
1519 int selinux_enforced
= security_getenforce();
1522 /* First try to open up /proc/devices */
1523 if (!(file
= fopen("/proc/devices", "r"))) {
1524 pout("Error opening /proc/devices to check/create 3ware device nodes\n");
1526 return 0; // don't fail here: user might not have /proc !
1529 /* Attempt to get device major number */
1530 while (EOF
!= fscanf(file
, "%3s %32s", majorstring
, device_name
)) {
1531 majorstring
[MAJOR_STRING_LENGTH
]='\0';
1532 device_name
[DEVICE_STRING_LENGTH
]='\0';
1533 if (!strncmp(device_name
, nodename
, DEVICE_STRING_LENGTH
)) {
1534 tw_major
= atoi(majorstring
);
1540 /* See if we found a major device number */
1542 pout("No major number for /dev/%s listed in /proc/devices. Is the %s driver loaded?\n", nodename
, driver_name
);
1546 /* Prepare a database of contexts for files in /dev
1547 * and save the current context */
1548 if (selinux_enabled
) {
1549 if (matchpathcon_init_prefix(NULL
, "/dev") < 0)
1550 pout("Error initializing contexts database for /dev");
1551 if (getfscreatecon(&orig_context
) < 0) {
1552 pout("Error retrieving original SELinux fscreate context");
1553 if (selinux_enforced
)
1554 matchpathcon_fini();
1559 /* Now check if nodes are correct */
1560 for (index
=0; index
<16; index
++) {
1561 snprintf(nodestring
, sizeof(nodestring
), "/dev/%s%d", nodename
, index
);
1563 /* Get context of the node and set it as the default */
1564 if (selinux_enabled
) {
1565 if (matchpathcon(nodestring
, S_IRUSR
| S_IWUSR
, &node_context
) < 0) {
1566 pout("Could not retrieve context for %s", nodestring
);
1567 if (selinux_enforced
) {
1572 if (setfscreatecon(node_context
) < 0) {
1573 pout ("Error setting default fscreate context");
1574 if (selinux_enforced
) {
1581 /* Try to stat the node */
1582 if ((stat(nodestring
, &stat_buf
))) {
1583 pout("Node %s does not exist and must be created. Check the udev rules.\n", nodestring
);
1584 /* Create a new node if it doesn't exist */
1585 if (mknod(nodestring
, S_IFCHR
|0600, makedev(tw_major
, index
))) {
1586 pout("problem creating 3ware device nodes %s", nodestring
);
1592 if (selinux_enabled
&& node_context
) {
1593 freecon(node_context
);
1594 node_context
= NULL
;
1601 /* See if nodes major and minor numbers are correct */
1602 if ((tw_major
!= (int)(major(stat_buf
.st_rdev
))) ||
1603 (index
!= (int)(minor(stat_buf
.st_rdev
))) ||
1604 (!S_ISCHR(stat_buf
.st_mode
))) {
1605 pout("Node %s has wrong major/minor number and must be created anew."
1606 " Check the udev rules.\n", nodestring
);
1607 /* Delete the old node */
1608 if (unlink(nodestring
)) {
1609 pout("problem unlinking stale 3ware device node %s", nodestring
);
1615 /* Make a new node */
1616 if (mknod(nodestring
, S_IFCHR
|0600, makedev(tw_major
, index
))) {
1617 pout("problem creating 3ware device nodes %s", nodestring
);
1624 if (selinux_enabled
&& node_context
) {
1625 freecon(node_context
);
1626 node_context
= NULL
;
1632 if (selinux_enabled
) {
1633 if(setfscreatecon(orig_context
) < 0) {
1634 pout("Error re-setting original fscreate context");
1635 if (selinux_enforced
)
1639 freecon(orig_context
);
1641 freecon(node_context
);
1642 matchpathcon_fini();
1648 bool linux_escalade_device::open()
1650 if (m_escalade_type
== AMCC_3WARE_9700_CHAR
|| m_escalade_type
== AMCC_3WARE_9000_CHAR
||
1651 m_escalade_type
== AMCC_3WARE_678K_CHAR
) {
1652 // the device nodes for these controllers are dynamically assigned,
1653 // so we need to check that they exist with the correct major
1654 // numbers and if not, create them
1655 const char * node
= (m_escalade_type
== AMCC_3WARE_9700_CHAR
? "twl" :
1656 m_escalade_type
== AMCC_3WARE_9000_CHAR
? "twa" :
1658 const char * driver
= (m_escalade_type
== AMCC_3WARE_9700_CHAR
? "3w-sas" :
1659 m_escalade_type
== AMCC_3WARE_9000_CHAR
? "3w-9xxx" :
1661 if (setup_3ware_nodes(node
, driver
))
1662 return set_err((errno
? errno
: ENXIO
), "setup_3ware_nodes(\"%s\", \"%s\") failed", node
, driver
);
1664 // Continue with default open
1665 return linux_smart_device::open();
1668 // TODO: Function no longer useful
1669 //void printwarning(smart_command_set command);
1672 // This is an interface routine meant to isolate the OS dependent
1673 // parts of the code, and to provide a debugging interface. Each
1674 // different port and OS needs to provide it's own interface. This
1675 // is the linux interface to the 3ware 3w-xxxx driver. It allows ATA
1676 // commands to be passed through the SCSI driver.
1677 // DETAILED DESCRIPTION OF ARGUMENTS
1678 // fd: is the file descriptor provided by open()
1679 // disknum is the disk number (0 to 15) in the RAID array
1680 // escalade_type indicates the type of controller type, and if scsi or char interface is used
1681 // command: defines the different operations.
1682 // select: additional input data if needed (which log, which type of
1684 // data: location to write output data, if needed (512 bytes).
1685 // Note: not all commands use all arguments.
1687 // -1 if the command failed
1688 // 0 if the command succeeded,
1689 // STATUS_CHECK routine:
1690 // -1 if the command failed
1691 // 0 if the command succeeded and disk SMART status is "OK"
1692 // 1 if the command succeeded and disk SMART status is "FAILING"
1694 /* 512 is the max payload size: increase if needed */
1695 #define BUFFER_LEN_678K ( sizeof(TW_Ioctl) ) // 1044 unpacked, 1041 packed
1696 #define BUFFER_LEN_678K_CHAR ( sizeof(TW_New_Ioctl)+512-1 ) // 1539 unpacked, 1536 packed
1697 #define BUFFER_LEN_9000 ( sizeof(TW_Ioctl_Buf_Apache)+512-1 ) // 2051 unpacked, 2048 packed
1698 #define TW_IOCTL_BUFFER_SIZE ( MAX(MAX(BUFFER_LEN_678K, BUFFER_LEN_9000), BUFFER_LEN_678K_CHAR) )
1700 bool linux_escalade_device::ata_pass_through(const ata_cmd_in
& in
, ata_cmd_out
& out
)
1702 if (!ata_cmd_is_ok(in
,
1703 true, // data_out_support
1704 false, // TODO: multi_sector_support
1705 true) // ata_48bit_support
1709 // Used by both the SCSI and char interfaces
1710 TW_Passthru
*passthru
=NULL
;
1711 char ioctl_buffer
[TW_IOCTL_BUFFER_SIZE
];
1713 // only used for SCSI device interface
1714 TW_Ioctl
*tw_ioctl
=NULL
;
1715 TW_Output
*tw_output
=NULL
;
1717 // only used for 6000/7000/8000 char device interface
1718 TW_New_Ioctl
*tw_ioctl_char
=NULL
;
1720 // only used for 9000 character device interface
1721 TW_Ioctl_Buf_Apache
*tw_ioctl_apache
=NULL
;
1723 memset(ioctl_buffer
, 0, TW_IOCTL_BUFFER_SIZE
);
1725 // TODO: Handle controller differences by different classes
1726 if (m_escalade_type
== AMCC_3WARE_9700_CHAR
|| m_escalade_type
== AMCC_3WARE_9000_CHAR
) {
1727 tw_ioctl_apache
= (TW_Ioctl_Buf_Apache
*)ioctl_buffer
;
1728 tw_ioctl_apache
->driver_command
.control_code
= TW_IOCTL_FIRMWARE_PASS_THROUGH
;
1729 tw_ioctl_apache
->driver_command
.buffer_length
= 512; /* payload size */
1730 passthru
= (TW_Passthru
*)&(tw_ioctl_apache
->firmware_command
.command
.oldcommand
);
1732 else if (m_escalade_type
==AMCC_3WARE_678K_CHAR
) {
1733 tw_ioctl_char
= (TW_New_Ioctl
*)ioctl_buffer
;
1734 tw_ioctl_char
->data_buffer_length
= 512;
1735 passthru
= (TW_Passthru
*)&(tw_ioctl_char
->firmware_command
);
1737 else if (m_escalade_type
==AMCC_3WARE_678K
) {
1738 tw_ioctl
= (TW_Ioctl
*)ioctl_buffer
;
1739 tw_ioctl
->cdb
[0] = TW_IOCTL
;
1740 tw_ioctl
->opcode
= TW_ATA_PASSTHRU
;
1741 tw_ioctl
->input_length
= 512; // correct even for non-data commands
1742 tw_ioctl
->output_length
= 512; // correct even for non-data commands
1743 tw_output
= (TW_Output
*)tw_ioctl
;
1744 passthru
= (TW_Passthru
*)&(tw_ioctl
->input_data
);
1747 return set_err(ENOSYS
,
1748 "Unrecognized escalade_type %d in linux_3ware_command_interface(disk %d)\n"
1749 "Please contact " PACKAGE_BUGREPORT
"\n", (int)m_escalade_type
, m_disknum
);
1752 // Same for (almost) all commands - but some reset below
1753 passthru
->byte0
.opcode
= TW_OP_ATA_PASSTHRU
;
1754 passthru
->request_id
= 0xFF;
1755 passthru
->unit
= m_disknum
;
1756 passthru
->status
= 0;
1757 passthru
->flags
= 0x1;
1761 const ata_in_regs_48bit
& r
= in
.in_regs
;
1762 passthru
->features
= r
.features_16
;
1763 passthru
->sector_count
= r
.sector_count_16
;
1764 passthru
->sector_num
= r
.lba_low_16
;
1765 passthru
->cylinder_lo
= r
.lba_mid_16
;
1766 passthru
->cylinder_hi
= r
.lba_high_16
;
1767 passthru
->drive_head
= r
.device
;
1768 passthru
->command
= r
.command
;
1771 // Is this a command that reads or returns 512 bytes?
1772 // passthru->param values are:
1773 // 0x0 - non data command without TFR write check,
1774 // 0x8 - non data command with TFR write check,
1775 // 0xD - data command that returns data to host from device
1776 // 0xF - data command that writes data from host to device
1777 // passthru->size values are 0x5 for non-data and 0x07 for data
1778 bool readdata
= false;
1779 if (in
.direction
== ata_cmd_in::data_in
) {
1781 passthru
->byte0
.sgloff
= 0x5;
1782 passthru
->size
= 0x7; // TODO: Other value for multi-sector ?
1783 passthru
->param
= 0xD;
1784 // For 64-bit to work correctly, up the size of the command packet
1785 // in dwords by 1 to account for the 64-bit single sgl 'address'
1786 // field. Note that this doesn't agree with the typedefs but it's
1787 // right (agree with kernel driver behavior/typedefs).
1788 if ((m_escalade_type
== AMCC_3WARE_9700_CHAR
|| m_escalade_type
== AMCC_3WARE_9000_CHAR
)
1789 && sizeof(long) == 8)
1792 else if (in
.direction
== ata_cmd_in::no_data
) {
1793 // Non data command -- but doesn't use large sector
1794 // count register values.
1795 passthru
->byte0
.sgloff
= 0x0;
1796 passthru
->size
= 0x5;
1797 passthru
->param
= 0x8;
1798 passthru
->sector_count
= 0x0;
1800 else if (in
.direction
== ata_cmd_in::data_out
) {
1801 if (m_escalade_type
== AMCC_3WARE_9700_CHAR
|| m_escalade_type
== AMCC_3WARE_9000_CHAR
)
1802 memcpy(tw_ioctl_apache
->data_buffer
, in
.buffer
, in
.size
);
1803 else if (m_escalade_type
== AMCC_3WARE_678K_CHAR
)
1804 memcpy(tw_ioctl_char
->data_buffer
, in
.buffer
, in
.size
);
1806 // COMMAND NOT SUPPORTED VIA SCSI IOCTL INTERFACE
1807 // memcpy(tw_output->output_data, data, 512);
1808 // printwarning(command); // TODO: Parameter no longer valid
1809 return set_err(ENOTSUP
, "DATA OUT not supported for this 3ware controller type");
1811 passthru
->byte0
.sgloff
= 0x5;
1812 passthru
->size
= 0x7; // TODO: Other value for multi-sector ?
1813 passthru
->param
= 0xF; // PIO data write
1814 if ((m_escalade_type
== AMCC_3WARE_9700_CHAR
|| m_escalade_type
== AMCC_3WARE_9000_CHAR
)
1815 && sizeof(long) == 8)
1819 return set_err(EINVAL
);
1821 // Now send the command down through an ioctl()
1823 if (m_escalade_type
== AMCC_3WARE_9700_CHAR
|| m_escalade_type
== AMCC_3WARE_9000_CHAR
)
1824 ioctlreturn
=ioctl(get_fd(), TW_IOCTL_FIRMWARE_PASS_THROUGH
, tw_ioctl_apache
);
1825 else if (m_escalade_type
==AMCC_3WARE_678K_CHAR
)
1826 ioctlreturn
=ioctl(get_fd(), TW_CMD_PACKET_WITH_DATA
, tw_ioctl_char
);
1828 ioctlreturn
=ioctl(get_fd(), SCSI_IOCTL_SEND_COMMAND
, tw_ioctl
);
1830 // Deal with the different error cases
1832 if (AMCC_3WARE_678K
==m_escalade_type
1833 && in
.in_regs
.command
==ATA_SMART_CMD
1834 && ( in
.in_regs
.features
== ATA_SMART_AUTO_OFFLINE
1835 || in
.in_regs
.features
== ATA_SMART_AUTOSAVE
)
1836 && in
.in_regs
.lba_low
) {
1837 // error here is probably a kernel driver whose version is too old
1838 // printwarning(command); // TODO: Parameter no longer valid
1839 return set_err(ENOTSUP
, "Probably kernel driver too old");
1841 return set_err(EIO
);
1844 // The passthru structure is valid after return from an ioctl if:
1845 // - we are using the character interface OR
1846 // - we are using the SCSI interface and this is a NON-READ-DATA command
1847 // For SCSI interface, note that we set passthru to a different
1848 // value after ioctl().
1849 if (AMCC_3WARE_678K
==m_escalade_type
) {
1853 passthru
=(TW_Passthru
*)&(tw_output
->output_data
);
1856 // See if the ATA command failed. Now that we have returned from
1857 // the ioctl() call, if passthru is valid, then:
1858 // - passthru->status contains the 3ware controller STATUS
1859 // - passthru->command contains the ATA STATUS register
1860 // - passthru->features contains the ATA ERROR register
1862 // Check bits 0 (error bit) and 5 (device fault) of the ATA STATUS
1863 // If bit 0 (error bit) is set, then ATA ERROR register is valid.
1864 // While we *might* decode the ATA ERROR register, at the moment it
1865 // doesn't make much sense: we don't care in detail why the error
1868 if (passthru
&& (passthru
->status
|| (passthru
->command
& 0x21))) {
1869 return set_err(EIO
);
1872 // If this is a read data command, copy data to output buffer
1874 if (m_escalade_type
== AMCC_3WARE_9700_CHAR
|| m_escalade_type
== AMCC_3WARE_9000_CHAR
)
1875 memcpy(in
.buffer
, tw_ioctl_apache
->data_buffer
, in
.size
);
1876 else if (m_escalade_type
==AMCC_3WARE_678K_CHAR
)
1877 memcpy(in
.buffer
, tw_ioctl_char
->data_buffer
, in
.size
);
1879 memcpy(in
.buffer
, tw_output
->output_data
, in
.size
);
1882 // Return register values
1884 ata_out_regs_48bit
& r
= out
.out_regs
;
1885 r
.error
= passthru
->features
;
1886 r
.sector_count_16
= passthru
->sector_count
;
1887 r
.lba_low_16
= passthru
->sector_num
;
1888 r
.lba_mid_16
= passthru
->cylinder_lo
;
1889 r
.lba_high_16
= passthru
->cylinder_hi
;
1890 r
.device
= passthru
->drive_head
;
1891 r
.status
= passthru
->command
;
1894 // look for nonexistent devices/ports
1895 if ( in
.in_regs
.command
== ATA_IDENTIFY_DEVICE
1896 && !nonempty(in
.buffer
, in
.size
)) {
1897 return set_err(ENODEV
, "No drive on port %d", m_disknum
);
1903 /////////////////////////////////////////////////////////////////////////////
1904 /// Areca RAID support
1906 ///////////////////////////////////////////////////////////////////
1907 // SATA(ATA) device behind Areca RAID Controller
1908 class linux_areca_ata_device
1909 : public /*implements*/ areca_ata_device
,
1910 public /*extends*/ linux_smart_device
1913 linux_areca_ata_device(smart_interface
* intf
, const char * dev_name
, int disknum
, int encnum
= 1);
1914 virtual smart_device
* autodetect_open();
1915 virtual bool arcmsr_lock();
1916 virtual bool arcmsr_unlock();
1917 virtual int arcmsr_do_scsi_io(struct scsi_cmnd_io
* iop
);
1920 ///////////////////////////////////////////////////////////////////
1921 // SAS(SCSI) device behind Areca RAID Controller
1922 class linux_areca_scsi_device
1923 : public /*implements*/ areca_scsi_device
,
1924 public /*extends*/ linux_smart_device
1927 linux_areca_scsi_device(smart_interface
* intf
, const char * dev_name
, int disknum
, int encnum
= 1);
1928 virtual smart_device
* autodetect_open();
1929 virtual bool arcmsr_lock();
1930 virtual bool arcmsr_unlock();
1931 virtual int arcmsr_do_scsi_io(struct scsi_cmnd_io
* iop
);
1934 // Looks in /proc/scsi to suggest correct areca devices
1935 static int find_areca_in_proc()
1937 const char* proc_format_string
="host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n";
1939 // check data formwat
1940 FILE *fp
=fopen("/proc/scsi/sg/device_hdr", "r");
1942 pout("Unable to open /proc/scsi/sg/device_hdr for reading\n");
1946 // get line, compare to format
1949 char *out
= fgets(linebuf
, 256, fp
);
1952 pout("Unable to read contents of /proc/scsi/sg/device_hdr\n");
1956 if (strcmp(linebuf
, proc_format_string
)) {
1958 // Fix this by comparing only tokens not white space!!
1959 pout("Unexpected format %s in /proc/scsi/sg/device_hdr\n", proc_format_string
);
1963 // Format is understood, now search for correct device
1964 fp
=fopen("/proc/scsi/sg/devices", "r");
1966 int host
, chan
, id
, lun
, type
, opens
, qdepth
, busy
, online
;
1969 // search all lines of /proc/scsi/sg/devices
1970 while (9 == fscanf(fp
, "%d %d %d %d %d %d %d %d %d", &host
, &chan
, &id
, &lun
, &type
, &opens
, &qdepth
, &busy
, &online
)) {
1972 if (id
== 16 && type
== 3) {
1973 // devices with id=16 and type=3 might be Areca controllers
1974 pout("Device /dev/sg%d appears to be an Areca controller.\n", dev
);
1982 // Areca RAID Controller(SATA Disk)
1983 linux_areca_ata_device::linux_areca_ata_device(smart_interface
* intf
, const char * dev_name
, int disknum
, int encnum
)
1984 : smart_device(intf
, dev_name
, "areca", "areca"),
1985 linux_smart_device(O_RDWR
| O_EXCL
| O_NONBLOCK
)
1987 set_disknum(disknum
);
1989 set_info().info_name
= strprintf("%s [areca_disk#%02d_enc#%02d]", dev_name
, disknum
, encnum
);
1992 smart_device
* linux_areca_ata_device::autodetect_open()
1996 // autodetect device type
1997 is_ata
= arcmsr_get_dev_type();
2011 smart_device_auto_ptr
newdev(new linux_areca_scsi_device(smi(), get_dev_name(), get_disknum(), get_encnum()));
2014 newdev
->open(); // TODO: Can possibly pass open fd
2016 return newdev
.release();
2019 int linux_areca_ata_device::arcmsr_do_scsi_io(struct scsi_cmnd_io
* iop
)
2021 int ioctlreturn
= 0;
2025 find_areca_in_proc();
2029 ioctlreturn
= do_normal_scsi_cmnd_io(get_fd(), iop
, scsi_debugmode
);
2030 if ( ioctlreturn
|| iop
->scsi_status
)
2039 bool linux_areca_ata_device::arcmsr_lock()
2044 bool linux_areca_ata_device::arcmsr_unlock()
2049 // Areca RAID Controller(SAS Device)
2050 linux_areca_scsi_device::linux_areca_scsi_device(smart_interface
* intf
, const char * dev_name
, int disknum
, int encnum
)
2051 : smart_device(intf
, dev_name
, "areca", "areca"),
2052 linux_smart_device(O_RDWR
| O_EXCL
| O_NONBLOCK
)
2054 set_disknum(disknum
);
2056 set_info().info_name
= strprintf("%s [areca_disk#%02d_enc#%02d]", dev_name
, disknum
, encnum
);
2059 smart_device
* linux_areca_scsi_device::autodetect_open()
2064 int linux_areca_scsi_device::arcmsr_do_scsi_io(struct scsi_cmnd_io
* iop
)
2066 int ioctlreturn
= 0;
2070 find_areca_in_proc();
2074 ioctlreturn
= do_normal_scsi_cmnd_io(get_fd(), iop
, scsi_debugmode
);
2075 if ( ioctlreturn
|| iop
->scsi_status
)
2084 bool linux_areca_scsi_device::arcmsr_lock()
2089 bool linux_areca_scsi_device::arcmsr_unlock()
2094 /////////////////////////////////////////////////////////////////////////////
2097 class linux_marvell_device
2098 : public /*implements*/ ata_device_with_command_set
,
2099 public /*extends*/ linux_smart_device
2102 linux_marvell_device(smart_interface
* intf
, const char * dev_name
, const char * req_type
);
2105 virtual int ata_command_interface(smart_command_set command
, int select
, char * data
);
2108 linux_marvell_device::linux_marvell_device(smart_interface
* intf
,
2109 const char * dev_name
, const char * req_type
)
2110 : smart_device(intf
, dev_name
, "marvell", req_type
),
2111 linux_smart_device(O_RDONLY
| O_NONBLOCK
)
2115 int linux_marvell_device::ata_command_interface(smart_command_set command
, int select
, char * data
)
2124 mvsata_scsi_cmd smart_command
;
2125 unsigned char *buff
= (unsigned char *)&smart_command
.cmd
[6];
2126 // See struct hd_drive_cmd_hdr in hdreg.h
2127 // buff[0]: ATA COMMAND CODE REGISTER
2128 // buff[1]: ATA SECTOR NUMBER REGISTER
2129 // buff[2]: ATA FEATURES REGISTER
2130 // buff[3]: ATA SECTOR COUNT REGISTER
2132 // clear out buff. Large enough for HDIO_DRIVE_CMD (4+512 bytes)
2133 memset(&smart_command
, 0, sizeof(smart_command
));
2134 smart_command
.inlen
= 540;
2135 smart_command
.outlen
= 540;
2136 smart_command
.cmd
[0] = 0xC; //Vendor-specific code
2137 smart_command
.cmd
[4] = 6; //command length
2139 buff
[0] = ATA_SMART_CMD
;
2141 case CHECK_POWER_MODE
:
2142 buff
[0]=ATA_CHECK_POWER_MODE
;
2145 buff
[2]=ATA_SMART_READ_VALUES
;
2148 case READ_THRESHOLDS
:
2149 buff
[2]=ATA_SMART_READ_THRESHOLDS
;
2150 copydata
=buff
[1]=buff
[3]=1;
2153 buff
[2]=ATA_SMART_READ_LOG_SECTOR
;
2158 buff
[0]=ATA_IDENTIFY_DEVICE
;
2162 buff
[0]=ATA_IDENTIFY_PACKET_DEVICE
;
2166 buff
[2]=ATA_SMART_ENABLE
;
2170 buff
[2]=ATA_SMART_DISABLE
;
2175 // this command only says if SMART is working. It could be
2176 // replaced with STATUS_CHECK below.
2177 buff
[2] = ATA_SMART_STATUS
;
2180 buff
[2]=ATA_SMART_AUTO_OFFLINE
;
2181 buff
[3]=select
; // YET NOTE - THIS IS A NON-DATA COMMAND!!
2184 buff
[2]=ATA_SMART_AUTOSAVE
;
2185 buff
[3]=select
; // YET NOTE - THIS IS A NON-DATA COMMAND!!
2187 case IMMEDIATE_OFFLINE
:
2188 buff
[2]=ATA_SMART_IMMEDIATE_OFFLINE
;
2192 pout("Unrecognized command %d in mvsata_os_specific_handler()\n", command
);
2196 // There are two different types of ioctls(). The HDIO_DRIVE_TASK
2198 // We are now doing the HDIO_DRIVE_CMD type ioctl.
2199 if (ioctl(get_fd(), SCSI_IOCTL_SEND_COMMAND
, (void *)&smart_command
))
2202 if (command
==CHECK_POWER_MODE
) {
2203 // LEON -- CHECK THIS PLEASE. THIS SHOULD BE THE SECTOR COUNT
2204 // REGISTER, AND IT MIGHT BE buff[2] NOT buff[3]. Bruce
2209 // Always succeed on a SMART status, as a disk that failed returned
2210 // buff[4]=0xF4, buff[5]=0x2C, i.e. "Bad SMART status" (see below).
2211 if (command
== STATUS
)
2213 //Data returned is starting from 0 offset
2214 if (command
== STATUS_CHECK
)
2216 // Cyl low and Cyl high unchanged means "Good SMART status"
2217 if (buff
[4] == 0x4F && buff
[5] == 0xC2)
2219 // These values mean "Bad SMART status"
2220 if (buff
[4] == 0xF4 && buff
[5] == 0x2C)
2222 // We haven't gotten output that makes sense; print out some debugging info
2223 syserror("Error SMART Status command failed");
2224 pout("Please get assistance from %s\n",PACKAGE_BUGREPORT
);
2225 pout("Register values returned from SMART Status command are:\n");
2226 pout("CMD =0x%02x\n",(int)buff
[0]);
2227 pout("FR =0x%02x\n",(int)buff
[1]);
2228 pout("NS =0x%02x\n",(int)buff
[2]);
2229 pout("SC =0x%02x\n",(int)buff
[3]);
2230 pout("CL =0x%02x\n",(int)buff
[4]);
2231 pout("CH =0x%02x\n",(int)buff
[5]);
2232 pout("SEL=0x%02x\n",(int)buff
[6]);
2237 memcpy(data
, buff
, 512);
2241 /////////////////////////////////////////////////////////////////////////////
2242 /// Highpoint RAID support
2244 class linux_highpoint_device
2245 : public /*implements*/ ata_device_with_command_set
,
2246 public /*extends*/ linux_smart_device
2249 linux_highpoint_device(smart_interface
* intf
, const char * dev_name
,
2250 unsigned char controller
, unsigned char channel
, unsigned char port
);
2253 virtual int ata_command_interface(smart_command_set command
, int select
, char * data
);
2256 unsigned char m_hpt_data
[3]; ///< controller/channel/port
2259 linux_highpoint_device::linux_highpoint_device(smart_interface
* intf
, const char * dev_name
,
2260 unsigned char controller
, unsigned char channel
, unsigned char port
)
2261 : smart_device(intf
, dev_name
, "hpt", "hpt"),
2262 linux_smart_device(O_RDONLY
| O_NONBLOCK
)
2264 m_hpt_data
[0] = controller
; m_hpt_data
[1] = channel
; m_hpt_data
[2] = port
;
2265 set_info().info_name
= strprintf("%s [hpt_disk_%u/%u/%u]", dev_name
, m_hpt_data
[0], m_hpt_data
[1], m_hpt_data
[2]);
2268 // this implementation is derived from ata_command_interface with a header
2269 // packing for highpoint linux driver ioctl interface
2271 // ioctl(fd,HPTIO_CTL,buff)
2274 // structure of hpt_buff
2275 // +----+----+----+----+--------------------.....---------------------+
2276 // | 1 | 2 | 3 | 4 | 5 |
2277 // +----+----+----+----+--------------------.....---------------------+
2279 // 1: The target controller [ int ( 4 Bytes ) ]
2280 // 2: The channel of the target controllee [ int ( 4 Bytes ) ]
2281 // 3: HDIO_ ioctl call [ int ( 4 Bytes ) ]
2282 // available from ${LINUX_KERNEL_SOURCE}/Documentation/ioctl/hdio
2283 // 4: the pmport that disk attached, [ int ( 4 Bytes ) ]
2284 // if no pmport device, set to 1 or leave blank
2285 // 5: data [ void * ( var leangth ) ]
2287 #define STRANGE_BUFFER_LENGTH (4+512*0xf8)
2289 int linux_highpoint_device::ata_command_interface(smart_command_set command
, int select
, char * data
)
2291 unsigned char hpt_buff
[4*sizeof(int) + STRANGE_BUFFER_LENGTH
];
2292 unsigned int *hpt
= (unsigned int *)hpt_buff
;
2293 unsigned char *buff
= &hpt_buff
[4*sizeof(int)];
2295 const int HDIO_DRIVE_CMD_OFFSET
= 4;
2297 memset(hpt_buff
, 0, 4*sizeof(int) + STRANGE_BUFFER_LENGTH
);
2298 hpt
[0] = m_hpt_data
[0]; // controller id
2299 hpt
[1] = m_hpt_data
[1]; // channel number
2300 hpt
[3] = m_hpt_data
[2]; // pmport number
2302 buff
[0]=ATA_SMART_CMD
;
2304 case CHECK_POWER_MODE
:
2305 buff
[0]=ATA_CHECK_POWER_MODE
;
2309 buff
[2]=ATA_SMART_READ_VALUES
;
2313 case READ_THRESHOLDS
:
2314 buff
[2]=ATA_SMART_READ_THRESHOLDS
;
2319 buff
[2]=ATA_SMART_READ_LOG_SECTOR
;
2327 buff
[0]=ATA_IDENTIFY_DEVICE
;
2332 buff
[0]=ATA_IDENTIFY_PACKET_DEVICE
;
2337 buff
[2]=ATA_SMART_ENABLE
;
2341 buff
[2]=ATA_SMART_DISABLE
;
2345 buff
[2]=ATA_SMART_STATUS
;
2348 buff
[2]=ATA_SMART_AUTO_OFFLINE
;
2352 buff
[2]=ATA_SMART_AUTOSAVE
;
2355 case IMMEDIATE_OFFLINE
:
2356 buff
[2]=ATA_SMART_IMMEDIATE_OFFLINE
;
2360 buff
[1]=ATA_SMART_STATUS
;
2363 pout("Unrecognized command %d in linux_highpoint_command_interface()\n"
2364 "Please contact " PACKAGE_BUGREPORT
"\n", command
);
2369 if (command
==WRITE_LOG
) {
2370 unsigned char task
[4*sizeof(int)+sizeof(ide_task_request_t
)+512];
2371 unsigned int *hpt_tf
= (unsigned int *)task
;
2372 ide_task_request_t
*reqtask
= (ide_task_request_t
*)(&task
[4*sizeof(int)]);
2373 task_struct_t
*taskfile
= (task_struct_t
*)reqtask
->io_ports
;
2376 memset(task
, 0, sizeof(task
));
2378 hpt_tf
[0] = m_hpt_data
[0]; // controller id
2379 hpt_tf
[1] = m_hpt_data
[1]; // channel number
2380 hpt_tf
[3] = m_hpt_data
[2]; // pmport number
2381 hpt_tf
[2] = HDIO_DRIVE_TASKFILE
; // real hd ioctl
2384 taskfile
->feature
= ATA_SMART_WRITE_LOG_SECTOR
;
2385 taskfile
->sector_count
= 1;
2386 taskfile
->sector_number
= select
;
2387 taskfile
->low_cylinder
= 0x4f;
2388 taskfile
->high_cylinder
= 0xc2;
2389 taskfile
->device_head
= 0;
2390 taskfile
->command
= ATA_SMART_CMD
;
2392 reqtask
->data_phase
= TASKFILE_OUT
;
2393 reqtask
->req_cmd
= IDE_DRIVE_TASK_OUT
;
2394 reqtask
->out_size
= 512;
2395 reqtask
->in_size
= 0;
2397 memcpy(task
+sizeof(ide_task_request_t
)+4*sizeof(int), data
, 512);
2399 if ((retval
=ioctl(get_fd(), HPTIO_CTL
, task
))) {
2400 if (retval
==-EINVAL
)
2401 pout("Kernel lacks HDIO_DRIVE_TASKFILE support; compile kernel with CONFIG_IDE_TASKFILE_IO set\n");
2407 if (command
==STATUS_CHECK
){
2409 unsigned const char normal_lo
=0x4f, normal_hi
=0xc2;
2410 unsigned const char failed_lo
=0xf4, failed_hi
=0x2c;
2414 hpt
[2] = HDIO_DRIVE_TASK
;
2416 if ((retval
=ioctl(get_fd(), HPTIO_CTL
, hpt_buff
))) {
2417 if (retval
==-EINVAL
) {
2418 pout("Error SMART Status command via HDIO_DRIVE_TASK failed");
2419 pout("Rebuild older linux 2.2 kernels with HDIO_DRIVE_TASK support added\n");
2422 syserror("Error SMART Status command failed");
2426 if (buff
[4]==normal_lo
&& buff
[5]==normal_hi
)
2429 if (buff
[4]==failed_lo
&& buff
[5]==failed_hi
)
2432 syserror("Error SMART Status command failed");
2433 pout("Please get assistance from " PACKAGE_HOMEPAGE
"\n");
2434 pout("Register values returned from SMART Status command are:\n");
2435 pout("CMD=0x%02x\n",(int)buff
[0]);
2436 pout("FR =0x%02x\n",(int)buff
[1]);
2437 pout("NS =0x%02x\n",(int)buff
[2]);
2438 pout("SC =0x%02x\n",(int)buff
[3]);
2439 pout("CL =0x%02x\n",(int)buff
[4]);
2440 pout("CH =0x%02x\n",(int)buff
[5]);
2441 pout("SEL=0x%02x\n",(int)buff
[6]);
2446 if (command
==IDENTIFY
|| command
==PIDENTIFY
) {
2447 unsigned char deviceid
[4*sizeof(int)+512*sizeof(char)];
2448 unsigned int *hpt_id
= (unsigned int *)deviceid
;
2450 hpt_id
[0] = m_hpt_data
[0]; // controller id
2451 hpt_id
[1] = m_hpt_data
[1]; // channel number
2452 hpt_id
[3] = m_hpt_data
[2]; // pmport number
2454 hpt_id
[2] = HDIO_GET_IDENTITY
;
2455 if (!ioctl(get_fd(), HPTIO_CTL
, deviceid
) && (deviceid
[4*sizeof(int)] & 0x8000))
2456 buff
[0]=(command
==IDENTIFY
)?ATA_IDENTIFY_PACKET_DEVICE
:ATA_IDENTIFY_DEVICE
;
2460 hpt
[2] = HDIO_DRIVE_CMD
;
2461 if ((ioctl(get_fd(), HPTIO_CTL
, hpt_buff
)))
2464 if (command
==CHECK_POWER_MODE
)
2465 buff
[HDIO_DRIVE_CMD_OFFSET
]=buff
[2];
2468 memcpy(data
, buff
+HDIO_DRIVE_CMD_OFFSET
, copydata
);
2473 #if 0 // TODO: Migrate from 'smart_command_set' to 'ata_in_regs' OR remove the function
2474 // Utility function for printing warnings
2475 void printwarning(smart_command_set command
){
2476 static int printed
[4]={0,0,0,0};
2477 const char* message
=
2478 "can not be passed through the 3ware 3w-xxxx driver. This can be fixed by\n"
2479 "applying a simple 3w-xxxx driver patch that can be found here:\n"
2480 PACKAGE_HOMEPAGE
"\n"
2481 "Alternatively, upgrade your 3w-xxxx driver to version 1.02.00.037 or greater.\n\n";
2483 if (command
==AUTO_OFFLINE
&& !printed
[0]) {
2485 pout("The SMART AUTO-OFFLINE ENABLE command (smartmontools -o on option/Directive)\n%s", message
);
2487 else if (command
==AUTOSAVE
&& !printed
[1]) {
2489 pout("The SMART AUTOSAVE ENABLE command (smartmontools -S on option/Directive)\n%s", message
);
2491 else if (command
==STATUS_CHECK
&& !printed
[2]) {
2493 pout("The SMART RETURN STATUS return value (smartmontools -H option/Directive)\n%s", message
);
2495 else if (command
==WRITE_LOG
&& !printed
[3]) {
2497 pout("The SMART WRITE LOG command (smartmontools -t selective) only supported via char /dev/tw[ae] interface\n");
2504 /////////////////////////////////////////////////////////////////////////////
2505 /// SCSI open with autodetection support
2507 smart_device
* linux_scsi_device::autodetect_open()
2513 // No Autodetection if device type was specified by user
2514 bool sat_only
= false;
2515 if (*get_req_type()) {
2516 // Detect SAT if device object was created by scan_smart_devices().
2517 if (!(m_scanning
&& !strcmp(get_req_type(), "sat")))
2522 // The code below is based on smartd.cpp:SCSIFilterKnown()
2525 unsigned char req_buff
[64] = {0, };
2527 if (scsiStdInquiry(this, req_buff
, req_len
)) {
2528 // Marvell controllers fail on a 36 bytes StdInquiry, but 64 suffices
2529 // watch this spot ... other devices could lock up here
2531 if (scsiStdInquiry(this, req_buff
, req_len
)) {
2532 // device doesn't like INQUIRY commands
2534 set_err(EIO
, "INQUIRY failed");
2539 int avail_len
= req_buff
[4] + 5;
2540 int len
= (avail_len
< req_len
? avail_len
: req_len
);
2544 set_err(EIO
, "INQUIRY too short for SAT");
2549 // Use INQUIRY to detect type
2553 if (!memcmp(req_buff
+ 8, "3ware", 5) || !memcmp(req_buff
+ 8, "AMCC", 4)) {
2555 set_err(EINVAL
, "AMCC/3ware controller, please try adding '-d 3ware,N',\n"
2556 "you may need to replace %s with /dev/twlN, /dev/twaN or /dev/tweN", get_dev_name());
2561 if (!memcmp(req_buff
+ 8, "DELL PERC", 12) || !memcmp(req_buff
+ 8, "MegaRAID", 8)
2562 || !memcmp(req_buff
+ 16, "PERC H700", 9) || !memcmp(req_buff
+ 8, "LSI\0",4)
2565 set_err(EINVAL
, "DELL or MegaRaid controller, please try adding '-d megaraid,N'");
2570 if (len
>= 42 && !memcmp(req_buff
+ 36, "MVSATA", 6)) {
2571 //pout("Device %s: using '-d marvell' for ATA disk with Marvell driver\n", get_dev_name());
2573 smart_device_auto_ptr
newdev(
2574 new linux_marvell_device(smi(), get_dev_name(), get_req_type())
2576 newdev
->open(); // TODO: Can possibly pass open fd
2578 return newdev
.release();
2584 smart_device
* newdev
= smi()->autodetect_sat_device(this, req_buff
, len
);
2586 // NOTE: 'this' is now owned by '*newdev'
2590 // Nothing special found
2594 set_err(EIO
, "Not a SAT device");
2599 //////////////////////////////////////////////////////////////////////
2600 // USB bridge ID detection
2602 // Read USB ID from /sys file
2603 static bool read_id(const std::string
& path
, unsigned short & id
)
2605 FILE * f
= fopen(path
.c_str(), "r");
2609 bool ok
= (fscanf(f
, "%hx%n", &id
, &n
) == 1 && n
== 4);
2614 // Get USB bridge ID for "sdX"
2615 static bool get_usb_id(const char * name
, unsigned short & vendor_id
,
2616 unsigned short & product_id
, unsigned short & version
)
2618 // Only "sdX" supported
2619 if (!(!strncmp(name
, "sd", 2) && !strchr(name
, '/')))
2622 // Start search at dir referenced by symlink "/sys/block/sdX/device"
2623 // -> "/sys/devices/.../usb*/.../host*/target*/..."
2624 std::string dir
= strprintf("/sys/block/%s/device", name
);
2626 // Stop search at "/sys/devices"
2628 if (stat("/sys/devices", &st
))
2630 ino_t stop_ino
= st
.st_ino
;
2632 // Search in parent directories until "idVendor" is found,
2633 // fail if "/sys/devices" reached or too many iterations
2637 if (!(++cnt
< 10 && !stat(dir
.c_str(), &st
) && st
.st_ino
!= stop_ino
))
2639 } while (access((dir
+ "/idVendor").c_str(), 0));
2642 if (!( read_id(dir
+ "/idVendor", vendor_id
)
2643 && read_id(dir
+ "/idProduct", product_id
)
2644 && read_id(dir
+ "/bcdDevice", version
) ))
2647 if (scsi_debugmode
> 1)
2648 pout("USB ID = 0x%04x:0x%04x (0x%03x)\n", vendor_id
, product_id
, version
);
2652 //////////////////////////////////////////////////////////////////////
2655 class linux_smart_interface
2656 : public /*implements*/ smart_interface
2659 virtual std::string
get_os_version_str();
2661 virtual std::string
get_app_examples(const char * appname
);
2663 virtual bool scan_smart_devices(smart_device_list
& devlist
, const char * type
,
2664 const char * pattern
= 0);
2667 virtual ata_device
* get_ata_device(const char * name
, const char * type
);
2669 virtual scsi_device
* get_scsi_device(const char * name
, const char * type
);
2671 virtual smart_device
* autodetect_smart_device(const char * name
);
2673 virtual smart_device
* get_custom_smart_device(const char * name
, const char * type
);
2675 virtual std::string
get_valid_custom_dev_types_str();
2678 bool get_dev_list(smart_device_list
& devlist
, const char * pattern
,
2679 bool scan_ata
, bool scan_scsi
, const char * req_type
, bool autodetect
);
2680 bool get_dev_megasas(smart_device_list
& devlist
);
2681 smart_device
* missing_option(const char * opt
);
2682 int megasas_dcmd_cmd(int bus_no
, uint32_t opcode
, void *buf
,
2683 size_t bufsize
, uint8_t *mbox
, size_t mboxlen
, uint8_t *statusp
);
2684 int megasas_pd_add_list(int bus_no
, smart_device_list
& devlist
);
2687 std::string
linux_smart_interface::get_os_version_str()
2691 return strprintf("%s-linux-%s", u
.machine
, u
.release
);
2693 return SMARTMONTOOLS_BUILD_HOST
;
2696 std::string
linux_smart_interface::get_app_examples(const char * appname
)
2698 if (!strcmp(appname
, "smartctl"))
2699 return smartctl_examples
;
2703 // we are going to take advantage of the fact that Linux's devfs will only
2704 // have device entries for devices that exist.
2705 bool linux_smart_interface::get_dev_list(smart_device_list
& devlist
,
2706 const char * pattern
, bool scan_ata
, bool scan_scsi
,
2707 const char * req_type
, bool autodetect
)
2709 // Use glob to look for any directory entries matching the pattern
2711 memset(&globbuf
, 0, sizeof(globbuf
));
2712 int retglob
= glob(pattern
, GLOB_ERR
, NULL
, &globbuf
);
2714 // glob failed: free memory and return
2717 if (retglob
==GLOB_NOMATCH
){
2718 pout("glob(3) found no matches for pattern %s\n", pattern
);
2722 if (retglob
==GLOB_NOSPACE
)
2723 set_err(ENOMEM
, "glob(3) ran out of memory matching pattern %s", pattern
);
2724 #ifdef GLOB_ABORTED // missing in old versions of glob.h
2725 else if (retglob
==GLOB_ABORTED
)
2726 set_err(EINVAL
, "glob(3) aborted matching pattern %s", pattern
);
2729 set_err(EINVAL
, "Unexplained error in glob(3) of pattern %s", pattern
);
2734 // did we find too many paths?
2735 const int max_pathc
= 1024;
2736 int n
= (int)globbuf
.gl_pathc
;
2737 if (n
> max_pathc
) {
2738 pout("glob(3) found %d > MAX=%d devices matching pattern %s: ignoring %d paths\n",
2739 n
, max_pathc
, pattern
, n
- max_pathc
);
2743 // now step through the list returned by glob. If not a link, copy
2744 // to list. If it is a link, evaluate it and see if the path ends
2746 for (int i
= 0; i
< n
; i
++){
2747 // see if path is a link
2749 int retlink
= readlink(globbuf
.gl_pathv
[i
], linkbuf
, sizeof(linkbuf
)-1);
2751 char tmpname
[1024]={0};
2752 const char * name
= 0;
2753 bool is_scsi
= scan_scsi
;
2754 // if not a link (or a strange link), keep it
2755 if (retlink
<=0 || retlink
>1023)
2756 name
= globbuf
.gl_pathv
[i
];
2758 // or if it's a link that points to a disc, follow it
2759 linkbuf
[retlink
] = 0;
2761 if ((p
=strrchr(linkbuf
, '/')) && !strcmp(p
+1, "disc"))
2762 // This is the branch of the code that gets followed if we are
2763 // using devfs WITH traditional compatibility links. In this
2764 // case, we add the traditional device name to the list that
2766 name
= globbuf
.gl_pathv
[i
];
2768 // This is the branch of the code that gets followed if we are
2769 // using devfs WITHOUT traditional compatibility links. In
2770 // this case, we check that the link to the directory is of
2771 // the correct type, and then append "disc" to it.
2772 bool match_ata
= strstr(linkbuf
, "ide");
2773 bool match_scsi
= strstr(linkbuf
, "scsi");
2774 if (((match_ata
&& scan_ata
) || (match_scsi
&& scan_scsi
)) && !(match_ata
&& match_scsi
)) {
2775 is_scsi
= match_scsi
;
2776 snprintf(tmpname
, sizeof(tmpname
), "%s/disc", globbuf
.gl_pathv
[i
]);
2783 // Found a name, add device to list.
2786 dev
= autodetect_smart_device(name
);
2788 dev
= new linux_scsi_device(this, name
, req_type
, true /*scanning*/);
2790 dev
= new linux_ata_device(this, name
, req_type
);
2791 if (dev
) // autodetect_smart_device() may return nullptr.
2792 devlist
.push_back(dev
);
2801 // getting devices from LSI SAS MegaRaid, if available
2802 bool linux_smart_interface::get_dev_megasas(smart_device_list
& devlist
)
2804 /* Scanning of disks on MegaRaid device */
2805 /* Perform mknod of device ioctl node */
2808 bool scan_megasas
= false;
2809 FILE * fp
= fopen("/proc/devices", "r");
2810 while (fgets(line
, sizeof(line
), fp
) != NULL
) {
2812 if (sscanf(line
, "%d megaraid_sas_ioctl%n", &mjr
, &n1
) == 1 && n1
== 22) {
2813 scan_megasas
= true;
2814 n1
=mknod("/dev/megaraid_sas_ioctl_node", S_IFCHR
, makedev(mjr
, 0));
2815 if(scsi_debugmode
> 0)
2816 pout("Creating /dev/megaraid_sas_ioctl_node = %d\n", n1
>= 0 ? 0 : errno
);
2817 if (n1
>= 0 || errno
== EEXIST
)
2826 // getting bus numbers with megasas devices
2828 unsigned int host_no
= 0;
2831 /* we are using sysfs to get list of all scsi hosts */
2832 DIR * dp
= opendir ("/sys/class/scsi_host/");
2835 while ((ep
= readdir (dp
)) != NULL
) {
2836 if (!sscanf(ep
->d_name
, "host%d", &host_no
))
2838 /* proc_name should be megaraid_sas */
2839 snprintf(sysfsdir
, sizeof(sysfsdir
) - 1,
2840 "/sys/class/scsi_host/host%d/proc_name", host_no
);
2841 if((fp
= fopen(sysfsdir
, "r")) == NULL
)
2843 if(fgets(line
, sizeof(line
), fp
) != NULL
&& !strncmp(line
,"megaraid_sas",12)) {
2844 megasas_pd_add_list(host_no
, devlist
);
2848 (void) closedir (dp
);
2849 } else { /* sysfs not mounted ? */
2850 for(unsigned i
= 0; i
<=16; i
++) // trying to add devices on first 16 buses
2851 megasas_pd_add_list(i
, devlist
);
2856 bool linux_smart_interface::scan_smart_devices(smart_device_list
& devlist
,
2857 const char * type
, const char * pattern
/*= 0*/)
2860 set_err(EINVAL
, "DEVICESCAN with pattern not implemented yet");
2867 bool scan_ata
= (!*type
|| !strcmp(type
, "ata" ));
2868 // "sat" detection will be later handled in linux_scsi_device::autodetect_open()
2869 bool scan_scsi
= (!*type
|| !strcmp(type
, "scsi") || !strcmp(type
, "sat"));
2870 if (!(scan_ata
|| scan_scsi
))
2874 get_dev_list(devlist
, "/dev/hd[a-t]", true, false, type
, false);
2876 bool autodetect
= !*type
; // Try USB autodetection if no type specifed
2877 get_dev_list(devlist
, "/dev/sd[a-z]", false, true, type
, autodetect
);
2878 // Support up to 104 devices
2879 get_dev_list(devlist
, "/dev/sd[a-c][a-z]", false, true, type
, autodetect
);
2880 // get device list from the megaraid device
2881 get_dev_megasas(devlist
);
2884 // if we found traditional links, we are done
2885 if (devlist
.size() > 0)
2888 // else look for devfs entries without traditional links
2889 // TODO: Add udev support
2890 return get_dev_list(devlist
, "/dev/discs/disc*", scan_ata
, scan_scsi
, type
, false);
2893 ata_device
* linux_smart_interface::get_ata_device(const char * name
, const char * type
)
2895 return new linux_ata_device(this, name
, type
);
2898 scsi_device
* linux_smart_interface::get_scsi_device(const char * name
, const char * type
)
2900 return new linux_scsi_device(this, name
, type
);
2903 smart_device
* linux_smart_interface::missing_option(const char * opt
)
2905 set_err(EINVAL
, "requires option '%s'", opt
);
2910 linux_smart_interface::megasas_dcmd_cmd(int bus_no
, uint32_t opcode
, void *buf
,
2911 size_t bufsize
, uint8_t *mbox
, size_t mboxlen
, uint8_t *statusp
)
2913 struct megasas_iocpacket ioc
;
2915 if ((mbox
!= NULL
&& (mboxlen
== 0 || mboxlen
> MFI_MBOX_SIZE
)) ||
2916 (mbox
== NULL
&& mboxlen
!= 0))
2922 bzero(&ioc
, sizeof(ioc
));
2923 struct megasas_dcmd_frame
* dcmd
= &ioc
.frame
.dcmd
;
2924 ioc
.host_no
= bus_no
;
2926 bcopy(mbox
, dcmd
->mbox
.w
, mboxlen
);
2927 dcmd
->cmd
= MFI_CMD_DCMD
;
2930 dcmd
->data_xfer_len
= bufsize
;
2931 dcmd
->opcode
= opcode
;
2934 dcmd
->sge_count
= 1;
2935 dcmd
->data_xfer_len
= bufsize
;
2936 dcmd
->sgl
.sge32
[0].phys_addr
= (intptr_t)buf
;
2937 dcmd
->sgl
.sge32
[0].length
= (uint32_t)bufsize
;
2939 ioc
.sgl_off
= offsetof(struct megasas_dcmd_frame
, sgl
);
2940 ioc
.sgl
[0].iov_base
= buf
;
2941 ioc
.sgl
[0].iov_len
= bufsize
;
2945 if ((fd
= ::open("/dev/megaraid_sas_ioctl_node", O_RDWR
)) <= 0) {
2949 int r
= ioctl(fd
, MEGASAS_IOC_FIRMWARE
, &ioc
);
2955 if (statusp
!= NULL
)
2956 *statusp
= dcmd
->cmd_status
;
2957 else if (dcmd
->cmd_status
!= MFI_STAT_OK
) {
2958 fprintf(stderr
, "command %x returned error status %x\n",
2959 opcode
, dcmd
->cmd_status
);
2967 linux_smart_interface::megasas_pd_add_list(int bus_no
, smart_device_list
& devlist
)
2970 * Keep fetching the list in a loop until we have a large enough
2971 * buffer to hold the entire list.
2973 megasas_pd_list
* list
= 0;
2974 for (unsigned list_size
= 1024; ; ) {
2975 list
= (megasas_pd_list
*)realloc(list
, list_size
);
2977 throw std::bad_alloc();
2978 bzero(list
, list_size
);
2979 if (megasas_dcmd_cmd(bus_no
, MFI_DCMD_PD_GET_LIST
, list
, list_size
, NULL
, 0,
2985 if (list
->size
<= list_size
)
2987 list_size
= list
->size
;
2990 // adding all SCSI devices
2991 for (unsigned i
= 0; i
< list
->count
; i
++) {
2992 if(list
->addr
[i
].scsi_dev_type
)
2993 continue; /* non disk device found */
2995 snprintf(line
, sizeof(line
) - 1, "/dev/bus/%d", bus_no
);
2996 smart_device
* dev
= new linux_megaraid_device(this, line
, 0, list
->addr
[i
].device_id
);
2997 devlist
.push_back(dev
);
3003 // Return kernel release as integer ("2.6.31" -> 206031)
3004 static unsigned get_kernel_release()
3009 unsigned x
= 0, y
= 0, z
= 0;
3010 if (!(sscanf(u
.release
, "%u.%u.%u", &x
, &y
, &z
) == 3
3011 && x
< 100 && y
< 100 && z
< 1000 ))
3013 return x
* 100000 + y
* 1000 + z
;
3016 // Guess device type (ata or scsi) based on device name (Linux
3017 // specific) SCSI device name in linux can be sd, sr, scd, st, nst,
3018 // osst, nosst and sg.
3019 smart_device
* linux_smart_interface::autodetect_smart_device(const char * name
)
3021 const char * test_name
= name
;
3023 // Dereference symlinks
3025 std::string pathbuf
;
3026 if (!lstat(name
, &st
) && S_ISLNK(st
.st_mode
)) {
3027 char * p
= realpath(name
, (char *)0);
3031 test_name
= pathbuf
.c_str();
3035 // Remove the leading /dev/... if it's there
3036 static const char dev_prefix
[] = "/dev/";
3037 if (str_starts_with(test_name
, dev_prefix
))
3038 test_name
+= strlen(dev_prefix
);
3040 // form /dev/h* or h*
3041 if (str_starts_with(test_name
, "h"))
3042 return new linux_ata_device(this, name
, "");
3044 // form /dev/ide/* or ide/*
3045 if (str_starts_with(test_name
, "ide/"))
3046 return new linux_ata_device(this, name
, "");
3048 // form /dev/s* or s*
3049 if (str_starts_with(test_name
, "s")) {
3051 // Try to detect possible USB->(S)ATA bridge
3052 unsigned short vendor_id
= 0, product_id
= 0, version
= 0;
3053 if (get_usb_id(test_name
, vendor_id
, product_id
, version
)) {
3054 const char * usbtype
= get_usb_dev_type_by_id(vendor_id
, product_id
, version
);
3058 // Kernels before 2.6.29 do not support the sense data length
3059 // required for SAT ATA PASS-THROUGH(16)
3060 if (!strcmp(usbtype
, "sat") && get_kernel_release() < 206029)
3063 // Return SAT/USB device for this type
3064 // (Note: linux_scsi_device::autodetect_open() will not be called in this case)
3065 return get_sat_device(usbtype
, new linux_scsi_device(this, name
, ""));
3068 // No USB bridge found, assume regular SCSI device
3069 return new linux_scsi_device(this, name
, "");
3072 // form /dev/scsi/* or scsi/*
3073 if (str_starts_with(test_name
, "scsi/"))
3074 return new linux_scsi_device(this, name
, "");
3076 // form /dev/ns* or ns*
3077 if (str_starts_with(test_name
, "ns"))
3078 return new linux_scsi_device(this, name
, "");
3080 // form /dev/os* or os*
3081 if (str_starts_with(test_name
, "os"))
3082 return new linux_scsi_device(this, name
, "");
3084 // form /dev/nos* or nos*
3085 if (str_starts_with(test_name
, "nos"))
3086 return new linux_scsi_device(this, name
, "");
3088 // form /dev/tw[ael]* or tw[ael]*
3089 if (str_starts_with(test_name
, "tw") && strchr("ael", test_name
[2]))
3090 return missing_option("-d 3ware,N");
3092 // form /dev/cciss/* or cciss/*
3093 if (str_starts_with(test_name
, "cciss/"))
3094 return missing_option("-d cciss,N");
3096 // we failed to recognize any of the forms
3100 smart_device
* linux_smart_interface::get_custom_smart_device(const char * name
, const char * type
)
3103 if (!strcmp(type
, "marvell"))
3104 return new linux_marvell_device(this, name
, type
);
3107 int disknum
= -1, n1
= -1, n2
= -1;
3108 if (sscanf(type
, "3ware,%n%d%n", &n1
, &disknum
, &n2
) == 1 || n1
== 6) {
3109 if (n2
!= (int)strlen(type
)) {
3110 set_err(EINVAL
, "Option -d 3ware,N requires N to be a non-negative integer");
3113 if (!(0 <= disknum
&& disknum
<= 127)) {
3114 set_err(EINVAL
, "Option -d 3ware,N (N=%d) must have 0 <= N <= 127", disknum
);
3118 if (!strncmp(name
, "/dev/twl", 8))
3119 return new linux_escalade_device(this, name
, linux_escalade_device::AMCC_3WARE_9700_CHAR
, disknum
);
3120 else if (!strncmp(name
, "/dev/twa", 8))
3121 return new linux_escalade_device(this, name
, linux_escalade_device::AMCC_3WARE_9000_CHAR
, disknum
);
3122 else if (!strncmp(name
, "/dev/twe", 8))
3123 return new linux_escalade_device(this, name
, linux_escalade_device::AMCC_3WARE_678K_CHAR
, disknum
);
3125 return new linux_escalade_device(this, name
, linux_escalade_device::AMCC_3WARE_678K
, disknum
);
3129 disknum
= n1
= n2
= -1;
3131 if (sscanf(type
, "areca,%n%d/%d%n", &n1
, &disknum
, &encnum
, &n2
) >= 1 || n1
== 6) {
3132 if (!(1 <= disknum
&& disknum
<= 128)) {
3133 set_err(EINVAL
, "Option -d areca,N/E (N=%d) must have 1 <= N <= 128", disknum
);
3136 if (!(1 <= encnum
&& encnum
<= 8)) {
3137 set_err(EINVAL
, "Option -d areca,N/E (E=%d) must have 1 <= E <= 8", encnum
);
3140 return new linux_areca_ata_device(this, name
, disknum
, encnum
);
3144 int controller
= -1, channel
= -1; disknum
= 1;
3145 n1
= n2
= -1; int n3
= -1;
3146 if (sscanf(type
, "hpt,%n%d/%d%n/%d%n", &n1
, &controller
, &channel
, &n2
, &disknum
, &n3
) >= 2 || n1
== 4) {
3147 int len
= strlen(type
);
3148 if (!(n2
== len
|| n3
== len
)) {
3149 set_err(EINVAL
, "Option '-d hpt,L/M/N' supports 2-3 items");
3152 if (!(1 <= controller
&& controller
<= 8)) {
3153 set_err(EINVAL
, "Option '-d hpt,L/M/N' invalid controller id L supplied");
3156 if (!(1 <= channel
&& channel
<= 128)) {
3157 set_err(EINVAL
, "Option '-d hpt,L/M/N' invalid channel number M supplied");
3160 if (!(1 <= disknum
&& disknum
<= 15)) {
3161 set_err(EINVAL
, "Option '-d hpt,L/M/N' invalid pmport number N supplied");
3164 return new linux_highpoint_device(this, name
, controller
, channel
, disknum
);
3167 #ifdef HAVE_LINUX_CCISS_IOCTL_H
3169 disknum
= n1
= n2
= -1;
3170 if (sscanf(type
, "cciss,%n%d%n", &n1
, &disknum
, &n2
) == 1 || n1
== 6) {
3171 if (n2
!= (int)strlen(type
)) {
3172 set_err(EINVAL
, "Option -d cciss,N requires N to be a non-negative integer");
3175 if (!(0 <= disknum
&& disknum
<= 127)) {
3176 set_err(EINVAL
, "Option -d cciss,N (N=%d) must have 0 <= N <= 127", disknum
);
3179 return get_sat_device("sat,auto", new linux_cciss_device(this, name
, disknum
));
3181 #endif // HAVE_LINUX_CCISS_IOCTL_H
3184 if (sscanf(type
, "megaraid,%d", &disknum
) == 1) {
3185 return new linux_megaraid_device(this, name
, 0, disknum
);
3189 unsigned int device
;
3191 if(sscanf(type
, "aacraid,%d,%d,%d", &host
, &channel
, &device
)==3) {
3192 //return new linux_aacraid_device(this,name,channel,device);
3193 return get_sat_device("sat,auto",
3194 new linux_aacraid_device(this, name
, host
, channel
, device
));
3201 std::string
linux_smart_interface::get_valid_custom_dev_types_str()
3203 return "marvell, areca,N/E, 3ware,N, hpt,L/M/N, megaraid,N, aacraid,H,L,ID"
3204 #ifdef HAVE_LINUX_CCISS_IOCTL_H
3212 /////////////////////////////////////////////////////////////////////////////
3213 /// Initialize platform interface and register with smi()
3215 void smart_interface::init()
3217 static os_linux::linux_smart_interface the_interface
;
3218 smart_interface::set(&the_interface
);