Enumerations
Enumerations
BLE » Generic Access Profile (GAP) » Generic Access Profile (GAP) Connection Control

## Enumerations
enum | ble_gap_addr_type_t { BLE_GAP_ADDR_TYPE_PUBLIC = 0, BLE_GAP_ADDR_TYPE_RANDOM_STATIC }
| The identity address type. More...
enum | ble_gap_phy_bit_t { BLE_GAP_PHY_ANY = 0x00, BLE_GAP_PHY_LE_1MBPS = (1 << 0), BLE_GAP_PHY_LE_2MBPS = (1 << 1), BLE_GAP_PHY_LE_CODED = (1 << 2) }
| Bit field use to select the preferred TX or RX LE PHY. More...
enum | ble_gap_phy_options_t { BLE_GAP_PHY_OPT_NO_CODING = 0, BLE_GAP_PHY_OPT_S2_CODING, BLE_GAP_PHY_OPT_S8_CODING }
| The phy options. More...
enum | ble_gap_get_conn_info_op_t { BLE_GAP_GET_CON_RSSI = 0, BLE_GAP_GET_CON_CHANNEL_MAP, BLE_GAP_GET_PHY, BLE_GAP_GET_CHAN_SEL_ALGO }
| The operation code used to get connection info. More...
enum | ble_gap_get_peer_info_op_t { BLE_GAP_GET_PEER_VERSION = 0, BLE_GAP_GET_PEER_FEATURES }
| The operation code used to get peer device info. More...
enum | ble_gap_adv_report_type_t { BLE_GAP_REPORT_TYPE_ADV_EXT = 0, BLE_GAP_REPORT_TYPE_ADV_LEG, BLE_GAP_REPORT_TYPE_SCAN_RSP_EXT, BLE_GAP_REPORT_TYPE_SCAN_RSP_LEG, BLE_GAP_REPORT_TYPE_PER_ADV }
| Advertising report type. More...
enum | ble_gap_adv_report_info_t { BLE_GAP_REPORT_INFO_COMPLETE_BIT = (1 << 0), BLE_GAP_REPORT_INFO_CONN_ADV_BIT = (1 << 1), BLE_GAP_REPORT_INFO_SCAN_ADV_BIT = (1 << 2), BLE_GAP_REPORT_INFO_DIR_ADV_BIT = (1 << 3) }
| Advertising report information. More...
enum | ble_gap_stopped_reason_t { BLE_GAP_STOPPED_REASON_TIMEOUT = 0, BLE_GAP_STOPPED_REASON_ON_USER, BLE_GAP_STOPPED_REASON_CONN_EST }
| Stop reason code. More...
enum | ble_gap_ll_role_type_t { BLE_GAP_LL_ROLE_MASTER = 0, BLE_GAP_LL_ROLE_SLAVE = 1 }
| Device role of LL layer type. More...
enum | ble_gap_param_set_op_id_t { BLE_GAP_OPCODE_CHNL_MAP_SET, BLE_GAP_OPCODE_WHITELIST_SET, BLE_GAP_OPCODE_PER_ADV_LIST_SET, BLE_GAP_OPCODE_PRIVACY_MODE_SET }
| Operation code used to set param(s). More...
enum | ble_gap_disconn_reason_t { BLE_GAP_HCI_AUTHENTICATION_FAILURE = 0x05, BLE_GAP_HCI_REMOTE_USER_TERMINATED_CONNECTION = 0x13, BLE_GAP_HCI_REMOTE_DEV_TERMINATION_DUE_TO_LOW_RESOURCES = 0x14, BLE_GAP_HCI_REMOTE_DEV_TERMINATION_DUE_TO_POWER_OFF = 0x15, BLE_GAP_HCI_UNSUPPORTED_REMOTE_FEATURE = 0x1A, BLE_GAP_HCI_PAIRING_WITH_UNIT_KEY_UNSUPPORTED = 0X29, BLE_GAP_HCI_CONN_INTERVAL_UNACCEPTABLE = 0x3B }
| The specified reason for terminating a connection. More...
enum | ble_gap_rslv_addr_read_op_id_t { BLE_GAP_OPCODE_LOCAL_RSLV_ADDR_READ, BLE_GAP_OPCODE_PEER_RSLV_ADDR_READ }
| Operation code used to read resolvable address. More...
enum | ble_gap_psm_manager_op_id_t { BLE_GAP_OPCODE_LEPSM_REGISTER, BLE_GAP_OPCODE_LEPSM_UNREGISTER }
| Operation code used for LEPSM manager. More...
enum | ble_gap_dev_info_type_t { BLE_GAPC_DEV_NAME, BLE_GAPC_DEV_APPEARANCE }
| GAP Device inforamtion write indication. More...
enum | ble_gap_cte_type_t { BLE_GAP_CTE_TYPE_AOA = 0x01 << 0, BLE_GAP_CTE_TYPE_AOD_1US = 0x01 << 1, BLE_GAP_CTE_TYPE_AOD_2US = 0x01 << 2 }
| Type of constant tone extension. More...
enum | ble_gap_switching_sampling_type_t { BLE_GAP_SLOT_1US = 0x01, BLE_GAP_SLOT_2US }
| Type of switching and sampling slots. More...
enum | ble_gap_iq_report_status_t { BLE_GAP_CRC_OK, BLE_GAP_CRC_ERR1, BLE_GAP_CRC_ERR2, BLE_GAP_INSUFFI_RESOURCE = 0xFF }
| Status of IQ report packet. More...
enum | ble_gap_phy_type_t { BLE_GAP_PHY_1M = 0x01, BLE_GAP_PHY_2M = 0x02, BLE_GAP_PHY_CODED = 0x03, BLE_GAP_PHY_CODED_S8 = 0x03, BLE_GAP_PHY_CODED_S2 = 0x04 }
| Phy for power control management. More...
enum | ble_gap_tx_pwr_change_report_reason_t { BLE_GAP_PWR_LOCAL_TX_CHG = 0x00, BLE_GAP_PWR_REMOTE_TX_CHG = 0x01 }
| Transmit power change reporting reason. More...
enum | ble_gap_pwr_lvl_flag_t { BLE_GAP_PWR_MID_LVL = 0x00, BLE_GAP_PWR_MIN_LVL = 0x01, BLE_GAP_PWR_MAX_LVL = 0x02 }
| Transmit Power level flag. More...
enum | ble_gap_path_loss_zone_t { BLE_GAP_PATH_LOSS_LOW = 0x00, BLE_GAP_PATH_LOSS_MID = 0x01, BLE_GAP_PATH_LOSS_HIGH = 0x02 }
| Path Loss zones. HCI:7.8.118. More...

