Flash Controller

Modules
	FLC_Registers

Macros
#define	MXC_FLASH_PAGE_MASK   ~(MXC_FLASH_PAGE_SIZE - 1)
#define	MXC_FLASH_PAGE_ADDR(page)   (MXC_FLASH_MEM_BASE + ((uint32_t)page * MXC_FLASH_PAGE_SIZE))

Functions
int	MXC_FLC_Init (void)
int	MXC_FLC_Busy (void)
int	MXC_FLC_MassErase (void)
int	MXC_FLC_PageErase (uint32_t address)
void	MXC_FLC_Read (int address, void *buffer, int len)
int	MXC_FLC_Write (uint32_t address, uint32_t length, uint32_t *buffer)
int	MXC_FLC_Write32 (uint32_t address, uint32_t data)
int	MXC_FLC_Write128 (uint32_t address, uint32_t *data)
int	MXC_FLC_EnableInt (uint32_t flags)
int	MXC_FLC_DisableInt (uint32_t flags)
int	MXC_FLC_GetFlags (void)
int	MXC_FLC_ClearFlags (uint32_t flags)
int	MXC_FLC_UnlockInfoBlock (uint32_t address)
int	MXC_FLC_LockInfoBlock (uint32_t address)

Detailed Description

Function Documentation

MXC_FLC_Busy()

int MXC_FLC_Busy

(

void

)

Checks if Flash controller is busy.

Reading or executing from flash is not possible if flash is busy with an erase or write operation.

Returns

If non-zero, flash operation is in progress

MXC_FLC_ClearFlags()

int MXC_FLC_ClearFlags

(

uint32_t

flags

)

Clear flash interrupt flags.

Note

Provide the bit position to clear, even if the flag is write-0-to-clear

Parameters

flags

Mask of flags to clear

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_FLC_DisableInt()

int MXC_FLC_DisableInt

(

uint32_t

flags

)

Disable flash interrupts.

Parameters

flags

Interrupts to disable

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_FLC_EnableInt()

int MXC_FLC_EnableInt

(

uint32_t

flags

)

Enable flash interrupts.

Parameters

flags

Interrupts to enable

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_FLC_GetFlags()

int MXC_FLC_GetFlags

(

void

)

Retrieve flash interrupt flags.

Returns

Mask of active flags.

MXC_FLC_Init()

int MXC_FLC_Init

(

void

)

Initializes the flash controller for erase/write operations.

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_FLC_LockInfoBlock()

int MXC_FLC_LockInfoBlock

(

uint32_t

address

)

Lock info block.

Parameters

[in]

address

The address in the info block needing written to

Returns

E_NO_ERROR If function is successful.

MXC_FLC_MassErase()

int MXC_FLC_MassErase

(

void

)

Erases the entire flash array.

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_FLC_PageErase()

int MXC_FLC_PageErase

(

uint32_t

address

)

Erases the page of flash at the specified address.

Parameters

address

Any address within the page to erase.

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_FLC_Read()

void MXC_FLC_Read	(	int	address,
		void *	buffer,
		int	len
	)

Read Data out of Flash from an address.

Parameters

[in]	address	The address to read from
	buffer	The buffer to read the data into
[in]	len	The length of the buffer

MXC_FLC_UnlockInfoBlock()

int MXC_FLC_UnlockInfoBlock

(

uint32_t

address

)

Unlock info block.

Parameters

[in]

address

The address in the info block needing written to

Returns

E_NO_ERROR If function is successful.

MXC_FLC_Write()

int MXC_FLC_Write	(	uint32_t	address,
		uint32_t	length,
		uint32_t *	buffer
	)

Writes data to flash.

Parameters

address	Address in flash to start writing from.
length	Number of bytes to be written.
buffer	Pointer to data to be written to flash.

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_FLC_Write128()

int MXC_FLC_Write128	(	uint32_t	address,
		uint32_t *	data
	)

Writes the specified 128-bits of data to flash.

Parameters

address	128-bit aligned address in flash to write.
data	pointer to data to be written to flash.

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_FLC_Write32()

int MXC_FLC_Write32	(	uint32_t	address,
		uint32_t	data
	)

Writes the specified 32-bit value to flash.

Parameters

address	32-bit aligned address in flash to write.
data	value to be written to flash.

Returns

E_NO_ERROR if successful, error if unsuccessful.