Enhanced Embedded Flash Controller (EEFC)

Macros
#define	EEFC_ERROR_FLAGS   (EEFC_FSR_FLOCKE | EEFC_FSR_FCMDE)
#define	EEFC_FCR_FKEY_PASSWD   EEFC_FCR_FKEY(FWP_KEY)
#define	FWP_KEY   0x5Au

Functions
void	efc_disable_frdy_interrupt (Efc *p_efc)
	Disable the flash ready interrupt. More...
void	efc_enable_frdy_interrupt (Efc *p_efc)
	Enable the flash ready interrupt. More...
uint32_t	efc_get_flash_access_mode (Efc *p_efc)
	Get flash access mode. More...
uint32_t	efc_get_result (Efc *p_efc)
	Get the result of the last executed command. More...
uint32_t	efc_get_status (Efc *p_efc)
	Get the current status of the EEFC. More...
uint32_t	efc_get_wait_state (Efc *p_efc)
	Get flash wait state. More...
uint32_t	efc_init (Efc *p_efc, uint32_t ul_access_mode, uint32_t ul_fws)
	Initialize the EFC controller. More...
uint32_t	efc_perform_command (Efc *p_efc, uint32_t ul_command, uint32_t ul_argument)
	Perform the given command and wait until its completion (or an error). More...
uint32_t	efc_perform_fcr (Efc *p_efc, uint32_t ul_fcr)
	Perform command. More...
__no_inline RAMFUNC uint32_t	efc_perform_read_sequence (Efc *p_efc, uint32_t ul_cmd_st, uint32_t ul_cmd_sp, uint32_t *p_ul_buf, uint32_t ul_size)
	Perform read sequence. Supported sequences are read Unique ID and read User Signature. More...
void	efc_set_flash_access_mode (Efc *p_efc, uint32_t ul_mode)
	Set flash access mode. More...
void	efc_set_wait_state (Efc *p_efc, uint32_t ul_fws)
	Set flash wait state. More...
void	efc_write_fmr (Efc *p_efc, uint32_t ul_fmr)
	Set mode register. More...

Detailed Description

The Enhanced Embedded Flash Controller ensures the interface of the Flash block with the 32-bit internal bus.

Macro Definition Documentation

EEFC_ERROR_FLAGS

#define EEFC_ERROR_FLAGS   (EEFC_FSR_FLOCKE | EEFC_FSR_FCMDE)

Definition at line 96 of file efc.c.

EEFC_FCR_FKEY_PASSWD

#define EEFC_FCR_FKEY_PASSWD   EEFC_FCR_FKEY(FWP_KEY)

Definition at line 100 of file efc.c.

FWP_KEY

#define FWP_KEY   0x5Au

Definition at line 86 of file efc.c.

Function Documentation

efc_disable_frdy_interrupt()

void efc_disable_frdy_interrupt

(

Efc *

p_efc

)

Disable the flash ready interrupt.

Parameters

p_efc

Pointer to an EFC instance.

Definition at line 174 of file efc.c.

efc_enable_frdy_interrupt()

void efc_enable_frdy_interrupt

(

Efc *

p_efc

)

Enable the flash ready interrupt.

Parameters

p_efc

Pointer to an EFC instance.

Definition at line 162 of file efc.c.

efc_get_flash_access_mode()

uint32_t efc_get_flash_access_mode

(

Efc *

p_efc

)

Get flash access mode.

Parameters

p_efc

Pointer to an EFC instance.

Returns

0 for 128-bit or EEFC_FMR_FAM for 64-bit.

Definition at line 222 of file efc.c.

efc_get_result()

uint32_t efc_get_result

(

Efc *

p_efc

)

Get the result of the last executed command.

Parameters

p_efc

Pointer to an EFC instance.

Returns

The result of the last executed command.

Definition at line 307 of file efc.c.

efc_get_status()

uint32_t efc_get_status

(

Efc *

p_efc

)

Get the current status of the EEFC.

Note

This function clears the value of some status bits (FLOCKE, FCMDE).

Parameters

p_efc

Pointer to an EFC instance.

Returns

The current status.

Definition at line 295 of file efc.c.

efc_get_wait_state()

uint32_t efc_get_wait_state

(

Efc *

p_efc

)

Get flash wait state.

Parameters

p_efc

Pointer to an EFC instance.

Returns

The number of wait states in cycle (no shift).

Definition at line 248 of file efc.c.

efc_init()

uint32_t efc_init	(	Efc *	p_efc,
		uint32_t	ul_access_mode,
		uint32_t	ul_fws
	)

Initialize the EFC controller.

Parameters

ul_access_mode	0 for 128-bit, EEFC_FMR_FAM for 64-bit.
ul_fws	The number of wait states in cycle (no shift).

Returns

0 if successful.

Definition at line 119 of file efc.c.

efc_perform_command()

uint32_t efc_perform_command	(	Efc *	p_efc,
		uint32_t	ul_command,
		uint32_t	ul_argument
	)

Perform the given command and wait until its completion (or an error).

Note

Unique ID commands are not supported, use efc_perform_read_sequence.

Parameters

p_efc	Pointer to an EFC instance.
ul_command	Command to perform.
ul_argument	Optional command argument.

Note

This function will automatically choose to use IAP function.

Returns

0 if successful, otherwise returns an error code.

Definition at line 266 of file efc.c.

efc_perform_fcr()

__no_inline RAMFUNC uint32_t efc_perform_fcr	(	Efc *	p_efc,
		uint32_t	ul_fcr
	)

Perform command.

Parameters

p_efc	Pointer to an EFC instance.
ul_fcr	Flash command.

Returns

The current status.

Definition at line 418 of file efc.c.

efc_perform_read_sequence()

__no_inline RAMFUNC uint32_t efc_perform_read_sequence	(	Efc *	p_efc,
		uint32_t	ul_cmd_st,
		uint32_t	ul_cmd_sp,
		uint32_t *	p_ul_buf,
		uint32_t	ul_size
	)

Perform read sequence. Supported sequences are read Unique ID and read User Signature.

Parameters

p_efc	Pointer to an EFC instance.
ul_cmd_st	Start command to perform.
ul_cmd_sp	Stop command to perform.
p_ul_buf	Pointer to an data buffer.
ul_size	Buffer size.

Returns

0 if successful, otherwise returns an error code.

Definition at line 326 of file efc.c.

efc_set_flash_access_mode()

void efc_set_flash_access_mode	(	Efc *	p_efc,
		uint32_t	ul_mode
	)

Set flash access mode.

Parameters

p_efc	Pointer to an EFC instance.
ul_mode	0 for 128-bit, EEFC_FMR_FAM for 64-bit.

Definition at line 208 of file efc.c.

efc_set_wait_state()

void efc_set_wait_state	(	Efc *	p_efc,
		uint32_t	ul_fws
	)

Set flash wait state.

Parameters

p_efc	Pointer to an EFC instance.
ul_fws	The number of wait states in cycle (no shift).

Definition at line 234 of file efc.c.

efc_write_fmr()

__no_inline RAMFUNC void efc_write_fmr	(	Efc *	p_efc,
		uint32_t	ul_fmr
	)

Set mode register.

Parameters

p_efc	Pointer to an EFC instance.
ul_fmr	Value of mode register

Definition at line 403 of file efc.c.