53 lines
2.2 KiB
C
53 lines
2.2 KiB
C
/* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
/** library to control up to 4 independent receive and transmit software UART ports (API)
|
|
* @file uart_soft.h
|
|
* @author King Kévin <kingkevin@cuvoodoo.info>
|
|
* @date 2016
|
|
* @note peripherals used: GPIO @ref uart_soft_gpio, timer @ref uart_soft_timer
|
|
*/
|
|
|
|
/** if data has been received from UART port and is available to be read */
|
|
extern volatile bool uart_soft_received[4];
|
|
|
|
/** setup software UART ports
|
|
* @param[in] rx_baudrates baud rates of the 4 UART RX ports (0 if unused)
|
|
* @param[in] tx_baudrates baud rates of the 4 UART TX ports (0 if unused)
|
|
* @return is setup succeeded, else the configuration is wrong
|
|
*/
|
|
bool uart_soft_setup(uint32_t *rx_baudrates, uint32_t *tx_baudrates);
|
|
/** get received byte from UART port
|
|
* @param[in] uart UART receive port to read byte from
|
|
* @return received byte (0 if no byte is available)
|
|
*/
|
|
uint8_t uart_soft_getbyte(uint8_t uart);
|
|
/** ensure all bytes are transmitted for the UART
|
|
* @param[in] uart UART port to flush
|
|
*/
|
|
void uart_soft_flush(uint8_t uart);
|
|
/** put byte in buffer to be transmitted on UART port
|
|
* @note blocking if buffer is full
|
|
* @param[in] uart UART port to transmit the byte from
|
|
* @param[in] byte byte to put in transmit buffer
|
|
*/
|
|
void uart_soft_putbyte_nonblocking(uint8_t uart, uint8_t byte);
|
|
/** transmit byte on UART port
|
|
* @note blocks until all buffered byte and this byte are transmitted
|
|
* @param[in] uart UART port to transmit the byte from
|
|
* @param[in] byte byte to transmit
|
|
*/
|
|
void uart_soft_putbyte_blocking(uint8_t uart, uint8_t byte);
|
|
|