UM1618 datasheet(25/51 Pages) STMICROELECTRONICS

25 / 51 page

DocID024371 Rev 3

25/51

UM1618

API specification

Arguments

Return values

Troubleshooting

Comments

In order to provide correct pSum calculation, this input argument must not be NULL pointer.

However, this API does not return any error code if user tries doing so.

If user wants to do checksum for large size, this Flash size is divided into many small

portions defined by NUM_WORDS_CHECK_SUM_CYCLE such that checksum for one

small portion can be finished within expected time interval. In this case, ‘CheckSum’

function plays a role to kick-off this operation by finishing checksum for the first portion after

back-up all necessary information to pCtxData variable. And checksum from the second

portion is done within ‘FlashCheckStatus’ function. Thus, user must call ‘FlashCheckStatus’

to finish all the expected operations defined by size argument.

Table 30. Arguments for CheckSum

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.

dest

Destination address to be

summed in Flash memory.

Any accessible address aligned on word boundary

in either main array or UTest block.

size

Size, in bytes, of the Flash

region to check sum.

If size is 0 and the other parameters are all valid,

C55_OK is returned. It must be word aligned and its

combination with dest should fall within main array

or UTest block.

pSum

Returns the sum value.

0x00000000 - 0xFFFFFFFF. Note that this value is

only valid when the function returns C55_OK.

User must not pass to this function with NULL

pointer of pSum.

pCtxData

Address of context data

structure.

A data structure for storing context variables.

Table 31. Return values for CheckSum

Type

Description

Possible values

UINT32

Successful completion or error value.

C55_OK

C55_ERROR_ALIGNMENT

Table 32. Troubleshooting for CheckSum

Returned Error Bits

Description

Solution

C55_ERROR_ALIGNMENT

This error indicates that

dest/size isn’t properly

aligned.

Check if dest and size are aligned on

word (32-bit) boundary.

UM1618 Datasheet(PDF) 25 Page - STMicroelectronics

UM1618 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 39 40 41 42 43 44 45 46 47 48 49 50 51

Datasheet Download

Link URL