MTB CAT1 Peripheral driver library
Enumerated Types

General Description

Enumerations

enum  cy_en_ks_status_t {
  CY_KEYSCAN_SUCCESS = 0x00u,
  CY_KEYSCAN_BAD_PARAM = CY_KEYSCAN_ID | CY_PDL_STATUS_ERROR | 0x01u,
  CY_KEYSCAN_BUSY = CY_KEYSCAN_ID | CY_PDL_STATUS_ERROR | 0x02u,
  CY_KEYSCAN_QUEUE_OVERFLOW = CY_KEYSCAN_ID | CY_PDL_STATUS_ERROR | 0x03u,
  CY_KEYSCAN_QUEUE_EMPTY = CY_KEYSCAN_ID | CY_PDL_STATUS_ERROR | 0x04u,
  CY_KEYSCAN_EVENT_NONE = CY_KEYSCAN_ID | CY_PDL_STATUS_ERROR | 0x05u
}
 KEYSCAN API status definition. More...
 
enum  cy_en_ks_keycode_t {
  KEYSCAN_KEYCODE_GHOST = 0xf5,
  KEYSCAN_KEYCODE_NONE = 0xfd,
  KEYSCAN_KEYCODE_END_OF_SCAN_CYCLE = 0xfe,
  KEYSCAN_KEYCODE_ROLLOVER = 0xff
}
 Keycode enumerations. More...
 

Enumeration Type Documentation

◆ cy_en_ks_status_t

KEYSCAN API status definition.

Enumerator
CY_KEYSCAN_SUCCESS 

Returned successful.

CY_KEYSCAN_BAD_PARAM 

Bad parameter was passed.

CY_KEYSCAN_BUSY 

Change settings while tx/rx on-going.

CY_KEYSCAN_QUEUE_OVERFLOW 

QUEUE Over flow condition.

CY_KEYSCAN_QUEUE_EMPTY 

QUEUE Empty condition.

CY_KEYSCAN_EVENT_NONE 

Event None.

◆ cy_en_ks_keycode_t

Keycode enumerations.

Enumerator
KEYSCAN_KEYCODE_GHOST 

Ghost key keycode.

KEYSCAN_KEYCODE_NONE 

Keycode value if no key is pressed.

KEYSCAN_KEYCODE_END_OF_SCAN_CYCLE 

Event returned to indicate the end of a scan cycle.

KEYSCAN_KEYCODE_ROLLOVER 

Rollover event generated by the keyscan driver in case of an error (ghost or overflow) For every key event its state has to be stored and if there is an error, then rollover event is triggered and driver restores the previous state.