nvm_api.h

Go to the documentation of this file.

 
#ifndef __NVM_API_H
#define __NVM_API_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#ifdef ERASE_VALUE_IS_FF
  #define NVM_BLOCK_INVALID 0xFFFFFFFCFFFFFF0E
  #define NVM_BLOCK_VALID   0xFFFFFF0CFFFFFF0E
  #define NVM_BLOCK_EMPTY   0xFFFFFFFFFFFFFFFF
 
  #define NVM_BLOCK_INVALID_1 0xFFFFFFFF
  #define NVM_BLOCK_INVALID_2 0xFFFFFF0E
 
  #define NVM_BLOCK_VALID_1     0xFFFFFF0E
  #define NVM_BLOCK_VALID_2     0xFFFFFF0C
#else
  #define NVM_BLOCK_INVALID 0x00000000000000FE
  #define NVM_BLOCK_VALID   0x000000FC000000FE
  #define NVM_BLOCK_EMPTY   0x00
 
  #define NVM_BLOCK_INVALID_1 0x00000000
  #define NVM_BLOCK_INVALID_2 0x000000FE
 
  #define NVM_BLOCK_VALID_1     0x000000FE
  #define NVM_BLOCK_VALID_2     0x000000FC
#endif
 
#define BLOCK_HEADER_SIZE 8 /* To preserve data integrity, 2 words are reserved for record validation */
#define BLOCK_BODY_SIZE   8 /* NVM data size */
 
#define EEPROM_NVDATA_ADDRESS 0x600
#define RCZ_MASK 0x000000FF
 
typedef enum
{
  NVM_TYPE_EEPROM = 0,
  NVM_TYPE_FLASH = 1
} NVM_TYPE;
 
 
typedef enum
{
  NVM_WRITE_MODE_WRITEOVER = 0, 
  NVM_WRITE_MODE_ERASE = 1      
} NVM_WRITE_MODE;
 
 
typedef enum
{
  NVM_RW_OK = 0,
  NVM_WRITE_ERROR,
  NVM_READ_ERROR,
  NVM_WRITE_RECORD_ERROR,
  NVM_READ_RECORD_ERROR,
  NVM_WRITE_HEADER_ERROR,
  NVM_NO_RECORDS
} NVM_RW_RESULTS;
 
 
typedef enum
{
  NVM_FREQ_OFFSET = 0,
  NVM_RSSI_OFFSET = 1,
  NVM_LBT_OFFSET = 2
} NVM_UPDATE_OFFSET;
 
 
typedef struct
{
  NVM_TYPE nvmType; 
  uint32_t boardDataAddress;
  uint32_t sfxDataAddress;
  uint8_t  messageSequenceNumber;
} NVM_ConfigType;
 
 
#define INIT_NVM_CONFIG(X) NVM_ConfigType X = { .nvmType = NVM_TYPE_EEPROM, \
.boardDataAddress = 0, .sfxDataAddress = EEPROM_NVDATA_ADDRESS, .messageSequenceNumber = 0x00 }
 
 
typedef struct
{
  uint16_t pn;
  uint16_t seqNumber;
  uint16_t fh;
  uint16_t rl;
} NVM_RecurrentDataType;
 
 
typedef struct
{
  uint32_t id;
  uint8_t  rcz;
  uint8_t  pac[8];
  int32_t  freqOffset;
  int32_t  rssiOffset;
  int32_t  lbtOffset;
} NVM_BoardDataType;
 
 
/*-------------------------------------FUNCTION PROTOTYPES------------------------------------*/
 
void SetNVMInitial(NVM_ConfigType *config);
 
 
NVM_TYPE GetNVMType(void);
 
 
uint32_t GetNVMBoardDataAddress(void);
 
 
uint32_t GetNVMSigfoxDataAddress(void);
 
 
NVM_RW_RESULTS NVM_Read(uint32_t nAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
 
 
NVM_RW_RESULTS NVM_Write(uint32_t nAddress, uint8_t cNbBytes, uint8_t* pcBuffer, NVM_WRITE_MODE writeMode);
 
 
NVM_RW_RESULTS NVM_ReadRecord(uint8_t* nvmRecord, uint32_t recordSize);
 
 
NVM_RW_RESULTS NVM_WriteRecord(uint8_t* nvmRecord, uint32_t recordSize);
 
 
NVM_RW_RESULTS NVM_UpdateOffset(NVM_UPDATE_OFFSET updateWhat, int32_t data);
 
#ifdef __cplusplus
}
#endif
 
#endif
 
/******************* (C) COPYRIGHT 2019 STMicroelectronics *****END OF FILE*****/