GAP LE Types Exported Types

group GAP_LE_TYPES_Exported_Types

Enums

enum T_GAP_LOCAL_ADDR_TYPE

Define local address type.

Values:

enumerator GAP_LOCAL_ADDR_LE_PUBLIC

Public Device Address.

enumerator GAP_LOCAL_ADDR_LE_RANDOM

Random Device Address.

enumerator GAP_LOCAL_ADDR_LE_RAP_OR_PUBLIC

Controller generates the Resolvable Private Address based on the local IRK from the resolving list. If the resolving list contains no matching entry, then use the public address.

enumerator GAP_LOCAL_ADDR_LE_RAP_OR_RAND

Controller generates the Resolvable Private Address based on the local IRK from the resolving list. If the resolving list contains no matching entry, then use the random address.

enum T_GAP_RAND_ADDR_TYPE

Define random address type.

Values:

enumerator GAP_RAND_ADDR_STATIC

Static device address.

enumerator GAP_RAND_ADDR_NON_RESOLVABLE

Non-resolvable private address.

enumerator GAP_RAND_ADDR_RESOLVABLE

Resolvable private address.

enum T_GAP_IDENT_ADDR_TYPE

Define identity address type.

Values:

enumerator GAP_IDENT_ADDR_PUBLIC

Identity Address Information uses public device address.

enumerator GAP_IDENT_ADDR_RAND

Identity Address Information uses static random address.

enum T_GAP_DIRECT_ADDR_TYPE

Definition of LE direct address type.

Values:

enumerator GAP_DIRECT_ADDR_LE_PUBLIC

Public Device Address (default).

enumerator GAP_DIRECT_ADDR_LE_RAND

Random Device Address.

enumerator GAP_DIRECT_ADDR_LE_PUBLIC_IDENT

Public Identity Address (Corresponds to Resolved Private Address).

enumerator GAP_DIRECT_ADDR_LE_RAND_IDENT

Random (static) Identity Address (Corresponds to Resolved Private Address).

enumerator GAP_DIRECT_ADDR_LE_RAND_UNABLE_RESOLV

No address provided (anonymous advertisement).

enum T_GAP_WHITE_LIST_OP

Definition of LE Filter Accept List operation.

Values:

enumerator GAP_WHITE_LIST_OP_CLEAR

Clear Filter Accept List.

enumerator GAP_WHITE_LIST_OP_ADD

Add a device to the Filter Accept List.

enumerator GAP_WHITE_LIST_OP_REMOVE

Remove a device from the Filter Accept List.

enum T_GAP_ADTYPE

Advertising Event Types.

Values:

enumerator GAP_ADTYPE_ADV_IND

Connectable undirected advertisement.

enumerator GAP_ADTYPE_ADV_HDC_DIRECT_IND

Connectable high duty cycle directed advertisement.

enumerator GAP_ADTYPE_ADV_SCAN_IND

Scannable undirected advertisement.

enumerator GAP_ADTYPE_ADV_NONCONN_IND

Non-Connectable undirected advertisement.

enumerator GAP_ADTYPE_ADV_LDC_DIRECT_IND

Connectable low duty cycle directed advertisement.

enum T_GAP_ADV_FILTER_POLICY

Definition of LE advertising filter policy.

Values:

enumerator GAP_ADV_FILTER_ANY

Process scan and connection requests from all devices (i.e., the Filter Accept List is not in use) (default).

enumerator GAP_ADV_FILTER_WHITE_LIST_SCAN

Process connection requests from all devices and only scan requests from devices that are in the Filter Accept List.

enumerator GAP_ADV_FILTER_WHITE_LIST_CONN

Process scan requests from all devices and only connection requests from devices that are in the Filter Accept List.

enumerator GAP_ADV_FILTER_WHITE_LIST_ALL

Process scan and connection requests only from devices in the Filter Accept List.

enum T_GAP_SCAN_MODE

Definition of LE scan type.

Values:

enumerator GAP_SCAN_MODE_PASSIVE

Passive Scanning. No scan request PDUs shall be sent.

enumerator GAP_SCAN_MODE_ACTIVE

Active Scanning. Scan request PDUs may be sent.

enum T_GAP_SCAN_FILTER_POLICY

Definition of LE scan filter policy.

Values:

enumerator GAP_SCAN_FILTER_ANY

Accept all advertising packets except directed advertising packets not addressed to this device (default).

enumerator GAP_SCAN_FILTER_WHITE_LIST

