<< Previous | Next >>

fs_get_flash_lx (FS2)

FSLXnum fs_get_flash_lx( void );

Description

Returns the logical extent number of the preferred flash device. This is the second flash if one is available on your hardware, otherwise it is the reserved area in your program flash. In order for the program flash to be available for use by the file system, you must define two constants: the first constant is XMEM_RESERVE_SIZE near the top of BIOS\RABBITBIOS.C. This value is set to the amount of program flash to reserve (in bytes). This is required by the BIOS. The second constant is set in your code before #use "fs2.lib". FS2_USE_PROGRAM_FLASH must be defined to the number of KB (1024 bytes) that will actually be used by the file system. If this is set to a larger value than the actual amount of reserved space, then only the actual amount will be used.

The sample program SAMPLES\FILESYSTEM\FS2INFO.C demonstrates use of this function.

This function may be called before calling fs_init().

Return value

 0: There is no flash file system available.
!0: Logical extent number of the preferred flash.

Library

FS2.lib

See also

fs_get_ram_lx (FS2), fs_get_other_lx (FS2)