eeprom5 2.0.0.0
eeprom5.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  eeprom5_t
 EEPROM 5 Click context object. More...
 
struct  eeprom5_cfg_t
 EEPROM 5 Click configuration object. More...
 
struct  status_data_t
 EEPROM 5 Click status data object. More...
 

Macros

#define EEPROM5_CMD_WREN   0x06
 EEPROM 5 Commands.
 
#define EEPROM5_CMD_WRDI   0x04
 
#define EEPROM5_CMD_RDSR   0x05
 
#define EEPROM5_CMD_WRSR   0x01
 
#define EEPROM5_CMD_READ   0x03
 
#define EEPROM5_CMD_WRITE   0x02
 
#define EEPROM5_CMD_READ_ID   0x83
 
#define EEPROM5_CMD_WRITE_ID   0x82
 
#define EEPROM5_CMD_READ_LOCK_STATUS   0x83
 
#define EEPROM5_CMD_LOCK_ID   0x82
 
#define EEPROM5_WRITE_MEMORY_DISABLE   0x00
 EEPROM 5 Memory enable.
 
#define EEPROM5_WRITE_MEMORY_ENABLE   0x01
 
#define EEPROM5_IDENT_PAGE_ADDR_START   0x0000
 EEPROM 5 Memory address.
 
#define EEPROM5_IDENT_PAGE_ADDR_END   0x01FF
 
#define EEPROM5_SIGNIFICANT_ADDR_BIT_0   0xFB
 EEPROM 5 Significant address bit.
 
#define EEPROM5_SIGNIFICANT_ADDR_BIT_1   0x04
 
#define EEPROM5_MEMORY_ADDR_START   0x00000000ul
 EEPROM 5 Memory address.
 
#define EEPROM5_MEMORY_ADDR_END   0x0007FFFFul
 
#define EEPROM5_HOLD_DISABLE   0x00
 EEPROM 5 Hold enable.
 
#define EEPROM5_HOLD_ENABLE   0x01
 
#define EEPROM5_WRITE_PROTECT_DISABLE   0x00
 EEPROM 5 Write protect.
 
#define EEPROM5_WRITE_PROTECT_ENABLE   0x01
 
#define EEPROM5_DUMMY   0xFF
 EEPROM 5 Dummy.
 
#define EEPROM5_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  eeprom5_return_value_t { EEPROM5_OK = 0 , EEPROM5_ERROR = -1 }
 EEPROM 5 Click return value data. More...
 

Functions

void eeprom5_cfg_setup (eeprom5_cfg_t *cfg)
 EEPROM 5 configuration object setup function.
 
err_t eeprom5_init (eeprom5_t *ctx, eeprom5_cfg_t *cfg)
 EEPROM 5 initialization function.
 
void eeprom5_generic_write (eeprom5_t *ctx, uint32_t addr, uint8_t tx_data)
 EEPROM 5 data writing function.
 
uint8_t eeprom5_generic_read (eeprom5_t *ctx, uint32_t addr)
 EEPROM 5 data reading function.
 
void eeprom5_set_hold (eeprom5_t *ctx, uint8_t en_hold)
 Enable hold operation function.
 
void eeprom5_set_write_protect (eeprom5_t *ctx, uint8_t en_wr_prot)
 Enable write protect function.
 
void eeprom5_send_cmd (eeprom5_t *ctx, uint8_t cmd)
 Send command function.
 
void eeprom5_enable_memory_write (eeprom5_t *ctx, uint8_t en_wr_mem)
 Enable memory write function.
 
void eeprom5_get_status (eeprom5_t *ctx, status_data_t *stat_data)
 Get status function.
 
void eeprom5_set_status (eeprom5_t *ctx, status_data_t stat_data)
 Set status function.
 
void eeprom5_read_memory (eeprom5_t *ctx, uint32_t addr, uint8_t *p_rx_data, uint8_t n_bytes)
 Read EEPROM memory function.
 
void eeprom5_write_memory (eeprom5_t *ctx, uint32_t addr, uint8_t *p_tx_data, uint8_t n_bytes)
 Write EEPROM memory function.
 
uint8_t eeprom5_read_ident_page (eeprom5_t *ctx, uint16_t addr)
 Read identification page function.
 
void eeprom5_write_ident_page (eeprom5_t *ctx, uint16_t addr, uint8_t ident_data)
 Write dentification page function.
 
uint8_t eeprom5_read_lock_status (eeprom5_t *ctx)
 Reads the identification page lock status function.
 
void eeprom5_lock_id (eeprom5_t *ctx, uint8_t lock_id)
 Lock ID function.
 

Detailed Description

This file contains API for EEPROM 5 Click Driver.

Enumeration Type Documentation

◆ eeprom5_return_value_t

EEPROM 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
EEPROM5_OK 
EEPROM5_ERROR