uart_device.h

Go to the documentation of this file.

 
#ifndef __UART_DEVICE_H__
#define __UART_DEVICE_H__
 
#include "driver/uart.h"
#include "pal_err.h"
#include "pal_log.h"
#include "freertos/task.h"


#define DEFAULT_TX              (23)     
#define DEFAULT_RX              (22)     
#define DEFAULT_CTS             (20)     
#define DEFAULT_RTS             (21)     
#define DEFAULT_BAUDRATE        (115200) 
#define DEFAULT_BUF_SIZE        (2028)   
#define DEFAULT_CTRL_TRESH      (122)    
#define DEFAULT_EVT_QUEUE_SIZE  (10)     
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    const char *const TAG;   
    uart_port_t port;        
    uint32_t baudrate;       
 
    uint8_t tx_pin;          
    uint8_t rx_pin;          
    uint8_t rts_pin;         
    uint8_t cts_pin;         
 
    bool flow_ctrl;          
 
    size_t evt_queue_size;   
    size_t rx_buf_size;      
    size_t tx_buf_size;      
} uartd_config_t;

typedef struct uartd uartd_t;
    
typedef uartd_t* uartd_handle_t;

uartd_handle_t uartd_init(uartd_config_t* restrict cfg);

pal_err_t uartd_deinit(uartd_handle_t restrict dev);

uartd_config_t uartd_default_config(void);

pal_err_t uartd_wait_event(
    const uartd_handle_t dev,
    uart_event_t *event,
    TickType_t timeout
);

pal_err_t uartd_read(
    const uartd_handle_t restrict dev,
    void *restrict buf,
    size_t sz,
    size_t len,
    TickType_t timeout,
    size_t *out_bytes
);

pal_err_t uartd_write(
    const uartd_handle_t restrict dev,
    const void *const restrict buf,
    size_t sz,
    size_t len,
    size_t *out_bytes
);

pal_err_t uartd_readline(
    const uartd_handle_t restrict dev,
    char *restrict line,
    size_t max_len,
    TickType_t timeout,
    size_t *out_len
);

pal_err_t uartd_writeline(
    const uartd_handle_t restrict dev,
    const char *const restrict line,
    size_t *out_len
);
 
#ifdef __cplusplus
}
#endif
 // end of uart_device group
 
#endif // __UART_DEVICE_H__