usbuart3  2.0.0.0
Functions

Functions

void usbuart3_cfg_setup (usbuart3_cfg_t *cfg)
 Config Object Initialization function. More...
 
USBUART3_RETVAL usbuart3_init (usbuart3_t *ctx, usbuart3_cfg_t *cfg)
 Initialization function. More...
 
void usbuart3_generic_write (usbuart3_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int32_t usbuart3_generic_read (usbuart3_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
void usbuart3_reset (usbuart3_t *ctx)
 Function for reset. More...
 
uint8_t usbuart3_get_susp (usbuart3_t *ctx)
 Set device mode. More...
 

Detailed Description

Function Documentation

◆ usbuart3_cfg_setup()

void usbuart3_cfg_setup ( usbuart3_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.

◆ usbuart3_generic_read()

int32_t usbuart3_generic_read ( usbuart3_t ctx,
char *  data_buf,
uint16_t  max_len 
)

Generic read function.

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

◆ usbuart3_generic_write()

void usbuart3_generic_write ( usbuart3_t ctx,
char *  data_buf,
uint16_t  len 
)

Generic write function.

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

◆ usbuart3_get_susp()

uint8_t usbuart3_get_susp ( usbuart3_t ctx)

Set device mode.

Parameters
ctxClick object.
Returns
SUS (USB suspend) pin state

◆ usbuart3_init()

USBUART3_RETVAL usbuart3_init ( usbuart3_t ctx,
usbuart3_cfg_t cfg 
)

Initialization function.

Parameters
usbuart3Click object.
cfgClick configuration structure.

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

◆ usbuart3_reset()

void usbuart3_reset ( usbuart3_t ctx)

Function for reset.

Parameters
ctxClick object.

@description This function is reset