Bootloaders/MassStorage/Lib/VirtualFAT.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 #ifndef _VIRTUALFAT_H_
  32 #define _VIRTUALFAT_H_
  33
  34         /* Includes: */
  35                 #include <avr/io.h>
  36                 #include <avr/pgmspace.h>
  37
  38                 #include <LUFA/Drivers/USB/USB.h>
  39
  40                 #include "../BootloaderAPI.h"
  41
  42         /* Macros: */
  43                 /** Size of the virtual FIRMWARE.BIN file in bytes. */
  44                 #define FIRMWARE_FILE_SIZE_BYTES  (FLASHEND - (FLASHEND - BOOT_START_ADDR) - AUX_BOOT_SECTION_SIZE)
  45
  46                 /** Number of sectors that comprise a single logical disk cluster. */
  47                 #define SECTOR_PER_CLUSTER        4
  48
  49                 /** Size of a single logical sector on the disk. */
  50                 #define SECTOR_SIZE_BYTES         512
  51
  52                 /** Size of a logical cluster on the disk, in bytes */
  53                 #define CLUSTER_SIZE_BYTES        (SECTOR_PER_CLUSTER * SECTOR_SIZE_BYTES)
  54
  55                 /** Number of sectors required to store a given size in bytes.
  56                  *
  57                  *  \param[in] size  Size of the data that needs to be stored
  58                  *
  59                  *  \return Number of sectors required to store the given data on the disk.
  60                  */
  61                 #define FILE_SECTORS(size)        ((size / SECTOR_SIZE_BYTES)  + ((size % SECTOR_SIZE_BYTES)  ? 1 : 0))
  62
  63                 /** Number of clusters required to store a given size in bytes.
  64                  *
  65                  *  \param[in] size  Size of the data that needs to be stored
  66                  *
  67                  *  \return Number of clusters required to store the given data on the disk.
  68                  */
  69                 #define FILE_CLUSTERS(size)       ((size / CLUSTER_SIZE_BYTES) + ((size % CLUSTER_SIZE_BYTES) ? 1 : 0))
  70
  71                 /** Total number of logical sectors/blocks on the disk. */
  72                 #define LUN_MEDIA_BLOCKS          (FILE_SECTORS(FIRMWARE_FILE_SIZE_BYTES) + 32)
  73
  74                 /** Converts a given time in HH:MM:SS format to a FAT filesystem time.
  75                  *
  76                  *  \note The minimum seconds resolution of FAT is 2, thus odd seconds
  77                  *        will be truncated to the previous integer multiple of 2 seconds.
  78                  *
  79                  *  \param[in] hh  Hours (0-23)
  80                  *  \param[in] mm  Minutes (0-59)
  81                  *  \param[in] ss  Seconds (0-59)
  82                  *
  83                  *  \return Given time encoded as a FAT filesystem timestamp
  84                  */
  85                 #define FAT_TIME(hh, mm, ss)      ((hh << 11) | (mm << 5) | (ss >> 1))
  86
  87                 /** Converts a given date in DD/MM/YYYY format to a FAT filesystem date.
  88                  *
  89                  *  \param[in] dd    Days in the month (1-31)
  90                  *  \param[in] mm    Months in the year (1-12)
  91                  *  \param[in] yyyy  Year (1980 - 2107)
  92                  *
  93                  *  \return Given date encoded as a FAT filesystem datestamp
  94                  */
  95                 #define FAT_DATE(dd, mm, yyyy)    (((yyyy - 1980) << 9) | (mm << 5) | (dd << 0))
  96
  97                 /** \name FAT Filesystem Flags */
  98                 //@{
  99                 /** FAT attribute flag to indicate a read-only file. */
 100                 #define FAT_FLAG_READONLY         (1 << 0)
 101
 102                 /** FAT attribute flag to indicate a hidden file. */
 103                 #define FAT_FLAG_HIDDEN           (1 << 1)
 104
 105                 /** FAT attribute flag to indicate a system file. */
 106                 #define FAT_FLAG_SYSTEM           (1 << 2)
 107
 108                 /** FAT attribute flag to indicate a Volume name entry. */
 109                 #define FAT_FLAG_VOLUME_NAME      (1 << 3)
 110
 111                 /** FAT attribute flag to indicate a directory entry. */
 112                 #define FAT_FLAG_DIRECTORY        (1 << 4)
 113
 114                 /** FAT attribute flag to indicate a file ready for archiving. */
 115                 #define FAT_FLAG_ARCHIVE          (1 << 5)
 116
 117                 /** FAT pseudo-attribute flag to indicate a Long File Name entry. */
 118                 #define FAT_FLAG_LONG_FILE_NAME   0x0F
 119
 120                 /** Ordinal flag marker for FAT Long File Name entries to mark the last entry. */
 121                 #define FAT_ORDINAL_LAST_ENTRY    (1 << 6)
 122                 //@}
 123
 124         /* Type Definitions: */
 125                 /** FAT boot block structure definition, used to identify the core
 126                  *  parameters of a FAT filesystem stored on a disk.
 127                  *
 128                  *  \note This definition is truncated to save space; the magic signature
 129                  *        0xAA55 must be appended to the very end of the block for it to
 130                  *        be detected by the host as a valid boot block.
 131                  */
 132                 typedef struct
 133                 {
 134                         uint8_t  Bootstrap[3];
 135                         uint8_t  Description[8];
 136                         uint16_t SectorSize;
 137                         uint8_t  SectorsPerCluster;
 138                         uint16_t ReservedSectors;
 139                         uint8_t  FATCopies;
 140                         uint16_t RootDirectoryEntries;
 141                         uint16_t TotalSectors16;
 142                         uint8_t  MediaDescriptor;
 143                         uint16_t SectorsPerFAT;
 144                         uint16_t SectorsPerTrack;
 145                         uint16_t Heads;
 146                         uint32_t HiddenSectors;
 147                         uint32_t TotalSectors32;
 148                         uint16_t PhysicalDriveNum;
 149                         uint8_t  ExtendedBootRecordSig;
 150                         uint32_t VolumeSerialNumber;
 151                         uint8_t  VolumeLabel[11];
 152                         uint8_t  FilesystemIdentifier[8];
 153                         /* uint8_t  BootstrapProgram[448]; */
 154                         /* uint16_t MagicSignature; */
 155                 } FATBootBlock_t;
 156
 157                 /** FAT directory entry structure, for the various kinds of File and
 158                  *  directory descriptors on a FAT disk.
 159                  */
 160                 typedef union
 161                 {
 162                         /** FAT Long File Name directory entry. */
 163                         struct
 164                         {
 165                                 uint8_t  Ordinal;
 166                                 uint16_t Unicode1;
 167                                 uint16_t Unicode2;
 168                                 uint16_t Unicode3;
 169                                 uint16_t Unicode4;
 170                                 uint16_t Unicode5;
 171                                 uint8_t  Attribute;
 172                                 uint8_t  Reserved1;
 173                                 uint8_t  Checksum;
 174                                 uint16_t Unicode6;
 175                                 uint16_t Unicode7;
 176                                 uint16_t Unicode8;
 177                                 uint16_t Unicode9;
 178                                 uint16_t Unicode10;
 179                                 uint16_t Unicode11;
 180                                 uint16_t Reserved2;
 181                                 uint16_t Unicode12;
 182                                 uint16_t Unicode13;
 183                         } VFAT_LongFileName;
 184
 185                         /** FAT MSDOS 8.3 legacy file entry. */
 186                         struct
 187                         {
 188                                 uint8_t  Filename[8];
 189                                 uint8_t  Extension[3];
 190                                 uint8_t  Attributes;
 191                                 uint8_t  Reserved[10];
 192                                 uint16_t CreationTime;
 193                                 uint16_t CreationDate;
 194                                 uint16_t StartingCluster;
 195                                 uint32_t FileSizeBytes;
 196                         } MSDOS_File;
 197
 198                         /** FAT MSDOS (sub-)directory entry. */
 199                         struct
 200                         {
 201                                 uint8_t  Name[11];
 202                                 uint8_t  Attributes;
 203                                 uint8_t  Reserved[10];
 204                                 uint16_t CreationTime;
 205                                 uint16_t CreationDate;
 206                                 uint16_t StartingCluster;
 207                                 uint32_t Reserved2;
 208                         } MSDOS_Directory;
 209                 } FATDirectoryEntry_t;
 210
 211         /* Function Prototypes: */
 212                 #if defined(INCLUDE_FROM_VIRTUAL_FAT_C)
 213                         static void UpdateFAT12ClusterEntry(uint8_t* const FATTable,
 214                                                             const uint16_t Index,
 215                                                             const uint16_t ChainEntry) AUX_BOOT_SECTION;
 216                         static void WriteVirtualBlock(const uint16_t BlockNumber) AUX_BOOT_SECTION;
 217                         static void ReadVirtualBlock(const uint16_t BlockNumber) AUX_BOOT_SECTION;
 218                 #endif
 219
 220                 void VirtualFAT_WriteBlocks(const uint16_t BlockAddress,
 221                                             uint16_t TotalBlocks) AUX_BOOT_SECTION;
 222
 223                 void VirtualFAT_ReadBlocks(const uint16_t BlockAddress,
 224                                            uint16_t TotalBlocks) AUX_BOOT_SECTION;
 225 #endif