bf0_ble_gap.h

Header file - Bluetooth GAP protocol interface.

Author: Sifli software development team

Defines

CO_BIT(pos): return Value with one bit set. There is no return type since this is a macro and this will be resolved by the compiler upon assignment to an l-value.

GAP_KEY_LEN: Key length.

GAP_ACTV_INVALID_IDX: Invalid activity identifier.

GAP_LE_FEATS_LEN: LE Feature Flags Length.

GAP_RAND_NB_LEN: Random number length.

GAP_ADV_DATA_LEN: The maximum ADV Data length.

GAP_SCAN_RSP_DATA_LEN: The maximum scan response length.

GAP_MIN_OCTETS: minimum data size in octets.

GAP_MIN_TIME: minimum data transfer time in us.

GAP_MAX_OCTETS: maximum data size in octets.

GAP_MAX_TIME: maximum data size in octets.

GAP_LE_CHNL_MAP_LEN: LE Channel map length.

GAP_MAX_LOCAL_NAME_LEN: Maximum Local device name.

GAP_DEFAULT_LOCAL_NAME: Default Local device name.

BLE_GAP_UPDATE_CONN_PARAM_INIT(_conn_idx, _intv_min, _intv_max, _latency, _timeout)

Initialize update connection parameters.

参数:

_conn_idx – conn_idx for dedicated BLE connection.
_intv_min – minimum interval (N * 1.25 ms).
_intv_max – maximum interval (N * 1.25 ms).
_latency – maximum peripherial latency in connection (N * 0.625 ms).
_timeout – Create connection scan window (N * 100 ms).

BLE_GAP_CREATE_UPDATE_CONN_PARA(_conn_idx, _intv_min, _intv_max, _latency, _timeout)

Helper to declare update connection parameters inline

参数:

_conn_idx – conn_idx for dedicated BLE connection.
_intv_min – minimum interval (N * 1.25 ms).
_intv_max – maximum interval (N * 1.25 ms).
_latency – maximum peripherial latency in connection (N * 0.625 ms).
_timeout – Create connection scan window (N * 100 ms).

BLE_GAP_UPDATE_CONN_PARA_FAST(_conn_idx): Default fast connection parameters. It’s for scenarios which need high throughput

BLE_GAP_UPDATE_CONN_PARA_SLOW(_conn_idx): Default slow connection parameters. It’s for scenarios which need low power

Typedefs

typedef ble_gap_status_t ble_gap_set_white_list_cnf_t: The struture of BLE_GAP_SET_WHITE_LIST_CNF.

typedef ble_gap_status_t ble_gap_set_resolve_list_cnf_t: The struture of BLE_GAP_SET_RESOLVING_LIST_CNF.

typedef ble_gap_status_t ble_gap_set_irk_cnf_t: The struture of BLE_GAP_SET_IRK_CNF.

typedef ble_gap_status_t ble_gap_create_adv_cnf_t: The struture of BLE_GAP_CREATE_ADV_CNF.

typedef ble_gap_status_t ble_gap_set_adv_data_cnf_t: The strcture of BLE_GAP_SET_ADV_DATA_CNF.

typedef ble_gap_status_t ble_gap_set_scan_rsp_data_cnf_t: The strcture of BLE_GAP_SET_SCAN_RSP_DATA_CNF.

typedef ble_gap_status_t ble_gap_set_periodic_adv_data_cnf_t: The strcture of BLE_GAP_SET_PERIODIC_ADV_DATA_CNF.

typedef ble_gap_status_t ble_gap_start_scan_cnf_t: The struture of BLE_GAP_SCAN_START_CNF.

typedef ble_gap_status_t ble_gap_stop_scan_cnf_t: The struture of BLE_GAP_SCAN_STOP_CNF.

typedef ble_gap_status_t ble_gap_create_connection_cnf_t: The strucutre of BLE_GAP_CREATE_CONNECTION_CNF.

typedef ble_gap_status_t ble_gap_cancel_create_connection_cnf_t: The struture of BLE_GAP_CANCEL_CREATE_CONNECTION_CNF.

typedef ble_gap_status_t ble_gap_resolve_address_cnf_t: The struture of BLE_GAP_RESOLVE_ADDRESS_CNF.

typedef ble_gap_status_t ble_gap_create_per_adv_sync_cnf_t: The struture of BLE_GAP_CREATE_PERIODIC_ADV_SYNC_CNF.

Enums

enum gap_rnd_addr_type

Random Address type.

Values:

enumerator GAP_STATIC_ADDR: Static random address - 11 (MSB->LSB)

enumerator GAP_NON_RSLV_ADDR: Private non resolvable address - 01 (MSB->LSB)

enumerator GAP_RSLV_ADDR: Private resolvable address - 01 (MSB->LSB)

enum ble_gap_event_t

GAP events that notify user.

Values:

enumerator BLE_GAP_LOCAL_VER_IND: This event indicates local version.

enumerator BLE_GAP_LOCAL_BD_ADDR_IND: This event indicates local bd address.

enumerator BLE_GAP_LOCAL_ADV_TX_POWER_IND: This event indicates advertising channel TX power

enumerator BLE_GAP_LOCAL_MAX_DATA_LEN_IND: This event indicates mamimum data len that controller supported.

enumerator BLE_GAP_NUMBER_ADV_SETS_IND: This event indicates maximum number of adv sets.

enumerator BLE_GAP_LOCAL_MAX_ADV_DATA_LEN_IND: This event indicates maximum adv data len and scan rsp len that controller supported.

enumerator BLE_GAP_SET_WHITE_LIST_CNF: This event indicates the result of set white list.

enumerator BLE_GAP_SET_RESOLVING_LIST_CNF: This event indicates the result of set resolving list.

enumerator BLE_GAP_RAL_ADDR_IND: This event indicates current resolvable address.

enumerator BLE_GAP_SET_IRK_CNF: This event indicates the result of set IRK.

enumerator BLE_GAP_ADV_CREATED_IND: This event indicates advertising created.

enumerator BLE_GAP_CREATE_ADV_CNF: This event indicates the result of created advertising.

enumerator BLE_GAP_SET_ADV_DATA_CNF: This event indicates the result of set advertising data.

enumerator BLE_GAP_SET_SCAN_RSP_DATA_CNF: This event indicates the result of set scan rsp data.

enumerator BLE_GAP_START_ADV_CNF: This event indicates the result of start advertising.

enumerator BLE_GAP_ADV_STOPPED_IND: This event indicates advertising stopped.

enumerator BLE_GAP_STOP_ADV_CNF: This event indicates the result of stop advertising.

enumerator BLE_GAP_DELETE_ADV_CNF: This event indicates the result of delete advertising.

enumerator BLE_GAP_SCAN_START_CNF: This event indicates the result of scan start.

enumerator BLE_GAP_SCAN_STOPPED_IND: This event indicates scan stopped.

enumerator BLE_GAP_SCAN_STOP_CNF: This event indicates the result of scan stop.

enumerator BLE_GAP_CREATE_CONNECTION_CNF: This event indicates the result of start connection.

enumerator BLE_GAP_CANCEL_CREATE_CONNECTION_CNF: This event indicates the result of cancel connection.

enumerator BLE_GAP_CONNECTED_IND: This event indicates connection setup.

enumerator BLE_GAP_DISCONNECT_CNF: This event indicates the result of disconnect.

enumerator BLE_GAP_DISCONNECTED_IND: This event indicates link disconnected.

enumerator BLE_GAP_REMOTE_VER_IND: This event indicates peer device bluetooth version.

enumerator BLE_GAP_REMOTE_FEATURE_IND: This event indicates peer device supported BLE features.

enumerator BLE_GAP_REMOTE_RSSI_IND: This event indicates on-going link RSSI.

enumerator BLE_GAP_REMOTE_PHY_IND: This event indicates on-goling link PHY configuration.

enumerator BLE_GAP_UPDATE_CONN_PARAM_IND: This event indicates on-going link connection parameter updatad

enumerator BLE_GAP_UPDATE_CONN_PARAM_CNF: This event indicates the result of update connection parameter.

enumerator BLE_GAP_BOND_CNF: This event indicates the result of bond command.

enumerator BLE_GAP_BOND_REQ_IND: This event indicates bond request by peer device.

enumerator BLE_GAP_BOND_IND: This event indicates bond information.

enumerator BLE_GAP_ENCRYPT_REQ_IND: This event indicates encrypt request by peer device.

enumerator BLE_GAP_ENCRYPT_IND: This event indicates encrypt information.

enumerator BLE_GAP_SECURITY_REQUEST_CNF: This event indicates the result of security request.

enumerator BLE_GAP_SECURITY_REQUEST_IND: This event indicates security request by peer deivce in peripherial role.

enumerator BLE_GAP_PASSKEY_REQ_IND: This event indicates passkey request by peer device.

enumerator BLE_GAP_PHY_UPDATE_IND: This event indicates PHY updated.

enumerator BLE_GAP_EXT_ADV_REPORT_IND: This evnet indicates extended advertising report which including either legacy or extended advertising PDUs.

enumerator BLE_GAP_UPDATE_DATA_LENGTH_CNF: This event indicates the result of update data length

enumerator BLE_GAP_UPDATE_DATA_LENGTH_IND: This event indicates the on-going link data length updated

enumerator BLE_GAP_UPDATE_CHANNEL_MAP_CNF: This event indicates the result of channel map updated

enumerator BLE_GAP_UPDATE_CHANNEL_MAP_IND: This event indicates the on-going link channel map updated

enumerator BLE_GAP_SIGN_COUNTER_UPDATE_IND: This event indicates the local or peer sign counter updated

