stm32l4xx_hal_crc.h

Go to the documentation of this file.

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

#ifdef __cplusplus
extern "C" {
#endif

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

/* Exported types ------------------------------------------------------------*/
typedef enum
{
  HAL_CRC_STATE_RESET     = 0x00U,  
  HAL_CRC_STATE_READY     = 0x01U,  
  HAL_CRC_STATE_BUSY      = 0x02U,  
  HAL_CRC_STATE_TIMEOUT   = 0x03U,  
  HAL_CRC_STATE_ERROR     = 0x04U   
} HAL_CRC_StateTypeDef;

typedef struct
{
  uint8_t DefaultPolynomialUse;       
  uint8_t DefaultInitValueUse;        
  uint32_t GeneratingPolynomial;      
  uint32_t CRCLength;                 
  uint32_t InitValue;                 
  uint32_t InputDataInversionMode;    
  uint32_t OutputDataInversionMode;   
} CRC_InitTypeDef;

typedef struct
{
  CRC_TypeDef                 *Instance;   
  CRC_InitTypeDef             Init;        
  HAL_LockTypeDef             Lock;        
  __IO HAL_CRC_StateTypeDef   State;       
  uint32_t InputDataFormat;                
} CRC_HandleTypeDef;
/* Exported constants --------------------------------------------------------*/
#define DEFAULT_CRC32_POLY      0x04C11DB7U  
#define DEFAULT_CRC_INITVALUE   0xFFFFFFFFU  
#define DEFAULT_POLYNOMIAL_ENABLE       ((uint8_t)0x00U)  
#define DEFAULT_POLYNOMIAL_DISABLE      ((uint8_t)0x01U)  
#define DEFAULT_INIT_VALUE_ENABLE      ((uint8_t)0x00U) 
#define DEFAULT_INIT_VALUE_DISABLE     ((uint8_t)0x01U) 
#define CRC_POLYLENGTH_32B                  0x00000000U        
#define CRC_POLYLENGTH_16B                  CRC_CR_POLYSIZE_0  
#define CRC_POLYLENGTH_8B                   CRC_CR_POLYSIZE_1  
#define CRC_POLYLENGTH_7B                   CRC_CR_POLYSIZE    
#define HAL_CRC_LENGTH_32B     32U          
#define HAL_CRC_LENGTH_16B     16U          
#define HAL_CRC_LENGTH_8B       8U          
#define HAL_CRC_LENGTH_7B       7U          
/* WARNING: CRC_INPUT_FORMAT_UNDEFINED is created for reference purposes but
 * an error is triggered in HAL_CRC_Init() if InputDataFormat field is set
 * to CRC_INPUT_FORMAT_UNDEFINED: the format MUST be defined by the user for
 * the CRC APIs to provide a correct result */
#define CRC_INPUTDATA_FORMAT_UNDEFINED             0x00000000U  
#define CRC_INPUTDATA_FORMAT_BYTES                 0x00000001U  
#define CRC_INPUTDATA_FORMAT_HALFWORDS             0x00000002U  
#define CRC_INPUTDATA_FORMAT_WORDS                 0x00000003U  
#define HAL_CRC_Input_Data_Reverse   HAL_CRCEx_Input_Data_Reverse    
#define HAL_CRC_Output_Data_Reverse  HAL_CRCEx_Output_Data_Reverse   
/* Exported macros -----------------------------------------------------------*/

#define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET)

#define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET)

#define __HAL_CRC_INITIALCRCVALUE_CONFIG(__HANDLE__, __INIT__) ((__HANDLE__)->Instance->INIT = (__INIT__))

#define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (WRITE_REG((__HANDLE__)->Instance->IDR, (__VALUE__)))

#define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR)

/* Private macros --------------------------------------------------------*/
#define IS_DEFAULT_POLYNOMIAL(DEFAULT) (((DEFAULT) == DEFAULT_POLYNOMIAL_ENABLE) || \
                                        ((DEFAULT) == DEFAULT_POLYNOMIAL_DISABLE))


#define IS_DEFAULT_INIT_VALUE(VALUE)  (((VALUE) == DEFAULT_INIT_VALUE_ENABLE) || \
                                       ((VALUE) == DEFAULT_INIT_VALUE_DISABLE))

#define IS_CRC_POL_LENGTH(LENGTH)     (((LENGTH) == CRC_POLYLENGTH_32B) || \
                                       ((LENGTH) == CRC_POLYLENGTH_16B) || \
                                       ((LENGTH) == CRC_POLYLENGTH_8B)  || \
                                       ((LENGTH) == CRC_POLYLENGTH_7B))

#define IS_CRC_INPUTDATA_FORMAT(FORMAT)           (((FORMAT) == CRC_INPUTDATA_FORMAT_BYTES)     || \
                                                   ((FORMAT) == CRC_INPUTDATA_FORMAT_HALFWORDS) || \
                                                   ((FORMAT) == CRC_INPUTDATA_FORMAT_WORDS))

/* Include CRC HAL Extended module */
#include "stm32l4xx_hal_crc_ex.h"

/* Exported functions --------------------------------------------------------*/
/* Initialization and de-initialization functions  ****************************/
HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
HAL_StatusTypeDef HAL_CRC_DeInit(CRC_HandleTypeDef *hcrc);
void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
/* Peripheral Control functions ***********************************************/
uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
/* Peripheral State and Error functions ***************************************/
HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
#ifdef __cplusplus
}
#endif

#endif /* STM32L4xx_HAL_CRC_H */

/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/