CAT2 Peripheral Driver Library

Enumerations

enum  cy_en_msc_status_t {
  CY_MSC_SUCCESS = 0x00u,
  CY_MSC_BAD_PARAM = CY_MSC_ID | CY_PDL_STATUS_ERROR | 0x01u,
  CY_MSC_BUSY = CY_MSC_ID | CY_PDL_STATUS_ERROR | 0x02u,
  CY_MSC_LOCKED = CY_MSC_ID | CY_PDL_STATUS_ERROR | 0x03u
}
 MSC status definitions. More...
 
enum  cy_en_msc_key_t {
  CY_MSC_NONE_KEY = 0u,
  CY_MSC_USER_DEFINED_KEY = 1u,
  CY_MSC_CAPSENSE_KEY = 2u
}
 Definitions of upper level keys that use the driver. More...
 

Detailed Description

Enumeration Type Documentation

◆ cy_en_msc_status_t

MSC status definitions.

Enumerator
CY_MSC_SUCCESS 

Successful.

CY_MSC_BAD_PARAM 

One or more invalid parameters.

CY_MSC_BUSY 

The MSC HW block performs conversion.

CY_MSC_LOCKED 

The MSC HW block is captured by another middleware.

◆ cy_en_msc_key_t

Definitions of upper level keys that use the driver.

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

Enumerator
CY_MSC_NONE_KEY 

The MSC HW block is unused and not captured by any middleware.

CY_MSC_USER_DEFINED_KEY 

The MSC HW block is captured by the application program directly to implement a customer's specific case.

CY_MSC_CAPSENSE_KEY 

The MSC HW block is captured by a CAPSENSE middleware.