UM1634 datasheet(13/43 Pages) STMICROELECTRONICS

13 / 43 page

DocID024601 Rev 3

13/43

UM1634

API specification

3.6.2

FlashErase()

Description

The 'FlashErase()' API 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,

UINT8 shadowFlag,

UINT32 lowEnabledBlocks,

UINT32 midEnabledBlocks,

UINT32 highEnabledBlocks,

void (*CallBack)(void));

Arguments

Table 7. Arguments for FlashErase()

Argument

Description

Range

pSSDConfig

Pointer to the SSD

Configuration Structure.

The values in this structure are chip-dependent.

Please refer to Section 3.3 for more details.

shadowFlag

Indicate either the main

array or the shadow row

to be erased.

1: shadow row not to be erased.

2: shadow row of bank0 to be erased i.e. Shadow

Row0 to be erased.

3: shadow row of bank1 to be erased i.e. Shadow

Row1 to be erased.

4: both the shadow rows to be erased.

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

back function pointer.

Any addressable void function address. To disable it

use NULL_CALLBACK macro.

UM1634 Datasheet(PDF) 13 Page - STMicroelectronics

UM1634 Datasheet(HTML) 13 Page - STMicroelectronics

Html Pages

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

Datasheet Download

Link URL