uart.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2014-2015 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <errno.h>
#include <limits.h>
#include <stddef.h>
#include <stdint.h>
 
#include "periph_cpu.h"
#include "periph_conf.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#ifndef CONFIG_UART_DMA_THRESHOLD_BYTES
#define CONFIG_UART_DMA_THRESHOLD_BYTES 8
#endif

#ifndef HAVE_UART_T
typedef uint_fast8_t uart_t;
#endif

#ifndef UART_UNDEF
#define UART_UNDEF          (UINT_FAST8_MAX)
#endif

#ifndef UART_DEV
#define UART_DEV(x)         (x)
#endif

typedef void(*uart_rx_cb_t)(void *arg, uint8_t data);

typedef void(*uart_rxstart_cb_t)(void *arg);

#ifndef HAVE_UART_ISR_CTX_T
typedef struct {
    uart_rx_cb_t rx_cb;     
    void *arg;              
#ifdef MODULE_PERIPH_UART_RXSTART_IRQ
    uart_rxstart_cb_t rxs_cb;   
    void *rxs_arg;          
#endif
} uart_isr_ctx_t;
#endif

enum {
    UART_OK         =  0,           
    UART_NODEV      = -ENODEV,      
    UART_NOBAUD     = -ENOTSUP,     
    UART_NOMODE     = -ENOTSUP,     
    UART_INTERR     = -EIO,         
};

#ifndef HAVE_UART_PARITY_T
typedef enum {
   UART_PARITY_NONE,   
   UART_PARITY_EVEN,   
   UART_PARITY_ODD,    
   UART_PARITY_MARK,   
   UART_PARITY_SPACE   
} uart_parity_t;
#endif

#ifndef HAVE_UART_DATA_BITS_T
typedef enum {
    UART_DATA_BITS_5,   
    UART_DATA_BITS_6,   
    UART_DATA_BITS_7,   
    UART_DATA_BITS_8,   
} uart_data_bits_t;
#endif

#ifndef HAVE_UART_STOP_BITS_T
typedef enum {
   UART_STOP_BITS_1,   
   UART_STOP_BITS_2,   
} uart_stop_bits_t;
#endif

int uart_init(uart_t uart, uint32_t baud, uart_rx_cb_t rx_cb, void *arg);
 
#if defined(MODULE_PERIPH_UART_RECONFIGURE) || DOXYGEN
void uart_deinit_pins(uart_t uart);

void uart_init_pins(uart_t uart);
 
#if DOXYGEN
gpio_t uart_pin_rx(uart_t uart);

gpio_t uart_pin_tx(uart_t uart);
 
#endif /* DOXYGEN */

gpio_t uart_pin_cts(uart_t uart);

gpio_t uart_pin_rts(uart_t uart);
 
#endif /* MODULE_PERIPH_UART_RECONFIGURE */
 
#if defined(MODULE_PERIPH_UART_RXSTART_IRQ) || DOXYGEN

void uart_rxstart_irq_configure(uart_t uart, uart_rxstart_cb_t cb, void *arg);

void uart_rxstart_irq_enable(uart_t uart);

void uart_rxstart_irq_disable(uart_t uart);
#endif /* MODULE_PERIPH_UART_RXSTART_IRQ */
 
#if defined(MODULE_PERIPH_UART_COLLISION) || DOXYGEN
void uart_collision_detect_enable(uart_t uart);
void uart_collision_detect_disable(uart_t uart);

bool uart_collision_detected(uart_t uart);
#endif /* MODULE_PERIPH_UART_COLLISION */

int uart_mode(uart_t uart, uart_data_bits_t data_bits, uart_parity_t parity,
              uart_stop_bits_t stop_bits);

void uart_write(uart_t uart, const uint8_t *data, size_t len);

void uart_poweron(uart_t uart);

void uart_poweroff(uart_t uart);

void uart_enable_tx(uart_t uart);

void uart_disable_tx(uart_t uart);
 
#ifdef __cplusplus
}
#endif