UM1634 datasheet(21/43 Pages) STMICROELECTRONICS

21 / 43 page

DocID024601 Rev 3

21/43

UM1634

API specification

3.6.6

CheckSum()

Description

The 'CheckSum()' API performs a 32-bit sum over the specified Flash memory range

without carry, which provides a rapid method for checking data integrity.

Prototype

UINT32 CheckSum (PSSD_CONFIG pSSDConfig,

UINT32 dest,

UINT32 size,

UINT32 *pSum,

void (*CallBack)(void));

Arguments

Return values

Comments

None.

Table 19. 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 3.3 for more details.

Dest

Destination address to be

summed in Flash memory.

Any accessible address aligned on double word

boundary in either main array or shadow row.

Size

Size, in bytes, of the Flash

region to check sum.

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

C90FL_OK is returned. Its combination with dest

should fall within either main array or shadow row.

pSum

Returns the sum value.

0x00000000 - 0xFFFFFFFF. Note that this value is

only valid when the function returns C90FL_OK.

CallBack

Address of void call back

function pointer.

Any addressable void function address. To disable it

use NULL_CALLBACK macro.

Table 20. Return values for CheckSum()

Return Values

Possible Causes

Solution

C90FL_ERROR_ALIGNMENT

This error indicates that

dest/size isn’t properly

aligned

Check if dest and size are aligned

on double word (64-bit) boundary.

Check if source is aligned on word

boundary

C90FL_ERROR_RANGE

The area specified by dest

and size is out of the valid

C90FL address range.

Check dest and dest+size, both

should fall in the same C90FL

address ranges, i.e. both in main

array or both in shadow row

C90FL_OK

Successful completion.

UM1634 Datasheet(PDF) 21 Page - STMicroelectronics

UM1634 Datasheet(HTML) 21 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