eeprom8 2.0.0.0
eeprom8.h File Reference

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

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  eeprom8_t
 EEPROM 8 Click context object. More...
 
struct  eeprom8_cfg_t
 EEPROM 8 Click configuration object. More...
 

Macros

#define EEPROM8_WRITE_ENABLE   0
 
#define EEPROM8_WRITE_PROTECT   1
 
#define EEPROM8_BLOCK_ADDR_START   0x0000
 EEPROM 8 memory address range.
 
#define EEPROM8_BLOCK_ADDR_END   0xFFFFul
 
#define EEPROM8_NBYTES_MIN   1
 EEPROM 8 data transfer option.
 
#define EEPROM8_NBYTES_PAGE   128
 
#define EEPROM8_SET_DEV_ADDR   0x50
 EEPROM 8 device address setting.
 
#define EEPROM8_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  eeprom_i2c_address_selector_t {
  EEPROM_I2C_ADDR_SEL_0 = 0 , EEPROM_I2C_ADDR_SEL_1 , EEPROM_I2C_ADDR_SEL_2 , EEPROM_I2C_ADDR_SEL_3 ,
  EEPROM_I2C_ADDR_SEL_4 , EEPROM_I2C_ADDR_SEL_5 , EEPROM_I2C_ADDR_SEL_6 , EEPROM_I2C_ADDR_SEL_7
}
 Click address (memory block) selection. More...
 
enum  eeprom8_return_value_t { EEPROM8_OK = 0 , EEPROM8_ERROR = -1 }
 EEPROM 8 Click return value data. More...
 

Functions

void eeprom8_cfg_setup (eeprom8_cfg_t *cfg)
 EEPROM 8 configuration object setup function.
 
err_t eeprom8_init (eeprom8_t *ctx, eeprom8_cfg_t *cfg)
 EEPROM 8 initialization function.
 
err_t eeprom8_write_byte (eeprom8_t *ctx, uint16_t reg_addr, uint8_t data_in)
 Byte Write function.
 
err_t eeprom8_write_page (eeprom8_t *ctx, uint16_t reg_addr, uint8_t *data_in)
 Page Write function.
 
err_t eeprom8_read_random_byte (eeprom8_t *ctx, uint16_t reg_addr, uint8_t *data_out)
 Random Byte Read function.
 
err_t eeprom8_read_current_byte (eeprom8_t *ctx, uint8_t *data_out)
 Byte Read function.
 
err_t eeprom8_read_sequential (eeprom8_t *ctx, uint16_t reg_addr, uint16_t n_bytes, uint8_t *data_out)
 Sequential Read function.
 
void eeprom8_write_enable (eeprom8_t *ctx)
 Write Enable function.
 
void eeprom8_write_protect (eeprom8_t *ctx)
 Write Protect function.
 

Detailed Description

This file contains API for EEPROM 8 Click Driver.

Enumeration Type Documentation

◆ eeprom8_return_value_t

EEPROM 8 Click return value data.

Predefined enum values for driver return values.

Enumerator
EEPROM8_OK 
EEPROM8_ERROR 

◆ eeprom_i2c_address_selector_t

Click address (memory block) selection.

Memory block is defined by ADDR SEL switch.

Enumerator
EEPROM_I2C_ADDR_SEL_0 
EEPROM_I2C_ADDR_SEL_1 
EEPROM_I2C_ADDR_SEL_2 
EEPROM_I2C_ADDR_SEL_3 
EEPROM_I2C_ADDR_SEL_4 
EEPROM_I2C_ADDR_SEL_5 
EEPROM_I2C_ADDR_SEL_6 
EEPROM_I2C_ADDR_SEL_7