stm32h7xx_hal_otfdec.h File Reference

Header file of OTFDEC HAL module. More...

#include "stm32h7xx_hal_def.h"

Go to the source code of this file.

Data Structures
struct	OTFDEC_RegionConfigTypeDef
	OTFDEC region configuration structure definition. More...
struct	__OTFDEC_HandleTypeDef
	OTFDEC handle structure definition. More...
Defines
#define	OTFDEC_SEC_ERROR_INT   (OTFDEC_IER_SEIE )
#define	OTFDEC_EXE_ERROR_INT   ( OTFDEC_IER_XONEIE )
#define	OTFDEC_KEY_ERROR_INT   ( OTFDEC_IER_KEIE)
#define	OTFDEC_SEC_EXE_ERROR_INT   (OTFDEC_IER_SEIE|OTFDEC_IER_XONEIE )
#define	OTFDEC_SEC_KEY_ERROR_INT   (OTFDEC_IER_SEIE| OTFDEC_IER_KEIE)
#define	OTFDEC_EXE_KEY_ERROR_INT   ( OTFDEC_IER_XONEIE|OTFDEC_IER_KEIE)
#define	OTFDEC_ALL_INT   (OTFDEC_IER_SEIE|OTFDEC_IER_XONEIE|OTFDEC_IER_KEIE)
#define	OTFDEC_REG_CONFIGR_REG_DISABLE   0x00000000U
#define	OTFDEC_REG_CONFIGR_REG_ENABLE   OTFDEC_REG_CONFIGR_REG_EN
#define	OTFDEC_REG_CONFIGR_LOCK_DISABLE   0x00000000U
#define	OTFDEC_REG_CONFIGR_LOCK_ENABLE   OTFDEC_REG_CONFIGR_CONFIGLOCK
#define	OTFDEC_REG_MODE_INSTRUCTION_ACCESSES_ONLY   0x00000000U
#define	OTFDEC_REG_MODE_DATA_ACCESSES_ONLY   OTFDEC_REG_CONFIGR_MODE_0
#define	OTFDEC_REG_MODE_INSTRUCTION_OR_DATA_ACCESSES   OTFDEC_REG_CONFIGR_MODE_1
#define	OTFDEC_REG_MODE_INSTRUCTION_ACCESSES_ONLY_WITH_CIPHER   OTFDEC_REG_CONFIGR_MODE
#define	HAL_OTFDEC_ERROR_NONE   ((uint32_t)0x00000000U)
#define	HAL_OTFDEC_SECURITY_ERROR   ((uint32_t)0x00000001U)
#define	HAL_OTFDEC_EXECUTE_ERROR   ((uint32_t)0x00000002U)
#define	HAL_OTFDEC_KEY_ERROR   ((uint32_t)0x00000004U)
#define	HAL_OTFDEC_ERROR_INVALID_CALLBACK   ((uint32_t)0x00000008U)
#define	OTFDEC_REGION1   ((uint32_t)0x00000000U)
#define	OTFDEC_REGION2   ((uint32_t)0x00000001U)
#define	OTFDEC_REGION3   ((uint32_t)0x00000002U)
#define	OTFDEC_REGION4   ((uint32_t)0x00000003U)
#define	__HAL_OTFDEC_RESET_HANDLE_STATE(__HANDLE__)
	Reset OTFDEC handle state.
#define	__HAL_OTFDEC_ENABLE_IT(__HANDLE__, __INTERRUPT__)   SET_BIT(((__HANDLE__)->Instance->IER), (__INTERRUPT__))
	Enable OTFDEC peripheral interrupts combination.
#define	__HAL_OTFDEC_DISABLE_IT(__HANDLE__, __INTERRUPT__)   CLEAR_BIT(((__HANDLE__)->Instance->IER), (__INTERRUPT__))
	Disable OTFDEC peripheral interrupts combination.
#define	__HAL_OTFDEC_GET_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
	Check whether the specified combination of OTFDEC interrupt flags is set or not.
#define	__HAL_OTFDEC_CLEAR_FLAG(__HANDLE__, __FLAG__)   SET_BIT((__HANDLE__)->Instance->ICR, (__FLAG__))
	Clear the specified combination of OTFDEC interrupt flags.
#define	IS_OTFDEC_INTERRUPTS(__INT__)
	Verify the OTFDEC peripheral interrupts parameter.
#define	IS_OTFDEC_REGION_CONFIG_LOCK(__LOCK__)
	Verify the OTFDEC region configuration lock parameter.
#define	IS_OTFDEC_REGION_OPERATING_MODE(__MODE__)
	Verify the OTFDEC region operating mode.
#define	IS_OTFDEC_REGIONINDEX(__INDEX__)
	Verify the OTFDEC region index.
#define	IS_OTFDEC_ATTRIBUTE(__ATTRIBUTE__)
	Verify the OTFDEC configuration attributes.
