stm32l4xx_hal_crc_ex.h 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. /**
  2. ******************************************************************************
  3. * @file stm32l4xx_hal_crc_ex.h
  4. * @author MCD Application Team
  5. * @brief Header file of CRC HAL extended 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 __STM32L4xx_HAL_CRC_EX_H
  37. #define __STM32L4xx_HAL_CRC_EX_H
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. /* Includes ------------------------------------------------------------------*/
  42. #include "stm32l4xx_hal_def.h"
  43. /** @addtogroup STM32L4xx_HAL_Driver
  44. * @{
  45. */
  46. /** @addtogroup CRCEx
  47. * @{
  48. */
  49. /* Exported types ------------------------------------------------------------*/
  50. /* Exported constants --------------------------------------------------------*/
  51. /** @defgroup CRCEx_Exported_Constants CRCEx Exported Constants
  52. * @{
  53. */
  54. /** @defgroup CRCEx_Input_Data_Inversion Input Data Inversion Modes
  55. * @{
  56. */
  57. #define CRC_INPUTDATA_INVERSION_NONE (0x00000000U) /*!< No input data inversion */
  58. #define CRC_INPUTDATA_INVERSION_BYTE (CRC_CR_REV_IN_0) /*!< Byte-wise input data inversion */
  59. #define CRC_INPUTDATA_INVERSION_HALFWORD (CRC_CR_REV_IN_1) /*!< HalfWord-wise input data inversion */
  60. #define CRC_INPUTDATA_INVERSION_WORD (CRC_CR_REV_IN) /*!< Word-wise input data inversion */
  61. /**
  62. * @}
  63. */
  64. /** @defgroup CRCEx_Output_Data_Inversion Output Data Inversion Modes
  65. * @{
  66. */
  67. #define CRC_OUTPUTDATA_INVERSION_DISABLE (0x00000000U) /*!< No output data inversion */
  68. #define CRC_OUTPUTDATA_INVERSION_ENABLE (CRC_CR_REV_OUT) /*!< Bit-wise output data inversion */
  69. /**
  70. * @}
  71. */
  72. /**
  73. * @}
  74. */
  75. /* Exported macro ------------------------------------------------------------*/
  76. /** @defgroup CRCEx_Exported_Macros CRCEx Exported Macros
  77. * @{
  78. */
  79. /**
  80. * @brief Set CRC output reversal
  81. * @param __HANDLE__: CRC handle
  82. * @retval None
  83. */
  84. #define __HAL_CRC_OUTPUTREVERSAL_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_REV_OUT)
  85. /**
  86. * @brief Unset CRC output reversal
  87. * @param __HANDLE__: CRC handle
  88. * @retval None
  89. */
  90. #define __HAL_CRC_OUTPUTREVERSAL_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(CRC_CR_REV_OUT))
  91. /**
  92. * @brief Set CRC non-default polynomial
  93. * @param __HANDLE__: CRC handle
  94. * @param __POLYNOMIAL__: 7, 8, 16 or 32-bit polynomial
  95. * @retval None
  96. */
  97. #define __HAL_CRC_POLYNOMIAL_CONFIG(__HANDLE__, __POLYNOMIAL__) ((__HANDLE__)->Instance->POL = (__POLYNOMIAL__))
  98. /**
  99. * @}
  100. */
  101. /* Private macros --------------------------------------------------------*/
  102. /** @addtogroup CRCEx_Private_Macros CRCEx Private Macros
  103. * @{
  104. */
  105. #define IS_CRC_INPUTDATA_INVERSION_MODE(MODE) (((MODE) == CRC_INPUTDATA_INVERSION_NONE) || \
  106. ((MODE) == CRC_INPUTDATA_INVERSION_BYTE) || \
  107. ((MODE) == CRC_INPUTDATA_INVERSION_HALFWORD) || \
  108. ((MODE) == CRC_INPUTDATA_INVERSION_WORD))
  109. #define IS_CRC_OUTPUTDATA_INVERSION_MODE(MODE) (((MODE) == CRC_OUTPUTDATA_INVERSION_DISABLE) || \
  110. ((MODE) == CRC_OUTPUTDATA_INVERSION_ENABLE))
  111. /**
  112. * @}
  113. */
  114. /* Exported functions --------------------------------------------------------*/
  115. /** @addtogroup CRCEx_Exported_Functions CRC Extended Exported Functions
  116. * @{
  117. */
  118. /** @addtogroup CRCEx_Exported_Functions_Group1 Extended Initialization/de-initialization functions
  119. * @{
  120. */
  121. /* Initialization and de-initialization functions ****************************/
  122. HAL_StatusTypeDef HAL_CRCEx_Polynomial_Set(CRC_HandleTypeDef *hcrc, uint32_t Pol, uint32_t PolyLength);
  123. HAL_StatusTypeDef HAL_CRCEx_Input_Data_Reverse(CRC_HandleTypeDef *hcrc, uint32_t InputReverseMode);
  124. HAL_StatusTypeDef HAL_CRCEx_Output_Data_Reverse(CRC_HandleTypeDef *hcrc, uint32_t OutputReverseMode);
  125. /**
  126. * @}
  127. */
  128. /**
  129. * @}
  130. */
  131. /**
  132. * @}
  133. */
  134. /**
  135. * @}
  136. */
  137. #ifdef __cplusplus
  138. }
  139. #endif
  140. #endif /* __STM32L4xx_HAL_CRC_EX_H */
  141. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/