[flash.h] Flash

Functions
static uint32_t	FlashSectorSizeGet (void)
	Get size of a flash sector in number of bytes. More...
static uint32_t	FlashSizeGet (void)
	Get the size of the flash. More...
void	FlashPowerModeSet (uint32_t ui32PowerMode, uint32_t ui32BankGracePeriod, uint32_t ui32PumpGracePeriod)
	Set power mode. More...
uint32_t	FlashPowerModeGet (void)
	Get current configured power mode. More...
void	FlashProtectionSet (uint32_t ui32SectorAddress, uint32_t ui32ProtectMode)
	Set sector protection. More...
uint32_t	FlashProtectionGet (uint32_t ui32SectorAddress)
	Get sector protection. More...
uint32_t	FlashProtectionSave (uint32_t ui32SectorAddress)
	Save sector protection to make it permanent. More...
static uint32_t	FlashCheckFsmForError (void)
	Checks if the Flash state machine has detected an error. More...
static uint32_t	FlashCheckFsmForReady (void)
	Checks if the Flash state machine is ready. More...
static void	FlashIntRegister (void(*pfnHandler)(void))
	Registers an interrupt handler for the flash interrupt in the dynamic interrupt table. More...
static void	FlashIntUnregister (void)
	Unregisters the interrupt handler for the flash interrupt in the dynamic interrupt table. More...
static void	FlashIntEnable (uint32_t ui32IntFlags)
	Enables flash controller interrupt sources. More...
static void	FlashIntDisable (uint32_t ui32IntFlags)
	Disables individual flash controller interrupt sources. More...
static uint32_t	FlashIntStatus (void)
	Gets the current interrupt status. More...
static void	FlashIntClear (uint32_t ui32IntFlags)
	Clears flash controller interrupt source. More...
uint32_t	FlashSectorErase (uint32_t ui32SectorAddress)
	Erase a flash sector. More...
uint32_t	FlashProgram (uint8_t *pui8DataBuffer, uint32_t ui32Address, uint32_t ui32Count)
	Programs unprotected flash sectors in the main bank. More...
bool	FlashEfuseReadRow (uint32_t *pui32EfuseData, uint32_t ui32RowAddress)
	Reads efuse data from specified row. More...
void	FlashDisableSectorsForWrite (void)
	Disables all sectors for erase and programming on the active bank. More...

Enumerations
enum	tFlashStateCommandsType {   FAPI_PROGRAM_DATA = 0x0002, FAPI_ERASE_SECTOR = 0x0006, FAPI_ERASE_BANK = 0x0008, FAPI_VALIDATE_SECTOR = 0x000E,   FAPI_CLEAR_STATUS = 0x0010, FAPI_PROGRAM_RESUME = 0x0014, FAPI_ERASE_RESUME = 0x0016, FAPI_CLEAR_MORE = 0x0018,   FAPI_PROGRAM_SECTOR = 0x0020, FAPI_ERASE_OTP = 0x0030 }
	Defined values for Flash State Machine commands. More...

Detailed Description

Function Documentation

static uint32_t FlashCheckFsmForError ( void  )

inlinestatic

Checks if the Flash state machine has detected an error.

This function returns the status of the Flash State Machine indicating if an error is detected or not. Primary use is to check if an Erase or Program operation has failed.

Note

Please note that code can not execute in flash while any part of the flash is being programmed or erased. This function must be called from ROM or SRAM while any part of the flash is being programmed or erased.

Returns

Returns status of Flash state machine:

• FAPI_STATUS_FSM_ERROR
• FAPI_STATUS_SUCCESS

{
    if(HWREG(FLASH_BASE + FLASH_O_FMSTAT) & FLASH_FMSTAT_CSTAT)
    {
        return(FAPI_STATUS_FSM_ERROR);
    }
    else
    {
        return(FAPI_STATUS_SUCCESS);
    }
}

static uint32_t FlashCheckFsmForReady ( void  )

inlinestatic

Checks if the Flash state machine is ready.

This function returns the status of the Flash State Machine indicating if it is ready to accept a new command or not. Primary use is to check if an Erase or Program operation has finished.

Note

Please note that code can not execute in flash while any part of the flash is being programmed or erased. This function must be called from ROM or SRAMh while any part of the flash is being programmed or erased.

Returns

Returns readiness status of Flash state machine:

• FAPI_STATUS_FSM_READY
• FAPI_STATUS_FSM_BUSY

{
    if(HWREG(FLASH_BASE + FLASH_O_STAT) & FLASH_STAT_BUSY)
    {
        return(FAPI_STATUS_FSM_BUSY);
    }
    else
    {
        return(FAPI_STATUS_FSM_READY);
    }
}

void FlashDisableSectorsForWrite

