GAP Common Exported Types

group GAP_Common_Exported_Types

Enums

enum T_GAP_IO_CAP

IO Capabilities.

Values:

enumerator GAP_IO_CAP_DISPLAY_ONLY: Only a Display present, no Keyboard or Yes/No Keys.

enumerator GAP_IO_CAP_DISPLAY_YES_NO: Display and Yes/No Keys present.

enumerator GAP_IO_CAP_KEYBOARD_ONLY: Only a Keyboard present, no Display.

enumerator GAP_IO_CAP_NO_INPUT_NO_OUTPUT: No input/output capabilities.

enumerator GAP_IO_CAP_KEYBOARD_DISPLAY: Keyboard and Display present.

enum T_GAP_KEY_TYPE

Key types.

Values:

enumerator GAP_KEY_COMBINATION: Combination key.

enumerator GAP_KEY_LOCAL_UNIT: Local unit key.

enumerator GAP_KEY_REMOTE_UNIT: Remote unit key.

enumerator GAP_KEY_DEBUG_COMBINATION: Debug combination key.

enumerator GAP_KEY_UNAUTHEN: SSP generated link key without MITM protection.

enumerator GAP_KEY_AUTHEN: SSP generated link key with MITM protection.

enumerator GAP_KEY_CHANGED_COMBINATION: Changed combination key.

enumerator GAP_KEY_UNAUTHEN_P256: Secure Connections generated link key without MITM protection.

enumerator GAP_KEY_AUTHEN_P256: Secure Connections generated key with MITM protection.

enumerator GAP_KEY_LE_LOCAL_LTK: Bluetooth LE Local Long Term Key.

enumerator GAP_KEY_LE_REMOTE_LTK: Bluetooth LE Remote Long Term Key.

enumerator GAP_KEY_LE_LOCAL_IRK: Bluetooth LE Local Identity Resolving Key.

enumerator GAP_KEY_LE_REMOTE_IRK: Bluetooth LE Remote Identity Resolving Key.

enumerator GAP_KEY_LE_LOCAL_CSRK: Bluetooth LE Local Connection Signature Resolving Key.

enumerator GAP_KEY_LE_REMOTE_CSRK: Bluetooth LE Remote Connection Signature Resolving Key.

enumerator GAP_KEY_REQ_BR: Only used to request a BR/EDR link key.

enumerator GAP_KEY_DELETE: Link key is no longer valid and should be deleted.

enum T_GAP_KEYPRESS_NOTIF_TYPE

Keypress notification type.

Values:

enumerator GAP_PASSKEY_ENTRY_STARTED: Passkey entry started.

enumerator GAP_PASSKEY_DIGIT_ENTERED: Passkey digit entered.

enumerator GAP_PASSKEY_DIGIT_ERASED: Passkey digit erased.

enumerator GAP_PASSKEY_CLEARED: Passkey cleared.

enumerator GAP_PASSKEY_ENTRY_CMPL: Passkey entry completed.

enum T_GAP_REMOTE_ADDR_TYPE

GAP Remote Address Type.

Values:

enumerator GAP_REMOTE_ADDR_LE_PUBLIC: LE Public device address type.

enumerator GAP_REMOTE_ADDR_LE_RANDOM: LE Random device address type.

enumerator GAP_REMOTE_ADDR_LE_PUBLIC_IDENTITY: LE Public identity address type.

enumerator GAP_REMOTE_ADDR_LE_RANDOM_IDENTITY: LE Random identity address type.

enumerator GAP_REMOTE_ADDR_CLASSIC: BR/EDR device address type.

enumerator GAP_REMOTE_ADDR_LE_ANONYMOUS: LE anonymous device address type.

enum T_GAP_CAUSE

GAP Cause.

Values:

enumerator GAP_CAUSE_SUCCESS: Operation success.

enumerator GAP_CAUSE_ALREADY_IN_REQ: Operation already in progress.

enumerator GAP_CAUSE_INVALID_STATE: Invalid state.