## Detailed Description

## Enumeration Type Documentation

## ◆ ble_gap_addr_type_t

enum ble_gap_addr_type_t

The identity address type.

Enumerator
BLE_GAP_ADDR_TYPE_PUBLIC | Public (identity) address.
BLE_GAP_ADDR_TYPE_RANDOM_STATIC | Random static (identity) address.

Definition at line 94 of file ble_gapc.h.

## ◆ ble_gap_adv_report_info_t

enum ble_gap_adv_report_info_t

Advertising report information.

Enumerator
BLE_GAP_REPORT_INFO_COMPLETE_BIT | Report is complete.
BLE_GAP_REPORT_INFO_CONN_ADV_BIT | Connectable advertising.
BLE_GAP_REPORT_INFO_SCAN_ADV_BIT | Scannable advertising.
BLE_GAP_REPORT_INFO_DIR_ADV_BIT | Directed advertising.

Definition at line 150 of file ble_gapc.h.

## ◆ ble_gap_adv_report_type_t

enum ble_gap_adv_report_type_t

Advertising report type.

Enumerator
BLE_GAP_REPORT_TYPE_ADV_EXT | Extended advertising report.
BLE_GAP_REPORT_TYPE_ADV_LEG | Legacy advertising report.
BLE_GAP_REPORT_TYPE_SCAN_RSP_EXT | Extended scan response report.
BLE_GAP_REPORT_TYPE_SCAN_RSP_LEG | Legacy scan response report.
BLE_GAP_REPORT_TYPE_PER_ADV | Periodic advertising report.

Definition at line 140 of file ble_gapc.h.

## ◆ ble_gap_cte_type_t

enum ble_gap_cte_type_t

Type of constant tone extension.

Enumerator
BLE_GAP_CTE_TYPE_AOA | Allow AoA Constant Tone Extension Response.
BLE_GAP_CTE_TYPE_AOD_1US | Allow AoD Constant Tone Extension Response with 1us slots.
BLE_GAP_CTE_TYPE_AOD_2US | Allow AoD Constant Tone Extension Response with 2us slots.

