usbuart4  2.0.0.0
Data Structures | Macros | Enumerations | Functions
usbuart4.h File Reference

This file contains API for USB UART 4 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  usbuart4_t
 USB UART 4 Click context object. More...
 
struct  usbuart4_cfg_t
 USB UART 4 Click configuration object. More...
 

Macros

#define USBUART4_MODE_SLEEP   1
 USB UART 4 description setting. More...
 
#define USBUART4_MODE_NORMAL   0
 
#define USBUART4_CTS_ACTIVE   1
 
#define USBUART4_CTS_NO_ACTIVE   0
 
#define USBUART4_POWER_ON   1
 
#define USBUART4_POWER_OFF   0
 
#define DRV_BUFFER_SIZE   500
 USB UART 4 driver buffer size. More...
 
#define USBUART4_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  usbuart4_return_value_t { USBUART4_OK = 0, USBUART4_ERROR = -1 }
 USB UART 4 Click return value data. More...
 

Functions

void usbuart4_cfg_setup (usbuart4_cfg_t *cfg)
 USB UART 4 configuration object setup function. More...
 
err_t usbuart4_init (usbuart4_t *ctx, usbuart4_cfg_t *cfg)
 USB UART 4 initialization function. More...
 
void usbuart4_generic_write (usbuart4_t *ctx, char *data_buf, uint16_t len)
 USB UART 4 data writing function. More...
 
uint32_t usbuart4_generic_read (usbuart4_t *ctx, char *data_buf, uint16_t max_len)
 USB UART 4 data reading function. More...
 
void usbuart4_pwr_ctrl (usbuart4_t *ctx, uint8_t state)
 Power control. More...
 
void usbuart4_set_cts (usbuart4_t *ctx, uint8_t state)
 Set CTS (Clear to send) More...
 
void usbuart4_set_mode (usbuart4_t *ctx, uint8_t mode)
 Set device mode. More...
 
uint8_t usbuart4_get_rts (usbuart4_t *ctx)
 Set device mode. More...
 
void usbuart4_send_command (usbuart4_t *ctx, char *command)
 Function for send command. More...
 

Detailed Description

This file contains API for USB UART 4 Click Driver.

Enumeration Type Documentation

◆ usbuart4_return_value_t

USB UART 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
USBUART4_OK 
USBUART4_ERROR