Enumerated Types

General Description

Enumerations are used in the driver.

Enumerations
enum	cy_en_btipcdrv_status_t {   CY_BT_IPC_DRV_SUCCESS =(uint32_t)(0x00u),   CY_BT_IPC_DRV_ERROR =(uint32_t)(CY_BT_IPC_ID_ERROR | 1UL),   CY_BT_IPC_DRV_ERROR_BAD_HANDLE =(uint32_t)(CY_BT_IPC_ID_ERROR | 2UL),   CY_BT_IPC_DRV_ERROR_CH_BUSY =(uint32_t)(CY_BT_IPC_ID_ERROR | 3UL),   CY_BT_IPC_DRV_ERROR_LOCK_REL =(uint32_t)(CY_BT_IPC_ID_ERROR | 4UL),   CY_BT_IPC_DRV_ERROR_LOCK_ACQUIRE =(uint32_t)(CY_BT_IPC_ID_ERROR | 5UL),   CY_BT_IPC_DRV_ERROR_BUF_GET =(uint32_t)(CY_BT_IPC_ID_ERROR | 6UL),   CY_BT_IPC_DRV_ERROR_BUF_FULL =(uint32_t)(CY_BT_IPC_ID_ERROR | 7UL),   CY_BT_IPC_DRV_ERROR_BUF_EMPTY =(uint32_t)(CY_BT_IPC_ID_ERROR | 8UL),   CY_BT_IPC_DRV_ERROR_BUF_PRESENT =(uint32_t)(CY_BT_IPC_ID_ERROR | 9UL),   CY_BT_IPC_DRV_ERROR_BUF_SIZE =(uint32_t)(CY_BT_IPC_ID_ERROR | 10UL),   CY_BT_IPC_DRV_ERROR_PARAM =(uint32_t)(CY_BT_IPC_ID_ERROR | 11UL) }
	This is a list of ENUMs used for function return status. More...
enum	cy_en_btipc_buftype_t {   CY_BT_IPC_CTRL_BUF = (0x00u),   CY_BT_IPC_HCI_CMD_BUF = (0x01u),   CY_BT_IPC_HCI_BREDR_BUF = (0x02u),   CY_BT_IPC_HCI_BLE_BUF = (0x03u),   CY_BT_IPC_HCI_ISOC_BUF = (0x04u),   CY_BT_IPC_HCI_INVALID_BUF = (0xFFu) }
	This is a list of ENUMs used for buffer types. More...
enum	cy_en_btipc_hcipti_t {   CY_BT_IPC_HCI_IGNORE = (0x00u),   CY_BT_IPC_HCI_CMD = (0x01u),   CY_BT_IPC_HCI_ACL = (0x02u),   CY_BT_IPC_HCI_SCO = (0x03u),   CY_BT_IPC_HCI_EVT = (0x04u),   CY_BT_IPC_HCI_ISO = (0x05u),   CY_BT_IPC_HCI_DIAG = (0x07u),   CY_BT_IPC_HCI_MPAF = (0x0Au),   CY_BT_IPC_HCI_SLIPH5 = (0xC0u),   CY_BT_IPC_HCI_LONG = (0xFFu) }
	This is a list of ENUMs used for HCI packet type. More...
enum	cy_en_btipc_hpcpti_t {   CY_BT_IPC_HPC_RESERVED = (0x00u),   CY_BT_IPC_HPC_BUFRELEASE = (0x01u),   CY_BT_IPC_HPC_REQTRNG = (0x02u),   CY_BT_IPC_HPC_BUFPROVIDE = (0x03u),   CY_BT_IPC_HPC_PM = (0x04u),   CY_BT_IPC_HPC_RESACCESS = (0x05u),   CY_BT_IPC_HPC_LPO_SWITCH = (0x06u),   CY_BT_IPC_HPC_INRUSH_MODE = (0x07u),   CY_BT_IPC_HPC_BUFFER_REMOVE = (0x08u),   CY_BT_IPC_HPC_LONG = (0xFFu) }
	This is a list of ENUMs used for HPC packet type. More...
enum	cy_en_btipc_hpcmsgid_t {   CY_BT_IPC_HPC_INIT = (0x01u),   CY_BT_IPC_HPC_HADM = (0x02u),   CY_BT_IPC_HPC_DUMMY = (0x10u) }
	This is a list of ENUMs used for HPC long message type. More...
enum	cy_en_btipc_boottype_t {   CY_BT_IPC_BOOT_CONFIG_WAIT = (0x00u),   CY_BT_IPC_BOOT_FULLY_UP = (0x01u) }
	This is a list of ENUMs used for bt boot type. More...
enum	cy_en_btipc_pm_cmd_t { CY_BT_IPC_PM_HIBERNATE_CMD = (0x01u) }
	This is a list of ENUMs used in PM command from MCU to BTSS. More...
