excelonlp 2.0.0.0
excelonlp.h File Reference

This file contains API for Excelon LP Click driver. More...

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

Go to the source code of this file.

Data Structures

struct  excelonlp_t
 Click ctx object definition. More...
 
struct  excelonlp_cfg_t
 Click configuration structure definition. More...
 

Macros

#define EXCELONLP_MAP_MIKROBUS(cfg, mikrobus)
 
#define EXCELONLP_RETVAL   uint8_t
 
#define EXCELONLP_OK   0x00
 
#define EXCELONLP_INIT_ERROR   0xFF
 
#define EXCELONLP_OPCODE_SET_WRITE_ENABLE_LATCH   0x06
 
#define EXCELONLP_OPCODE_RESET_WRITE_ENABLE_LATCH   0x04
 
#define EXCELONLP_OPCODE_READ_STATUS_REGISTER   0x05
 
#define EXCELONLP_OPCODE_WRITE_STATUS_REGISTER   0x01
 
#define EXCELONLP_OPCODE_WRITE_MEMORY_DATA   0x02
 
#define EXCELONLP_OPCODE_READ_MEMORY_DATA   0x03
 
#define EXCELONLP_OPCODE_FAST_READ_MEMORY_DATA   0x0B
 
#define EXCELONLP_OPCODE_SPECIAL_SECTOR_WRITE   0x42
 
#define EXCELONLP_OPCODE_SPECIAL_SECTOR_READ   0x4B
 
#define EXCELONLP_OPCODE_READ_DEVICE_ID   0x9F
 
#define EXCELONLP_OPCODE_READ_UNIQUE_ID   0x4C
 
#define EXCELONLP_OPCODE_WRITE_SERIAL_NUMBER   0xC2
 
#define EXCELONLP_OPCODE_READ_SERIAL_NUMBER   0xC3
 
#define EXCELONLP_OPCODE_ENTER_DEEP_POWER_DOWN   0xBA
 
#define EXCELONLP_OPCODE_Enter_Hibernate_Mode   0xB9
 

Functions

void excelonlp_cfg_setup (excelonlp_cfg_t *cfg)
 Config Object Initialization function.
 
EXCELONLP_RETVAL excelonlp_init (excelonlp_t *ctx, excelonlp_cfg_t *cfg)
 Initialization function.
 
void excelonlp_generic_transfer (excelonlp_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function.
 
void excelonlp_send_command (excelonlp_t *ctx, uint8_t opcode)
 Functions for send opcode command.
 
void excelonlp_read_data (excelonlp_t *ctx, uint8_t opcode, uint8_t *out_buf, uint8_t n_data)
 Functions for read data.
 
void excelonlp_write_memory_data (excelonlp_t *ctx, uint8_t opcode, uint32_t addr, uint8_t c_data)
 Functions for write data to memory.
 
uint8_t excelonlp_read_memory_data (excelonlp_t *ctx, uint8_t opcode, uint32_t addr)
 Functions for read data form memory.
 

Detailed Description

This file contains API for Excelon LP Click driver.