sioc_io.7 (2010 09)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages

sioc_io(7) sioc_io(7)

NAME

sioc_io - SCSI pass-through interface

DESCRIPTION

SCSI devices are controlled by a device-speciﬁc driver, when one exists. Device-speciﬁc drivers, such as

those for SCSI direct access (disk) and sequential access (tape) devices, coordinate device and driver

states to accomplish correct logical device behavior. The

sioc_io pass-through interface enables the

use of SCSI devices and commands not normally supported by these device-speciﬁc drivers. It is com-

posed of two ioctls:

SIOC_IO_EXT, and SIOC_IO

SIOC_IO_EXT is the pass-through interface introduced with HP-UX 11i V3 release. It is the recom-

mended interface. It should be issued on persistent device ﬁles (see intro (7)). It allows to send the SCSI

command through any of the available LUN paths or through a speciﬁc LUN path.

SIOC_IO is the pass-through interface that existed prior to HP-UX 11i V3. This interface is deprecated

with HP-UX 11i V3 release. It is maintained for backward compatibility. It can be used on persistent

device ﬁles or legacy device ﬁles. If issued on a persistent device ﬁle, the SCSI command is sent through

any of the available LUN paths. If issued on a legacy device ﬁle, the SCSI command will be sent through

any available LUN paths. However, if multi-pathing is disabled legacy device ﬁles (see

leg_mpath_enable

in scsimgr (1M)), the SCSI command will be sent only through the LUN path

corresponding to the legacy device ﬁle.

All reserved ﬁelds in the data structure associated to the interface must be zero-ﬁlled.

The

SIOC_IO_EXT/SIOC_IO ioctl allows an arbitrary SCSI command to be sent to a device. All details

of the SCSI command protocol are handled automatically.

The data structure for the

SIOC_IO_EXT/SIOC_IO ioctl is included from <sys/scsi.h>:

/* SCSI device control ioctls */

#define SIOC_IO_EXT _IOWR(’S’, 102, esctl_io_t)

#define SIOC_IO _IOWR(’S’, 22, struct sctl_io)

/* Structure for SIOC_IO_EXT ioctl */

typedef struct {

int version;

escsi_sctl_io_flags_t flags;

int max_msecs;

uint32_t cdb_length;

uint32_t data_length;

ptr64_t data;

union sense_data sense;

escsi_hw_path_t lpt_hwp;

uint32_t data_xfer;

uint32_t sense_xfer;

uint32_t cdb_status;

uint32_t sense_status;

uint8_t cdb[ESCSI_MAX_CDB_LEN];

uint32_t rsvd[32]; /* Reserved for

* future use

} esctl_io_t;

/* Structure for SIOC_IO ioctl */

typedef struct sctl_io {

unsigned flags;

unsigned char cdb_length;

unsigned char cdb[16];

void *data;

unsigned data_length;

unsigned max_msecs;

unsigned data_xfer;

unsigned cdb_status;

unsigned char sense[256];

HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1

Summary of content (6 pages)

PAGE 1
sioc_io(7) sioc_io(7) NAME sioc_io - SCSI pass-through interface DESCRIPTION SCSI devices are controlled by a device-specific driver, when one exists. Device-specific drivers, such as those for SCSI direct access (disk) and sequential access (tape) devices, coordinate device and driver states to accomplish correct logical device behavior. The sioc_io pass-through interface enables the use of SCSI devices and commands not normally supported by these device-specific drivers.
PAGE 2
sioc_io(7) sioc_io(7) unsigned unsigned char unsigned char } sctl_io_t; sense_status; sense_xfer; reserved[64]; The following flags can be used to specify the flags field value of both SIOC_IO_EXT and SIOC_IO unless indicated otherwise: SCTL_READ Data-in phase expected if the data_length field is non-zero. The absence of this flag implies that a data-out phase is expected if the data_length field is non-zero. ESCTL_IO_LPT The SCSI command is to be issued on a given LUN path.
PAGE 3
sioc_io(7) sioc_io(7) The data_xfer field indicates the number of data bytes actually transferred during the data phase of the cdb command. This field is valid only when the cdb_status field contains one of the following values: S_GOOD or S_CHECK_CONDITION. The sense_xfer field indicates the number of valid sense data bytes. This field is valid only when the cdb_status field contains the value S_CHECK_CONDITION and the sense_status field contains the value S_GOOD.
PAGE 4
sioc_io(7) sioc_io(7) esctl_io.cdb[3] = 0x00; esctl_io.cdb[4] = MAX_LEN; /* allocation length */ esctl_io.cdb[5] = 0x00; esctl_io.cdb_length = 6; /* 6 byte command */ esctl_io.data = &inquiry_data[0]; /* data buffer location */ esctl_io.data_length = MAX_LEN; /* maximum transfer length */ esctl_io.max_msecs = 10000; /* allow 10 seconds for cmd */ if (ioctl(fildes, SIOC_IO_EXT, &esctl_io) < 0) { /* request is invalid */ } else { if ( esctl_io.cdb_status == S_GOOD) { /* success.
PAGE 5
sioc_io(7) sioc_io(7) Most SCSI commands have a logical unit number (LUN) field. Parallel SCSI implementations on the HP-UX operating system select logical units via the SCSI IDENTIFY message. The LUN portion of the cdb should normally be set to zero, even when the LUN being accessed is not zero. Use of linked commands is not supported. Most SCSI commands with a data phase expect the data length information to be included somewhere in the command bytes.
PAGE 6
(Notes) A (Notes) sA 6 Hewlett-Packard Company −1− HP-UX 11i Version 3: September 2010