uart.h

Go to the documentation of this file.

#pragma once
#include "gpio.h"
#include <picofuse/sys/io.h>
#include <stdbool.h>
#include <stdint.h>

// TYPES

typedef enum {
  hw_uart_data_bits_5 = 5,
  hw_uart_data_bits_6 = 6,
  hw_uart_data_bits_7 = 7,
  hw_uart_data_bits_8 = 8,
} hw_uart_data_bits_t;

typedef enum {
  hw_uart_stop_bits_1 = 1,
  hw_uart_stop_bits_2 = 2,
} hw_uart_stop_bits_t;

typedef enum {
  hw_uart_parity_none,
  hw_uart_parity_even,
  hw_uart_parity_odd,
} hw_uart_parity_t;

typedef enum {
  hw_uart_flow_control_none,
  hw_uart_flow_control_cts,
  hw_uart_flow_control_rts,
  hw_uart_flow_control_cts_rts,
} hw_uart_flow_control_t;

typedef struct {
  const hw_gpio_t *cts_pin; 
  const hw_gpio_t *rts_pin; 
  hw_uart_data_bits_t data_bits; 
  hw_uart_stop_bits_t stop_bits; 
  hw_uart_parity_t parity; 
  hw_uart_flow_control_t flow_control; 
  bool unbuffered; 
} hw_uart_config_t;

// LIFECYCLE

sys_iostream_t *hw_uart_init(const hw_gpio_t *rx_pin, const hw_gpio_t *tx_pin,
                             uint32_t baud_rate,
                             const hw_uart_config_t *config);

sys_iostream_t *hw_uart_init_device(const char *device, uint32_t baud_rate,
                                    const hw_uart_config_t *config);

// METHODS

bool hw_uart_flush(sys_iostream_t *uart, uint32_t timeout_ms);