(

void

)

Disables all sectors for erase and programming on the active bank.

This function disables all sectors for erase and programming on the active bank and enables the Idle Reading Power reduction mode if no low power mode is configured. Furthermore, an additional level of protection from erase is enabled.

Note

Please note that code can not execute in flash while any part of the flash is being programmed or erased.

Returns

None

{
    // Configure flash back to read mode
    SetReadMode();

    // Disable Level 1 Protection.
    HWREG(FLASH_BASE + FLASH_O_FBPROT) = FLASH_FBPROT_PROTL1DIS;

    // Disable all sectors for erase and programming.
    HWREG(FLASH_BASE + FLASH_O_FBSE) = 0x0000;

    // Enable Level 1 Protection.
    HWREG(FLASH_BASE + FLASH_O_FBPROT) = 0;

    // Protect sectors from sector erase.
    HWREG(FLASH_BASE + FLASH_O_FSM_WR_ENA) = FSM_REG_WRT_ENABLE;
    HWREG(FLASH_BASE + FLASH_O_FSM_SECTOR1) = 0xFFFFFFFF;
    HWREG(FLASH_BASE + FLASH_O_FSM_SECTOR2) = 0xFFFFFFFF;
    HWREG(FLASH_BASE + FLASH_O_FSM_WR_ENA) = FSM_REG_WRT_DISABLE;
}

Here is the call graph for this function:

bool FlashEfuseReadRow	(	uint32_t *	pui32EfuseData,
		uint32_t	ui32RowAddress
	)

Reads efuse data from specified row.

This function will read one efuse row. It is assumed that any previous efuse operation has finished.

Parameters

pui32EfuseData	is pointer to variable to be updated with efuse data.
ui32RowAddress	is the efuse row number to be read. First row is row number 0.

Returns

Returns the status of the efuse read operation.

• false : OK status.
• true : Error status

{
    bool bStatus;

    // Make sure the clock for the efuse is enabled
    HWREG(FLASH_BASE + FLASH_O_CFG) &= ~FLASH_CFG_DIS_EFUSECLK;

    // Set timing for EFUSE read operations.
    HWREG(FLASH_BASE + FLASH_O_EFUSEREAD) |= ((5 << FLASH_EFUSEREAD_READCLOCK_S) &
            FLASH_EFUSEREAD_READCLOCK_M);

    // Clear status register.
    HWREG(FLASH_BASE + FLASH_O_EFUSEERROR) = 0;

    // Select the FuseROM block 0.
    HWREG(FLASH_BASE + FLASH_O_EFUSEADDR) = 0x00000000;

    // Start the read operation.
    HWREG(FLASH_BASE + FLASH_O_EFUSE) =
        (DUMPWORD_INSTR << FLASH_EFUSE_INSTRUCTION_S) |
        (ui32RowAddress & FLASH_EFUSE_DUMPWORD_M);

    // Wait for operation to finish.
    while(!(HWREG(FLASH_BASE + FLASH_O_EFUSEERROR) & FLASH_EFUSEERROR_DONE))
    {
    }

    // Check if error reported.
    if(HWREG(FLASH_BASE + FLASH_O_EFUSEERROR) & FLASH_EFUSEERROR_CODE_M)
    {
        // Set error status.
        bStatus = 1;

        // Clear data.
        *pui32EfuseData = 0;
    }
    else
    {
        // Set ok status.
        bStatus = 0;

        // No error. Get data from data register.
        *pui32EfuseData = HWREG(FLASH_BASE + FLASH_O_DATALOWER);
    }

    // Disable the efuse clock to conserve power
    HWREG(FLASH_BASE + FLASH_O_CFG) |= FLASH_CFG_DIS_EFUSECLK;

    // Return the data.
    return(bStatus);
}

static void FlashIntClear ( uint32_t  ui32IntFlags )

inlinestatic

Clears flash controller interrupt source.

The flash controller interrupt source is cleared, so that it no longer asserts. This must be done in the interrupt handler to keep it from being called again immediately upon exit.

Note

Due to write buffers and synchronizers in the system it may take several clock cycles from a register write clearing an event in a module and until the event is actually cleared in the NVIC of the system CPU. It is recommended to clear the event source early in the interrupt service routine (ISR) to allow the event clear to propagate to the NVIC before returning from the ISR. At the same time, an early event clear allows new events of the same type to be pended instead of ignored if the event is cleared later in the ISR. It is the responsibility of the programmer to make sure that enough time has passed before returning from the ISR to avoid false re-triggering of the cleared event. A simple, although not necessarily optimal, way of clearing an event before returning from the ISR is:

