excelonlp  2.0.0.0
Functions

Functions

void excelonlp_cfg_setup (excelonlp_cfg_t *cfg)
 Config Object Initialization function. More...
 
EXCELONLP_RETVAL excelonlp_init (excelonlp_t *ctx, excelonlp_cfg_t *cfg)
 Initialization function. More...
 
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. More...
 
void excelonlp_send_command (excelonlp_t *ctx, uint8_t opcode)
 Functions for send opcode command. More...
 
void excelonlp_read_data (excelonlp_t *ctx, uint8_t opcode, uint8_t *out_buf, uint8_t n_data)
 Functions for read data. More...
 
void excelonlp_write_memory_data (excelonlp_t *ctx, uint8_t opcode, uint32_t addr, uint8_t c_data)
 Functions for write data to memory. More...
 
uint8_t excelonlp_read_memory_data (excelonlp_t *ctx, uint8_t opcode, uint32_t addr)
 Functions for read data form memory. More...
 

Detailed Description

Function Documentation

◆ excelonlp_cfg_setup()

void excelonlp_cfg_setup ( excelonlp_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ excelonlp_generic_transfer()

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.

Parameters
ctxClick object.
wr_bufWrite data buffer
wr_lenNumber of byte in write data buffer
rd_bufRead data buffer
rd_lenNumber of byte in read data buffer

@description Generic SPI transfer, for sending and receiving packages

◆ excelonlp_init()

EXCELONLP_RETVAL excelonlp_init ( excelonlp_t ctx,
excelonlp_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ excelonlp_read_data()

void excelonlp_read_data ( excelonlp_t ctx,
uint8_t  opcode,
uint8_t *  out_buf,
uint8_t  n_data 
)

Functions for read data.

Parameters
ctxClick object.
opcodeCommand to be sent
out_bufBuffer in which data will be storage
n_dataNumber of bytes to be read

◆ excelonlp_read_memory_data()

uint8_t excelonlp_read_memory_data ( excelonlp_t ctx,
uint8_t  opcode,
uint32_t  addr 
)

Functions for read data form memory.

Parameters
ctxClick object.
opcodeTransfer block structure.
addraddres in memmory

◆ excelonlp_send_command()

void excelonlp_send_command ( excelonlp_t ctx,
uint8_t  opcode 
)

Functions for send opcode command.

Parameters
ctxClick object.
opcodecommand to be sent

◆ excelonlp_write_memory_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.

Parameters
ctxClick object.
opcodeCommand to be sent
addraddres in memmory
c_dataData to be written