Peripheral State and Errors functions

exFlash control functions More...

Typedefs
typedef hal_status_t(*	exflash_operation_func) (exflash_handle_t *p_exflash)
	HAL exFlash operation function.

Functions
hal_exflash_state_t	hal_exflash_get_state (exflash_handle_t *p_exflash)
	Return the exFlash handle state. More...
uint32_t	hal_exflash_get_error (exflash_handle_t *p_exflash)
	Return the exFlash error code. More...
void	hal_exflash_set_retry (exflash_handle_t *p_exflash, uint32_t retry)
	Set the exFlash internal process timeout value. More...
hal_status_t	hal_exflash_operation (exflash_handle_t *p_exflash, exflash_operation_func p_func_exflash_operation)
	Call user XIP Flash operation functon. More...

Detailed Description

exFlash control functions

 ===============================================================================
                      ##### Peripheral State and Errors functions #####
 ===============================================================================
    [..]
    This subsection provides a set of functions allowing to control the exFlash.
     (+) hal_exflash_get_state()API can be helpful to check in run-time the state of the exFlash peripheral.
     (+) hal_exflash_get_error() check in run-time Errors occurring during communication.
     (+) hal_exflash_set_timeout() set the timeout during internal process.

Function Documentation

hal_exflash_get_error()

uint32_t hal_exflash_get_error

(

exflash_handle_t *

p_exflash

)

Return the exFlash error code.

Parameters

[in]

p_exflash

Pointer to an exFlash handle which contains the configuration information for the specified exFlash module.

Returns

exFlash error code in bitmap format

hal_exflash_get_state()

hal_exflash_state_t hal_exflash_get_state

(

exflash_handle_t *

p_exflash

)

Return the exFlash handle state.

Parameters

[in]

p_exflash

Pointer to an exFlash handle which contains the configuration information for the specified exFlash module.

Return values

HAL_EXFLASH_STATE_RESET	Peripheral not initialized.
HAL_EXFLASH_STATE_READY	Peripheral initialized and ready for use.
HAL_EXFLASH_STATE_BUSY	Peripheral in indirect mode and busy.
HAL_EXFLASH_STATE_BUSY_WRITE	Peripheral in indirect mode with transmission ongoing.
HAL_EXFLASH_STATE_BUSY_READ	Peripheral in indirect mode with reception ongoing.
HAL_EXFLASH_STATE_BUSY_ERASE	Peripheral in indirect mode with erase ongoing.
HAL_EXFLASH_STATE_ERROR	Peripheral in error.

hal_exflash_operation()

hal_status_t hal_exflash_operation	(	exflash_handle_t *	p_exflash,
		exflash_operation_func	p_func_exflash_operation
	)

Call user XIP Flash operation functon.

Parameters

[in]	p_exflash	Pointer to an exFlash handle which contains the configuration information for the specified exFlash module.
[in]	p_func_exflash_operation	HAL exFlash operation function.

hal_exflash_set_retry()

void hal_exflash_set_retry	(	exflash_handle_t *	p_exflash,
		uint32_t	retry
	)

Set the exFlash internal process timeout value.

Parameters

[in]	p_exflash	Pointer to an exFlash handle which contains the configuration information for the specified exFlash module.
[in]	retry	Internal process repeat times value.