usbuartiso 2.1.0.0
usbuartiso.h File Reference

This file contains API for USB UART ISO Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  usbuartiso_t
 USB UART ISO Click context object. More...
 
struct  usbuartiso_cfg_t
 USB UART ISO Click configuration object. More...
 

Macros

#define USBUARTISO_TX_DRV_BUFFER_SIZE   100
 USB UART ISO driver buffer size.
 
#define USBUARTISO_RX_DRV_BUFFER_SIZE   300
 
#define USBUARTISO_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  usbuartiso_return_value_t { USBUARTISO_OK = 0 , USBUARTISO_ERROR = -1 }
 USB UART ISO Click return value data. More...
 

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.
 

Detailed Description

This file contains API for USB UART ISO Click Driver.

Enumeration Type Documentation

◆ usbuartiso_return_value_t

USB UART ISO Click return value data.

Predefined enum values for driver return values.

Enumerator
USBUARTISO_OK 
USBUARTISO_ERROR