Accept only advertising packets from devices where the advertiser's address is in the Filter Accept List. Directed advertising packets which are not addressed to this device shall be ignored.

enumerator GAP_SCAN_FILTER_ANY_RPA

Accept all advertising packets except directed advertising packets where the initiator's identity address does not address this device.

Directed advertising packets where the initiator's address is a resolvable private address that cannot be resolved are also accepted.

enumerator GAP_SCAN_FILTER_WHITE_LIST_RPA

Accept all advertising packets except:

  • Advertising packets where the advertiser's identity address is not in the Filter Accept List;

  • Directed advertising packets where the initiator's identity address does not address this device.

Directed advertising packets where the initiator's address is a resolvable private address that cannot be resolved are also accepted.

enum T_GAP_SCAN_FILTER_DUPLICATE

Definition of LE extended scan duplicate filter type.

Values:

enumerator GAP_SCAN_FILTER_DUPLICATE_DISABLE

Duplicate filtering disabled.

enumerator GAP_SCAN_FILTER_DUPLICATE_ENABLE

Duplicate filtering enabled.

enumerator GAP_SCAN_FILTER_DUPLICATE_ENABLED_RESET_FOR_EACH_PERIOD

Duplicate filtering enabled, reset for each scan period.

enum T_GAP_ADV_EVT_TYPE

This enum type describes ADV type.

Values:

enumerator GAP_ADV_EVT_TYPE_UNDIRECTED

Connectable undirected advertising.

enumerator GAP_ADV_EVT_TYPE_DIRECTED

Connectable directed advertising.

enumerator GAP_ADV_EVT_TYPE_SCANNABLE

Scannable undirected advertising.

enumerator GAP_ADV_EVT_TYPE_NON_CONNECTABLE

Nonconnectable undirected advertising.

enumerator GAP_ADV_EVT_TYPE_SCAN_RSP

Scan response.

enum T_GAP_SEC_LEVEL

Definition of security level.

Values:

enumerator GAP_SEC_LEVEL_NO

No security (No authentication and no encryption).

enumerator GAP_SEC_LEVEL_UNAUTHEN

Unauthenticated pairing with encryption.

enumerator GAP_SEC_LEVEL_AUTHEN

Authenticated pairing with encryption.

enumerator GAP_SEC_LEVEL_SC_UNAUTHEN

Unauthenticated LE Secure Connections pairing with encryption using a 128- bit strength encryption key.

enumerator GAP_SEC_LEVEL_SC_AUTHEN

Authenticated LE Secure Connections pairing with encryption using a 128- bit strength encryption key.

enum T_GAP_RESOLV_LIST_OP

Definition of LE resolving list operation.

Values:

enumerator GAP_RESOLV_LIST_OP_CLEAR

Clear resolving list operation.

enumerator GAP_RESOLV_LIST_OP_ADD

Add a device to the resolving list operation.

enumerator GAP_RESOLV_LIST_OP_REMOVE

Remove a device from the resolving list operation.

enum T_GAP_PRIVACY_MODE

Definition of LE privacy mode.

Values:

enumerator GAP_PRIVACY_MODE_NETWORK

Network privacy mode.

enumerator GAP_PRIVACY_MODE_DEVICE

Device privacy mode.

enum T_GAP_PHYS_TYPE

Definition of LE PHY type.

Values:

enumerator GAP_PHYS_1M

LE PHY 1M used.

enumerator GAP_PHYS_2M

LE PHY 2M used.

enumerator GAP_PHYS_CODED

LE Coded PHY used.

enum T_GAP_PHYS_PRIM_ADV_TYPE

Definition of LE primary advertising PHY type.

Values:

enumerator GAP_PHYS_PRIM_ADV_1M

Primary advertisement PHY is LE 1M.

enumerator GAP_PHYS_PRIM_ADV_CODED

Primary advertisement PHY is LE Coded.

enum T_GAP_PHYS_OPTIONS

Definition of LE Coded PHY preference options.

Values:

enumerator GAP_PHYS_OPTIONS_CODED_PREFER_NO

Host has no preferred coding when transmitting on the LE Coded PHY.

enumerator GAP_PHYS_OPTIONS_CODED_PREFER_S2

Host prefers that S=2 coding be used when transmitting on the LE Coded PHY.

enumerator GAP_PHYS_OPTIONS_CODED_PREFER_S8

Host prefers that S=8 coding be used when transmitting on the LE Coded PHY.

enum T_GAP_EXT_ADV_EVT_DATA_STATUS

