Peripheral Control functions

Peripheral control functions. More...

Functions
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.

---

Detailed Description

Peripheral control functions.

  ==============================================================================
                      ##### Peripheral Control functions #####
  ==============================================================================
    [..]
    This subsection permits to configure the OTFDEC peripheral

---

Function Documentation

uint32_t HAL_OTFDEC_KeyCRCComputation

(

uint32_t *

pKey

)

Compute Key CRC.

Parameters:

pKey	pointer at set of keys

Return values:

CRC

value

Definition at line 757 of file stm32h7xx_hal_otfdec.c.

Referenced by HAL_OTFDEC_RegionSetKey().

HAL_StatusTypeDef HAL_OTFDEC_RegionConfig	(	OTFDEC_HandleTypeDef *	hotfdec,
		uint32_t	RegionIndex,
		OTFDEC_RegionConfigTypeDef *	Config,
		uint32_t	lock
	)

Set region configuration.

Note:

Region deciphering is enabled at the end of this function

Parameters:

hotfdec	pointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
RegionIndex	index of region that is configured
Config	pointer on structure containing the region configuration parameters
lock	configuration lock enable or disable parameter This parameter can be one of the following values: OTFDEC_REG_CONFIGR_LOCK_DISABLE OTFDEC region configuration is not locked OTFDEC_REG_CONFIGR_LOCK_ENABLE OTFDEC region configuration is locked

Return values:

HAL

state

Definition at line 696 of file stm32h7xx_hal_otfdec.c.

References assert_param, OTFDEC_RegionConfigTypeDef::EndAddress, __OTFDEC_HandleTypeDef::Instance, IS_OTFDEC_REGION_CONFIG_LOCK, IS_OTFDEC_REGIONINDEX, OTFDEC_RegionConfigTypeDef::Nonce, OTFDEC_REG_CONFIGR_LOCK_ENABLE, OTFDEC_REG_CONFIGR_REG_ENABLE, OTFDEC_RegionConfigTypeDef::StartAddress, and OTFDEC_RegionConfigTypeDef::Version.

HAL_StatusTypeDef HAL_OTFDEC_RegionDisable	(	OTFDEC_HandleTypeDef *	hotfdec,
		uint32_t	RegionIndex
	)

Disable region deciphering.

Parameters:

hotfdec	pointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
RegionIndex	index of region the deciphering is disabled

Note:

An error is reported when the configuration is locked.

Return values:

HAL

state

Definition at line 848 of file stm32h7xx_hal_otfdec.c.

References assert_param, __OTFDEC_HandleTypeDef::Instance, IS_OTFDEC_REGIONINDEX, OTFDEC_REG_CONFIGR_LOCK_ENABLE, and OTFDEC_REG_CONFIGR_REG_ENABLE.

HAL_StatusTypeDef HAL_OTFDEC_RegionEnable	(	OTFDEC_HandleTypeDef *	hotfdec,
		uint32_t	RegionIndex
	)

Enable region deciphering.

Parameters:

hotfdec	pointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
RegionIndex	index of region the deciphering is enabled

Note:

An error is reported when the configuration is locked.

Return values:

HAL

state

Definition at line 807 of file stm32h7xx_hal_otfdec.c.

References assert_param, __OTFDEC_HandleTypeDef::Instance, IS_OTFDEC_REGIONINDEX, OTFDEC_REG_CONFIGR_LOCK_ENABLE, and OTFDEC_REG_CONFIGR_REG_ENABLE.

HAL_StatusTypeDef HAL_OTFDEC_RegionKeyLock	(	OTFDEC_HandleTypeDef *	hotfdec,
		uint32_t	RegionIndex
	)

Lock region keys.

Note:

Writes to this region KEYRx registers are ignored until next OTFDEC reset.

Parameters:

hotfdec	pointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
RegionIndex	index of region the keys of which are locked

Return values:

HAL

state

Definition at line 550 of file stm32h7xx_hal_otfdec.c.

References assert_param, __OTFDEC_HandleTypeDef::Instance, and IS_OTFDEC_REGIONINDEX.

HAL_StatusTypeDef HAL_OTFDEC_RegionSetKey	(	OTFDEC_HandleTypeDef *	hotfdec,
		uint32_t	RegionIndex,
		uint32_t *	pKey
	)

Set region keys.

Parameters:

hotfdec	pointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
RegionIndex	index of region the keys of which are set
pKey	pointer at set of keys

Note:

The API reads the key CRC computed by the peripheral and compares it with that theoretically expected. An error is reported if they are different.

Return values:

HAL

state

Definition at line 584 of file stm32h7xx_hal_otfdec.c.

References assert_param, HAL_OTFDEC_KeyCRCComputation(), HAL_OTFDEC_RegionGetKeyCRC(), __OTFDEC_HandleTypeDef::Instance, and IS_OTFDEC_REGIONINDEX.

HAL_StatusTypeDef HAL_OTFDEC_RegionSetMode	(	OTFDEC_HandleTypeDef *	hotfdec,
		uint32_t	RegionIndex,
		uint32_t	mode
	)

Set region mode.

Parameters:

hotfdec	pointer to an OTFDEC_HandleTypeDef structure that contains the configuration information for OTFDEC module
RegionIndex	index of region the mode of which is set
mode	This parameter can be only: OTFDEC_REG_MODE_INSTRUCTION_ACCESSES_ONLY Only instruction accesses are decrypted OTFDEC_REG_MODE_DATA_ACCESSES_ONLY Only data accesses are decrypted OTFDEC_REG_MODE_INSTRUCTION_OR_DATA_ACCESSES All read accesses are decrypted (instruction or data) OTFDEC_REG_MODE_INSTRUCTION_ACCESSES_ONLY_WITH_CIPHER Only instruction accesses are decrypted with proprietary cipher activated

Return values:

HAL

state

Definition at line 657 of file stm32h7xx_hal_otfdec.c.

References assert_param, __OTFDEC_HandleTypeDef::Instance, IS_OTFDEC_REGION_OPERATING_MODE, and IS_OTFDEC_REGIONINDEX.