1. Write to clear event (interrupt source). (buffered write)
2. Dummy read from the event source module. (making sure the write has propagated)
3. Wait two system CPU clock cycles (user code or two NOPs). (allowing cleared event to propagate through any synchronizers)

Parameters

ui32IntFlags

is the bit mask of the interrupt sources to be cleared. Can be any of: FLASH_INT_FSM_DONE FLASH_INT_RV

Returns

None

{
    uint32_t ui32TempVal;

    ui32TempVal = 0;

    if(ui32IntFlags & FLASH_INT_FSM_DONE)
    {
        ui32TempVal = FLASH_FEDACSTAT_FSM_DONE;
    }

    if(ui32IntFlags & FLASH_INT_RV)
    {
        ui32TempVal |= FLASH_FEDACSTAT_RVF_INT;
    }

    // Clear the flash interrupt source.
    HWREG(FLASH_BASE + FLASH_O_FEDACSTAT) = ui32TempVal;
}

static void FlashIntDisable ( uint32_t  ui32IntFlags )

inlinestatic

Disables individual flash controller interrupt sources.

This function disables the flash controller interrupt sources.

Parameters

ui32IntFlags

is the bit mask of the interrupt sources to be disabled. The parameter is the bitwise OR of any of the following: FLASH_INT_FSM_DONE : FSM Done interrupt. FLASH_INT_RV : Read verify error interrupt.

Returns

None

{
    HWREG(FLASH_BASE + FLASH_O_FSM_WR_ENA) = FSM_REG_WRT_ENABLE;
    HWREG(FLASH_BASE + FLASH_O_FSM_ST_MACHINE) &= ~ui32IntFlags;
    HWREG(FLASH_BASE + FLASH_O_FSM_WR_ENA) = FSM_REG_WRT_DISABLE;
}

static void FlashIntEnable ( uint32_t  ui32IntFlags )

inlinestatic

Enables flash controller interrupt sources.

This function enables the flash controller interrupt sources.

Parameters

ui32IntFlags

is the bit mask of the interrupt sources to be enabled. The parameter is the bitwise OR of any of the following: FLASH_INT_FSM_DONE : FSM Done interrupt. FLASH_INT_RV : Read verify error interrupt.

Returns

None

{
    HWREG(FLASH_BASE + FLASH_O_FSM_WR_ENA) = FSM_REG_WRT_ENABLE;
    HWREG(FLASH_BASE + FLASH_O_FSM_ST_MACHINE) |= ui32IntFlags;
    HWREG(FLASH_BASE + FLASH_O_FSM_WR_ENA) = FSM_REG_WRT_DISABLE;
}

static void FlashIntRegister ( void(*)(void)  pfnHandler )

inlinestatic

Registers an interrupt handler for the flash interrupt in the dynamic interrupt table.

Note

Only use this function if you want to use the dynamic vector table (in SRAM)!

This function registers a function as the interrupt handler for a specific interrupt and enables the corresponding interrupt in the interrupt controller.

Specific FLASH interrupts must be enabled via FlashIntEnable(). It is the interrupt handler's responsibility to clear the interrupt source.

Parameters

pfnHandler

is a pointer to the function to be called when the flash interrupt occurs.

Returns

None

See also

IntRegister() for important information about registering interrupt handlers.

{
    // Register the interrupt handler.
    IntRegister(INT_FLASH, pfnHandler);

    // Enable the flash interrupt.
    IntEnable(INT_FLASH);
}

Here is the call graph for this function:

static uint32_t FlashIntStatus ( void  )

inlinestatic

Gets the current interrupt status.

This function returns the interrupt status for the Flash.

Returns

Returns the current interrupt status as values described in FlashIntEnable().

{
    uint32_t ui32IntFlags;

    ui32IntFlags = 0;

    // Check if FSM_DONE interrupt status is set.
    if(HWREG(FLASH_BASE + FLASH_O_FEDACSTAT) & FLASH_FEDACSTAT_FSM_DONE)
    {
        ui32IntFlags = FLASH_INT_FSM_DONE;
    }

    // Check if RVF_INT interrupt status is set.
    if(HWREG(FLASH_BASE + FLASH_O_FEDACSTAT) & FLASH_FEDACSTAT_RVF_INT)
    {
        ui32IntFlags |= FLASH_INT_RV;
    }

    return(ui32IntFlags);
}

static void FlashIntUnregister ( void  )

inlinestatic

Unregisters the interrupt handler for the flash interrupt in the dynamic interrupt table.

This function does the actual unregistering of the interrupt handler. It clears the handler to be called when a FLASH interrupt occurs. This function also masks off the interrupt in the interrupt controller so that the interrupt handler no longer is called.

Returns

None

See also

IntRegister() for important information about registering interrupt handlers.

