canfd3 2.0.0.0
Public function

Functions

void canfd3_cfg_setup (canfd3_cfg_t *cfg)
 Config Object Initialization function.
 
CANFD3_RETVAL canfd3_init (canfd3_t *ctx, canfd3_cfg_t *cfg)
 Initialization function.
 
void canfd3_generic_write (canfd3_t *ctx, char *data_buf, uint16_t len)
 Generic write function.
 
int32_t canfd3_generic_read (canfd3_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function.
 
void canfd3_set_cs_pin (canfd3_t *ctx, uint8_t mode)
 Sets the CS pin state.
 

Detailed Description

Function Documentation

◆ canfd3_cfg_setup()

void canfd3_cfg_setup ( canfd3_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.

◆ canfd3_generic_read()

int32_t canfd3_generic_read ( canfd3_t * ctx,
char * data_buf,
uint16_t max_len )

Generic read function.

Parameters
canfd3Click object.
data_bufData buffer for read data.
max_lenThe maximum length of data that can be read.
Returns
Number of reads data.

◆ canfd3_generic_write()

void canfd3_generic_write ( canfd3_t * ctx,
char * data_buf,
uint16_t len )

Generic write function.

Parameters
canfd3Click object.
data_bufData buffer for sends.
lenNumber of bytes for sends.

◆ canfd3_init()

CANFD3_RETVAL canfd3_init ( canfd3_t * ctx,
canfd3_cfg_t * cfg )

Initialization function.

Parameters
canfd3Click object.
cfgClick configuration structure.

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

◆ canfd3_set_cs_pin()

void canfd3_set_cs_pin ( canfd3_t * ctx,
uint8_t mode )

Sets the CS pin state.

Parameters
modemode of the pin