stm32h7/include/stm32h7xx_hal_usart_ex.h

0001 /**
0002   ******************************************************************************
0003   * @file    stm32h7xx_hal_usart_ex.h
0004   * @author  MCD Application Team
0005   * @brief   Header file of USART HAL Extended module.
0006   ******************************************************************************
0007   * @attention
0008   *
0009   * Copyright (c) 2017 STMicroelectronics.
0010   * All rights reserved.
0011   *
0012   * This software is licensed under terms that can be found in the LICENSE file
0013   * in the root directory of this software component.
0014   * If no LICENSE file comes with this software, it is provided AS-IS.
0015   *
0016   ******************************************************************************
0017   */
0018
0019 /* Define to prevent recursive inclusion -------------------------------------*/
0020 #ifndef STM32H7xx_HAL_USART_EX_H
0021 #define STM32H7xx_HAL_USART_EX_H
0022
0023 #ifdef __cplusplus
0024 extern "C" {
0025 #endif
0026
0027 /* Includes ------------------------------------------------------------------*/
0028 #include "stm32h7xx_hal_def.h"
0029
0030 /** @addtogroup STM32H7xx_HAL_Driver
0031   * @{
0032   */
0033
0034 /** @addtogroup USARTEx
0035   * @{
0036   */
0037
0038 /* Exported types ------------------------------------------------------------*/
0039 /* Exported constants --------------------------------------------------------*/
0040 /** @defgroup USARTEx_Exported_Constants USARTEx Exported Constants
0041   * @ingroup RTEMSBSPsARMSTM32H7
0042   * @{
0043   */
0044
0045 /** @defgroup USARTEx_Word_Length USARTEx Word Length
0046   * @ingroup RTEMSBSPsARMSTM32H7
0047   * @{
0048   */
0049 #define USART_WORDLENGTH_7B                  (USART_CR1_M1)   /*!< 7-bit long USART frame */
0050 #define USART_WORDLENGTH_8B                  (0x00000000U)    /*!< 8-bit long USART frame */
0051 #define USART_WORDLENGTH_9B                  (USART_CR1_M0)   /*!< 9-bit long USART frame */
0052 /**
0053   * @}
0054   */
0055
0056 /** @defgroup USARTEx_Slave_Select_management USARTEx Slave Select Management
0057   * @ingroup RTEMSBSPsARMSTM32H7
0058   * @{
0059   */
0060 #define USART_NSS_HARD                        0x00000000U          /*!< SPI slave selection depends on NSS input pin              */
0061 #define USART_NSS_SOFT                        USART_CR2_DIS_NSS    /*!< SPI slave is always selected and NSS input pin is ignored */
0062 /**
0063   * @}
0064   */
0065
0066
0067 /** @defgroup USARTEx_Slave_Mode USARTEx Synchronous Slave mode enable
0068   * @ingroup RTEMSBSPsARMSTM32H7
0069   * @brief    USART SLAVE mode
0070   * @{
0071   */
0072 #define USART_SLAVEMODE_DISABLE   0x00000000U     /*!< USART SPI Slave Mode Enable  */
0073 #define USART_SLAVEMODE_ENABLE    USART_CR2_SLVEN /*!< USART SPI Slave Mode Disable */
0074 /**
0075   * @}
0076   */
0077
0078 /** @defgroup USARTEx_FIFO_mode USARTEx FIFO  mode
0079   * @ingroup RTEMSBSPsARMSTM32H7
0080   * @brief    USART FIFO  mode
0081   * @{
0082   */
0083 #define USART_FIFOMODE_DISABLE        0x00000000U                   /*!< FIFO mode disable */
0084 #define USART_FIFOMODE_ENABLE         USART_CR1_FIFOEN              /*!< FIFO mode enable  */
0085 /**
0086   * @}
0087   */
0088
0089 /** @defgroup USARTEx_TXFIFO_threshold_level USARTEx TXFIFO threshold level
0090   * @ingroup RTEMSBSPsARMSTM32H7
0091   * @brief    USART TXFIFO level
0092   * @{
0093   */
0094 #define USART_TXFIFO_THRESHOLD_1_8   0x00000000U                               /*!< TXFIFO reaches 1/8 of its depth */
0095 #define USART_TXFIFO_THRESHOLD_1_4   USART_CR3_TXFTCFG_0                       /*!< TXFIFO reaches 1/4 of its depth */
0096 #define USART_TXFIFO_THRESHOLD_1_2   USART_CR3_TXFTCFG_1                       /*!< TXFIFO reaches 1/2 of its depth */
0097 #define USART_TXFIFO_THRESHOLD_3_4   (USART_CR3_TXFTCFG_0|USART_CR3_TXFTCFG_1) /*!< TXFIFO reaches 3/4 of its depth */
0098 #define USART_TXFIFO_THRESHOLD_7_8   USART_CR3_TXFTCFG_2                       /*!< TXFIFO reaches 7/8 of its depth */
0099 #define USART_TXFIFO_THRESHOLD_8_8   (USART_CR3_TXFTCFG_2|USART_CR3_TXFTCFG_0) /*!< TXFIFO becomes empty            */
0100 /**
0101   * @}
0102   */
0103
0104 /** @defgroup USARTEx_RXFIFO_threshold_level USARTEx RXFIFO threshold level
0105   * @ingroup RTEMSBSPsARMSTM32H7
0106   * @brief    USART RXFIFO level
0107   * @{
0108   */
0109 #define USART_RXFIFO_THRESHOLD_1_8   0x00000000U                               /*!< RXFIFO FIFO reaches 1/8 of its depth */
0110 #define USART_RXFIFO_THRESHOLD_1_4   USART_CR3_RXFTCFG_0                       /*!< RXFIFO FIFO reaches 1/4 of its depth */
0111 #define USART_RXFIFO_THRESHOLD_1_2   USART_CR3_RXFTCFG_1                       /*!< RXFIFO FIFO reaches 1/2 of its depth */
0112 #define USART_RXFIFO_THRESHOLD_3_4   (USART_CR3_RXFTCFG_0|USART_CR3_RXFTCFG_1) /*!< RXFIFO FIFO reaches 3/4 of its depth */
0113 #define USART_RXFIFO_THRESHOLD_7_8   USART_CR3_RXFTCFG_2                       /*!< RXFIFO FIFO reaches 7/8 of its depth */
0114 #define USART_RXFIFO_THRESHOLD_8_8   (USART_CR3_RXFTCFG_2|USART_CR3_RXFTCFG_0) /*!< RXFIFO FIFO becomes full             */
0115 /**
0116   * @}
0117   */
0118
0119 /**
0120   * @}
0121   */
0122
0123 /* Private macros ------------------------------------------------------------*/
0124 /** @defgroup USARTEx_Private_Macros USARTEx Private Macros
0125   * @ingroup RTEMSBSPsARMSTM32H7
0126   * @{
0127   */
0128
0129 /** @brief  Compute the USART mask to apply to retrieve the received data
0130   *         according to the word length and to the parity bits activation.
0131   * @note   If PCE = 1, the parity bit is not included in the data extracted
0132   *         by the reception API().
0133   *         This masking operation is not carried out in the case of
0134   *         DMA transfers.
0135   * @param  __HANDLE__ specifies the USART Handle.
0136   * @retval None, the mask to apply to USART RDR register is stored in (__HANDLE__)->Mask field.
0137   */
0138 #define USART_MASK_COMPUTATION(__HANDLE__)                            \
0139   do {                                                                \
0140     if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_9B)         \
0141     {                                                                 \
0142       if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE)             \
0143       {                                                               \
0144         (__HANDLE__)->Mask = 0x01FFU;                                 \
0145       }                                                               \
0146       else                                                            \
0147       {                                                               \
0148         (__HANDLE__)->Mask = 0x00FFU;                                 \
0149       }                                                               \
0150     }                                                                 \
0151     else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_8B)    \
0152     {                                                                 \
0153       if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE)             \
0154       {                                                               \
0155         (__HANDLE__)->Mask = 0x00FFU;                                 \
0156       }                                                               \
0157       else                                                            \
0158       {                                                               \
0159         (__HANDLE__)->Mask = 0x007FU;                                 \
0160       }                                                               \
0161     }                                                                 \
0162     else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_7B)    \
0163     {                                                                 \
0164       if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE)             \
0165       {                                                               \
0166         (__HANDLE__)->Mask = 0x007FU;                                 \
0167       }                                                               \
0168       else                                                            \
0169       {                                                               \
0170         (__HANDLE__)->Mask = 0x003FU;                                 \
0171       }                                                               \
0172     }                                                                 \
0173     else                                                              \
0174     {                                                                 \
0175       (__HANDLE__)->Mask = 0x0000U;                                   \
0176     }                                                                 \
0177   } while(0U)
0178
0179 /**
0180   * @brief Ensure that USART frame length is valid.
0181   * @param __LENGTH__ USART frame length.
0182   * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
0183   */
0184 #define IS_USART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == USART_WORDLENGTH_7B) || \
0185                                           ((__LENGTH__) == USART_WORDLENGTH_8B) || \
0186                                           ((__LENGTH__) == USART_WORDLENGTH_9B))
0187
0188 /**
0189   * @brief Ensure that USART Negative Slave Select (NSS) pin management is valid.
0190   * @param __NSS__ USART Negative Slave Select pin management.
0191   * @retval SET (__NSS__ is valid) or RESET (__NSS__ is invalid)
0192   */
0193 #define IS_USART_NSS(__NSS__) (((__NSS__) == USART_NSS_HARD) || \
0194                                ((__NSS__) == USART_NSS_SOFT))
0195
0196 /**
0197   * @brief Ensure that USART Slave Mode is valid.
0198   * @param __STATE__ USART Slave Mode.
0199   * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
0200   */
0201 #define IS_USART_SLAVEMODE(__STATE__)   (((__STATE__) == USART_SLAVEMODE_DISABLE ) || \
0202                                          ((__STATE__) == USART_SLAVEMODE_ENABLE))
0203
0204 /**
0205   * @brief Ensure that USART FIFO mode is valid.
0206   * @param __STATE__ USART FIFO mode.
0207   * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
0208   */
0209 #define IS_USART_FIFO_MODE_STATE(__STATE__) (((__STATE__) == USART_FIFOMODE_DISABLE ) || \
0210                                              ((__STATE__) == USART_FIFOMODE_ENABLE))
0211
0212 /**
0213   * @brief Ensure that USART TXFIFO threshold level is valid.
0214   * @param __THRESHOLD__ USART TXFIFO threshold level.
0215   * @retval SET (__THRESHOLD__ is valid) or RESET (__THRESHOLD__ is invalid)
0216   */
0217 #define IS_USART_TXFIFO_THRESHOLD(__THRESHOLD__)  (((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_1_8)  || \
0218                                                    ((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_1_4)  || \
0219                                                    ((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_1_2)  || \
0220                                                    ((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_3_4)  || \
0221                                                    ((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_7_8)  || \
0222                                                    ((__THRESHOLD__) == USART_TXFIFO_THRESHOLD_8_8))
0223
0224 /**
0225   * @brief Ensure that USART RXFIFO threshold level is valid.
0226   * @param __THRESHOLD__ USART RXFIFO threshold level.
0227   * @retval SET (__THRESHOLD__ is valid) or RESET (__THRESHOLD__ is invalid)
0228   */
0229 #define IS_USART_RXFIFO_THRESHOLD(__THRESHOLD__)  (((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_1_8)  || \
0230                                                    ((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_1_4)  || \
0231                                                    ((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_1_2)  || \
0232                                                    ((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_3_4)  || \
0233                                                    ((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_7_8)  || \
0234                                                    ((__THRESHOLD__) == USART_RXFIFO_THRESHOLD_8_8))
0235 /**
0236   * @}
0237   */
0238
0239 /* Exported functions --------------------------------------------------------*/
0240 /** @addtogroup USARTEx_Exported_Functions
0241   * @{
0242   */
0243
0244 /** @addtogroup USARTEx_Exported_Functions_Group1
0245   * @{
0246   */
0247
0248 /* IO operation functions *****************************************************/
0249 void HAL_USARTEx_RxFifoFullCallback(USART_HandleTypeDef *husart);
0250 void HAL_USARTEx_TxFifoEmptyCallback(USART_HandleTypeDef *husart);
0251
0252 /**
0253   * @}
0254   */
0255
0256 /** @addtogroup USARTEx_Exported_Functions_Group2
0257   * @{
0258   */
0259
0260 /* Peripheral Control functions ***********************************************/
0261 HAL_StatusTypeDef HAL_USARTEx_EnableSlaveMode(USART_HandleTypeDef *husart);
0262 HAL_StatusTypeDef HAL_USARTEx_DisableSlaveMode(USART_HandleTypeDef *husart);
0263 HAL_StatusTypeDef HAL_USARTEx_ConfigNSS(USART_HandleTypeDef *husart, uint32_t NSSConfig);
0264 HAL_StatusTypeDef HAL_USARTEx_EnableFifoMode(USART_HandleTypeDef *husart);
0265 HAL_StatusTypeDef HAL_USARTEx_DisableFifoMode(USART_HandleTypeDef *husart);
0266 HAL_StatusTypeDef HAL_USARTEx_SetTxFifoThreshold(USART_HandleTypeDef *husart, uint32_t Threshold);
0267 HAL_StatusTypeDef HAL_USARTEx_SetRxFifoThreshold(USART_HandleTypeDef *husart, uint32_t Threshold);
0268
0269 /**
0270   * @}
0271   */
0272
0273 /**
0274   * @}
0275   */
0276
0277 /**
0278   * @}
0279   */
0280
0281 /**
0282   * @}
0283   */
0284
0285 #ifdef __cplusplus
0286 }
0287 #endif
0288
0289 #endif /* STM32H7xx_HAL_USART_EX_H */
0290