{
    // Disable the interrupts.
    IntDisable(INT_FLASH);

    // Unregister the interrupt handler.
    IntUnregister(INT_FLASH);
}

Here is the call graph for this function:

uint32_t FlashPowerModeGet

(

void

)

Get current configured power mode.

This function will return the current configured power mode.

Returns

Returns the current configured power mode. The defined power modes are:

• FLASH_PWR_ACTIVE_MODE
• FLASH_PWR_OFF_MODE
• FLASH_PWR_DEEP_STDBY_MODE (Not to be used. This mode is deprecated.)

{
    uint32_t ui32PowerMode;
    uint32_t ui32BankPwrMode;

    ui32BankPwrMode = HWREG(FLASH_BASE + FLASH_O_FBFALLBACK) &
                      FLASH_FBFALLBACK_BANKPWR0_M;

    if((ui32BankPwrMode == FBFALLBACK_SLEEP) &&
       ((HWREG(FLASH_BASE + FLASH_O_FWFLAG) & FW_PWRMODE_DEPRECATED) == FW_PWRMODE_DEPRECATED))
    {
        ui32PowerMode = FLASH_PWR_DEEP_STDBY_MODE;
    }
    else if((ui32BankPwrMode == FBFALLBACK_SLEEP) &&
            ((HWREG(FLASH_BASE + FLASH_O_FWFLAG) & FW_PWRMODE_DEPRECATED) == 0))
    {
        ui32PowerMode = FLASH_PWR_OFF_MODE;
    }
    else
    {
        ui32PowerMode = FLASH_PWR_ACTIVE_MODE;
    }

    // Return power mode.
    return(ui32PowerMode);
}

void FlashPowerModeSet	(	uint32_t	ui32PowerMode,
		uint32_t	ui32BankGracePeriod,
		uint32_t	ui32PumpGracePeriod
	)

Set power mode.

This function will set the specified power mode.

Any access to the bank causes a reload of the specified bank grace period input value into the bank down counter. After the last access to the flash bank, the down counter delays from 0 to 255 prescaled HCLK clock cycles before putting the bank into one of the fallback power modes as determined by ui32PowerMode. This value must be greater than 1 when the fallback mode is not FLASH_PWR_ACTIVE_MODE.

Note: The prescaled clock used for the down counter is a clock divided by 16 from input HCLK. The ui32BankGracePeriod parameter is ignored if ui32PowerMode is equal to FLASH_PWR_ACTIVE_MODE. Any access to flash memory causes the pump grace period down counter to reload with value of ui32PumpGracePeriod. After the bank has gone to sleep, the down counter delays this number of prescaled HCLK clock cycles before entering one of the charge pump fallback power modes as determined by ui32PowerMode. The prescaled clock used for the pump grace period down counter is a clock divided by 16 from input HCLK. This parameter is ignored if ui32PowerMode is equal to FLASH_PWR_ACTIVE_MODE.

Note: The FLASH_PWR_DEEP_STDBY_MODE power mode is deprecated and shall not be used. When used this mode will force the same power mode as for FLASH_PWR_OFF_MODE.

Changing the power mode of the flash module must be a part within a device power mode transition requiring configuration of multiple modules. Refer to documents describing the device power modes.

Parameters

ui32PowerMode	is the wanted power mode. The defined flash power modes are: FLASH_PWR_ACTIVE_MODE FLASH_PWR_OFF_MODE FLASH_PWR_DEEP_STDBY_MODE (Not to be used. This mode is deprecated.)
ui32BankGracePeriod	is the starting count value for the bank grace period down counter.
ui32PumpGracePeriod	is the starting count value for the pump grace period down counter.

Returns

None