enumerator GAP_CAUSE_INVALID_PARAM: Invalid parameter.

enumerator GAP_CAUSE_NON_CONN: No connection establishment.

enumerator GAP_CAUSE_NOT_FIND_IRK: IRK not found.

enumerator GAP_CAUSE_ERROR_CREDITS: Credits error.

enumerator GAP_CAUSE_SEND_REQ_FAILED: Send Request failed.

enumerator GAP_CAUSE_NO_RESOURCE: No resource.

enumerator GAP_CAUSE_INVALID_PDU_SIZE: Invalid PDU size.

enumerator GAP_CAUSE_NOT_FIND: Not Found.

enumerator GAP_CAUSE_CONN_LIMIT: Connection reaches limited count.

enumerator GAP_CAUSE_NO_BOND: No Bond.

enumerator GAP_CAUSE_ERROR_UNKNOWN: Unknown error.

enum T_GAP_CFM_CAUSE

GAP Confirmation Cause.

Values:

enumerator GAP_CFM_CAUSE_ACCEPT: Accept for indication, only used when confirmation.

enumerator GAP_CFM_CAUSE_REJECT: Reject for indication, only used when confirmation.

enum T_APP_RESULT

APP Return Result.

Values:

enumerator APP_RESULT_SUCCESS

enumerator APP_RESULT_PENDING

enumerator APP_RESULT_ACCEPT

enumerator APP_RESULT_REJECT

enumerator APP_RESULT_NOT_RELEASE

enumerator APP_RESULT_PREP_QUEUE_FULL

enumerator APP_RESULT_INVALID_OFFSET

enumerator APP_RESULT_INVALID_VALUE_SIZE

enumerator APP_RESULT_INVALID_PDU

enumerator APP_RESULT_ATTR_NOT_FOUND

enumerator APP_RESULT_ATTR_NOT_LONG

enumerator APP_RESULT_INSUFFICIENT_RESOURCES

enumerator APP_RESULT_VALUE_NOT_ALLOWED

enumerator APP_RESULT_APP_ERR

enumerator APP_RESULT_CCCD_IMPROPERLY_CONFIGURED

enumerator APP_RESULT_PROC_ALREADY_IN_PROGRESS

enum T_GAP_PARAM_TYPE

GAP Parameter.

Values:

enumerator GAP_PARAM_BD_ADDR: Public device address. Read only. Size is 6 octets GAP_BD_ADDR_LEN.

enumerator GAP_PARAM_BOND_PAIRING_MODE: Pairing Mode of LE and BR/EDR. Write only. Size is 1 octet. Value is Pairing Modes. Default value is GAP_PAIRING_MODE_PAIRABLE.

enumerator GAP_PARAM_BOND_AUTHEN_REQUIREMENTS_FLAGS: Authentication requirements. Write only. Size is 2 octets. Value is Authentication Requirements. Default value is GAP_AUTHEN_BIT_BONDING_FLAG.

enumerator GAP_PARAM_BOND_IO_CAPABILITIES: IO capabilities. Read/Write. Size is 1 octet. Value is T_GAP_IO_CAP. Default value is GAP_IO_CAP_NO_INPUT_NO_OUTPUT.

enumerator GAP_PARAM_BOND_OOB_ENABLED: OOB data available for pairing algorithm. Read/Write. Size is 1 octet. Default value is 0(disabled).

enumerator GAP_PARAM_BOND_LINK_KEY_CONVERT: Link Key Convert. Write only. Size is 1 octet. Value is Link Key Conversion Flags. Default value is GAP_SC_KEY_CONVERT_NONE.

enumerator GAP_PARAM_BOND_BR_PAIRING_MODE: BR/EDR Pairing Mode. Read/Write. Size is 1 octet. Value is Pairing Modes. Default value is GAP_PAIRING_MODE_PAIRABLE.

