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

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

Data Structures
struct	usbuart5_t
	USB UART 5 Click context object. More...

struct	usbuart5_cfg_t
	USB UART 5 Click configuration object. More...

Macros
#define	USBUART5_SUSPEND_MODE_DISABLE 0
	USB UART 5 config suspend mode values.

#define	USBUART5_SUSPEND_MODE_ENABLE 1

#define	USBUART5_TX_DRV_BUFFER_SIZE 100
	USB UART 5 driver buffer size.

#define	USBUART5_RX_DRV_BUFFER_SIZE 300

#define	USBUART5_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	usbuart5_return_value_t { USBUART5_OK = 0 , USBUART5_ERROR = -1 }
	USB UART 5 Click return value data. More...

enum	usbuart5_pin_state_t { USBUART5_PIN_STATE_LOW = 0 , USBUART5_PIN_STATE_HIGH = 1 }
	USB UART 5 Click pin state. More...

Functions
void	usbuart5_cfg_setup (usbuart5_cfg_t *cfg)
	USB UART 5 configuration object setup function.

err_t	usbuart5_init (usbuart5_t ctx, usbuart5_cfg_t cfg)
	USB UART 5 initialization function.

void	usbuart5_default_cfg (usbuart5_t *ctx)
	USB UART 5 default configuration function.

err_t	usbuart5_generic_write (usbuart5_t ctx, char data_in, uint16_t len)
	USB UART 5 data writing function.

err_t	usbuart5_generic_read (usbuart5_t ctx, char data_out, uint16_t len)
	USB UART 5 data reading function.

void	usbuart5_enable_device (usbuart5_t *ctx)
	USB UART 5 enable the device function.

void	usbuart5_reset_device (usbuart5_t *ctx)
	USB UART 5 reset the device function.

void	usbuart5_set_cts_pin (usbuart5_t *ctx, usbuart5_pin_state_t state)
	USB UART 5 set cts pin state function.

uint8_t	usbuart5_get_suspend_state (usbuart5_t *ctx)
	USB UART 5 get USB Suspend state function.

uint8_t	usbuart5_get_rts_pin (usbuart5_t *ctx)
	USB UART 5 get rts pin state function.

Detailed Description

This file contains API for USB UART 5 Click Driver.

Enumeration Type Documentation

USB UART 5 Click pin state.

Predefined enum values for pin stat.

Enumerator
USBUART5_PIN_STATE_LOW
USBUART5_PIN_STATE_HIGH

USB UART 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
USBUART5_OK
USBUART5_ERROR