enum	cy_en_btipc_pm_resp_t {   CY_BT_IPC_PM_ACCEPTED = (0x00u),   CY_BT_IPC_PM_REJECTED = (0x01u) }
	This is a list of ENUMs used in PM response from BTSS to MCU. More...
enum	cy_en_btipc_recacc_req_t {   CY_BT_IPC_RESACC_DI = (0x00u),   CY_BT_IPC_RESACC_EN = (0x01u) }
	This is a list of ENUMs used in resource access request from BTSS to MCU. More...
enum	cy_en_btipc_recacc_resp_t {   CY_BT_IPC_RESACC_ACCEPTED = (0x00u),   CY_BT_IPC_RESACC_REJECTED = (0x01u) }
	This is a list of ENUMs used as response from MCCU to BTSS for resource access request. More...
enum	cy_en_btipc_lpo_cmd_t {   CY_BT_IPC_LPO_PILO = (0x00u),   CY_BT_IPC_LPO_WCO = (0x01u),   CY_BT_IPC_LPO_WCO_BYPASS = (0x02u) }
	This is a list of ENUMs used for LPO change indication from MCUSS to BTSS. More...
enum	cy_en_btipc_inrush_mode_t {   CY_BT_IPC_INRUSH_LOW = (0x00u),   CY_BT_IPC_INRUSH_HIGH = (0x01u) }
	This is a list of ENUMs used for cbuk inrush mode indication from MCUSS to BTSS. More...