Values:

enumerator GAP_EXT_ADV_EVT_DATA_STATUS_COMPLETE

Data status: Complete.

enumerator GAP_EXT_ADV_EVT_DATA_STATUS_MORE

Data status: Incomplete, more data to come.

enumerator GAP_EXT_ADV_EVT_DATA_STATUS_TRUNCATED

Data status: Incomplete, data truncated, no more to come.

enumerator GAP_EXT_ADV_EVT_DATA_STATUS_RFU

Data status: Reserved for future use.

enum T_GAP_CTE_TYPE

Values:

enumerator GAP_CTE_TYPE_AOA

AoA Constant Tone Extension.

enumerator GAP_CTE_TYPE_AOD_1US_SLOT

AoD Constant Tone Extension with 1 us slots.

enumerator GAP_CTE_TYPE_AOD_2US_SLOT

AoD Constant Tone Extension with 2 us slots.

enum T_GAP_SLOT_DUATIONS_TYPE

Values:

enumerator GAP_SLOT_DURATIONS_SWITCH_SAMPLE_1US

Switching and sampling slots are 1 us each.

enumerator GAP_SLOT_DURATIONS_SWITCH_SAMPLE_2US

Switching and sampling slots are 2 us each.

enum T_GAP_PA_SYNC_PERIODIC_ADV_LIST_OP

Definition of LE Periodic Advertiser list operation.

Values:

enumerator GAP_PA_SYNC_PERIODIC_ADV_LIST_OP_CLEAR

Clear all entries from Periodic Advertiser list.

enumerator GAP_PA_SYNC_PERIODIC_ADV_LIST_OP_ADD

Add an entry to Periodic Advertiser list.

enumerator GAP_PA_SYNC_PERIODIC_ADV_LIST_OP_REMOVE

Remove one entry from Periodic Advertiser list.

enum T_GAP_PERIODIC_ADV_REPORT_DATA_STATUS

Definition of data status in LE Periodic Advertising Report.

Values:

enumerator GAP_PERIODIC_ADV_REPORT_DATA_STATUS_COMPLETE

Data complete.

enumerator GAP_PERIODIC_ADV_REPORT_DATA_STATUS_MORE

Data incomplete, more data to come.

enumerator GAP_PERIODIC_ADV_REPORT_DATA_STATUS_TRUNCATED

Data incomplete, data truncated, no more to come.

enumerator GAP_PERIODIC_ADV_REPORT_DATA_STATUS_FAILED

Failed to receive an AUX_SYNC_SUBEVENT_IND PDU.

enum T_GAP_PERIODIC_ADV_REPORT_CTE_TYPE

Definition of CTE type in LE Periodic Advertising Report.

Values:

enumerator GAP_PERIODIC_ADV_REPORT_CTE_TYPE_AOA_CTE

AoA Constant Tone Extension.

enumerator GAP_PERIODIC_ADV_REPORT_CTE_TYPE_AOD_CTE_1US

AoD Constant Tone Extension with 1 μs slots.

enumerator GAP_PERIODIC_ADV_REPORT_CTE_TYPE_AOD_CTE_2US

AoD Constant Tone Extension with 2 μs slots.

enumerator GAP_PERIODIC_ADV_REPORT_CTE_TYPE_NO_CTE

No Constant Tone Extension.

enum T_GAP_PERIODIC_ADV_RSP_REPORT_TX_STATUS

Definition of tx status in LE Periodic Advertising Response Report event.

Values:

enumerator GAP_PERIODIC_ADV_RSP_REPORT_TX_STATUS_TRANSMITTED

AUX_SYNC_SUBEVENT_IND packet was transmitted.

enumerator GAP_PERIODIC_ADV_RSP_REPORT_TX_STATUS_NOT_TRANSMITTED

AUX_SYNC_SUBEVENT_IND packet was not transmitted.

enum T_GAP_PERIODIC_ADV_RSP_REPORT_DATA_STATUS

Definition of data status in LE Periodic Advertising Response Report event.

Values:

enumerator GAP_PERIODIC_ADV_RSP_REPORT_DATA_STATUS_COMPLETE

Data complete.

enumerator GAP_PERIODIC_ADV_RSP_REPORT_DATA_STATUS_MORE

Data incomplete, more data to come.

enumerator GAP_PERIODIC_ADV_RSP_REPORT_DATA_STATUS_FAILED

Failed to receive an AUX_SYNC_SUBEVENT_RSP PDU.