Definition at line 226 of file ble_gapc.h.

## ◆ ble_gap_dev_info_type_t

enum ble_gap_dev_info_type_t

GAP Device inforamtion write indication.

Enumerator
BLE_GAPC_DEV_NAME |
BLE_GAPC_DEV_APPEARANCE |

Definition at line 217 of file ble_gapc.h.

## ◆ ble_gap_disconn_reason_t

enum ble_gap_disconn_reason_t

The specified reason for terminating a connection.

Enumerator
BLE_GAP_HCI_AUTHENTICATION_FAILURE | Authentication Failure.
BLE_GAP_HCI_REMOTE_USER_TERMINATED_CONNECTION | Remote User Terminated Connection.
BLE_GAP_HCI_REMOTE_DEV_TERMINATION_DUE_TO_LOW_RESOURCES | Remote Device Terminated Connection due to Low Resources.
BLE_GAP_HCI_REMOTE_DEV_TERMINATION_DUE_TO_POWER_OFF | Remote Device Terminated Connection due to Power Off.
BLE_GAP_HCI_UNSUPPORTED_REMOTE_FEATURE | Unsupported Remote Feature.
BLE_GAP_HCI_PAIRING_WITH_UNIT_KEY_UNSUPPORTED | Pairing With Unit Key Not Supported.
BLE_GAP_HCI_CONN_INTERVAL_UNACCEPTABLE | Unacceptable Connection Parameters.

Definition at line 187 of file ble_gapc.h.

## ◆ ble_gap_get_conn_info_op_t

enum ble_gap_get_conn_info_op_t

The operation code used to get connection info.

Enumerator
BLE_GAP_GET_CON_RSSI | Get connection RSSI info.
BLE_GAP_GET_CON_CHANNEL_MAP | Get connection channel map.
BLE_GAP_GET_PHY | Get connection PHY.
BLE_GAP_GET_CHAN_SEL_ALGO | Get selection algorithm for connection channel.

Definition at line 124 of file ble_gapc.h.

## ◆ ble_gap_get_peer_info_op_t

enum ble_gap_get_peer_info_op_t

The operation code used to get peer device info.

Enumerator
BLE_GAP_GET_PEER_VERSION | Get peer device version info.
BLE_GAP_GET_PEER_FEATURES | Get peer device features info.

Definition at line 133 of file ble_gapc.h.

## ◆ ble_gap_iq_report_status_t

enum ble_gap_iq_report_status_t

Status of IQ report packet.

Enumerator
BLE_GAP_CRC_OK | CRC was correct.
BLE_GAP_CRC_ERR1 | CRC was incorrect and the Length and CTETime fields of the packet were used to determine sampling points.
BLE_GAP_CRC_ERR2 | CRC was incorrect but the Controller has determined the position and length of the Constant Tone Extension in some other way.
BLE_GAP_INSUFFI_RESOURCE | Insufficient resources to sample (data_channel_idx, cte_type, and slot_dur invalid).

Definition at line 245 of file ble_gapc.h.

## ◆ ble_gap_ll_role_type_t

enum ble_gap_ll_role_type_t

Device role of LL layer type.

Enumerator
BLE_GAP_LL_ROLE_MASTER | Master role.
BLE_GAP_LL_ROLE_SLAVE | Slave role.

Definition at line 167 of file ble_gapc.h.

## ◆ ble_gap_param_set_op_id_t

enum ble_gap_param_set_op_id_t

Operation code used to set param(s).

Enumerator
BLE_GAP_OPCODE_CHNL_MAP_SET | Set Channel Map.
BLE_GAP_OPCODE_WHITELIST_SET | Set white list.
BLE_GAP_OPCODE_PER_ADV_LIST_SET | Set periodic advertising list.
BLE_GAP_OPCODE_PRIVACY_MODE_SET | Set privacy mode for peer device.

Definition at line 176 of file ble_gapc.h.

## ◆ ble_gap_path_loss_zone_t

enum ble_gap_path_loss_zone_t

Path Loss zones. HCI:7.8.118.

Enumerator
BLE_GAP_PATH_LOSS_LOW | Entered Low zone.
BLE_GAP_PATH_LOSS_MID | Entered Middle zone.
BLE_GAP_PATH_LOSS_HIGH | Entered High zone.

