/* ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio ChibiOS - Copyright (C) 2023..2025 HorrorTroll ChibiOS - Copyright (C) 2023..2025 Zhaqian Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ /** * @file USARTv1/hal_serial_lld.h * @brief AT32 low level serial driver header. * * @addtogroup SERIAL * @{ */ #ifndef HAL_SERIAL_LLD_H #define HAL_SERIAL_LLD_H #if HAL_USE_SERIAL || defined(__DOXYGEN__) /*===========================================================================*/ /* Driver constants. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver pre-compile time settings. */ /*===========================================================================*/ /** * @name Configuration options * @{ */ /** * @brief USART1 driver enable switch. * @details If set to @p TRUE the support for USART1 is included. * @note The default is @p FALSE. */ #if !defined(AT32_SERIAL_USE_USART1) || defined(__DOXYGEN__) #define AT32_SERIAL_USE_USART1 FALSE #endif /** * @brief USART2 driver enable switch. * @details If set to @p TRUE the support for USART2 is included. * @note The default is @p FALSE. */ #if !defined(AT32_SERIAL_USE_USART2) || defined(__DOXYGEN__) #define AT32_SERIAL_USE_USART2 FALSE #endif /** * @brief USART3 driver enable switch. * @details If set to @p TRUE the support for USART3 is included. * @note The default is @p FALSE. */ #if !defined(AT32_SERIAL_USE_USART3) || defined(__DOXYGEN__) #define AT32_SERIAL_USE_USART3 FALSE #endif /** * @brief UART4 driver enable switch. * @details If set to @p TRUE the support for UART4 is included. * @note The default is @p FALSE. */ #if !defined(AT32_SERIAL_USE_UART4) || defined(__DOXYGEN__) #define AT32_SERIAL_USE_UART4 FALSE #endif /** * @brief UART5 driver enable switch. * @details If set to @p TRUE the support for UART5 is included. * @note The default is @p FALSE. */ #if !defined(AT32_SERIAL_USE_UART5) || defined(__DOXYGEN__) #define AT32_SERIAL_USE_UART5 FALSE #endif /** * @brief USART1 interrupt priority level setting. */ #if !defined(AT32_SERIAL_USART1_PRIORITY) || defined(__DOXYGEN__) #define AT32_SERIAL_USART1_PRIORITY 12 #endif /** * @brief USART2 interrupt priority level setting. */ #if !defined(AT32_SERIAL_USART2_PRIORITY) || defined(__DOXYGEN__) #define AT32_SERIAL_USART2_PRIORITY 12 #endif /** * @brief USART3 interrupt priority level setting. */ #if !defined(AT32_SERIAL_USART3_PRIORITY) || defined(__DOXYGEN__) #define AT32_SERIAL_USART3_PRIORITY 12 #endif /** * @brief UART4 interrupt priority level setting. */ #if !defined(AT32_SERIAL_UART4_PRIORITY) || defined(__DOXYGEN__) #define AT32_SERIAL_UART4_PRIORITY 12 #endif /** * @brief UART5 interrupt priority level setting. */ #if !defined(AT32_SERIAL_UART5_PRIORITY) || defined(__DOXYGEN__) #define AT32_SERIAL_UART5_PRIORITY 12 #endif /** @} */ /*===========================================================================*/ /* Derived constants and error checks. */ /*===========================================================================*/ #if AT32_SERIAL_USE_USART1 && !AT32_HAS_USART1 #error "USART1 not present in the selected device" #endif #if AT32_SERIAL_USE_USART2 && !AT32_HAS_USART2 #error "USART2 not present in the selected device" #endif #if AT32_SERIAL_USE_USART3 && !AT32_HAS_USART3 #error "USART3 not present in the selected device" #endif #if AT32_SERIAL_USE_UART4 && !AT32_HAS_UART4 #error "UART4 not present in the selected device" #endif #if AT32_SERIAL_USE_UART5 && !AT32_HAS_UART5 #error "UART5 not present in the selected device" #endif #if !AT32_SERIAL_USE_USART1 && !AT32_SERIAL_USE_USART2 && \ !AT32_SERIAL_USE_USART3 && !AT32_SERIAL_USE_UART4 && \ !AT32_SERIAL_USE_UART5 #error "SERIAL driver activated but no USART/UART peripheral assigned" #endif #if AT32_SERIAL_USE_USART1 && \ !OSAL_IRQ_IS_VALID_PRIORITY(AT32_SERIAL_USART1_PRIORITY) #error "Invalid IRQ priority assigned to USART1" #endif #if AT32_SERIAL_USE_USART2 && \ !OSAL_IRQ_IS_VALID_PRIORITY(AT32_SERIAL_USART2_PRIORITY) #error "Invalid IRQ priority assigned to USART2" #endif #if AT32_SERIAL_USE_USART3 && \ !OSAL_IRQ_IS_VALID_PRIORITY(AT32_SERIAL_USART3_PRIORITY) #error "Invalid IRQ priority assigned to USART3" #endif #if AT32_SERIAL_USE_UART4 && \ !OSAL_IRQ_IS_VALID_PRIORITY(AT32_SERIAL_UART4_PRIORITY) #error "Invalid IRQ priority assigned to UART4" #endif #if AT32_SERIAL_USE_UART5 && \ !OSAL_IRQ_IS_VALID_PRIORITY(AT32_SERIAL_UART5_PRIORITY) #error "Invalid IRQ priority assigned to UART5" #endif /* Checks on allocation of USARTx units.*/ #if AT32_SERIAL_USE_USART1 #if defined(AT32_USART1_IS_USED) #error "SD1 requires USART1 but it is already used" #else #define AT32_USART1_IS_USED #endif #endif #if AT32_SERIAL_USE_USART2 #if defined(AT32_USART2_IS_USED) #error "SD2 requires USART2 but it is already used" #else #define AT32_USART2_IS_USED #endif #endif #if AT32_SERIAL_USE_USART3 #if defined(AT32_USART3_IS_USED) #error "SD3 requires USART3 but it is already used" #else #define AT32_USART3_IS_USED #endif #endif #if AT32_SERIAL_USE_UART4 #if defined(AT32_UART4_IS_USED) #error "SD4 requires UART4 but it is already used" #else #define AT32_UART4_IS_USED #endif #endif #if AT32_SERIAL_USE_UART5 #if defined(AT32_UART5_IS_USED) #error "SD5 requires UART5 but it is already used" #else #define AT32_UART5_IS_USED #endif #endif /*===========================================================================*/ /* Driver data structures and types. */ /*===========================================================================*/ /** * @brief AT32 Serial Driver configuration structure. * @details An instance of this structure must be passed to @p sdStart() * in order to configure and start a serial driver operations. * @note This structure content is architecture dependent, each driver * implementation defines its own version and the custom static * initializers. */ typedef struct hal_serial_config { /** * @brief Bit rate. */ uint32_t speed; /* End of the mandatory fields.*/ /** * @brief Initialization value for the CTRL1 register. */ uint16_t ctrl1; /** * @brief Initialization value for the CTRL2 register. */ uint16_t ctrl2; /** * @brief Initialization value for the CTRL3 register. */ uint16_t ctrl3; } SerialConfig; /** * @brief @p SerialDriver specific data. */ #define _serial_driver_data \ _base_asynchronous_channel_data \ /* Driver state.*/ \ sdstate_t state; \ /* Input queue.*/ \ input_queue_t iqueue; \ /* Output queue.*/ \ output_queue_t oqueue; \ /* Input circular buffer.*/ \ uint8_t ib[SERIAL_BUFFERS_SIZE]; \ /* Output circular buffer.*/ \ uint8_t ob[SERIAL_BUFFERS_SIZE]; \ /* End of the mandatory fields.*/ \ /* Pointer to the USART registers block.*/ \ USART_TypeDef *usart; \ /* Clock frequency for the associated USART/UART.*/ \ uint32_t clock; \ /* Mask to be applied on received frames.*/ \ uint8_t rxmask; /*===========================================================================*/ /* Driver macros. */ /*===========================================================================*/ /* * Extra USARTs definitions here (missing from the AT header file). */ #define USART_CTRL2_STOPBN1_BITS (0 << 12) /**< @brief CTRL2 1 stop bit value.*/ #define USART_CTRL2_STOPBN0P5_BITS (1 << 12) /**< @brief CTRL2 0.5 stop bit value.*/ #define USART_CTRL2_STOPBN2_BITS (2 << 12) /**< @brief CTRL2 2 stop bit value.*/ #define USART_CTRL2_STOPBN1P5_BITS (3 << 12) /**< @brief CTRL2 1.5 stop bit value.*/ /*===========================================================================*/ /* External declarations. */ /*===========================================================================*/ #if AT32_SERIAL_USE_USART1 && !defined(__DOXYGEN__) extern SerialDriver SD1; #endif #if AT32_SERIAL_USE_USART2 && !defined(__DOXYGEN__) extern SerialDriver SD2; #endif #if AT32_SERIAL_USE_USART3 && !defined(__DOXYGEN__) extern SerialDriver SD3; #endif #if AT32_SERIAL_USE_UART4 && !defined(__DOXYGEN__) extern SerialDriver SD4; #endif #if AT32_SERIAL_USE_UART5 && !defined(__DOXYGEN__) extern SerialDriver SD5; #endif #ifdef __cplusplus extern "C" { #endif void sd_lld_init(void); void sd_lld_start(SerialDriver *sdp, const SerialConfig *config); void sd_lld_stop(SerialDriver *sdp); void sd_lld_serve_interrupt(SerialDriver *sdp); #ifdef __cplusplus } #endif #endif /* HAL_USE_SERIAL */ #endif /* HAL_SERIAL_LLD_H */ /** @} */