usbuartiso  2.1.0.0
Modules | Functions
USB-UART ISO Click Driver

API for configuring and manipulating USB-UART ISO Click driver. More...

Modules

 USB-UART ISO Device Settings
 Settings for registers of USB-UART ISO Click driver.
 
 USB-UART ISO MikroBUS Map
 MikroBUS pin mapping of USB-UART ISO Click driver.
 

Functions

void usbuartiso_cfg_setup (usbuartiso_cfg_t *cfg)
 USB-UART ISO configuration object setup function. More...
 
err_t usbuartiso_init (usbuartiso_t *ctx, usbuartiso_cfg_t *cfg)
 USB-UART ISO initialization function. More...
 
void usbuartiso_default_cfg (usbuartiso_t *ctx)
 USB-UART ISO default configuration function. More...
 
err_t usbuartiso_generic_write (usbuartiso_t *ctx, uint8_t *data_in, uint16_t len)
 USB-UART ISO data writing function. More...
 
err_t usbuartiso_generic_read (usbuartiso_t *ctx, uint8_t *data_out, uint16_t len)
 USB-UART ISO data reading function. More...
 
void usbuartiso_power_on (usbuartiso_t *ctx)
 USB-UART ISO power on function. More...
 
void usbuartiso_power_off (usbuartiso_t *ctx)
 USB-UART ISO power off function. More...
 
uint8_t usbuartiso_get_slp_ind (usbuartiso_t *ctx)
 USB-UART ISO sleep indicator function. More...
 
uint8_t usbuartiso_request_to_send (usbuartiso_t *ctx)
 USB-UART ISO request to send function. More...
 
void usbuartiso_clear_to_send (usbuartiso_t *ctx, uint8_t cts)
 USB-UART ISO clear to send function. More...
 

Detailed Description

API for configuring and manipulating USB-UART ISO Click driver.

Function Documentation

◆ usbuartiso_cfg_setup()

void usbuartiso_cfg_setup ( usbuartiso_cfg_t cfg)

USB-UART ISO configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See usbuartiso_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ usbuartiso_clear_to_send()

void usbuartiso_clear_to_send ( usbuartiso_t ctx,
uint8_t  cts 
)

USB-UART ISO clear to send function.

This function is flow control and uses to sets the clear to send state of the USB-UART ISO click board™.

Parameters
[in]ctx: Click context object. See usbuartiso_t object definition for detailed explanation.
[in]cts: Clear to send state.
Returns
Nothing.
Note
None.

◆ usbuartiso_default_cfg()

void usbuartiso_default_cfg ( usbuartiso_t ctx)

USB-UART ISO default configuration function.

This function executes a default configuration of USB-UART ISO click board.

Parameters
[in]ctx: Click context object. See usbuartiso_t object definition for detailed explanation.
Returns
Nothing.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ usbuartiso_generic_read()

err_t usbuartiso_generic_read ( usbuartiso_t ctx,
uint8_t *  data_out,
uint16_t  len 
)

USB-UART ISO data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See usbuartiso_t object definition for detailed explanation.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • >0 - Number of data bytes read,
  • <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.
Note
None.

◆ usbuartiso_generic_write()

err_t usbuartiso_generic_write ( usbuartiso_t ctx,
uint8_t *  data_in,
uint16_t  len 
)

USB-UART ISO data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See usbuartiso_t object definition for detailed explanation.
[in]data_in: Data buffer for sending.
[in]len: Number of bytes for sending.
Returns
  • >=0 - Success,
  • <0 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ usbuartiso_get_slp_ind()

uint8_t usbuartiso_get_slp_ind ( usbuartiso_t ctx)

USB-UART ISO sleep indicator function.

This function indicates that the device going into USB suspend mode of the FT232RL, USB Full Speed to Serial UART IC on the USB-UART ISO click board™.

Parameters
[in]ctx: Click context object. See usbuartiso_t object definition for detailed explanation.
Returns
  • 0 - USB suspend mode,
  • 1 - USB operating mode.
Note
None.

◆ usbuartiso_init()

err_t usbuartiso_init ( usbuartiso_t ctx,
usbuartiso_cfg_t cfg 
)

USB-UART ISO initialization function.

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

Parameters
[out]ctx: Click context object. See usbuartiso_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See usbuartiso_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ usbuartiso_power_off()

void usbuartiso_power_off ( usbuartiso_t ctx)

USB-UART ISO power off function.

This function performs a power off of the FT232RL, USB Full Speed to Serial UART IC on the USB-UART ISO click board™.

Parameters
[in]ctx: Click context object. See usbuartiso_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ usbuartiso_power_on()

void usbuartiso_power_on ( usbuartiso_t ctx)

USB-UART ISO power on function.

This function performs a power on of the FT232RL, USB Full Speed to Serial UART IC on the USB-UART ISO click board™.

Parameters
[in]ctx: Click context object. See usbuartiso_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ usbuartiso_request_to_send()

uint8_t usbuartiso_request_to_send ( usbuartiso_t ctx)

USB-UART ISO request to send function.

This function is flow control and uses to get requests to send status of the USB-UART ISO click board™.

Parameters
[in]ctx: Click context object. See usbuartiso_t object definition for detailed explanation.
Returns
Status of the request to send.
Note
None.