{
    // Check the arguments.
    ASSERT(ui32PowerMode == FLASH_PWR_ACTIVE_MODE ||
           ui32PowerMode == FLASH_PWR_OFF_MODE    ||
           ui32PowerMode == FLASH_PWR_DEEP_STDBY_MODE);
    ASSERT(ui32BankGracePeriod <= 0xFF);
    ASSERT(ui32PumpGracePeriod <= 0xFFFF);

    // Initialize flag requesting deprecated power mode
    HWREG(FLASH_BASE + FLASH_O_FWLOCK) = 5;
    HWREG(FLASH_BASE + FLASH_O_FWFLAG) &= ~FW_PWRMODE_DEPRECATED;
    HWREG(FLASH_BASE + FLASH_O_FWLOCK) = 0;

    switch(ui32PowerMode)
    {
    case FLASH_PWR_ACTIVE_MODE:
        // Set bank power mode to ACTIVE.
        HWREG(FLASH_BASE + FLASH_O_FBFALLBACK) =
            (HWREG(FLASH_BASE + FLASH_O_FBFALLBACK) &
             ~FLASH_FBFALLBACK_BANKPWR0_M) | FBFALLBACK_ACTIVE;

        // Set charge pump power mode to ACTIVE mode.
        HWREG(FLASH_BASE + FLASH_O_FPAC1) =
            (HWREG(FLASH_BASE + FLASH_O_FPAC1) & ~FLASH_FPAC1_PUMPPWR_M) | (1 << FLASH_FPAC1_PUMPPWR_S);
        break;

    case FLASH_PWR_DEEP_STDBY_MODE:
        // Deprecated power mode requested. Set flag.
        HWREG(FLASH_BASE + FLASH_O_FWLOCK) = 5;
        HWREG(FLASH_BASE + FLASH_O_FWFLAG) |= FW_PWRMODE_DEPRECATED;
        HWREG(FLASH_BASE + FLASH_O_FWLOCK) = 0;
        // Fall through to force FLASH_PWR_OFF_MODE power mode
    case FLASH_PWR_OFF_MODE:
        // Set bank grace period.
        HWREG(FLASH_BASE + FLASH_O_FBAC) =
            (HWREG(FLASH_BASE + FLASH_O_FBAC) & (~FLASH_FBAC_BAGP_M)) |
            ((ui32BankGracePeriod << FLASH_FBAC_BAGP_S) & FLASH_FBAC_BAGP_M);

        // Set pump grace period.
        HWREG(FLASH_BASE + FLASH_O_FPAC2) =
            (HWREG(FLASH_BASE + FLASH_O_FPAC2) & (~FLASH_FPAC2_PAGP_M)) |
            ((ui32PumpGracePeriod << FLASH_FPAC2_PAGP_S) & FLASH_FPAC2_PAGP_M);

        // Set bank power mode to SLEEP.
        HWREG(FLASH_BASE + FLASH_O_FBFALLBACK) &= ~FLASH_FBFALLBACK_BANKPWR0_M;

        // Set charge pump power mode to SLEEP mode.
        HWREG(FLASH_BASE + FLASH_O_FPAC1) &= ~FLASH_FPAC1_PUMPPWR_M;
        break;
    }
}

uint32_t FlashProgram	(	uint8_t *	pui8DataBuffer,
		uint32_t	ui32Address,
		uint32_t	ui32Count
	)

Programs unprotected flash sectors in the main bank.

This function programs a sequence of bytes into the on-chip flash. Programming each location consists of the result of an AND operation of the new data and the existing data; in other words bits that contain 1 can remain 1 or be changed to 0, but bits that are 0 cannot be changed to 1. Therefore, a byte can be programmed multiple times as long as these rules are followed; if a program operation attempts to change a 0 bit to a 1 bit, that bit will not have its value changed.

This function does not return until the data has been programmed or a programming error occurs.

Note

It is recommended to disable cache and line buffer before programming the flash. Cache and line buffer are not automatically updated if a flash program causes a mismatch between new flash content and old content in cache and line buffer. Remember to enable cache and line buffer when the program operation completes. See VIMSModeSafeSet(), VIMSLineBufDisable(), and VIMSLineBufEnable() for more information.

Warning

Please note that code can not execute in flash while any part of the flash is being programmed or erased. The application must disable interrupts that have interrupt routines in flash. This function calls a ROM function which handles the actual program operation.

The pui8DataBuffer pointer can not point to flash.

Parameters

pui8DataBuffer	is a pointer to the data to be programmed.
ui32Address	is the starting address in flash to be programmed.
ui32Count	is the number of bytes to be programmed.

Returns

Returns status of the flash programming:

• FAPI_STATUS_SUCCESS : Success.
• FAPI_STATUS_INCORRECT_DATABUFFER_LENGTH : Too many bytes were requested.
• FAPI_STATUS_FSM_ERROR : A programming error is encountered.

Referenced by FlashProtectionSave().

{
    uint32_t ui32ErrorReturn;
    FlashPrgPointer_t FuncPointer;

    // Check the arguments.
    ASSERT((ui32Address + ui32Count) <= (FLASHMEM_BASE + FlashSizeGet()));

    // Call ROM function that handles the actual program operation
    FuncPointer = (uint32_t (*)(uint8_t *, uint32_t, uint32_t)) (ROM_API_FLASH_TABLE[6]);
    ui32ErrorReturn = FuncPointer( pui8DataBuffer, ui32Address, ui32Count);

    // Enable standby in flash bank since ROM function might have disabled it
    HWREGBITW(FLASH_BASE + FLASH_O_CFG, FLASH_CFG_DIS_STANDBY_BITN ) = 0;

    // Return status of operation.
    return(ui32ErrorReturn);

}

Here is the call graph for this function:

uint32_t FlashProtectionGet

