stm32f7xx_hal_usart_ex.h 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. /**
  2. ******************************************************************************
  3. * @file stm32f7xx_hal_usart_ex.h
  4. * @author MCD Application Team
  5. * @brief Header file of USART HAL Extension module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  10. *
  11. * Redistribution and use in source and binary forms, with or without modification,
  12. * are permitted provided that the following conditions are met:
  13. * 1. Redistributions of source code must retain the above copyright notice,
  14. * this list of conditions and the following disclaimer.
  15. * 2. Redistributions in binary form must reproduce the above copyright notice,
  16. * this list of conditions and the following disclaimer in the documentation
  17. * and/or other materials provided with the distribution.
  18. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  19. * may be used to endorse or promote products derived from this software
  20. * without specific prior written permission.
  21. *
  22. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  26. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32. *
  33. ******************************************************************************
  34. */
  35. /* Define to prevent recursive inclusion -------------------------------------*/
  36. #ifndef __STM32F7xx_HAL_USART_EX_H
  37. #define __STM32F7xx_HAL_USART_EX_H
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. /* Includes ------------------------------------------------------------------*/
  42. #include "stm32f7xx_hal_def.h"
  43. /** @addtogroup STM32F7xx_HAL_Driver
  44. * @{
  45. */
  46. /** @addtogroup USARTEx
  47. * @{
  48. */
  49. /* Exported types ------------------------------------------------------------*/
  50. /* Exported constants --------------------------------------------------------*/
  51. /** @defgroup USARTEx_Exported_Constants USARTEx Exported Constants
  52. * @{
  53. */
  54. /** @defgroup USARTEx_Word_Length USARTEx Word Length
  55. * @{
  56. */
  57. #define USART_WORDLENGTH_7B ((uint32_t)USART_CR1_M_1)
  58. #define USART_WORDLENGTH_8B ((uint32_t)0x00000000U)
  59. #define USART_WORDLENGTH_9B ((uint32_t)USART_CR1_M_0)
  60. /**
  61. * @}
  62. */
  63. /**
  64. * @}
  65. */
  66. /* Exported functions --------------------------------------------------------*/
  67. /* Private macros ------------------------------------------------------------*/
  68. /** @defgroup USARTEx_Private_Macros USARTEx Private Macros
  69. * @{
  70. */
  71. /** @brief Computes the USART mask to apply to retrieve the received data
  72. * according to the word length and to the parity bits activation.
  73. * If PCE = 1, the parity bit is not included in the data extracted
  74. * by the reception API().
  75. * This masking operation is not carried out in the case of
  76. * DMA transfers.
  77. * @param __HANDLE__ specifies the USART Handle
  78. * @retval none
  79. */
  80. #define __HAL_USART_MASK_COMPUTATION(__HANDLE__) \
  81. do { \
  82. if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_9B) \
  83. { \
  84. if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
  85. { \
  86. (__HANDLE__)->Mask = 0x01FF ; \
  87. } \
  88. else \
  89. { \
  90. (__HANDLE__)->Mask = 0x00FF ; \
  91. } \
  92. } \
  93. else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_8B) \
  94. { \
  95. if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
  96. { \
  97. (__HANDLE__)->Mask = 0x00FF ; \
  98. } \
  99. else \
  100. { \
  101. (__HANDLE__)->Mask = 0x007F ; \
  102. } \
  103. } \
  104. else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_7B) \
  105. { \
  106. if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
  107. { \
  108. (__HANDLE__)->Mask = 0x007F ; \
  109. } \
  110. else \
  111. { \
  112. (__HANDLE__)->Mask = 0x003F ; \
  113. } \
  114. } \
  115. } while(0)
  116. #define IS_USART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == USART_WORDLENGTH_7B) || \
  117. ((__LENGTH__) == USART_WORDLENGTH_8B) || \
  118. ((__LENGTH__) == USART_WORDLENGTH_9B))
  119. /**
  120. * @}
  121. */
  122. /* Exported functions --------------------------------------------------------*/
  123. /* Initialization/de-initialization methods **********************************/
  124. /* IO operation methods *******************************************************/
  125. /* Peripheral Control methods ************************************************/
  126. /* Peripheral State methods **************************************************/
  127. /**
  128. * @}
  129. */
  130. /**
  131. * @}
  132. */
  133. #ifdef __cplusplus
  134. }
  135. #endif
  136. #endif /* __STM32F7xx_HAL_USART_EX_H */
  137. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/