Legacy Document

Inside Macintosh: Devices /

Chapter 4 - SCSI Manager 4.3 / SCSI Manager 4.3 Reference

SCSI Manager 4.3 Functions / Client Functions

SCSIExecIO

You use the SCSIExecIO function to perform SCSI I/O operations.

OSErr SCSIAction(SCSIExecIOPB *scsiPB);

scsiPB

A pointer to a SCSI I/O parameter block, which is described on page 4-23.

-->	scsiPBLength	UInt16	The size of the parameter block. This value must be equal to or greater than the scsiIOpbSize for the SIM.
-->	scsiFunctionCode	UInt8	The SCSIExecIO function selector code (0x01).
<--	scsiResult	OSErr	The returned result code.
-->	scsiDevice	DeviceIdent	The device identification record.
-->	scsiCompletion	CallbackProc	A pointer to a completion routine. If this field is set to nil, the function is executed synchronously.
-->	scsiFlags	UInt32	Flags indicating the transfer direction and any special handling required for the request. See page 4-22 for descriptions of these flags.
-->	scsiDriverStorage	UInt8 *	Optional pointer to the device driver's private storage.
<--	scsiResultFlags	UInt16	Output flags that modify the scsiResult field. See page 4-24.
-->	scsiDataPtr	UInt8 *	A pointer to a data buffer or scatter/gather list.
-->	scsiDataLength	UInt32	The amount of data to be transferred.
-->	scsiSensePtr	UInt8 *	A pointer to the autosense buffer.
-->	scsiSenseLength	UInt8	The size of the autosense buffer.
-->	scsiCDBLength	UInt8	The size of the CDB.
-->	scsiSGListCount	UInt16	The number of elements in the scatter/gather list.
<--	scsiSCSIstatus	UInt8	Status returned by the SCSI device.
<--	scsiSenseResidual	SInt8	The autosense residual length.
<--	scsiDataResidual	SInt32	The data transfer residual length.
-->	scsiCDB	CDB	The CDB, or a pointer to the CDB, depending on the setting of the scsiCDBIsPointer flag.
-->	scsiTimeout	SInt32	The SCSI bus timeout period.
-->	scsiIOFlags	UInt16	Additional I/O flags. See page 4-25.
-->	scsiSelectTimeout	UInt16	Optional SELECT timeout value.
-->	scsiDataType	UInt8	The data type pointed to by the scsiDataPtr field. See page 4-27.
-->	scsiTransferType	UInt8	The transfer mode (polled or blind). See page 4-27.
-->	scsiHandshake[8]	UInt16	Handshaking instructions.
-->	scsiCommandLink	SCSI_IO *	Optional pointer to a linked CDB.

DESCRIPTION

The SCSIExecIO function sends a request to a SIM to carry out a SCSI transaction. The SIM performs all the actions necessary to fulfill the request, including arbitrating for the bus, selecting the device, sending the CDB, receiving or sending data, performing disconnect operations, and so on. The parameter block contains all the information required for the SIM to complete the SCSI request, including issuing a REQUEST SENSE command if necessary.

RESULT CODES

noErr	0	No error
scsiRequestInProgress	1	Parameter block request is in progress
scsiCDBLengthInvalid	-7863	The CDB length supplied is not supported by this SIM; typically this means it was too big
scsiTransferTypeInvalid	-7864	The scsiTransferType requested is not supported by this SIM
scsiDataTypeInvalid	-7865	SIM does not support the requested scsiDataType
scsiIDInvalid	-7866	The initiator ID is invalid
scsiLUNInvalid	-7867	The logical unit number is invalid
scsiTIDInvalid	-7868	The target ID is invalid
scsiBusInvalid	-7869	The bus ID is invalid
scsiRequestInvalid	-7870	The parameter block request is invalid
scsiFunctionNotAvailable	-7871	The requested function is not supported by this SIM
scsiPBLengthError	-7872	The parameter block length supplied was too small for this SIM
scsiQLinkInvalid	-7881	The qLink field was not 0
scsiNoSuchXref	-7882	No driver has been cross-referenced with this device
scsiDeviceConflict	-7883	Attempt to register more than one driver to a device
scsiNoHBA	-7884	No HBA detected
scsiDeviceNotThere	-7885	SCSI device not installed or available
scsiProvideFail	-7886	Unable to provide the requested service
scsiBusy	-7887	SCSI subsystem is busy
scsiTooManyBuses	-7888	SIM registration failed because the XPT registry is full
scsiCDBReceived	-7910	The SCSI CDB was received
scsiNoNexus	-7911	Nexus is not established
scsiTerminated	-7912	Parameter block request terminated by the host
scsiBDRsent	-7913	A SCSI bus device reset (BDR) message was sent to the target
scsiWrongDirection	-7915	Data phase was in an unexpected direction
scsiSequenceFail	-7916	Target bus phase sequence failure
scsiUnexpectedBusFree	-7917	Unexpected bus free phase
scsiDataRunError	-7918	Data overrun/underrun error
scsiAutosenseFailed	-7920	Automatic REQUEST SENSE command failed
scsiParityError	-7921	An uncorrectable parity error occurred
scsiSCSIBusReset	-7922	Execution of this parameter block was halted because of a SCSI bus reset
scsiMessageRejectReceived	-7923	REJECT message received
scsiIdentifyMessageRejected	-7924	The target issued a REJECT message in response to the IDENTIFY message; the LUN probably does not exist
scsiCommandTimeout	-7925	The timeout value for this parameter block was exceeded and the parameter block was aborted
scsiSelectTimeout	-7926	Target selection timeout
scsiUnableToTerminate	-7927	Unable to terminate I/O parameter block request
scsiNonZeroStatus	-7932	The target returned non-zero status upon completion of the request
scsiUnableToAbort	-7933	Unable to abort parameter block request
scsiRequestAborted	-7934	Parameter block request aborted by the host