MPFS2.h

Go to the documentation of this file.

/*********************************************************************
 * Software License Agreement
 *
 * Copyright (C) 2002-2008 Microchip Technology Inc.  All rights 
 * reserved.
 *
 * Microchip licenses to you the right to use, modify, copy, and 
 * distribute: 
 * (i)  the Software when embedded on a Microchip microcontroller or 
 *      digital signal controller product ("Device") which is 
 *      integrated into Licensee's product; or
 * (ii) ONLY the Software driver source files ENC28J60.c and 
 *      ENC28J60.h ported to a non-Microchip device used in 
 *      conjunction with a Microchip ethernet controller for the 
 *      sole purpose of interfacing with the ethernet controller. 
 *
 * You should refer to the license agreement accompanying this 
 * Software for additional information regarding your rights and 
 * obligations.
 *
 * THE SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS" WITHOUT 
 * WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT 
 * LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS FOR A 
 * PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL 
 * MICROCHIP BE LIABLE FOR ANY INCIDENTAL, SPECIAL, INDIRECT OR 
 * CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF 
 * PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR SERVICES, ANY CLAIMS 
 * BY THIRD PARTIES (INCLUDING BUT NOT LIMITED TO ANY DEFENSE 
 * THEREOF), ANY CLAIMS FOR INDEMNITY OR CONTRIBUTION, OR OTHER 
 * SIMILAR COSTS, WHETHER ASSERTED ON THE BASIS OF CONTRACT, TORT 
 * (INCLUDING NEGLIGENCE), BREACH OF WARRANTY, OR OTHERWISE.
 *
 *
 * Author               Date        Comment
 *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * Elliott Wood         07/2007     Complete rewrite as MPFS2
 * E. Wood              04/2008     Updated as MPFS2.1
 ********************************************************************/

#ifndef __MPFS2_H
#define __MPFS2_H


/****************************************************************************
  Section:
    Storage Type Configurations
  ***************************************************************************/
    #if defined(STACK_USE_MPFS) && defined(STACK_USE_MPFS2)
        #error Both MPFS and MPFS2 are included
    #endif

    #if defined(MPFS_USE_EEPROM)
        #if defined(USE_EEPROM_25LC1024)
            #define MPFS_WRITE_PAGE_SIZE        (256u)  // Defines the size of a page in EEPROM
        #else
            #define MPFS_WRITE_PAGE_SIZE        (64u)   // Defines the size of a page in EEPROM
        #endif
    #endif

/****************************************************************************
  Section:
    Type Definitions
  ***************************************************************************/
    #define MPFS2_FLAG_ISZIPPED     ((WORD)0x0001)  // Indicates a file is compressed with GZIP compression
    #define MPFS2_FLAG_HASINDEX     ((WORD)0x0002)  // Indicates a file has an associated index of dynamic variables
    // MODIFIX: Added the following macro:
    #define MPFS2_FLAG_ISCOMPRESSED ((WORD)0x0004)  // Indicates a file is compressed with huffman compression
    #define MPFS_INVALID            (0xffffffffu)   // Indicates a position pointer is invalid
    #define MPFS_INVALID_FAT        (0xffffu)       // Indicates an invalid FAT cache
    #define MPFS_INVALID_HANDLE     (0xffu)         // Indicates that a handle is not valid
    typedef DWORD MPFS_PTR;                         // MPFS Pointers are currently DWORDs
    typedef BYTE MPFS_HANDLE;                       // MPFS Handles are currently stored as BYTEs


    // Stores each file handle's information
    // Handles are free when addr = MPFS_INVALID
    typedef struct
    {
        MPFS_PTR addr;      // Current address in the file system
        DWORD bytesRem;     // How many bytes remain in this file
        WORD fatID;         // ID of which file in the FAT was accessed
        BYTE offset;        // MODIFIX: Added this field for bit position in huffman encoded files.
    } MPFS_STUB;
    
    // Indicates the method for MPFSSeek
    typedef enum
    {
        MPFS_SEEK_START     = 0u,   // Seek forwards from the front of the file
        MPFS_SEEK_END,              // Seek backwards from the end of the file
        MPFS_SEEK_FORWARD,          // Seek forward from the current position
        MPFS_SEEK_REWIND            // See backwards from the current position
    } MPFS_SEEK_MODE;
    
    // Stores the data for an MPFS2 FAT record
    typedef struct
    {
        DWORD string;       // Pointer to the file name
        DWORD data;         // Address of the file data
        DWORD len;          // Length of file data
        DWORD timestamp;    // Timestamp of file
        DWORD microtime;    // Microtime stamp of file
        WORD flags;         // Flags for this file
    } MPFS_FAT_RECORD;

/****************************************************************************
  Section:
    Function Definitions
  ***************************************************************************/

void MPFSInit(void);

MPFS_HANDLE MPFSOpen(BYTE* cFile);
#if defined(__18CXX)
    MPFS_HANDLE MPFSOpenROM(ROM BYTE* cFile);
#else
    // Non-ROM variant for C30 / C32
    #define MPFSOpenROM(a)  MPFSOpen((BYTE*) a);
#endif
MPFS_HANDLE MPFSOpenID(WORD hFatID);
void MPFSClose(MPFS_HANDLE hMPFS);

BOOL MPFSGet(MPFS_HANDLE hMPFS, BYTE* c);
WORD MPFSGetArray(MPFS_HANDLE hMPFS, BYTE* cData, WORD wLen);
BOOL MPFSGetLong(MPFS_HANDLE hMPFS, DWORD* ul);
BOOL MPFSSeek(MPFS_HANDLE hMPFS, DWORD dwOffset, MPFS_SEEK_MODE tMode);
#if defined(__C30__)
    // Assembly function to read all three bytes of program memory for 16-bit parts
    extern DWORD ReadProgramMemory(DWORD address);
#endif

MPFS_HANDLE MPFSFormat(void);
void MPFSPutEnd(BOOL final);
WORD MPFSPutArray(MPFS_HANDLE hMPFS, BYTE* cData, WORD wLen);

DWORD MPFSGetTimestamp(MPFS_HANDLE hMPFS);
DWORD MPFSGetMicrotime(MPFS_HANDLE hMPFS);
WORD MPFSGetFlags(MPFS_HANDLE hMPFS);
DWORD MPFSGetSize(MPFS_HANDLE hMPFS);
DWORD MPFSGetBytesRem(MPFS_HANDLE hMPFS);
MPFS_PTR MPFSGetStartAddr(MPFS_HANDLE hMPFS);
MPFS_PTR MPFSGetEndAddr(MPFS_HANDLE hMPFS);
BOOL MPFSGetFilename(MPFS_HANDLE hMPFS, BYTE* cName, WORD wLen);
DWORD MPFSGetPosition(MPFS_HANDLE hMPFS);
WORD MPFSGetID(MPFS_HANDLE hMPFS);

// Alias of MPFSGetPosition
#define MPFSTell(a) MPFSGetPosition(a)

#endif

---