enumerator BLE_GAP_RESOLVE_ADDRESS_CNF: This event indicates the address resolved result

enumerator BLE_GAP_SOLVED_ADDRESS_IND: This event indicates the solved address with dedicated key

enumerator BLE_GAP_PUBLIC_KEY_GEN_IND: This event indicates public key has generated

enumerator BT_DBG_RSSI_NOTIFY_IND: This debug event indicates the link rssi and channel assessment

enumerator BT_DBG_ASSERT_NOTIFY_IND: This debug event indicates the controller is crash

enumerator BLE_GAP_SET_PERIODIC_ADV_DATA_CNF: This event indicates the result of set periodic rsp data.

enumerator BLE_GAP_CREATE_PERIODIC_ADV_SYNC_CNF: This event indicates the result of create periodic advertising sync.

enumerator BLE_GAP_START_PERIODIC_ADV_SYNC_CNF: This event indicates the result of start periodic advertising sync.

enumerator BLE_GAP_STOP_PERIODIC_ADV_SYNC_CNF: This event indicates the result of stop periodic advertising sync.

enumerator BLE_GAP_DELETE_PERIODIC_ADV_SYNC_CNF: This event indicates the result of delete periodic advertising sync.

enumerator BLE_GAP_PERIODIC_ADV_SYNC_CREATED_IND: This event indicates periodic advertising sync created.

enumerator BLE_GAP_PERIODIC_ADV_SYNC_STOPPED_IND: This event indicates periodic advertising sync stopped.

enumerator BLE_GAP_PERIODIC_ADV_SYNC_ESTABLISHED_IND: This event indicates periodic advertising sync established.

enum ble_gap_adv_type

GAP Advertising Flags.

Values:

enumerator BLE_GAP_AD_TYPE_FLAGS

Flag.

enumerator BLE_GAP_AD_TYPE_MORE_16_BIT_UUID: Use of more than 16 bits UUID.

enumerator BLE_GAP_AD_TYPE_COMPLETE_LIST_16_BIT_UUID: Complete list of 16 bit UUID.

enumerator BLE_GAP_AD_TYPE_MORE_32_BIT_UUID: Use of more than 32 bit UUD.

enumerator BLE_GAP_AD_TYPE_COMPLETE_LIST_32_BIT_UUID: Complete list of 32 bit UUID.

enumerator BLE_GAP_AD_TYPE_MORE_128_BIT_UUID: Use of more than 128 bit UUID.

enumerator BLE_GAP_AD_TYPE_COMPLETE_LIST_128_BIT_UUID: Complete list of 128 bit UUID.

enumerator BLE_GAP_AD_TYPE_SHORTENED_NAME: Shortened device name.

enumerator BLE_GAP_AD_TYPE_COMPLETE_NAME: Complete device name.

enumerator BLE_GAP_AD_TYPE_TRANSMIT_POWER: Transmit power.

enumerator BLE_GAP_AD_TYPE_CLASS_OF_DEVICE: Class of device.

enumerator BLE_GAP_AD_TYPE_SP_HASH_C: Simple Pairing Hash C.

enumerator BLE_GAP_AD_TYPE_SP_RANDOMIZER_R: Simple Pairing Randomizer.

enumerator BLE_GAP_AD_TYPE_TK_VALUE: Temporary key value.

enumerator BLE_GAP_AD_TYPE_OOB_FLAGS: Out of Band Flag.

enumerator BLE_GAP_AD_TYPE_SLAVE_CONN_INT_RANGE: Slave connection interval range.

enumerator BLE_GAP_AD_TYPE_RQRD_16_BIT_SVC_UUID: Require 16 bit service UUID.

enumerator BLE_GAP_AD_TYPE_RQRD_32_BIT_SVC_UUID: Require 32 bit service UUID.

enumerator BLE_GAP_AD_TYPE_RQRD_128_BIT_SVC_UUID: Require 128 bit service UUID.

enumerator BLE_GAP_AD_TYPE_SERVICE_16_BIT_DATA: Service data 16-bit UUID.

enumerator BLE_GAP_AD_TYPE_SERVICE_32_BIT_DATA: Service data 32-bit UUID.

enumerator BLE_GAP_AD_TYPE_SERVICE_128_BIT_DATA: Service data 128-bit UUID.

enumerator BLE_GAP_AD_TYPE_PUB_TGT_ADDR: Public Target Address.

enumerator BLE_GAP_AD_TYPE_RAND_TGT_ADDR: Random Target Address.

enumerator BLE_GAP_AD_TYPE_APPEARANCE: Appearance.

enumerator BLE_GAP_AD_TYPE_ADV_INTV: Advertising Interval.

enumerator BLE_GAP_AD_TYPE_LE_BT_ADDR: LE Bluetooth Device Address.

enumerator BLE_GAP_AD_TYPE_LE_ROLE: LE Role.

enumerator BLE_GAP_AD_TYPE_SPAIR_HASH: Simple Pairing Hash C-256.

enumerator BLE_GAP_AD_TYPE_SPAIR_RAND: Simple Pairing Randomizer R-256.

enumerator BLE_GAP_AD_TYPE_3D_INFO: 3D Information Data.

enumerator BLE_GAP_AD_TYPE_MANU_SPECIFIC_DATA

Manufacturer specific data.

enum gapm_adv_type

Type of advertising that can be created.

Values:

enumerator GAPM_ADV_TYPE_LEGACY: Legacy advertising.

enumerator GAPM_ADV_TYPE_EXTENDED: Extended advertising.

enumerator GAPM_ADV_TYPE_PERIODIC: Periodic advertising.

enum gapm_adv_disc_mode

Advertising discovery mode.

Values:

enumerator GAPM_ADV_MODE_NON_DISC: Mode in non-discoverable.

enumerator GAPM_ADV_MODE_GEN_DISC: Mode in general discoverable.

enumerator GAPM_ADV_MODE_LIM_DISC: Mode in limited discoverable.

enumerator GAPM_ADV_MODE_BEACON: Broadcast mode without presence of AD_TYPE_FLAG in advertising data.

enumerator GAPM_ADV_MODE_DULMODE

enumerator GAPM_ADV_MODE_CUSTOMIZE

enumerator GAPM_ADV_MODE_MAX

enum gapm_adv_prop_pos

Advertising properties bit field bit positions.

Values:

enumerator GAPM_ADV_PROP_CONNECTABLE_POS: Indicate that advertising is connectable, reception of CONNECT_REQ or AUX_CONNECT_REQ PDUs is accepted. Not applicable for periodic advertising.

enumerator GAPM_ADV_PROP_SCANNABLE_POS: Indicate that advertising is scannable, reception of SCAN_REQ or AUX_SCAN_REQ PDUs is accepted

enumerator GAPM_ADV_PROP_DIRECTED_POS

Indicate that advertising targets a specific device. Only apply in following cases:

Legacy advertising: if connectable
Extended advertising: connectable or (non connectable and non discoverable)

enumerator GAPM_ADV_PROP_HDC_POS: Indicate that High Duty Cycle has to be used for advertising on primary channel Apply only if created advertising is not an extended advertising

enumerator GAPM_ADV_PROP_RESERVED_4_POS: Bit 4 is reserved.

enumerator GAPM_ADV_PROP_ANONYMOUS_POS: Enable anonymous mode. Device address won’t appear in send PDUs Valid only if created advertising is an extended advertising

enumerator GAPM_ADV_PROP_TX_PWR_POS: Include TX Power in the extended header of the advertising PDU. Valid only if created advertising is not a legacy advertising

enumerator GAPM_ADV_PROP_PER_TX_PWR_POS: Include TX Power in the periodic advertising PDU. Valid only if created advertising is a periodic advertising

enumerator GAPM_ADV_PROP_SCAN_REQ_NTF_EN_POS: Indicate if application must be informed about received scan requests PDUs.

enum gapm_adv_prop

Advertising properties bit field bit value.

Values:

enumerator GAPM_ADV_PROP_CONNECTABLE_BIT: Indicate that advertising is connectable, reception of CONNECT_REQ or AUX_CONNECT_REQ PDUs is accepted. Not applicable for periodic advertising. return Value with one bit set. There is no return type since this is a macro and this ** will be resolved by the compiler upon assignment to an l-value.

enumerator GAPM_ADV_PROP_SCANNABLE_BIT: Indicate that advertising is scannable, reception of SCAN_REQ or AUX_SCAN_REQ PDUs is accepted return Value with one bit set. There is no return type since this is a macro and this ** will be resolved by the compiler upon assignment to an l-value.

enumerator GAPM_ADV_PROP_DIRECTED_BIT

Indicate that advertising targets a specific device. Only apply in following cases:

Legacy advertising: if connectable
Extended advertising: connectable or (non connectable and non discoverable) return Value with one bit set. There is no return type since this is a macro and this ** will be resolved by the compiler upon assignment to an l-value.

enumerator GAPM_ADV_PROP_HDC_BIT: Indicate that High Duty Cycle has to be used for advertising on primary channel Apply only if created advertising is not an extended advertising return Value with one bit set. There is no return type since this is a macro and this ** will be resolved by the compiler upon assignment to an l-value.

enumerator GAPM_ADV_PROP_RESERVED_4_BIT

Bit 4 is reserved.

return Value with one bit set. There is no return type since this is a macro and this ** will be resolved by the compiler upon assignment to an l-value.

enumerator GAPM_ADV_PROP_ANONYMOUS_BIT: Enable anonymous mode. Device address won’t appear in send PDUs Valid only if created advertising is an extended advertising return Value with one bit set. There is no return type since this is a macro and this ** will be resolved by the compiler upon assignment to an l-value.

