Collaboration diagram for CommandSequence Functions:

Functions
IFX_EXTERN void	IfxFlash_clearStatus (uint32 flash)
	Performs the "Clear Status" sequence. Operation and error flags are cleared. More...

IFX_EXTERN void	IfxFlash_disableWriteProtection (uint32 flash, IfxFlash_UcbType ucb, uint32 *password)
	The password protection of the selected UCB (if this UCB offers this feature) is temporarily disabled. The command fails by setting PROER when any of the supplied PWs does not match. In this case until the next application reset all further calls of "Disable Protection" fail with PROER independent of the supplied password. More...

IFX_EXTERN uint8	IfxFlash_enterPageMode (uint32 pageAddr)
	Performs the sequence for entering program page mode. More...

IFX_EXTERN void	IfxFlash_eraseMultiplePhysicalSectors (uint32 sectorAddr, uint32 numSector)
	Performs the erase sequence for n sectors in program or data flash. More...

IFX_EXTERN void	IfxFlash_eraseMultipleSectors (uint32 sectorAddr, uint32 numSector)
	Performs the erase sequence for n sectors in program or data flash. More...

IFX_EXTERN void	IfxFlash_erasePhysicalSector (uint32 sectorAddr)
	Performs the erase sequence for a physical sector in program or data flash. More...

IFX_EXTERN void	IfxFlash_eraseSector (uint32 sectorAddr)
	Performs the erase sequence for a sector in program or data flash. More...

IFX_EXTERN void	IfxFlash_eraseVerifyMultipleSectors (uint32 sectorAddr, uint32 numSector)
	Performs the "Erase Verify" sequence for multiple sectors. More...

IFX_EXTERN void	IfxFlash_eraseVerifySector (uint32 sectorAddr)
	Performs the "Erase Verify" sequence. More...

IFX_EXTERN void	IfxFlash_loadPage (uint32 pageAddr, uint32 wordL, uint32 wordU)
	performs a load page sequence with a single 64bit access More...

IFX_EXTERN void	IfxFlash_loadPage2X32 (uint32 pageAddr, uint32 wordL, uint32 wordU)
	performs a load page sequence with two 32bit accesses More...

IFX_EXTERN void	IfxFlash_resetToRead (uint32 flash)
	reset to read mode More...

IFX_EXTERN void	IfxFlash_resumeProtection (uint32 flash)
	Performs the "Resume Protection" sequence. More...

IFX_EXTERN void	IfxFlash_suspendResumeMultipleSectors (uint32 sectorAddr, uint32 numSector)
	Performs the "Suspend Resume" sequence for multiple sectors. More...

IFX_EXTERN void	IfxFlash_suspendResumeSector (uint32 sectorAddr)
	Performs the "Suspend Resume" sequence. More...

IFX_EXTERN uint8	IfxFlash_waitUnbusy (uint32 flash, IfxFlash_FlashType flashType)
	Polls the selected status flag in flash status register until it turns to 0. More...

IFX_EXTERN void	IfxFlash_writeBurst (uint32 pageAddr)
	Performs the "Write Burst" sequence, similar to write page but performs a burst transfer instead of page.Make sure the appropriate amount of data is loaded using load page command. More...

IFX_EXTERN void	IfxFlash_writePage (uint32 pageAddr)
	Performs the "Write Page" sequence. More...

IFX_EXTERN void	IfxFlash_writePageOnce (uint32 pageAddr)
	Performs the "Write Page Once" sequence, similar to write page but performs a program verify after writing. More...

Detailed Description

Function Documentation

IFX_EXTERN void IfxFlash_clearStatus ( uint32 flash)

Performs the "Clear Status" sequence. Operation and error flags are cleared.

Parameters

flash selects the flash (PMU) module

Returns: None

Definition at line 42 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_disableWriteProtection	(	uint32	flash,
		IfxFlash_UcbType	ucb,
		uint32 *	password
	)

The password protection of the selected UCB (if this UCB offers this feature) is temporarily disabled. The command fails by setting PROER when any of the supplied PWs does not match. In this case until the next application reset all further calls of "Disable Protection" fail with PROER independent of the supplied password.

Parameters

flash	selects the flash (PMU) module
ucb	selects the user configuration block (0 for UCB0, 1 for UCB1, 5 for UCB_HSMC)
password	password pointer to an array of 8 words

Returns: None

Definition at line 70 of file IfxFlash.c.

IFX_EXTERN uint8 IfxFlash_enterPageMode ( uint32 pageAddr)

Performs the sequence for entering program page mode.

Parameters

pageAddr pageAddr specifies the page being written - the command sequence will be varied accordingly

Returns: 0 on success, != 0 if invalid or not available page is selected

Usage Example:

unsigned int pageAddr = IFXFLASH_DFLASH_START + page*IFXFLASH_DFLASH_PAGE_LENGTH;
// enter page mode
IfxFlash_enterPageMode(pageAddr);

Definition at line 86 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_eraseMultiplePhysicalSectors	(	uint32	sectorAddr,
		uint32	numSector
	)

Performs the erase sequence for n sectors in program or data flash.

Parameters

sectorAddr	sector address
numSector	the no.of sectors to be erased

Returns: None

Usage Example:

// erase the first and second data flash

IfxFlash_eraseMultiplePhysicalSectors(IFXFLASH_DFLASH_START,2);

Definition at line 106 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_eraseMultipleSectors	(	uint32	sectorAddr,
		uint32	numSector
	)

