Subversion Repositories ScreenTimer

Rev

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