PSOC E8XXGP Device Support Library

General Description

Enumerations

enum  cy_en_rram_status_t {
  CY_RRAM_SUCCESS = 0x0UL ,
  CY_RRAM_BAD_PARAM = CY_RRAM_ID | CY_PDL_STATUS_ERROR | 0x01UL ,
  CY_RRAM_ACQUIRE_PC_LOCK_FAIL = CY_RRAM_ID | CY_PDL_STATUS_ERROR | 0X02UL ,
  CY_RRAM_OPERATION_TIME_OUT_ERROR = CY_RRAM_ID | CY_PDL_STATUS_ERROR | 0X03UL ,
  CY_RRAM_WRITE_OPERATION_ERROR = CY_RRAM_ID | CY_PDL_STATUS_ERROR | 0x04UL ,
  CY_RRAM_WPLOCK_ENABLED = CY_RRAM_ID | CY_PDL_STATUS_ERROR | 0x05UL ,
  CY_RRAM_ECC_FAIL = CY_RRAM_ID | CY_PDL_STATUS_ERROR | 0x06UL ,
  CY_RRAM_HARDEN_ALLMEM_FAIL = CY_RRAM_ID | CY_PDL_STATUS_ERROR | 0x07UL ,
  CY_RRAM_UPDATE_LOCKABLE_REGION_FAILED = CY_RRAM_ID | CY_PDL_STATUS_ERROR | 0x08UL ,
  CY_RRAM_VERR_BLOCK_FAIL_BITS = CY_RRAM_ID | CY_PDL_STATUS_ERROR | 0x09UL ,
  CY_RRAM_ADDRESS_UPDATE_FAIL = CY_RRAM_ID | CY_PDL_STATUS_ERROR | 0x0AUL ,
  CY_RRAM_INIT_FAIL = CY_RRAM_ID | CY_PDL_STATUS_ERROR | 0x0BUL
}
 RRAM driver error codes. More...
 
enum  cy_en_rram_protected_lock_t {
  CY_RRAM_PROTECTED_UNLOCK = 0x00UL ,
  CY_RRAM_PROTECTED_LOCK = 0x0FUL
}
 RRAM protected lock for NVM region. More...
 
enum  cy_en_rram_uds_lock_t {
  CY_RRAM_UDS_UNLOCK = 0x00UL ,
  CY_RRAM_UDS_LOCK = 0x0FUL
}
 RRAM UDS lock for NVM region. More...
 
enum  cy_en_rram_wp_lock_t {
  CY_RRAM_WP_UNLOCK = 0x00UL ,
  CY_RRAM_WP_LOCK = 0x01UL
}
 RRAM write protection lock for NVM region. More...
 
enum  cy_en_rram_sleep_t {
  CY_RRAM_NOT_IN_SLEEP = 0x00UL ,
  CY_RRAM_IN_SLEEP = 0x01UL
}
 RRAM sleep mode status. More...
 
enum  cy_en_rram_operation_t {
  CY_RRAM_IDLE = 0x00UL ,
  CY_RRAM_INDIRECT_WRITE = 0x01UL ,
  CY_RRAM_VERIFY_ONLY = 0x02UL ,
  CY_RRAM_HARDENING = 0x04UL ,
  CY_RRAM_LOOPED_FORMING = 0x07UL ,
  CY_RRAM_FORMING = 0x08UL ,
  CY_RRAM_RETRIEVE_CONFIG = 0x0BUL ,
  CY_RRAM_LOOPED_WRITE = 0x0EUL
}
 RRAM operations. More...
 
enum  cy_en_rram_verr_status_t {
  CY_RRAM_NO_ERROR = 0x00UL ,
  CY_RRAM_SINGLE_BIT_ERROR = 0x01UL ,
  CY_RRAM_DOUBLE_BIT_ERROR = 0x02UL ,
  CY_RRAM_TRIPLE_BIT_ERROR = 0x03UL ,
  CY_RRAM_ECC_UNCORRECTABLE_BIT_ERROR = 0x04UL ,
  CY_RRAM_ECC_ADDR_MISMATCH_ERROR = 0x05UL ,
  CY_RRAM_CONFIG_ERROR = 0x06UL ,
  CY_RRAM_ALGORITHM_ERROR = 0x07UL
}
 RRAM error codes. More...
 
