uart.h

/**
  ******************************************************************************
  * @file    uart.h
  * @author  WI6LABS
  * @version V1.0.0
  * @date    01-August-2016
  * @brief   Header for uart module
  ******************************************************************************
  * @attention
  *
  * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
  *
  * Redistribution and use in source and binary forms, with or without modification,
  * are permitted provided that the following conditions are met:
  *   1. Redistributions of source code must retain the above copyright notice,
  *      this list of conditions and the following disclaimer.
  *   2. Redistributions in binary form must reproduce the above copyright notice,
  *      this list of conditions and the following disclaimer in the documentation
  *      and/or other materials provided with the distribution.
  *   3. Neither the name of STMicroelectronics nor the names of its contributors
  *      may be used to endorse or promote products derived from this software
  *      without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  ******************************************************************************
  */

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __UART_H
#define __UART_H

/* Includes ------------------------------------------------------------------*/
#include "stm32_def.h"
#include "variant.h"

#ifdef __cplusplus
 extern "C" {
#endif

#if !defined(NO_HWSERIAL)
#if defined(ALL_HWSERIAL) || defined(FIRST_THIRD_HWSERIAL)
#define ENABLE_HWSERIAL1
#define ENABLE_HWSERIAL2
#define ENABLE_HWSERIAL3
#if !defined(FIRST_THIRD_HWSERIAL)
#define ENABLE_HWSERIAL4
#define ENABLE_HWSERIAL5
#define ENABLE_HWSERIAL6
#define ENABLE_HWSERIAL7
#define ENABLE_HWSERIAL8
#define ENABLE_HWSERIAL9
#define ENABLE_HWSERIAL10
#endif // FIRST_THIRD_HWSERIAL
#endif // ALL_HWSERIAL || FIRST_THIRD_HWSERIAL
#ifdef SERIAL_UART_INSTANCE
#if SERIAL_UART_INSTANCE == 1
#define ENABLE_HWSERIAL1
#if !defined(Serial)
#define Serial Serial1
#define serialEvent serialEvent1
#endif
#elif SERIAL_UART_INSTANCE == 2
#define ENABLE_HWSERIAL2
#if !defined(Serial)
#define Serial Serial2
#define serialEvent serialEvent2
#endif
#elif SERIAL_UART_INSTANCE == 3
#define ENABLE_HWSERIAL3
#if !defined(Serial)
#define Serial Serial3
#define serialEvent serialEvent3
#endif
#elif SERIAL_UART_INSTANCE == 4
#define ENABLE_HWSERIAL4
#if !defined(Serial)
#define Serial Serial4
#define serialEvent serialEvent4
#endif
#elif SERIAL_UART_INSTANCE == 5
#define ENABLE_HWSERIAL5
#if !defined(Serial)
#define Serial Serial5
#define serialEvent serialEvent5
#endif
#elif SERIAL_UART_INSTANCE == 6
#define ENABLE_HWSERIAL6
#if !defined(Serial)
#define Serial Serial6
#define serialEvent serialEvent6
#endif
#elif SERIAL_UART_INSTANCE == 7
#define ENABLE_HWSERIAL7
#if !defined(Serial)
#define Serial Serial7
#define serialEvent serialEvent7
#endif
#elif SERIAL_UART_INSTANCE == 8
#define ENABLE_HWSERIAL8
#if !defined(Serial)
#define Serial Serial8
#define serialEvent serialEvent8
#endif
#elif SERIAL_UART_INSTANCE == 9
#define ENABLE_HWSERIAL9
#if !defined(Serial)
#define Serial Serial9
#define serialEvent serialEvent9
#endif
#elif SERIAL_UART_INSTANCE == 10
#define ENABLE_HWSERIAL10
#if !defined(Serial)
#define Serial Serial10
#define serialEvent serialEvent10
#endif
#endif // SERIAL_UART_INSTANCE == x
#else
#if !defined(Serial)
#warning "No generic 'Serial' defined!"
#endif
#endif // SERIAL_UART_INSTANCE
#endif // NO_HWSERIAL

#if defined(ENABLE_HWSERIAL1)
#if defined(USART1_BASE)
#define HAVE_HWSERIAL1
#endif
#endif
#if defined(ENABLE_HWSERIAL2)
#if defined(USART2_BASE)
#define HAVE_HWSERIAL2
#endif
#endif
#if defined(ENABLE_HWSERIAL3)
#if defined(USART3_BASE)
#define HAVE_HWSERIAL3
#endif
#endif
#if defined(ENABLE_HWSERIAL4)
#if defined(USART4_BASE) || defined(UART4_BASE)
#define HAVE_HWSERIAL4
#endif
#endif
#if defined(ENABLE_HWSERIAL5)
#if defined(USART5_BASE) || defined(UART5_BASE)
#define HAVE_HWSERIAL5
#endif
#endif
#if defined(ENABLE_HWSERIAL6)
#if defined(USART6_BASE)
#define HAVE_HWSERIAL6
#endif
#endif
#if defined(ENABLE_HWSERIAL7)
#if defined(USART7_BASE) || defined(UART7_BASE)
#define HAVE_HWSERIAL7
#endif
#endif
#if defined(ENABLE_HWSERIAL8)
#if defined(USART8_BASE) || defined(UART8_BASE)
#define HAVE_HWSERIAL8
#endif
#endif
#if defined(ENABLE_HWSERIAL9)
#if defined(UART9_BASE)
#define HAVE_HWSERIAL9
#endif
#endif
#if defined(ENABLE_HWSERIAL10)
#if defined(UART10_BASE)
#define HAVE_HWSERIAL10
#endif
#endif

/* Exported types ------------------------------------------------------------*/
typedef struct serial_s serial_t;

struct serial_s {
  USART_TypeDef *uart;
  UART_HandleTypeDef handle;
  uint8_t index;
  uint8_t recv;
  uint32_t baudrate;
  uint32_t databits;
  uint32_t stopbits;
  uint32_t parity;
  PinName pin_tx;
  PinName pin_rx;
  IRQn_Type irq;
  uint8_t *rx_buff;
  volatile uint16_t rx_head;
  uint16_t rx_tail;
  uint8_t *tx_buff;
  uint16_t tx_head;
  volatile uint16_t tx_tail;
};

/* Exported constants --------------------------------------------------------*/
#define TX_TIMEOUT  1000

#if defined(USART3_BASE) && !defined(USART3_IRQn)
#if defined(STM32F0xx)
#if defined(STM32F091xC) || defined (STM32F098xx)
#define USART3_IRQn USART3_8_IRQn
#define USART3_IRQHandler USART3_8_IRQHandler
#elif defined(STM32F030xC)
#define USART3_IRQn USART3_6_IRQn
#define USART3_IRQHandler USART3_6_IRQHandler
#else
#define USART3_IRQn USART3_4_IRQn
#define USART3_IRQHandler USART3_4_IRQHandler

#endif // STM32F091xC || STM32F098xx
#endif // STM32F0xx
#endif

#if defined(USART4_BASE) && !defined(USART4_IRQn)
#if defined(STM32F0xx)
// IRQHandler is mapped on USART3_IRQHandler for STM32F0xx
#if defined(STM32F091xC) || defined (STM32F098xx)
#define USART4_IRQn USART3_8_IRQn
#elif defined(STM32F030xC)
#define USART4_IRQn USART3_6_IRQn
#else
#define USART4_IRQn USART3_4_IRQn
#endif // STM32F091xC || STM32F098xx
#elif defined(STM32L0xx)
#define USART4_IRQn USART4_5_IRQn
#endif // STM32F0xx
#endif

#if defined(USART5_BASE) && !defined(USART5_IRQn)
#if defined(STM32F0xx)
// IRQHandler is mapped on USART3_IRQHandler for STM32F0xx
#if defined(STM32F091xC) || defined (STM32F098xx)
#define USART5_IRQn USART3_8_IRQn
#elif defined(STM32F030xC)
#define USART5_IRQn USART3_6_IRQn
#endif // STM32F091xC || STM32F098xx
#elif defined(STM32L0xx)
#define USART5_IRQn USART4_5_IRQn
#endif // STM32F0xx
#endif

#if defined (STM32F0xx)
// IRQHandler is mapped on USART3_IRQHandler for STM32F0xx
#if defined(USART6_BASE) && !defined(USART6_IRQn)
#if defined(STM32F091xC) || defined (STM32F098xx)
#define USART6_IRQn USART3_8_IRQn
#elif defined(STM32F030xC)
#define USART6_IRQn USART3_6_IRQn
#endif // STM32F091xC || STM32F098xx
#endif

#if defined(USART7_BASE) && !defined(USART7_IRQn)
#if defined(STM32F091xC) || defined (STM32F098xx)
#define USART7_IRQn USART3_8_IRQn
#endif // STM32F091xC || STM32F098xx
#endif

#if defined(USART8_BASE) && !defined(USART8_IRQn)
#if defined(STM32F091xC) || defined (STM32F098xx)
#define USART8_IRQn USART3_8_IRQn
#endif // STM32F091xC || STM32F098xx
#endif
#endif // STM32F0xx

/* Exported macro ------------------------------------------------------------*/
/* Exported functions ------------------------------------------------------- */
void uart_init(serial_t *obj);
void uart_deinit(serial_t *obj);
size_t uart_write(serial_t *obj, uint8_t data, uint16_t size);
int uart_getc(serial_t *obj, unsigned char* c);
void uart_attach_rx_callback(serial_t *obj, void (*callback)(serial_t*));
void uart_attach_tx_callback(serial_t *obj, int (*callback)(serial_t*));

uint8_t serial_tx_active(serial_t *obj);
uint8_t serial_rx_active(serial_t *obj);

size_t uart_debug_write(uint8_t *data, uint32_t size);

#ifdef __cplusplus
}
#endif

#endif /* __UART_H */

/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/