FATFS.h

Go to the documentation of this file.

/*
 * Copyright (C) 2014 Texas Instruments Incorporated - http://www.ti.com/
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of Texas Instruments Incorporated nor the names of
 * its contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
#ifndef FATFS_H
#define FATFS_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stddef.h>
#include <ti/fs/fatfs/ff.h>
#include <ti/fs/fatfs/diskio.h>

#define FATFS_OK                                     0

#define FATFS_ERR                                   (-(1))

#define FATFS_VOLUME_FULL_ERR                       (-(10))

#define FATFS_VOLUME_DISK_AVL                       (0)

/*Offset macros of MBR table */
#define FATFS_MBR_TABLE                             (446)

#define FATFS_SZ_PTE                                (16)

#define FATFS_NUM_OF_PARTITIONS                     (4)

#define FATFS_MBR_PT_TYPE_OFFSET                    (4)

#define FATFS_DFLT_VOLUME_PD                        (0xf)

#define FATFS_DFLT_VOLUME_PT                        (0xf)

#define FATFS_MOUNT_IMMEDIATE                        (1)

#define FATFS_MOUNT_LATER                            (0)

#define FATFS_MEDIA_BOOT_SEC_OFFSET                  (21)

#define FATFS_JUMP_BOOT_SEC_OFFSET                   (0)

#define FATFS_BOOT_MEDIA_TYPE_NON_REM                (0xF0)

#define FATFS_BOOT_MEDIA_REM_TYPE_MIN                (0xF8)

#define FATFS_BOOT_MEDIA_REM_TYPE_MAX                (0xFF)

#define FATFS_JUMP_BOOT_SEC_JMP_INS_0                (0xEB)

#define FATFS_JUMP_BOOT_SEC_JMP_INS_1                (0xE9)

typedef int32_t                   FATFS_Error;

typedef void                     *FATFS_Handle;

typedef void                     *FATFS_Params;

typedef void                     *FATFS_DrvHandle;

typedef void                     *FATFS_DrvParams;

typedef struct FATFS_DrvFxnTable_s  FATFS_DrvFxnTable;

typedef struct FATFS_ConfigParams_s {
    FATFS_DrvHandle    drvHandle;       
    FATFS_DrvParams    drvParams;       
    FATFS_DrvFxnTable *drvFxnTablePtr;  
    void              *custom;          
} FATFS_ConfigParams;

typedef FATFS_Error (*FATFS_CloseDrvFxn) (FATFS_DrvHandle drvHandle);

typedef FATFS_Error (*FATFS_ControlDrvFxn) (FATFS_DrvHandle drvHandle,
                                            uint32_t cmd,
                                            void *arg);

typedef FATFS_Error (*FATFS_InitDrvFxn) (void);

typedef FATFS_Error (*FATFS_OpenDrvFxn) (uint32_t index,
                                         FATFS_DrvParams  drvParams,
                                         FATFS_DrvHandle *drvHandle);

typedef FATFS_Error (*FATFS_WriteDrvFxn) (FATFS_DrvHandle drvHandle,
                                          uint8_t *buf,
                                          uint32_t block,
                                          uint32_t numBlks);

typedef FATFS_Error (*FATFS_ReadDrvFxn) (FATFS_DrvHandle drvHandle,
                                         uint8_t *buf,
                                         uint32_t block,
                                         uint32_t numBlks);

struct FATFS_DrvFxnTable_s {
    FATFS_CloseDrvFxn             closeDrvFxn;

    FATFS_ControlDrvFxn           controlDrvFxn;

    FATFS_InitDrvFxn              initDrvFxn;

    FATFS_OpenDrvFxn              openDrvFxn;

    FATFS_WriteDrvFxn             writeDrvFxn;

    FATFS_ReadDrvFxn              readDrvFxn;
};

/* SD function table pointer */
extern FATFS_DrvFxnTable FATFS_drvFxnTable;

typedef struct FATFS_HwAttrs_s {
    uint32_t        drvInst; 
} FATFS_HwAttrs;

typedef struct FATFS_Object_s {
    FATFS_DrvHandle     drvHandle;     
    uint32_t            drvInst;       
    uint32_t            driveNumber;   
    DSTATUS             diskState;     
    FATFS               filesystem[FATFS_NUM_OF_PARTITIONS];    
    FATFS_ConfigParams  FATFSConfigParams;   
    uint32_t            isOpen;        
} FATFS_Object;

typedef struct FATFS_Config_s {
    FATFS_DrvFxnTable    *drvFxnTablePtr;

    FATFS_Object         *object;

    FATFS_HwAttrs        *hwAttrs;
} FATFS_Config;


/* Avoid Misra warning "MISRA.DECL.ARRAY_SIZE" by pairing config array type 
 * with its array size to avoid externs with [] (no size) */
typedef FATFS_Config FATFSConfigList[((uint32_t)_VOLUMES) + (uint32_t)1U];


extern FATFS_Error FATFS_close(FATFS_Handle handle);

extern FATFS_Error FATFS_open(uint32_t index,
                              FATFS_Params  params,
                              FATFS_Handle *handle);

extern FATFS_Error FATFS_Params_init(FATFS_Params params);

extern FATFS_Error FATFS_init(void);

#ifdef __cplusplus
}
#endif

#endif /* FATFS_H */