UM1620 Datasheet, PDF (11/41 Pages) STMicroelectronics – Standard software driver for C90FL

UM1620
API specification
2.6.2
FlashErase()
Description
This function erases the enabled blocks in the main array or the shadow row. Input
arguments together with relevant Flash module status are checked, and relevant error code
is returned if there is any error.
Prototype
UINT32 FlashErase (PSSD_CONFIG pSSDConfig,
BOOL shadowFlag,
UINT32 lowEnabledBlocks,
UINT32 midEnabledBlocks,
UINT32 highEnabledBlocks,
void (*CallBack)(void));
Arguments
Table 6. Arguments for FlashErase()
Argument
Description
Range
pSSDConfig
Pointer to the SSD
The values in this structure are chip-dependent.
Configuration Structure. Please refer to Section 2.3 for more details.
shadowFlag
TRUE: the shadow row is erased. The
lowEnabledBlocks, midEnabledBlocks and
Indicate either the main highEnabledBlocks are ignored;
array or the shadow row FALSE: The main array is erased. Which blocks are
to be erased.
erased in low, mid and high address spaces are
specified by lowEnabledBlocks, midEnabledBlocks
and highEnabledBlocks respectively.
lowEnabledBlocks
To select the array
blocks in low address
space for erasing.
Bit-mapped value. Select the block in the low
address space to be erased by setting 1 to the
appropriate bit of lowEnabledBlocks. If there is not
any block to be erased in the low address space,
lowEnabledBlocks must be set to 0.
midEnabledBlocks
To select the array
blocks in mid address
space for erasing.
Bit-mapped value. Select the block in the middle
address space to be erased by setting 1 to the
appropriate bit of midEnabledBlocks. If there is not
any block to be erased in the middle address space,
midEnabledBlocks must be set to 0.
highEnabledBlocks
To select the array
blocks in high address
space for erasing.
Bit-mapped value. Select the block in the high
address space to be erased by setting 1 to the
appropriate bit of highEnabledBlocks. If there is not
any block to be erased in the high address space,
highEnabledBlocks must be set to 0.
CallBack
Address of void call
Any addressable void function address. To disable it
back function pointer. use NULL_CALLBACK macro.
DocID024388 Rev 3
11/41