(

uint32_t

ui32SectorAddress

)

Get sector protection.

This return the protection mode for the specified flash bank sector.

Parameters

ui32SectorAddress

is the start address of the desired sector.

Returns

Returns the sector protection:

• FLASH_NO_PROTECT
• FLASH_WRITE_PROTECT

Referenced by FlashProtectionSave().

{
    uint32_t ui32SectorProtect;
    uint32_t ui32SectorNumber;

    // Check the arguments.
    ASSERT(ui32SectorAddress <= (FLASHMEM_BASE + FlashSizeGet() -
                                 FlashSectorSizeGet()));
    ASSERT((ui32SectorAddress & (FlashSectorSizeGet() - 1)) == 00);

    ui32SectorProtect = FLASH_NO_PROTECT;
    ui32SectorNumber = (ui32SectorAddress - FLASHMEM_BASE) / FlashSectorSizeGet();

    if(ui32SectorNumber <= 31)
    {
        if((HWREG(FLASH_BASE + FLASH_O_FSM_BSLE0) & (1 << ui32SectorNumber)) &&
                (HWREG(FLASH_BASE + FLASH_O_FSM_BSLP0) & (1 << ui32SectorNumber)))
        {
            ui32SectorProtect = FLASH_WRITE_PROTECT;
        }
    }
    else if(ui32SectorNumber <= 63)
    {
        if((HWREG(FLASH_BASE + FLASH_O_FSM_BSLE1) &
                (1 << (ui32SectorNumber & 0x1F))) &&
                (HWREG(FLASH_BASE + FLASH_O_FSM_BSLP1) &
                 (1 << (ui32SectorNumber & 0x1F))))
        {
            ui32SectorProtect = FLASH_WRITE_PROTECT;
        }
    }

    return(ui32SectorProtect);
}

Here is the call graph for this function:

uint32_t FlashProtectionSave

(

uint32_t

ui32SectorAddress

)

Save sector protection to make it permanent.

This function will save the current protection mode for the specified flash bank sector.

This function must only be executed from ROM or SRAM.

Note

A write protected sector will become permanent write protected!! A device reset will not change the write protection!

Parameters

ui32SectorAddress

is the start address of the sector to be protected.

Returns

Returns the status of the sector protection:

• FAPI_STATUS_SUCCESS : Success.
• FAPI_STATUS_FSM_ERROR : An erase error is encountered.

{
    uint32_t ui32ErrorReturn;
    uint32_t ui32SectorNumber;
    uint32_t ui32CcfgSectorAddr;
    uint32_t ui32ProgBuf;

    ui32ErrorReturn = FAPI_STATUS_SUCCESS;

    // Check the arguments.
    ASSERT(ui32SectorAddress <= (FLASHMEM_BASE + FlashSizeGet() -
                                 FlashSectorSizeGet()));
    ASSERT((ui32SectorAddress & (FlashSectorSizeGet() - 1)) == 00);

    if(FlashProtectionGet(ui32SectorAddress) == FLASH_WRITE_PROTECT)
    {
        // Find sector number for specified sector.
        ui32SectorNumber = (ui32SectorAddress - FLASHMEM_BASE) / FlashSectorSizeGet();
        ui32CcfgSectorAddr = FLASHMEM_BASE + FlashSizeGet() - FlashSectorSizeGet();

        // Adjust CCFG address to the 32-bit CCFG word holding the
        // protect-bit for the specified sector.
        ui32CcfgSectorAddr += (((ui32SectorNumber >> 5) * 4) + CCFG_OFFSET_SECT_PROT);

        // Find value to program by setting the protect-bit which
        // corresponds to specified sector number, to 0.
        // Leave other protect-bits unchanged.
        ui32ProgBuf = (~(1 << (ui32SectorNumber & 0x1F))) &
                                   *(uint32_t *)ui32CcfgSectorAddr;

        ui32ErrorReturn = FlashProgram((uint8_t*)&ui32ProgBuf, ui32CcfgSectorAddr,
                                       CCFG_SIZE_SECT_PROT);
    }

    // Return status.
    return(ui32ErrorReturn);
}

Here is the call graph for this function:

void FlashProtectionSet	(	uint32_t	ui32SectorAddress,
		uint32_t	ui32ProtectMode
	)

Set sector protection.

This function will set the specified protection on specified flash bank sector. A sector can either have no protection or have write protection which guards for both program and erase of that sector. Sector protection can only be changed from FLASH_NO_PROTECT to FLASH_WRITE_PROTECT! After write protecting a sector this sector can only be set back to unprotected by a device reset.

Parameters

ui32SectorAddress	is the start address of the sector to protect.
ui32ProtectMode	is the enumerated sector protection mode. FLASH_NO_PROTECT FLASH_WRITE_PROTECT