Typedefs
typedef struct __OTFDEC_HandleTypeDef	OTFDEC_HandleTypeDef
	OTFDEC handle structure definition.
typedef void(*	pOTFDEC_CallbackTypeDef )(OTFDEC_HandleTypeDef *hotfdec)
	HAL OTFDEC Callback pointer definition.
Enumerations
enum	HAL_OTFDEC_StateTypeDef { HAL_OTFDEC_STATE_RESET = 0x00U, HAL_OTFDEC_STATE_READY = 0x01U, HAL_OTFDEC_STATE_BUSY = 0x02U }
	OTFDEC states structure definition. More...
enum	HAL_OTFDEC_CallbackIDTypeDef { HAL_OTFDEC_ERROR_CB_ID = 0x00U, HAL_OTFDEC_MSPINIT_CB_ID = 0x01U, HAL_OTFDEC_MSPDEINIT_CB_ID = 0x02U }
	HAL OTFDEC Callback ID enumeration definition. More...
Functions
HAL_StatusTypeDef	HAL_OTFDEC_Init (OTFDEC_HandleTypeDef *hotfdec)
	Initialize the OTFDEC peripheral and create the associated handle.
HAL_StatusTypeDef	HAL_OTFDEC_DeInit (OTFDEC_HandleTypeDef *hotfdec)
	DeInitialize the OTFDEC peripheral.
__weak void	HAL_OTFDEC_MspInit (OTFDEC_HandleTypeDef *hotfdec)
	Initialize the OTFDEC MSP.
__weak void	HAL_OTFDEC_MspDeInit (OTFDEC_HandleTypeDef *hotfdec)
	DeInitialize OTFDEC MSP.
HAL_StatusTypeDef	HAL_OTFDEC_RegisterCallback (OTFDEC_HandleTypeDef *hotfdec, HAL_OTFDEC_CallbackIDTypeDef CallbackID, pOTFDEC_CallbackTypeDef pCallback)
	Register a User OTFDEC Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_OTFDEC_UnRegisterCallback (OTFDEC_HandleTypeDef *hotfdec, HAL_OTFDEC_CallbackIDTypeDef CallbackID)
	Unregister a OTFDEC Callback OTFDEC callback is redirected to the weak predefined callback.
void	HAL_OTFDEC_IRQHandler (OTFDEC_HandleTypeDef *hotfdec)
	Handle OTFDEC interrupt request.
__weak void	HAL_OTFDEC_ErrorCallback (OTFDEC_HandleTypeDef *hotfdec)
	OTFDEC error callback.
HAL_StatusTypeDef	HAL_OTFDEC_RegionKeyLock (OTFDEC_HandleTypeDef *hotfdec, uint32_t RegionIndex)
	Lock region keys.
HAL_StatusTypeDef	HAL_OTFDEC_RegionSetKey (OTFDEC_HandleTypeDef *hotfdec, uint32_t RegionIndex, uint32_t *pKey)
	Set region keys.
HAL_StatusTypeDef	HAL_OTFDEC_RegionSetMode (OTFDEC_HandleTypeDef *hotfdec, uint32_t RegionIndex, uint32_t mode)
	Set region mode.
HAL_StatusTypeDef	HAL_OTFDEC_RegionConfig (OTFDEC_HandleTypeDef *hotfdec, uint32_t RegionIndex, OTFDEC_RegionConfigTypeDef *Config, uint32_t lock)
	Set region configuration.
uint32_t	HAL_OTFDEC_KeyCRCComputation (uint32_t *pKey)
	Compute Key CRC.
HAL_StatusTypeDef	HAL_OTFDEC_RegionEnable (OTFDEC_HandleTypeDef *hotfdec, uint32_t RegionIndex)
	Enable region deciphering.
HAL_StatusTypeDef	HAL_OTFDEC_RegionDisable (OTFDEC_HandleTypeDef *hotfdec, uint32_t RegionIndex)
	Disable region deciphering.
HAL_OTFDEC_StateTypeDef	HAL_OTFDEC_GetState (OTFDEC_HandleTypeDef *hotfdec)
	Return the OTFDEC state.
uint32_t	HAL_OTFDEC_RegionGetKeyCRC (OTFDEC_HandleTypeDef *hotfdec, uint32_t RegionIndex)
	Return region keys CRC.
HAL_StatusTypeDef	HAL_OTFDEC_RegionGetConfig (OTFDEC_HandleTypeDef *hotfdec, uint32_t RegionIndex, OTFDEC_RegionConfigTypeDef *Config)
	Return region configuration parameters.

---

Detailed Description

Header file of OTFDEC HAL module.

Author:

MCD Application Team

Attention:

Copyright (c) 2018 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.

Definition in file stm32h7xx_hal_otfdec.h.