usbuart  2.0.0.0
Data Structures | Macros | Typedefs | Functions
usbuart.h File Reference

This file contains API for USB UART 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  usbuart_t
 Click ctx object definition. More...
 
struct  usbuart_cfg_t
 Click configuration structure definition. More...
 

Macros

#define USBUART_MAP_MIKROBUS(cfg, mikrobus)
 
#define USBUART_RETVAL   uint8_t
 
#define USBUART_OK   0x00
 
#define USBUART_INIT_ERROR   0xFF
 
#define DRV_RX_BUFFER_SIZE   500
 
#define USBUART_POWER_ON   1
 
#define USBUART_POWER_OFF   0
 
#define USBUART_CTS_ACTIVE   1
 
#define USBUART_CTS_NO_ACTIVE   0
 
#define USBUART_MODE_SLEEP   1
 
#define USBUART_MODE_NORMAL   0
 

Typedefs

typedef uint8_t usbuart_error_t
 Error type. More...
 

Functions

void usbuart_cfg_setup (usbuart_cfg_t *cfg)
 Config Object Initialization function. More...
 
USBUART_RETVAL usbuart_init (usbuart_t *ctx, usbuart_cfg_t *cfg)
 Initialization function. More...
 
void usbuart_generic_write (usbuart_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int32_t usbuart_generic_read (usbuart_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
void usbuart_pwr_ctrl (usbuart_t *ctx, uint8_t state)
 Power control. More...
 
void usbuart_set_cts (usbuart_t *ctx, uint8_t state)
 Set CTS (Clear to send) More...
 
void usbuart_set_mode (usbuart_t *ctx, uint8_t mode)
 Set device mode. More...
 
uint8_t usbuart_get_rts (usbuart_t *ctx)
 Set device mode. More...
 
void usbuart_send_command (usbuart_t *ctx, char *command)
 Function for send command. More...
 

Detailed Description

This file contains API for USB UART Click driver.