The IOCC_FORMAT CommandCode consists of all CommandModifiers responsible for unit format requests. The following table describes the IOCC_FORMAT CommandModifiers:
旼컴컴컴컴컴컴컴컴컴컴컴컫컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿎ommandModifier 쿏escription � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔OCM_FORMAT_MEDIA 쿑ormats the entire media in the � � 퀅nit. Support of this command is � � 쿺andatory for SCSI devices that � � 퀁equire low-level formatting. � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔OCM_FORMAT_TRACK 쿑ormats the specified track on the � � 퀅nit. Support of this command is � � 쿺andatory for standard diskette � � 쿺edia. � 쳐컴컴컴컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔OCM_FORMAT_PROGRESS 쿝eports the progress of the � � 쿯ormatting. Support of this command � � 쿶s mandatory for standard diskette � � 쿺edia. � 읕컴컴컴컴컴컴컴컴컴컴컴컨컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴�
Remarks
Support:
Format of IORB
IORB_FORMAT Description:
This section defines the IORB_FORMAT control block. (See the following table.)
旼컴컴컴컴컴컴컴컴쩡컴컴컴컴컴컴컴컴쩡컴컴컴컴쩡컴컴컴컴컴컴컴컴엿Field Name 쿎 Type 쿗ength 쿏escription � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿶orbh 쿔ORBH 쿏B(68) 쿔ORB header � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿬SGLIST 쿢SHORT 쿏W 쿙umber of � � � � 쿮lements � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿾SGLIST 쿛SCATGATENTRY 쿏D 쿑ar pointer to � � � � 퀂/g list � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿾pSGLIST 쿢LONG 쿏D 쿛hysical address � � � � 쿽f s/g list � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿑ormatCmdLen 쿢SHORT 쿏W 쿗ength of Format � � � � 쿬ommand � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿾FormatCmd 쿛BYTE 쿏D 쿛ointer to Format� � � � 쿬ommand � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿝eserved_1 쿢CHAR 쿏B(8) 쿝eserved. � 읕컴컴컴컴컴컴컴컴좔컴컴컴컴컴컴컴컴좔컴컴컴컴좔컴컴컴컴컴컴컴컴�
On entry to the driver:
iorbh
See IORB General Format.
cSGList
contains the number of scatter/gather elements in the scatter/gather list
(pSGLIST).
pSGLIST
contains a far pointer to the scatter/gather list supplied by the caller.
The scatter/gather list consists of an array of cSGList elements,
each pointing to a physically contiguous area of real memory in a format
defined by the SCATGATENTRY structure. (See the following table.)
旼컴컴컴컴컴컴컴컴쩡컴컴컴컴컴컴컴컴쩡컴컴컴컴쩡컴컴컴컴컴컴컴컴� 쿑ield Name 쿎 Type 쿗ength 쿏escription � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿾pXferBuf 쿢LONG 쿏D 쿛hysical pointer � � � � 퀃o buffer � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿦ferBufLen 쿢LONG 쿏D 쿗ength of buffer � 읕컴컴컴컴컴컴컴컴좔컴컴컴컴컴컴컴컴좔컴컴컴컴좔컴컴컴컴컴컴컴컴�
ppSGLIST
contains a 32-bit physical address of the scatter/gather list.
Note: For IOCM_FORMAT_MEDIA, the s/g pointers will point to a Format Unit Parameter List as defined by the SCSI-2 specification.
If the SCSI Format Unit CDB does not require a parameter list and other command modifiers, the s/g pointers must be 0.
FormatCmdLen
contains the length of the format command (pFormatCmd), in bytes.
pFormatCmd
contains a pointer to device-specific formatting information. For diskette
controllers, this points to the FORMAT_CMD_TRACK structure (see the table
below). For SCSI devices, this points to a SCSI Format Unit CDB.
旼컴컴컴컴컴컴컴컴쩡컴컴컴컴컴컴컴컴쩡컴컴컴컴쩡컴컴컴컴컴컴컴컴� 쿑ield Name 쿎 Type 쿗ength 쿏escription � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿑lags 쿢SHORT 쿏W 쿑lags � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿝BA 쿢LONG 쿏D 쿞tarting RBA � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿬TrackEntries 쿢SHORT 쿏W 쿙umber of track � � � � 쿮ntries � 읕컴컴컴컴컴컴컴컴좔컴컴컴컴컴컴컴컴좔컴컴컴컴좔컴컴컴컴컴컴컴컴�
On entry to the driver:
Flags
contains flags to define the request, as shown in the following table.
旼컴컴컴컴컴컴컴쩡컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿑lag 쿏escription � 쳐컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿑F_VERIFY 쿣erify after format. If set, this flag � � 쿶ndicates that the driver should verify the � � 퀂ectors after formatting. � 읕컴컴컴컴컴컴컴좔컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴컴�
RBA
contains the starting relative block address for an IOCM_FORMAT_TRACK request.
For IOCM_FORMAT_MEDIA and IOCM_FORMAT_PROGRESS requests, this field equals
0. If the IORB_CHS_ADDRESSING flag is set in the IORBH->RequestControl
field, then the format of the RBA field is defined by the CHS_ADDRstructure
,showninthefollowingtable .
旼컴컴컴컴컴컴컴컴쩡컴컴컴컴컴컴컴컴쩡컴컴컴컴쩡컴컴컴컴컴컴컴컴� 쿑ield Name 쿎 Type 쿗ength 쿏escription � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿎ylinder 쿢SHORT 쿏W 쿞tarting cylinder� 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿓ead 쿢CHAR 쿏B 쿞tarting head � 쳐컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴탠컴컴컴컴탠컴컴컴컴컴컴컴컴� 쿞ector 쿢CHAR 쿏B 쿞tarting sector � 읕컴컴컴컴컴컴컴컴좔컴컴컴컴컴컴컴컴좔컴컴컴컴좔컴컴컴컴컴컴컴컴�
Note: The scatter/gather list-related fields (cSGLIST, pSGLIST, and ppSGLIST) are at the same offset as its equivalent pointers in the IOCC_EXECUTE_IO and IOCC_ADAPTER_PASSTHRU CommandCodes.
On exit, the driver sets the Status and ErrorCode fields of the IORBH to reflect the results of the IOCC_FORMAT request.
Return Codes
Following is a list of the IOCC_FORMAT error codes:
IOERR_CMD_NOT_SUPPORTED
IOERR_CMD_SYNTAX
IOERR_CMD_SW_RESOURCE
IOERR_CMD_ABORTED
IOERR_UNIT_NOT_ALLOCATED
IOERR_UNIT_NOT_READY
IOERR_UNIT_PWR_OFF
IOERR_RBA_ADDRESSING_ERROR
IOERR_RBA_LIMIT
IOERR_RBA_CRC_ERROR
IOERR_MEDIA_NOT_SUPPORTED
IOERR_MEDIA_WRITE_PROTECT
IOERR_MEDIA_CHANGED
IOERR_MEDIA_NOT_PRESENT
IOERR_ADAPTER_HOSTBUSCHECK
IOERR_ADAPTER_DEVICEBUSCHECK
IOERR_ADAPTER_OVERRUN
IOERR_ADAPTER_UNDERRUN
IOERR_ADAPTER_DIAGFAIL
IOERR_ADAPTER_TIMEOUT
IOERR_ADAPTER_DEVICE_TIMEOUT
IOERR_ADAPTER_REQ_NOT_SUPPORTED
IOERR_ADAPTER_REFER_TO_STATUS
IOERR_DEVICE_DEVICEBUSCHECK
IOERR_DEVICE_REQ_NOT_SUPPORTED
IOERR_DEVICE_DIAGFAIL
IOERR_DEVICE_BUSY
IOERR_DEVICE_OVERRUN
IOERR_DEVICE_UNDERRUN
For a detailed description of all the return codes, see Error Handling.