eeprom4 2.0.0.0
eeprom4.h File Reference

This file contains API for EEPROM 4 Click driver. More...

#include "drv_digital_out.h"
#include "drv_spi_master.h"

Go to the source code of this file.

Data Structures

struct  eeprom4_t
 Click ctx object definition. More...
 
struct  eeprom4_cfg_t
 Click configuration structure definition. More...
 

Macros

#define EEPROM4_MAP_MIKROBUS(cfg, mikrobus)
 
#define EEPROM4_RETVAL   uint8_t
 
#define EEPROM4_OK   0x00
 
#define EEPROM4_INIT_ERROR   0xFF
 
#define EEPROM4_LOGIC_HIGH   1
 
#define EEPROM4_LOGIC_LOW   0
 
#define EEPROM4_READY_BIT   0x01
 
#define EEPROM4_WRITE_ENABLE_LATCH_BIT   0x02
 
#define EEPROM4_WRITE_PROTECT_ENABLE_BIT   0x80
 
#define EEPROM4_LOW_POWER_WRITE_POLL_COMMAND   0x08
 
#define EEPROM4_SET_WRITE_ENABLE_LATCH_COMMAND   0x06
 
#define EEPROM4_RESET_WRITE_ENABLE_LATCH_COMMAND   0x04
 
#define EEPROM4_FIRST_MEMORY_LOCATION   0x00000000
 
#define EEPROM4_ONE_QUARTER_MEMORY_LOCATION   0x0000FFFF
 
#define EEPROM4_HALF_MEMORY_LOCATION   0x0001FFFF
 
#define EEPROM4_TWO_QUARTER_MEMORY_LOCATION   0x0002FFFF
 
#define EEPROM4_LAST_MEMORY_LOCATION   0x0003FFFF
 
#define EEPROM4_NONE_PROTECTED_MEMORY_LOCATION   0x00
 
#define EEPROM4_ONE_QUARTER_PROTECTED_MEMORY_LOCATION   0x04
 
#define EEPROM4_HALF_PROTECTED_MEMORY_LOCATION   0x08
 
#define EEPROM4_ALL_PROTECTED_MEMORY_LOCATION   0x0C
 

Functions

void eeprom4_cfg_setup (eeprom4_cfg_t *cfg)
 Config Object Initialization function.
 
EEPROM4_RETVAL eeprom4_init (eeprom4_t *ctx, eeprom4_cfg_t *cfg)
 Initialization function.
 
void eeprom4_default_cfg (eeprom4_t *ctx)
 Click Default Configuration function.
 
void eeprom4_generic_transfer (eeprom4_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function.
 
uint8_t eeprom4_send_command (eeprom4_t *ctx, uint8_t command_byte)
 Command send function.
 
void eeprom4_write_status_reg (eeprom4_t *ctx, uint8_t data_value)
 Status register write function.
 
uint8_t eeprom4_read_status_reg (eeprom4_t *ctx)
 Status register read function.
 
void eeprom4_write_memory (eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_input, uint8_t n_bytes)
 Memory array write function.
 
void eeprom4_read_memory (eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_output, uint8_t n_bytes)
 Memory array read function.
 
void eeprom4_enable_write_protect (eeprom4_t *ctx, uint8_t state)
 Write Protect enable function.
 
void eeprom4_enable_hold_operation (eeprom4_t *ctx, uint8_t state)
 Hold operation enable function.
 
uint8_t eeprom4_check_status_reg (eeprom4_t *ctx, uint8_t check_bit)
 Status register bits check function.
 

Detailed Description

This file contains API for EEPROM 4 Click driver.