The Compact-Flash Wildcard and CF Card Software Package User Guide
<< Previous | Next>>
C: FAIL_ADDR
4th: FAIL_ADDR ( -- n )
A constant (equal to 0x0004) that is returned as a failure code when the requested sector number is out of range. All failure codes returned by the low level ATA access routines (such as ATA_Read and ATA_Write) have names starting with "FAIL", have a single-bit set, and may be OR'd together to represent multiple errors. This constant may be used as a bitmask to decode the value returned by an ATA function.
C: FAIL_ARGS
4th: FAIL_ARGS ( -- n )
A constant (equal to 0x0001) that is returned as a failure code when one of the arguments that is passed to the low level ATA function is invalid. All failure codes returned by the low level ATA access routines (such as ATA_Read and ATA_Write) have names starting with "FAIL", have a single-bit set, and may be OR'd together to represent multiple errors. This constant may be used as a bitmask to decode the value returned by an ATA function.
C: FAIL_BUSY
4th: FAIL_BUSY ( -- n )
A constant (equal to 0x0080) that is returned as a failure code when a timeout error is encountered during an access to the ATA flash card. All failure codes returned by the low level ATA access routines (such as ATA_Read and ATA_Write) have names starting with "FAIL", have a single-bit set, and may be OR'd together to represent multiple errors. This constant may be used as a bitmask to decode the value returned by an ATA function.
C: FAIL_CMD
4th: FAIL_CMD ( -- n )
A constant (equal to 0x0008) that is returned as a failure code when an ATA command fails to complete. All failure codes returned by the low level ATA access routines (such as ATA_Read and ATA_Write) have names starting with "FAIL", have a single-bit set, and may be OR'd together to represent multiple errors. This constant may be used as a bitmask to decode the value returned by an ATA function.
C: FAIL_DATAREQ
4th: FAIL_DATAREQ ( -- n )
A constant (equal to 0x0020) that is returned as a failure code when the "DRQ" bit in the ATA hardware status register indicates that the drive is not synchronized with the data requests to/from the host as it should be during a data transfer. All failure codes returned by the low level ATA access routines (such as ATA_Read and ATA_Write) have names starting with "FAIL", have a single-bit set, and may be OR'd together to represent multiple errors. This constant may be used as a bitmask to decode the value returned by an ATA function.
C: FAIL_EXTERR
4th: FAIL_EXTERR ( -- n )
A constant (equal to 0x0010) that is returned as a failure code when an attempt to get an "extended error" description fails after a failure occurs while accessing the ATA device; this extended error feature is supported only by Sandisk ATA flash cards. All failure codes returned by the low level ATA access routines (such as ATA_Read and ATA_Write) have names starting with "FAIL", have a single-bit set, and may be OR'd together to represent multiple errors. This constant may be used as a bitmask to decode the value returned by an ATA function.
C: FAIL_ID_DRIVE
4th: FAIL_ID_DRIVE ( -- n )
A constant (equal to 0x0100) that is returned as a failure code when an error is encountered by the ATA_ID_Drive command. All failure codes returned by the low level ATA access routines (such as ATA_Read and ATA_Write) have names starting with "FAIL", have a single-bit set, and may be OR'd together to represent multiple errors. This constant may be used as a bitmask to decode the value returned by an ATA function. See also ERR_FAIL_ID_DRIVE.
C: FAIL_NO_CARD
4th: FAIL_NO_CARD ( -- n )
A constant (equal to 0x0002) that is returned as a failure code when there is no card present. All failure codes returned by the low level ATA access routines (such as ATA_Read and ATA_Write) have names starting with "FAIL", have a single-bit set, and may be OR'd together to represent multiple errors. This constant may be used as a bitmask to decode the value returned by an ATA function.
C: FAIL_READY
4th: FAIL_READY ( -- n )
A constant (equal to 0x0040) that is returned as a failure code when the "Drive Ready" bit in the ATA hardware status register indicates that the drive is not ready when it should be. All failure codes returned by the low level ATA access routines (such as ATA_Read and ATA_Write) have names starting with "FAIL", have a single-bit set, and may be OR'd together to represent multiple errors. This constant may be used as a bitmask to decode the value returned by an ATA function.
C: xaddr FI( void)
4th: FI ( -- fat_info_xaddr )
This function returns the 32-bit extended base address (xaddr) of the fat_info structure that holds all of the key variables and array parameter fields used by the file system software. This address is set by Init_File_IO or Init_File_System. The returned fat_info_xaddr parameter is the base address of a block of 300 bytes of RAM in either common or paged memory. The first entry at offset 0 in this structure is the resource variable that mediates access to the CF Card access functions so that this software package is re-entrant with respect to multitasking. (Note that the functions that access the CF Card cannot be called from inside interrupt service routines; see the glossary entries for ATA_Read and ATA_Write). The fat_info structure stores low level parameters, buffers, and array parameter fields that manage ATA access, FAT file manipulation, and file access. The arrays associated with the array parameter fields are maintained in the heap that is initialized by Init_File_Heap. With the possible exception of getting or releasing the resource variable at the base of this structure, the programmer does not need to directly access the contents of the structure.
<< Previous | Next>>
|