src/main/drivers/serial_softserial.h

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