swieeprom  2.0.0.7
Data Structures | Macros | Enumerations | Functions
swieeprom.h File Reference

This file contains API for SWI EEPROM Click Driver. More...

#include "stdint.h"

Go to the source code of this file.

Data Structures

struct  swieeprom_t
 SWI EEPROM Click context object. More...
 

Macros

#define SWIEEPROM_ID   0x00D200
 SWI EEPROM Click ID value. More...
 

Enumerations

enum  swieeprom_op_code_t {
  SWIEEPROM_OP_CODE_EEPROM = 0xA0, SWIEEPROM_OP_CODE_SECURITY = 0xB0, SWIEEPROM_OP_CODE_LOCK = 0x20, SWIEEPROM_OP_CODE_ROM = 0x70,
  SWIEEPROM_OP_CODE_FREEZE_ROM = 0x10, SWIEEPROM_OP_CODE_ID = 0xC0, SWIEEPROM_OP_CODE_STDN_SPEED = 0xD0, SWIEEPROM_OP_CODE_HIGH_SPEED = 0xE0
}
 SWI EEPROM Click operation codes. More...
 
enum  swieeprom_return_value_t {
  SWIEEPROM_RET_VAL_OK = 0, SWIEEPROM_RET_VAL_ERROR = -1, SWIEEPROM_RET_VAL_ERROR_NO_DEVICE_FOUND = -2, SWIEEPROM_RET_VAL_ERROR_SLAVE_ADDRESS = -3,
  SWIEEPROM_RET_VAL_ERROR_OP_CODE = -4, SWIEEPROM_RET_VAL_ERROR_ADR = -5, SWIEEPROM_RET_VAL_ERROR_DATA = -6, SWIEEPROM_RET_VAL_ERROR_ID = -7
}
 SWI EEPROM Click return values. More...
 

Functions

swieeprom_return_value_t swieeprom_init (swieeprom_t *ctx)
 SWI EEPROM initialization function. More...
 
swieeprom_return_value_t swieeprom_read_id (swieeprom_t *ctx)
 SWI EEPROM check device ID. More...
 
swieeprom_return_value_t swieeprom_write_to_memory (swieeprom_t *ctx, uint8_t mem_adr, uint8_t mem_data)
 SWI EEPROM write byte to memory. More...
 
swieeprom_return_value_t swieeprom_read_from_memory (swieeprom_t *ctx, uint8_t mem_adr, uint8_t *mem_data)
 SWI EEPROM read byte from memory. More...
 
swieeprom_return_value_t swieeprom_write_data_to_memory (swieeprom_t *ctx, uint8_t start_mem_adr, uint8_t *tx_buf, uint16_t buf_len)
 SWI EEPROM write data to memory. More...
 
swieeprom_return_value_t swieeprom_read_data_from_memory (swieeprom_t *ctx, uint8_t start_mem_adr, uint8_t *rx_buf, uint16_t buf_len)
 SWI EEPROM read data from memory. More...
 
swieeprom_return_value_t swieeprom_clear_data_from_memory (swieeprom_t *ctx, uint8_t start_mem_adr, uint16_t buf_len)
 SWI EEPROM clears data from memory. More...
 

Detailed Description

This file contains API for SWI EEPROM Click Driver.