enumerator GAPM_ADV_PROP_TX_PWR_BIT: Include TX Power in the extended header of the advertising PDU. Valid only if created advertising is not a legacy advertising return Value with one bit set. There is no return type since this is a macro and this ** will be resolved by the compiler upon assignment to an l-value.

enumerator GAPM_ADV_PROP_PER_TX_PWR_BIT: Include TX Power in the periodic advertising PDU. Valid only if created advertising is a periodic advertising return Value with one bit set. There is no return type since this is a macro and this ** will be resolved by the compiler upon assignment to an l-value.

enumerator GAPM_ADV_PROP_SCAN_REQ_NTF_EN_BIT

Indicate if application must be informed about received scan requests PDUs.

return Value with one bit set. There is no return type since this is a macro and this ** will be resolved by the compiler upon assignment to an l-value.

enum gapm_leg_adv_prop

Advertising properties configurations for legacy advertising.

Values:

enumerator GAPM_ADV_PROP_NON_CONN_NON_SCAN_MASK: Non connectable non scannable advertising.

enumerator GAPM_ADV_PROP_BROADCAST_NON_SCAN_MASK: Broadcast non scannable advertising - Discovery mode must be Non Discoverable.

enumerator GAPM_ADV_PROP_NON_CONN_SCAN_MASK: Non connectable scannable advertising.

enumerator GAPM_ADV_PROP_BROADCAST_SCAN_MASK: Broadcast non scannable advertising - Discovery mode must be Non Discoverable.

enumerator GAPM_ADV_PROP_UNDIR_CONN_MASK: Undirected connectable advertising.

enumerator GAPM_ADV_PROP_DIR_CONN_MASK: Directed connectable advertising.

enumerator GAPM_ADV_PROP_DIR_CONN_LDC_MASK: Directed connectable with Low Duty Cycle.

enumerator GAPM_ADV_PROP_DIR_CONN_HDC_MASK: Directed connectable with High Duty Cycle.

enum adv_filter_policy

Advertising filter policy.

Values:

enumerator ADV_ALLOW_SCAN_ANY_CON_ANY: Allow both scan and connection requests from anyone.

enumerator ADV_ALLOW_SCAN_WLST_CON_ANY: Allow both scan req from White List devices only and connection req from anyone.

enumerator ADV_ALLOW_SCAN_ANY_CON_WLST: Allow both scan req from anyone and connection req from White List devices only.

enumerator ADV_ALLOW_SCAN_WLST_CON_WLST: Allow scan and connection requests from White List devices only.

enum adv_channel_map

Advertising channels enables.

Values:

enumerator ADV_CHNL_37_EN: Byte value for advertising channel map for channel 37 enable.

enumerator ADV_CHNL_38_EN: Byte value for advertising channel map for channel 38 enable.

enumerator ADV_CHNL_39_EN: Byte value for advertising channel map for channel 39 enable.

enumerator ADV_ALL_CHNLS_EN: Byte value for advertising channel map for channel 37, 38 and 39 enable.

enum gap_phy_type

PHY Type.

Values:

enumerator GAP_PHY_TYPE_LE_1M: LE 1M.

enumerator GAP_PHY_TYPE_LE_2M: LE 2M.

enumerator GAP_PHY_TYPE_LE_CODED: LE Coded.

enum gap_per_sync_type

Periodic synchronization types.

Values:

enumerator GAP_PER_SYNC_TYPE_GENERAL: Do not use periodic advertiser list for synchronization. Use advertiser information provided in the ble_gap_start_periodic_advertising_sync().

enumerator GAP_PER_SYNC_TYPE_SELECTIVE: Use periodic advertiser list for synchronization.

enum gap_sec_req

Security Defines.

Values:

enumerator GAP_NO_SEC: No security (no authentication and encryption)

enumerator GAP_SEC1_NOAUTH_PAIR_ENC: Unauthenticated pairing with encryption.

enumerator GAP_SEC1_AUTH_PAIR_ENC: Authenticated pairing with encryption.

enumerator GAP_SEC2_NOAUTH_DATA_SGN: Unauthenticated pairing with data signing.

enumerator GAP_SEC2_AUTH_DATA_SGN: Authentication pairing with data signing.

enumerator GAP_SEC1_SEC_CON_PAIR_ENC: Secure Connection pairing with encryption.

enum gap_kdist

Key Distribution Flags.

Values:

enumerator GAP_KDIST_NONE: No Keys to distribute.

enumerator GAP_KDIST_ENCKEY: Encryption key in distribution.

enumerator GAP_KDIST_IDKEY: IRK (ID key)in distribution.

enumerator GAP_KDIST_SIGNKEY: CSRK(Signature key) in distribution.

enumerator GAP_KDIST_LINKKEY: LTK in distribution.

enumerator GAP_KDIST_LAST

enum gap_io_cap

IO Capability Values.

Values:

enumerator GAP_IO_CAP_DISPLAY_ONLY: Display Only.

enumerator GAP_IO_CAP_DISPLAY_YES_NO: Display Yes No.

enumerator GAP_IO_CAP_KB_ONLY: Keyboard Only.

enumerator GAP_IO_CAP_NO_INPUT_NO_OUTPUT: No Input No Output.

enumerator GAP_IO_CAP_KB_DISPLAY: Keyboard Display.

enumerator GAP_IO_CAP_LAST

enum gap_oob

OOB Data Present Flag Values.

Values:

enumerator GAP_OOB_AUTH_DATA_NOT_PRESENT: OOB Data not present.

enumerator GAP_OOB_AUTH_DATA_PRESENT: OOB data present.

enumerator GAP_OOB_AUTH_DATA_LAST

enum gap_auth_mask

Authentication mask.

Values:

enumerator GAP_AUTH_NONE: No Flag set.

enumerator GAP_AUTH_BOND: Bond authentication.

enumerator GAP_AUTH_MITM: Man In the middle protection.

enumerator GAP_AUTH_SEC_CON: Secure Connection.

enumerator GAP_AUTH_KEY_NOTIF: Key Notification.

enum gap_auth

Authentication Requirements.

Values:

enumerator GAP_AUTH_REQ_NO_MITM_NO_BOND: No MITM No Bonding.

enumerator GAP_AUTH_REQ_NO_MITM_BOND: No MITM Bonding.

enumerator GAP_AUTH_REQ_MITM_NO_BOND: MITM No Bonding.

enumerator GAP_AUTH_REQ_MITM_BOND: MITM and Bonding.

enumerator GAP_AUTH_REQ_SEC_CON_NO_BOND: SEC_CON and No Bonding.

enumerator GAP_AUTH_REQ_SEC_CON_BOND: SEC_CON and Bonding.

enumerator GAP_AUTH_REQ_SEC_CON_MITM_BOND: SEC CON and Bonding and MITM.

enumerator GAP_AUTH_REQ_LAST

enumerator GAP_AUTH_REQ_MASK: Mask of authentication features without reserved flag.

enum gapc_bond

Bond event type.

Values:

enumerator GAPC_PAIRING_REQ: Bond Pairing request.

enumerator GAPC_PAIRING_RSP: Respond to Pairing request.

enumerator GAPC_PAIRING_SUCCEED: Pairing Finished information.

enumerator GAPC_PAIRING_FAILED: Pairing Failed information.

enumerator GAPC_TK_EXCH: Used to retrieve pairing Temporary Key.

enumerator GAPC_IRK_EXCH: Used for Identity Resolving Key exchange.

enumerator GAPC_CSRK_EXCH: Used for Connection Signature Resolving Key exchange.

enumerator GAPC_LTK_EXCH: Used for Long Term Key exchange.

enumerator GAPC_REPEATED_ATTEMPT: Bond Pairing request issue, Repeated attempt.

enumerator GAPC_OOB_EXCH: Out of Band - exchange of confirm and rand.

enumerator GAPC_NC_EXCH: Numeric Comparison - Exchange of Numeric Value -.

enum gap_tk_type

TK Type.

Values:

enumerator GAP_TK_OOB: TK get from out of band method.

enumerator GAP_TK_DISPLAY: TK generated and shall be displayed by local device.

enumerator GAP_TK_KEY_ENTRY: TK shall be entered by user using device keyboard.

enum gap_phy

Bit field use to select the preferred TX or RX LE PHY. 0 means no preferences.

Values:

enumerator GAP_PHY_ANY: No preferred PHY.

enumerator GAP_PHY_LE_1MBPS: LE 1M PHY preferred for an active link.

enumerator GAP_PHY_LE_2MBPS: LE 2M PHY preferred for an active link.

enumerator GAP_PHY_LE_CODED: LE Coded PHY preferred for an active link.

enum gapc_phy_option

Option for PHY configuration.

Values:

enumerator GAPC_PHY_OPT_LE_CODED_ALL_RATES: No preference for rate used when transmitting on the LE Coded PHY.

enumerator GAPC_PHY_OPT_LE_CODED_500K_RATE: 500kbps rate preferred when transmitting on the LE Coded PHY

enumerator GAPC_PHY_OPT_LE_CODED_125K_RATE: 125kbps when transmitting on the LE Coded PHY

enum gap_pkt_pld_type

Packet Payload type for test mode.

Values:

enumerator GAP_PKT_PLD_PRBS9: PRBS9 sequence “11111111100000111101…” (in transmission order)

enumerator GAP_PKT_PLD_REPEATED_11110000: Repeated “11110000” (in transmission order)

enumerator GAP_PKT_PLD_REPEATED_10101010: Repeated “10101010” (in transmission order)

enumerator GAP_PKT_PLD_PRBS15: PRBS15 sequence.

enumerator GAP_PKT_PLD_REPEATED_11111111: Repeated “11111111” (in transmission order) sequence.