enum	cy_en_btipc_hci_diag_msg_type_t {   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_NOP = (0x00U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_ALIVE_IND = (0x02U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_CPU_LOAD = (0x10U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_RESET_STATS = (0xB9U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_LMP_LOG = (0xF0U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_MEM_PEEK = (0xF1U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_MEM_POKE = (0xF2U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_MEM_HEXDUMP = (0xF3U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_SEND_STATS = (0xF4U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_BB_PKT_TEST = (0xF6U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_PICO_TEST = (0xF7U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_HCI_LOG = (0xF8U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_PICO_STATS = (0xF9U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_AUX_STATS = (0xFAU),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_SEND_RSSI = (0xFBU),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_BAD_EVENT_LOG = (0xFCU),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_READ_2040_GPIO = (0xFDU),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_SEND_BASIC_RATE_ACL_STATS = (0xC1U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_SEND_EDR_ACL_STATS = (0xC2U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_2045_AUX_STATS = (0xC3U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_SEND_BASIC_RATE_SCO_STATS = (0xC5U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_SEND_EDR_SCO_STATS = (0xC6U),   CY_BT_IPC_HCI_DIAG_IN_PKT_ID_BLE_CONN_STATS = (0xCFU) }
	This is a list of ENUMs used for HCI DAIG packet type.

Enumeration Type Documentation

cy_en_btipcdrv_status_t

enum cy_en_btipcdrv_status_t

This is a list of ENUMs used for function return status.

Enumerator
CY_BT_IPC_DRV_SUCCESS	BT IPC API return for no error.
CY_BT_IPC_DRV_ERROR	BT IPC API return for general error.
CY_BT_IPC_DRV_ERROR_BAD_HANDLE	BT IPC API return for bad handle.
CY_BT_IPC_DRV_ERROR_CH_BUSY	BT IPC API return for channel busy.
CY_BT_IPC_DRV_ERROR_LOCK_REL	BT IPCAPI return for channel release error.
CY_BT_IPC_DRV_ERROR_LOCK_ACQUIRE	BT IPC API return for channel release error.
CY_BT_IPC_DRV_ERROR_BUF_GET	BT IPC API return for get buffer error.
CY_BT_IPC_DRV_ERROR_BUF_FULL	BT IPC API return for buffer full error.
CY_BT_IPC_DRV_ERROR_BUF_EMPTY	BT IPC API return for buffer empty error.
CY_BT_IPC_DRV_ERROR_BUF_PRESENT	BT IPC API return for buffer already present error.
CY_BT_IPC_DRV_ERROR_BUF_SIZE	BT IPC API return for buffer of size not available error.
CY_BT_IPC_DRV_ERROR_PARAM	BT IPC API return for bad parameter error.

cy_en_btipc_buftype_t

enum cy_en_btipc_buftype_t

This is a list of ENUMs used for buffer types.

Enumerator
CY_BT_IPC_CTRL_BUF	Control buffer type.
CY_BT_IPC_HCI_CMD_BUF	Command buffer type.
CY_BT_IPC_HCI_BREDR_BUF	BR/EDR buffer type.
CY_BT_IPC_HCI_BLE_BUF	BLE buffer type.
CY_BT_IPC_HCI_ISOC_BUF	ISOC buffer type.
CY_BT_IPC_HCI_INVALID_BUF	Invalid buffer type.

cy_en_btipc_hcipti_t

enum cy_en_btipc_hcipti_t

This is a list of ENUMs used for HCI packet type.

Enumerator
CY_BT_IPC_HCI_IGNORE	HCI payload type ignore.
CY_BT_IPC_HCI_CMD	HCI payload type command.
CY_BT_IPC_HCI_ACL	HCI payload type ACL.
CY_BT_IPC_HCI_SCO	HCI payload type SCO.
CY_BT_IPC_HCI_EVT	HCI payload type Event.
CY_BT_IPC_HCI_ISO	HCI payload type ISO.
CY_BT_IPC_HCI_DIAG	HCI payload type Diagnostics.
CY_BT_IPC_HCI_MPAF	HCI payload type MPAF.
CY_BT_IPC_HCI_SLIPH5	HCI payload type SLIPH5.
CY_BT_IPC_HCI_LONG	HCI payload type long message.

cy_en_btipc_hpcpti_t

enum cy_en_btipc_hpcpti_t

This is a list of ENUMs used for HPC packet type.

Enumerator
CY_BT_IPC_HPC_RESERVED	..Reserved (not used)
CY_BT_IPC_HPC_BUFRELEASE	HPC payload type buffer release, sent from MCU only.
CY_BT_IPC_HPC_REQTRNG	HPC payload type request TRNG.
CY_BT_IPC_HPC_BUFPROVIDE	HPC payload type provide buffer, sent from BT only.
CY_BT_IPC_HPC_PM	HPC payload type PM control.
CY_BT_IPC_HPC_RESACCESS	HPC payload type Resource Access.
CY_BT_IPC_HPC_LPO_SWITCH	HPC payload type LPO Clk switch.
CY_BT_IPC_HPC_INRUSH_MODE	HPC payload type inrush mode select.
CY_BT_IPC_HPC_BUFFER_REMOVE	HPC payload type buffer remove, sent from BT only.
CY_BT_IPC_HPC_LONG	HPC payload type long message.

cy_en_btipc_hpcmsgid_t

enum cy_en_btipc_hpcmsgid_t

This is a list of ENUMs used for HPC long message type.

Enumerator
CY_BT_IPC_HPC_INIT	..Init message
CY_BT_IPC_HPC_HADM	HADM data message from BTSS to MCU.
CY_BT_IPC_HPC_DUMMY	DUMMY data message from MCU to BTSS.

cy_en_btipc_boottype_t

enum cy_en_btipc_boottype_t

This is a list of ENUMs used for bt boot type.

Enumerator
CY_BT_IPC_BOOT_CONFIG_WAIT	BTSS is reset and is in boot waiting for a config from the MCU. If certificate error indicates any error processing certificates
CY_BT_IPC_BOOT_FULLY_UP	BTSS is fully up. It either processed a config from the MCU, or the MCU did not send a config. If the certificate error value is non-zero, there was an error processing certificates after getting the config, but the boot continued anyway.

cy_en_btipc_pm_cmd_t

enum cy_en_btipc_pm_cmd_t

This is a list of ENUMs used in PM command from MCU to BTSS.

Enumerator
CY_BT_IPC_PM_HIBERNATE_CMD	Command for Hibernate state.

cy_en_btipc_pm_resp_t

enum cy_en_btipc_pm_resp_t

This is a list of ENUMs used in PM response from BTSS to MCU.

Enumerator
CY_BT_IPC_PM_ACCEPTED	PM command accepted.
CY_BT_IPC_PM_REJECTED	PM command rejected.

cy_en_btipc_recacc_req_t

enum cy_en_btipc_recacc_req_t

This is a list of ENUMs used in resource access request from BTSS to MCU.

Enumerator
CY_BT_IPC_RESACC_DI	Resource access disable request.
CY_BT_IPC_RESACC_EN	Resource access enable request.

cy_en_btipc_recacc_resp_t

enum cy_en_btipc_recacc_resp_t

This is a list of ENUMs used as response from MCCU to BTSS for resource access request.

Enumerator
CY_BT_IPC_RESACC_ACCEPTED	Resource access request accepted.
CY_BT_IPC_RESACC_REJECTED	Resource access request rejected.

cy_en_btipc_lpo_cmd_t

enum cy_en_btipc_lpo_cmd_t

This is a list of ENUMs used for LPO change indication from MCUSS to BTSS.

Enumerator
CY_BT_IPC_LPO_PILO	LPO clk type PILO.
CY_BT_IPC_LPO_WCO	LPO clk type WCO.
CY_BT_IPC_LPO_WCO_BYPASS	LPO clk type WCO BYPASS.

cy_en_btipc_inrush_mode_t

enum cy_en_btipc_inrush_mode_t

This is a list of ENUMs used for cbuk inrush mode indication from MCUSS to BTSS.

Enumerator
CY_BT_IPC_INRUSH_LOW	Inrush limit low.
CY_BT_IPC_INRUSH_HIGH	Inrush limit high.