spark_abacus/lib/usart_soft.h

35 lines
1.3 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 multiple software USARTs (API)
* @file usart_soft.h
* @author King Kévin <kingkevin@cuvoodoo.info>
* @date 2016
* @note peripherals used: GPIO @ref usart_soft_gpio, timer @ref usart_soft_timer
*/
/** number of software USART receive ports (0-4)
* @note the corresponding GPIOs need to be configured in @p usart_soft_gpio
*/
#define USART_SOFT_RX_PORTS 1
/** number of software USART transmit ports (0-4)
* @note the corresponding GPIOs need to be configured in @p usart_soft_gpio
*/
#define USART_SOFT_TX_PORTS 1
/** setup software USART ports
* @return is setup succeeded, else the configuration is wrong
*/
bool usart_soft_setup(void);