swieeprom 2.1.0.0
swieeprom.h File Reference

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

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

Go to the source code of this file.

Data Structures

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

Macros

#define SWIEEPROM_OP_CODE_EEPROM   0xA0
 
#define SWIEEPROM_OP_CODE_SECURITY   0xB0
 
#define SWIEEPROM_OP_CODE_LOCK   0x20
 
#define SWIEEPROM_OP_CODE_ROM   0x70
 
#define SWIEEPROM_OP_CODE_FREEZE_ROM   0x10
 
#define SWIEEPROM_OP_CODE_ID   0xC0
 
#define SWIEEPROM_OP_CODE_STDN_SPEED   0xD0
 
#define SWIEEPROM_OP_CODE_HIGH_SPEED   0xE0
 
#define SWIEEPROM_DEVICE_ID   0x00D200
 SWI EEPROM device ID setting.
 

Typedefs

typedef err_t(* drv_reset_t) (void)
 Function pointers for gpio settings.
 
typedef void(* drv_set_t) (void)
 
typedef uint8_t(* drv_get_t) (void)
 

Enumerations

enum  swieeprom_return_value_t { SWIEEPROM_OK = 0 , SWIEEPROM_ERROR = -1 }
 SWI EEPROM Click return value data. More...
 

Functions

err_t swieeprom_init (swieeprom_t *ctx)
 SWI EEPROM initialization function.
 
err_t swieeprom_check_communication (swieeprom_t *ctx)
 SWI EEPROM check communication function.
 
err_t swieeprom_mem_write (swieeprom_t *ctx, uint8_t start_addr, uint8_t data_in)
 SWI EEPROM memory write function.
 
err_t swieeprom_mem_write_page (swieeprom_t *ctx, uint8_t start_addr, uint8_t *data_in, uint8_t len)
 SWI EEPROM memory write page function.
 
err_t swieeprom_mem_read (swieeprom_t *ctx, uint8_t start_addr, uint8_t *data_out, uint8_t len)
 SWI EEPROM memory read function.
 
err_t swieeprom_mem_clear (swieeprom_t *ctx)
 SWI EEPROM memory clear function.
 

Detailed Description

This file contains API for SWI EEPROM Click Driver.

Typedef Documentation

◆ drv_get_t

typedef uint8_t(* drv_get_t) (void)

◆ drv_reset_t

typedef err_t(* drv_reset_t) (void)

Function pointers for gpio settings.

Function pointers for gpio settings of SWI EEPROM Click driver.

◆ drv_set_t

typedef void(* drv_set_t) (void)

Enumeration Type Documentation

◆ swieeprom_return_value_t

SWI EEPROM Click return value data.

Predefined enum values for driver return values.

Enumerator
SWIEEPROM_OK 
SWIEEPROM_ERROR