Returns

None

{
    uint32_t ui32SectorNumber;

    // Check the arguments.
    ASSERT(ui32SectorAddress <= (FLASHMEM_BASE + FlashSizeGet() -
                                 FlashSectorSizeGet()));
    ASSERT((ui32SectorAddress & (FlashSectorSizeGet() - 1)) == 00);

    if(ui32ProtectMode == FLASH_WRITE_PROTECT)
    {
        ui32SectorNumber = (ui32SectorAddress - FLASHMEM_BASE) /
                           FlashSectorSizeGet();
        HWREG(FLASH_BASE + FLASH_O_FSM_WR_ENA) = FSM_REG_WRT_ENABLE;

        if(ui32SectorNumber <= 31)
        {
            HWREG(FLASH_BASE + FLASH_O_FSM_BSLE0) |= (1 << ui32SectorNumber);
            HWREG(FLASH_BASE + FLASH_O_FSM_BSLP0) |= (1 << ui32SectorNumber);
        }
        else if(ui32SectorNumber <= 63)
        {
            HWREG(FLASH_BASE + FLASH_O_FSM_BSLE1) |=
                (1 << (ui32SectorNumber & 0x1F));
            HWREG(FLASH_BASE + FLASH_O_FSM_BSLP1) |=
                (1 << (ui32SectorNumber & 0x1F));
        }

        HWREG(FLASH_BASE + FLASH_O_FSM_WR_ENA) = FSM_REG_WRT_DISABLE;
    }
}

Here is the call graph for this function:

uint32_t FlashSectorErase

(

uint32_t

ui32SectorAddress

)

Erase a flash sector.

This function will erase the specified flash sector. The function will not return until the flash sector has been erased or an error condition occurred. If flash top sector is erased the function will program the the device security data bytes with default values. The device security data located in the customer configuration area of the flash top sector, must have valid values at all times. These values affect the configuration of the device during boot.

Warning

Please note that code can not execute in flash while any part of the flash is being programmed or erased. The application must disable interrupts that have interrupt routines in flash. This function calls a ROM function which handles the actual program operation.

Parameters

ui32SectorAddress

is the starting address in flash of the sector to be erased.

Returns

Returns the status of the sector erase:

• FAPI_STATUS_SUCCESS : Success.
• FAPI_STATUS_INCORRECT_DATABUFFER_LENGTH : Invalid argument.
• FAPI_STATUS_FSM_ERROR : A programming error is encountered.

{
    uint32_t ui32ErrorReturn;
    FlashSectorErasePointer_t FuncPointer;

    // Check the arguments.
    ASSERT(ui32SectorAddress <= (FLASHMEM_BASE + FlashSizeGet() -
                                 FlashSectorSizeGet()));
    ASSERT((ui32SectorAddress & (FlashSectorSizeGet() - 1)) == 00);

    // Call ROM function that handles the actual erase operation
    FuncPointer = (uint32_t (*)(uint32_t)) (ROM_API_FLASH_TABLE[5]);
    ui32ErrorReturn = FuncPointer(ui32SectorAddress);

    // Enable standby in flash bank since ROM function might have disabled it
    HWREGBITW(FLASH_BASE + FLASH_O_CFG, FLASH_CFG_DIS_STANDBY_BITN ) = 0;

    // Return status of operation.
    return(ui32ErrorReturn);

}

Here is the call graph for this function:

static uint32_t FlashSectorSizeGet ( void  )

inlinestatic

Get size of a flash sector in number of bytes.

This function will return the size of a flash sector in number of bytes.

Returns

Returns size of a flash sector in number of bytes.

Referenced by FlashProtectionGet(), FlashProtectionSave(), FlashProtectionSet(), FlashSectorErase(), and FlashSizeGet().

{
    uint32_t ui32SectorSizeInKbyte;

    ui32SectorSizeInKbyte = (HWREG(FLASH_BASE + FLASH_O_FCFG_B0_SSIZE0) &
                             FLASH_FCFG_B0_SSIZE0_B0_SECT_SIZE_M) >>
                            FLASH_FCFG_B0_SSIZE0_B0_SECT_SIZE_S;

    // Return flash sector size in number of bytes.
    return(ui32SectorSizeInKbyte * 1024);
}

static uint32_t FlashSizeGet ( void  )

inlinestatic

Get the size of the flash.

This function returns the size of the flash main bank in number of bytes.

Returns

Returns the flash size in number of bytes.

Referenced by FlashProgram(), FlashProtectionGet(), FlashProtectionSave(), FlashProtectionSet(), and FlashSectorErase().

