1.2.7.4.51 SYS_FS_FORMAT_PARAM Struct

C

typedef struct {
    /* Specifies combination of FAT type flags, SYS_FS_FORMAT_XXX.
     * These flags specify which FAT type to be created on the volume.
     * If two or more types are specified, one out of them will be
     * selected depends on the volume size and au_size.
     * The default value is FM_ANY.
    */
    uint8_t  fmt;

    /* Specifies number of FAT copies on the FAT/FAT32 volume.
     * Valid value for this member is 1 or 2. If the FAT type is exFAT,
     * this member has no effect.
    */
    uint8_t  n_fat;

    /* Specifies alignment of the volume data area (file allocation pool,
     * usually erase block boundary of flash media) in unit of sector.
     * When a zero is given, alignment is decided on the block size.
    */
    uint32_t align;

    /* Specifies number of root directory entries on the FAT volume.
     * Valid value for this member is up to 32768 and aligned to
     * sector size / 32. If the FAT type is FAT32 or exFAT, this member
     * has no effect.
    */
    uint32_t n_root;

    /* Specifies size of the allocation unit (cluster) in unit of byte.
     * The valid value is power of 2 between sector size and
     * 128 * sector size inclusive for FAT/FAT32 volume and up to 16 MB.
     * When a zero is given, the cluster size depends on the volume size.
    */
    uint32_t au_size;

} SYS_FS_FORMAT_PARAM;

Summary

SYS FS Drive Format parameter structure.

Description

Specifies the structure holding format options. This structure has to be filled and passed to SYS_FS_DriveFormat() API.

Remarks

None.