usbuartiso 2.1.0.0
|
API for configuring and manipulating USB UART ISO Click driver. More...
Topics | |
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. | |
err_t | usbuartiso_init (usbuartiso_t *ctx, usbuartiso_cfg_t *cfg) |
USB UART ISO initialization function. | |
void | usbuartiso_default_cfg (usbuartiso_t *ctx) |
USB UART ISO default configuration function. | |
err_t | usbuartiso_generic_write (usbuartiso_t *ctx, uint8_t *data_in, uint16_t len) |
USB UART ISO data writing function. | |
err_t | usbuartiso_generic_read (usbuartiso_t *ctx, uint8_t *data_out, uint16_t len) |
USB UART ISO data reading function. | |
void | usbuartiso_power_on (usbuartiso_t *ctx) |
USB UART ISO power on function. | |
void | usbuartiso_power_off (usbuartiso_t *ctx) |
USB UART ISO power off function. | |
uint8_t | usbuartiso_get_slp_ind (usbuartiso_t *ctx) |
USB UART ISO sleep indicator function. | |
uint8_t | usbuartiso_request_to_send (usbuartiso_t *ctx) |
USB UART ISO request to send function. | |
void | usbuartiso_clear_to_send (usbuartiso_t *ctx, uint8_t cts) |
USB UART ISO clear to send function. | |
API for configuring and manipulating USB UART ISO Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void usbuartiso_cfg_setup | ( | usbuartiso_cfg_t * | cfg | ) |
USB UART ISO configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See usbuartiso_cfg_t object definition for detailed explanation. |
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™.
[in] | ctx | : Click context object. See usbuartiso_t object definition for detailed explanation. |
[in] | cts | : Clear to send state. |
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.
[in] | ctx | : Click context object. See usbuartiso_t object definition for detailed explanation. |
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.
[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. |
>0
- Number of data bytes read, <=0
- Error/Empty Ring buffer. See #err_t definition for detailed explanation. 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.
[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. |
>=0
- Success, <0
- Error. See #err_t definition for detailed explanation. 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™.
[in] | ctx | : Click context object. See usbuartiso_t object definition for detailed explanation. |
0
- USB suspend mode, 1
- USB operating mode. 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.
[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. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. 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™.
[in] | ctx | : Click context object. See usbuartiso_t object definition for detailed explanation. |
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™.
[in] | ctx | : Click context object. See usbuartiso_t object definition for detailed explanation. |
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™.
[in] | ctx | : Click context object. See usbuartiso_t object definition for detailed explanation. |