USER Keys (32-bit) and Related Parameters - 2020.2 English

OS and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2020-11-24
Version
2020.2 English
Note: For programming USER key for MONO/SSIT device, the corresponding SLR should be selected and USER key programming should be enabled.

Enable the following parameters if you want to program USER key for SLR2:

  1. Enable programming for SLR:
    • XSK_EFUSEPL_PGM_SLR_CONFIG_ORDER_2 should have the TRUE value.
  2. Enable USER key programming:
    • XSK_EFUSEPL_PROGRAM_USER_KEY should have the TRUE value.
  3. Provide key to be programmed on SLR:
    • XSK_EFUSEPL_USER_KEY_CONFIG_ORDER_2 should have key to be programmed in the string format.

Enable the following parameters if you want to program USER key on SLR0 and SLR3:

  1. Enable programming for SLR:
    • XSK_EFUSEPL_PGM_SLR_CONFIG_ORDER_0 should have the TRUE value.
    • XSK_EFUSEPL_PGM_SLR_CONFIG_ORDER_3 should have the TRUE value.
  2. Enable USER key programming:
    • XSK_EFUSEPL_PROGRAM_USER_KEY should have the TRUE value.
  3. Provide key to be programmed on SLR:
    • XSK_EFUSEPL_USER_KEY_CONFIG_ORDER_0 should have key to be programmed in the string format.
    • XSK_EFUSEPL_USER_KEY_CONFIG_ORDER_3 should have key to be programmed in the string format.

The following table shows USER key and related parameters to be taken care while programming USER key.

Parameter Name Description
XSK_EFUSEPL_PROGRAM_USER_KEY Default = FALSE

TRUE will burn 32 bit User key given in

XSK_EFUSEPL_USER_KEY_CONFIG_ORDER_

INDEX if orresponding XSK_EFUSEPL_PGM_SLR_CONFIG_ORDER_

INDEX is TRUE, FALSE will ignore the values given.
XSK_EFUSEPL_USER_KEY_CONFIG_ORDER_0 Default = 00000000

The value mentioned in this will be converted to hex buffer and written into the PL eFUSE array of SLR1/MONO when write API used. This value should be the User Key given in string format. It should be 8 characters long, valid characters are 0-9,a-f,A-F. Any other character is considered as invalid string and will not burn User Key.
Note: For writing the User Key, make sure XSK_EFUSEPL_PROGRAM_USER_KEY and XSK_EFUSEPL_PGM_SLR_CONFIG_ORDER_

0 are enabled with TRUE value.
XSK_EFUSEPL_USER_KEY_CONFIG_ORDER_1 Default = 00000000

The value mentioned in this will be converted to hex buffer and written into the PL eFUSE array when the write API is used. This value should be the User Key given in string format. It should be 8 characters long, valid characters are 0-9,a-f,A-F. Any other character is considered as invalid string and will not burn User Key.
Note: For writing the User Key, make sure XSK_EFUSEPL_PROGRAM_USER_KEY and XSK_EFUSEPL_PGM_SLR_CONFIG_ORDER

_1 are enabled with TRUE value.
XSK_EFUSEPL_USER_KEY_CONFIG_ORDER_2 Default = 00000000

The value mentioned in this will be converted to hex buffer and written into the PL eFUSE array when write API used. This value should be the User Key given in string format. It should be 8 characters long, valid characters are 0-9,a-f,A-F. Any other character is considered as invalid string and will not burn User Key.
Note: For writing the User Key, make sure XSK_EFUSEPL_PROGRAM_USER_KEY and XSK_EFUSEPL_PGM_SLR_CONFIG_ORDER

_2 are enabled with TRUE value.
XSK_EFUSEPL_USER_KEY_CONFIG_ORDER_3 Default = 00000000

The value mentioned in this will be converted to hex buffer and written into the PL eFUSE array when write API used. This value should be the User Key given in string format. It should be 8 characters long, valid characters are 0-9,a-f,A-F. Any other character is considered as invalid string and will not burn User Key.
Note: For writing the User Key, XSK_EFUSEPL_PROGRAM_USER_KEY and XSK_EFUSEPL_PGM_SLR_CONFIG_ORDER

_3 are enabled with TRUE value.