enumerator GAP_PARAM_BOND_BR_AUTHEN_REQUIREMENTS_FLAGS: BR/EDR authentication requirements. Write only. Size is 2 octets. Value is Authentication Requirements. Default value is GAP_AUTHEN_BIT_BONDING_FLAG.

enumerator GAP_PARAM_BOND_BR_IO_CAPABILITIES: BR/EDR IO capabilities. Write only. Size is 1 octet. Value is T_GAP_IO_CAP. Default value is GAP_IO_CAP_NO_INPUT_NO_OUTPUT.

enumerator GAP_PARAM_BOND_LE_PAIRING_MODE: LE Pairing Mode. Read/Write. Size is 1 octet. Value is Pairing Modes. Default value is GAP_PAIRING_MODE_PAIRABLE.

enumerator GAP_PARAM_BOND_LE_AUTHEN_REQUIREMENTS_FLAGS: LE authentication requirements. Write only. Size is 2 octets. Value is Authentication Requirements. Default value is GAP_AUTHEN_BIT_BONDING_FLAG.

enumerator GAP_PARAM_BOND_LE_IO_CAPABILITIES: LE IO capabilities. Write only. Size is 1 octet. Value is T_GAP_IO_CAP. Default value is GAP_IO_CAP_NO_INPUT_NO_OUTPUT.

enum T_GAP_PA_SYNC_ADV_ADDR_TYPE

GAP PA Sync Advertiser Address Type.

Values:

enumerator PA_SYNC_ADV_ADDR_PUBLIC: Public Device Address for reception of info; otherwise, Public Device Address or Public Identity Address.

enumerator PA_SYNC_ADV_ADDR_RANDOM: Random Device Address for reception of info; otherwise, Random Device Address or Random (static) Identity Address.

enumerator PA_SYNC_ADV_ADDR_RPA_PUBLIC_IDENTITY: Public Identity Address (corresponds to Resolved Private Address), only for reception of info.

enumerator PA_SYNC_ADV_ADDR_RPA_RANDOM_IDENTITY: Random (static) Identity Address (corresponds to Resolved Private Address), only for reception of info.

struct T_GAP_WRITE_AIRPLAN_MODE_RSP

Response for write airplane mode.

Public Members

uint16_t cause: Write response cause.

struct T_GAP_READ_AIRPLAN_MODE_RSP

Response for read airplane mode.

Public Members

uint16_t cause: Read response cause.

uint8_t mode

Current airplane mode.

0x00: Airplane mode disable.
0x01: Airplane mode enable.

struct T_GAP_SET_BD_ADDR_RSP

Response for set local public address.

Public Members

uint16_t cause: Set response cause.

uint8_t bd_addr[6]: Public bluetooth address.

struct T_GAP_DUMP_TX_GAIN_IDX_RSP

Public Members

uint16_t cause

uint8_t iqm_legacy_1m_idx

uint8_t iqm_legacy_2m_idx

uint8_t iqm_legacy_3m_idx

uint8_t iqm_le_1m_idx

uint8_t iqm_le_2m_idx

uint8_t iqm_le_2m_2402_idx

uint8_t iqm_le_2m_2480_idx

uint8_t tpm_legacy_1m_idx

uint8_t tpm_le_1m_idx

uint8_t tpm_le_2m_idx

uint8_t tpm_le_2m_2402_idx

uint8_t tpm_le_2m_2480_idx

struct T_GAP_VND_CMD_FAIL_RSP

Public Members

uint16_t cause

uint16_t command

struct T_GAP_VND_CMD_CMPL_EVT_RSP

Public Members

uint16_t command: Vendor command. Should be the same as that in request.

uint16_t cause: Result of executing command.

bool is_cmpl_evt: Whether the response is generated from command complete event.

uint8_t param_len: Response parameter length.

uint8_t *p_param: Response parameter buffer.

struct T_GAP_READ_CONNECTION_ACCEPT_TIMEOUT_RSP

Public Members

uint16_t cause

uint16_t connection_accept_timeout

struct T_GAP_WRITE_CONNECTION_ACCEPT_TIMEOUT_RSP

