Add BIN build system target information to the documentation.
[pub/USBasp.git] / Bootloaders / MassStorage / Lib / VirtualFAT.h
index 16b4b73..37095ea 100644 (file)
 
                #include <LUFA/Drivers/USB/USB.h>
 
+               #include "../BootloaderAPI.h"
+
        /* Macros: */
                /** Size of the virtual FIRMWARE.BIN file in bytes. */
-               #define FIRMWARE_FILE_SIZE_BYTES  (FLASHEND - (FLASHEND - BOOT_START_ADDR))
+               #define FIRMWARE_FILE_SIZE_BYTES  (FLASHEND - (FLASHEND - BOOT_START_ADDR) - AUX_BOOT_SECTION_SIZE)
 
                /** Number of sectors that comprise a single logical disk cluster. */
                #define SECTOR_PER_CLUSTER        4
                 */
                #define FAT_DATE(dd, mm, yyyy)    (((yyyy - 1980) << 9) | (mm << 5) | (dd << 0))
 
+               /** \name FAT Filesystem Flags */
+               //@{
+               /** FAT attribute flag to indicate a read-only file. */
+               #define FAT_FLAG_READONLY         (1 << 0)
+
+               /** FAT attribute flag to indicate a hidden file. */
+               #define FAT_FLAG_HIDDEN           (1 << 1)
+
+               /** FAT attribute flag to indicate a system file. */
+               #define FAT_FLAG_SYSTEM           (1 << 2)
+
+               /** FAT attribute flag to indicate a Volume name entry. */
+               #define FAT_FLAG_VOLUME_NAME      (1 << 3)
+
+               /** FAT attribute flag to indicate a directory entry. */
+               #define FAT_FLAG_DIRECTORY        (1 << 4)
+
+               /** FAT attribute flag to indicate a file ready for archiving. */
+               #define FAT_FLAG_ARCHIVE          (1 << 5)
+
+               /** FAT pseudo-attribute flag to indicate a Long File Name entry. */
+               #define FAT_FLAG_LONG_FILE_NAME   0x0F
+
+               /** Ordinal flag marker for FAT Long File Name entries to mark the last entry. */
+               #define FAT_ORDINAL_LAST_ENTRY    (1 << 6)
+               //@}
+
        /* Type Definitions: */
                /** FAT boot block structure definition, used to identify the core
                 *  parameters of a FAT filesystem stored on a disk.
                        /* uint16_t MagicSignature; */
                } FATBootBlock_t;
 
-               /** FAT legacy 8.3 style directory entry structure definition, used to
-                *  identify the files and folders of FAT filesystem stored on a disk.
+               /** FAT directory entry structure, for the various kinds of File and
+                *  directory descriptors on a FAT disk.
                 */
-               typedef struct
+               typedef union
                {
-                       uint8_t  Filename[8];
-                       uint8_t  Extension[3];
-                       uint8_t  Attributes;
-                       uint8_t  Reserved[10];
-                       uint16_t CreationTime;
-                       uint16_t CreationDate;
-                       uint16_t StartingCluster;
-                       uint32_t FileSizeBytes;
+                       /** FAT Long File Name directory entry. */
+                       struct
+                       {
+                               uint8_t  Ordinal;
+                               uint16_t Unicode1;
+                               uint16_t Unicode2;
+                               uint16_t Unicode3;
+                               uint16_t Unicode4;
+                               uint16_t Unicode5;
+                               uint8_t  Attribute;
+                               uint8_t  Reserved1;
+                               uint8_t  Checksum;
+                               uint16_t Unicode6;
+                               uint16_t Unicode7;
+                               uint16_t Unicode8;
+                               uint16_t Unicode9;
+                               uint16_t Unicode10;
+                               uint16_t Unicode11;
+                               uint16_t Reserved2;
+                               uint16_t Unicode12;
+                               uint16_t Unicode13;
+                       } VFAT_LongFileName;
+
+                       /** FAT MSDOS 8.3 legacy file entry. */
+                       struct
+                       {
+                               uint8_t  Filename[8];
+                               uint8_t  Extension[3];
+                               uint8_t  Attributes;
+                               uint8_t  Reserved[10];
+                               uint16_t CreationTime;
+                               uint16_t CreationDate;
+                               uint16_t StartingCluster;
+                               uint32_t FileSizeBytes;
+                       } MSDOS_File;
+
+                       /** FAT MSDOS (sub-)directory entry. */
+                       struct
+                       {
+                               uint8_t  Name[11];
+                               uint8_t  Attributes;
+                               uint8_t  Reserved[10];
+                               uint16_t CreationTime;
+                               uint16_t CreationDate;
+                               uint16_t StartingCluster;
+                               uint32_t Reserved2;
+                       } MSDOS_Directory;
                } FATDirectoryEntry_t;
 
        /* Function Prototypes: */
                #if defined(INCLUDE_FROM_VIRTUAL_FAT_C)
                        static void UpdateFAT12ClusterEntry(uint8_t* const FATTable,
                                                            const uint16_t Index,
-                                                           const uint16_t ChainEntry);
-                       static void WriteVirtualBlock(const uint16_t BlockNumber);
-                       static void ReadVirtualBlock(const uint16_t BlockNumber);
+                                                           const uint16_t ChainEntry) AUX_BOOT_SECTION;
+                       static void WriteVirtualBlock(const uint16_t BlockNumber) AUX_BOOT_SECTION;
+                       static void ReadVirtualBlock(const uint16_t BlockNumber) AUX_BOOT_SECTION;
                #endif
 
-               void VirtualFAT_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
-                                           const uint32_t BlockAddress,
-                                           uint16_t TotalBlocks);
+               void VirtualFAT_WriteBlocks(const uint16_t BlockAddress,
+                                           uint16_t TotalBlocks) AUX_BOOT_SECTION;
 
-               void VirtualFAT_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
-                                          const uint32_t BlockAddress,
-                                          uint16_t TotalBlocks);
+               void VirtualFAT_ReadBlocks(const uint16_t BlockAddress,
+                                          uint16_t TotalBlocks) AUX_BOOT_SECTION;
 #endif