eeprom.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 Texas Instruments Incorporated
 *
 *  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 EEPROM_H_
#define EEPROM_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <kernel/dpl/SemaphoreP.h>
#include <drivers/i2c.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define EEPROM_PAGE_SIZE                (256U)
 
#define EEPROM_WR_BUF_SIZE              (2U + EEPROM_PAGE_SIZE)
 
typedef void *EEPROM_Handle;
typedef struct EEPROM_Config_s EEPROM_Config;
typedef struct EEPROM_Params_s EEPROM_Params;
 
typedef int32_t (*EEPROM_OpenFxn)(EEPROM_Config *config,
                                  const EEPROM_Params *params);
 
typedef void (*EEPROM_CloseFxn)(EEPROM_Config *config);
 
typedef int32_t (*EEPROM_ReadFxn)(EEPROM_Config *config,
                                  uint32_t offset,
                                  uint8_t *buf,
                                  uint32_t len);
 
typedef int32_t (*EEPROM_WriteFxn)(EEPROM_Config *config,
                                   uint32_t offset,
                                   const uint8_t *buf,
                                   uint32_t len);
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
struct EEPROM_Params_s
{
    uint32_t        driverInstance;
    uint32_t        i2cAddress;
};
 
typedef struct EEPROM_Fxns_s
{
    EEPROM_OpenFxn  openFxn;
    EEPROM_CloseFxn closeFxn;
    EEPROM_ReadFxn  readFxn;
    EEPROM_WriteFxn writeFxn;
} EEPROM_Fxns;
 
typedef struct EEPROM_Attrs_s
{
    uint32_t        size;
    uint32_t        pageCount;
    uint32_t        pageSize;
} EEPROM_Attrs;
 
struct EEPROM_Config_s
{
    EEPROM_Attrs   *attrs;
    EEPROM_Fxns    *fxns;
    void           *object;
};
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void EEPROM_Params_init(EEPROM_Params *params);
 
EEPROM_Handle EEPROM_open(uint32_t instanceId, const EEPROM_Params *params);
 
void EEPROM_close(EEPROM_Handle handle);
 
int32_t EEPROM_read(EEPROM_Handle handle,
                    uint32_t offset,
                    uint8_t *buf,
                    uint32_t len);
 
int32_t EEPROM_write(EEPROM_Handle handle,
                     uint32_t offset,
                     const uint8_t *buf,
                     uint32_t len);
 
const EEPROM_Attrs *EEPROM_getAttrs(uint32_t instanceId);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
typedef struct
{
    I2C_Handle          i2cHandle;
    uint32_t            driverInstance;
    uint32_t            i2cAddress;
    uint8_t             pageWrBuf[EEPROM_WR_BUF_SIZE];
    void               *lock;
    SemaphoreP_Object   lockObj;
} EEPROM_Object;
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef EEPROM_H_ */