NVS.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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 ti_drivers_NVS__include
#define ti_drivers_NVS__include

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>

#if defined (__cplusplus)
extern "C" {
#endif

#define NVS_CMD_RESERVED            32

#define NVS_STATUS_RESERVED        -32

#define NVS_STATUS_SUCCESS         0

#define NVS_STATUS_ERROR          -1

#define NVS_STATUS_UNDEFINEDCMD   -2

/* Add NVS_CMD_<commands> here */

#define NVS_SOK (0)

#define NVS_EFAIL               (-1)
#define NVS_EOFFSET             (-3)
#define NVS_EALIGN              (-4)
#define NVS_ENOTENOUGHBYTES     (-5)
#define NVS_EALREADYWRITTEN     (-6)
#define NVS_ECOPYBLOCK          (-7)

#define NVS_WRITE_EXCLUSIVE           (0x1)

#define NVS_WRITE_ERASE               (0x2)

#define NVS_WRITE_VALIDATE            (0x4)

typedef struct NVS_Params {
    bool    eraseOnOpen;    
} NVS_Params;

typedef struct NVS_Attrs {
    size_t  pageSize;    
    size_t  blockSize;   
} NVS_Attrs;

typedef struct NVS_Config      *NVS_Handle;

typedef void        (*NVS_CloseFxn)    (NVS_Handle handle);

typedef int         (*NVS_ControlFxn)  (NVS_Handle handle, unsigned int cmd,
                                        uintptr_t arg);

typedef void        (*NVS_ExitFxn)     (NVS_Handle handle);

typedef int         (*NVS_GetAttrsFxn) (NVS_Handle handle, NVS_Attrs *attrs);

typedef void        (*NVS_InitFxn)     (NVS_Handle handle);

typedef NVS_Handle  (*NVS_OpenFxn)     (NVS_Handle handle, NVS_Params *params);

typedef int         (*NVS_ReadFxn)     (NVS_Handle handle, size_t offset,
                                        void *buffer, size_t bufferSize);

typedef int         (*NVS_WriteFxn)    (NVS_Handle handle, size_t offset,
                                        void *buffer, size_t bufferSize,
                                        unsigned int flags);

typedef struct NVS_FxnTable {
    NVS_CloseFxn        closeFxn;

    NVS_ControlFxn      controlFxn;

    NVS_ExitFxn         exitFxn;

    NVS_GetAttrsFxn     getAttrsFxn;

    NVS_InitFxn         initFxn;

    NVS_OpenFxn         openFxn;

    NVS_ReadFxn         readFxn;

    NVS_WriteFxn        writeFxn;
} NVS_FxnTable;

typedef struct NVS_Config {
    NVS_FxnTable const *fxnTablePtr;

    void               *object;

    void         const *hwAttrs;
} NVS_Config;

extern void NVS_close(NVS_Handle handle);

extern int NVS_control(NVS_Handle handle, unsigned int cmd, uintptr_t arg);

extern int NVS_erase(NVS_Handle handle);

extern void NVS_exit(void);

extern int NVS_getAttrs(NVS_Handle handle, NVS_Attrs *attrs);

extern void NVS_init(void);

extern NVS_Handle NVS_open(int index, NVS_Params *params);

extern int NVS_read(NVS_Handle handle, size_t offset, void *buffer,
                    size_t bufferSize);

extern int NVS_write(NVS_Handle handle, size_t offset, void *buffer,
                     size_t bufferSize, unsigned int flags);

#if defined (__cplusplus)
}
#endif /* defined (__cplusplus) */

#endif /* ti_drivers_NVS__include */