stm32f7xx_hal_crc_ex.h 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. /**
  2. ******************************************************************************
  3. * @file stm32f7xx_hal_crc_ex.h
  4. * @author MCD Application Team
  5. * @brief Header file of CRC 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_CRC_EX_H
  37. #define __STM32F7xx_HAL_CRC_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. /** @defgroup CRCEx CRCEx
  47. * @{
  48. */
  49. /* Exported types ------------------------------------------------------------*/
  50. /* Exported constants --------------------------------------------------------*/
  51. /** @defgroup CRCEx_Exported_Constants CRC Extended exported constants
  52. * @{
  53. */
  54. /** @defgroup CRCEx_Input_Data_Inversion CRC Extended input data inversion modes
  55. * @{
  56. */
  57. #define CRC_INPUTDATA_INVERSION_NONE ((uint32_t)0x00000000U)
  58. #define CRC_INPUTDATA_INVERSION_BYTE ((uint32_t)CRC_CR_REV_IN_0)
  59. #define CRC_INPUTDATA_INVERSION_HALFWORD ((uint32_t)CRC_CR_REV_IN_1)
  60. #define CRC_INPUTDATA_INVERSION_WORD ((uint32_t)CRC_CR_REV_IN)
  61. #define IS_CRC_INPUTDATA_INVERSION_MODE(__MODE__) (((__MODE__) == CRC_INPUTDATA_INVERSION_NONE) || \
  62. ((__MODE__) == CRC_INPUTDATA_INVERSION_BYTE) || \
  63. ((__MODE__) == CRC_INPUTDATA_INVERSION_HALFWORD) || \
  64. ((__MODE__) == CRC_INPUTDATA_INVERSION_WORD))
  65. /**
  66. * @}
  67. */
  68. /** @defgroup CRCEx_Output_Data_Inversion CRC Extended output data inversion modes
  69. * @{
  70. */
  71. #define CRC_OUTPUTDATA_INVERSION_DISABLE ((uint32_t)0x00000000U)
  72. #define CRC_OUTPUTDATA_INVERSION_ENABLE ((uint32_t)CRC_CR_REV_OUT)
  73. #define IS_CRC_OUTPUTDATA_INVERSION_MODE(__MODE__) (((__MODE__) == CRC_OUTPUTDATA_INVERSION_DISABLE) || \
  74. ((__MODE__) == CRC_OUTPUTDATA_INVERSION_ENABLE))
  75. /**
  76. * @}
  77. */
  78. /**
  79. * @}
  80. */
  81. /* Exported macro ------------------------------------------------------------*/
  82. /** @defgroup CRCEx_Exported_Macros CRC Extended exported macros
  83. * @{
  84. */
  85. /**
  86. * @brief Set CRC output reversal
  87. * @param __HANDLE__ CRC handle
  88. * @retval None.
  89. */
  90. #define __HAL_CRC_OUTPUTREVERSAL_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_REV_OUT)
  91. /**
  92. * @brief Unset CRC output reversal
  93. * @param __HANDLE__ CRC handle
  94. * @retval None.
  95. */
  96. #define __HAL_CRC_OUTPUTREVERSAL_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(CRC_CR_REV_OUT))
  97. /**
  98. * @brief Set CRC non-default polynomial
  99. * @param __HANDLE__ CRC handle
  100. * @param __POLYNOMIAL__ 7, 8, 16 or 32-bit polynomial
  101. * @retval None.
  102. */
  103. #define __HAL_CRC_POLYNOMIAL_CONFIG(__HANDLE__, __POLYNOMIAL__) ((__HANDLE__)->Instance->POL = (__POLYNOMIAL__))
  104. /**
  105. * @}
  106. */
  107. /** @defgroup CRCEx_Exported_Functions CRC Extended Exported Functions
  108. * @{
  109. */
  110. /** @defgroup CRCEx_Exported_Functions_Group1 Extended CRC features functions
  111. * @{
  112. */
  113. /* Exported functions --------------------------------------------------------*/
  114. /* Initialization and de-initialization functions ****************************/
  115. HAL_StatusTypeDef HAL_CRCEx_Polynomial_Set(CRC_HandleTypeDef *hcrc, uint32_t Pol, uint32_t PolyLength);
  116. HAL_StatusTypeDef HAL_CRCEx_Input_Data_Reverse(CRC_HandleTypeDef *hcrc, uint32_t InputReverseMode);
  117. HAL_StatusTypeDef HAL_CRCEx_Output_Data_Reverse(CRC_HandleTypeDef *hcrc, uint32_t OutputReverseMode);
  118. /* Peripheral Control functions ***********************************************/
  119. /* Peripheral State and Error functions ***************************************/
  120. /**
  121. * @}
  122. */
  123. /**
  124. * @}
  125. */
  126. /**
  127. * @}
  128. */
  129. /**
  130. * @}
  131. */
  132. #ifdef __cplusplus
  133. }
  134. #endif
  135. #endif /* __STM32F7xx_HAL_CRC_EX_H */
  136. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/