enum  cy_en_rram_hresp_t {
  CY_RRAM_AHB_NO_ERROR = 0x00UL ,
  CY_RRAM_OTP_TAGBIT_VIOLATION = 0x01UL ,
  CY_RRAM_POSTREAD_CHK_TAGBIT_VIOLATION = 0x02UL ,
  CY_RRAM_POSTREAD_CHK_ADDR_FAULT_ALRM = 0x03UL ,
  CY_RRAM_AHB_ERROR = 0x04UL ,
  CY_RRAM_M0SEC_WRITE_ERROR = 0x05UL ,
  CY_RRAM_WRITE_ADDR_MISMATCH = 0x06UL ,
  CY_RRAM_PROTECTED_PRGM_ERROR = 0x07UL ,
  CY_RRAM_READ_UDS_WHILE_LOCKED = 0x09UL ,
  CY_RRAM_UNLOCK_UDS_WHILE_LOCKED = 0x0AUL ,
  CY_RRAM_TAGBIT_GATING_CTL_ERROR = 0x0BUL ,
  CY_RRAM_OPRTN_ERR_WITHOUT_PC_ACQUISITION = 0x0CUL ,
  CY_RRAM_PC_MISMATCH_ERROR = 0x0DUL ,
  CY_RRAM_EXECUTE_FORMING = 0x0EUL ,
  CY_RRAM_PROTECTED_INTERFACE_MPC_VIOLATION = 0x0FUL
}
 RRAM AHB error codes. More...
 
enum  cy_en_rram_vmode_t {
  CY_RRAM_VMODE_UNDEFINED = 0x0UL ,
  CY_RRAM_VMODE_ULP = 0x1UL ,
  CY_RRAM_VMODE_LP = 0x2UL ,
  CY_RRAM_VMODE_HP = 0x3UL
}
 RRAM voltage/frequency mode for operations. More...
 
enum  cy_en_rram_temperature_t {
  CY_RRAM_TEMP_INVALID = 0x0UL ,
  CY_RRAM_TEMP_LESS_THAN_EQ_50C = 0x1UL ,
  CY_RRAM_TEMP_ABOVE_50C_BELOW_85C = 0x2UL ,
  CY_RRAM_TEMP_ABOVE_85C_BELOW_100C = 0x4UL ,
  CY_RRAM_TEMP_ABOVE_100C_BELOW_110C = 0x8UL ,
  CY_RRAM_TEMP_ABOVE_110C_BELOW_120C = 0xAUL ,
  CY_RRAM_TEMP_ABOVE_120C = 0xCUL
}
 RRAM Junction Temperature. More...
 

Enumeration Type Documentation

◆ cy_en_rram_status_t

RRAM driver error codes.

Enumerator
CY_RRAM_SUCCESS 

Returned successful.

CY_RRAM_BAD_PARAM 

Bad parameter was passed.

CY_RRAM_ACQUIRE_PC_LOCK_FAIL 

Fail to acquire PC lock during indirect operation.

CY_RRAM_OPERATION_TIME_OUT_ERROR 

Time out error during RRAM operation.

CY_RRAM_WRITE_OPERATION_ERROR 

Write operation failed.

CY_RRAM_WPLOCK_ENABLED 

Write protection lock enabled.

CY_RRAM_ECC_FAIL 

Read operation failed with uncorrectable ECC error.

CY_RRAM_HARDEN_ALLMEM_FAIL 

Hardening of complete memory failed.

CY_RRAM_UPDATE_LOCKABLE_REGION_FAILED 

The Lock bit state is Locked.

Failed to update the lockable region.

CY_RRAM_VERR_BLOCK_FAIL_BITS 

Information on number of fail bits for a block after verify operations in indirect write, verify-only, and forming operations.

CY_RRAM_ADDRESS_UPDATE_FAIL 

Failed to write NVM_ADDR register for write operation.

CY_RRAM_INIT_FAIL 

Failed to retrieve configuration from configuration space in extra area.

◆ cy_en_rram_protected_lock_t

RRAM protected lock for NVM region.

Enumerator
CY_RRAM_PROTECTED_UNLOCK 

Not locked, PARTITION_SIZE_0/1 in PROTECTED_NVM region.

CY_RRAM_PROTECTED_LOCK 

Locked, PARTITION_SIZE_0/1 in PROTECTED_NVM region.

◆ cy_en_rram_uds_lock_t

RRAM UDS lock for NVM region.

Enumerator
CY_RRAM_UDS_UNLOCK 

Not locked, Access to UDS_KEY.

CY_RRAM_UDS_LOCK 

Locked, No access to UDS_KEY.

◆ cy_en_rram_wp_lock_t

RRAM write protection lock for NVM region.

Enumerator
CY_RRAM_WP_UNLOCK 

Not locked, Sectors for write protection can be configured.

CY_RRAM_WP_LOCK 

Locked, Sectors for write protection cannot be configured.

◆ cy_en_rram_sleep_t

RRAM sleep mode status.

