mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
143 lines
3.1 KiB
C
143 lines
3.1 KiB
C
/*
|
|
* Copyright (C) 2018 Hamburg University of Applied Sciences
|
|
* 2020 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.
|
|
*/
|
|
|
|
/**
|
|
* @ingroup pkg_openwsn
|
|
* @{
|
|
*
|
|
* For details on the implementation check pkg/openwsn/doc.txt
|
|
*
|
|
* @file
|
|
* @brief RIOT adaption-specific definition of the "uart" bsp module.
|
|
*
|
|
* @author Thomas Watteyne <watteyne@eecs.berkeley.edu>, February 2012
|
|
* @author Peter Kietzmann <peter.kietzmann@haw-hamburg.de>, July 2018
|
|
* @author Francisco Molina <francois-xavier.molina@inria.fr>
|
|
*
|
|
* @}
|
|
*/
|
|
|
|
#ifndef OPENWSN_UART_H
|
|
#define OPENWSN_UART_H
|
|
|
|
#include "stdint.h"
|
|
#include "board.h"
|
|
#include "periph_conf.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief UART device to use for STDIO
|
|
*
|
|
* Dont want to include the stdio header, so redefine the default value
|
|
*
|
|
*/
|
|
#ifndef STDIO_UART_DEV
|
|
#define STDIO_UART_DEV (UART_DEV(0))
|
|
#endif
|
|
/**
|
|
* @brief OpenWSN default uart dev.
|
|
*
|
|
* @note If only one UART is available that uart might collide with
|
|
* STDIO_UART_DEV, otherwise the next available UART will be used.
|
|
*
|
|
*/
|
|
#ifndef OPENWSN_UART_DEV
|
|
#ifdef MODULE_STDIO_NULL
|
|
#define OPENWSN_UART_DEV (STDIO_UART_DEV)
|
|
#else
|
|
#define OPENWSN_UART_DEV ((STDIO_UART_DEV + 1) % UART_NUMOF)
|
|
#endif
|
|
#endif
|
|
|
|
/**
|
|
* @brief OpenWSN uart baudrate
|
|
*/
|
|
#ifndef OPENWSN_UART_BAUDRATE
|
|
#ifndef STDIO_UART_BAUDRATE
|
|
#define OPENWSN_UART_BAUDRATE (115200U)
|
|
#else
|
|
#define OPENWSN_UART_BAUDRATE (STDIO_UART_BAUDRATE)
|
|
#endif
|
|
#endif
|
|
|
|
/**
|
|
* @brief Initialize OpenWSN uart
|
|
*
|
|
* This will initialize a uart device at STDIO_UART_BAUDRATE/8N1. It will also
|
|
* initialize a timer to set sw tx_isr.
|
|
*
|
|
*/
|
|
void uart_init_openwsn(void);
|
|
|
|
/**
|
|
* @brief OpenWSN uart tx callback type
|
|
*/
|
|
typedef void (*uart_tx_cbt)(void);
|
|
|
|
/**
|
|
* @brief OpenWSN uart rx callback type
|
|
*/
|
|
typedef void (*uart_rx_cbt)(void);
|
|
|
|
/**
|
|
* @brief OpenWSN uart tx callback type
|
|
*/
|
|
void uart_setCallbacks(uart_tx_cbt txCb, uart_rx_cbt rxCb);
|
|
|
|
/**
|
|
* @brief Sets software flow control CTS
|
|
*
|
|
* This function sends XON or XOFF bytes to "set" or "unset" CTS by sw.
|
|
*
|
|
* @param[in] state true sets CTS, false clears CTS
|
|
*/
|
|
void uart_setCTS(bool state);
|
|
|
|
/**
|
|
* @brief Write a single byte to the configured OpenWSN uart
|
|
*/
|
|
void uart_writeByte(uint8_t byteToWrite);
|
|
|
|
/**
|
|
* @brief Reads a single byte received through uart.
|
|
*
|
|
* OpenWSN will call this thrpugh uart_rx_cbt.
|
|
*
|
|
*/
|
|
uint8_t uart_readByte(void);
|
|
|
|
/**
|
|
* @brief Unused in RIOT, needs to be defined for OpenWSN
|
|
*/
|
|
void uart_enableInterrupts(void);
|
|
|
|
/**
|
|
* @brief Unused in RIOT, needs to be defined for OpenWSN
|
|
*/
|
|
void uart_disableInterrupts(void);
|
|
|
|
/**
|
|
* @brief Unused in RIOT, needs to be defined for OpenWSN
|
|
*/
|
|
void uart_clearRxInterrupts(void);
|
|
|
|
/**
|
|
* @brief Unused in RIOT, needs to be defined for OpenWSN
|
|
*/
|
|
void uart_clearTxInterrupts(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* OPENWSN_UART_H */
|