Public Members

uint16_t cause

struct T_GAP_CONFIGURE_DATA_PATH_RSP

Public Members

uint16_t cause

struct T_GAP_READ_LOCAL_SUPPORTED_CODECS_V2_RSP

Public Members

uint16_t cause

uint8_t num_supported_standard_codecs

uint8_t num_supported_vendor_specific_codecs

uint8_t *p_standard_codecs

uint8_t *p_vendor_specific_codecs

struct T_GAP_READ_LOCAL_SUPPORTED_CODEC_CAPABILITIES_RSP

Public Members

uint16_t cause

uint8_t num_codec_capabilities

uint8_t *p_codec_capability_combination

uint8_t codec_capability_combination_len

struct T_GAP_READ_LOCAL_SUPPORTED_CONTROLLER_DELAY_RSP

Public Members

uint16_t cause

uint32_t min_controller_delay

uint32_t max_controller_delay

struct T_GAP_CHANN_ADDED

Information for L2CAP channel added. This L2CAP channel can transmit ATT PDU.

Public Members

T_GAP_CHANN_TYPE chann_type

uint16_t conn_handle

uint16_t cid

uint16_t mtu_size

struct T_GAP_CHANN_DEL

Information for L2CAP channel removed.

Public Members

uint16_t conn_handle

uint16_t cid

struct T_GAP_CHANN_MTU_UPDATE

Information for L2CAP channel MTU updated.

Public Members

uint16_t conn_handle

uint16_t cid

uint16_t mtu_size

struct T_GAP_VENDOR_LE_EVT_INFO

LE Vendor event information.

Public Members

uint8_t param_len: Information parameter length.

uint8_t param[1]: Information parameter buffer.

struct T_GAP_VENDOR_CMD_RSP

Vendor command response.

Public Members

uint16_t command: Vendor command. Should be the same as that in request.

uint16_t cause: Result of executing command.

bool is_cmpl_evt: Whether the response is generated from command complete event.

uint8_t param_len: Response parameter length.

uint8_t param[1]: Response parameter buffer.

union T_GAP_CB_DATA

GAP callback data.

Public Members

T_GAP_WRITE_AIRPLAN_MODE_RSP *p_gap_write_airplan_mode_rsp

T_GAP_READ_AIRPLAN_MODE_RSP *p_gap_read_airplan_mode_rsp

T_GAP_SET_BD_ADDR_RSP *p_gap_set_bd_addr_rsp

T_GAP_DUMP_TX_GAIN_IDX_RSP *p_gap_dump_tx_gain_idx_rsp

T_GAP_VND_CMD_CMPL_EVT_RSP *p_gap_vnd_cmd_cmpl_evt_rsp

T_GAP_READ_CONNECTION_ACCEPT_TIMEOUT_RSP *p_read_connection_accept_timeout_rsp

T_GAP_WRITE_CONNECTION_ACCEPT_TIMEOUT_RSP *p_write_connection_accept_timeout_rsp

T_GAP_CONFIGURE_DATA_PATH_RSP *p_configure_data_path_rsp

T_GAP_READ_LOCAL_SUPPORTED_CODECS_V2_RSP *p_read_local_supported_codecs_v2_rsp

T_GAP_READ_LOCAL_SUPPORTED_CODEC_CAPABILITIES_RSP *p_read_local_supported_codec_capabilities_rsp

T_GAP_READ_LOCAL_SUPPORTED_CONTROLLER_DELAY_RSP *p_read_local_supported_controller_delay_rsp

T_GAP_CHANN_ADDED *p_gap_chann_added

T_GAP_CHANN_DEL *p_gap_chann_del

T_GAP_CHANN_MTU_UPDATE *p_gap_chann_mtu_update

T_GAP_VENDOR_CMD_RSP *p_gap_vendor_cmd_rsp

T_GAP_VENDOR_LE_EVT_INFO *p_gap_vendor_evt_info

void *p_gap_cb_data