Enumerator
CY_RRAM_NOT_IN_SLEEP 

Not in sleep mode, and no sleep or wake up procedure in progress.

CY_RRAM_IN_SLEEP 

In sleep mode, or busy due to a sleep or wake up procedure.

◆ cy_en_rram_operation_t

RRAM operations.

Enumerator
CY_RRAM_IDLE 

Idle state.

CY_RRAM_INDIRECT_WRITE 

Indirect write operation.

CY_RRAM_VERIFY_ONLY 

Verify only operation.

CY_RRAM_HARDENING 

Hardening operation.

CY_RRAM_LOOPED_FORMING 

Looped forming operation.

CY_RRAM_FORMING 

Forming operation.

CY_RRAM_RETRIEVE_CONFIG 

Retrieve configuration.

CY_RRAM_LOOPED_WRITE 

Looped write.

◆ cy_en_rram_verr_status_t

RRAM error codes.

Enumerator
CY_RRAM_NO_ERROR 

No Error.

CY_RRAM_SINGLE_BIT_ERROR 

Single Bit fail.

CY_RRAM_DOUBLE_BIT_ERROR 

Double Bit fail.

CY_RRAM_TRIPLE_BIT_ERROR 

Triple Bit fail.

CY_RRAM_ECC_UNCORRECTABLE_BIT_ERROR 

ECC uncorrectable fail bit error.

CY_RRAM_ECC_ADDR_MISMATCH_ERROR 

ECC address mismatch error.

CY_RRAM_CONFIG_ERROR 

Config error.

CY_RRAM_ALGORITHM_ERROR 

Algorithm error.

◆ cy_en_rram_hresp_t

RRAM AHB error codes.

Enumerator
CY_RRAM_AHB_NO_ERROR 

No Error.

CY_RRAM_OTP_TAGBIT_VIOLATION 

OTP Tag bit violation during write.

CY_RRAM_POSTREAD_CHK_TAGBIT_VIOLATION 

Post-read check Tag bit violation during read.

CY_RRAM_POSTREAD_CHK_ADDR_FAULT_ALRM 

Post-read check address fault alarm.

CY_RRAM_AHB_ERROR 

RRAM IP AHB bus error.

CY_RRAM_M0SEC_WRITE_ERROR 

Incomplete write or 8/16 write on the protected interface.

CY_RRAM_WRITE_ADDR_MISMATCH 

Indirect sequence where AHB write address mismatch with SFR NVM_ADDR.

CY_RRAM_PROTECTED_PRGM_ERROR 

Programming PROTECTED_NVM lockable subsection.

CY_RRAM_READ_UDS_WHILE_LOCKED 

Detecting UDS read access while UDS is locked.

CY_RRAM_UNLOCK_UDS_WHILE_LOCKED 

Detecting unlock UDS when it is locked.

CY_RRAM_TAGBIT_GATING_CTL_ERROR 

Detecting Tag bit gating control error.

CY_RRAM_OPRTN_ERR_WITHOUT_PC_ACQUISITION 

Executing indirect operation without a PC acquired.

CY_RRAM_PC_MISMATCH_ERROR 

Transaction PC is different than the acquired PC.

CY_RRAM_EXECUTE_FORMING 

Executing forming or looped forming in SORT LCS.

CY_RRAM_PROTECTED_INTERFACE_MPC_VIOLATION 

Protected interface MPC violation.

◆ cy_en_rram_vmode_t

RRAM voltage/frequency mode for operations.

Enumerator
CY_RRAM_VMODE_UNDEFINED 

Undefined voltage/frequency mode for operations.

CY_RRAM_VMODE_ULP 

ULP voltage/frequency mode for operations.

CY_RRAM_VMODE_LP 

LP voltage/frequency mode for operations.

CY_RRAM_VMODE_HP 

HP voltage/frequency mode for operations.

◆ cy_en_rram_temperature_t

RRAM Junction Temperature.

Enumerator
CY_RRAM_TEMP_INVALID 

Invalid/Unknown junction temperature value.

CY_RRAM_TEMP_LESS_THAN_EQ_50C 

Tj <= 50C.

CY_RRAM_TEMP_ABOVE_50C_BELOW_85C 

50C < Tj <= 85C.

CY_RRAM_TEMP_ABOVE_85C_BELOW_100C 

85C < Tj <= 100C.

CY_RRAM_TEMP_ABOVE_100C_BELOW_110C 

100C < Tj <= 110C.

CY_RRAM_TEMP_ABOVE_110C_BELOW_120C 

110C < Tj <=120C.

CY_RRAM_TEMP_ABOVE_120C 

Tj > 120C.