ptxNvm.h

Go to the documentation of this file.

 
#ifndef PTXNVM_H_
#define PTXNVM_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptx_Status.h"
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES
 * ####################################################################################################################
 */
 
#define PTX_NVM_MAX_PATH_LEN            256U        
typedef enum ptxNvm_FileMode
{
    ptxNvm_FileMode_None,
    ptxNvm_FileMode_Read,               
    ptxNvm_FileMode_Write,              
    ptxNvm_FileMode_Append,             
    ptxNvm_FileMode_ReadUpdate,         
    ptxNvm_FileMode_WriteUpdate,        
    ptxNvm_FileMode_AppendUpdate        
} ptxNvm_FileMode_t;
 
typedef struct ptxFileHandle
{
    void               *F;              
    ptxNvm_FileMode_t   Mode;           
} ptxFileHandle_t;
 
typedef struct ptxNvmRecord
{
    void               *F;              
    char               *NvmName;        
    size_t              Length;         
}ptxNvmRecord_t;
 
struct ptxNvm;
 
typedef ptxStatus_t (*pptxNvm_Read_t) (struct ptxNvm *nvm, uint8_t *buffer, size_t bufferLen, ptxNvmRecord_t *nvmRecord);
 
typedef ptxStatus_t (*pptxNvm_Write_t) (struct ptxNvm *nvm, uint8_t *buffer, size_t bufferLen, ptxNvmRecord_t *nvmRecord);
 
typedef ptxStatus_t (*pptxNvm_CreateRecord_t) (struct ptxNvm *nvm, uint8_t *buffer, size_t bufferLen, ptxNvmRecord_t *nvmRecord);
 
typedef ptxStatus_t (*pptxNvm_IsRecordCreated_t)(struct ptxNvm *nvm, ptxNvmRecord_t *nvmRecord);
 
 struct ptxOsal;
 
typedef struct ptxNvm
{
    /*
     * Attributes.
     */
    char                       *prefix;                         
    uint32_t                    SwId;                           
    char                        Path[PTX_NVM_MAX_PATH_LEN];     
    uint8_t                     IsPathProvided;                 
    /*
     * Function pointers.
     */
    pptxNvm_Read_t              ReadFn;                         
    pptxNvm_Write_t             WriteFn;                        
    pptxNvm_CreateRecord_t      CreateRecordFn;                 
    pptxNvm_IsRecordCreated_t   IsRecordCreatedFn;              
} ptxNvm_t;
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxNvm_Init (ptxNvm_t *nvm, uint32_t swId);
 
ptxStatus_t ptxNvm_SetPath (ptxNvm_t *nvm, const char *nvmPath);
 
ptxStatus_t ptxNvm_DeInit (ptxNvm_t *nvm);
 
ptxStatus_t ptxNvm_Read (ptxNvm_t *nvm, uint8_t *buffer, size_t bufferLen, ptxNvmRecord_t *nvmRecord);
 
ptxStatus_t ptxNvm_Write (ptxNvm_t *nvm, uint8_t *buffer, size_t bufferLen, ptxNvmRecord_t *nvmRecord);
 
ptxStatus_t ptxNvm_Write_And_Flush (ptxNvm_t *nvm, uint8_t *buffer, size_t bufferLen, ptxNvmRecord_t *nvmRecord);
 
ptxStatus_t ptxNvm_CreateRecord (ptxNvm_t *nvm, uint8_t *buffer, size_t bufferLen, ptxNvmRecord_t *nvmRecord);
 
ptxStatus_t ptxNvm_IsRecordCreated (ptxNvm_t *nvm, ptxNvmRecord_t *nvmRecord);
 
 
/*
 * ####################################################################################################################
 * HELPER FUNCTIONS.
 * ####################################################################################################################
 */
 
ptxStatus_t ptxNvm_FileOpen(ptxNvm_t *nvm, const char *fileNameID, ptxNvm_FileMode_t fileMode, uint8_t isBinary, ptxFileHandle_t *fileHandle);
 
ptxStatus_t ptxNvm_FileRead(ptxNvm_t *nvm, ptxFileHandle_t *fileHandle, uint8_t *dataBlock, size_t *dataBlockSize);
 
ptxStatus_t ptxNvm_FileWrite(ptxNvm_t *nvm, ptxFileHandle_t *fileHandle, uint8_t *dataBlock, size_t dataBlockSize);
 
ptxStatus_t ptxNvm_FileClose(ptxNvm_t *nvm, ptxFileHandle_t *fileHandle);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */