Subversion Repositories FuelGauge

Rev

Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /**
  2.   ******************************************************************************
  3.   * @file    stm32f0xx_hal_crc.h
  4.   * @author  MCD Application Team
  5.   * @brief   Header file of CRC HAL module.
  6.   ******************************************************************************
  7.   * @attention
  8.   *
  9.   * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
  10.   * All rights reserved.</center></h2>
  11.   *
  12.   * This software component is licensed by ST under BSD 3-Clause license,
  13.   * the "License"; You may not use this file except in compliance with the
  14.   * License. You may obtain a copy of the License at:
  15.   *                        opensource.org/licenses/BSD-3-Clause
  16.   *
  17.   ******************************************************************************
  18.   */
  19.  
  20. /* Define to prevent recursive inclusion -------------------------------------*/
  21. #ifndef STM32F0xx_HAL_CRC_H
  22. #define STM32F0xx_HAL_CRC_H
  23.  
  24. #ifdef __cplusplus
  25. extern "C" {
  26. #endif
  27.  
  28. /* Includes ------------------------------------------------------------------*/
  29. #include "stm32f0xx_hal_def.h"
  30.  
  31. /** @addtogroup STM32F0xx_HAL_Driver
  32.   * @{
  33.   */
  34.  
  35. /** @addtogroup CRC
  36.   * @{
  37.   */
  38.  
  39. /* Exported types ------------------------------------------------------------*/
  40. /** @defgroup CRC_Exported_Types CRC Exported Types
  41.   * @{
  42.   */
  43.  
  44. /**
  45.   * @brief  CRC HAL State Structure definition
  46.   */
  47. typedef enum
  48. {
  49.   HAL_CRC_STATE_RESET     = 0x00U,  /*!< CRC not yet initialized or disabled */
  50.   HAL_CRC_STATE_READY     = 0x01U,  /*!< CRC initialized and ready for use   */
  51.   HAL_CRC_STATE_BUSY      = 0x02U,  /*!< CRC internal process is ongoing     */
  52.   HAL_CRC_STATE_TIMEOUT   = 0x03U,  /*!< CRC timeout state                   */
  53.   HAL_CRC_STATE_ERROR     = 0x04U   /*!< CRC error state                     */
  54. } HAL_CRC_StateTypeDef;
  55.  
  56. /**
  57.   * @brief CRC Init Structure definition
  58.   */
  59. typedef struct
  60. {
  61. #if defined(CRC_POL_POL)
  62.   uint8_t DefaultPolynomialUse;       /*!< This parameter is a value of @ref CRC_Default_Polynomial and indicates if default polynomial is used.
  63.                                             If set to DEFAULT_POLYNOMIAL_ENABLE, resort to default
  64.                                             X^32 + X^26 + X^23 + X^22 + X^16 + X^12 + X^11 + X^10 +X^8 + X^7 + X^5 + X^4 + X^2+ X +1.
  65.                                             In that case, there is no need to set GeneratingPolynomial field.
  66.                                             If otherwise set to DEFAULT_POLYNOMIAL_DISABLE, GeneratingPolynomial and CRCLength fields must be set. */
  67. #endif /* CRC_POL_POL */
  68.  
  69.   uint8_t DefaultInitValueUse;        /*!< This parameter is a value of @ref CRC_Default_InitValue_Use and indicates if default init value is used.
  70.                                            If set to DEFAULT_INIT_VALUE_ENABLE, resort to default
  71.                                            0xFFFFFFFF value. In that case, there is no need to set InitValue field.
  72.                                            If otherwise set to DEFAULT_INIT_VALUE_DISABLE,  InitValue field must be set. */
  73.  
  74. #if defined(CRC_POL_POL)
  75.   uint32_t GeneratingPolynomial;      /*!< Set CRC generating polynomial as a 7, 8, 16 or 32-bit long value for a polynomial degree
  76.                                            respectively equal to 7, 8, 16 or 32. This field is written in normal representation,
  77.                                            e.g., for a polynomial of degree 7, X^7 + X^6 + X^5 + X^2 + 1 is written 0x65.
  78.                                            No need to specify it if DefaultPolynomialUse is set to DEFAULT_POLYNOMIAL_ENABLE.   */
  79.  
  80.   uint32_t CRCLength;                 /*!< This parameter is a value of @ref CRC_Polynomial_Sizes and indicates CRC length.
  81.                                            Value can be either one of
  82.                                            @arg @ref CRC_POLYLENGTH_32B                  (32-bit CRC),
  83.                                            @arg @ref CRC_POLYLENGTH_16B                  (16-bit CRC),
  84.                                            @arg @ref CRC_POLYLENGTH_8B                   (8-bit CRC),
  85.                                            @arg @ref CRC_POLYLENGTH_7B                   (7-bit CRC). */
  86. #endif /* CRC_POL_POL */
  87.  
  88.   uint32_t InitValue;                 /*!< Init value to initiate CRC computation. No need to specify it if DefaultInitValueUse
  89.                                            is set to DEFAULT_INIT_VALUE_ENABLE.   */
  90.  
  91.   uint32_t InputDataInversionMode;    /*!< This parameter is a value of @ref CRCEx_Input_Data_Inversion and specifies input data inversion mode.
  92.                                            Can be either one of the following values
  93.                                            @arg @ref CRC_INPUTDATA_INVERSION_NONE       no input data inversion
  94.                                            @arg @ref CRC_INPUTDATA_INVERSION_BYTE       byte-wise inversion, 0x1A2B3C4D becomes 0x58D43CB2
  95.                                            @arg @ref CRC_INPUTDATA_INVERSION_HALFWORD   halfword-wise inversion, 0x1A2B3C4D becomes 0xD458B23C
  96.                                            @arg @ref CRC_INPUTDATA_INVERSION_WORD       word-wise inversion, 0x1A2B3C4D becomes 0xB23CD458 */
  97.  
  98.   uint32_t OutputDataInversionMode;   /*!< This parameter is a value of @ref CRCEx_Output_Data_Inversion and specifies output data (i.e. CRC) inversion mode.
  99.                                             Can be either
  100.                                             @arg @ref CRC_OUTPUTDATA_INVERSION_DISABLE   no CRC inversion,
  101.                                             @arg @ref CRC_OUTPUTDATA_INVERSION_ENABLE    CRC 0x11223344 is converted into 0x22CC4488 */
  102. } CRC_InitTypeDef;
  103.  
  104. /**
  105.   * @brief  CRC Handle Structure definition
  106.   */
  107. typedef struct
  108. {
  109.   CRC_TypeDef                 *Instance;   /*!< Register base address        */
  110.  
  111.   CRC_InitTypeDef             Init;        /*!< CRC configuration parameters */
  112.  
  113.   HAL_LockTypeDef             Lock;        /*!< CRC Locking object           */
  114.  
  115.   __IO HAL_CRC_StateTypeDef   State;       /*!< CRC communication state      */
  116.  
  117.   uint32_t InputDataFormat;                /*!< This parameter is a value of @ref CRC_Input_Buffer_Format and specifies input data format.
  118.                                             Can be either
  119.                                             @arg @ref CRC_INPUTDATA_FORMAT_BYTES       input data is a stream of bytes (8-bit data)
  120.                                             @arg @ref CRC_INPUTDATA_FORMAT_HALFWORDS   input data is a stream of half-words (16-bit data)
  121.                                             @arg @ref CRC_INPUTDATA_FORMAT_WORDS       input data is a stream of words (32-bit data)
  122.  
  123.                                            Note that constant CRC_INPUT_FORMAT_UNDEFINED is defined but an initialization error
  124.                                            must occur if InputBufferFormat is not one of the three values listed above  */
  125. } CRC_HandleTypeDef;
  126. /**
  127.   * @}
  128.   */
  129.  
  130. /* Exported constants --------------------------------------------------------*/
  131. /** @defgroup CRC_Exported_Constants CRC Exported Constants
  132.   * @{
  133.   */
  134.  
  135. #if defined(CRC_POL_POL)
  136. /** @defgroup CRC_Default_Polynomial_Value    Default CRC generating polynomial
  137.   * @{
  138.   */
  139. #define DEFAULT_CRC32_POLY      0x04C11DB7U  /*!<  X^32 + X^26 + X^23 + X^22 + X^16 + X^12 + X^11 + X^10 +X^8 + X^7 + X^5 + X^4 + X^2+ X +1 */
  140. /**
  141.   * @}
  142.   */
  143. #endif /* CRC_POL_POL */
  144.  
  145. /** @defgroup CRC_Default_InitValue    Default CRC computation initialization value
  146.   * @{
  147.   */
  148. #define DEFAULT_CRC_INITVALUE   0xFFFFFFFFU  /*!< Initial CRC default value */
  149. /**
  150.   * @}
  151.   */
  152.  
  153. #if defined(CRC_POL_POL)
  154. /** @defgroup CRC_Default_Polynomial    Indicates whether or not default polynomial is used
  155.   * @{
  156.   */
  157. #define DEFAULT_POLYNOMIAL_ENABLE       ((uint8_t)0x00U)  /*!< Enable default generating polynomial 0x04C11DB7  */
  158. #define DEFAULT_POLYNOMIAL_DISABLE      ((uint8_t)0x01U)  /*!< Disable default generating polynomial 0x04C11DB7 */
  159. /**
  160.   * @}
  161.   */
  162. #endif /* CRC_POL_POL */
  163.  
  164. /** @defgroup CRC_Default_InitValue_Use    Indicates whether or not default init value is used
  165.   * @{
  166.   */
  167. #define DEFAULT_INIT_VALUE_ENABLE      ((uint8_t)0x00U) /*!< Enable initial CRC default value  */
  168. #define DEFAULT_INIT_VALUE_DISABLE     ((uint8_t)0x01U) /*!< Disable initial CRC default value */
  169. /**
  170.   * @}
  171.   */
  172.  
  173. #if defined(CRC_POL_POL)
  174. /** @defgroup CRC_Polynomial_Sizes Polynomial sizes to configure the peripheral
  175.   * @{
  176.   */
  177. #define CRC_POLYLENGTH_32B                  0x00000000U        /*!< Resort to a 32-bit long generating polynomial */
  178. #define CRC_POLYLENGTH_16B                  CRC_CR_POLYSIZE_0  /*!< Resort to a 16-bit long generating polynomial */
  179. #define CRC_POLYLENGTH_8B                   CRC_CR_POLYSIZE_1  /*!< Resort to a 8-bit long generating polynomial  */
  180. #define CRC_POLYLENGTH_7B                   CRC_CR_POLYSIZE    /*!< Resort to a 7-bit long generating polynomial  */
  181. /**
  182.   * @}
  183.   */
  184.  
  185. /** @defgroup CRC_Polynomial_Size_Definitions CRC polynomial possible sizes actual definitions
  186.   * @{
  187.   */
  188. #define HAL_CRC_LENGTH_32B     32U          /*!< 32-bit long CRC */
  189. #define HAL_CRC_LENGTH_16B     16U          /*!< 16-bit long CRC */
  190. #define HAL_CRC_LENGTH_8B       8U          /*!< 8-bit long CRC  */
  191. #define HAL_CRC_LENGTH_7B       7U          /*!< 7-bit long CRC  */
  192. /**
  193.   * @}
  194.   */
  195. #endif /* CRC_POL_POL */
  196.  
  197. /** @defgroup CRC_Input_Buffer_Format Input Buffer Format
  198.   * @{
  199.   */
  200. /* WARNING: CRC_INPUT_FORMAT_UNDEFINED is created for reference purposes but
  201.  * an error is triggered in HAL_CRC_Init() if InputDataFormat field is set
  202.  * to CRC_INPUT_FORMAT_UNDEFINED: the format MUST be defined by the user for
  203.  * the CRC APIs to provide a correct result */
  204. #define CRC_INPUTDATA_FORMAT_UNDEFINED             0x00000000U  /*!< Undefined input data format    */
  205. #define CRC_INPUTDATA_FORMAT_BYTES                 0x00000001U  /*!< Input data in byte format      */
  206. #define CRC_INPUTDATA_FORMAT_HALFWORDS             0x00000002U  /*!< Input data in half-word format */
  207. #define CRC_INPUTDATA_FORMAT_WORDS                 0x00000003U  /*!< Input data in word format      */
  208. /**
  209.   * @}
  210.   */
  211.  
  212. /** @defgroup CRC_Aliases CRC API aliases
  213.   * @{
  214.   */
  215. #define HAL_CRC_Input_Data_Reverse   HAL_CRCEx_Input_Data_Reverse    /*!< Aliased to HAL_CRCEx_Input_Data_Reverse for inter STM32 series compatibility  */
  216. #define HAL_CRC_Output_Data_Reverse  HAL_CRCEx_Output_Data_Reverse   /*!< Aliased to HAL_CRCEx_Output_Data_Reverse for inter STM32 series compatibility */
  217. /**
  218.   * @}
  219.   */
  220.  
  221. /**
  222.   * @}
  223.   */
  224.  
  225. /* Exported macros -----------------------------------------------------------*/
  226. /** @defgroup CRC_Exported_Macros CRC Exported Macros
  227.   * @{
  228.   */
  229.  
  230. /** @brief Reset CRC handle state.
  231.   * @param  __HANDLE__ CRC handle.
  232.   * @retval None
  233.   */
  234. #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET)
  235.  
  236. /**
  237.   * @brief  Reset CRC Data Register.
  238.   * @param  __HANDLE__ CRC handle
  239.   * @retval None
  240.   */
  241. #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET)
  242.  
  243. /**
  244.   * @brief  Set CRC INIT non-default value
  245.   * @param  __HANDLE__ CRC handle
  246.   * @param  __INIT__ 32-bit initial value
  247.   * @retval None
  248.   */
  249. #define __HAL_CRC_INITIALCRCVALUE_CONFIG(__HANDLE__, __INIT__) ((__HANDLE__)->Instance->INIT = (__INIT__))
  250.  
  251. /**
  252.   * @brief Store data in the Independent Data (ID) register.
  253.   * @param __HANDLE__ CRC handle
  254.   * @param __VALUE__  Value to be stored in the ID register
  255.   * @note  Refer to the Reference Manual to get the authorized __VALUE__ length in bits
  256.   * @retval None
  257.   */
  258. #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (WRITE_REG((__HANDLE__)->Instance->IDR, (__VALUE__)))
  259.  
  260. /**
  261.   * @brief Return the data stored in the Independent Data (ID) register.
  262.   * @param __HANDLE__ CRC handle
  263.   * @note  Refer to the Reference Manual to get the authorized __VALUE__ length in bits
  264.   * @retval Value of the ID register
  265.   */
  266. #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR)
  267. /**
  268.   * @}
  269.   */
  270.  
  271.  
  272. /* Private macros --------------------------------------------------------*/
  273. /** @defgroup  CRC_Private_Macros CRC Private Macros
  274.   * @{
  275.   */
  276.  
  277. #if defined(CRC_POL_POL)
  278. #define IS_DEFAULT_POLYNOMIAL(DEFAULT) (((DEFAULT) == DEFAULT_POLYNOMIAL_ENABLE) || \
  279.                                         ((DEFAULT) == DEFAULT_POLYNOMIAL_DISABLE))
  280. #endif /* CRC_POL_POL */
  281.  
  282. #define IS_DEFAULT_INIT_VALUE(VALUE)  (((VALUE) == DEFAULT_INIT_VALUE_ENABLE) || \
  283.                                        ((VALUE) == DEFAULT_INIT_VALUE_DISABLE))
  284.  
  285. #if defined(CRC_POL_POL)
  286. #define IS_CRC_POL_LENGTH(LENGTH)     (((LENGTH) == CRC_POLYLENGTH_32B) || \
  287.                                        ((LENGTH) == CRC_POLYLENGTH_16B) || \
  288.                                        ((LENGTH) == CRC_POLYLENGTH_8B)  || \
  289.                                        ((LENGTH) == CRC_POLYLENGTH_7B))
  290. #endif /* CRC_POL_POL */
  291.  
  292. #define IS_CRC_INPUTDATA_FORMAT(FORMAT)           (((FORMAT) == CRC_INPUTDATA_FORMAT_BYTES)     || \
  293.                                                    ((FORMAT) == CRC_INPUTDATA_FORMAT_HALFWORDS) || \
  294.                                                    ((FORMAT) == CRC_INPUTDATA_FORMAT_WORDS))
  295.  
  296. /**
  297.   * @}
  298.   */
  299.  
  300. /* Include CRC HAL Extended module */
  301. #include "stm32f0xx_hal_crc_ex.h"
  302.  
  303. /* Exported functions --------------------------------------------------------*/
  304. /** @defgroup CRC_Exported_Functions CRC Exported Functions
  305.   * @{
  306.   */
  307.  
  308. /* Initialization and de-initialization functions  ****************************/
  309. /** @defgroup CRC_Exported_Functions_Group1 Initialization and de-initialization functions
  310.   * @{
  311.   */
  312. HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
  313. HAL_StatusTypeDef HAL_CRC_DeInit(CRC_HandleTypeDef *hcrc);
  314. void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
  315. void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
  316. /**
  317.   * @}
  318.   */
  319.  
  320. /* Peripheral Control functions ***********************************************/
  321. /** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions
  322.   * @{
  323.   */
  324. uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
  325. uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
  326. /**
  327.   * @}
  328.   */
  329.  
  330. /* Peripheral State and Error functions ***************************************/
  331. /** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions
  332.   * @{
  333.   */
  334. HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
  335. /**
  336.   * @}
  337.   */
  338.  
  339. /**
  340.   * @}
  341.   */
  342.  
  343. /**
  344.   * @}
  345.   */
  346.  
  347. /**
  348.   * @}
  349.   */
  350.  
  351. #ifdef __cplusplus
  352. }
  353. #endif
  354.  
  355. #endif /* STM32F0xx_HAL_CRC_H */
  356.  
  357. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
  358.