uart_half_duplex.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Inria
 *
 * This file is subject to the terms and conditions of the GNU Lesser General
 * Public License v2.1. See the file LICENSE in the top level directory for more
 * details.
 */
 
#pragma once
 
#include <stdlib.h>
 
#include "periph/uart.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef UART_HALF_DUPLEX_DEFAULT_TIMEOUT_US
#define UART_HALF_DUPLEX_DEFAULT_TIMEOUT_US (20000LU) 
#endif
 
typedef struct {
    void (*init)(uart_t);       
    void (*enable_tx)(uart_t);  
    void (*disable_tx)(uart_t); 
} uart_half_duplex_dir_t;
 
#define UART_HALF_DUPLEX_DIR_NONE { NULL, NULL, NULL }  
typedef struct {
    uart_t uart;                
    uint32_t baudrate;          
    uart_half_duplex_dir_t dir; 
} uart_half_duplex_params_t;
 
typedef struct {
    uint8_t *buffer;                  
    size_t size;                      
    size_t buffer_max_size;                     
    uint32_t timeout_us;              
    uart_half_duplex_params_t params; 
} uart_half_duplex_t;
 
enum {
    UART_HALF_DUPLEX_OK     = UART_OK,       
    UART_HALF_DUPLEX_NODEV  = UART_NODEV,    
    UART_HALF_DUPLEX_NOBAUD = UART_NOBAUD,   
    UART_HALF_DUPLEX_INTERR = UART_INTERR,   
    UART_HALF_DUPLEX_NOMODE = UART_NOMODE,   
    UART_HALF_DUPLEX_NOBUFF = -5             
};
 
int uart_half_duplex_init(uart_half_duplex_t *dev, uint8_t *buffer, size_t buffer_max_size, const uart_half_duplex_params_t *params);
 
static inline void uart_half_duplex_set_tx(uart_half_duplex_t *dev)
{
    dev->size = dev->buffer_max_size;
}
 
static inline void uart_half_duplex_set_rx(uart_half_duplex_t *dev)
{
    dev->size = 0;
}
 
size_t uart_half_duplex_send(const uart_half_duplex_t *dev, size_t size);
 
size_t uart_half_duplex_recv(const uart_half_duplex_t *dev, size_t size);
 
#ifdef __cplusplus
}
#endif