eeram2.h File Reference

This file contains API for EERAM 2 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	eeram2_t
	Click ctx object definition. More...
struct	eeram2_cfg_t
	Click configuration structure definition. More...

Macros
#define	EERAM2_MAP_MIKROBUS(cfg, mikrobus)
#define	EERAM2_RETVAL   uint8_t
#define	EERAM2_OK   0x00
#define	EERAM2_INIT_ERROR   0xFF
#define	EERAM2_CMD_WREN   0x06
#define	EERAM2_CMD_WRDI   0x04
#define	EERAM2_CMD_WRITE   0x02
#define	EERAM2_CMD_READ   0x03
#define	EERAM2_CMD_SECURE_WRITE   0x12
#define	EERAM2_CMD_SECURE_READ   0x13
#define	EERAM2_CMD_WRSR   0x01
#define	EERAM2_CMD_RDSR   0x05
#define	EERAM2_CMD_STORE   0x08
#define	EERAM2_CMD_RECALL   0x09
#define	EERAM2_CMD_WRNUR   0xC2
#define	EERAM2_CMD_RDNUR   0xC3
#define	EERAM2_CMD_HIBERNATE   0xB9
#define	EERAM2_HOLD_DISABLE   0x00
#define	EERAM2_HOLD_ENABLE   0x01
#define	EERAM2_WRITE_DISABLE   0x00
#define	EERAM2_WRITE_ENABLE   0x01
#define	EERAM2_STATUS_ASE_ENABLE   0x00
#define	EERAM2_STATUS_ASE_DISABLE   0x40
#define	EERAM2_STATUS_BP_LVL_0   0x00
#define	EERAM2_STATUS_BP_LVL_1   0x04
#define	EERAM2_STATUS_BP_LVL_2   0x08
#define	EERAM2_STATUS_BP_LVL_3   0x0C
#define	EERAM2_ERROR   0x00
#define	EERAM2_SUCCESS   0x01
#define	EERAM2_SRAM_ADDR_FIRST   0x00000000
#define	EERAM2_SRAM_ADDR_LAST   0x00FFFFFF

Functions
void	eeram2_cfg_setup (eeram2_cfg_t *cfg)
	Config Object Initialization function.
EERAM2_RETVAL	eeram2_init (eeram2_t *ctx, eeram2_cfg_t *cfg)
	Initialization function.
void	eeram2_generic_transfer (eeram2_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
	Generic transfer function.
void	eeram2_set_on_hold_status (eeram2_t *ctx, uint8_t en_hold)
	Set On-hold status function.
void	eeram2_set_command (eeram2_t *ctx, uint8_t command)
	Set command function.
void	eeram2_set_write_status (eeram2_t *ctx, uint8_t en_write)
	Set write status function.
void	eeram2_set_status (eeram2_t *ctx, uint8_t tx_data)
	Set status register function.
uint8_t	eeram2_get_status (eeram2_t *ctx)
	Read status register function.
uint8_t	eeram2_write_byte (eeram2_t *ctx, uint32_t reg, uint8_t tx_data)
	Write the data byte into SRAM function.
uint8_t	eeram2_read_byte (eeram2_t *ctx, uint32_t reg)
	Read the data byte from SRAM function.
uint8_t	eeram2_write_continuous (eeram2_t *ctx, uint32_t reg, uint8_t *p_tx_data, uint8_t n_bytes)
	Continuous write the data into SRAM function.
uint8_t	eeram2_read_continuous (eeram2_t *ctx, uint32_t reg, uint8_t *p_rx_data, uint8_t n_bytes)
	Continuous read the data into SRAM function.
uint8_t	eeram2_read_nonvolatile (eeram2_t *ctx, uint8_t *p_rx_data)
	Nonvolatile user space write function.
uint8_t	eeram2_write_nonvolatile (eeram2_t *ctx, uint8_t *p_tx_data)
	Nonvolatile user space read function.
uint8_t	eeram2_secure_write (eeram2_t *ctx, uint16_t reg, uint8_t *p_tx_data)
	Secure SRAM write function.
uint8_t	eeram2_secure_read (eeram2_t *ctx, uint16_t reg, uint8_t *p_rx_data)
	Secure SRAM read function.

Detailed Description

This file contains API for EERAM 2 Click driver.