src/main/drivers/serial_uart.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 // Since serial ports can be used for any function these buffer sizes should be equal
  21 // The two largest things that need to be sent are: 1, MSP responses, 2, UBLOX SVINFO packet.
  22 #define UART1_RX_BUFFER_SIZE    256
  23 #define UART1_TX_BUFFER_SIZE    256
  24 #define UART2_RX_BUFFER_SIZE    256
  25 #define UART2_TX_BUFFER_SIZE    256
  26 #define UART3_RX_BUFFER_SIZE    256
  27 #define UART3_TX_BUFFER_SIZE    256
  28
  29 typedef struct {
  30     serialPort_t port;
  31
  32     DMA_Channel_TypeDef *rxDMAChannel;
  33     DMA_Channel_TypeDef *txDMAChannel;
  34
  35     uint32_t rxDMAIrq;
  36     uint32_t txDMAIrq;
  37
  38     uint32_t rxDMAPos;
  39     bool txDMAEmpty;
  40
  41     uint32_t txDMAPeripheralBaseAddr;
  42     uint32_t rxDMAPeripheralBaseAddr;
  43
  44     USART_TypeDef *USARTx;
  45 } uartPort_t;
  46
  47 serialPort_t *uartOpen(USART_TypeDef *USARTx, serialReceiveCallbackPtr callback, uint32_t baudRate, portMode_t mode, serialInversion_e inversion);
  48
  49 // serialPort API
  50 void uartWrite(serialPort_t *instance, uint8_t ch);
  51 uint8_t uartTotalBytesWaiting(serialPort_t *instance);
  52 uint8_t uartRead(serialPort_t *instance);
  53 void uartSetBaudRate(serialPort_t *s, uint32_t baudRate);
  54 bool isUartTransmitBufferEmpty(serialPort_t *s);