Frank Vannieuwkerke / FlashFileSystem

FLASH File System This file system can mount, read, and enumerate a file system image from Flash memory.

Fork of FlashFileSystem by Adam Green

A filesystem for accessing a read-only file system placed in the internal FLASH memory of the mbed board.
The file system to be mounted by this file system should be created through the use of the fsbld utility on the PC.
This fsbld.zip archive contains the sources for that utility.

As fsbld creates two output files (a binary and a header file), there are two ways to add the resulting file system image:

  1. Concatenate the binary file system to the end of the .bin file created by the mbed online compiler before uploading to the mbed device.
    On *nix this can be done with the cat command.
    For example: cat Test_LPC1768.bin FileImage.bin >/Volumes/MBED/test.bin
    On Windows this can be done with the copy command.
    For example: copy /b Test_LPC1768.bin + FileImage.bin e:\test.bin
  2. Import the header file into your project, include this file in your main file and add 'roFlashDrive' to the FlashfileSystem constructor call.
    eg : static FlashFileSystem flash("flash", roFlashDrive);

A third (optional) parameter in the FlashfileSystem constructor call allows you to specify the size of the FLASH (KB) on the device (default = 512). eg (for a KL25Z device) : static FlashFileSystem flash("flash", NULL, 128);
Note that in this example, the pointer to the header file has been omitted, so we need to append the binary file system ourselves (see above). When you include the binary file system header in your main file, you can also use the roFlashDrive pointer. eg (for a KL25Z device) : static FlashFileSystem flash("flash", roFlashDrive, 128);

NOTE
This file system is case-sensitive.
Calling fopen("/flash/INDEX.html") won't successfully open a file named index.html in the root directory of the flash file system.

ffsformat.h

Committer:
AdamGreen
Date:
2011-07-29
Revision:
0:5ea6e74c35f7
Child:
1:a3cb118c4f6e

File content as of revision 0:5ea6e74c35f7:

/*
Copyright (c) 2011 Adam Green http://mbed.org/users/AdamGreen/
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
/* Specifies constants and structures used within the FLASH File System.  The
   header is used by both the runtime and the tool which builds the image on
   the PC.
*/
#ifndef _FFSFORMAT_H_
#define _FFSFORMAT_H_


/* The signature to be placed in SFileSystemHeader::FileSystemSignature.
   Only the first 8 bytes are used and the NULL terminator discarded. */
#define FILE_SYSTEM_SIGNATURE "FFileSys"

/* The size of the FLASH on the device to search through for the file
   system signature. */
#define FILE_SYSTEM_FLASH_SIZE  (512 * 1024)


/* Header stored at the beginning of the file system image. */
typedef struct _SFileSystemHeader
{
    /* Signature should be set to FILE_SYSTEM_SIGNATURE. */
    char            FileSystemSignature[8];
    /* Number of entries in this file system image. */
    unsigned int    FileCount;
    /* The SFileSystemEntry[SFileSystemHeader::FileCount] array will start here. 
       These entries are to be sorted so that a binary search can be performed
       at file open time. */
} SFileSystemHeader;

/* Information about each file added to the file system image. */
typedef struct _SFileSystemEntry
{
    /* The 2 following offsets are relative to the beginning of the file 
       image. */
    unsigned int    FilenameOffset;
    unsigned int    FileBinaryOffset;
    unsigned int    FileBinarySize;
} SFileSystemEntry;


#endif /* _FFSFORMAT_H_ */