Performs the erase sequence for n sectors in program or data flash.

Parameters

sectorAddr	sector address
numSector	the no.of sectors to be erased

Returns: None

Usage Example:

// erase logical sectors of program flash

IfxFlash_eraseMultipleSectors(pFlashTableLog[sector].start,2);

Definition at line 122 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_erasePhysicalSector ( uint32 sectorAddr)

Performs the erase sequence for a physical sector in program or data flash.

Parameters

sectorAddr sector address

Returns: None

Usage Example:

// erase the first data flash

IfxFlash_erasePhysicalSector(IFXFLASH_DFLASH_START);

Definition at line 138 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_eraseSector ( uint32 sectorAddr)

Performs the erase sequence for a sector in program or data flash.

Parameters

sectorAddr sector address

Returns: None

Usage Example:

// erase all sectors of program flash
for(sector=0; sector<IFXFLASH_PFLASH_NO_OF_LOG_SECTORS; ++sector) {
  // get address from predefined table
  unsigned int sector_addr = pFlashTableLog[sector].start;
  // erase sector
 IfxFlash_eraseSector(sector_addr);
}

Definition at line 154 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_eraseVerifyMultipleSectors	(	uint32	sectorAddr,
		uint32	numSector
	)

Performs the "Erase Verify" sequence for multiple sectors.

Parameters

sectorAddr	sector address which should be verified
numSector	no.of sectors to be operated on

Returns: None

Definition at line 170 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_eraseVerifySector ( uint32 sectorAddr)

Performs the "Erase Verify" sequence.

Parameters

sectorAddr sector address which should be verified

Returns: None

Definition at line 186 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_loadPage	(	uint32	pageAddr,
		uint32	wordL,
		uint32	wordU
	)

performs a load page sequence with a single 64bit access

Parameters

pageAddr	pageAddr start address of page which should be programmed
wordL	Lower Address word
wordU	Upper address word

Returns: None

Usage Example:

// load 64bit into assembly buffer of program flash
IfxFlash_loadPage(IFXFLASH_PFLASH_START, 0x55555555, 0xaaaaaaaa);
// load 64bit into assembly buffer of data flash
IfxFlash_loadPage(0XAF000000, 0x55555555, 0xaaaaaaaa);

Definition at line 262 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_loadPage2X32	(	uint32	pageAddr,
		uint32	wordL,
		uint32	wordU
	)

performs a load page sequence with two 32bit accesses

Parameters

pageAddr	pageAddr start address of page which should be programmed
wordL	Lower Address word
wordU	Upper Address word

Returns: None

Usage Example:

// load 2*32bit into assembly buffer of program flash
IfxFlash_loadPage2X32(IFXFLASH_PFLASH_START, 0x55555555, 0xaaaaaaaa);
// load 2*32bit into assembly buffer of data flash
IfxFlash_loadPage2X32(0XAF000000, 0x55555555, 0xaaaaaaaa);

Definition at line 272 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_resetToRead ( uint32 flash)

reset to read mode

Parameters

flash flash selects the flash (PMU) module

Returns: None

Usage Example:

// reset to read mode

IfxFlash_resetToRead(0);

Definition at line 284 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_resumeProtection ( uint32 flash)

Performs the "Resume Protection" sequence.

Parameters

flash selects the flash (PMU) module

Returns: None

Definition at line 293 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_suspendResumeMultipleSectors	(	uint32	sectorAddr,
		uint32	numSector
	)

Performs the "Suspend Resume" sequence for multiple sectors.

Parameters

sectorAddr	sector address
numSector	the no.of sectors to be operated on

Returns: None

Definition at line 325 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_suspendResumeSector ( uint32 sectorAddr)

Performs the "Suspend Resume" sequence.

Parameters

sectorAddr sector address which should be resumed

Returns: None

Definition at line 341 of file IfxFlash.c.

IFX_EXTERN uint8 IfxFlash_waitUnbusy	(	uint32	flash,
		IfxFlash_FlashType	flashType
	)

Polls the selected status flag in flash status register until it turns to 0.

Parameters

flash	selects the flash (PMU) module
flashType	selects the flash type

Returns: 0 on success, != 0 if invalid or not available page is selected

Usage Example:

// wait until data flash 0 is unbusy

IfxFlash_waitUnbusy(0, IfxFlash_FlashType_D0);

Definition at line 357 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_writeBurst ( uint32 pageAddr)

Performs the "Write Burst" sequence, similar to write page but performs a burst transfer instead of page.Make sure the appropriate amount of data is loaded using load page command.

Parameters

pageAddr start address of page which should be programmed

Returns: None

Usage Example:

// program the second page of the first sector of the Program Flash

IfxFlash_writeBurst(0xa0000100);

Definition at line 381 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_writePage ( uint32 pageAddr)

Performs the "Write Page" sequence.

Parameters

pageAddr start address of page which should be programmed

Returns: None

Usage Example:

// program the second page of the first sector of the Program Flash

IfxFlash_writePage(0xa0000100);

Definition at line 397 of file IfxFlash.c.

IFX_EXTERN void IfxFlash_writePageOnce ( uint32 pageAddr)

Performs the "Write Page Once" sequence, similar to write page but performs a program verify after writing.

Parameters

pageAddr start address of page which should be programmed

Returns: None

Usage Example:

// program the second page of the first sector of the Program Flash

IfxFlash_writePageOnce(0xa0000100);

Definition at line 413 of file IfxFlash.c.