Enumerated Types

Enumerations
enum	cy_en_msclp_status_t {   CY_MSCLP_SUCCESS = 0x00u,   CY_MSCLP_BAD_PARAM = CY_MSCLP_ID | CY_PDL_STATUS_ERROR | 0x01u,   CY_MSCLP_BUSY = CY_MSCLP_ID | CY_PDL_STATUS_ERROR | 0x02u,   CY_MSCLP_LOCKED = CY_MSCLP_ID | CY_PDL_STATUS_ERROR | 0x03u,   CY_MSCLP_TIMEOUT = CY_MSCLP_ID | CY_PDL_STATUS_ERROR | 0x04u,   CY_MSCLP_MRSS_DISABLED = CY_MSCLP_ID | CY_PDL_STATUS_ERROR | 0x05u }
	MSCLP status definitions. More...
enum	cy_en_msclp_key_t {   CY_MSCLP_NONE_KEY = 0u,   CY_MSCLP_USER_DEFINED_KEY = 1u,   CY_MSCLP_CAPSENSE_KEY = 2u }
	Definitions of upper level keys that use the driver. More...

Detailed Description

Enumeration Type Documentation

cy_en_msclp_status_t

enum cy_en_msclp_status_t

MSCLP status definitions.

Enumerator
CY_MSCLP_SUCCESS	Successful.
CY_MSCLP_BAD_PARAM	One or more invalid parameters.
CY_MSCLP_BUSY	The MSCLP HW block performs conversion.
CY_MSCLP_LOCKED	The MSCLP HW block is captured by another middleware.
CY_MSCLP_TIMEOUT	The MSCLP HW block operation reaches timeout.
CY_MSCLP_MRSS_DISABLED	The MRSS is disabled.

cy_en_msclp_key_t

enum cy_en_msclp_key_t

Definitions of upper level keys that use the driver.

Each middleware has a unique key assigned. When middleware successfully captures the MSCLP HW block, this key is placed into the MSCLP driver context structure. All attempts to capture the MSCLP HW block by other middleware are rejected. When the first middleware releases the MSCLP HW block, CY_MSCLP_NONE_KEY is written to the lockKey variable of the MSCLP driver context structure and any other middleware can capture the MSCLP HW block.

Enumerator
CY_MSCLP_NONE_KEY	The MSCLP HW block is unused and not captured by any middleware.
CY_MSCLP_USER_DEFINED_KEY	The MSCLP HW block is captured by the application program directly to implement a customer's specific case.
CY_MSCLP_CAPSENSE_KEY	The MSCLP HW block is captured by a CAPSENSE™ middleware.