uartmux  2.0.0.0
Functions
Public function

Functions

void uartmux_cfg_setup (uartmux_cfg_t *cfg)
 Config Object Initialization function. More...
 
UARTMUX_RETVAL uartmux_init (uartmux_t *ctx, uartmux_cfg_t *cfg)
 Initialization function. More...
 
void uartmux_generic_write (uartmux_t *ctx, char *data_buf, uartmux_channel_t *channel)
 Generic write function. More...
 
int32_t uartmux_generic_read (uartmux_t *ctx, char *data_buf, uint16_t max_len, uartmux_channel_t *channel)
 Generic read function. More...
 
void uartmux_send_command (uartmux_t *ctx, char *command, uartmux_channel_t *channel)
 Send command. More...
 
void uartmux_set_inhibit_communication (uartmux_t *ctx, uint8_t state)
 Set INT pin. More...
 
void uartmux_choose_channel (uartmux_t *ctx, uartmux_channel_t *channel)
 Choose channel. More...
 

Detailed Description

Function Documentation

◆ uartmux_cfg_setup()

void uartmux_cfg_setup ( uartmux_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ uartmux_choose_channel()

void uartmux_choose_channel ( uartmux_t ctx,
uartmux_channel_t channel 
)

Choose channel.

Parameters
uartmuxClick object.
channelStruct of channel ( 1, 2, 3, 4 )

◆ uartmux_generic_read()

int32_t uartmux_generic_read ( uartmux_t ctx,
char *  data_buf,
uint16_t  max_len,
uartmux_channel_t channel 
)

Generic read function.

Parameters
uartmuxClick object.
data_bufData buffer for read data.
max_lenThe maximum length of data that can be read.
channelStruct of channel ( 1, 2, 3, 4 )
Returns
Number of reads data.

◆ uartmux_generic_write()

void uartmux_generic_write ( uartmux_t ctx,
char *  data_buf,
uartmux_channel_t channel 
)

Generic write function.

Parameters
uartmuxClick object.
data_bufData buffer for sends.
channelStruct of channel ( 1, 2, 3, 4 )

◆ uartmux_init()

UARTMUX_RETVAL uartmux_init ( uartmux_t ctx,
uartmux_cfg_t cfg 
)

Initialization function.

Parameters
uartmuxClick object.
cfgClick configuration structure.

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

◆ uartmux_send_command()

void uartmux_send_command ( uartmux_t ctx,
char *  command,
uartmux_channel_t channel 
)

Send command.

Parameters
uartmuxClick object.
commandData to be send.
channelStruct of channel ( 1, 2, 3, 4 )

◆ uartmux_set_inhibit_communication()

void uartmux_set_inhibit_communication ( uartmux_t ctx,
uint8_t  state 
)

Set INT pin.

Parameters
uartmuxClick object.
stateState of INT pin.