src/main/drivers/serial_softserial.h

   1 /*
   2  * This file is part of Cleanflight and Betaflight.
   3  *
   4  * Cleanflight and Betaflight are free software. You can redistribute
   5  * this software and/or modify this software under the terms of the
   6  * GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * Cleanflight and Betaflight are distributed in the hope that they
  11  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  12  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13  * See the GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this software.
  17  *
  18  * If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #pragma once
  22
  23 #define SOFTSERIAL_BUFFER_SIZE 256
  24
  25 typedef enum {
  26     SOFTSERIAL1 = 0,
  27     SOFTSERIAL2
  28 } softSerialPortIndex_e;
  29
  30 serialPort_t *openSoftSerial(softSerialPortIndex_e portIndex, serialReceiveCallbackPtr rxCallback, void *rxCallbackData, uint32_t baud, portMode_e mode, portOptions_e options);
  31
  32 // serialPort API
  33 void softSerialWriteByte(serialPort_t *instance, uint8_t ch);
  34 uint32_t softSerialRxBytesWaiting(const serialPort_t *instance);
  35 uint32_t softSerialTxBytesFree(const serialPort_t *instance);
  36 uint8_t softSerialReadByte(serialPort_t *instance);
  37 void softSerialSetBaudRate(serialPort_t *s, uint32_t baudRate);
  38 bool isSoftSerialTransmitBufferEmpty(const serialPort_t *s);