{
    uint32_t ui32NoOfSectors;

    // Get number of flash sectors
    ui32NoOfSectors = (HWREG(FLASH_BASE + FLASH_O_FLASH_SIZE) &
                       FLASH_FLASH_SIZE_SECTORS_M) >>
                      FLASH_FLASH_SIZE_SECTORS_S;

    // Return flash size in number of bytes
    return(ui32NoOfSectors * FlashSectorSizeGet());
}

Here is the call graph for this function:

Macro Definition Documentation

#define ADDR_OFFSET   (0x1F800000 - FLASHMEM_BASE)

#define DUMPWORD_INSTR   0x04

Referenced by FlashEfuseReadRow().

#define FAPI_STATUS_FSM_BUSY   0x00000001

Referenced by FlashCheckFsmForReady().

#define FAPI_STATUS_FSM_ERROR   0x00000004

Referenced by FlashCheckFsmForError().

#define FAPI_STATUS_FSM_READY   0x00000002

Referenced by FlashCheckFsmForReady().

#define FAPI_STATUS_INCORRECT_DATABUFFER_LENGTH   0x00000003

#define FAPI_STATUS_SUCCESS   0x00000000

Referenced by FlashCheckFsmForError(), and FlashProtectionSave().

#define FBFALLBACK_ACTIVE   3

Referenced by FlashPowerModeSet().

#define FBFALLBACK_DEEP_STDBY   1

#define FBFALLBACK_SLEEP   0

Referenced by FlashPowerModeGet().

#define FCFG1_OFFSET   0x1000

Referenced by SetReadMode().

#define FLASH_BAGP   0x14

#define FLASH_CMD_EXEC   0x15

#define FLASH_INT_FSM_DONE   0x00400000

Referenced by FlashIntClear(), and FlashIntStatus().

#define FLASH_INT_RV   0x00010000

Referenced by FlashIntClear(), and FlashIntStatus().

#define FLASH_MODULE_CLK_FREQ   48

#define FLASH_NO_PROTECT   0x00000000

Referenced by FlashProtectionGet().

#define FLASH_PAGP   0x14

#define FLASH_PWR_ACTIVE_MODE   0x00000000

Referenced by FlashPowerModeGet(), and FlashPowerModeSet().

#define FLASH_PWR_DEEP_STDBY_MODE   0x00000002

Referenced by FlashPowerModeGet(), and FlashPowerModeSet().

#define FLASH_PWR_OFF_MODE   0x00000001

Referenced by FlashPowerModeGet(), and FlashPowerModeSet().

#define FLASH_WRITE_PROTECT   0x00000001

Referenced by FlashProtectionGet(), FlashProtectionSave(), and FlashProtectionSet().

#define FSM_REG_WRT_DISABLE   2

Referenced by FlashDisableSectorsForWrite(), FlashIntDisable(), FlashIntEnable(), and FlashProtectionSet().

#define FSM_REG_WRT_ENABLE   5

Referenced by FlashDisableSectorsForWrite(), FlashIntDisable(), FlashIntEnable(), and FlashProtectionSet().

#define FW_PWRMODE_DEPRECATED   0x00000002

Referenced by FlashPowerModeGet(), and FlashPowerModeSet().

#define FW_WRT_TRIMMED   0x00000001

#define FWPWRITE_BYTE_ADDRESS   ((tFwpWriteByte *)((FLASH_BASE + FLASH_O_FWPWRITE0)))

#define PATTERN_BITS   0x20

Enumeration Type Documentation

enum tFlashStateCommandsType

Defined values for Flash State Machine commands.

Enumerator
FAPI_PROGRAM_DATA	Program data.
FAPI_ERASE_SECTOR	Erase sector.
FAPI_ERASE_BANK	Erase bank.
FAPI_VALIDATE_SECTOR	Validate sector.
FAPI_CLEAR_STATUS	Clear status.
FAPI_PROGRAM_RESUME	Program resume.
FAPI_ERASE_RESUME	Erase resume.
FAPI_CLEAR_MORE	Clear more.
FAPI_PROGRAM_SECTOR	Program sector.
FAPI_ERASE_OTP	Erase OTP.

{
    FAPI_PROGRAM_DATA    = 0x0002, 
    FAPI_ERASE_SECTOR    = 0x0006, 
    FAPI_ERASE_BANK      = 0x0008, 
    FAPI_VALIDATE_SECTOR = 0x000E, 
    FAPI_CLEAR_STATUS    = 0x0010, 
    FAPI_PROGRAM_RESUME  = 0x0014, 
    FAPI_ERASE_RESUME    = 0x0016, 
    FAPI_CLEAR_MORE      = 0x0018, 
    FAPI_PROGRAM_SECTOR  = 0x0020, 
    FAPI_ERASE_OTP       = 0x0030  
} tFlashStateCommandsType;