The IORB is the main control block for all direct call commands. To accommodate varying command-specific data, there are eight types of IORBs, one per CommandCode, as shown in the following table.
旼컴컴컴컴컴컴컴컴컴컴컴컴컴컴컫컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB Type 쿎ommandCode � 쳐컴컴컴컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_CONFIGURATION 쿔OCC_CONFIGURATION � 쳐컴컴컴컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_UNIT_CONTROL 쿔OCC_UNIT_CONTROL � 쳐컴컴컴컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_GEOMETRY 쿔OCC_GEOMETRY � 쳐컴컴컴컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_EXECUTE_IO 쿔OCC_EXECUTE_IO � 쳐컴컴컴컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_FORMAT 쿔OCC_FORMAT � 쳐컴컴컴컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_UNIT_STATUS 쿔OCC_UNIT_STATUS � 쳐컴컴컴컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_DEVICE_CONTROL 쿔OCC_DEVICE_CONTROL � 쳐컴컴컴컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_ADAPTER_PASSTHRU 쿔OCC_ADAPTER_PASSTHRU � 읕컴컴컴컴컴컴컴컴컴컴컴컴컴컴컨컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴�
Each IORB consists of a common I/O Request Block Header (IORBH data structure), followed by unique command-specific data, as shown in the following table.
旼컴컴컴컴컴컴컴컴컴컴컫컴컴컴컴컴쩡컴컴컴컴쩡컴컴컴컴컴컴컴컴컴� 쿑ield Name 쿎 Type 쿗ength 쿏escription � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿗ength 쿢SHORT 쿏W 쿗ength of IORB � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿢nitHandle 쿢SHORT 쿏W 쿢nit handle � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿎ommandCode 쿢SHORT 쿏W 쿎ommand code � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿎ommandModifier 쿢SHORT 쿏W 쿎ommand modifier � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿝equestControl 쿢SHORT 쿏W 쿑lags � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿞tatus 쿢SHORT 쿏W 쿞tatus � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿐rrorCode 쿢SHORT 쿏W 쿐rror code � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿟imeout 쿢LONG 쿏D 쿎ompletion timeout � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿞tatusBlockLen 쿢SHORT 쿏W 쿗ength of status � � � � 쿶nfo � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿾StatusBlock 쿙PBYTE 쿏W 쿛ointer to status � � � � 쿶nfo � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿝eserved_1 쿢SHORT 쿏W 쿝eserved � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿾NxtIORB 쿛IORB 쿏D 쿛ointer to next � � � � 쿔ORB � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿙otifyAddress �(*PFN)( ) 쿏D 쿙otification � � � � 쿪ddress � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿏MWorkSpace[20] 쿢CHAR 쿏B(20) 쿝eserved � 쳐컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴컴� 쿌DDWorkSpace[16] 쿢CHAR 쿏B(16) 쿪dapter device � � � � 쿭river work area � 읕컴컴컴컴컴컴컴컴컴컴컨컴컴컴컴컴좔컴컴컴컴좔컴컴컴컴컴컴컴컴컴�
On entry to the driver:
Length
is set to the total length of the IORB (IORBH plus Command-Specific Data)
in bytes.
UnitHandle
identifies the adapter device driver's unit for which the request is intended.
The adapter device driver must assign a unique UnitHandle in the
DEVICETABLE UNITINFO structure for each of the units it manages. Refer
to the IOCC_CONFIGURATION CommandCode section for additional information.
CommandCode/CommandModifier
contains the direct call commands. These commands are grouped by CommandCode
as shown in the following table. The CommandCode field defines
the IORB; the CommandModifier field selects the actual operation
within a specified CommandCode. For details on each of the commands,
refer to their corresponding CommandCode sections.
旼컴컴컴컴컴컴컴컴컴컴컴컫컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿎ommandCode 쿎ommandModifier � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔OCC_CONFIGURATION � � � 쿔OCM_GET_DEVICE_TABLE � � 쿔OCM_COMPLETE_INIT � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔OCC_UNIT_CONTROL � � � 쿔OCM_ALLOCATE_UNIT � � 쿔OCM_DEALLOCATE_UNIT � � 쿔OCM_CHANGE_UNITINFO � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔OCC_GEOMETRY � � � 쿔OCM_GET_MEDIA_GEOMETRY � � 쿔OCM_SET_MEDIA_GEOMETRY � � 쿔OCM_GET_DEVICE_GEOMETRY � � 쿔OCM_SET_LOGICAL_GEOMETRY � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔OCC_EXECUTE_IO � � � 쿔OCM_READ � � 쿔OCM_READ_VERIFY � � 쿔OCM_READ_PREFETCH � � 쿔OCM_WRITE � � 쿔OCM_WRITE_VERIFY � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔OCC_FORMAT � � � 쿔OCM_FORMAT_MEDIA � � 쿔OCM_FORMAT_TRACK � � 쿔OCM_FORMAT_PROGRESS � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔OCC_UNIT_STATUS � � � 쿔OCM_GET_UNIT_STATUS � � 쿔OCM_GET_CHANGELINE_STATE � � 쿔OCM_GET_MEDIA_SENSE � � 쿔OCM_GET_LOCK_SENSE � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔OCC_DEVICE_CONTROL � � � 쿔OCM_ABORT � � 쿔OCM_RESET � � 쿔OCM_SUSPEND � � 쿔OCM_RESUME � � 쿔OCM_LOCK_MEDIA � � 쿔OCM_UNLOCK_MEDIA � � 쿔OCM_EJECT_MEDIA � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔OCC_ADAPTER_PASSTHRU � � � 쿔OCM_EXECUTE_SCB � � 쿔OCM_EXECUTE_CDB � 읕컴컴컴컴컴컴컴컴컴컴컴컨컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴�
RequestControl
contains flags which control the processing of the IORB, as shown in the
following table.
旼컴컴컴컴컴컴컴컴컴컴컴컫컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿑lag 쿏escription � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_ASYNC_POST 쿎ommand-completion protocol. This � � 쿌DD will always return immediately, � � 쿪s this is an asynchronous protocol � � 퀁equiring ASYNC_NOTIFY to be set. If� � 퀂et, this flag indicates that the � � �NotifyAddress field is valid and � � 퀃hat the adapter device driver � � 퀂hould call this routine when the � � 쿔ORB request is completed. � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_CHAIN 쿔ORB chaining. If set, this flag � � 쿶ndicates that the pNxtIORB field is� � 퀆alid and that there is a chained � � 쿔ORB command to service. � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_CHS_ADDRESSING 쿔/O addressing format. If set, this� � 쿯lag indicates that the command's � � �RBA field is in the format defined � � 쿫y the CHS_ADDR structure. This bit� � 퀂hould be set only for diskette � � 쿬ontrollers. � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_REQ_STATUSBLOCK 쿝equest for status information. If � � 퀂et, this flag indicates that the � � �StatusBlockLen and pStatusBlock � � 쿯ields are valid and that the � � 쿪dapter device driver should return � � 퀃he command's associated status � � 쿶nformation. � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_DISABLE_RETRY 쿙o error retry. If set, this flag � � 쿶ndicates that the adapter device � � 쿭river should not retry the request � � 쿶f a processing error occurs. � 읕컴컴컴컴컴컴컴컴컴컴컴컨컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴�
For more information about chained IORBs (IORB_CHAIN), see Adapter Device Driver Interface Questions and Answers.
Status
equals 0 on entry. Upon exit from the adapter device driver, Status
contains flags to indicate the command's completion status. (See the
following table.)
旼컴컴컴컴컴컴컴컴컴컴컴컫컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿑lag 쿏escription � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_DONE 쿛rocessing complete. If set, this � � 쿯lag indicates that the adapter � � 쿭evice driver has completed � � 쿾rocessing the request. � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_ERROR 쿐rror encountered. If set, this � � 쿯lag indicates that an error � � 쿽ccurred while processing the � � 퀁equest. This flag should not be � � 퀂et if the error was successfully � � 퀁ecovered by the adapter device � � 쿭river. � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_RECOV_ERROR 쿝ecoverable error. If set, this � � 쿯lag indicates that, although an � � 쿮rror occurred, the adapter device � � 쿭river successfully recovered � � 퀃hrough retries. � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔ORB_STATUSBLOCK_AVAIL 쿞tatus information returned. If � � 퀂et, this flag indicates that the � � 쿪dapter device driver has returned � � 퀂tatus information in the buffer � � 쿭efined by pStatusBlock. � 읕컴컴컴컴컴컴컴컴컴컴컴컨컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴�
ErrorCode
equals 0, on entry. On exit from the driver, it contains the command's
completion error code. This field is valid only if the IORB_ERROR flag
in the Status field is set. The error codes are summarized in Error
Handling.
Timeout
contains the maximum number of seconds the driver will permit for command
completion before timing out. If this field is set to 0, the timeout value
assigned is the default set by the driver If this field is set to -1, the
timeout value assigned is infinite. The timeout period is measured from
the last valid contact (interrupt) with the target device. Therefore, if
the device interrupts periodically within the timeout interval, the interval
is reset after each interrupt.
StatusBlockLen
contains the size of the block of storage, in bytes, for the driver to return
status information (pStatusBlock). This field is valid only if the
IORB_REQ_STATUSBLOCK flag is set in the RequestControl field.
pStatusBlock
contains a near pointer to a block of storage (length = StatusBlockLength),
allocated by the caller, for the driver to return status information. On
exit from the driver, the storage area contains status information. This
field is valid only if the IORB_REQ_STATUSBLOCK flag is set in the RequestControl
field. The format of information in the status block depends on the
class of adapters the driver supports. For SCSI devices, see IORB
Status Block for more information.
Note: The pointer to the status block is a 16-bit near pointer. The status block must reside in the same segment as the IORB.
Reserved_1
is reserved for use by the device manager and must not be modified by the
adapter device driver.
pNxtIORB
contains a far pointer to the next IORB for chained commands. This field
is valid only if the IORB_CHAIN flag is set in the RequestControl field.
NotifyAddress
contains a far pointer to the notification routine to be called when the
request has completed successfully or aborted due to error conditions. This
field is valid only if the IORB_ASYNC_POST flag is set in the RequestControl
field. The notification routine should be called with a far pointer
to the command's IORB.
C Language Syntax
컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴
(FAR *piorb->NotifyAddress) (piorb);
컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴
Assembly Language Syntax
컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴
; ** ES:BX = IORB Pointer PUSH es ; IORB segment PUSH bx ; IORB offset CALL dword ptr es:[bx+IOH_NotifyAddress] ; Call notify routine add sp, 4 ; Cleanup stack
컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴
Note: The Notify routine will preserve only the DS, ES, SI, and DI registers.
DMWorkSpace[20]
defines a workspace, for use by the device manager, that must not be modified
by the device driver.
ADDWorkSpace[16]
defines a workspace for the adapter device driver that is ignored by the
device manager.
Command-Specific Data
contains the command-unique parameters. The commands and actual formats
of the corresponding IORBs are described in the following sections.