UM1627 datasheet(25/38 Pages) STMICROELECTRONICS

25 / 38 page

DocID024497 Rev 2

25/38

UM1627

API specification

2.6.10

SetLock()

Description

This function sets the block lock state for Shadow/Low/Middle/High address space on the

C90LC module to protect them from program/erase. The API provides password to enable

block lock register writes when needed and write the block lock value to block lock register

for the requested address space.

Prototype

UINT32 SetLock (PSSD_CONFIG pSSDConfig,

UINT8 blkLockIndicator,

UINT32 blkLockState,

UINT32 password);

Arguments

Return values

Table 40. Arguments for SetLock()

Argument

Description

Range

pSSDConfig

Pointer to the SSD

Configuration Structure.

The values in this structure are chip-dependent.

Please refer to Section 2.3 for more details.

blkLockIndicator

Indicating the address

space and the protection

level of the block lock

Refer to Table 35 for valid codes for this parameter.

blkLockState

The block locks to be set to

the specified address

space and protection level.

Bit mapped value indicating the lock status of the

specified protection level and address space.

1: The block is locked from program/erase.

0: The block is ready for program/erase

password

A password is required to

enable the block lock

Correct passwords for block lock registers are

0xA1A1_1111 for Low/Mid Address Space Block

Locking Register, 0xC3C3_3333 for Secondary

Low/Mid Address Space Block Locking Register,

and 0xB2B2_2222 for High Address Space Block

Select Register.

Table 41. Return values for SetLock()

Type

Description

Possible values

UINT32

Successful completion or error value.

C90FL_OK

C90FL_ERROR_LOCK_INDICATOR

C90FL_ERROR_PASSWORD

UM1627 Datasheet(PDF) 25 Page - STMicroelectronics

UM1627 Datasheet(HTML) 25 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

Datasheet Download

Link URL