enumerator GAP_PKT_PLD_REPEATED_00000000: Repeated “00000000” (in transmission order) sequence.

enumerator GAP_PKT_PLD_REPEATED_00001111: Repeated “00001111” (in transmission order) sequence.

enumerator GAP_PKT_PLD_REPEATED_01010101: Repeated “01010101” (in transmission order) sequence.

enum gap_test_phy

Enumeration of TX/RX PHY used for Test Mode.

Values:

enumerator GAP_TEST_PHY_1MBPS: LE 1M PHY (TX or RX)

enumerator GAP_TEST_PHY_2MBPS: LE 2M PHY (TX or RX)

enumerator GAP_TEST_PHY_CODED: LE Coded PHY (RX Only)

enumerator GAP_TEST_PHY_125KBPS: LE Coded PHY with S=8 data coding (TX Only)

enumerator GAP_TEST_PHY_500KBPS: LE Coded PHY with S=2 data coding (TX Only)

enum gap_modulation_idx

Modulation index.

Values:

enumerator GAP_MODULATION_STANDARD: Assume transmitter will have a standard modulation index.

enumerator GAP_MODULATION_STABLE: Assume transmitter will have a stable modulation index.

enum gapm_own_addr

Own BD address source of the device.

Values:

enumerator GAPM_STATIC_ADDR: Public or Private Static Address according to device address configuration.

enumerator GAPM_GEN_RSLV_ADDR: Generated resolvable private random address.

enumerator GAPM_GEN_NON_RSLV_ADDR: Generated non-resolvable private random address.

enum gapm_init_type

Initiating Types.

Values:

enumerator GAPM_INIT_TYPE_DIRECT_CONN_EST: Direct connection establishment, establish a connection with an indicated device.

enumerator GAPM_INIT_TYPE_AUTO_CONN_EST: Automatic connection establishment, establish a connection with all devices whose address is present in the white list

enumerator GAPM_INIT_TYPE_NAME_DISC: Name discovery, Establish a connection with an indicated device in order to read content of its Device Name characteristic. Connection is closed once this operation is stopped.

enum gapm_init_prop

Initiating Properties.

Values:

enumerator GAPM_INIT_PROP_1M_BIT: Scan connectable advertisements on the LE 1M PHY. Connection parameters for the LE 1M PHY are provided.

enumerator GAPM_INIT_PROP_2M_BIT: Connection parameters for the LE 2M PHY are provided.

enumerator GAPM_INIT_PROP_CODED_BIT: Scan connectable advertisements on the LE Coded PHY. Connection parameters for the LE Coded PHY are provided.

enum gapm_scan_prop

Scanning properties bit field bit value.

Values:

enumerator GAPM_SCAN_PROP_PHY_1M_BIT: Scan advertisement on the LE 1M PHY.

enumerator GAPM_SCAN_PROP_PHY_CODED_BIT: Scan advertisement on the LE Coded PHY.

enumerator GAPM_SCAN_PROP_ACTIVE_1M_BIT: Active scan on LE 1M PHY (Scan Request PDUs may be sent)

enumerator GAPM_SCAN_PROP_ACTIVE_CODED_BIT: Active scan on LE Coded PHY (Scan Request PDUs may be sent)

enumerator GAPM_SCAN_PROP_ACCEPT_RPA_BIT: Accept directed advertising packets if we use a RPA and target address cannot be solved by the controller

enumerator GAPM_SCAN_PROP_FILT_TRUNC_BIT: Filter truncated advertising or scan response reports.

enum gapm_scan_type

Scanning Types.

Values:

enumerator GAPM_SCAN_TYPE_GEN_DISC: General discovery.

enumerator GAPM_SCAN_TYPE_LIM_DISC: Limited discovery.

enumerator GAPM_SCAN_TYPE_OBSERVER: Observer.

enumerator GAPM_SCAN_TYPE_SEL_OBSERVER: Selective observer.

enumerator GAPM_SCAN_TYPE_CONN_DISC: Connectable discovery.

enumerator GAPM_SCAN_TYPE_SEL_CONN_DISC: Selective connectable discovery.

enum gapm_adv_report_type

Advertising report type.

Values:

enumerator GAPM_REPORT_TYPE_ADV_EXT: Extended advertising report.

enumerator GAPM_REPORT_TYPE_ADV_LEG: Legacy advertising report.

enumerator GAPM_REPORT_TYPE_SCAN_RSP_EXT: Extended scan response report.

enumerator GAPM_REPORT_TYPE_SCAN_RSP_LEG: Legacy scan response report.

enumerator GAPM_REPORT_TYPE_PER_ADV: Periodic advertising report.

enum gapm_adv_report_info

Advertising report information.

Values:

enumerator GAPM_REPORT_INFO_REPORT_TYPE_MASK: Report Type.

enumerator GAPM_REPORT_INFO_COMPLETE_BIT: Report is complete.

enumerator GAPM_REPORT_INFO_CONN_ADV_BIT: Connectable advertising.

enumerator GAPM_REPORT_INFO_SCAN_ADV_BIT: Scannable advertising.

enumerator GAPM_REPORT_INFO_DIR_ADV_BIT: Directed advertising.

Functions

uint8_t ble_gap_set_dev_name(ble_gap_dev_name_t *dev)

Set local device name. The event.

参数:

dev – [in] local device name.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_set_appearance(uint16_t appearance)

Set local appearance for GAP service.

参数:

appearance – [in] local appearance.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_set_slave_prefer_param(ble_gap_slave_prf_param_t *param)

Set local slave prefer param for GAP service.

参数:

param – [in] local slave prefer param.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_configure_public_addr(bd_addr_t *addr)

Configure local public address.

参数:

addr – [in] public address.

返回值:

The – status of configure.

uint8_t ble_gap_get_local_version(void)

Get the local version supported by controller. The event BLE_GAP_LOCAL_VER_IND will indicate the result.

返回值:: The – status of send to BLE subsystem.

uint8_t ble_gap_get_local_bdaddr(void)

Get the local address. The event BLE_GAP_LOCAL_BD_ADDR_IND will indicate the result.

返回值:: The – status of send to BLE subsystem.

uint8_t ble_gap_get_local_adv_tx_power(void)

Get the local advertising channel tx power. The event BLE_GAP_LOCAL_ADV_TX_POWER_IND will indicate the result.

返回值:: The – status of send to BLE subsystem.

uint8_t ble_gap_get_local_max_data_len(void)

Get the local maximum data length support by controller. The event BLE_GAP_LOCAL_MAX_DATA_LEN_IND will indicate the result.

返回值:: The – status of send to BLE subsystem.

uint8_t ble_gap_get_number_of_adv_sets(void)

Get the maximum number of adv sets.The event BLE_GAP_NUMBER_ADV_SETS_IND will indicate the result.

返回值:: The – status of send to BLE subsystem.

uint8_t ble_gap_get_local_max_adv_data_len(void)

Get the maximum adv data len and scan rsp len supported by controller.The event BLE_GAP_LOCAL_MAX_ADV_DATA_LEN_IND will indicate the result.

返回值:: The – status of send to BLE subsystem.

uint8_t ble_gap_set_white_list(ble_gap_white_list_t *white_list)

Set the white list.The event BLE_GAP_SET_WHITE_LIST_CNF will indicate the result.

参数:

white_list – [in] Devices in white list.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_set_resolving_list(ble_gap_resolving_list_t *rl_list)

Set the resolving list.The event BLE_GAP_SET_RESOLVING_LIST_CNF will indicate the result.

参数:

rl_list – [in] Devices in resolving list.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_get_local_ral_addr(ble_gap_addr_t *addr)

Get local ral address via peer ral address. The event BLE_GAP_RAL_ADDR_IND will indicate the result.

参数:

addr – [in] Peer ral address.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_generate_rand_addr(uint8_t rand_type)

Generate a random address by rand type. The event BLE_GAP_LOCAL_BD_ADDR_IND will indicate the result.

参见

enum gapm_own_addr)

参数:

rand_type – [in] address random type.(

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_set_irk(ble_gap_sec_key_t *new_irk)

Set new irk. The event BLE_GAP_SET_IRK_CNF will indicate the result.

参数:

new_irk – [in] new irk to set.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_create_advertising(ble_gap_adv_parameter_t *para)

Create a new advertising set. The event BLE_GAP_ADV_CREATED_IND will receive if created successful. BLE_GAP_CREATE_ADV_CNF will indicate the created compelted.

参数:

para – [in] advertising parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_set_adv_data(ble_gap_adv_data_t *data)

Set advertising data, it should be set before advertising start. The event BLE_GAP_SET_ADV_DATA_CNF will indicate the result.

参数:

data – [in] advertising data.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_set_periodic_adv_data(ble_gap_adv_data_t *data)

Set periodic advertising data. The event BLE_GAP_SET_ADV_DATA_CNF will indicate the result.

参数:

data – [in] advertising data.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_set_scan_rsp_data(ble_gap_adv_data_t *data)

Set scan rsp data, it should be set before advertising start. The event BLE_GAP_SET_SCAN_RSP_DATA_CNF will indicate the result.

参数:

data – [in] scan response data.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_start_advertising(ble_gap_adv_start_t *adv_start)

Start advertising. The event BLE_GAP_START_ADV_CNF will indicate the result.

参数:

adv_start – [in] start advertising parameter.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_stop_advertising(ble_gap_adv_stop_t *adv_stop)

Stop advertising. The event BLE_GAP_STOP_ADV_CNF will indicate the result.

参数:

adv_stop – [in] stop advertising parameter.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_delete_advertising(ble_gap_adv_delete_t *del)

Delete advertising set. The event BLE_GAP_DELETE_ADV_CNF will indicate the result.

参数:

del – [in] delete advertising parameter.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_scan_start(ble_gap_scan_start_t *scan_param)

Start scan. The event BLE_GAP_SCAN_START_CNF will indicate the result.

参数:

scan_param – [in] Scan start parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_scan_stop(void)

Stop scan.The event BLE_GAP_SCAN_STOP_CNF will indicate the result.

返回值:: The – status of send to BLE subsystem.

uint8_t ble_gap_create_connection(ble_gap_connection_create_param_t *conn_param)

Start connect peer device. The event BLE_GAP_CREATE_CONNECTION_CNF will indicate connect operation result. BLE_GAP_CONNECTED_IND will indicate peer device connected.

参数:

conn_param – [in] connection parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_connect_response(ble_gap_connection_response_t *rsp)

Provide link information for the connected request.

参数:

rsp – [in] connection information.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_cancel_create_connection(void)

Start connect peer device. The event BLE_GAP_CANCEL_CREATE_CONNECTION_CNF indicate the result.

返回值:: The – status of send to BLE subsystem.

uint8_t ble_gap_disconnect(ble_gap_disconnect_t *conn)

Disconnect peer device. The event BLE_GAP_DISCONNECT_CNF will indicate disconnect operation result. BLE_GAP_DISCONNECTED_IND will indicate peer device disconnected.

参数:

conn – [in] disconnect parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_create_periodic_advertising_sync(void)

Create a new periodic advertising sync set to get activity idx. The event BLE_GAP_CREATE_PERIODIC_ADV_SYNC_CNF indicate the result.

返回值:: The – status of send to BLE subsystem.

uint8_t ble_gap_start_periodic_advertising_sync(ble_gap_periodic_advertising_sync_start_t *sync_param)

Start periodic advertising sync to dedicated periodic advertising. The event BLE_GAP_START_PERIODIC_ADV_SYNC_CNF indicate the result.

参数:

Sync – [in] start parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_stop_periodic_advertising_sync(ble_gap_eriodic_advertising_sync_stop_t *sync_stop)

Stop periodic advertising sync. The event BLE_GAP_STOP_PERIODIC_ADV_SYNC_CNF indicate the result.

参数:

Sync – [in] stop parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_delete_periodic_advertising_sync(ble_gap_eriodic_advertising_sync_delete_t *del)

Delete periodic advertising sync set. The event BLE_GAP_DELETE_PERIODIC_ADV_SYNC_CNF indicate the result.

参数:

Sync – [in] delete parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_get_remote_version(ble_gap_get_remote_version_t *ver)

Get the peer device Bluetooth version. The event BLE_GAP_REMOTE_VER_IND will indicate the result.

参数:

ver – [in] version parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_get_remote_feature(bt_gap_get_remote_feature_t *feature)

Get the peer device supported features. The event BLE_GAP_REMOTE_FEATURE_IND will indicate the result.

参数:

feature – [in] version parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_get_remote_rssi(ble_gap_get_rssi_t *rssi)

Get the peer device RSSI. The event BLE_GAP_REMOTE_RSSI_IND will indicate the result.

参数:

rssi – [in] parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_get_remote_physical(ble_gap_get_phy_t *phy)

Get the peer device physical configuration. The event BLE_GAP_REMOTE_PHY_IND will indicate the result.

参数:

phy – [in] parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_update_conn_param(ble_gap_update_conn_param_t *conn_para)

Update the connection parameters with peer device. This API will first try to use HCI command to update connection parameter and if only remote device not supported then use l2cap to update. The event BLE_GAP_UPDATE_CONN_PARAM_IND will indicate the result.

参数:

conn_para – [in] Connection update parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_update_conn_param_on_l2cap(ble_gap_update_conn_param_t *conn_para)

Update the connection parameters with peer device .This API will try to used l2cap to update connection parameter. Only if current role is master, then use HCI command to update. The event BLE_GAP_UPDATE_CONN_PARAM_IND will indicate the result.

参数:

conn_para – [in] Connection update parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_lepsm_register(void)

uint8_t ble_gap_resolve_address(ble_gap_resolve_address_t *req)

Resolve RPA address with IRKs. The event BLE_GAP_RESOLVE_ADDRESS_CNF will indicate the result. BLE_GAP_SOLVED_ADDRESS_IND will indicate address is solved with the correct IRK.

参数:

req – [in] resolve address and possible IRKs.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_bond(ble_gap_bond_t *bond)

Bond with peer device. The API could be only called via master device. Slave device can use ble_gap_security_request(). The event BLE_GAP_BOND_CNF indicate the bond command result. The event BLE_GAP_BOND_IND will indicate the bond process result.

参数:

bond – [in] bond information.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_bond_confirm(ble_gap_bond_confirm_t *cfm)

Reponse with bond request from peer device. Should call this API after received BLE_GAP_BOND_REQ_IND. The event BLE_GAP_BOND_IND will indicate the bond result.

参数:

cfm – [in] confirm parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_encrypt_confirm(ble_gap_encrypt_confirm_t *cfm)

Reponse with encrypt request from peer device. Should call this API after received BLE_GAP_ENCRYPT_REQ_IND. The event BLE_GAP_ENCRYPT_IND will indicate the result.

参数:

cfm – [in] encrypt confirm parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_security_request(ble_gap_sec_req_t *req)

Request master initiates a security with associated parameters which only could be called as slave role. Master device can use ble_gap_bond(). The event BLE_GAP_SECURITY_REQUEST_CNF will indicate the result of request.

参数:

req – [in] Security properties.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_update_phy(ble_gap_update_phy_t *phy)

Update phy configuration with peer device. The event BLE_GAP_PHY_UPDATE_IND will indicate the result.

参数:

phy – [in] Phy updated parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_update_data_len(ble_gap_update_data_len_t *req)

Update data length with peer device. The event BLE_GAP_UPDATE_DATA_LENGTH_IND will indicate the result.

参数:

req – [in] Updated parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_gap_update_channel_map(ble_gap_update_channel_map_t *map)

Update channel map to avoid air collision. The event BLE_GAP_UPDATE_CHANNEL_MAP_CNF and BLE_GAP_UPDATE_CHANNEL_MAP_IND will indicate the result.

参数:

map – [in] Channel updated parameters.

返回值:

The – status of send to BLE subsystem.

uint8_t ble_get_local_irk(ble_gap_sec_key_t *local_irk)

Get local irk.

参数:

local_irk – [out] Local irk.

返回值:

0 – if local irk could get.

ble_common_update_type_t ble_request_local_irk(ble_gap_sec_key_t *local_irk)

User implementation function. Stack will call this function to get local irk.

参数:

local_irk – [out] Local irk.

返回值:

BLE_UPDATE_NO_UPDATE – No need to update. BLE_UPDATE_ONCE Only update if public address not existed. BLE_UPDATE_ALWAYS Always use this public address.

uint8_t ble_gap_aes_h6(uint8_t *w, uint8_t *key_id, uint32_t cb_request)

uint8_t ble_gap_aes_h7(uint8_t *salt, uint8_t *w, uint32_t metainfo)

struct ble_gap_addr_t

#include <bf0_ble_gap.h>

BD address structure.

Public Members

bd_addr_t addr: BD Address of device.

uint8_t addr_type: Address type of the device 0=public/1=private random.

struct ble_gap_ral_dev_info_t

#include <bf0_ble_gap.h>

Resolving list device information.

Public Members

ble_gap_addr_t addr: Device identity.

uint8_t priv_mode: Privacy Mode.

uint8_t peer_irk[(16)]: Peer IRK.

uint8_t local_irk[(16)]: Local IRK.

struct ble_gap_white_list_t

#include <bf0_ble_gap.h>

White list structure.

Public Members

uint8_t size: Number of entries in white list.

ble_gap_addr_t addr[]: Bd address list of white list.

struct ble_gap_resolving_list_t

#include <bf0_ble_gap.h>

The struture of set resolving list request.

Public Members

uint8_t size: Number of entries in resovling list.

ble_gap_ral_dev_info_t ral[]: Resovling inforamtion list of resovling list.

struct ble_gap_ral_addr_t

Public Members

ble_gap_addr_t peer_addr

struct ble_gap_sec_key_t

#include <bf0_ble_gap.h>

The struture of security key.

Public Members

uint8_t key[(16)]: Key value MSB -> LSB.

struct ble_gap_rand_nb_t

#include <bf0_ble_gap.h>

The struture of random number.

Public Members

uint8_t nb[(0x08)]: 8-byte array for random number

struct ble_gap_ltk_t

#include <bf0_ble_gap.h>

Long Term Key information.

Public Members

ble_gap_sec_key_t ltk: Long Term Key.

uint16_t ediv: Encryption Diversifier.

ble_gap_rand_nb_t randnb: Random Number.

uint8_t key_size: Encryption key size (7 to 16)

struct ble_gap_irk_t

#include <bf0_ble_gap.h>

Identity Resolving Key information.

Public Members

ble_gap_sec_key_t irk: Identity Resolving Key.

ble_gap_addr_t addr: Device BD Identity Address.

struct ble_gap_oob_t

#include <bf0_ble_gap.h>

Out of Band Information.

Public Members

uint8_t conf[(16)]: Confirm Value.

uint8_t rand[(16)]: Random Number.

struct ble_gap_nc_t

#include <bf0_ble_gap.h>

The struture of number comparison data.

Public Members

uint8_t value[4]: number conparison value.

struct ble_gap_dev_name_t

#include <bf0_ble_gap.h>

The struture of set local device name request.

Public Members

uint16_t len: Name length.

uint8_t name[]: Deivce name.

struct ble_gap_slave_prf_param_t

#include <bf0_ble_gap.h>

The struture of set slave preference parameter request.

Public Members

uint16_t con_intv_min: Connection interval minimum.

uint16_t con_intv_max: Connection interval maximum.

uint16_t slave_latency: Slave latency.

uint16_t conn_timeout: Connection supervision timeout multiplier.

struct gapm_adv_prim_cfg_t

#include <bf0_ble_gap.h>

Configuration for advertising on primary channel.

Public Members

uint32_t adv_intv_min: Minimum advertising interval (in unit of 625us). Must be greater than 20ms.

uint32_t adv_intv_max: Maximum advertising interval (in unit of 625us). Must be greater than 20ms.

uint8_t chnl_map

Bit field indicating the channel mapping (.

参见

enum adv_channel_map).

uint8_t phy

Indicate on which PHY primary advertising has to be performed (

参见

enum gap_phy_type) Note that LE 2M PHY is not allowed and that legacy advertising only support LE 1M PHY

struct gapm_adv_second_cfg_t

#include <bf0_ble_gap.h>

Configuration for advertising on secondary channel.

Public Members

uint8_t max_skip: Maximum number of advertising events the controller can skip before sending the AUX_ADV_IND packets. 0 means that AUX_ADV_IND PDUs shall be sent prior each advertising events

uint8_t phy

Indicate on which PHY secondary advertising has to be performed (.

参见

enum gap_phy_type)

uint8_t adv_sid: Advertising SID.

struct gapm_adv_period_cfg_t

#include <bf0_ble_gap.h>

Configuration for periodic advertising.

Public Members

uint16_t adv_intv_min: Minimum advertising interval (in unit of 1.25ms). Must be greater than 20ms.

uint16_t adv_intv_max: Maximum advertising interval (in unit of 1.25ms). Must be greater than 20ms.

struct ble_gap_adv_parameter_t

#include <bf0_ble_gap.h>

The struture of advertising parmeter.

Public Members

uint8_t own_addr_type

Own address type (.

参见

enum gapm_own_addr)

uint8_t type

Advertising type (.

参见

enum gapm_adv_type)

uint8_t disc_mode

Discovery mode (.

参见

enum gapm_adv_disc_mode)

uint16_t prop

Bit field value provided advertising properties (.

参见

enum gapm_adv_prop for bit signification)

int8_t max_tx_pwr: Maximum power level at which the advertising packets have to be transmitted (between -127 and 126 dBm, 127 dbm use default value in stack)

uint8_t filter_pol

Advertising filtering policy (.

参见

enum adv_filter_policy)

ble_gap_addr_t peer_addr: Peer address configuration (only used in case of directed advertising)

gapm_adv_prim_cfg_t prim_cfg: Configuration for primary advertising.

gapm_adv_second_cfg_t second_cfg: Configuration for secondary advertising (valid only if advertising type is GAPM_ADV_TYPE_EXTENDED)

gapm_adv_period_cfg_t period_cfg: Configuration for periodic advertising (valid only if advertising type os GAPM_ADV_TYPE_PERIODIC)

struct ble_gap_adv_data_t

#include <bf0_ble_gap.h>

The struture of advertising data and scan response data.

Public Members

uint8_t actv_idx: Activity identifier.

uint16_t length: Data length.

uint8_t data[]: Data.

struct ble_gap_adv_start_t

#include <bf0_ble_gap.h>

The struture of advertising start parameter.

Public Members

uint8_t actv_idx: Activity identifier.

uint16_t duration: Advertising duration (in unit of 10ms). 0 means that advertising continues until the host disable it (between 10 to 655350 ms)

uint8_t max_adv_evt: Maximum number of extended advertising events the controller shall attempt to send prior to terminating the extending advertising Valid only if extended advertising

struct ble_gap_adv_stop_t

#include <bf0_ble_gap.h>

The struture of advertising stop parameter.

Public Members

uint8_t actv_idx: Activity identifier.

struct ble_gap_adv_delete_t

#include <bf0_ble_gap.h>

The struture of advertising delete parameter.

Public Members

uint8_t actv_idx: Activity identifier.

struct ble_gap_scan_param_t

#include <bf0_ble_gap.h>

The struture of scan window parameter.

Public Members

uint16_t scan_intv: Scan interval in unit of 0.625ms (between 2.5ms to 40.959375s)

uint16_t scan_wd: Scan window in unit of 0.625ms (between 2.5ms to 40.959375s)

struct ble_gap_scan_start_t

#include <bf0_ble_gap.h>

The struture of scan start parameter.

Public Members

uint8_t own_addr_type

own addr type. (

参见

enum gapm_own_addr)

uint8_t type

Type of scanning to be started (.

参见

enum gapm_scan_type)

uint8_t prop

Properties for the scan procedure (.

参见

enum gapm_scan_prop for bit signification)

uint8_t dup_filt_pol: Duplicate packet filtering policy.

uint8_t rsvd: Reserved for future use.

ble_gap_scan_param_t scan_param_1m: Scan window opening parameters for LE 1M PHY.

uint16_t duration: Scan window opening parameters for LE Coded PHY reception of a stop command from the application

uint16_t period: Scan period (in unit of 1.28s). Time interval betweem two consequent starts of a scan duration by the controller. 0 means that the scan procedure is not periodic (between 1.28s to 83884.8s)

struct ble_gap_scan_stop_t

#include <bf0_ble_gap.h>

The struture of scan stop parameter.

Public Members

uint8_t actv_idx: Activity identifier.

struct ble_gap_conn_param_t

#include <bf0_ble_gap.h>

The struture of connection parameter.

Public Members

uint16_t scan_intv: Scan interval (in unit of 625us) (between 2.5ms to 40.959375s)

uint16_t scan_wd: Scan window (in unit of 0.625us) (between 2.5ms to 40.959375s)

uint16_t conn_intv_min: Minimum value for the connection interval (in unit of 1.25ms). Shall be less than or equal to conn_intv_max value. Allowed range is 7.5ms to 4s.

uint16_t conn_intv_max: Maximum value for the connection interval (in unit of 1.25ms). Shall be greater than or equal to conn_intv_min value. Allowed range is 7.5ms to 4s.

uint16_t conn_latency: Slave latency. Number of events that can be missed by a connected slave device. Allowed range is 0 to ((supervision_to / (conn_intv)) - 1)

uint16_t supervision_to: Link supervision timeout (in unit of 10ms). Allowed range is 100ms to 32s.

uint16_t ce_len_min: Recommended minimum duration of connection events (in unit of 625us)

uint16_t ce_len_max: Recommended maximum duration of connection events (in unit of 625us)

struct ble_gap_connection_create_param_t

#include <bf0_ble_gap.h>

The struture of create connection parameter.

Public Members

uint8_t own_addr_type

own addr type. (

参见

enum gapm_own_addr)

uint8_t type

Initiating type (.

参见

enum gapm_init_type)

uint16_t conn_to

Properties for the initiating procedure (.

参见

enum gapm_init_prop for bit signification) Timeout for automatic connection establishment (in unit of 10ms). Cancel the procedure if not all indicated devices have been connected when the timeout occurs. 0 means there is no timeout

ble_gap_conn_param_t conn_param_1m: Connection parameters for LE 1M PHY.

ble_gap_addr_t peer_addr: Address of peer device in case white list is not used for connection.

struct ble_gap_periodic_advertising_sync_start_t

#include <bf0_ble_gap.h>

The struture of start periodic advertising sync parameter.

Public Members

uint8_t actv_idx: Activity identifier.

uint8_t type

Periodic synchronization type (.

参见

enum gap_per_sync_type)

ble_gap_addr_t addr: Advertiser address information.

uint8_t adv_sid: Advertising SID.

uint16_t skip: value is 499

uint16_t sync_to: Synchronization timeout for the periodic advertising (in unit of 10ms between 100ms and 163.84s)

struct ble_gap_eriodic_advertising_sync_stop_t

#include <bf0_ble_gap.h>

The struture of stop periodic advertising sync parameter.

Public Members

uint8_t actv_idx: Activity identifier.

struct ble_gap_eriodic_advertising_sync_delete_t

#include <bf0_ble_gap.h>

The struture of delete periodic advertising sync parameter.

Public Members

uint8_t actv_idx: Activity identifier.

struct ble_gap_connection_response_t

Public Members

uint8_t conn_idx: Connection index.

ble_gap_sec_key_t lcsrk: Local CSRK value.

uint32_t lsign_counter: Local signature counter value that acquired from BLE_GAP_SIGN_COUNTER_UPDATE_IND.

ble_gap_sec_key_t rcsrk: Remote CSRK value that distributed from BLE_GAP_BOND_IND (if info == GAPC_CSRK_EXCH)

uint32_t rsign_counter: Remote signature counter value that acquired from BLE_GAP_SIGN_COUNTER_UPDATE_IND.

uint8_t auth

Authentication (.

参见

gap_auth) from BLE_GAP_BOND_IND (if info == GAPC_PAIRING_SUCCEED)

bool ltk_present: LTK exchanged from BLE_GAP_BOND_IND (if info == GAPC_PAIRING_SUCCEED)

struct ble_gap_disconnect_t

#include <bf0_ble_gap.h>

The structure of disconnect request.

Public Members

uint8_t conn_idx: Connection index.

uint8_t reason

Disconnect Reason(

参见

enum co_error).

struct ble_gap_get_remote_version_t

#include <bf0_ble_gap.h>

The structure of get remote version request.

Public Members

uint8_t conn_idx: Connection index.

struct bt_gap_get_remote_feature_t

#include <bf0_ble_gap.h>

The structure of get remote feature request.

Public Members

uint8_t conn_idx: Connection index.

struct ble_gap_get_rssi_t

#include <bf0_ble_gap.h>

The structure of get RSSI request.

Public Members

uint8_t conn_idx: Connection index.

struct ble_gap_get_phy_t

#include <bf0_ble_gap.h>

The structure of get remote physical request.

Public Members

uint8_t conn_idx: Connection index.

struct ble_gap_update_conn_param_t

#include <bf0_ble_gap.h>

The structure of update connection parameter request.

Public Members

uint8_t conn_idx: Connection index.

uint16_t intv_min: Connection interval minimum. Shall be less than or equal to intv_max value. Allowed range is 7.5ms to 4s

uint16_t intv_max: Connection interval maximum. Shall be greater than or equal to intv_min value. Allowed range is 7.5ms to 4s

uint16_t latency: Latency. Allowed range is 0 to ((time_out / (conn_intv)) - 1)

uint16_t time_out: Supervision timeout (in unit of 10ms). Allowed range is 100ms to 32s.

uint16_t ce_len_min: Minimum Connection Event Duration (in unit of 625us)

uint16_t ce_len_max: Maximum Connection Event Duration (in unit of 625us)

struct ble_gap_pairing_t

#include <bf0_ble_gap.h>

The structure of pair information.

Public Members

uint8_t iocap

IO capabilities (.

参见

gap_io_cap)

uint8_t oob

OOB information (.

参见

gap_oob)

uint8_t auth

Authentication (

参见

gap_auth) Note in BT 4.1 the Auth Field is extended to include ‘Key Notification’ and and ‘Secure Connections’.

uint8_t key_size: Encryption key size (7 to 16)

uint8_t ikey_dist

Initiator key distribution (.

参见

gap_kdist)

uint8_t rkey_dist

Responder key distribution (.

参见

gap_kdist)

uint8_t sec_req

Device security requirements (minimum security level). (.

参见

gap_sec_req)

struct ble_gap_bond_t

#include <bf0_ble_gap.h>

The structure of bond request.

Public Members

uint8_t conn_idx: Connection index.

ble_gap_pairing_t pair_info: Pair info struct.

union ble_gap_bond_cfm_data_t

Public Members

ble_gap_pairing_t pairing_feat: Pairing Features (request = GAPC_PAIRING_RSP)

ble_gap_ltk_t ltk: LTK (request = GAPC_LTK_EXCH)

ble_gap_sec_key_t csrk: CSRK (request = GAPC_CSRK_EXCH)

ble_gap_sec_key_t tk: TK (request = GAPC_TK_EXCH)

ble_gap_irk_t irk: IRK (request = GAPC_IRK_EXCH)

ble_gap_oob_t oob: OOB Confirm and Random from the peer (request = GAPC_OOB_EXCH)

struct ble_gap_bond_confirm_t

#include <bf0_ble_gap.h>

The structure of bond confirm.

Public Members

uint8_t conn_idx: Connection index.

uint8_t request

Bond request type (

参见

gapc_bond).

uint8_t accept: Request accepted.

ble_gap_bond_cfm_data_t cfm_data: bond confirm data structure.

struct ble_gap_encrypt_confirm_t

#include <bf0_ble_gap.h>

The structure of bond confirm.

Public Members

uint8_t conn_idx: Connection index.

uint8_t found: Indicate if a LTK has been found for the peer device.

ble_gap_sec_key_t ltk: Long Term Key.

uint8_t key_size: LTK Key Size.

struct ble_gap_sec_req_t

#include <bf0_ble_gap.h>

The structure of security request.

Public Members

uint8_t conn_idx: Connection index.

uint8_t auth

Authentication level (

参见

gap_auth).

struct ble_gap_update_phy_t

Public Members

uint8_t conn_idx

uint8_t tx_phy

Supported LE PHY for data transmission (.

参见

enum gap_phy)

uint8_t rx_phy

Supported LE PHY for data reception (.

参见

enum gap_phy)

uint8_t phy_opt

PHY options (.

参见

enum gapc_phy_option)

struct ble_gap_update_data_len_t

Public Members

uint8_t conn_idx

uint16_t tx_octets: Preferred maximum number of payload octets that the local Controller should include in a single Link Layer Data Channel PDU.

uint16_t tx_time: Preferred maximum number of microseconds that the local Controller should use to transmit a single Link Layer Data Channel PDU

struct ble_gap_resolve_address_t

Public Members

uint8_t nb_key: Number of provided IRK (sahlle be > 0)

bd_addr_t addr: Resolvable random address to solve.

ble_gap_sec_key_t irk[]: Array of IRK used for address resolution (MSB -> LSB)

struct ble_gap_local_version_ind_t

#include <bf0_ble_gap.h>

Event.

Local device version indication event. The structure of BLE_GAP_LOCAL_VER_IND.

Public Members

uint8_t hci_ver: HCI version.

uint8_t lmp_ver: LMP version.

uint8_t host_ver: Host version.

uint16_t hci_subver: HCI revision.

uint16_t lmp_subver: LMP subversion.

uint16_t host_subver: Host revision.

uint16_t manuf_name: Manufacturer name.

struct ble_gap_dev_bdaddr_ind_t

#include <bf0_ble_gap.h>

Local device BD Address indication event. The structure of BLE_GAP_LOCAL_BD_ADDR_IND.

Public Members

ble_gap_addr_t addr: Local device address information.

uint8_t actv_idx: Activity index.

struct ble_gap_dev_adv_tx_power_ind_t

#include <bf0_ble_gap.h>

Advertising channel Tx power level indication event. The structure of BLE_GAP_LOCAL_ADV_TX_POWER_IND.

Public Members

int8_t power_lvl: Advertising channel Tx power level.

struct ble_gap_max_data_len_ind_t

#include <bf0_ble_gap.h>

Indicates maximum data length. The structure of BLE_GAP_LOCAL_MAX_DATA_LEN_IND.

Public Members

uint16_t suppted_max_tx_octets: Maximum number of payload octets that the local Controller supports for transmission.

uint16_t suppted_max_tx_time: Maximum time, in microseconds, that the local Controller supports for transmission.

uint16_t suppted_max_rx_octets: Maximum number of payload octets that the local Controller supports for reception.

uint16_t suppted_max_rx_time: Maximum time, in microseconds, that the local Controller supports for reception.

struct ble_gap_nb_adv_sets_ind_t

#include <bf0_ble_gap.h>

Number of available advertising sets indication event. The structure of BLE_GAP_NUMBER_ADV_SETS_IND.

Public Members

uint8_t nb_adv_sets: Number of available advertising sets.

struct ble_gap_max_adv_data_len_ind_t

#include <bf0_ble_gap.h>

Maximum advertising data length indication event. The structure of BLE_GAP_LOCAL_MAX_ADV_DATA_LEN_IND.

Public Members

uint16_t length: Maximum advertising data length supported by controller.

struct ble_gap_update_channel_map_t

#include <bf0_ble_gap.h>

The structure of channel map.

Public Members

uint8_t channel_map[(0x05)]

struct ble_gap_update_channel_map_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_UPDATE_CHANNEL_MAP_IND.

Public Members

uint8_t channel_map[(0x05)]

struct ble_gap_adv_created_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_ADV_CREATED_IND.

Public Members

uint8_t actv_idx: Activity identifier.

int8_t tx_pwr: Selected TX power for advertising activity.

struct ble_gap_adv_stopped_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_ADV_STOPPED_IND.

Public Members

uint8_t actv_idx: Activity identifier.

uint8_t reason: Stopped reason.

int8_t per_adv_stop: In case of periodic advertising, indicate if periodic advertising has been stopped.

struct ble_gap_scan_stopped_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_SCAN_STOPPED_IND.

Public Members

uint8_t reason: Stopped reason.

struct ble_gap_status_t

Public Members

uint8_t status

struct ble_gap_start_adv_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_START_ADV_CNF.

Public Members

uint8_t actv_index: Activity identifier.

uint8_t status: Start result.

struct ble_gap_stop_adv_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_STOP_ADV_CNF.

Public Members

uint8_t actv_index: Activity identifier.

uint8_t status: Start result.

struct ble_gap_delete_adv_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_DELETE_ADV_CNF.

Public Members

uint8_t actv_index: Activity identifier.

uint8_t status: Delete result.

struct ble_gap_update_conn_param_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_UPDATE_CONN_PARAM_CNF.

Public Members

uint8_t conn_idx: Connection index.

uint8_t status: Update request result

struct ble_gap_disconnect_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_DISCONNECT_CNF.

Public Members

uint8_t conn_idx: Connection index.

uint8_t status: Disconnect request result.

struct ble_gap_ral_addr_ind_t

#include <bf0_ble_gap.h>

Resolving Address indication event. The structure of BLE_GAP_RAL_ADDR_IND. */.

Public Members

ble_gap_addr_t addr: Resolving List address.

struct ble_gap_connect_configure_t

#include <bf0_ble_gap.h>

Provide link configrations.

Public Members

ble_gap_sec_key_t lcsrk: Local CSRK value.

uint32_t lsign_counter: Local signature counter value that acquired from BLE_GAP_SIGN_COUNTER_UPDATE_IND.

ble_gap_sec_key_t rcsrk: Remote CSRK value that distributed from BLE_GAP_BOND_IND (if info == GAPC_CSRK_EXCH)

uint32_t rsign_counter: Remote signature counter value that acquired from BLE_GAP_SIGN_COUNTER_UPDATE_IND.

uint8_t auth

Authentication (.

参见

gap_auth) from BLE_GAP_BOND_IND (if info == GAPC_PAIRING_SUCCEED)

bool ltk_present: LTK exchanged from BLE_GAP_BOND_IND (if info == GAPC_PAIRING_SUCCEED)

uint8_t not_respond: CFG not respond directly.

struct ble_gap_connect_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_CONNECTED_IND.

Public Members

uint8_t conn_idx: Connection index.

uint16_t con_interval: Connection interval, time = N * 1.25ms.

uint16_t con_latency: Connection latency.

uint16_t sup_to: Link supervision timeout, time = N * 10 ms.

uint8_t peer_addr_type: Peer address type.

bd_addr_t peer_addr: Peer BT address.

uint8_t role: Role of device in connection (0 = Master / 1 = Slave)

ble_gap_connect_configure_t config_info: Need one and only one user to fill this filed to provide link configurations.

struct ble_gap_disconnected_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_DISCONNECTED_IND.

Public Members

uint8_t conn_idx: Connection index.

uint8_t reason

Reason of disconnection(.

参见

enum co_error)

struct ble_gap_per_adv_sync_created_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_PERIODIC_ADV_SYNC_CREATED_IND.

Public Members

uint8_t actv_idx: Activity identifier.

struct ble_gap_per_adv_sync_stopped_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_PERIODIC_ADV_SYNC_STOPPED_IND.

Public Members

uint8_t actv_idx: Activity identifier.

uint8_t reason: Stopped reason.

struct ble_gap_start_per_adv_sync_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_START_PERIODIC_ADV_SYNC_CNF.

Public Members

uint8_t actv_index: Activity identifier.

uint8_t status: Start result.

struct ble_gap_stop_per_adv_sync_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_STOP_PERIODIC_ADV_SYNC_CNF.

Public Members

uint8_t actv_index: Activity identifier.

uint8_t status: Start result.

struct ble_gap_delete_per_adv_sync_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_DELETE_PERIODIC_ADV_SYNC_CNF.

Public Members

uint8_t actv_index: Activity identifier.

uint8_t status: Delete result.

struct ble_gap_per_adv_sync_established_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_PERIODIC_ADV_SYNC_ESTABLISHED_IND.

Public Members

uint8_t actv_idx: Activity identifier.

uint8_t phy

PHY on which synchronization has been established (.

参见

gap_phy_type)

uint16_t intv: Periodic advertising interval (in unit of 1.25ms, min is 7.5ms)

uint8_t adv_sid: Advertising SID.

uint8_t clk_acc

Advertiser clock accuracy (.

参见

enum gapm_clk_acc)

ble_gap_addr_t addr: Advertiser address.

struct ble_gap_remote_version_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_REMOTE_VER_IND.

Public Members

uint8_t conn_idx: Connection index.

uint16_t compid: Manufacturer name.

uint16_t lmp_subvers: LMP subversion.

uint8_t lmp_vers: LMP version.

struct ble_gap_remote_features_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_REMOTE_FEATURE_IND.

Public Members

uint8_t conn_idx: Connection index.

uint8_t features[(0x08)]: 8-byte array for LE features

struct ble_gap_remote_rssi_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_REMOTE_RSSI_IND.

Public Members

uint8_t conn_idx: Connection index.

int8_t rssi: RSSI value.

struct ble_gap_remote_phy_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_REMOTE_PHY_IND.

Public Members

uint8_t conn_idx: Connection index.

uint8_t tx_phy

LE PHY for data transmission (.

参见

enum gap_phy)

uint8_t rx_phy

LE PHY for data reception (.

参见

enum gap_phy)

struct ble_gap_update_conn_param_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_UPDATE_CONN_PARAM_IND.

Public Members

uint8_t conn_idx: Connection index.

uint16_t con_interval: Connection interval value.

uint16_t con_latency: Connection latency value.

uint16_t sup_to: Supervision timeout.

union ble_gap_bond_req_data_t

#include <bf0_ble_gap.h>

Bond procedure requested information data.

Public Members

uint8_t auth_req

Authentication level (.

参见

gap_auth) (if request = GAPC_PAIRING_REQ)

uint8_t key_size: LTK Key Size (if request = GAPC_LTK_EXCH)

uint8_t tk_type

Device IO used to get TK: (if request = GAPC_TK_EXCH)

GAP_TK_OOB: TK get from out of band method
GAP_TK_DISPLAY: TK generated and shall be displayed by local device
GAP_TK_KEY_ENTRY: TK shall be entered by user using device keyboard

ble_gap_oob_t oob_data: Addition OOB Data for the OOB Conf and Rand values.

ble_gap_nc_t nc_data: Numeric Comparison Data.

struct ble_gap_bond_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_BOND_CNF.

Public Members

uint8_t conn_idx: Connection index.

uint8_t status: Bond command result.

struct ble_gap_bond_req_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_BOND_REQ_IND.

Public Members

uint8_t conn_idx: Connection index.

uint8_t request

Bond request type (.

参见

gapc_bond)

ble_gap_bond_req_data_t data: Bond parameter.

struct ble_gap_bond_auth_t

#include <bf0_ble_gap.h>

Authentication information

Public Members

uint8_t info

Authentication information (.

参见

gap_auth)

bool ltk_present: LTK exchanged during pairing.

union ble_gap_bond_data_t

#include <bf0_ble_gap.h>

Bond procedure information data.

Public Members

ble_gap_bond_auth_t auth

Authentication information (

参见

gap_auth) (if info = GAPC_PAIRING_SUCCEED)

uint8_t reason: Pairing failed reason (if info = GAPC_PAIRING_FAILED)

ble_gap_ltk_t ltk: Long Term Key information (if info = GAPC_LTK_EXCH)

ble_gap_irk_t irk: Identity Resolving Key information (if info = GAPC_IRK_EXCH)

ble_gap_sec_key_t csrk: Connection Signature Resolving Key information (if info = GAPC_CSRK_EXCH)

struct ble_gap_bond_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_BOND_IND.

Public Members

uint8_t conn_idx: Connection index.

uint8_t info

Bond information type (.

参见

gapc_bond)

ble_gap_bond_data_t data

struct ble_gap_encrypt_req_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_ENCRYPT_REQ_IND.

Public Members

uint8_t conn_idx: Connection index.

uint16_t ediv: Encryption Diversifier.

ble_gap_rand_nb_t rand_nb: Random Number.

struct ble_gap_encrypt_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_ENCRYPT_IND.

Public Members

uint8_t conn_idx: Connection index.

uint8_t auth

Authentication level (.

参见

gap_auth)

struct ble_gap_security_request_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_SECURITY_REQUEST_IND.

Public Members

uint8_t conn_idx: Connection index.

uint8_t auth

Authentication level (.

参见

gap_auth)

struct ble_gap_security_request_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_SECURITY_REQUEST_CNF.

Public Members

uint8_t conn_idx: Connection index.

uint8_t status: Security request result.

struct ble_gap_update_data_length_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_UPDATE_DATA_LENGTH_CNF.

Public Members

uint8_t conn_idx: Connection index.

uint8_t status: Update data length result.

struct ble_gap_update_data_length_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_UPDATE_DATA_LENGTH_IND.

Public Members

uint8_t conn_idx: Connection index.

uint16_t max_tx_octets: The maximum number of payload octets in TX.

uint16_t max_tx_time: The maximum time that the local Controller will take to TX.

uint16_t max_rx_octets: The maximum number of payload octets in RX.

uint16_t max_rx_time: The maximum time that the local Controller will take to RX.

struct ble_gap_update_channel_map_cnf_t

#include <bf0_ble_gap.h>

The struture of BLE_GAP_UPDATE_CHANNEL_MAP_CNF.

Public Members

uint8_t conn_idx: Connection index.

uint8_t status: Update data length result.

struct ble_gap_sign_counter_update_ind_t

#include <bf0_ble_gap.h>

The structure of BLE_GAP_SIGN_COUNTER_UPDATE_IND.

Public Members

uint32_t local_sign_counter: Local SignCounter value.

uint32_t peer_sign_counter: Peer SignCounter value.

struct ble_gap_ext_adv_report_ind_t

#include <bf0_ble_gap.h>

@ Indicate reception of advertising, scan response or periodic advertising data. The structure of BLE_GAP_EXT_ADV_REPORT_IND

Public Members

uint8_t actv_idx: Activity identifier.

uint8_t info

Combined with report type (.

参见

enum gapm_adv_report_type) and bit field providing information (

参见

enum gapm_adv_report_info)

ble_gap_addr_t addr: Advertising device address.

ble_gap_addr_t direct_addr: Directed advertising target address (in case of a directed advertising report)

int8_t tx_pwr: TX power (in dBm)

int8_t rssi: RSSI (between -127 and +20 dBm)

uint8_t phy_prim: Primary PHY on which advertising report has been received.

uint8_t phy_second: Secondary PHY on which advertising report has been received.

uint8_t adv_sid: Advertising SID Valid only for periodic advertising report

uint16_t period_adv_intv: Periodic advertising interval (in unit of 1.25ms, min is 7.5ms) Valid only for periodic advertising report

uint16_t length: Report length.

uint8_t data[]: Report.

struct bt_dbg_rssi_notify_ind_t

#include <bf0_ble_gap.h>

@ Indicate rssi and channel assesement of connected link . The structure of BT_DBG_RSSI_NOTIFY_IND

Public Members

uint8_t is_bt: BT link or BLE link.

int8_t channel_asset[79]: All channel assesement. 0 is no prefered. Negative is good channel while positive is bad channel.

uint8_t rssi_num: Average RSSI for all Exsted link of BT or BLE.

int8_t rssi_ave[]

struct ble_gap_solved_addr_ind_t

Public Members

bd_addr_t addr: Resolvable random address solved.

ble_gap_sec_key_t irk: IRK that correctly solved the random address.

struct ble_gap_assert_ind_t

Public Members

uint8_t type