stm32g4xx_hal_crc.h

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_crc.h
  * @author  MCD Application Team
  * @brief   CRC HAL模块的头文件。
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2019 STMicroelectronics.
  * All rights reserved.
  *
  * This software is licensed under terms that can be found in the LICENSE file
  * in the root directory of this software component.
  * If no LICENSE file comes with this software, it is provided AS-IS.
  *
  ******************************************************************************
  */

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef STM32G4xx_HAL_CRC_H
#define STM32G4xx_HAL_CRC_H

#ifdef __cplusplus
extern "C" {
#endif

/* Includes ------------------------------------------------------------------*/
#include "stm32g4xx_hal_def.h"

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @addtogroup CRC
  * @{
  */

/* Exported types ------------------------------------------------------------*/
/** @defgroup CRC_Exported_Types CRC Exported Types
  * @{
  */

/**
  * @brief  CRC HAL状态结构定义
  */
typedef enum
{
  HAL_CRC_STATE_RESET     = 0x00U,  /*!< CRC尚未初始化或已禁用 */
  HAL_CRC_STATE_READY     = 0x01U,  /*!< CRC已初始化并准备就绪   */
  HAL_CRC_STATE_BUSY      = 0x02U,  /*!< CRC内部处理正在进行中     */
  HAL_CRC_STATE_TIMEOUT   = 0x03U,  /*!< CRC超时状态                   */
  HAL_CRC_STATE_ERROR     = 0x04U   /*!< CRC错误状态                     */
} HAL_CRC_StateTypeDef;

/**
  * @brief CRC初始化结构定义
  */
typedef struct
{
  uint8_t DefaultPolynomialUse;       /*!< 此参数是 @ref CRC_Default_Polynomial 的值，指示是否使用默认多项式。
                                            如果设置为 DEFAULT_POLYNOMIAL_ENABLE，则使用默认
                                            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。
                                            在这种情况下，无需设置 GeneratingPolynomial 字段。
                                            如果设置为 DEFAULT_POLYNOMIAL_DISABLE，则必须设置 GeneratingPolynomial 和
                                            CRCLength 字段。 */

  uint8_t DefaultInitValueUse;        /*!< 此参数是 @ref CRC_Default_InitValue_Use 的值，指示是否使用默认初始值。
                                           如果设置为 DEFAULT_INIT_VALUE_ENABLE，则使用默认
                                           0xFFFFFFFF 值。在这种情况下，无需设置 InitValue 字段。如果
                                           设置为 DEFAULT_INIT_VALUE_DISABLE，则必须设置 InitValue 字段。 */

  uint32_t GeneratingPolynomial;      /*!< 设置CRC生成多项式为7、8、16或32位长的值，分别对应
                                           7、8、16或32次多项式。此字段以正常
                                           表示法写入，例如，对于7次多项式，X^7 + X^6 + X^5 + X^2 + 1
                                           写为 0x65。如果 DefaultPolynomialUse 设置为
                                            DEFAULT_POLYNOMIAL_ENABLE，则无需指定。   */

  uint32_t CRCLength;                 /*!< 此参数是 @ref CRC_Polynomial_Sizes 的值，指示CRC长度。
                                           值可以是以下之一
                                           @arg @ref CRC_POLYLENGTH_32B                  (32位 CRC),
                                           @arg @ref CRC_POLYLENGTH_16B                  (16位 CRC),
                                           @arg @ref CRC_POLYLENGTH_8B                   (8位 CRC),
                                           @arg @ref CRC_POLYLENGTH_7B                   (7位 CRC). */

  uint32_t InitValue;                 /*!< 用于启动CRC计算的初始值。如果 DefaultInitValueUse
                                           设置为 DEFAULT_INIT_VALUE_ENABLE，则无需指定。   */

  uint32_t InputDataInversionMode;    /*!< 此参数是 @ref CRCEx_Input_Data_Inversion 的值，指定输入数据反转模式。
                                           可以是以下值之一
                                           @arg @ref CRC_INPUTDATA_INVERSION_NONE       无输入数据反转
                                           @arg @ref CRC_INPUTDATA_INVERSION_BYTE       逐字节反转，0x1A2B3C4D
                                           变为 0x58D43CB2
                                           @arg @ref CRC_INPUTDATA_INVERSION_HALFWORD   逐半字反转，
                                           0x1A2B3C4D 变为 0xD458B23C
                                           @arg @ref CRC_INPUTDATA_INVERSION_WORD       逐字反转，0x1A2B3C4D
                                           变为 0xB23CD458 */

  uint32_t OutputDataInversionMode;   /*!< 此参数是 @ref CRCEx_Output_Data_Inversion 的值，指定输出数据（即CRC）反转模式。
                                            可以是
                                            @arg @ref CRC_OUTPUTDATA_INVERSION_DISABLE   无CRC反转，
                                            @arg @ref CRC_OUTPUTDATA_INVERSION_ENABLE    CRC 0x11223344 被转换
                                             为 0x22CC4488 */
} CRC_InitTypeDef;

/**
  * @brief  CRC句柄结构定义
  */
typedef struct
{
  CRC_TypeDef                 *Instance;   /*!< 寄存器基地址        */

  CRC_InitTypeDef             Init;        /*!< CRC配置参数 */

  HAL_LockTypeDef             Lock;        /*!< CRC锁定对象           */

  __IO HAL_CRC_StateTypeDef   State;       /*!< CRC通信状态      */

  uint32_t InputDataFormat;                /*!< 此参数是 @ref CRC_Input_Buffer_Format 的值，指定输入数据格式。
                                            可以是
                                            @arg @ref CRC_INPUTDATA_FORMAT_BYTES       输入数据是字节流
                                            (8位数据)
                                            @arg @ref CRC_INPUTDATA_FORMAT_HALFWORDS   输入数据是半字流
                                            (16位数据)
                                            @arg @ref CRC_INPUTDATA_FORMAT_WORDS       输入数据是字流
                                            (32位数据)

                                          请注意，定义了常量 CRC_INPUT_FORMAT_UNDEFINED，但如果 InputBufferFormat 不是上述三个值之一，
                                          则必须在 HAL_CRC_Init() 中触发初始化错误：格式必须由用户定义，
                                          以便CRC API提供正确的结果 */
} CRC_HandleTypeDef;
/**
  * @}
  */

/* Exported constants --------------------------------------------------------*/
/** @defgroup CRC_Exported_Constants CRC Exported Constants
  * @{
  */

/** @defgroup CRC_Default_Polynomial_Value    Default CRC generating polynomial
  * @{
  */