SAM Adapter ioctl Operations

Edit online

This overview lists the SAM adapter ioctl operations.

IOCINFO for FCP Adapters
This operation lets an FCP device driver obtain important information about a FCP adapter, including the adapter's SCSI ID, the maximum data transfer size in bytes, and the FC topology to which the adapter is connected.
IOCINFO for iSCSI Adapters
This operation lets an iSCSI device driver obtain important information about an iSCSI adapter, including the adapter's maximum data transfer size in bytes.
IOCINFO for SAS Adapters
This operation allows a SAS device driver to obtain important information about a SAS adapter, such as the maximum data-transfer size in bytes of the adapter.
IOCINFO for Virtual SCSI Adapters
This operation lets a Virtual SCSI device driver obtain important information about a Virtual SCSI adapter, including the adapter's maximum data transfer size in bytes.
SCIOLSTART
This operation opens a logical path to the target device and causes the SAM adapter device driver to allocate and initialize all of the data areas needed for the target device. The SCIOLSTOP operation should be issued when those data areas are no longer needed. The SCIOLSTART operation must be issued before any nondiagnostic operation except for IOCINFO.
SCIOLSTOP
This operation closes a logical path to the device and causes the adapter device driver to deallocate all data areas that were allocated by the SCIOLSTART operation. This operation should only be issued after a successful SCIOLSTART operation to a device.
SCIOLEVENT
This operation lets a device driver register a particular device instance for receiving asynchronous event status by calling the SCIOLEVENT ioctl operation for the adapter device driver. When an event covered by the SCIOLEVENT ioctl operation is detected by the adapter device driver, it builds an scsi_event_info structure and passes a pointer to the structure and to the asynchronous event-handler routine entry point, which was previously registered.
SCIOLINQU
This operation issues an inquiry command to an device and is used to aid in device configuration.
SCIOLSTUNIT
This operation issues a start unit command to an device and is used to aid in device configuration.
SCIOLTUR
This operation issues a Test Unit Ready command to an adapter and aids in device configuration.
SCIOLREAD
This operation issues an read command to an device and is used to aid in device configuration.
SCIOLRESET
If the SCIOLRESET_LUN_RESET flag is not set in the flags field of the scsi_sciolst, then this operation causes an FCP or iSCSI device, clear all current commands, and return to an initial state by issuing a Target Reset, which resets all LUNs associated with the specified FCP ID or iSCSI device's SCSI ID alias. If, for an FCP or iSCSI device the SCIOLRESET_LUN_RESET flag is set in the flags field of the scsi_sciolst, then this operation causes an FCP or iSCSI device to clear all current commands, and return to an initial state by issuing a Lun Reset, which resets just the specified LUN associated with the specified FCP ID or iSCSI device's SCSI ID alias. For the SAS transport type, the Target Reset command is not defined; and thus for SAS, this ioctl always results in Lun Reset being issued without regard to the SCIOLRESET_LUN_RESET flag setting.
SCIOLHALT
This operation stops the current command of the selected device, clears the command queue of any pending commands, and brings the device to a halted state. The adapter sends a SCSI abort message to the device and is usually used by the device driver to abort the current operation instead of waiting for it to complete or time out.
SCIOLCMD
After the SCSI device has been successfully started using SCIOLSTART, the SCIOLCMD ioctl operation provides the means for issuing any SCSI command to the specified device. The SAM adapter driver performs no error recovery or logging on failures of this ioctl operation.
SCIOLNMSRV
This operation returns a list of target devices and is used to aid in SCSI device configuration.
SCIOLQWWN
This operation issues a request to find the SCSI ID of a device for the specified world wide name.
SCIOLPAYLD
The SCIOLPAYLD ioctl is not supported by the Virtual SCSI adapter driver.
SCIOLCHBA
The SCIOLCHBA ioctl is not supported by the Virtual SCSI adapter driver.
SCIOLPASSTHRUHBA
The SCIOLPASSTHRUHBA ioctl is not supported by the Virtual SCSI adapter driver.

Parent topic: Programming SAM Device Drivers

Related concepts

SAM Adapter Device Driver ioctl Commands