X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/b956fedeeb97c0493a8910245b2e59b2bfd16eca..3642ea0b9715cdf0196b10c9fc97898940eaefa6:/Bootloaders/MassStorage/Lib/VirtualFAT.c diff --git a/Bootloaders/MassStorage/Lib/VirtualFAT.c b/Bootloaders/MassStorage/Lib/VirtualFAT.c index 569b754f9..63d4ea0f6 100644 --- a/Bootloaders/MassStorage/Lib/VirtualFAT.c +++ b/Bootloaders/MassStorage/Lib/VirtualFAT.c @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2013. + Copyright (C) Dean Camera, 2015. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2013 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2015 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted @@ -95,60 +95,145 @@ static FATDirectoryEntry_t FirmwareFileEntries[] = /* VFAT Long File Name entry for the virtual firmware file; required to * prevent corruption from systems that are unable to detect the device * as being a legacy MSDOS style FAT12 volume. */ - [DISK_FILE_ENTRY_FirmwareLFN] = + [DISK_FILE_ENTRY_FLASH_LFN] = { .VFAT_LongFileName = { - .Ordinal = FAT_ORDINAL_LAST_ENTRY | 1, + .Ordinal = 1 | FAT_ORDINAL_LAST_ENTRY, .Attribute = FAT_FLAG_LONG_FILE_NAME, .Reserved1 = 0, .Reserved2 = 0, - .Checksum = 0x57, + .Checksum = FAT_CHECKSUM('F','L','A','S','H',' ',' ',' ','B','I','N'), .Unicode1 = 'F', - .Unicode2 = 'I', - .Unicode3 = 'R', - .Unicode4 = 'M', - .Unicode5 = 'W', - .Unicode6 = 'A', - .Unicode7 = 'R', - .Unicode8 = 'E', - .Unicode9 = '.', - .Unicode10 = 'B', - .Unicode11 = 'I', - .Unicode12 = 'N', + .Unicode2 = 'L', + .Unicode3 = 'A', + .Unicode4 = 'S', + .Unicode5 = 'H', + .Unicode6 = '.', + .Unicode7 = 'B', + .Unicode8 = 'I', + .Unicode9 = 'N', + .Unicode10 = 0, + .Unicode11 = 0, + .Unicode12 = 0, .Unicode13 = 0, } }, /* MSDOS file entry for the virtual Firmware image. */ - [DISK_FILE_ENTRY_FirmwareMSDOS] = + [DISK_FILE_ENTRY_FLASH_MSDOS] = { .MSDOS_File = { - .Filename = "FIRMWARE", + .Filename = "FLASH ", .Extension = "BIN", .Attributes = 0, .Reserved = {0}, .CreationTime = FAT_TIME(1, 1, 0), .CreationDate = FAT_DATE(14, 2, 1989), .StartingCluster = 2, - .FileSizeBytes = FIRMWARE_FILE_SIZE_BYTES, + .FileSizeBytes = FLASH_FILE_SIZE_BYTES, + } + }, + + [DISK_FILE_ENTRY_EEPROM_LFN] = + { + .VFAT_LongFileName = + { + .Ordinal = 1 | FAT_ORDINAL_LAST_ENTRY, + .Attribute = FAT_FLAG_LONG_FILE_NAME, + .Reserved1 = 0, + .Reserved2 = 0, + + .Checksum = FAT_CHECKSUM('E','E','P','R','O','M',' ',' ','B','I','N'), + + .Unicode1 = 'E', + .Unicode2 = 'E', + .Unicode3 = 'P', + .Unicode4 = 'R', + .Unicode5 = 'O', + .Unicode6 = 'M', + .Unicode7 = '.', + .Unicode8 = 'B', + .Unicode9 = 'I', + .Unicode10 = 'N', + .Unicode11 = 0, + .Unicode12 = 0, + .Unicode13 = 0, + } + }, + + [DISK_FILE_ENTRY_EEPROM_MSDOS] = + { + .MSDOS_File = + { + .Filename = "EEPROM ", + .Extension = "BIN", + .Attributes = 0, + .Reserved = {0}, + .CreationTime = FAT_TIME(1, 1, 0), + .CreationDate = FAT_DATE(14, 2, 1989), + .StartingCluster = 2 + FILE_CLUSTERS(FLASH_FILE_SIZE_BYTES), + .FileSizeBytes = EEPROM_FILE_SIZE_BYTES, } }, }; -/** Starting block of the virtual firmware file image on disk. On Windows, files - * are (usually?) replaced using the original file's physical sectors. On Linux - * file replacements are performed with an offset. +/** Starting cluster of the virtual FLASH.BIN file on disk, tracked so that the + * offset from the start of the data sector can be determined. On Windows + * systems files are usually replaced using the original file's disk clusters, + * while Linux appears to overwrite with an offset which must be compensated for. */ -static uint16_t FileStartBlock = DISK_BLOCK_DataStartBlock; +static const uint16_t* FLASHFileStartCluster = &FirmwareFileEntries[DISK_FILE_ENTRY_FLASH_MSDOS].MSDOS_File.StartingCluster; +/** Starting cluster of the virtual EEPROM.BIN file on disk, tracked so that the + * offset from the start of the data sector can be determined. On Windows + * systems files are usually replaced using the original file's disk clusters, + * while Linux appears to overwrite with an offset which must be compensated for. + */ +static const uint16_t* EEPROMFileStartCluster = &FirmwareFileEntries[DISK_FILE_ENTRY_EEPROM_MSDOS].MSDOS_File.StartingCluster; + +/** Reads a byte of EEPROM out from the EEPROM memory space. + * + * \note This function is required as the avr-libc EEPROM functions do not cope + * with linker relaxations, and a jump longer than 4K of FLASH on the + * larger USB AVRs will break the linker. This function is marked as + * never inlinable and placed into the normal text segment so that the + * call to the EEPROM function will be short even if the AUX boot section + * is used. + * + * \param[in] Address Address of the EEPROM location to read from + * + * \return Read byte of EEPROM data. + */ +static uint8_t ReadEEPROMByte(const uint8_t* const Address) +{ + return eeprom_read_byte(Address); +} + +/** Writes a byte of EEPROM out to the EEPROM memory space. + * + * \note This function is required as the avr-libc EEPROM functions do not cope + * with linker relaxations, and a jump longer than 4K of FLASH on the + * larger USB AVRs will break the linker. This function is marked as + * never inlinable and placed into the normal text segment so that the + * call to the EEPROM function will be short even if the AUX boot section + * is used. + * + * \param[in] Address Address of the EEPROM location to write to + * \param[in] Data New data to write to the EEPROM location + */ +static void WriteEEPROMByte(uint8_t* const Address, + const uint8_t Data) +{ + eeprom_update_byte(Address, Data); +} /** Updates a FAT12 cluster entry in the FAT file table with the specified next * chain index. If the cluster is the last in the file chain, the magic value - * 0xFFF is used. + * \c 0xFFF should be used. * * \note FAT data cluster indexes are offset by 2, so that cluster 2 is the * first file data cluster on the disk. See the FAT specification. @@ -179,22 +264,52 @@ static void UpdateFAT12ClusterEntry(uint8_t* const FATTable, } } +/** Updates a FAT12 cluster chain in the FAT file table with a linear chain of + * the specified length. + * + * \note FAT data cluster indexes are offset by 2, so that cluster 2 is the + * first file data cluster on the disk. See the FAT specification. + * + * \param[out] FATTable Pointer to the FAT12 allocation table + * \param[in] Index Index of the start of the cluster chain to update + * \param[in] ChainLength Length of the chain to write, in clusters + */ +static void UpdateFAT12ClusterChain(uint8_t* const FATTable, + const uint16_t Index, + const uint8_t ChainLength) +{ + for (uint8_t i = 0; i < ChainLength; i++) + { + uint16_t CurrentCluster = Index + i; + uint16_t NextCluster = CurrentCluster + 1; + + /* Mark last cluster as end of file */ + if (i == (ChainLength - 1)) + NextCluster = 0xFFF; + + UpdateFAT12ClusterEntry(FATTable, CurrentCluster, NextCluster); + } +} + /** Reads or writes a block of data from/to the physical device FLASH using a * block buffer stored in RAM, if the requested block is within the virtual * firmware file's sector ranges in the emulated FAT file system. * - * \param[in] BlockNumber Physical disk block to read from + * \param[in] BlockNumber Physical disk block to read from/write to * \param[in,out] BlockBuffer Pointer to the start of the block buffer in RAM * \param[in] Read If \c true, the requested block is read, if * \c false, the requested block is written */ -static void ReadWriteFirmwareFileBlock(const uint16_t BlockNumber, - uint8_t* BlockBuffer, - const bool Read) +static void ReadWriteFLASHFileBlock(const uint16_t BlockNumber, + uint8_t* BlockBuffer, + const bool Read) { + uint16_t FileStartBlock = DISK_BLOCK_DataStartBlock + (*FLASHFileStartCluster - 2) * SECTOR_PER_CLUSTER; + uint16_t FileEndBlock = FileStartBlock + (FILE_SECTORS(FLASH_FILE_SIZE_BYTES) - 1); + /* Range check the write request - abort if requested block is not within the * virtual firmware file sector range */ - if (!((BlockNumber >= FileStartBlock) && (BlockNumber < (FileStartBlock + FILE_SECTORS(FIRMWARE_FILE_SIZE_BYTES))))) + if (!((BlockNumber >= FileStartBlock) && (BlockNumber <= FileEndBlock))) return; #if (FLASHEND > 0xFFFF) @@ -239,6 +354,43 @@ static void ReadWriteFirmwareFileBlock(const uint16_t BlockNumber, } } +/** Reads or writes a block of data from/to the physical device EEPROM using a + * block buffer stored in RAM, if the requested block is within the virtual + * firmware file's sector ranges in the emulated FAT file system. + * + * \param[in] BlockNumber Physical disk block to read from/write to + * \param[in,out] BlockBuffer Pointer to the start of the block buffer in RAM + * \param[in] Read If \c true, the requested block is read, if + * \c false, the requested block is written + */ +static void ReadWriteEEPROMFileBlock(const uint16_t BlockNumber, + uint8_t* BlockBuffer, + const bool Read) +{ + uint16_t FileStartBlock = DISK_BLOCK_DataStartBlock + (*EEPROMFileStartCluster - 2) * SECTOR_PER_CLUSTER; + uint16_t FileEndBlock = FileStartBlock + (FILE_SECTORS(EEPROM_FILE_SIZE_BYTES) - 1); + + /* Range check the write request - abort if requested block is not within the + * virtual firmware file sector range */ + if (!((BlockNumber >= FileStartBlock) && (BlockNumber <= FileEndBlock))) + return; + + uint16_t EEPROMAddress = (uint16_t)(BlockNumber - FileStartBlock) * SECTOR_SIZE_BYTES; + + if (Read) + { + /* Read out the mapped block of data from the device's EEPROM */ + for (uint16_t i = 0; i < SECTOR_SIZE_BYTES; i++) + BlockBuffer[i] = ReadEEPROMByte((uint8_t*)EEPROMAddress++); + } + else + { + /* Write out the mapped block of data to the device's EEPROM */ + for (uint16_t i = 0; i < SECTOR_SIZE_BYTES; i++) + WriteEEPROMByte((uint8_t*)EEPROMAddress++, BlockBuffer[i]); + } +} + /** Writes a block of data to the virtual FAT filesystem, from the USB Mass * Storage interface. * @@ -265,15 +417,11 @@ void VirtualFAT_WriteBlock(const uint16_t BlockNumber) /* Copy over the updated directory entries */ memcpy(FirmwareFileEntries, BlockBuffer, sizeof(FirmwareFileEntries)); - /* Save the new firmware file block offset so the written and read file - * contents can be correctly mapped to the device's FLASH pages */ - FileStartBlock = DISK_BLOCK_DataStartBlock + - (FirmwareFileEntries[DISK_FILE_ENTRY_FirmwareMSDOS].MSDOS_File.StartingCluster - 2) * SECTOR_PER_CLUSTER; - break; default: - ReadWriteFirmwareFileBlock(BlockNumber, BlockBuffer, false); + ReadWriteFLASHFileBlock(BlockNumber, BlockBuffer, false); + ReadWriteEEPROMFileBlock(BlockNumber, BlockBuffer, false); break; } @@ -308,18 +456,11 @@ void VirtualFAT_ReadBlock(const uint16_t BlockNumber) /* Cluster 1: Reserved */ UpdateFAT12ClusterEntry(BlockBuffer, 1, 0xFFF); - /* Cluster 2 onwards: Cluster chain of FIRMWARE.BIN */ - for (uint16_t i = 0; i <= FILE_CLUSTERS(FIRMWARE_FILE_SIZE_BYTES); i++) - { - uint16_t CurrentCluster = FirmwareFileEntries[DISK_FILE_ENTRY_FirmwareMSDOS].MSDOS_File.StartingCluster + i; - uint16_t NextCluster = CurrentCluster + 1; - - /* Mark last cluster as end of file */ - if (i == FILE_CLUSTERS(FIRMWARE_FILE_SIZE_BYTES)) - NextCluster = 0xFFF; + /* Cluster 2 onwards: Cluster chain of FLASH.BIN */ + UpdateFAT12ClusterChain(BlockBuffer, *FLASHFileStartCluster, FILE_CLUSTERS(FLASH_FILE_SIZE_BYTES)); - UpdateFAT12ClusterEntry(BlockBuffer, CurrentCluster, NextCluster); - } + /* Cluster 2+n onwards: Cluster chain of EEPROM.BIN */ + UpdateFAT12ClusterChain(BlockBuffer, *EEPROMFileStartCluster, FILE_CLUSTERS(EEPROM_FILE_SIZE_BYTES)); break; @@ -329,7 +470,8 @@ void VirtualFAT_ReadBlock(const uint16_t BlockNumber) break; default: - ReadWriteFirmwareFileBlock(BlockNumber, BlockBuffer, true); + ReadWriteFLASHFileBlock(BlockNumber, BlockBuffer, true); + ReadWriteEEPROMFileBlock(BlockNumber, BlockBuffer, true); break; }