Definition at line 285 of file ble_gapc.h.

## ◆ ble_gap_phy_bit_t

enum ble_gap_phy_bit_t

Bit field use to select the preferred TX or RX LE PHY.

Enumerator
BLE_GAP_PHY_ANY | No preferred PHY.
BLE_GAP_PHY_LE_1MBPS | LE 1M PHY preferred for an active link.
BLE_GAP_PHY_LE_2MBPS | LE 2M PHY preferred for an active link.
BLE_GAP_PHY_LE_CODED | LE Coded PHY preferred for an active link.

Definition at line 103 of file ble_gapc.h.

## ◆ ble_gap_phy_options_t

enum ble_gap_phy_options_t

The phy options.

Enumerator
BLE_GAP_PHY_OPT_NO_CODING | The Host has no preferred coding when transmitting on the LE Coded PHY.
BLE_GAP_PHY_OPT_S2_CODING | The Host prefers that S=2 coding be used when transmitting on the LE Coded PHY.
BLE_GAP_PHY_OPT_S8_CODING | The Host prefers that S=8 coding be used when transmitting on the LE Coded PHY.

Definition at line 116 of file ble_gapc.h.

## ◆ ble_gap_phy_type_t

enum ble_gap_phy_type_t

Phy for power control management.

Enumerator
BLE_GAP_PHY_1M | LE 1M PHY.
BLE_GAP_PHY_2M | LE 2M PHY.
BLE_GAP_PHY_CODED | LE Coded PHY, used for BLE_GAPC_EVT_PHY_UPDATED.
BLE_GAP_PHY_CODED_S8 | LE Coded PHY with S=8 data coding.
BLE_GAP_PHY_CODED_S2 | LE Coded PHY with S=2 data coding.

Definition at line 256 of file ble_gapc.h.

## ◆ ble_gap_psm_manager_op_id_t

enum ble_gap_psm_manager_op_id_t

Operation code used for LEPSM manager.

Enumerator
BLE_GAP_OPCODE_LEPSM_REGISTER | LEPSM register operation.
BLE_GAP_OPCODE_LEPSM_UNREGISTER | LEPSM unregister operation.

Definition at line 210 of file ble_gapc.h.

## ◆ ble_gap_pwr_lvl_flag_t

enum ble_gap_pwr_lvl_flag_t

Transmit Power level flag.

Enumerator
BLE_GAP_PWR_MID_LVL | Transmit power level is between minimum and max level.
BLE_GAP_PWR_MIN_LVL | Transmit power level is at minimum level.
BLE_GAP_PWR_MAX_LVL | Transmit power level is at maximum level.

Definition at line 277 of file ble_gapc.h.

## ◆ ble_gap_rslv_addr_read_op_id_t

enum ble_gap_rslv_addr_read_op_id_t

Operation code used to read resolvable address.

Enumerator
BLE_GAP_OPCODE_LOCAL_RSLV_ADDR_READ | Local resolvable address operation.
BLE_GAP_OPCODE_PEER_RSLV_ADDR_READ | Peer resolvable address operation.

Definition at line 201 of file ble_gapc.h.

## ◆ ble_gap_stopped_reason_t

enum ble_gap_stopped_reason_t

Stop reason code.

Enumerator
BLE_GAP_STOPPED_REASON_TIMEOUT | Stop with timeout.
BLE_GAP_STOPPED_REASON_ON_USER | Stop with user stopping it actively.
BLE_GAP_STOPPED_REASON_CONN_EST | Stop with connection established.

Definition at line 159 of file ble_gapc.h.

## ◆ ble_gap_switching_sampling_type_t

enum ble_gap_switching_sampling_type_t

Type of switching and sampling slots.

Enumerator
BLE_GAP_SLOT_1US | Switching and sampling slots are 1us each.
BLE_GAP_SLOT_2US | Switching and sampling slots are 2us each.

Definition at line 236 of file ble_gapc.h.

## ◆ ble_gap_tx_pwr_change_report_reason_t

enum ble_gap_tx_pwr_change_report_reason_t

Transmit power change reporting reason.

Enumerator
BLE_GAP_PWR_LOCAL_TX_CHG | Local transmit power changed.
BLE_GAP_PWR_REMOTE_TX_CHG | Remote transmit power changed.

Definition at line 268 of file ble_gapc.h.