canfd4  2.0.0.0
Functions
Public function

Functions

void canfd4_cfg_setup (canfd4_cfg_t *cfg)
 Config Object Initialization function. More...
 
CANFD4_RETVAL canfd4_init (canfd4_t *ctx, canfd4_cfg_t *cfg)
 Initialization function. More...
 
void canfd4_generic_write (canfd4_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int32_t canfd4_generic_read (canfd4_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
void canfd4_set_dev_mode (canfd4_t *ctx, uint8_t mode)
 Set mode function. More...
 

Detailed Description

Function Documentation

◆ canfd4_cfg_setup()

void canfd4_cfg_setup ( canfd4_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.

◆ canfd4_generic_read()

int32_t canfd4_generic_read ( canfd4_t ctx,
char *  data_buf,
uint16_t  max_len 
)

Generic read function.

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

◆ canfd4_generic_write()

void canfd4_generic_write ( canfd4_t ctx,
char *  data_buf,
uint16_t  len 
)

Generic write function.

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

◆ canfd4_init()

CANFD4_RETVAL canfd4_init ( canfd4_t ctx,
canfd4_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ canfd4_set_dev_mode()

void canfd4_set_dev_mode ( canfd4_t ctx,
uint8_t  mode 
)

Set mode function.

Parameters
ctxClick object.
modeMode selection.