UM1620
User manual
Standard Software Driver for C90FL Flash module embedded on
SPC56 A line microcontroller
Introduction
This document is the user manual for the Standard Software Driver (SSD) for single C90
Flash module.
The SSD is a set of API’s that enables user application to operate on the Flash module
embedded on a microcontroller. The C90FL SSD contains a set of functions to
program/erase a single C90FL Flash module.
The C90FL Standard Software Driver (SSD) provides the following API’s:
FlashInit
FlashErase
BlankCheck
FlashProgram
ProgramVerify
CheckSum
FlashSuspend
FlashResume
GetLock
SetLock
FlashArrayIntegrityCheck
FlashECCLogicCheck
FactoryMarginReadCheck
July 2020 UM1620 Rev 4 1/41
www.st.com
Contents UM1620
Contents
1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.1 Document overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.2 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2 API specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1 General overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2 General type definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.3 Configuration parameters and macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.4 Callback notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.5 Return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.6 Normal mode functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.6.1 FlashInit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.6.2 FlashErase() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.6.3 BlankCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.6.4 FlashProgram() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.6.5 ProgramVerify() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.6.6 CheckSum() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.6.7 FlashSuspend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.6.8 FlashResume() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
2.6.9 GetLock() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.6.10 SetLock() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
2.7 User test mode functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.7.1 FlashArrayIntegrityCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.7.2 FlashECCLogicCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
2.7.3 FactoryMarginReadCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Appendix A CallBack timings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Appendix B System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Appendix C Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Appendix D Document reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
2/41 UM1620 Rev 4
UM1620 Contents
Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
UM1620 Rev 4 3/41
List of tables UM1620
List of tables
Table 1. Type definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Table 2. SSD configuration structure field definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Table 3. Return codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Table 4. Arguments for FlashInit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Table 5. Return values for FlashInit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Table 6. Arguments for FlashErase() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Table 7. Return values for FlashErase() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Table 8. Troubleshooting for FlashErase() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Table 9. Bit allocation for blocks in low address space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Table 10. Bit allocation for blocks in middle address space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Table 11. Bit allocation for blocks in high address space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Table 12. Arguments for BlankCheck(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Table 13. Return values for BlankCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Table 14. Troubleshooting for BlankCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Table 15. Arguments for FlashProgram() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Table 16. Return values for FlashProgram() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Table 17. Troubleshooting for FlashProgram() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Table 18. Arguments for ProgramVerify() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Table 19. Return values for ProgramVerify() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Table 20. Troubleshooting for ProgramVerify() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Table 21. Arguments for CheckSum() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Table 22. Return values for CheckSum() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Table 23. Troubleshooting for CheckSum() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Table 24. Arguments for FlashSuspend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Table 25. Return values for FlashSuspend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Table 26. suspendState definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Table 27. Suspending state and flag vs. C90FL status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Table 28. Arguments for FlashResume() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Table 29. Return values for FlashResume() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Table 30. resumeState definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
. 24
Table 31. Arguments for GetLock() . . . . . . . . . . . . . . .
Table 32. Return values for GetLock() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Table 33. Troubleshooting for GetLock() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Table 34. blkLockIndicator definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Table 35. blkLockState bit allocation for shadow address space . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Table 36. blkLockState bit allocation for low address space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Table 37. blkLockState bit allocation for mid address space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Table 38. blkLockState bit allocation for high address space. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Table 39. Arguments for SetLock() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Table 40. Return values for SetLock() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Table 41. Troubleshooting for SetLock() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Table 42. Arguments for FlashArrayIntegrityCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Table 43. Return values for FlashArrayIntegrityCheck(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Table 44. Troubleshooting for FlashArrayIntegrityCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Table 45. Bit allocation for blocks in low address space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Table 46. Bit allocation for blocks in middle address space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Table 47. Bit Allocation for Blocks in High Address Space. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Table 48. Arguments for FlashECCLogicCheck(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. .
4/41 UM1620 Rev 4
UM1620 List of tables
Table 49. Return values for FlashECCLogicCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Table 50. Troubleshooting for FlashECCLogicCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Table 51. Arguments for FactoryMarginReadCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Table 52. Return values for FactoryMarginReadCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Table 53. Troubleshooting for FactoryMarginReadCheck() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Table 54. Bit allocation for blocks in low address space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Table 55. Bit allocation for blocks in middle address space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Table 56. Bit allocation for blocks in high address space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Table 57. CallBack timings period for SPC564A70 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Table 58. System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Table 59. Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Table 60. Document revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
UM1620 Rev 4 5/41
Introduction UM1620
1 Introduction
1.1 Document overview
This document is the user manual for the Standard Software Driver (SSD) for single C90FL
Flash module. The road-map for the document is as follows.
Section 1.2 shows the features of the driver. Appendix B: System requirements details the
system requirement for the driver development. Appendix D: Document reference lists the
documents referred and terms used in making of this document. Appendix C: Acronyms lists
the acronyms used.
Chapter 2 describes the API specifications. In this section there are many sub sections,
which describe the different aspects of the driver. Section 2.1 provides a general overview of
the driver.
Section 2.2 mentions about the type definitions used for the driver. Section 2.3 mentions the
driver configuration parameters and configuration macros respectively. Section 2.4 and
Section 2.5 describe the CallBack notifications, and return codes used for the driver.
Section 2.6 and Section 2.7 provide the detailed description of normal mode and special
mode standard software Flash Driver APIs’ respectively. Appendix A: CallBack timings
provides the performance indexes.
1.2 Features
The C90FL SSD provides the following features:
Two sets of driver binaries built on Power Architecture instruction set technology and
Variable-Length-Encoding (VLE) instruction set.
Drivers released in binary c-array format to provide compiler-independent support for
non-debug-mode embedded applications.
Drivers released in s-record format to provide compiler-independent support for
debugmode/JTAG programming tools.
Each driver function is independent of each other so the end user can choose the
function subset to meet their particular needs.
Support page-wise programming for fast programming.
Position-independent and ROM-able
Ready-to-use demos illustrating the usage of the driver
Concurrency support via callback
6/41 UM1620 Rev 4
UM1620 API specification
2 API specification
2.1 General overview
The C90FL SSD has APIs to handle the erase, program, erase verify and program verify
operations on the Flash. Apart from these, it also provides the feature for locking specific
blocks and calculating Check sum. This SSD also provides 3 user test APIs for checking the
Array Integrity and the ECC Logic.
2.2 General type definitions
Derived type Size C language type description
BOOL 8-bits unsigned char
INT8 8-bits signed char
VINT8 8-bits volatile signed char
UINT8 8-bits unsigned char
VUINT8 8-bits volatile unsigned char
INT16 16-bits signed short
VINT16 16-bits volatile signed short
UINT16 16-bits unsigned short
VUINT16 16-bits volatile unsigned short
INT32 32-bits signed long
VINT32 32-bits volatile signed long
UINT32 32-bits unsigned long
VUINT32 32-bits volatile unsigned long
Table 1. Type definitions
2.3 Configuration parameters and macros
The configuration parameter which is used for SSD operations is explained in this section.
The configuration parameters are handled as structure. The user should correctly initialize
the fields including c90flRegBase, mainArrayBase, shadowRowBase, shadowRowSize,
pageSize and BDMEnable before passing the structure to SSD functions. The pointer to
CallBack has to be initialized either to a null pointer or a valid CallBack function pointer.
Parameter name Type Parameter description
c90flRegBase UINT32 The base address of C90FL and BIU control registers.
mainArrayBase UINT32 The base address of Flash main array.
mainArraySize UINT32 The size of Flash main array in byte.
Table 2. SSD configuration structure field definition
UM1620 Rev 4 7/41
API specification UM1620
Table 2. SSD configuration structure field definition (continued)
Parameter name Type Parameter description
shadowRowBase UINT32 The base address of shadow row
shadowRowSize UINT32 The size of shadow row in byte.
shadowRowSize UINT32 Number of blocks of the large address space (128K or 256K).
lowBlockNum UINT32 Block number of the low address space.
midBlockNum UINT32 Block number of the mid address space.
highBlockNum UINT32 Block number of the high address space.
pageSize UINT32 The page size of the C90FL Flash
BDMEnable UINT32
Defines the state of background debug mode (enable
/disable)
The type definition for the structure is given below.
typedef struct _ssd_config
{
UINT32 c90flRegBase;
UINT32 mainArrayBase;
UINT32 mainArraySize;
UINT32 shadowRowBase;
UINT32 shadowRowSize;
UINT32 lowBlockNum;
UINT32 midBlockNum;
UINT32 highBlockNum;
UINT32 pageSize;
UINT32 BDMEnable;
} SSD_CONFIG, *PSSD_CONFIG;
Note: The macro value COMPILER_SELECT should be set to
CODE_WARRIOR – if CodeWarrior compiler is used for compiling
DIAB_COMPILER – if Diab compiler is used for compiling
2.4 Callback notification
The Standard Software Driver facilitates the user to supply a pointer to ‘CallBack()’ function
so that time-critical events can be serviced during C90FL Standard Software driver
operations.
Servicing watchdog timers is one such time critical event. If it is not necessary to provide the
CallBack service, the user is able to disable it by a NULL function macro.
#define NULL_CALLBACK ((void *) 0xFFFFFFFF)
The job processing callback notifications shall have no parameters and no return value.
8/41 UM1620 Rev 4
UM1620 API specification
2.5 Return codes
The return code is returned to the caller function to notify the success or errors of the API
execution. These are the possible values of return code:
Name Value Description
C90FL_OK 0x00000000 The requested operation is successful.
C90FL_INFO_RWE 0x00000001 RWE bit is set before Flash operations.
C90FL_INFO_EER 0x00000002 EER bit is set before Flash operations.
C90FL_ERROR_ALIGNMENT 0x00000100 Alignment error.
C90FL_ERROR_RANGE 0x00000200 Address range error.
C90FL_ERROR_BUSY 0x00000300
C90FL_ERROR_PGOOD 0x00000400 The program operation is unsuccessful.
C90FL_ERROR_EGOOD 0x00000500 The erase operation is unsuccessful.
C90FL_ERROR_NOT_BLANK 0x00000600
C90FL_ERROR_VERIFY 0x00000700
C90FL_ERROR_LOCK_INDICATOR 0x00000800 Invalid block lock indicator.
C90FL_ERROR_RWE 0x00000900
C90FL_ERROR_PASSWORD 0x00000A00
Table 3. Return codes
New program/erase cannot be preformed
while a high voltage operation is already in
progress.
There is a non-blank Flash memory location
within the checked Flash memory region.
There is a mismatch between the source
data and the content in the checked Flash
memory.
Read-while-write error occurred in previous
reads.
The password provided cannot unlock the
block lock register for register writes
C90FL_ERROR_AIC_MISMATCH 0x00000B00
C90FL_ERROR_AIC_NO_BLOCK 0x00000C00
C90FL_ERROR_FMR_MISMATCH 0x00000D00
C90FL_ERROR_FMR_NO_BLOCK 0x00000E00
C90FL_ERROR_ECC_LOGIC 0x00000F00
UM1620 Rev 4 9/41
In ‘FlashArrayIntegrityCheck()’ the MISR
values generated by the hardware do not
match the values passed by the user.
In ‘FlashArrayIntegrityCheck()’ no blocks
have been enabled for Array Integrity check
In ‘FactoryMarginReadCheck()’ the MISR
values generated by the hardware do not
match the values passed by the user.
In ‘FactoryMarginReadCheck()’ no blocks
have been enabled for Array Integrity check
In ‘FlashECCLogicCheck()’ the simulated
ECC error has not occurred.
API specification UM1620
2.6 Normal mode functions
2.6.1 FlashInit()
Description
This function reads the Flash configuration information from the Flash control registers and
initialize parameters in SSD configuration structure. ‘FlashInit()’ must be called prior to any
other Flash operations.
Prototype
UINT32 FlashInit (PSSD_CONFIG pSSDConfig);
Arguments
Argument Description Range
pSSDConfig
Pointer to the SSD
Configuration Structure.
Table 4. Arguments for FlashInit()
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
Return values
Type Description Possible values
Indicates either success or failure type. It is a bit
mapped return code so that more than one condition
UINT32
can be returned with a single return code. Each bit in
the returned value, except for C90FL_OK, indicates a
kind of current status of C90FL module.
Table 5. Return values for FlashInit()
C90FL_OK
C90FL_INFO_EER
C90FL_INFO_RWE
Troubleshooting
None.
Comments
‘FlashInit()’ checks the C90FL_MCR_RWE and C90FL_MCR_EER bit, and clear them
when any of them is set. If RWE bit is set, Flash program/erase operations can still be
performed.
Assumptions
The user must correctly initialize the fields including c90flRegBase, mainArrayBase,
shadowRowBase, shadowRowSize, pageSize and BDMEnable before passing the structure
to the FlashInit() functions
10/41 UM1620 Rev 4
.
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
Argument Description Range
Table 6. Arguments for FlashErase()
pSSDConfig
shadowFlag
lowEnabledBlocks
midEnabledBlocks
highEnabledBlocks
Pointer to the SSD
Configuration Structure.
Indicate either the main
array or the shadow row
to be erased.
To select the array
blocks in low address
space for erasing.
To select the array
blocks in mid address
space for erasing.
To select the array
blocks in high address
space for erasing.
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
TRUE: the shadow row is erased. The
lowEnabledBlocks, midEnabledBlocks and
highEnabledBlocks are ignored;
FALSE: The main array is erased. Which blocks are
erased in low, mid and high address spaces are
specified by lowEnabledBlocks, midEnabledBlocks
and highEnabledBlocks respectively.
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.
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.
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.
UM1620 Rev 4 11/41
Any addressable void function address. To disable it
use NULL_CALLBACK macro.
API specification UM1620
Return values
Type Description Possible values
UINT32 Successful completion or error value.
Table 7. Return values for FlashErase()
C90FL_OK
C90FL_ERROR_BUSY
C90FL_ERROR_EGOOD
Troubleshooting
Error codes Possible causes Solution
C90FL_ERROR_BUSY
C90FL_ERROR_ EGOOD Erase operation failed.
Table 8. Troubleshooting for FlashErase()
Wait until all previous
program/erase operations on the
New erase operation cannot be
performed because there is
program/erase sequence in
progress on the Flash module.
Flash module finish.
Possible cases that erase cannot
start are:
– erase in progress
(FLASH_MCR-ERS is high);
– program in progress
(FLASH_MCR-PGM is high);
Check if the C90FL is available
and high voltage is applied to
C90FL. Then try to do the erase
operation again.
Comments
When shadowFlag is set to FALSE, the ‘FlashErase()’ function erases the blocks in the main
array. It is capable of erasing any combination of blocks in the low, mid and high address
spaces in one operation. If shadowFlag is TRUE, this function erases the shadow row.
The inputs lowEnabledBlocks, midEnabledBlocks and highEnabledBlocks are bit-mapped
arguments that are used to select the blocks to be erased in the Low/Mid/High address
spaces of main array. The selection of the blocks of the main array is determined by
setting/clearing the corresponding bit in lowEnabledBlocks, midEnabledBlocks or
highEnabledBlocks.
The bit allocations for blocks in one address space are: bit 0 is assigned to block 0, bit 1 to
block 1, etc. The following diagrams show the formats of lowEnabledBlocks,
midEnabledBlocks and highEnabledBlocks for the C90FL module.
For low address space valid bits are from bit 0 to bit (lowBlockNum – 1). In which,
lowBlockNum is the number of low blocks returned from FlashInit();
For middle address space valid bits are from bit 0 and bit (midBlockNum – 1). In which,
midBlockNum is the number of middle blocks returned from FlashInit();
For high address space valid bits are from bit 0 to bit (highBlockNum – 1). In which,
highBlockNum is the number of high blocks returned from FlashInit();
12/41 UM1620 Rev 4
UM1620 API specification
For example, below are bit allocations for blocks in Low/Mid/High Address Space of
SPC564A70:
MSB LSB
bit 31 … bit 10 bit 9 bit 8 … bit 1 bit 0
reserved … reserved block 9 block 8 … block 1 block 0
Table 9. Bit allocation for blocks in low address space
MSB LSB
bit 31 … bit 4 bit 3 bit 2 bit 1 bit 0
reserved … reserved reserved reserved block 1 block 0
MSB LSB
bit 31 … bit 6 bit 5 bit 4 … bit 1 bit 0
reserved … reserved block 5 block 4 … Block 1 Block 0
Table 10. Bit allocation for blocks in middle address space
Table 11. Bit allocation for blocks in high address space
If the selected main array blocks or the shadow row is locked for erasing, those blocks or
the shadow row are not erased, but ‘FlashErase()’ still returns C90FL_OK. User needs to
check the erasing result with the ‘BlankCheck()’ function.
It is impossible to erase any Flash block or shadow row when a program or erase operation
is already in progress on C90FL module. ‘FlashErase()’ returns C90FL_ERROR_BUSY
when trying to do so. Similarly, once an erasing operation has started on C90FL module, it is
impossible to run another program or erase operation.
In addition, when ‘FlashErase()’ is running, it is unsafe to read the data from the Flash
module having one or more blocks being erased. Otherwise, it causes a Read-While-Write
error.
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API. User provides the
correct ssdconfig parameters to FlashErase() as returned by FlashInit().
2.6.3 BlankCheck()
Description
This function checks on the specified Flash range in the main array or shadow row for blank
state. If the blank checking fails, the first failing address and the failing data in Flash block
are saved.
UM1620 Rev 4 13/41
API specification UM1620
Prototype
UINT32 BlankCheck (PSSD_CONFIG pSSDConfig,
UINT32 dest,
UINT32 size,
UINT32 * pFailAddress,
UINT64 *pFailData,
void (*CallBack) (void ));
Arguments
Argument Description Range
Table 12. Arguments for BlankCheck()
pSSDConfig
dest
size
pFailAddress
pFailData
CallBack
Pointer to the SSD
Configuration Structure.
Destination address to be
checked.
Size, in bytes, of the Flash
region to check.
Return the address of the first
non-blank Flash location in the
checking region.
Return the content of the first
non-blank Flash location in the
checking region.
Address of void callback
function.
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
Any accessible address aligned on double word
boundary in main array or shadow row
If size = 0, the return value is C90FL_OK.
It should be multiple of 8 and its combination with
dest should fall in either main array or shadow row.
Only valid when this function returns
C90FL_ERROR_NOT_BLANK.
Only valid when this function returns
C90FL_ERROR_NOT_BLANK.
Any addressable void function address. To disable
it use NULL_CALLBACK macro.
Return values
Type Description Possible values
UINT32 Successful completion or error value.
Table 13. Return values for BlankCheck()
C90FL_OK
C90FL_ERROR_ALIGNMENT
C90FL_ERROR_RANGE
C90FL_ERROR_NOT_BLANK
14/41 UM1620 Rev 4
UM1620 API specification
Troubleshooting
Returned error bits Description Solution
Table 14. Troubleshooting for BlankCheck()
C90FL_ERROR_ALIGNMENT
C90FL_ERROR_RANGE
C90FL_ERROR_NOT_BLANK
Comments
If the blank checking fails, the first failing address is saved to *pFailAddress, and
the failing data in Flash is saved to *pFailData. The contents pointed by
pFailAddress and pFailData are updated only when there is a non-blank location in
the checked Flash range.
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API.
2.6.4 FlashProgram()
Description
This function programs the specified Flash areas with the provided source data. Input
arguments together with relevant Flash module status are checked, and relevant error code
is returned if there is any error.
The dest/size are not
properly aligned.
The area specified by dest
and size is out of the valid
C90FL array ranges.
There is a non-blank
double word within the
area to be checked.
Check if dest and size are aligned on
double word (64-bit) boundary.
Check dest and dest+size. The area
to be checked must be within main
array space or shadow space.
Erase the relevant blocks and check
again.
Prototype
UINT32 FlashProgram (PSSD_CONFIG pSSDConfig,
UINT32 dest,
UINT32 size,
UINT32 source,
void (*CallBack)(void));
Arguments
Argument Description Range
pSSDConfig
Dest
Pointer to the SSD
Configuration Structure.
Destination address to be
programmed in Flash
memory.
Table 15. Arguments for FlashProgram()
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
Any accessible address aligned on double word
boundary in main array or shadow row.
UM1620 Rev 4 15/41
API specification UM1620
Table 15. Arguments for FlashProgram() (continued)
Argument Description Range
If size = 0, C90FL_OK is returned.
It should be multiple of 8 and its combination with dest
should fall in either main array or shadow row.
This address must reside on word boundary.
Any addressable void function address. To disable it
use NULL_CALLBACK macro.
Size
source
CallBack
Size, in bytes, of the Flash
region to be programmed.
Source program buffer
address.
Address of void call back
function pointer.
Return values
Type Description Possible values
UINT32 Successful completion or error value.
Table 16. Return values for FlashProgram()
C90FL_OK
C90FL_ERROR_BUSY
C90FL_ERROR_ALIGNMENT
C90FL_ERROR_RANGE
C90FL_ERROR_PGOOD
Troubleshooting
Table 17. Troubleshooting for FlashProgram()
Returned error bits Description Solution
Wait until the current operations finish.
Conditions that program cannot start
C90FL_ERROR_BUSY
New program operation
cannot be performed
because the Flash
module is busy with
some operation and
cannot meet the
condition for starting a
program operation.
are:
1. program in progress (MCR-PGM
high);
2. program not in progress (MCR-PGM
low), but:
– erase in progress but not suspended;
– erase on main array is suspended but
program is targeted to shadow row;
– erase on shadow row is suspended.
C90FL_ERROR_ALIGNMENT
C90FL_ERROR_RANGE
C90FL_ERROR_PGOOD
This error indicates that
dest/size/source isn’t
properly aligned
The area specified by
dest and size is out of th e
valid C90FL address
range.
Program operation failed
because this operation
cannot pass PEG check.
Check if dest and size are aligned on
double word (64-bit) boundary. Check if
source is aligned on word boundary.
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
Repeat the program operation. Check if
the C90FL is invalid or high voltage
applied to C90FL is unsuitable.
16/41 UM1620 Rev 4
UM1620 API specification
Comments
If the selected main array blocks or the shadow row is locked for programming, those blocks
or the shadow row are not programmed, and ‘FlashProgram()’ still returns C90FL_OK. User
needs to verify the programmed data with ‘ProgramVerify()’ function.
It is impossible to program any Flash block or shadow row when a program or erase
operation is already in progress on C90FL module. ‘FlashProgram()’ returns
C90FL_ERROR_BUSY when doing so. However, user can use the ‘FlashSuspend()’
function to suspend an on-going erase operation on one block to perform a program
operation on another block. The user has begun an erase operation on the main array or
shadow row, it may be suspended to program on both main array and shadow row.
It is unsafe to read the data from the Flash partitions having one or more blocks being
programmed when ‘FlashProgram()’ is running. Otherwise, it causes a Read-While-Write
error.
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API.
2.6.5 ProgramVerify()
Description
This function checks if a programmed Flash range matches the corresponding source data
buffer. In case of mismatch, the failed address, destination value and source value are
saved and relevant error code is returned.
Prototype
UINT32 ProgramVerify (PSSD_CONFIG pSSDConfig,
UINT32 dest,
UINT32 size,
UINT32 source,
UINT32 *pFailAddress,
UINT64 *pFailData,
UINT64 *pFailSource,
void (*CallBack)(void));
Arguments
Argument Description Range
pSSDConfig
Dest
Size
Source Verify source buffer address. This address must reside on word boundary.
Pointer to the SSD
Configuration Structure.
Destination address to be
verified in Flash memory.
Size, in byte, of the Flash
region to verify.
Table 18. Arguments for ProgramVerify()
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
Any accessible address aligned on double word
boundary in main array or shadow row.
If size = 0, C90FL_OK is returned. Its combination
with dest should fall within either main array or
shadow row.
UM1620 Rev 4 17/41
API specification UM1620
Table 18. Arguments for ProgramVerify() (continued)
Argument Description Range
pFailAddress
pFailData
pFailSource
CallBack
Return first failing address in
Flash.
Returns first mismatch data
in Flash.
Returns first mismatch data
in buffer.
Address of void call back
function pointer.
Only valid when the function returns
C90FL_ERROR_VERIFY.
Only valid when this function returns
C90FL_ERROR_VERIFY.
Only valid when this function returns
C90FL_ERROR_VERIFY.
Any addressable void function address. To disable it
use NULL_CALLBACK macro.
Return values
Type Description Possible values
UINT32 Successful completion or error value.
Table 19. Return values for ProgramVerify()
C90FL_OK
C90FL_ERROR_ALIGNMENT
C90FL_ERROR_RANGE
C90FL_ERROR_VERIFY
Troubleshooting
Table 20. Troubleshooting for ProgramVerify()
Returned error bits Description Solution
C90FL_ERROR_ALIGNMENT
C90FL_ERROR_RANGE
C90FL_ERROR_VERIFY
This error indicates that
dest/size/source isn’t
properly aligned
The area specified by
dest and size is out of
the valid C90FL address
range.
The content in C90FL
and source data
mismatch.
Check if dest and size are aligned on
double word (64-bit) boundary. Check if
source is aligned on word boundary
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
Check the correct source and destination
addresses, erase the block and
reprogram data into Flash.
Comments
The contents pointed by pFailLoc, pFailData and pFailSource are updated only when there
is a mismatch between the source and destination regions.
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API.
18/41 UM1620 Rev 4
UM1620 API specification
2.6.6 CheckSum()
Description
This function 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
Argument Description Range
Table 21. Arguments for CheckSum()
pSSDConfig
Dest
Size
pSum Returns the sum value.
CallBack
Pointer to the SSD
Configuration Structure.
Destination address to be
summed in Flash memory.
Size, in bytes, of the Flash
region to check sum.
Address of void call back
function pointer.
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
Any accessible address aligned on double word
boundary in either main array or shadow row.
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.
0x00000000 - 0xFFFFFFFF. Note that this value is
only valid when the function returns C90FL_OK.
Any addressable void function address. To disable it
use NULL_CALLBACK macro.
Return values
Type Description Possible values
UINT32 Successful completion or error value.
Table 22. Return values for CheckSum()
C90FL_OK
C90FL_ERROR_ALIGNMENT
C90FL_ERROR_RANGE
UM1620 Rev 4 19/41
API specification UM1620
Troubleshooting
Returned error bits Description Solution
Table 23. Troubleshooting for CheckSum()
C90FL_ERROR_ALIGNMENT
C90FL_ERROR_RANGE
Comments
None.
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API
2.6.7 FlashSuspend()
Description
This function checks if there is any high voltage operation, erase or program, in progress on
the C90FL module and if the operation can be suspended. This function suspends the
ongoing operation if it can be suspended.
Prototype
This error indicates that
dest/size isn’t properly
aligned.
The area specified by
dest and size is out of
the valid C90FL address
range.
Check if dest and size are aligned on
double word (64-bit) boundary. Check if
source is aligned on word boundary.
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.
.
UINT32 FlashSuspend (PSSD_CONFIG pSSDConfig,
UINT8 *suspendState,
BOOL *suspendFlag);
Arguments
Argument Description Range
pSSDConfig
suspendState
suspendFlag
Table 24. Arguments for FlashSuspend()
Pointer to the SSD
Configuration Structure.
Indicate the suspend state
of C90FL module after the
function being called.
Return whether the
suspended operation, if
there is any, is suspended
by this call.
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
All return values are enumerated inTable 27.
TRUE: the operation is suspended by this call;
FALSE: either no operation to be suspended or the
operation is suspended not by this call.
20/41 UM1620 Rev 4
UM1620 API specification
Return values
Type Description Possible values
UINT32 Successful completion. C90FL_OK
Table 25. Return values for FlashSuspend()
Troubleshooting
None.
Comments
After calling ‘FlashSuspend()’, read is allowed on both main array space and shadow row
without any Read-While-Write error. But data read from the blocks targeted for programming
or erasing is indeterminate even if the operation is suspended.
This function should be used together with ‘FlashResume()’. The suspendFlag returned by
‘FlashSuspend()’ determine whether ‘FlashResume()’ needs to be called or not. If
suspendFlag is TRUE, ‘FlashResume()’ must be called symmetrically to resume the
suspended operation.
Following table defines and describes various suspend states and associated suspend
codes.
Argument Code Description Valid operation after suspend
NO_OPERTION 0
PGM_WRITE 1
ERS_WRITE 2
ERS_SUS_PGM_WRITE 3
PGM_SUS 4
ERS_SUS 5
Table 26. suspendState definitions
Erasing operation, programming
There is no program/erase
operation.
There is a program
sequence in interlock write
stage.
There is an erase sequence
in interlock write stage.
There is an erase-suspend
program sequence in
interlock write stage.
The program operation is in
suspended state.
The erase operation on
main array is in suspended
state.
operation and read are valid on
both main array space and
shadow row.
Only read is valid on both main
array space and shadow row.
Only read is valid on both main
array space and shadow row.
Only read is valid on both main
array space and shadow row.
Only read is valid on both main
array space and shadow row.
Programming operation is valid
only on main array space. Read
is valid on both main array space
and shadow row.
UM1620 Rev 4 21/41
API specification UM1620
Table 26. suspendState definitions (continued)
Argument Code Description Valid operation after suspend
SHADOW_ERS_SUS 6
ERS_SUS_PGM_SUS 7
The erase operation on
shadow row is in suspended
state.
The erase-suspended
program operation is in
suspended state.
Read is valid on both main array
space and shadow space.
Only read is valid on both main
array space and shadow row.
The table below lists the Suspend Flag values returned against the Suspend State and the
Flash block status.
suspendState EHV ERS ESUS PGM PSUS PEAS suspendFlag
NO_OPERATION X 0 X 0 X X FALSE
PGM_WRITE 0 0 X 1 0 X FALSE
ERS_WRITE 0 1 0 0 X X FALSE
ESUS_PGM_WRITE 0 1 1 1 0 X FALSE
PGM_SUS
ERS_SUS
SHADOW_ERS_SUS
Table 27. Suspending state and flag vs. C90FL status
1 0 X 1 0 X TRUE
X0 X 1 1 X FALSE
1 1 0 0 X 0 TRUE
X1 1 0 X 0 FALSE
1 1 0 0 X 1 TRUE
X1 1 0 X 1 FALSE
ERS_SUS_PGM_SUS
1 1 1 1 0 X TRUE
X1 1 1 1 X FALSE
The values of EHV, ERS, ESUS, PGM, PSUS and PEAS represent the C90FL status at the
entry of FlashSuspend;
0: Logic zero; 1: Logic one; X: Do-not-care
.
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API.
2.6.8 FlashResume()
Description
This function checks if there is any suspended erase or program operation on the C90FL
module, and resumes the suspended operation if there is any.
22/41 UM1620 Rev 4
UM1620 API specification
Prototype
UINT32 FlashResume (PSSD_CONFIG pSSDConfig,
UINT8 *resumeState);
Arguments
Argument Description Range
Table 28. Arguments for FlashResume()
pSSDConfig
resumeState
Pointer to the SSD
Configuration Structure.
Indicate the resume state of
C90FL module after the
function being called.
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
All return values are listed in Table 29.
Return values
Type Description Possible values
UINT32 Successful completion. C90FL_OK
Table 29. Return values for FlashResume()
Troubleshooting
None.
Comments
This function resumes one operation if there is any operation is suspended. For instance, if
a program operation is in suspended state, it is resumed. If an erase operation is in
suspended state, it is resumed too. If an erase-suspended program operation is in
suspended state, the program operation is resumed prior to resuming the erase operation. It
is better to call this function based on suspendFlag returned from ‘FlashSupend()’.
Following table defines and describes various resume states and associated resume codes.
Code name Value Description
RES_NOTHING 0 No program/erase operation to be resumed
RES_PGM 1 A program operation is resumed
RES_ERS 2 A erase operation is resumed
RES_ERS_PGM 3
Table 30. resumeState definitions
A suspended erase-suspended program operation is
resumed
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API.
UM1620 Rev 4 23/41
API specification UM1620
2.6.9 GetLock()
Description
This function checks the block locking status of Shadow/Low/Middle/High address spaces in
the C90FL module.
Prototype
UINT32 GetLock (PSSD_CONFIG pSSDConfig,
UINT8 blkLockIndicator,
BOOL *blkLockEnabled,
UINT32 *blkLockState);
Arguments
Table 31. Arguments for GetLock()
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.
Indicating the address space
blkLockIndicator
and the block locking level,
which determines the address
space block locking register
Refer to Table 34 for valid values for this
parameter.
to be checked.
TRUE – The address space block locking register
is enabled for register writes.
FALSE – The address space block locking
register is disabled for register writes.
Bit mapped value indicating the locking status of
the specified locking level and address space.
1: The block is locked from program/erase.
0: The block is ready for program/erase
blkLockEnabled
blkLockState
Indicate whether the address
space block locking register is
enabled for register writes
Returns the blocks’ locking
status of indicated locking
level in the given address
space
Return values
Table 32. Return values for GetLock()
Type Description Possible values
UINT32 Successful completion or error value.
Troubleshooting
Returned error bits Possible causes Solution
C90FL_ERROR_LOCK_INDICATOR
24/41 UM1620 Rev 4
Table 33. Troubleshooting for GetLock()
The input blkLockIndicator
is invalid.
C90FL_OK
C90FL_ERROR_LOCK_INDICATOR
Set this argument to correct
value listed in Table 34.
UM1620 API specification
Comments
Following table defines and describes various blkLockIndicator values.
Code Name Value Description
LOCK_SHADOW_PRIMARY 0 Primary block lock protection of shadow address space
LOCK_SHADOW_SECONDARY 1
LOCK_LOW_PRIMARY 2 Primary block lock protection of low address space
LOCK_LOW_SECONDARY 3 Secondary block lock protection of low address space
LOCK_MID_PRIMARY 4 Primary block lock protection of mid address space
LOCK_MID_SECONDARY 5 Secondary block lock protection of mid address space
LOCK_HIGH 6 Block lock protection of high address space
For Shadow/Low/Mid address spaces, there are two block lock levels. The secondary level
of block locking provides an alternative means to protect blocks from being modified. A
logical “OR” of the corresponding bits in the primary and secondary lock registers for a block
determines the final lock status for that block. For high address space there is only one
block lock level.
Table 34. blkLockIndicator definitions
Secondary block lock protection of shadow address
space
The output parameter blkLockState returns a bit-mapped value indicating the block lock
status of the specified locking level and address space. A main array block or shadow row is
locked from program/erase if its corresponding bit is set.
The indicated address space determines the valid bits of blkLockState. The following
diagrams show the block bitmap definitions of blkLockState for shadow/Low/Mid/High
address spaces.
For low address space valid bits are from bit 0 to bit (lowBlockNum – 1). In which,
lowBlockNum is the number of low blocks returned from FlashInit();
For middle address space valid bits are from bit 0 and bit (midBlockNum – 1). In which,
midBlockNum is the number of middle blocks returned from FlashInit();
For high address space valid bits are from bit 0 to bit (highBlockNum – 1). In which,
highBlockNum is the number of high blocks returned from FlashInit();
For shadow row valid bit is bit 0;
For example, below are bit allocations for blocks in Low/Mid/High Address Space of
SPC564A70:
MSB LSB
bit 31 … bit 1 bit 0
reserved … reserved shadow row
Table 35. blkLockState bit allocation for shadow address space
UM1620 Rev 4 25/41
API specification UM1620
Table 36. blkLockState bit allocation for low address space
MSB LSB
bit 31 … bit 10 bit 9 bit 8 … bit 1 bit 0
reserved … reserved block 9 block 8 … block 1 block 0
Table 37. blkLockState bit allocation for mid address space
MSB LSB
bit 31 … bit 4 bit 3 bit 2 bit 1 bit 0
reserved … reserved reserved reserved block 1 block 0
Table 38. blkLockState bit allocation for high address space
MSB LSB
bit 31 … bit 6 bit 5 bit 4 … bit 1 bit 0
reserved … reserved block 5 block 4 … block 1 block 0
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API.
2.6.10 SetLock()
Description
This function sets the block lock state for Shadow/Low/Middle/High address space on the
C90FL module to protect them from program/erase. The API provides password to enable
block lock register writes when is 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);
26/41 UM1620 Rev 4
UM1620 API specification
Arguments
Argument Description Range
Table 39. Arguments for SetLock()
pSSDConfig
Pointer to the SSD
Configuration Structure.
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
Indicating the address
blkLockIndicator
space and the protection
level of the block lock
Refer to Table 34 for valid codes for this parameter.
register to be read.
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
blkLockState
The block locks to be set to
the specified address
space and protection level.
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
password
A password is required to
enable the block lock
register for register write.
Select Register.
Return values
Type Description Possible values
UINT32 Successful completion or error value.
Table 40. Return values for SetLock()
C90FL_OK
C90FL_ERROR_LOCK_INDICATOR
C90FL_ERROR_PASSWORD
Troubleshooting
The troubleshooting mentioned below comprises of hardware errors due to both P Flash
block erase verify and P Flash section erase verify command. Apart from these the input
based error handling is also mentioned.
Returned error bits Possible causes Solution
C90FL_ERROR_LOCK_INDICATOR
C90FL_ERROR_PASSWORD
Table 41. Troubleshooting for SetLock()
The input blkLockIndicator
is invalid.
The given password cannot
enable the block lock
register for register writes.
Set this argument to correct
value listed in Table 34.
Pass in a correct password.
Comments
The bit field allocation for blkLockState is same as that in ‘GetLock()’ function.
UM1620 Rev 4 27/41
API specification UM1620
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API.
2.7 User test mode functions
2.7.1 FlashArrayIntegrityCheck()
Description
This function checks the array integrity of the Flash. The user specified address sequence is
used for array integrity reads and the operation is done on the specified blocks. The MISR
values calculated by the hardware is compared to the values passed by the user, if they are
not the same, then an error code is returned.
Prototype
UINT32 FlashArrayIntegrityCheck (PSSD_CONFIG pSSDConfig,
UINT32 lowEnabledBlocks,
UINT32 midEnabledBlocks,
UINT32 highEnabledBlocks,
UINT8 addrSeq,
MISR misrValue,
void (*CallBack)(void));
Arguments
Argument Description Range
pSSDConfig
lowEnabledBlocks
midEnabledBlocks
highEnabledBlocks
Table 42. Arguments for FlashArrayIntegrityCheck()
Pointer to the SSD
Configuration Structure.
To select the array
blocks in low address
space for erasing.
To select the array
blocks in mid address
space for erasing.
To select the array
blocks in high address
space for erasing.
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
Bit-mapped value. Select the block in the low
address space whose array integrity is to be
evaluated by setting 1 to the appropriate bit of
lowEnabledBlocks. If there is not any block to be
evaluated in the low address space,
lowEnabledBlocks must be set to 0.
Bit-mapped value. Select the block in the middle
address space whose array integrity is to be
evaluated by setting 1 to the appropriate bit of
midEnabledBlocks. If there is not any block to be
evaluated in the middle address space,
midEnabledBlocks must be set to 0.
Bit-mapped value. Select the block in the high
address space whose array integrity is to be
evaluated by setting 1 to the appropriate bit of
highEnabledBlocks. If there is not any block to be
evaluated in the high address space,
highEnabledBlocks must be set to 0.
28/41 UM1620 Rev 4
UM1620 API specification
Table 42. Arguments for FlashArrayIntegrityCheck() (continued)
Argument Description Range
The default sequence (addrSeq = 0) is meant to
replicate sequences normal “user” code follows,
and thoroughly check the read propagation paths.
This sequence is proprietary.
The alternative sequence (addrSeq = 1) is just
logically sequential.
It should be noted that the time to run a sequential
sequence is significantly shorter than the time to
run the proprietary sequence.
The individual MISR words can range from
0x00000000 - 0xFFFFFFFF
addrSeq
misrValue
To determine the
address sequence to be
used during array
integrity checks.
A structure variable
containing the MISR
values calculated by the
user using the off-line
MISR generation tool.
CallBack
Address of void call back
function pointer.
Any addressable void function address. To disable
it use NULL_CALLBACK macro.
Return values
Type Description Possible values
UINT32 Successful completion or error value.
Table 43. Return values for FlashArrayIntegrityCheck()
C90FL_OK
C90FL_ERROR_AIC_MISMATCH
C90FL_ERROR_AIC_NO_BLOCK
Troubleshooting
The trouble shooting given here comprises of hardware errors and input parameter error.
Returned error bits Possible causes Solution
C90FL_ERROR_AIC_MISMATCH
C90FL_ERROR_AIC_NO_BLOCK
Table 44. Troubleshooting for FlashArrayIntegrityCheck()
The MISR value calculated
by the user is incorrect.
The MISR calculated by the
Hardware is incorrect.
None of the Blocks are
enabled for Array Integrity
Check
Re-calculate the MISR values
using the correct Data and
addrSeq.
Hardware Error.
Enable any of the blocks using
variables lowEnabledBlocks,
midEnabledBlocks and
highEnabledBlock.
Comments
The inputs lowEnabledBlocks, midEnabledBlocks and highEnabledBlocks are bit-mapped
arguments that are used to select the blocks to be evaluated in the Low/Mid/High address
UM1620 Rev 4 29/41
API specification UM1620
spaces of main array. The selection of the blocks of the main array is determined by
setting/clearing the corresponding bit in lowEnabledBlocks, midEnabledBlocks or
highEnabledBlocks.
The bit allocations for blocks in one address space are: bit 0 is assigned to block 0, bit 1 to
block 1, etc. The following diagrams show the formats of lowEnabledBlocks,
midEnabledBlocks and highEnabledBlocks for the C90FL module.
For low address space valid bits are from bit 0 to bit (lowBlockNum – 1). In which,
lowBlockNum is the number of low blocks returned from FlashInit();
For middle address space valid bits are from bit 0 and bit (midBlockNum – 1). In which,
midBlockNum is the number of middle blocks returned from FlashInit();
For high address space valid bits are from bit 0 to bit (highBlockNum – 1). In which,
highBlockNum is the number of high blocks returned from FlashInit();
For example, below are bit allocations for blocks in Low/Mid/High Address Space of
SPC564A70:
MSB LSB
bit 31 … bit 10 bit 9 bit 8 … bit 1 bit 0
Table 45. Bit allocation for blocks in low address space
reserved … reserved block 9 block 8 … block 1 block 0
MSB LSB
bit 31 … bit 4 bit 3 bit 2 bit 1 bit 0
reserved … reserved reserved reserved block 1 block 0
MSB LSB
bit 31 … bit 6 bit 5 bit 4 … bit 1 bit 0
reserved … reserved block 5 block 4 … Block 1 Block 0
Table 46. Bit allocation for blocks in middle address space
Table 47. Bit Allocation for Blocks in High Address Space
If no blocks are enabled the C90FL_ERROR_AIC_NO_BLOCK error code is returned.
Depending on the address sequence specified the MISR values are calculated for the
enabled blocks using the corresponding sequence. If the MISR values calculated by the
hardware is not the same as the values passed to this API by the user then the API returns
the error code C90FL_ERROR_AIC_MISMATCH.
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API.
30/41 UM1620 Rev 4
UM1620 API specification
2.7.2 FlashECCLogicCheck()
Description
This function checks the ECC logic of the Flash. The API simulates a single or double bit
fault depending on the user input. If the simulated ECC error is not detected, then the error
code C90FL_ERROR_ECC_LOGIC is returned.
Prototype
UINT32 FlashECCCLogicCheck (PSSD_CONFIG pSSDConfig,
UINT64 dataVal,
UINT64 errBits,
UINT32 eccValue)
Arguments
Argument Description Range
pSSDConfig
dataValue
errBits
eccValue
Table 48. Arguments for FlashECCLogicCheck()
Pointer to the SSD
Configuration Structure.
The 64 bits of data for which
the ECC is calculated. The
bits of dataValue are flipped
to generate single or double
bit faults.
Is a 64-bit mask of the bits
at which the user intends to
inject error.
It’s a 32 bit value which has
to be passed by user. This
is calculated ny using an
offline ECC Calculator.
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
Any 64-bit value.
Any 64-bit value, except zero.
This is a corresponding ECC value for the data
value passed by the user.
Note: Same data words should be used in off line
ECC calculator and Flash ECC logic check API.
Return values
Type Description Possible values
Table 49. Return values for FlashECCLogicCheck()
UINT32 Successful completion or error value.
C90FL_OK
C90FL_ERROR_ECC_LOGIC
Troubleshooting
The trouble shooting given here comprises of hardware errors and input parameter error.
UM1620 Rev 4 31/41
API specification UM1620
Returned error bits Possible causes Solution
C90FL_ERROR_ECC_LOGIC
Table 50. Troubleshooting for FlashECCLogicCheck()
The ECC value calculated by
the user is incorrect.
Hardware Failure. Hardware error.
Comments
Depending on the errBits value, a single or double bit faults are simulated. When a Flash
read is done, if the simulated error has not occurred, then the API returns the error code
C90FL_ERROR_ECC_LOGIC.
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API.
2.7.3 FactoryMarginReadCheck()
Description
This function checks the Factory Margin reads of the Flash. The user specified margin level
is used for reads and the operation is done on the specified blocks. The MISR values
calculated by the hardware is compared to the values passed by the user, if they are not the
same, then an error code is returned.
Re-calculate the ECC values
using the correct Data.
Prototype
UINT32 FactoryMarginReadCheck (PSSD_CONFIG pSSDConfig,
UINT32 lowEnabledBlocks,
UINT32 midEnabledBlocks,
UINT32 highEnabledBlocks,
UINT8 marginLevel,
MISR misrValue,
void (*CallBack)(void));
Arguments
Argument Description Range
pSSDConfig
lowEnabledBlocks
Table 51. Arguments for FactoryMarginReadCheck()
Pointer to the SSD
Configuration Structure.
To select the array blocks
in low address space for
erasing.
The values in this structure are chip-dependent.
Please refer to Section 2.3 for more details.
Bit-mapped value. Select the block in the low
address space whose array integrity is to be
evaluated by setting 1 to the appropriate bit of
lowEnabledBlocks. If there is not any block to be
evaluated in the low address space,
lowEnabledBlocks must be set to 0.
32/41 UM1620 Rev 4
UM1620 API specification
Table 51. Arguments for FactoryMarginReadCheck() (continued)
Argument Description Range
Bit-mapped value. Select the block in the middle
address space whose array integrity is to be
evaluated by setting 1 to the appropriate bit of
midEnabledBlocks. If there is not any block to be
evaluated in the middle address space,
midEnabledBlocks must be set to 0.
Bit-mapped value. Select the block in the high
address space whose array integrity is to be
evaluated by setting 1 to the appropriate bit of
highEnabledBlocks. If there is not any block to be
evaluated in the high address space,
highEnabledBlocks must be set to 0.
Selects the margin level that is being checked.
Margin can be checked to an erased level
(marginLevel=1) or to a programmed level
(marginLevel =0).
The individual MISR words can range from
0x00000000 - 0xFFFFFFFF
midEnabledBlocks
highEnabledBlocks
marginLevel
misrValue
To select the array blocks
in mid address space for
erasing.
To select the array blocks
in high address space for
erasing.
To determine the margin
level to be used during
factory margin read
checks.
A structure variable
containing the MISR
values calculated by the
user using the offline
MISR generation tool.
CallBack
Address of void call back
function pointer.
Any addressable void function address. To disable
it use NULL_CALLBACK macro.
Return values
Type Description Possible values
UINT32 Successful completion or error value.
Table 52. Return values for FactoryMarginReadCheck()
C90FL_OK
C90FL_ERROR_FMR_MISMATCH
C90FL_ERROR_FMR_NO_BLOCK
Troubleshooting
The trouble shooting given here comprises of hardware errors and input parameter error.
UM1620 Rev 4 33/41
API specification UM1620
C90FL_ERROR_FMR_MISMATCH
C90FL_ERROR_FMR_NO_BLOCK
Table 53. Troubleshooting for FactoryMarginReadCheck()
Returned error bits Possible causes Solution
The MISR value
calculated by the user is
incorrect.
The MISR calculated by
the Hardware is incorrect.
None of the Blocks are
enabled for Factory
Margin Read Check
Re-calculate the MISR values
using the correct Data and
address.
Hardware Error.
Enable any of the blocks using
variables lowEnabledBlocks,
midEnabledBlocks and
highEnabledBlock.
Comments
The inputs lowEnabledBlocks, midEnabledBlocks and highEnabledBlocks are bit-mapped
arguments that are used to select the blocks to be evaluated in the Low/Mid/High address
spaces of main array. The selection of the blocks of the main array is determined by
setting/clearing the corresponding bit in lowEnabledBlocks, midEnabledBlocks or
highEnabledBlocks.
The bit allocations for blocks in one address space are: bit 0 is assigned to block 0, bit 1 to
block 1, etc. The following diagrams show the formats of lowEnabledBlocks,
midEnabledBlocks and highEnabledBlocks for the C90FL module.
For low address space valid bits are from bit 0 to bit (lowBlockNum – 1). In which,
lowBlockNum is the number of low blocks returned from FlashInit();
For middle address space valid bits are from bit 0 and bit (midBlockNum – 1). In which,
midBlockNum is the number of middle blocks returned from FlashInit();
For high address space valid bits are from bit 0 to bit (highBlockNum – 1). In which,
highBlockNum is the number of high blocks returned from FlashInit();
For example, below are bit allocations for blocks in Low/Mid/High Address Space of
SPC564A70:
MSB LSB
bit 31 … bit 10 bit 9 bit 8 … bit 1 bit 0
reserved … reserved block 9 block 8 … block 1 block 0
MSB LSB
bit 31 … bit 4 bit 3 bit 2 bit 1 bit 0
reserved … reserved reserved reserved block 1 block 0
Table 54. Bit allocation for blocks in low address space
Table 55. Bit allocation for blocks in middle address space
34/41 UM1620 Rev 4
UM1620 API specification
MSB LSB
bit 31 … bit 6 bit 5 bit 4 … bit 1 bit 0
reserved … reserved block 5 block 4 … Block 1 Block 0
Table 56. Bit allocation for blocks in high address space
If no blocks are enabled the C90FL_ERROR_FMR_NO_BLOCK error code is returned.
The MISR values are calculated for the enabled blocks using the logical sequence. If the
MISR values calculated by the hardware is not the same as the values passed to this API by
the user then the API returns the error code C90FL_ERROR_FMR_MISMATCH.
Assumptions
It assumes that the Flash block is initialized using a ‘FlashInit()’ API.
UM1620 Rev 4 35/41
CallBack timings UM1620
Appendix A CallBack timings
FlashProgram() (size = 0x1000) 1.7
ProgramVerify() (size = 0x1000, CALLBACK_PV = 70) 99.3
FlashErase() (low block 0) 1.7
BlankCheck() (size = LOW_BLOCK0_SIZE, CALLBACK_BC = 80) 101.3
CheckSum (size = 0x1000, CALLBACK_CS = 120) 103.25
FlashArrayIntegrityCheck (low block 0) 1.7
FactoryMarginReadCheck (low block 0) 1.7
Table 57. CallBack timings period for SPC564A70
API Name
System clock = 40 MHz
Time (µs)
Note: Callback time period for ‘CheckSum()’ is measured with CALLBACK_CS (CallBack function
period for checksum)
Callback time period for ‘ProgramVerify()’ is measured with CALLBACK_PV (CallBack
function period for program verify)
Callback time period for ‘BlankCheck()’ is measured with CALLBACK_BC (CallBack
function period for program verify)
36/41 UM1620 Rev 4
UM1620 System requirements
Appendix B System requirements
The C90FL SSD is designed to support a single C90FL Flash module embedded on
microcontrollers. Before using this SSD on a different derivative microcontroller, user has to
provide the information specific to the derivative through a configuration structure.
Tool name Description Version number
CodeWarrior IDE Development tool 2.7
Diab PowerPC compiler Compiler 5.7.0.0
GreenHills Development tool 6.1.4
P/E Debugger
Table 58. System requirements
UM1620 Rev 4 37/41
Acronyms UM1620
Appendix C Acronyms
Abbreviation Complete name
API Application Programming Interface
BIU Bus Interface Unit
ECC Error Correction Code
EVB Evaluation Board
RWW Read While Write
SSD Standard Software Driver
Table 59. Acronyms
38/41 UM1620 Rev 4
UM1620 Document reference
Appendix D Document reference
1. SPC564A70B4, SPC564A70L7 32-bit MCU family built on the embedded Power
Architecture
®
(RM0068, Doc ID 18132)
UM1620 Rev 4 39/41
Revision history UM1620
Revision history
Date Revision Changes
18-Mar-2013 1 Initial release.
02-May-2013 2
18-Sep-2013 3 Updated Disclaimer.
13-Jul-2020 4 Updated title.
Table 60. Document revision history
Removed Table: CallBack timings period for SPC56EL60x,
SPC56XL70xx
Updated Appendix D: Document reference
40/41 UM1620 Rev 4
UM1620
IMPORTANT NOTICE – PLEASE READ CAREFULLY
STMicroelectronics NV and its subsidiaries (“ST”) reserve the right to make changes, corrections, enhancements, modifications, and
improvements to ST products and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on
ST products before placing orders. ST products are sold pursuant to ST’s terms and conditions of sale in place at the time of order
acknowledgement.
Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or
the design of Purchasers’ products.
No license, express or implied, to any intellectual property right is granted by ST herein.
Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product.
ST and the ST logo are trademarks of ST. For additional information about ST trademarks, please refer to www.st.com/trademarks. All other
product or service names are the property of their respective owners.
Information in this document supersedes and replaces information previously supplied in any prior versions of this document.
© 2020 STMicroelectronics – All rights reserved
UM1620 Rev 4 41/41
Loading...