espressif/esp-nimble
1
0
Fork 0
mirror of https://github.com/espressif/esp-nimble.git synced 2026-06-06 05:14:45 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0fb1f1ef11a0e166d78e8d71bd801f2f92fad047
esp-nimble/nimble/host/include/host/ble_gap.h
T

4187 lines
150 KiB
C
Raw Blame History

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef H_BLE_GAP_
#define H_BLE_GAP_
/**
* @brief Bluetooth Host Generic Access Profile (GAP)
* @defgroup bt_host_gap Bluetooth Host Generic Access Profile (GAP)
* @ingroup bt_host
* @{
*/
#include <inttypes.h>
#include "host/ble_hs.h"
#include "host/ble_hs_adv.h"
#include "syscfg/syscfg.h"
#include "host/ble_esp_gap.h"
#if MYNEWT_VAL(ENC_ADV_DATA)
#include "../../src/ble_hs_hci_priv.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
struct hci_le_conn_complete;
struct hci_conn_update;
#define BLE_GAP_ADV_ITVL_MS(t) ((t) * 1000 / BLE_HCI_ADV_ITVL)
#define BLE_GAP_SCAN_ITVL_MS(t) ((t) * 1000 / BLE_HCI_SCAN_ITVL)
#define BLE_GAP_SCAN_WIN_MS(t) ((t) * 1000 / BLE_HCI_SCAN_ITVL)
#define BLE_GAP_CONN_ITVL_MS(t) ((t) * 1000 / BLE_HCI_CONN_ITVL)
#define BLE_GAP_SUPERVISION_TIMEOUT_MS(t) ((t) / 10)
#define BLE_GAP_PERIODIC_ITVL_MS(t) ((t) * 1000 / BLE_HCI_PERIODIC_ADV_ITVL)
#if MYNEWT_VAL(BLE_HIGH_DUTY_ADV_ITVL)
/** 5 ms. */
#define BLE_GAP_ADV_FAST_INTERVAL1_MIN BLE_GAP_ADV_ITVL_MS(5)
#else
/** 30 ms. */
#define BLE_GAP_ADV_FAST_INTERVAL1_MIN BLE_GAP_ADV_ITVL_MS(30)
#endif
/** 60 ms. */
#define BLE_GAP_ADV_FAST_INTERVAL1_MAX BLE_GAP_ADV_ITVL_MS(60)
#if MYNEWT_VAL(BLE_HIGH_DUTY_ADV_ITVL)
/** 5 ms. */
#define BLE_GAP_ADV_FAST_INTERVAL2_MIN BLE_GAP_ADV_ITVL_MS(5)
#else
/** 100 ms. */
#define BLE_GAP_ADV_FAST_INTERVAL2_MIN BLE_GAP_ADV_ITVL_MS(100)
#endif
/** 150 ms. */
#define BLE_GAP_ADV_FAST_INTERVAL2_MAX BLE_GAP_ADV_ITVL_MS(150)
/** 30 ms; active scanning. */
#define BLE_GAP_SCAN_FAST_INTERVAL_MIN BLE_GAP_SCAN_ITVL_MS(30)
/** 60 ms; active scanning. */
#define BLE_GAP_SCAN_FAST_INTERVAL_MAX BLE_GAP_SCAN_ITVL_MS(60)
/** 11.25 ms; limited discovery interval. */
#define BLE_GAP_LIM_DISC_SCAN_INT BLE_GAP_SCAN_ITVL_MS(11.25)
/** 11.25 ms; limited discovery window (not from the spec). */
#define BLE_GAP_LIM_DISC_SCAN_WINDOW BLE_GAP_SCAN_WIN_MS(11.25)
/** 30 ms; active scanning. */
#define BLE_GAP_SCAN_FAST_WINDOW BLE_GAP_SCAN_WIN_MS(30)
/* 30.72 seconds; active scanning. */
#define BLE_GAP_SCAN_FAST_PERIOD BLE_GAP_SCAN_ITVL_MS(30.72)
/** 1.28 seconds; background scanning. */
#define BLE_GAP_SCAN_SLOW_INTERVAL1 BLE_GAP_SCAN_ITVL_MS(1280)
/** 11.25 ms; background scanning. */
#define BLE_GAP_SCAN_SLOW_WINDOW1 BLE_GAP_SCAN_WIN_MS(11.25)
/** 10.24 seconds. */
#define BLE_GAP_DISC_DUR_DFLT (10.24 * 1000)
/** 30 seconds (not from the spec). */
#define BLE_GAP_CONN_DUR_DFLT (30 * 1000)
/** 1 second. */
#define BLE_GAP_CONN_PAUSE_CENTRAL (1 * 1000)
/** 5 seconds. */
#define BLE_GAP_CONN_PAUSE_PERIPHERAL (5 * 1000)
/* 30 ms. */
#define BLE_GAP_INITIAL_CONN_ITVL_MIN BLE_GAP_CONN_ITVL_MS(30)
/* 50 ms. */
#define BLE_GAP_INITIAL_CONN_ITVL_MAX BLE_GAP_CONN_ITVL_MS(50)
/** Default channels mask: all three channels are used. */
#define BLE_GAP_ADV_DFLT_CHANNEL_MAP 0x07
#define BLE_GAP_INITIAL_CONN_LATENCY 0
#define BLE_GAP_INITIAL_SUPERVISION_TIMEOUT 0x0100
#define BLE_GAP_INITIAL_CONN_MIN_CE_LEN 0x0000
#define BLE_GAP_INITIAL_CONN_MAX_CE_LEN 0x0000
#define BLE_GAP_ROLE_MASTER 0
#define BLE_GAP_ROLE_SLAVE 1
#define BLE_GAP_EVENT_CONNECT 0
#define BLE_GAP_EVENT_DISCONNECT 1
/* Reserved 2 */
#define BLE_GAP_EVENT_CONN_UPDATE 3
#define BLE_GAP_EVENT_CONN_UPDATE_REQ 4
#define BLE_GAP_EVENT_L2CAP_UPDATE_REQ 5
#define BLE_GAP_EVENT_TERM_FAILURE 6
#define BLE_GAP_EVENT_DISC 7
#define BLE_GAP_EVENT_DISC_COMPLETE 8
#define BLE_GAP_EVENT_ADV_COMPLETE 9
#define BLE_GAP_EVENT_ENC_CHANGE 10
#define BLE_GAP_EVENT_PASSKEY_ACTION 11
#define BLE_GAP_EVENT_NOTIFY_RX 12
#define BLE_GAP_EVENT_NOTIFY_TX 13
#define BLE_GAP_EVENT_SUBSCRIBE 14
#define BLE_GAP_EVENT_MTU 15
#define BLE_GAP_EVENT_IDENTITY_RESOLVED 16
#define BLE_GAP_EVENT_REPEAT_PAIRING 17
#define BLE_GAP_EVENT_PHY_UPDATE_COMPLETE 18
#define BLE_GAP_EVENT_EXT_DISC 19
#define BLE_GAP_EVENT_PERIODIC_SYNC 20
#define BLE_GAP_EVENT_PERIODIC_REPORT 21
#define BLE_GAP_EVENT_PERIODIC_SYNC_LOST 22
#define BLE_GAP_EVENT_SCAN_REQ_RCVD 23
#define BLE_GAP_EVENT_PERIODIC_TRANSFER 24
#define BLE_GAP_EVENT_PATHLOSS_THRESHOLD 25
#define BLE_GAP_EVENT_TRANSMIT_POWER 26
#define BLE_GAP_EVENT_PARING_COMPLETE 27
#define BLE_GAP_EVENT_SUBRATE_CHANGE 28
#define BLE_GAP_EVENT_VS_HCI 29
#define BLE_GAP_EVENT_BIGINFO_REPORT 30
#define BLE_GAP_EVENT_REATTEMPT_COUNT 31
#define BLE_GAP_EVENT_AUTHORIZE 32
#define BLE_GAP_EVENT_TEST_UPDATE 33
#define BLE_GAP_EVENT_DATA_LEN_CHG 34
#define BLE_GAP_EVENT_CONNLESS_IQ_REPORT 35
#define BLE_GAP_EVENT_CONN_IQ_REPORT 36
#define BLE_GAP_EVENT_CTE_REQ_FAILED 37
//TODO : Deprecate the EVENT_LINK_ESTAB going ahead
#define BLE_GAP_EVENT_LINK_ESTAB 38
#define BLE_GAP_EVENT_EATT 39
#define BLE_GAP_EVENT_PER_SUBEV_DATA_REQ 40
#define BLE_GAP_EVENT_PER_SUBEV_RESP 41
#define BLE_GAP_EVENT_PERIODIC_TRANSFER_V2 42
/* ISO events */
#define BLE_GAP_EVENT_CIS_ESTAB 43
#define BLE_GAP_EVENT_CIS_REQUEST 44
#define BLE_GAP_EVENT_CREATE_BIG_COMP 45
#define BLE_GAP_EVENT_TERM_BIG_COMP 46
#define BLE_GAP_EVENT_BIG_SYNC_ESTAB 47
#define BLE_GAP_EVENT_BIG_SYNC_LOST 48
#define BLE_GAP_EVENT_BIGINFO_ADV_RPT 49
#define BLE_GAP_EVENT_CIS_ESTAB_V2 50
#define BLE_GAP_EVENT_RD_ALL_REM_FEAT 51
#define BLE_GAP_EVENT_MONITOR_ADV_REPORT 52
#define BLE_GAP_EVENT_CACHE_ASSOC 53
/* DTM events */
#define BLE_GAP_DTM_TX_START_EVT 0
#define BLE_GAP_DTM_RX_START_EVT 1
#define BLE_GAP_DTM_END_EVT 2
/*** Reason codes for the subscribe GAP event. */
/** Peer's CCCD subscription state changed due to a descriptor write. */
#define BLE_GAP_SUBSCRIBE_REASON_WRITE 1
/** Peer's CCCD subscription state cleared due to connection termination. */
#define BLE_GAP_SUBSCRIBE_REASON_TERM 2
/**
* Peer's CCCD subscription state changed due to restore from persistence
* (bonding restored).
*/
#define BLE_GAP_SUBSCRIBE_REASON_RESTORE 3
#define BLE_GAP_REPEAT_PAIRING_RETRY 1
#define BLE_GAP_REPEAT_PAIRING_IGNORE 2
/**
* @defgroup Mask for checking random address validity
* @{
*/
/** Static random address check mask. */
#define BLE_STATIC_RAND_ADDR_MASK 0xC0
/** Non RPA check mask. */
#define BLE_NON_RPA_MASK 0x3F
/** @} */
/* Response values for gatt read/write authorization event */
#define BLE_GAP_AUTHORIZE_ACCEPT 1
#define BLE_GAP_AUTHORIZE_REJECT 2
/** Connection security state */
struct ble_gap_sec_state {
/** If connection is encrypted */
unsigned encrypted:1;
/** If connection is authenticated */
unsigned authenticated:1;
/** If connection is bonded (security information is stored) */
unsigned bonded:1;
/** Size of a key used for encryption */
unsigned key_size:5;
/** Current device security state*/
unsigned authorize:1;
};
/** Read Remote Version parameters **/
struct ble_gap_read_rem_ver_params {
/** Version of the Current LMP **/
uint8_t version;
/** Company Identifier **/
uint16_t manufacturer;
/** Revision of the LMP **/
uint16_t subversion;
};
/** Advertising parameters */
struct ble_gap_adv_params {
/** Advertising mode. Can be one of following constants:
* - BLE_GAP_CONN_MODE_NON (non-connectable; 3.C.9.3.2).
* - BLE_GAP_CONN_MODE_DIR (directed-connectable; 3.C.9.3.3).
* - BLE_GAP_CONN_MODE_UND (undirected-connectable; 3.C.9.3.4).
*/
uint8_t conn_mode;
/** Discoverable mode. Can be one of following constants:
* - BLE_GAP_DISC_MODE_NON (non-discoverable; 3.C.9.2.2).
* - BLE_GAP_DISC_MODE_LTD (limited-discoverable; 3.C.9.2.3).
* - BLE_GAP_DISC_MODE_GEN (general-discoverable; 3.C.9.2.4).
*/
uint8_t disc_mode;
/** Minimum advertising interval, if 0 stack use sane defaults */
uint16_t itvl_min;
/** Maximum advertising interval, if 0 stack use sane defaults */
uint16_t itvl_max;
/** Advertising channel map , if 0 stack use sane defaults */
uint8_t channel_map;
/** Advertising Filter policy */
uint8_t filter_policy;
/** If do High Duty cycle for Directed Advertising */
uint8_t high_duty_cycle:1;
};
/** @brief Connection descriptor */
struct ble_gap_conn_desc {
/** Connection security state */
struct ble_gap_sec_state sec_state;
/** Local identity address */
ble_addr_t our_id_addr;
/** Peer identity address */
ble_addr_t peer_id_addr;
/** Local over-the-air address */
ble_addr_t our_ota_addr;
/** Peer over-the-air address */
ble_addr_t peer_ota_addr;
/** Connection handle */
uint16_t conn_handle;
/** Connection interval */
uint16_t conn_itvl;
/** Connection latency */
uint16_t conn_latency;
/** Connection supervision timeout */
uint16_t supervision_timeout;
/** Connection Role
* Possible values BLE_GAP_ROLE_SLAVE or BLE_GAP_ROLE_MASTER
*/
uint8_t role;
/** Master clock accuracy */
uint8_t master_clock_accuracy;
};
/** @brief Connection parameters */
struct ble_gap_conn_params {
/** Scan interval in 0.625ms units */
uint16_t scan_itvl;
/** Scan window in 0.625ms units */
uint16_t scan_window;
/** Minimum value for connection interval in 1.25ms units */
uint16_t itvl_min;
/** Maximum value for connection interval in 1.25ms units */
uint16_t itvl_max;
/** Connection latency */
uint16_t latency;
/** Supervision timeout in 10ms units */
uint16_t supervision_timeout;
/** Minimum length of connection event in 0.625ms units */
uint16_t min_ce_len;
/** Maximum length of connection event in 0.625ms units */
uint16_t max_ce_len;
};
/** @brief Extended discovery parameters */
struct ble_gap_ext_disc_params {
/** Scan interval in 0.625ms units */
uint16_t itvl;
/** Scan window in 0.625ms units */
uint16_t window;
/** If passive scan should be used */
uint8_t passive:1;
/** If observation procedure is to be disabled. By default all advertisement reports are accepted */
uint8_t disable_observer_mode:1;
};
/** @brief Discovery parameters */
struct ble_gap_disc_params {
/** Scan interval in 0.625ms units */
uint16_t itvl;
/** Scan window in 0.625ms units */
uint16_t window;
/** Scan filter policy */
uint8_t filter_policy;
/** If limited discovery procedure should be used */
uint8_t limited:1;
/** If passive scan should be used */
uint8_t passive:1;
/** If enable duplicates filtering */
uint8_t filter_duplicates:1;
/** If observation procedure is to be disabled. By default all advertisement reports are accepted */
uint8_t disable_observer_mode:1;
};
/** @brief Connection parameters update parameters */
struct ble_gap_upd_params {
/** Minimum value for connection interval in 1.25ms units */
uint16_t itvl_min;
/** Maximum value for connection interval in 1.25ms units */
uint16_t itvl_max;
/** Connection latency */
uint16_t latency;
/** Supervision timeout in 10ms units */
uint16_t supervision_timeout;
/** Minimum length of connection event in 0.625ms units */
uint16_t min_ce_len;
/** Maximum length of connection event in 0.625ms units */
uint16_t max_ce_len;
};
/** @brief Passkey query */
struct ble_gap_passkey_params {
/** Passkey action, can be one of following constants:
* - BLE_SM_IOACT_NONE
* - BLE_SM_IOACT_OOB
* - BLE_SM_IOACT_INPUT
* - BLE_SM_IOACT_DISP
* - BLE_SM_IOACT_NUMCMP
* - BLE_SM_IOACT_STATIC
*/
uint8_t action;
/** Passkey to compare, valid for BLE_SM_IOACT_NUMCMP action */
uint32_t numcmp;
};
#if MYNEWT_VAL(BLE_EXT_ADV)
#define BLE_GAP_EXT_ADV_DATA_STATUS_COMPLETE 0x00
#define BLE_GAP_EXT_ADV_DATA_STATUS_INCOMPLETE 0x01
#define BLE_GAP_EXT_ADV_DATA_STATUS_TRUNCATED 0x02
/** @brief Extended advertising report */
struct ble_gap_ext_disc_desc {
/** Report properties bitmask
* - BLE_HCI_ADV_CONN_MASK
* - BLE_HCI_ADV_SCAN_MASK
* - BLE_HCI_ADV_DIRECT_MASK
* - BLE_HCI_ADV_SCAN_RSP_MASK
* - BLE_HCI_ADV_LEGACY_MASK
* */
uint8_t props;
/** Advertising data status, can be one of following constants:
* - BLE_GAP_EXT_ADV_DATA_STATUS_COMPLETE
* - BLE_GAP_EXT_ADV_DATA_STATUS_INCOMPLETE
* - BLE_GAP_EXT_ADV_DATA_STATUS_TRUNCATED
*/
uint8_t data_status;
/** Legacy advertising PDU type. Valid if BLE_HCI_ADV_LEGACY_MASK props is
* set. Can be one of following constants:
* - BLE_HCI_ADV_RPT_EVTYPE_ADV_IND
* - BLE_HCI_ADV_RPT_EVTYPE_DIR_IND
* - BLE_HCI_ADV_RPT_EVTYPE_SCAN_IND
* - BLE_HCI_ADV_RPT_EVTYPE_NONCONN_IND
* - BLE_HCI_ADV_RPT_EVTYPE_SCAN_RSP
*/
uint8_t legacy_event_type;
/** Advertiser address */
ble_addr_t addr;
/** Received signal strength indication in dBm (127 if unavailable) */
int8_t rssi;
/** Advertiser transmit power in dBm (127 if unavailable) */
int8_t tx_power;
/** Advertising Set ID */
uint8_t sid;
/** Primary advertising PHY, can be one of following constants:
* - BLE_HCI_LE_PHY_1M
* - BLE_HCI_LE_PHY_CODED
*/
uint8_t prim_phy;
/** Secondary advertising PHY, can be one of following constants:
* - BLE_HCI_LE_PHY_1M
* - LE_HCI_LE_PHY_2M
* - BLE_HCI_LE_PHY_CODED
*/
uint8_t sec_phy;
/** Periodic advertising interval. 0 if no periodic advertising. */
uint16_t periodic_adv_itvl;
/** Advertising Data length */
uint8_t length_data;
/** Advertising data */
const uint8_t *data;
/** Directed advertising address. Valid if BLE_HCI_ADV_DIRECT_MASK props is
* set (BLE_ADDR_ANY otherwise).
*/
ble_addr_t direct_addr;
};
#endif
/** @brief Advertising report */
struct ble_gap_disc_desc {
/** Advertising PDU type. Can be one of following constants:
* - BLE_HCI_ADV_RPT_EVTYPE_ADV_IND
* - BLE_HCI_ADV_RPT_EVTYPE_DIR_IND
* - BLE_HCI_ADV_RPT_EVTYPE_SCAN_IND
* - BLE_HCI_ADV_RPT_EVTYPE_NONCONN_IND
* - BLE_HCI_ADV_RPT_EVTYPE_SCAN_RSP
*/
uint8_t event_type;
/** Advertising Data length */
uint8_t length_data;
/** Advertiser address */
ble_addr_t addr;
/** Received signal strength indication in dBm (127 if unavailable) */
int8_t rssi;
/** Advertising data */
const uint8_t *data;
/** Directed advertising address. Valid for BLE_HCI_ADV_RPT_EVTYPE_DIR_IND
* event type (BLE_ADDR_ANY otherwise).
*/
ble_addr_t direct_addr;
};
struct ble_gap_repeat_pairing {
/** The handle of the relevant connection. */
uint16_t conn_handle;
/** Properties of the existing bond. */
uint8_t cur_key_size;
uint8_t cur_authenticated:1;
uint8_t cur_sc:1;
/**
* Properties of the imminent secure link if the pairing procedure is
* allowed to continue.
*/
uint8_t new_key_size;
uint8_t new_authenticated:1;
uint8_t new_sc:1;
uint8_t new_bonding:1;
};
#define BLE_GAP_PER_ADV_DATA_STATUS_COMPLETE 0x00
#define BLE_GAP_PER_ADV_DATA_STATUS_INCOMPLETE 0x01
#define BLE_GAP_PER_ADV_DATA_STATUS_TRUNCATED 0x02
#define BLE_GAP_PER_ADV_DATA_STATUS_RX_FAILED 0xFF
#if MYNEWT_VAL(BLE_PERIODIC_ADV_WITH_RESPONSES)
struct ble_gap_periodic_adv_response {
/** The subevent in which the response is received */
uint8_t subevent;
/** Status of the subevent indication.
*
* 0 if subevent indication was transmitted.
* 1 if subevent indication was not transmitted.
* All other values RFU.
*/
/** The adv handle of the adv */
uint8_t adv_handle;
uint8_t tx_status;
/** The TX power of the response in dBm */
int8_t tx_power;
/** The RSSI of the response in dBm */
int8_t rssi;
/** The Constant Tone Extension (CTE) of the advertisement */
uint8_t cte_type;
/** The response slot */
uint8_t response_slot;
/** Data status */
uint8_t data_status;
/** Data length */
uint8_t data_length;
/** response data */
const uint8_t *data;
};
struct ble_gap_periodic_adv_response_params {
/** The periodic advertsing event for which response shall be sent in */
uint16_t request_event;
/** The request subevent for which response shall be sent in */
uint8_t request_subevent;
/** The subevent the response shall be sent in */
uint8_t response_subevent;
/** The response slot the response shall be sent in */
uint8_t response_slot;
};
#endif
/**
* Represents a GAP-related event. When such an event occurs, the host
* notifies the application by passing an instance of this structure to an
* application-specified callback.
*/
struct ble_gap_event {
/**
* Indicates the type of GAP event that occurred. This is one of the
* BLE_GAP_EVENT codes.
*/
uint8_t type;
/**
* A discriminated union containing additional details concerning the GAP
* event. The 'type' field indicates which member of the union is valid.
*/
union {
/**
* Represents a connection attempt. Valid for the following event
* types:
* o BLE_GAP_EVENT_CONNECT
*/
struct {
/**
* The status of the connection attempt;
* o 0: the connection was successfully established.
* o BLE host error code: the connection attempt failed for
* the specified reason.
*/
int status;
/** The handle of the relevant connection. */
uint16_t conn_handle;
#if MYNEWT_VAL(BLE_PERIODIC_ADV_WITH_RESPONSES)
/*
* Adv_Handle is used to identify an advertising set.
* If the connection is established from periodic advertising with responses
* and Role is 0x00 then the Advertising_Handle parameter shall be set
* according to the periodic advertising train the connection was established from
*/
uint8_t adv_handle;
/*
* Sync_Handle identifying the periodic advertising train
* If the connection is established from periodic advertising with responses
* and Role is 0x01, then the Sync_Handle parameter shall be set according
* to the periodic advertising train the connection was established from
*/
uint16_t sync_handle;
#endif
} connect;
/**
* Represents a successful Link establishment attempt. Sometimes, in noisy environment,
* even if BLE_GAP_EVENT_CONNECT is posted, the link syncronization procedure may fail
* and link gets disconnected with reason 0x3E. Application can wait for below event to ensure
* the link syncronization is completed. Valid for the following event
* types:
* o BLE_GAP_EVENT_LINK_ESTAB
*/
struct {
/**
* The final status of the link establishment;
* o 0: the connection was successfully established.
* o BLE host error code: the connection attempt failed for
* the specified reason.
*/
int status;
/** The handle of the relevant connection. */
uint16_t conn_handle;
#if MYNEWT_VAL(BLE_PERIODIC_ADV_WITH_RESPONSES)
/*
* Adv_Handle is used to identify an advertising set.
* If the connection is established from periodic advertising with responses
* and Role is 0x00 then the Advertising_Handle parameter shall be set
* according to the periodic advertising train the connection was established from
*/
uint8_t adv_handle;
/*
* Sync_Handle identifying the periodic advertising train
* If the connection is established from periodic advertising with responses
* and Role is 0x01, then the Sync_Handle parameter shall be set according
* to the periodic advertising train the connection was established from
*/
uint16_t sync_handle;
#endif
} link_estab;
/**
* Represents a terminated connection. Valid for the following event
* types:
* o BLE_GAP_EVENT_DISCONNECT
*/
struct {
/**
* A BLE host return code indicating the reason for the
* disconnect.
*/
int reason;
/** Information about the connection prior to termination. */
struct ble_gap_conn_desc conn;
} disconnect;
/**
* Represents an advertising report received during a discovery
* procedure. Valid for the following event types:
* o BLE_GAP_EVENT_DISC
*/
struct ble_gap_disc_desc disc;
#if MYNEWT_VAL(BLE_EXT_ADV)
/**
* Represents an extended advertising report received during a discovery
* procedure. Valid for the following event types:
* o BLE_GAP_EVENT_EXT_DISC
*/
struct ble_gap_ext_disc_desc ext_disc;
#endif
/**
* Represents a completed discovery procedure. Valid for the following
* event types:
* o BLE_GAP_EVENT_DISC_COMPLETE
*/
struct {
/**
* The reason the discovery procedure stopped. Typical reason
* codes are:
* o 0: Duration expired.
* o BLE_HS_EPREEMPTED: Host aborted procedure to configure a
* peer's identity.
*/
int reason;
} disc_complete;
/**
* Represents a completed advertise procedure. Valid for the following
* event types:
* o BLE_GAP_EVENT_ADV_COMPLETE
*/
struct {
/**
* The reason the advertise procedure stopped. Typical reason
* codes are:
* o 0: Terminated due to connection.
* o BLE_HS_ETIMEOUT: Duration expired.
* o BLE_HS_EPREEMPTED: Host aborted procedure to configure a
* peer's identity.
*/
int reason;
#if MYNEWT_VAL(BLE_EXT_ADV)
/** Advertising instance */
uint8_t instance;
/** The handle of the relevant connection - valid if reason=0 */
uint16_t conn_handle;
/**
* Number of completed extended advertising events
*
* This field is only valid if non-zero max_events was passed to
* ble_gap_ext_adv_start() and advertising completed due to duration
* timeout or max events transmitted.
* */
uint8_t num_ext_adv_events;
#endif
} adv_complete;
/**
* Represents an attempt to update a connection's parameters. If the
* attempt was successful, the connection's descriptor reflects the
* updated parameters.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_CONN_UPDATE
*/
struct {
/**
* The result of the connection update attempt;
* o 0: the connection was successfully updated.
* o BLE host error code: the connection update attempt failed
* for the specified reason.
*/
int status;
/** The handle of the relevant connection. */
uint16_t conn_handle;
} conn_update;
/**
* Represents a peer's request to update the connection parameters.
* This event is generated when a peer performs any of the following
* procedures:
* o L2CAP Connection Parameter Update Procedure
* o Link-Layer Connection Parameters Request Procedure
*
* To reject the request, return a non-zero HCI error code. The value
* returned is the reject reason given to the controller.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_L2CAP_UPDATE_REQ
* o BLE_GAP_EVENT_CONN_UPDATE_REQ
*/
struct {
/**
* Indicates the connection parameters that the peer would like to
* use.
*/
const struct ble_gap_upd_params *peer_params;
/**
* Indicates the connection parameters that the local device would
* like to use. The application callback should fill this in. By
* default, this struct contains the requested parameters (i.e.,
* it is a copy of 'peer_params').
*/
struct ble_gap_upd_params *self_params;
/** The handle of the relevant connection. */
uint16_t conn_handle;
} conn_update_req;
/**
* Represents a failed attempt to terminate an established connection.
* Valid for the following event types:
* o BLE_GAP_EVENT_TERM_FAILURE
*/
struct {
/**
* A BLE host return code indicating the reason for the failure.
*/
int status;
/** The handle of the relevant connection. */
uint16_t conn_handle;
} term_failure;
/**
* Represents an attempt to change the encrypted state of a
* connection. If the attempt was successful, the connection
* descriptor reflects the updated encrypted state.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_ENC_CHANGE
*/
struct {
/**
* Indicates the result of the encryption state change attempt;
* o 0: the encrypted state was successfully updated;
* o BLE host error code: the encryption state change attempt
* failed for the specified reason.
*/
int status;
/** The handle of the relevant connection. */
uint16_t conn_handle;
} enc_change;
/**
* Represents a passkey query needed to complete a pairing procedure.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_PASSKEY_ACTION
*/
struct {
/** Contains details about the passkey query. */
struct ble_gap_passkey_params params;
/** The handle of the relevant connection. */
uint16_t conn_handle;
} passkey;
#if MYNEWT_VAL(BLE_GATT_CACHING_ASSOC_ENABLE)
/**
* Represents an attempt to associate the cached attribute data of a peer
* device with the data already stored on the host. This is typically done
* after a connection is established to avoid full service discovery if
* valid cached data is available.
*
* If the association is successful, `cache_state` will be set to
* CACHE_LOADED, indicating that the cached attributes can be used.
* If the association fails, `cache_state` will be set to CACHE_INVALID,
* meaning the cache is unusable and full discovery may be required.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_CACHE_ASSOC
*/
struct {
/**
* Indicates the result of the cache association attempt;
* o 0: association successful;
* o BLE host error code: association failed for the specified reason.
*/
int status;
/** The handle of the relevant connection. */
uint16_t conn_handle;
/**
* Represents the state of the cache:
* o CACHE_LOADED : Cache successfully loaded
* o CACHE_INVALID : Cache invalid or unavailable
*/
uint8_t cache_state;
} cache_assoc;
#endif
/**
* Represents a received ATT notification or indication.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_NOTIFY_RX
*/
struct {
/**
* The contents of the notification or indication. If the
* application wishes to retain this mbuf for later use, it must
* set this pointer to NULL to prevent the stack from freeing it.
*/
struct os_mbuf *om;
/** The handle of the relevant ATT attribute. */
uint16_t attr_handle;
/** The handle of the relevant connection. */
uint16_t conn_handle;
/**
* Whether the received command is a notification or an
* indication;
* o 0: Notification;
* o 1: Indication.
*/
uint8_t indication:1;
} notify_rx;
/**
* Represents a transmitted ATT notification or indication, or a
* completed indication transaction.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_NOTIFY_TX
*/
struct {
/**
* The status of the notification or indication transaction;
* o 0: Command successfully sent;
* o BLE_HS_EDONE: Confirmation (indication ack) received;
* o BLE_HS_ETIMEOUT: Confirmation (indication ack) never
* received;
* o Other return code: Error.
*/
int status;
/** The handle of the relevant connection. */
uint16_t conn_handle;
/** The handle of the relevant characteristic value. */
uint16_t attr_handle;
/**
* Whether the transmitted command is a notification or an
* indication;
* o 0: Notification;
* o 1: Indication.
*/
uint8_t indication:1;
} notify_tx;
/**
* Represents a state change in a peer's subscription status. In this
* comment, the term "update" is used to refer to either a notification
* or an indication. This event is triggered by any of the following
* occurrences:
* o Peer enables or disables updates via a CCCD write.
* o Connection is about to be terminated and the peer is
* subscribed to updates.
* o Peer is now subscribed to updates after its state was restored
* from persistence. This happens when bonding is restored.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_SUBSCRIBE
*/
struct {
/** The handle of the relevant connection. */
uint16_t conn_handle;
/** The value handle of the relevant characteristic. */
uint16_t attr_handle;
/** One of the BLE_GAP_SUBSCRIBE_REASON codes. */
uint8_t reason;
/** Whether the peer was previously subscribed to notifications. */
uint8_t prev_notify:1;
/** Whether the peer is currently subscribed to notifications. */
uint8_t cur_notify:1;
/** Whether the peer was previously subscribed to indications. */
uint8_t prev_indicate:1;
/** Whether the peer is currently subscribed to indications. */
uint8_t cur_indicate:1;
} subscribe;
/**
* Represents a change in an L2CAP channel's MTU.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_MTU
*/
struct {
/** The handle of the relevant connection. */
uint16_t conn_handle;
/**
* Indicates the channel whose MTU has been updated; either
* BLE_L2CAP_CID_ATT or the ID of a connection-oriented channel.
*/
uint16_t channel_id;
/* The channel's new MTU. */
uint16_t value;
} mtu;
/**
* Represents a change in peer's identity. This is issued after
* successful pairing when Identity Address Information was received.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_IDENTITY_RESOLVED
*/
struct {
/** The handle of the relevant connection. */
uint16_t conn_handle;
/** Peer identity address */
ble_addr_t peer_id_addr;
} identity_resolved;
/**
* Represents a peer's attempt to pair despite a bond already existing.
* The application has two options for handling this event type:
* o Retry: Return BLE_GAP_REPEAT_PAIRING_RETRY after deleting the
* conflicting bond. The stack will verify the bond has
* been deleted and continue the pairing procedure. If
* the bond is still present, this event will be reported
* again.
* o Ignore: Return BLE_GAP_REPEAT_PAIRING_IGNORE. The stack will
* silently ignore the pairing request.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_REPEAT_PAIRING
*/
struct ble_gap_repeat_pairing repeat_pairing;
/**
* Represents a change of PHY. This is issue after successful
* change on PHY.
*/
struct {
int status;
uint16_t conn_handle;
/**
* Indicates enabled TX/RX PHY. Possible values:
* o BLE_GAP_LE_PHY_1M
* o BLE_GAP_LE_PHY_2M
* o BLE_GAP_LE_PHY_CODED
*/
uint8_t tx_phy;
uint8_t rx_phy;
} phy_updated;
#if MYNEWT_VAL(BLE_PERIODIC_ADV)
/**
* Represents a periodic advertising sync established during discovery
* procedure. Valid for the following event types:
* o BLE_GAP_EVENT_PERIODIC_SYNC
*/
struct {
/** BLE_ERR_SUCCESS on success or error code on failure. Other
* fields are valid only for success
*/
uint8_t status;
/** Periodic sync handle */
uint16_t sync_handle;
/** Advertising Set ID */
uint8_t sid;
/** Advertiser address */
ble_addr_t adv_addr;
/** Advertising PHY, can be one of following constants:
* - BLE_HCI_LE_PHY_1M
* - LE_HCI_LE_PHY_2M
* - BLE_HCI_LE_PHY_CODED
*/
uint8_t adv_phy;
/** Periodic advertising interval */
uint16_t per_adv_ival;
/** Advertiser clock accuracy */
uint8_t adv_clk_accuracy;
#if MYNEWT_VAL(BLE_PERIODIC_ADV_WITH_RESPONSES)
/** Number of subevents. If zero, the periodic advertiser will be a broadcaster,
* without responses.
*/
uint8_t num_subevents;
/** Interval between subevents (N * 1.25 ms) */
uint8_t subevent_interval;
/** Time between the advertising packet and the first response slot (N * 1.25 ms). */
uint8_t response_slot_delay;
/** Time between response slots (N * 0.125 ms) */
uint8_t response_slot_spacing;
#endif
} periodic_sync;
/**
* Represents a periodic advertising report received on established
* sync. Valid for the following event types:
* o BLE_GAP_EVENT_PERIODIC_REPORT
*/
struct {
/** Periodic sync handle */
uint16_t sync_handle;
/** Advertiser transmit power in dBm (127 if unavailable) */
int8_t tx_power;
/** Received signal strength indication in dBm (127 if unavailable) */
int8_t rssi;
#if MYNEWT_VAL(BLE_PERIODIC_ADV_WITH_RESPONSES)
/**
* It indicates the periodic advertising event counter (paEventCounter) of
* the event that the periodic advertising packet was received in.
*/
uint16_t event_counter;
/**
* It indicates Periodic Advertising with Responses subevent in which
* the periodic advertising packet was received in.
*/
uint8_t subevent;
#endif
/** Advertising data status, can be one of following constants:
* - BLE_HCI_PERIODIC_DATA_STATUS_COMPLETE
* - BLE_HCI_PERIODIC_DATA_STATUS_INCOMPLETE
* - BLE_HCI_PERIODIC_DATA_STATUS_TRUNCATED
* - BLE_HCI_PERIODIC_DATA_STATUS_RX_FAILED
*/
uint8_t data_status;
/** Advertising Data length */
uint8_t data_length;
/** Advertising data */
const uint8_t *data;
} periodic_report;
/**
* Represents a periodic advertising sync lost of established sync.
* Sync lost reason can be BLE_HS_ETIMEOUT (sync timeout) or
* BLE_HS_EDONE (sync terminated locally).
* Valid for the following event types:
* o BLE_GAP_EVENT_PERIODIC_SYNC_LOST
*/
struct {
/** Periodic sync handle */
uint16_t sync_handle;
/** Reason for sync lost, can be BLE_HS_ETIMEOUT for timeout or
* BLE_HS_EDONE for locally terminated sync
*/
int reason;
} periodic_sync_lost;
#endif
#if MYNEWT_VAL(BLE_EXT_ADV)
/**
* Represents a scan request for an extended advertising instance where
* scan request notifications were enabled.
* Valid for the following event types:
* o BLE_GAP_EVENT_SCAN_REQ_RCVD
*/
struct {
/** Extended advertising instance */
uint8_t instance;
/** Address of scanner */
ble_addr_t scan_addr;
} scan_req_rcvd;
#endif
#if MYNEWT_VAL(BLE_PERIODIC_ADV_SYNC_TRANSFER)
/**
* Represents a periodic advertising sync transfer received. Valid for
* the following event types:
* o BLE_GAP_EVENT_PERIODIC_TRANSFER
*/
struct {
/** BLE_ERR_SUCCESS on success or error code on failure. Sync handle
* is valid only for success.
*/
uint8_t status;
/** Periodic sync handle */
uint16_t sync_handle;
/** Connection handle */
uint16_t conn_handle;
/** Service Data */
uint16_t service_data;
/** Advertising Set ID */
uint8_t sid;
/** Advertiser address */
ble_addr_t adv_addr;
/** Advertising PHY, can be one of following constants:
* - BLE_HCI_LE_PHY_1M
* - LE_HCI_LE_PHY_2M
* - BLE_HCI_LE_PHY_CODED
*/
uint8_t adv_phy;
/** Periodic advertising interval */
uint16_t per_adv_itvl;
/** Advertiser clock accuracy */
uint8_t adv_clk_accuracy;
#if MYNEWT_VAL(BLE_PERIODIC_ADV_WITH_RESPONSES)
/** Number of subevents. If zero, the periodic advertiser will be a broadcaster,-
* without responses.
*/
uint8_t num_subevents;
/** Interval between subevents (N * 1.25 ms) */
uint8_t subevent_interval;
/** Time between the advertising packet and the first response slot (N * 1.25 ms). */
uint8_t response_slot_delay;
/** Time between response slots (N * 0.125 ms) */
uint8_t response_slot_spacing;
#endif
} periodic_transfer;
#endif
#if MYNEWT_VAL(BLE_PERIODIC_ADV_SYNC_BIGINFO_REPORTS) && !MYNEWT_VAL(BLE_ISO)
/**
* Represents a periodic advertising sync transfer received. Valid for
* the following event types:
* o BLE_GAP_EVENT_BIGINFO_REPORT
*/
struct {
/** Synchronization handle */
uint16_t sync_handle;
/** Number of present BISes */
uint8_t bis_cnt;
/** Number of SubEvents */
uint8_t nse;
/** ISO Interval */
uint16_t iso_interval;
/** Burst Number */
uint8_t bn;
/** Pre-Transmission Offset */
uint8_t pto;
/** Immediate Repetition Count */
uint8_t irc;
/** Maximum PDU size */
uint16_t max_pdu;
/** Maximum SDU size */
uint16_t max_sdu;
/** Service Data Unit Interval */
uint32_t sdu_interval;
/** BIG PHY */
uint8_t phy;
/** Framing of BIS Data PDUs */
uint8_t framing : 1;
/** Encryption */
uint8_t encryption : 1;
} biginfo_report;
#endif
#if MYNEWT_VAL(BLE_POWER_CONTROL)
/**
* Represents a change in either local transmit power or remote transmit
* power. Valid for the following event types:
* o BLE_GAP_EVENT_PATHLOSS_THRESHOLD
*/
struct {
/** Connection handle */
uint16_t conn_handle;
/** Current Path Loss */
uint8_t current_path_loss;
/** Entered Zone */
uint8_t zone_entered;
} pathloss_threshold;
/**
* Represents crossing of path loss threshold set via LE Set Path Loss
* Reporting Parameter command. Valid for the following event types:
* o BLE_GAP_EVENT_TRANSMIT_POWER
*/
struct {
/** BLE_ERR_SUCCESS on success or error code on failure */
uint8_t status;
/** Connection Handle */
uint16_t conn_handle;
/** Reason indicating why event was sent */
uint8_t reason;
/** Advertising PHY */
uint8_t phy;
/** Transmit power Level */
int8_t transmit_power_level;
/** Transmit Power Level Flag */
uint8_t transmit_power_level_flag;
/** Delta indicating change in transmit Power Level */
int8_t delta;
} transmit_power;
#endif
/**
* Represents a received Pairing Complete message
*
* Valid for the following event types:
* o BLE_GAP_EVENT_PARING_COMPLETE
*/
struct {
/**
* Indicates the result of the encryption state change attempt;
* o 0: the encrypted state was successfully updated;
* o BLE host error code: the encryption state change attempt
* failed for the specified reason.
*/
int status;
/** The handle of the relevant connection. */
uint16_t conn_handle;
} pairing_complete;
#if MYNEWT_VAL(BLE_CONN_SUBRATING)
/**
* Represents a subrate change event that indicates connection subrate update procedure
* has completed and some parameters have changed Valid for
* the following event types:
* o BLE_GAP_EVENT_SUBRATE_CHANGE
*/
struct {
/** BLE_ERR_SUCCESS on success or error code on failure */
uint8_t status;
/** Connection Handle */
uint16_t conn_handle;
/** Subrate Factor */
uint16_t subrate_factor;
/** Peripheral Latency */
uint16_t periph_latency;
/** Continuation Number */
uint16_t cont_num;
/** Supervision Timeout */
uint16_t supervision_tmo;
} subrate_change;
#endif
#if MYNEWT_VAL(BLE_PERIODIC_ADV_WITH_RESPONSES)
/**
* Represents a periodic advertising subevent data request
* with parameters valid for the following event types:
* o BLE_GAP_EVENT_PER_SUBEV_DATA_REQ
*/
struct {
/** Advertising handle */
uint8_t adv_handle;
/** Subevent start */
uint8_t subevent_start;
/** Number of subevents */
uint8_t subevent_data_count;
} periodic_adv_subev_data_req;
/**
* Represents a periodic advertising response
* with parameters valid for the following event types:
* o BLE_GAP_EVENT_PER_SUBEV_RESP
*/
struct ble_gap_periodic_adv_response periodic_adv_response;
#endif
#if MYNEWT_VAL(BLE_HCI_VS)
/**
* Represents a received vendor-specific HCI event
*
* Valid for the following event types:
* o BLE_GAP_EVENT_VS_HCI
*/
struct {
const void *ev;
uint8_t length;
} vs_hci;
#endif
/**
* GATT Authorization Event. Ask the user to authorize a GATT
* read/write operation.
*
* Valid for the following event types:
* o BLE_GAP_EVENT_AUTHORIZE
*
* Valid responses from user:
* o BLE_GAP_AUTHORIZE_ACCEPT
* o BLE_GAP_AUTHORIZE_REJECT
*/
struct {
/* Connection Handle */
uint16_t conn_handle;
/* Attribute handle of the attribute being accessed. */
uint16_t attr_handle;
/* Weather the operation is a read or write operation. */
int is_read;
/* User's response */
int out_response;
} authorize;
#if MYNEWT_VAL(BLE_EATT_CHAN_NUM) > 0
/**
* EATT Event
*
* Valid for the following event types:
* o BLE_GAP_EVENT_EATT
*
*/
struct {
/* Connection Handle */
uint16_t conn_handle;
/** Connected Status
*
* EATT Connected: 0
* EATT Disconnected: 1
*/
uint8_t status;
/* CID of the bearer */
uint16_t cid;
} eatt;
#endif
#if MYNEWT_VAL(BLE_ENABLE_CONN_REATTEMPT)
/**
* Represents a event mentioning connection reattempt
* count
*
* Valid for the following event types:
* o BLE_GAP_EVENT_REATTEMPT_COUNT
*/
struct {
/* Connection handle */
uint16_t conn_handle;
/* Reattempt connection attempt count */
uint8_t count;
} reattempt_cnt;
#endif
/**
* Represent a event for DTM test results
*
* Valid for the following event types:
* o BLE_GAP_EVENT_TEST_UPDATE
*/
struct {
/* Indicate DTM operation status */
uint8_t status;
/* DTM state change event. Can be following constants:
* o BLE_GAP_DTM_TX_START_EVT
* o BLE_GAP_DTM_RX_START_EVT
* o BLE_GAP_DTM_END_EVT
*/
uint8_t update_evt;
/* Number of packets received.
*
* Valid only for BLE_GAP_DTM_END_EVT
* shall be 0 for a transmitter.
*/
uint16_t num_pkt;
} dtm_state;
/**
* Represent an event for LE Data length change
*
* Valid for the following event types:
* o BLE_GAP_EVENT_DATA_LEN_CHG
*/
struct {
/* Connection handle */
uint16_t conn_handle;
/* Max Tx Payload octotes */
uint16_t max_tx_octets;
/* Max Tx Time */
uint16_t max_tx_time;
/* Max Rx payload octet */
uint16_t max_rx_octets;
/* Max Rx Time */
uint16_t max_rx_time;
} data_len_chg;
#if MYNEWT_VAL(BLE_AOA_AOD)
/**
* Represents a AOA/AOD connectionless iq report event
* Valid for the following event types:
* o BLE_GAP_EVENT_CONNLESS_IQ_RPT
*/
struct {
/** Sync_Handle identifying the periodic advertising train.
* Range: 0x0000 to 0x0EFF
* 0x0FFF indicates Receiver Test mode.
*/
uint16_t sync_handle;
/** The index of the channel on which the packet was received.
* Range: 0x00 to 0x27
* Note: 0x25 to 0x27 can be used only for packets generated during test modes.
*/
uint8_t channel_index;
/** RSSI of the packet.
* Range: -1270 to +200 (Units: 0.1 dBm).
*/
int16_t rssi;
/** Antenna ID used for receiving the packet. */
uint8_t rssi_antenna_id;
/** Type of Constant Tone Extension (CTE).
* 0x00: AoA Constant Tone Extension
* 0x01: AoD Constant Tone Extension with 1 μs slots
* 0x02: AoD Constant Tone Extension with 2 μs slots
*/
uint8_t cte_type;
/** Switching and sampling slot durations.
* 0x01: Switching and sampling slots are 1 μs each
* 0x02: Switching and sampling slots are 2 μs each
*/
uint8_t slot_durations;
/** Status of the packet.
* 0x00: CRC was correct
* 0x01: CRC was incorrect, but Length and CTETime fields were used to determine sampling points
* 0x02: CRC was incorrect, but the Controller determined the position and length of the CTE in another way
* 0xFF: Insufficient resources to sample (Channel_Index, CTE_Type, and Slot_Durations invalid)
*/
uint8_t packet_status;
/** Value of paEventCounter for the reported AUX_SYNC_IND PDU. */
uint16_t periodic_event_counter;
/** Total number of sample pairs (I and Q samples).
* 0x00: No samples provided (only permitted if Packet_Status is 0xFF)
* 0x09 to 0x52: Total number of sample pairs
*/
uint8_t sample_count;
/** Array of I samples for the reported packet (signed integers).
* Each value represents an I sample at a specific sampling point.
* 0x80 indicates no valid sample available.
*/
int8_t *i_samples;
/** Array of Q samples for the reported packet (signed integers).
* Each value represents a Q sample at a specific sampling point.
* 0x80 indicates no valid sample available.
*/
int8_t *q_samples;
} connless_iq_report;
/**
* Represents a connection iq report.
* Valid for the following event types:
* o BLE_GAP_EVENT_CONN_IQ_RPT
*/
struct {
/** Connection handle identifying the connection. */
uint16_t conn_handle;
/** PHY used for receiving the packet.
* 0x01: LE 1M PHY
* 0x02: LE 2M PHY
*/
uint8_t rx_phy;
/** The index of the data channel on which the packet was received. */
uint8_t data_channel_index;
/** RSSI of the packet.
* Range: -1270 to +200 (Units: 0.1 dBm).
*/
int16_t rssi;
/** Antenna ID used for receiving the packet. */
uint8_t rssi_antenna_id;
/** Type of Constant Tone Extension (CTE).
* 0x00: AoA Constant Tone Extension
* 0x01: AoD Constant Tone Extension with 1 μs slots
* 0x02: AoD Constant Tone Extension with 2 μs slots
*/
uint8_t cte_type;
/** Switching and sampling slot durations.
* 0x01: Switching and sampling slots are 1 μs each
* 0x02: Switching and sampling slots are 2 μs each
*/
uint8_t slot_durations;
/** Status of the packet.
* 0x00: CRC was correct
* 0x01: CRC was incorrect, but Length and CTETime fields were used to determine sampling points
* 0x02: CRC was incorrect, but the Controller determined the position and length of the CTE in another way
* 0xFF: Insufficient resources to sample (Channel_Index, CTE_Type, and Slot_Durations invalid)
*/
uint8_t packet_status;
/** Value of the connection event counter for the reported packet. */
uint16_t conn_event_counter;
/** Total number of sample pairs (I and Q samples).
* 0x00: No samples provided (only permitted if Packet_Status is 0xFF)
* 0x09 to 0x52: Total number of sample pairs
*/
uint8_t sample_count;
/** Array of I samples for the reported packet (signed integers).
* Each value represents an I sample at a specific sampling point.
* 0x80 indicates no valid sample available.
*/
int8_t *i_samples;
/** Array of Q samples for the reported packet (signed integers).
* Each value represents a Q sample at a specific sampling point.
* 0x80 indicates no valid sample available.
*/
int8_t *q_samples;
} conn_iq_report;
/**
* Represents a cte req failed event
* Valid for the following event types:
* o BLE_GAP_EVENT_CTE_REQ_FAILED
*/
struct {
/** Status indicating the reason for failure.
* Refer to HCI error codes for detailed status values.
*/
uint8_t status;
/** Connection handle identifying the connection. */
uint16_t conn_handle;
} cte_req_fail;
#endif
#if MYNEWT_VAL(BLE_ISO)
struct {
/** BLE_ERR_SUCCESS on success or error code on failure */
uint8_t status;
/** Connection handle of the CIS */
uint16_t cis_handle;
/** The maximum time, in microseconds, for transmission of PDUs
* of all CISes in a CIG event.
*/
uint32_t cig_sync_delay;
/** The maximum time, in microseconds, for transmission of PDUs
* of the specified CIS in a CIG event.
*/
uint32_t cis_sync_delay;
/** The actual transport latency, in microseconds, from Central to Peripheral */
uint32_t transport_latency_c_to_p;
/** The actual transport latency, in microseconds, from Peripheral to Central */
uint32_t transport_latency_p_to_c;
/** TX PHY (Central to Peripheral) */
uint8_t phy_c_to_p;
/** TX PHY (Peripheral to Central) */
uint8_t phy_p_to_c;
/** Maximum number of subevents in each CIS event */
uint8_t nse;
/** The burst number for Central to Peripheral transmission */
uint8_t bn_c_to_p;
/** The burst number for Peripheral to Central transmission */
uint8_t bn_p_to_c;
/** The flush timeout, in multiple of the ISO_Interval for the CIS,
* for each payload sent from Central to Peripheral.
*/
uint8_t ft_c_to_p;
/** The flush timeout, in multiple of the ISO_Interval for the CIS,
* for each payload sent from Peripheral to Central.
*/
uint8_t ft_p_to_c;
/** Maximum size, in octets, of the payload from Central to Peripheral */
uint16_t max_pdu_c_to_p;
/** Maximum size, in octets, of the payload from Peripheral to Central */
uint16_t max_pdu_p_to_c;
/** The time between two consecutive CIS anchor points (unit 1.25ms) */
uint16_t iso_interval;
} cis_estab;
struct {
/** Connection handle of the ACL */
uint16_t conn_handle;
/** Connection handle of the CIS */
uint16_t cis_handle;
/** Identifier of the CIG */
uint8_t cig_id;
/** Identifier of the CIS */
uint8_t cis_id;
} cis_request;
struct {
/** BLE_ERR_SUCCESS on success or error code on failure */
uint8_t status;
/** Identifier of the BIG */
uint8_t big_handle;
/** The maximum time, in microseconds, for transmission of PDUs
* of all BISes in a BIG event.
*/
uint32_t big_sync_delay;
/** The actual transport latency, in microseconds */
uint32_t transport_latency;
/** PHY used to create the BIG */
uint8_t phy;
/** The number of subevents in each BIS event in the BIG */
uint8_t nse;
/** The number of new payloads in each BIS event */
uint8_t bn;
/** Offset used for pre-transmissions */
uint8_t pto;
/** The number of times a payload is transmitted in a BIS event */
uint8_t irc;
/** Maximum size, in octets, of the payload */
uint16_t max_pdu;
/** The time between two consecutive BIG anchor points (unit 1.25ms) */
uint16_t iso_interval;
/** Total number of BISes in the BIG */
uint8_t bis_cnt;
/** Connection handles of the BISes */
uint16_t bis_handle[MYNEWT_VAL(BLE_ISO_BIS_PER_BIG)];
} create_big_comp;
struct {
/** Identifier of the BIG */
uint8_t big_handle;
/** Reason for termination */
uint8_t reason;
} term_big_comp;
struct {
/** BLE_ERR_SUCCESS on success or error code on failure */
uint8_t status;
/** Identifier of the BIG */
uint8_t big_handle;
/** The actual transport latency, in microseconds */
uint32_t transport_latency;
/** The number of subevents in each BIS event in the BIG */
uint8_t nse;
/** The number of new payloads in each BIS event */
uint8_t bn;
/** Offset used for pre-transmissions */
uint8_t pto;
/** The number of times a payload is transmitted in a BIS event */
uint8_t irc;
/** Maximum size, in octets, of the payload */
uint16_t max_pdu;
/** The time between two consecutive BIG anchor points (unit 1.25ms) */
uint16_t iso_interval;
/** Total number of BISes in the BIG */
uint8_t bis_cnt;
/** Connection handles of the BISes */
uint16_t bis_handle[MYNEWT_VAL(BLE_ISO_BIS_PER_BIG)];
} big_sync_estab;
struct {
/** Identifier of the BIG */
uint8_t big_handle;
/** Reason for termination */
uint8_t reason;
} big_sync_lost;
struct {
/** Sync_Handle identifying the periodic advertising train */
uint16_t sync_handle;
/** Total number of BISes in the BIG */
uint8_t bis_cnt;
/** The number of subevents in each BIS event in the BIG */
uint8_t nse;
/** The time between two consecutive BIG anchor points (unit 1.25ms) */
uint16_t iso_interval;
/** The number of new payloads in each BIS event */
uint8_t bn;
/** Offset used for pre-transmissions */
uint8_t pto;
/** The number of times a payload is transmitted in a BIS event */
uint8_t irc;
/** Maximum size, in octets, of the payload */
uint16_t max_pdu;
/** Time, in microseconds, between the start of consecutive SDUs */
uint32_t sdu_interval;
/** Maximum size of an SDU, in octets */
uint16_t max_sdu;
/** PHY used by the BIG */
uint8_t phy;
/** Unframed or framed PDUs */
uint8_t framing;
/** BIG encryption */
uint8_t encryption;
} biginfo_report;
#if MYNEWT_VAL(BLE_ISO_CIS_ESTAB_V2)
struct {
/** BLE_ERR_SUCCESS on success or error code on failure */
uint8_t status;
/** Connection handle of the CIS */
uint16_t cis_handle;
/** The maximum time, in microseconds, for transmission of PDUs
* of all CISes in a CIG event.
*/
uint32_t cig_sync_delay;
/** The maximum time, in microseconds, for transmission of PDUs
* of the specified CIS in a CIG event.
*/
uint32_t cis_sync_delay;
/** The actual transport latency, in microseconds, from Central to Peripheral */
uint32_t transport_latency_c_to_p;
/** The actual transport latency, in microseconds, from Peripheral to Central */
uint32_t transport_latency_p_to_c;
/** TX PHY (Central to Peripheral) */
uint8_t phy_c_to_p;
/** TX PHY (Peripheral to Central) */
uint8_t phy_p_to_c;
/** Maximum number of subevents in each CIS event */
uint8_t nse;
/** The burst number for Central to Peripheral transmission */
uint8_t bn_c_to_p;
/** The burst number for Peripheral to Central transmission */
uint8_t bn_p_to_c;
/** The flush timeout, in multiple of the ISO_Interval for the CIS,
* for each payload sent from Central to Peripheral.
*/
uint8_t ft_c_to_p;
/** The flush timeout, in multiple of the ISO_Interval for the CIS,
* for each payload sent from Peripheral to Central.
*/
uint8_t ft_p_to_c;
/** Maximum size, in octets, of the payload from Central to Peripheral */
uint16_t max_pdu_c_to_p;
/** Maximum size, in octets, of the payload from Peripheral to Central */
uint16_t max_pdu_p_to_c;
/** The time between two consecutive CIS anchor points (unit 1.25ms) */
uint16_t iso_interval;
/** Time, in microseconds, between the start of consecutive subevents in a CIS event */
uint32_t sub_interval;
/** Maximum size, in octets, of the payload from Central's Host */
uint16_t max_sdu_c_to_p;
/** Maximum size, in octets, of the payload from Peripheral's Host */
uint16_t max_sdu_p_to_c;
/** Time, in microseconds, between the start of consecutive SDUs sent by Central */
uint32_t sdu_interval_c_to_p;
/** Time, in microseconds, between the start of consecutive SDUs sent by Peripheral */
uint32_t sdu_interval_p_to_c;
/** Unframed or framed PDUs */
uint8_t framing;
} cis_estab_v2;
#endif /* MYNEWT_VAL(BLE_ISO_CIS_ESTAB_V2) */
#endif /* MYNEWT_VAL(BLE_ISO) */
/**
* Represents a read all remote features complete event
* Valid for the following event types:
* o BLE_GAP_EVENT_RD_ALL_REM_FEAT
*/
struct {
/** Status indicating the reason for failure.
* Refer to HCI error codes for detailed status values.
*/
uint8_t status;
/** Connection handle identifying the connection. */
uint16_t conn_handle;
/** Highest numbered page of remote device's supported LE features
* that contains atleast one bit set to 1
*/
uint8_t max_remote_page;
/** Number of highest numbered page of LE features that contains
* valid data
*/
uint8_t max_valid_page;
/** Bit Mask List of LE features */
uint8_t le_features[248];
} rd_all_rem_feat;
#if MYNEWT_VAL(BLE_MONITOR_ADV)
/**
* Represents a monitor advertising report event
* Valid for the following event types:
* o BLE_GAP_EVENT_MONITOR_ADV_REPORT
*/
struct {
/** Address Type [Public/Random...] */
uint8_t addr_type;
/** Device Address */
uint8_t address[6];
/** Represents whether RSSI threshold condition is met */
uint8_t condition;
} monitor_adv_report;
#endif
};
};
#if MYNEWT_VAL(OPTIMIZE_MULTI_CONN)
/** @brief multiple Connection parameters */
struct ble_gap_multi_conn_params {
/** The type of address the stack should use for itself. */
uint8_t own_addr_type;
#if MYNEWT_VAL(BLE_EXT_ADV)
/** Define on which PHYs connection attempt should be done */
uint8_t phy_mask;
#endif // MYNEWT_VAL(BLE_EXT_ADV)
/** The address of the peer to connect to. */
const ble_addr_t *peer_addr;
/** The duration of the discovery procedure. */
int32_t duration_ms;
/**
* Additional arguments specifying the particulars of the connect procedure. When extended
* adv is disabled or BLE_GAP_LE_PHY_1M_MASK is set in phy_mask this parameter can't be
* specified to null.
*/
const struct ble_gap_conn_params *phy_1m_conn_params;
#if MYNEWT_VAL(BLE_EXT_ADV)
/**
* Additional arguments specifying the particulars of the connect procedure. When
* BLE_GAP_LE_PHY_2M_MASK is set in phy_mask this parameter can't be specified to null.
*/
const struct ble_gap_conn_params *phy_2m_conn_params;
/**
* Additional arguments specifying the particulars of the connect procedure. When
* BLE_GAP_LE_PHY_CODED_MASK is set in phy_mask this parameter can't be specified to null.
*/
const struct ble_gap_conn_params *phy_coded_conn_params;
#endif // MYNEWT_VAL(BLE_EXT_ADV)
/**
* The minimum length occupied by this connection in scheduler. 0 means disable the
* optimization for this connection.
*/
uint32_t scheduling_len_us;
};
#endif // MYNEWT_VAL(OPTIMIZE_MULTI_CONN)
typedef int ble_gap_event_fn(struct ble_gap_event *event, void *arg);
typedef int ble_gap_conn_foreach_handle_fn(uint16_t conn_handle, void *arg);
#define BLE_GAP_CONN_MODE_NON 0
#define BLE_GAP_CONN_MODE_DIR 1
#define BLE_GAP_CONN_MODE_UND 2
#define BLE_GAP_DISC_MODE_NON 0
#define BLE_GAP_DISC_MODE_LTD 1
#define BLE_GAP_DISC_MODE_GEN 2
/**
* Searches for a connection with the specified handle. If a matching
* connection is found, the supplied connection descriptor is filled
* correspondingly.
*
* @param handle The connection handle to search for.
* @param out_desc On success, this is populated with information relating to
* the matching connection. Pass NULL if you don't need this
* information.
*
* @return 0 on success, BLE_HS_ENOTCONN if no matching connection was
* found.
*/
int ble_gap_conn_find(uint16_t handle, struct ble_gap_conn_desc *out_desc);
/**
* Searches for a connection with a peer with the specified address.
* If a matching connection is found, the supplied connection descriptor
* is filled correspondingly.
*
* @param addr The ble address of a connected peer device to search for.
* @param out_desc On success, this is populated with information relating to
* the matching connection. Pass NULL if you don't need this
* information.
*
* @return 0 on success, BLE_HS_ENOTCONN if no matching connection was
* found.
*/
int ble_gap_conn_find_by_addr(const ble_addr_t *addr,
struct ble_gap_conn_desc *out_desc);
/**
* Configures a connection to use the specified GAP event callback. A
* connection's GAP event callback is first specified when the connection is
* created, either via advertising or initiation. This function replaces the
* callback that was last configured.
*
* @param conn_handle The handle of the connection to configure.
* @param cb The callback to associate with the connection.
* @param cb_arg An optional argument that the callback receives.
*
* @return 0 on success, BLE_HS_ENOTCONN if there is no connection
* with the specified handle.
*/
int ble_gap_set_event_cb(uint16_t conn_handle,
ble_gap_event_fn *cb, void *cb_arg);
/** @brief Start advertising
*
* This function configures and start advertising procedure.
*
* @param own_addr_type The type of address the stack should use for itself.
* Valid values are:
* - BLE_OWN_ADDR_PUBLIC
* - BLE_OWN_ADDR_RANDOM
* - BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT
* - BLE_OWN_ADDR_RPA_RANDOM_DEFAULT
* @param direct_addr The peer's address for directed advertising. This
* parameter shall be non-NULL if directed advertising is
* being used.
* @param duration_ms The duration of the advertisement procedure. On
* expiration, the procedure ends and a
* BLE_GAP_EVENT_ADV_COMPLETE event is reported. Units are
* milliseconds. Specify BLE_HS_FOREVER for no expiration.
* @param adv_params Additional arguments specifying the particulars of the
* advertising procedure.
* @param cb The callback to associate with this advertising
* procedure. If advertising ends, the event is reported
* through this callback. If advertising results in a
* connection, the connection inherits this callback as its
* event-reporting mechanism.
* @param cb_arg The optional argument to pass to the callback function.
*
* @return 0 on success, error code on failure.
*/
int ble_gap_adv_start(uint8_t own_addr_type, const ble_addr_t *direct_addr,
int32_t duration_ms,
const struct ble_gap_adv_params *adv_params,
ble_gap_event_fn *cb, void *cb_arg);
/**
* Stops the currently-active advertising procedure. A success return
* code indicates that advertising has been fully aborted and a new advertising
* procedure can be initiated immediately.
*
* NOTE: If the caller is running in the same task as the NimBLE host, or if it
* is running in a higher priority task than that of the host, care must be
* taken when restarting advertising. Under these conditions, the following is
* *not* a reliable method to restart advertising:
* ble_gap_adv_stop()
* ble_gap_adv_start()
*
* Instead, the call to `ble_gap_adv_start()` must be made in a separate event
* context. That is, `ble_gap_adv_start()` must be called asynchronously by
* enqueueing an event on the current task's event queue. See
* https://github.com/apache/mynewt-nimble/pull/211 for more information.
*
* @return 0 on success, BLE_HS_EALREADY if there is no active advertising
* procedure, other error code on failure.
*/
int ble_gap_adv_stop(void);
/**
* Indicates whether an advertisement procedure is currently in progress.
*
* @return 0 if no advertisement procedure in progress, 1 otherwise.
*/
int ble_gap_adv_active(void);
/**
* Configures the data to include in subsequent advertisements.
*
* @param data Buffer containing the advertising data.
* @param data_len The size of the advertising data, in bytes.
*
* @return 0 on succes, BLE_HS_EBUSY if advertising is in progress,
* other error code on failure.
*/
int ble_gap_adv_set_data(const uint8_t *data, int data_len);
/**
* Configures the data to include in subsequent scan responses.
*
* @param data Buffer containing the scan response data.
* @param data_len The size of the response data, in bytes.
*
* @return 0 on succes, BLE_HS_EBUSY if advertising is in progress,
* other error code on failure.
*/
int ble_gap_adv_rsp_set_data(const uint8_t *data, int data_len);
/**
* Configures the fields to include in subsequent advertisements. This is a
* convenience wrapper for ble_gap_adv_set_data().
*
* @param adv_fields Specifies the advertisement data.
*
* @return 0 on success,
* BLE_HS_EBUSY if advertising is in progress,
* BLE_HS_EMSGSIZE if the specified data is too large to
* fit in an advertisement,
* other error code on failure.
*/
int ble_gap_adv_set_fields(const struct ble_hs_adv_fields *rsp_fields);
/**
* Configures the fields to include in subsequent scan responses. This is a
* convenience wrapper for ble_gap_adv_rsp_set_data().
*
* @param adv_fields Specifies the scan response data.
*
* @return 0 on success,
* BLE_HS_EBUSY if advertising is in progress,
* BLE_HS_EMSGSIZE if the specified data is too large to
* fit in a scan response,
* other error code on failure.
*/
int ble_gap_adv_rsp_set_fields(const struct ble_hs_adv_fields *rsp_fields);
#if MYNEWT_VAL(ENC_ADV_DATA)
/**
* @brief Bluetooth data serialized size.
*
* Get the size of a serialized @ref bt_data given its data length.
*
* Size of 'AD Structure'->'Length' field, equal to 1.
* Size of 'AD Structure'->'Data'->'AD Type' field, equal to 1.
* Size of 'AD Structure'->'Data'->'AD Data' field, equal to data_len.
*
* See Core Specification Version 5.4 Vol. 3 Part C, 11, Figure 11.1.
*/
#define BLE_GAP_DATA_SERIALIZED_SIZE(data_len) ((data_len) + 2)
#define BLE_GAP_ENC_ADV_DATA 0x31
struct enc_adv_data {
uint8_t len;
uint8_t type;
uint8_t *data;
};
/**
* @brief Helper to declare elements of enc_adv_data arrays
*
* This macro is mainly for creating an array of struct enc_adv_data
* elements which is then passed to e.g. @ref ble_gap_adv_start().
*
* @param _type Type of advertising data field
* @param _data Pointer to the data field payload
* @param _data_len Number of bytes behind the _data pointer
*/
#define ENC_ADV_DATA(_type, _data, _data_len) \
{ \
.type = (_type), \
.len = (_data_len), \
.data = (uint8_t *)(_data), \
}
#endif
#if MYNEWT_VAL(BLE_EXT_ADV)
/** @brief Extended advertising parameters */
struct ble_gap_ext_adv_params {
/** If perform connectable advertising */
unsigned int connectable:1;
/** If perform scannable advertising */
unsigned int scannable:1;
/** If perform directed advertising */
unsigned int directed:1;
/** If perform high-duty directed advertising */
unsigned int high_duty_directed:1;
/** If use legacy PDUs for advertising.
*
* Valid combinations of the connectable, scannable, directed,
* high_duty_directed options with the legcy_pdu flag are:
* - IND -> legacy_pdu + connectable + scannable
* - LD_DIR -> legacy_pdu + connectable + directed
* - HD_DIR -> legacy_pdu + connectable + directed + high_duty_directed
* - SCAN -> legacy_pdu + scannable
* - NONCONN -> legacy_pdu
*
* Any other combination of these options combined with the legacy_pdu flag
* are invalid.
*/
unsigned int legacy_pdu:1;
/** If perform anonymous advertising */
unsigned int anonymous:1;
/** If include TX power in advertising PDU */
unsigned int include_tx_power:1;
/** If enable scan request notification */
unsigned int scan_req_notif:1;
/** Minimum advertising interval in 0.625ms units, if 0 stack use sane
* defaults
*/
uint32_t itvl_min;
/** Maximum advertising interval in 0.625ms units, if 0 stack use sane
* defaults
*/
uint32_t itvl_max;
/** Advertising channel map , if 0 stack use sane defaults */
uint8_t channel_map;
/** Own address type to be used by advertising instance */
uint8_t own_addr_type;
/** Peer address for directed advertising, valid only if directed is set */
ble_addr_t peer;
/** Advertising Filter policy */
uint8_t filter_policy;
/** Primary advertising PHY to use , can be one of following constants:
* - BLE_HCI_LE_PHY_1M
* - BLE_HCI_LE_PHY_CODED
*/
uint8_t primary_phy;
/** Secondary advertising PHY to use, can be one of following constants:
* - BLE_HCI_LE_PHY_1M
* - LE_HCI_LE_PHY_2M
* - BLE_HCI_LE_PHY_CODED
*/
uint8_t secondary_phy;
/** Preferred advertiser transmit power */
int8_t tx_power;
/** Advertising Set ID */
uint8_t sid;
#if MYNEWT_VAL(BLE_EXT_ADV_V2)
/** Primary PHY options */
uint8_t primary_phy_opt;
/** Secondary PHY options */
uint8_t secondary_phy_opt;
#endif
};
/**
* Configure extended advertising instance
*
* @param instance Instance ID
* @param params Additional arguments specifying the particulars
* of the advertising.
* @param selected_tx_power Selected advertising transmit power will be
* stored in that param if non-NULL.
* @param cb The callback to associate with this advertising
* procedure. Advertising complete event is reported
* through this callback
* @param cb_arg The optional argument to pass to the callback
* function.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_ext_adv_configure(uint8_t instance,
const struct ble_gap_ext_adv_params *params,
int8_t *selected_tx_power,
ble_gap_event_fn *cb, void *cb_arg);
/**
* Set random address for configured advertising instance.
*
* @param instance Instance ID
* @param addr Random address to be set
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_ext_adv_set_addr(uint8_t instance, const ble_addr_t *addr);
/**
* Start advertising instance.
*
* @param instance Instance ID
* @param duration The duration of the advertisement procedure. On
* expiration, the procedure ends and
* a BLE_GAP_EVENT_ADV_COMPLETE event is reported.
* Units are 10 milliseconds. Specify 0 for no
* expiration.
* @params max_events Number of advertising events that should be sent
* before advertising ends and
* a BLE_GAP_EVENT_ADV_COMPLETE event is reported.
* Specify 0 for no limit.
*
* @return 0 on success, error code on failure.
*/
int ble_gap_ext_adv_start(uint8_t instance, int duration, int max_events);
/**
* Stops advertising procedure for specified instance.
*
* @param instance Instance ID
*
* @return 0 on success, BLE_HS_EALREADY if there is no active advertising
* procedure for instance, other error code on failure.
*/
int ble_gap_ext_adv_stop(uint8_t instance);
/**
* Configures the data to include in advertisements packets for specified
* advertising instance.
*
* @param instance Instance ID
* @param data Chain containing the advertising data.
*
* @return 0 on success or error code on failure.
*/
int ble_gap_ext_adv_set_data(uint8_t instance, struct os_mbuf *data);
/**
* Configures the data to include in subsequent scan responses for specified
* advertisign instance.
*
* @param instance Instance ID
* @param data Chain containing the scan response data.
*
* @return 0 on success or error code on failure.
*/
int ble_gap_ext_adv_rsp_set_data(uint8_t instance, struct os_mbuf *data);
/**
* Remove existing advertising instance.
*
* @param instance Instance ID
*
* @return 0 on success,
* BLE_HS_EBUSY if advertising is in progress,
* other error code on failure.
*/
int ble_gap_ext_adv_remove(uint8_t instance);
/**
* Clear all existing advertising instances
* @return 0 on success,
* BLE_HS_EBUSY if advertising is in progress,
* other error code on failure.
*/
int ble_gap_ext_adv_clear(void);
/**
* Indicates whether an advertisement procedure is currently in progress on
* the specified Instance
*
* @param instance Instance Id
*
* @return 0 if there is no active advertising procedure for the instance,
* 1 otherwise
*
*/
int ble_gap_ext_adv_active(uint8_t instance);
#endif
/* Periodic Advertising */
#if MYNEWT_VAL(BLE_PERIODIC_ADV)
/** @brief Periodic advertising parameters */
struct ble_gap_periodic_adv_params {
/** If include TX power in advertising PDU */
unsigned int include_tx_power : 1;
/** Minimum advertising interval in 1.25ms units, if 0 stack use sane
* defaults
*/
uint16_t itvl_min;
/** Maximum advertising interval in 1.25ms units, if 0 stack use sane
* defaults
*/
uint16_t itvl_max;
#if MYNEWT_VAL(BLE_PERIODIC_ADV_WITH_RESPONSES)
/** Number of subevents
* If zero, the periodic advertiser will be a broadcaster, without responses.
*/
uint8_t num_subevents;
/** Interval between subevents (N * 1.25 ms)
* Shall be between 7.5ms and 318.75 ms.
*/
uint8_t subevent_interval;
/** Time between the advertising packet in a subevent and the
* first response slot (N * 1.25 ms)
*
*/
uint8_t response_slot_delay;
/** Time between response slots (N * 0.125 ms)
* Shall be between 0.25 and 31.875 ms.
*/
uint8_t response_slot_spacing;
/** Number of subevent response slots
* If zero, response_slot_delay and response_slot_spacing are ignored.
*/
uint8_t num_response_slots;
#endif /* PERIODIC_ADV_WITH_RESPONSES */
};
#if MYNEWT_VAL(BLE_PERIODIC_ADV_ENH)
/** @brief Periodic advertising enable parameters */
struct ble_gap_periodic_adv_start_params {
/** If include adi in aux_sync_ind PDU */
unsigned int include_adi:1;
};
/** @brief Periodic advertising sync reporting parameters */
struct ble_gap_periodic_adv_sync_reporting_params {
/** If filter duplicates */
unsigned int filter_duplicates:1;
};
/** @brief Periodic adv set data parameters */
struct ble_gap_periodic_adv_set_data_params {
/** If include adi in aux_sync_ind PDU */
unsigned int update_did:1;
};
#endif
/** @brief Periodic sync parameters */
struct ble_gap_periodic_sync_params {
/** The maximum number of periodic advertising events that controller can
* skip after a successful receive.
* */
uint16_t skip;
/** Synchronization timeout for the periodic advertising train in 10ms units
*/
uint16_t sync_timeout;
/** If reports should be initially disabled when sync is created */
unsigned int reports_disabled:1;
#if MYNEWT_VAL(BLE_PERIODIC_ADV_ENH)
/** If duplicate filtering should be should be initially enabled when sync is
created */
unsigned int filter_duplicates:1;
#endif
#if MYNEWT_VAL(BLE_AOA_AOD)
/**
* Specifies the type of Constant Tone Extension (CTE) to which the receiver should not synchronize.
* This parameter determines which types of packets with specific CTE configurations are ignored during synchronization.
*
* Possible values:
* 0: Do not sync to packets with an AoA Constant Tone Extension.
* 1: Do not sync to packets with an AoD Constant Tone Extension with 1 μs slots.
* 2: Do not sync to packets with an AoD Constant Tone Extension with 2 μs slots.
* 3: Do not sync to packets with a type 3 Constant Tone Extension (currently reserved for future use).
* 4: Do not sync to packets without a Constant Tone Extension.
*/
uint8_t sync_cte_type;
#endif
};
#if MYNEWT_VAL(BLE_AOA_AOD)
#define BLE_GAP_CTE_TYPE_AOA 0x0
#define BLE_GAP_CTE_TYPE_AOD_1US 0x1
#define BLE_GAP_CTE_TYPE_AOD_2US 0x2
#define BLE_GAP_CTE_RSP_ALLOW_AOA_MASK BLE_HCI_CTE_RSP_ALLOW_AOA_MASK
#define BLE_GAP_CTE_RSP_ALLOW_AOD_1US_MASK BLE_HCI_CTE_RSP_ALLOW_AOD_1US_MASK
#define BLE_GAP_CTE_RSP_ALLOW_AOD_2US_MASK BLE_HCI_CTE_RSP_ALLOW_AOD_2US_MASK
/** @brief Periodic advertising parameters */
struct ble_gap_periodic_adv_cte_params {
/**
* Constant Tone Extension length in 8 µs units (Range: 0x02 to 0x14)
*/
uint8_t cte_length;
/**
* Constant Tone Extension type
* 0x00 : AoA Constant Tone Extension
* 0x01 : AoD Constant Tone Extension with 1 µs slots
* 0x02 : AoD Constant Tone Extension with 2 µs slots
*/
uint8_t cte_type;
/**
* The number of Constant Tone Extensions to transmit in each periodic
* advertising interval (Range: 0x01 to 0x10)
*/
uint8_t cte_count;
/**
* The number of Antenna IDs in the pattern
* (Range: 0x02 to 0x4B)
*/
uint8_t switching_pattern_length;
/**
* Antenna ID in the pattern.
* there is a pattern pointer
*/
uint8_t* antenna_ids;
};
struct ble_gap_cte_sampling_params {
/**
* The sampling rate used by the Controller
* 0x01 : Switching and sampling slots are 1 μs each
* 0x02 : Switching and sampling slots are 2 μs each
*/
uint8_t slot_durations;
/**
* The number of Antenna IDs in the pattern
* (Range: 0x02 to 0x4B)
*/
uint8_t switching_pattern_length;
/**
* Antenna ID in the pattern.
* there is a pattern pointer
*/
uint8_t* antenna_ids;
};
#endif
#if MYNEWT_VAL(BLE_PERIODIC_ADV_WITH_RESPONSES)
struct ble_gap_set_periodic_adv_subev_data_params {
/** The subevent to set data for */
uint8_t subevent;
/** The first response slot to listen to */
uint8_t response_slot_start;
/** The number of response slots to listen to */
uint8_t response_slot_count;
/** The data to send */
struct os_mbuf *data;
};
#endif
#if MYNEWT_VAL(BLE_ADV_SEND_CONSTANT_DID)
struct ble_gap_adv_const_did_cmd_params {
uint16_t handle;
uint8_t enable;
uint16_t did;
};
#endif // MYNEWT_VAL(BLE_ADV_SEND_CONSTANT_DID)
/**
* Configure periodic advertising for specified advertising instance
*
* This is allowed only for instances configured as non-announymous,
* non-connectable and non-scannable.
*
* @param instance Instance ID
* @param params Additional arguments specifying the particulars
* of periodic advertising.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_periodic_adv_configure(uint8_t instance,
const struct ble_gap_periodic_adv_params *params);
#if MYNEWT_VAL(BLE_PERIODIC_ADV_ENH)
/**
* Start periodic advertising for specified advertising instance.
*
* @param instance Instance ID
* @param params Additional arguments specifying the particulars
* of periodic advertising.
*
* @return 0 on success, error code on failure.
*/
int
ble_gap_periodic_adv_start(uint8_t instance,
const struct ble_gap_periodic_adv_start_params *params);
#else
/**
* Start periodic advertising for specified advertising instance.
*
* @param instance Instance ID
*
* @return 0 on success, error code on failure.
*/
int ble_gap_periodic_adv_start(uint8_t instance);
#endif
/**
* Stop periodic advertising for specified advertising instance.
*
* @param instance Instance ID
*
* @return 0 on success, error code on failure.
*/
int ble_gap_periodic_adv_stop(uint8_t instance);
#if MYNEWT_VAL(BLE_PERIODIC_ADV_ENH)
/**
* Configures the data to include in periodic advertisements for specified
* advertising instance.
*
* @param instance Instance ID
* @param data Chain containing the periodic advertising data.
* @param params Additional arguments specifying the particulars
of periodic advertising data.
*
* @return 0 on success or error code on failure.
*/
int ble_gap_periodic_adv_set_data(uint8_t instance,
struct os_mbuf *data,
struct ble_gap_periodic_adv_set_data_params *params);
#else
/**
* Configures the data to include in periodic advertisements for specified
* advertising instance.
*
* @param instance Instance ID
* @param data Chain containing the periodic advertising data.
*
* @return 0 on success or error code on failure.
*/
int ble_gap_periodic_adv_set_data(uint8_t instance, struct os_mbuf *data);
#endif
/**
* Performs the Synchronization procedure with periodic advertiser.
*
* @param addr Peer address to synchronize with. If NULL than
* peers from periodic list are used.
* @param adv_sid Advertiser Set ID
* @param params Additional arguments specifying the particulars
* of the synchronization procedure.
* @param cb The callback to associate with this synchrnization
* procedure. BLE_GAP_EVENT_PERIODIC_REPORT events
* are reported only by this callback.
* @param cb_arg The optional argument to pass to the callback
* function.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_periodic_adv_sync_create(const ble_addr_t *addr, uint8_t adv_sid,
const struct ble_gap_periodic_sync_params *params,
ble_gap_event_fn *cb, void *cb_arg);
/**
* Cancel pending synchronization procedure.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_periodic_adv_sync_create_cancel(void);
/**
* Terminate synchronization procedure.
*
* @param sync_handle Handle identifying synchronization to terminate.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_periodic_adv_sync_terminate(uint16_t sync_handle);
#if MYNEWT_VAL(BLE_PERIODIC_ADV_SYNC_TRANSFER)
#if MYNEWT_VAL(BLE_PERIODIC_ADV_ENH)
/**
* Disable or enable periodic reports for specified sync.
*
* @param sync_handle Handle identifying synchronization.
* @param enable If reports should be enabled.
* @param params Additional arguments specifying the particulars
* of periodic reports.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_periodic_adv_sync_reporting(uint16_t sync_handle,
bool enable,
const struct ble_gap_periodic_adv_sync_reporting_params *params);
#else
/**
* Disable or enable periodic reports for specified sync.
*
* @param sync_handle Handle identifying synchronization.
* @param enable If reports should be enabled.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_periodic_adv_sync_reporting(uint16_t sync_handle, bool enable);
#endif
/**
* Initialize sync transfer procedure for specified handles.
*
* This allows to transfer periodic sync to which host is synchronized.
*
* @param sync_handle Handle identifying synchronization.
* @param conn_handle Handle identifying connection.
* @param service_data Sync transfer service data
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_periodic_adv_sync_transfer(uint16_t sync_handle,
uint16_t conn_handle,
uint16_t service_data);
/**
* Initialize set info transfer procedure for specified handles.
*
* This allows to transfer periodic sync which is being advertised by host.
*
* @param instance Advertising instance with periodic adv enabled.
* @param conn_handle Handle identifying connection.
* @param service_data Sync transfer service data
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_periodic_adv_sync_set_info(uint8_t instance,
uint16_t conn_handle,
uint16_t service_data);
/**
* Set the default periodic sync transfer params.
*
*
* @param params Default Parameters for periodic sync transfer.
*
* @return 0 on success; nonzero on failure.
*/
int periodic_adv_set_default_sync_params(const struct ble_gap_periodic_sync_params *params);
/**
* Enables or disables sync transfer reception on specified connection.
* When sync transfer arrives, BLE_GAP_EVENT_PERIODIC_TRANSFER is sent to the user.
* After that, sync transfer reception on that connection is terminated and user needs
* to call this API again when expect to receive next sync transfers.
*
* Note: If ACL connection gets disconnected before sync transfer arrived, user will
* not receive BLE_GAP_EVENT_PERIODIC_TRANSFER. Instead, sync transfer reception
* is terminated by the host automatically.
*
* @param conn_handle Handle identifying connection.
* @param params Parameters for enabled sync transfer reception.
* Specify NULL to disable reception.
* @param cb The callback to associate with this synchronization
* procedure. BLE_GAP_EVENT_PERIODIC_REPORT events
* are reported only by this callback.
* @param cb_arg The optional argument to pass to the callback
* function.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_periodic_adv_sync_receive(uint16_t conn_handle,
const struct ble_gap_periodic_sync_params *params,
ble_gap_event_fn *cb, void *cb_arg);
#endif
/**
* Add peer device to periodic synchronization list.
*
* @param addr Peer address to add to list.
* @param adv_sid Advertiser Set ID
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_add_dev_to_periodic_adv_list(const ble_addr_t *peer_addr,
uint8_t adv_sid);
/**
* Remove peer device from periodic synchronization list.
*
* @param addr Peer address to remove from list.
* @param adv_sid Advertiser Set ID
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_rem_dev_from_periodic_adv_list(const ble_addr_t *peer_addr,
uint8_t adv_sid);
/**
* Clear periodic synchrnization list.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_clear_periodic_adv_list(void);
/**
* Get periodic synchronization list size.
*
* @param per_adv_list_size On success list size is stored here.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_read_periodic_adv_list_size(uint8_t *per_adv_list_size);
#if MYNEWT_VAL(BLE_AOA_AOD)
/**
* Set connectionless Constant Tone Extension (CTE) transmission parameters.
*
* @param instance Periodic advertising instance ID.
* @param params Pointer to the CTE transmission parameters.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_connless_cte_transmit_params(uint8_t instance,
const struct ble_gap_periodic_adv_cte_params *params);
/**
* Enable or disable connectionless CTE transmission.
*
* @param instance Periodic advertising instance ID.
* @param cte_enable 0x00 to disable, 0x01 to enable CTE transmission.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_connless_cte_transmit_enable(uint8_t instance, uint8_t cte_enable);
/**
* Enable or disable connectionless IQ sampling for periodic advertising.
*
* @param sync_handle Sync handle identifying the periodic advertiser.
* @param sampling_enable 0x00 to disable, 0x01 to enable IQ sampling.
* @param max_sampled_ctes Maximum number of sampled CTEs.
* @param cte_sampling_params Pointer to the CTE sampling parameters.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_connless_iq_sampling_enable(uint16_t sync_handle, uint8_t sampling_enable,
uint8_t max_sampled_ctes,
const struct ble_gap_cte_sampling_params *cte_sampling_params);
/**
* Set connection CTE receive parameters.
*
* @param conn_handle Connection handle.
* @param sampling_enable 0x00 to disable, 0x01 to enable CTE sampling.
* @param cte_sampling_params Pointer to the CTE sampling parameters.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_conn_cte_recv_param(uint16_t conn_handle, uint8_t sampling_enable,
const struct ble_gap_cte_sampling_params *cte_sampling_params);
/**
* Set connection CTE transmission parameters.
*
* @param conn_handle Connection handle.
* @param cte_types Bitfield specifying supported CTE types.
* @param switching_pattern_len Length of the antenna switching pattern.
* @param antenna_ids Pointer to the array of antenna IDs.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_conn_cte_transmit_param(uint16_t conn_handle, uint8_t cte_types,
uint8_t switching_pattern_len, const uint8_t *antenna_ids);
/**
* Enable or disable connection CTE request.
*
* @param conn_handle Connection handle.
* @param enable 0x00 to disable, 0x01 to enable CTE request.
* @param cte_request_interval Interval between CTE requests in connection interval.
* @param requested_cte_length Requested CTE length in 8 µs units.
* @param requested_cte_type Requested CTE type.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_conn_cte_req_enable(uint16_t conn_handle, uint8_t enable, uint16_t cte_request_interval,
uint8_t requested_cte_length, uint8_t requested_cte_type);
/**
* Enable or disable connection CTE response.
*
* @param conn_handle Connection handle.
* @param enable 0x00 to disable, 0x01 to enable CTE response.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_conn_cte_rsp_enable(uint16_t conn_handle, uint8_t enable);
/**
* Read antenna information.
*
* @param switch_sampling_rates On success, stores the supported switching and sampling rates.
* @param num_antennae On success, stores the number of antennae.
* @param max_switch_pattern_len On success, stores the maximum switching pattern length.
* @param max_cte_len On success, stores the maximum CTE length.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_read_antenna_information(uint8_t *switch_sampling_rates, uint8_t *num_antennae,
uint8_t *max_switch_pattern_len, uint8_t *max_cte_len);
#endif // MYNEWT_VAL(BLE_AOA_AOD)
#if MYNEWT_VAL(BLE_PERIODIC_ADV_WITH_RESPONSES)
int
ble_gap_set_periodic_adv_subev_data(uint8_t instance, uint8_t num_subevents,
const struct ble_gap_set_periodic_adv_subev_data_params *params);
int ble_gap_periodic_adv_set_response_data(uint16_t sync_handle,
struct ble_gap_periodic_adv_response_params *param,
struct os_mbuf *data);
int ble_gap_periodic_adv_sync_subev(uint16_t sync_handle, uint8_t include_tx_power,
uint8_t num_subevents, uint8_t *subevents);
#endif
#endif
/**
* Performs the Limited or General Discovery Procedures.
*
* @param own_addr_type The type of address the stack should use for
* itself when sending scan requests. Valid
* values are:
* - BLE_ADDR_TYPE_PUBLIC
* - BLE_ADDR_TYPE_RANDOM
* - BLE_ADDR_TYPE_RPA_PUB_DEFAULT
* - BLE_ADDR_TYPE_RPA_RND_DEFAULT
* This parameter is ignored unless active
* scanning is being used.
* @param duration_ms The duration of the discovery procedure.
* On expiration, the procedure ends and a
* BLE_GAP_EVENT_DISC_COMPLETE event is
* reported. Units are milliseconds. Specify
* BLE_HS_FOREVER for no expiration. Specify
* 0 to use stack defaults.
* @param disc_params Additional arguments specifying the particulars
* of the discovery procedure.
* @param cb The callback to associate with this discovery
* procedure. Advertising reports and
* discovery termination events are reported
* through this callback.
* @param cb_arg The optional argument to pass to the callback
* function.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_disc(uint8_t own_addr_type, int32_t duration_ms,
const struct ble_gap_disc_params *disc_params,
ble_gap_event_fn *cb, void *cb_arg);
/**
* Performs the Limited or General Extended Discovery Procedures.
*
* @param own_addr_type The type of address the stack should use for
* itself when sending scan requests. Valid
* values are:
* - BLE_ADDR_TYPE_PUBLIC
* - BLE_ADDR_TYPE_RANDOM
* - BLE_ADDR_TYPE_RPA_PUB_DEFAULT
* - BLE_ADDR_TYPE_RPA_RND_DEFAULT
* This parameter is ignored unless active
* scanning is being used.
* @param duration The duration of the discovery procedure.
* On expiration, if period is set to 0, the
* procedure ends and a
* BLE_GAP_EVENT_DISC_COMPLETE event is
* reported. Units are 10 milliseconds.
* Specify 0 for no expiration.
* @param period Time interval from when the Controller started
* its last Scan Duration until it begins the
* subsequent Scan Duration. Specify 0 to scan
* continuously. Units are 1.28 second.
* @param filter_duplicates Set to enable packet filtering in the
* controller
* @param filter_policy Set the used filter policy. Valid values are:
* - BLE_HCI_SCAN_FILT_NO_WL
* - BLE_HCI_SCAN_FILT_USE_WL
* - BLE_HCI_SCAN_FILT_NO_WL_INITA
* - BLE_HCI_SCAN_FILT_USE_WL_INITA
* - BLE_HCI_SCAN_FILT_MAX
* This parameter is ignored unless
* @p filter_duplicates is set.
* @param limited If limited discovery procedure should be used.
* @param uncoded_params Additional arguments specifying the particulars
* of the discovery procedure for uncoded PHY.
* If NULL is provided no scan is performed for
* this PHY.
* @param coded_params Additional arguments specifying the particulars
* of the discovery procedure for coded PHY.
* If NULL is provided no scan is performed for
* this PHY.
* @param cb The callback to associate with this discovery
* procedure. Advertising reports and discovery
* termination events are reported through this
* callback.
* @param cb_arg The optional argument to pass to the callback
* function.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_ext_disc(uint8_t own_addr_type, uint16_t duration, uint16_t period,
uint8_t filter_duplicates, uint8_t filter_policy,
uint8_t limited,
const struct ble_gap_ext_disc_params *uncoded_params,
const struct ble_gap_ext_disc_params *coded_params,
ble_gap_event_fn *cb, void *cb_arg);
/**
* Cancels the discovery procedure currently in progress. A success return
* code indicates that scanning has been fully aborted; a new discovery or
* connect procedure can be initiated immediately.
*
* @return 0 on success;
* BLE_HS_EALREADY if there is no discovery
* procedure to cancel;
* Other nonzero on unexpected error.
*/
int ble_gap_disc_cancel(void);
/**
* Indicates whether a discovery procedure is currently in progress.
*
* @return 0: No discovery procedure in progress;
* 1: Discovery procedure in progress.
*/
int ble_gap_disc_active(void);
/**
* Initiates a connect procedure.
*
* @param own_addr_type The type of address the stack should use for
* itself during connection establishment.
* - BLE_OWN_ADDR_PUBLIC
* - BLE_OWN_ADDR_RANDOM
* - BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT
* - BLE_OWN_ADDR_RPA_RANDOM_DEFAULT
* @param peer_addr The address of the peer to connect to.
* If this parameter is NULL, the white list
* is used.
* @param duration_ms The duration of the discovery procedure.
* On expiration, the procedure ends and a
* BLE_GAP_EVENT_DISC_COMPLETE event is
* reported. Units are milliseconds.
* @param conn_params Additional arguments specifying the particulars
* of the connect procedure. Specify null for
* default values.
* @param cb The callback to associate with this connect
* procedure. When the connect procedure
* completes, the result is reported through
* this callback. If the connect procedure
* succeeds, the connection inherits this
* callback as its event-reporting mechanism.
* @param cb_arg The optional argument to pass to the callback
* function.
*
* @return 0 on success;
* BLE_HS_EALREADY if a connection attempt is
* already in progress;
* BLE_HS_EBUSY if initiating a connection is not
* possible because scanning is in progress;
* BLE_HS_EDONE if the specified peer is already
* connected;
* Other nonzero on error.
*/
int ble_gap_connect(uint8_t own_addr_type, const ble_addr_t *peer_addr,
int32_t duration_ms,
const struct ble_gap_conn_params *params,
ble_gap_event_fn *cb, void *cb_arg);
#if MYNEWT_VAL(BLE_PERIODIC_ADV_WITH_RESPONSES)
/**
* Initiates an Sync connect procedure for PAwR.
*
* @param own_addr_type The type of address the stack should use for
* itself during connection establishment.
* - BLE_OWN_ADDR_PUBLIC
* - BLE_OWN_ADDR_RANDOM
* - BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT
* - BLE_OWN_ADDR_RPA_RANDOM_DEFAULT
* @param advertising_handle The advertising_Handle identifying the periodic advertising train
* Range: 0x00 to 0xEF or 0xFF
* @param subevent The Subevent parameter is used to identify the subevent where a connection
request shall be initiated from a periodic advertising train.
The Advertising_Handle and Subevent parameters
shall be set to 0xFF if these
parameters are not used.
* @param peer_addr The address of the peer to connect to.
* If this parameter is NULL, the white list
* is used.
* @param duration_ms The duration of the discovery procedure.
* On expiration, the procedure ends and a
* BLE_GAP_EVENT_DISC_COMPLETE event is
* reported. Units are milliseconds.
* @param phy_mask Define on which PHYs connection attempt should
* be done
* @param phy_1m_conn_params Additional arguments specifying the
* particulars of the connect procedure. When
* BLE_GAP_LE_PHY_1M_MASK is set in phy_mask
* this parameter can be specify to null for
* default values.
* @param phy_2m_conn_params Additional arguments specifying the
* particulars of the connect procedure. When
* BLE_GAP_LE_PHY_2M_MASK is set in phy_mask
* this parameter can be specify to null for
* default values.
* @param phy_coded_conn_params Additional arguments specifying the
* particulars of the connect procedure. When
* BLE_GAP_LE_PHY_CODED_MASK is set in
* phy_mask this parameter can be specify to
* null for default values.
* @param cb The callback to associate with this connect
* procedure. When the connect procedure
* completes, the result is reported through
* this callback. If the connect procedure
* succeeds, the connection inherits this
* callback as its event-reporting mechanism.
* @param cb_arg The optional argument to pass to the callback
* function.
*
* @return 0 on success;
* BLE_HS_EALREADY if a connection attempt is
* already in progress;
* BLE_HS_EBUSY if initiating a connection is not
* possible because scanning is in progress;
* BLE_HS_EDONE if the specified peer is already
* connected;
* Other nonzero on error.
*/
int ble_gap_connect_with_synced(uint8_t own_addr_type, uint8_t advertising_handle,
uint8_t subevent, const ble_addr_t *peer_addr,
int32_t duration_ms, uint8_t phy_mask,
const struct ble_gap_conn_params *phy_1m_conn_params,
const struct ble_gap_conn_params *phy_2m_conn_params,
const struct ble_gap_conn_params *phy_coded_conn_params,
ble_gap_event_fn *cb, void *cb_arg);
#endif
/**
* Initiates an extended connect procedure.
*
* @param own_addr_type The type of address the stack should use for
* itself during connection establishment.
* - BLE_OWN_ADDR_PUBLIC
* - BLE_OWN_ADDR_RANDOM
* - BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT
* - BLE_OWN_ADDR_RPA_RANDOM_DEFAULT
* @param peer_addr The address of the peer to connect to.
* If this parameter is NULL, the white list
* is used.
* @param duration_ms The duration of the discovery procedure.
* On expiration, the procedure ends and a
* BLE_GAP_EVENT_DISC_COMPLETE event is
* reported. Units are milliseconds.
* @param phy_mask Define on which PHYs connection attempt should
* be done
* @param phy_1m_conn_params Additional arguments specifying the
* particulars of the connect procedure. When
* BLE_GAP_LE_PHY_1M_MASK is set in phy_mask
* this parameter can be specify to null for
* default values.
* @param phy_2m_conn_params Additional arguments specifying the
* particulars of the connect procedure. When
* BLE_GAP_LE_PHY_2M_MASK is set in phy_mask
* this parameter can be specify to null for
* default values.
* @param phy_coded_conn_params Additional arguments specifying the
* particulars of the connect procedure. When
* BLE_GAP_LE_PHY_CODED_MASK is set in
* phy_mask this parameter can be specify to
* null for default values.
* @param cb The callback to associate with this connect
* procedure. When the connect procedure
* completes, the result is reported through
* this callback. If the connect procedure
* succeeds, the connection inherits this
* callback as its event-reporting mechanism.
* @param cb_arg The optional argument to pass to the callback
* function.
*
* @return 0 on success;
* BLE_HS_EALREADY if a connection attempt is
* already in progress;
* BLE_HS_EBUSY if initiating a connection is not
* possible because scanning is in progress;
* BLE_HS_EDONE if the specified peer is already
* connected;
* Other nonzero on error.
*/
int ble_gap_ext_connect(uint8_t own_addr_type, const ble_addr_t *peer_addr,
int32_t duration_ms, uint8_t phy_mask,
const struct ble_gap_conn_params *phy_1m_conn_params,
const struct ble_gap_conn_params *phy_2m_conn_params,
const struct ble_gap_conn_params *phy_coded_conn_params,
ble_gap_event_fn *cb, void *cb_arg);
#if MYNEWT_VAL(OPTIMIZE_MULTI_CONN)
/**
* @brief Enable the optimization of multiple connections.
*
* @param enable Enable or disable the optimization.
* @param common_factor The greatest common factor of all intervals in 0.625ms units.
* @return 0 on success;
*
*/
int ble_gap_common_factor_set(bool enable, uint32_t common_factor);
/**
* Initiates an extended connect procedure with optimization.
*
* @param multi_conn_params Additional arguments specifying the particulars
* of the connect procedure.
* @param cb The callback to associate with this connect
* procedure. When the connect procedure
* completes, the result is reported through
* this callback. If the connect procedure
* succeeds, the connection inherits this
* callback as its event-reporting mechanism.
* @param cb_arg The optional argument to pass to the callback
* function.
*
* @return 0 on success;
* BLE_HS_EALREADY if a connection attempt is
* already in progress;
* BLE_HS_EBUSY if initiating a connection is not
* possible because scanning is in progress;
* BLE_HS_EDONE if the specified peer is already
* connected;
* Other nonzero on error.
*/
int ble_gap_multi_connect(struct ble_gap_multi_conn_params *multi_conn_params,
ble_gap_event_fn *cb, void *cb_arg);
#endif
/**
* Aborts a connect procedure in progress.
*
* @return 0 on success;
* BLE_HS_EALREADY if there is no active connect
* procedure.
* Other nonzero on error.
*/
int ble_gap_conn_cancel(void);
/**
* Indicates whether a connect procedure is currently in progress.
*
* @return 0: No connect procedure in progress;
* 1: Connect procedure in progress.
*/
int ble_gap_conn_active(void);
/**
* Terminates an established connection.
*
* @param conn_handle The handle corresponding to the connection to
* terminate.
* @param hci_reason The HCI error code to indicate as the reason
* for termination.
*
* @return 0 on success;
* BLE_HS_ENOTCONN if there is no connection with
* the specified handle;
* Other nonzero on failure.
*/
int ble_gap_terminate(uint16_t conn_handle, uint8_t hci_reason);
/**
* Overwrites the controller's white list with the specified contents.
*
* @param addrs The entries to write to the white list.
* @param white_list_count The number of entries in the white list.
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_wl_set(const ble_addr_t *addrs, uint8_t white_list_count);
/**
* Initiates a connection parameter update procedure.
*
* @param conn_handle The handle corresponding to the connection to
* update.
* @param params The connection parameters to attempt to update
* to.
*
* @return 0 on success;
* BLE_HS_ENOTCONN if the there is no connection
* with the specified handle;
* BLE_HS_EALREADY if a connection update
* procedure for this connection is already in
* progress;
* BLE_HS_EINVAL if requested parameters are
* invalid;
* Other nonzero on error.
*/
int ble_gap_update_params(uint16_t conn_handle,
const struct ble_gap_upd_params *params);
/**
* Configure LE Data Length in controller (OGF = 0x08, OCF = 0x0022).
*
* @param conn_handle Connection handle.
* @param tx_octets The preferred value of payload octets that the
* Controller should use for a new connection
* (Range 0x001B-0x00FB).
* @param tx_time The preferred maximum number of microseconds that
* the local Controller should use to transmit a single
* link layer packet (Range 0x0148-0x4290).
*
* @return 0 on success,
* other error code on failure.
*/
int ble_gap_set_data_len(uint16_t conn_handle, uint16_t tx_octets,
uint16_t tx_time);
/**
* Read LE Suggested Default Data Length in controller
* (OGF = 0x08, OCF = 0x0024).
*
* @param out_sugg_max_tx_octets The Host's suggested value for the
* Controller's maximum transmitted number of
* payload octets in LL Data PDUs to be used
* for new connections. (Range 0x001B-0x00FB).
* @param out_sugg_max_tx_time The Host's suggested value for the
* Controller's maximum packet transmission
* time for packets containing LL Data PDUs to
* be used for new connections.
* (Range 0x0148-0x4290).
*
* @return 0 on success,
* other error code on failure.
*/
int ble_gap_read_sugg_def_data_len(uint16_t *out_sugg_max_tx_octets,
uint16_t *out_sugg_max_tx_time);
/**
* Configure LE Suggested Default Data Length in controller
* (OGF = 0x08, OCF = 0x0024).
*
* @param sugg_max_tx_octets The Host's suggested value for the Controller's
* maximum transmitted number of payload octets in
* LL Data PDUs to be used for new connections.
* (Range 0x001B-0x00FB).
* @param sugg_max_tx_time The Host's suggested value for the Controller's
* maximum packet transmission time for packets
* containing LL Data PDUs to be used for new
* connections. (Range 0x0148-0x4290).
*
* @return 0 on success,
* other error code on failure.
*/
int ble_gap_write_sugg_def_data_len(uint16_t sugg_max_tx_octets,
uint16_t sugg_max_tx_time);
/**
* Read LE Suggested Default Data Length in controller (OGF = 0x08, OCF = 0x0024).
*
* @param out_sugg_max_tx_octets The Host's suggested value for the Controller's maximum transmitted
* number of payload octets in LL Data PDUs to be used for new
* connections. (Range 0x001B-0x00FB).
* @param out_sugg_max_tx_time The Host's suggested value for the Controller's maximum packet
* transmission time for packets containing LL Data PDUs to be used
* for new connections. (Range 0x0148-0x4290).
*
* @return 0 on success,
* other error code on failure.
*/
int ble_gap_read_sugg_def_data_len(uint16_t *out_sugg_max_tx_octets,
uint16_t *out_sugg_max_tx_time);
/**
* Configure LE Suggested Default Data Length in controller (OGF = 0x08, OCF = 0x0024).
*
* @param sugg_max_tx_octets The Host's suggested value for the Controller's maximum transmitted
* number of payload octets in LL Data PDUs to be used for new
* connections. (Range 0x001B-0x00FB).
* @param sugg_max_tx_time The Host's suggested value for the Controller's maximum packet
* transmission time for packets containing LL Data PDUs to be used
* for new connections. (Range 0x0148-0x4290).
*
* @return 0 on success,
* other error code on failure.
*/
int ble_gap_write_sugg_def_data_len(uint16_t sugg_max_tx_octets, uint16_t sugg_max_tx_time);
/**
* Initiates the GAP security procedure.
*
* Depending on connection role and stored security information this function
* will start appropriate security procedure (pairing or encryption).
*
* @param conn_handle The handle corresponding to the connection to
* secure.
*
* @return 0 on success;
* BLE_HS_ENOTCONN if the there is no connection
* with the specified handle;
* BLE_HS_EALREADY if an security procedure for
* this connection is already in progress;
* Other nonzero on error.
*/
int ble_gap_security_initiate(uint16_t conn_handle);
/**
* Initiates the GAP pairing procedure as a master. This is for testing only and
* should not be used by application. Use ble_gap_security_initiate() instead.
*
* @param conn_handle The handle corresponding to the connection to
* start pairing on.
*
* @return 0 on success;
* BLE_HS_ENOTCONN if the there is no connection
* with the specified handle;
* BLE_HS_EALREADY if an pairing procedure for
* this connection is already in progress;
* Other nonzero on error.
*/
int ble_gap_pair_initiate(uint16_t conn_handle);
/**
* Initiates the GAP encryption procedure as a master. This is for testing only
* and should not be used by application. Use ble_gap_security_initiate()
* instead.
*
* @param conn_handle The handle corresponding to the connection to
* start encryption.
* @param key_size Encryption key size
* @param ltk Long Term Key to be used for encryption.
* @param udiv Encryption Diversifier for LTK
* @param rand_val Random Value for EDIV and LTK
* @param auth If LTK provided is authenticated.
*
* @return 0 on success;
* BLE_HS_ENOTCONN if the there is no connection
* with the specified handle;
* BLE_HS_EALREADY if an encryption procedure for
* this connection is already in progress;
* Other nonzero on error.
*/
int ble_gap_encryption_initiate(uint16_t conn_handle, uint8_t key_size,
const uint8_t *ltk, uint16_t ediv,
uint64_t rand_val, int auth);
/**
* Retrieves the most-recently measured RSSI for the specified connection. A
* connection's RSSI is updated whenever a data channel PDU is received.
*
* @param conn_handle Specifies the connection to query.
* @param out_rssi On success, the retrieved RSSI is written here.
*
* @return 0 on success;
* A BLE host HCI return code if the controller
* rejected the request;
* A BLE host core return code on unexpected
* error.
*/
int ble_gap_conn_rssi(uint16_t conn_handle, int8_t *out_rssi);
/**
* Unpairs a device with the specified address. The keys related to that peer
* device are removed from storage and peer address is removed from the resolve
* list from the controller. If a peer is connected, the connection is terminated.
*
* @param peer_addr Address of the device to be unpaired
*
* @return 0 on success;
* A BLE host HCI return code if the controller
* rejected the request;
* A BLE host core return code on unexpected
* error.
*/
int ble_gap_unpair(const ble_addr_t *peer_addr);
/**
* Unpairs the oldest bonded peer device. The keys related to that peer
* device are removed from storage and peer address is removed from the resolve
* list from the controller. If a peer is connected, the connection is terminated.
*
* @return 0 on success;
* A BLE host HCI return code if the controller
* rejected the request;
* A BLE host core return code on unexpected
* error.
*/
int ble_gap_unpair_oldest_peer(void);
/**
* Similar to `ble_gap_unpair_oldest_peer()`, except it makes sure that the
* peer received in input parameters is not deleted.
*
* @param peer_addr Address of the peer (not to be deleted)
*
* @return 0 on success;
* A BLE host HCI return code if the controller
* rejected the request;
* A BLE host core return code on unexpected
* error.
*/
int ble_gap_unpair_oldest_except(const ble_addr_t *peer_addr);
#define BLE_GAP_PRIVATE_MODE_NETWORK 0
#define BLE_GAP_PRIVATE_MODE_DEVICE 1
/**
* Set privacy mode for specified peer device
*
* @param peer_addr Peer device address
* @param priv_mode Privacy mode to be used. Can be one of following
* constants:
* - BLE_GAP_PRIVATE_MODE_NETWORK
* - BLE_GAP_PRIVATE_MODE_DEVICE
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_priv_mode(const ble_addr_t *peer_addr, uint8_t priv_mode);
#define BLE_GAP_LE_PHY_1M 1
#define BLE_GAP_LE_PHY_2M 2
#define BLE_GAP_LE_PHY_CODED 3
/**
* Read PHYs used for specified connection.
*
* On success output parameters are filled with information about used PHY type.
*
* @param conn_handle Connection handle
* @param tx_phy TX PHY used. Can be one of following constants:
* - BLE_GAP_LE_PHY_1M
* - BLE_GAP_LE_PHY_2M
* - BLE_GAP_LE_PHY_CODED
* @param rx_phy RX PHY used. Can be one of following constants:
* - BLE_GAP_LE_PHY_1M
* - BLE_GAP_LE_PHY_2M
* - BLE_GAP_LE_PHY_CODED
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_read_le_phy(uint16_t conn_handle, uint8_t *tx_phy, uint8_t *rx_phy);
#define BLE_GAP_LE_PHY_1M_MASK 0x01
#define BLE_GAP_LE_PHY_2M_MASK 0x02
#define BLE_GAP_LE_PHY_CODED_MASK 0x04
#define BLE_GAP_LE_PHY_ANY_MASK 0x0F
/**
* Set preferred default PHYs to be used for connections.
*
* @params tx_phys_mask Preferred TX PHY. Can be mask of following
* constants:
* - BLE_GAP_LE_PHY_1M_MASK
* - BLE_GAP_LE_PHY_2M_MASK
* - BLE_GAP_LE_PHY_CODED_MASK
* - BLE_GAP_LE_PHY_ANY_MASK
* @params rx_phys_mask Preferred RX PHY. Can be mask of following
* constants:
* - BLE_GAP_LE_PHY_1M_MASK
* - BLE_GAP_LE_PHY_2M_MASK
* - BLE_GAP_LE_PHY_CODED_MASK
* - BLE_GAP_LE_PHY_ANY_MASK
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_prefered_default_le_phy(uint8_t tx_phys_mask,
uint8_t rx_phys_mask);
#define BLE_GAP_LE_PHY_CODED_ANY 0
#define BLE_GAP_LE_PHY_CODED_S2 1
#define BLE_GAP_LE_PHY_CODED_S8 2
/**
* Set preferred PHYs to be used for connection.
*
* @param conn_handle Connection handle
* @params tx_phys_mask Preferred TX PHY. Can be mask of following
* constants:
* - BLE_GAP_LE_PHY_1M_MASK
* - BLE_GAP_LE_PHY_2M_MASK
* - BLE_GAP_LE_PHY_CODED_MASK
* - BLE_GAP_LE_PHY_ANY_MASK
* @params rx_phys_mask Preferred RX PHY. Can be mask of following
* constants:
* - BLE_GAP_LE_PHY_1M_MASK
* - BLE_GAP_LE_PHY_2M_MASK
* - BLE_GAP_LE_PHY_CODED_MASK
* - BLE_GAP_LE_PHY_ANY_MASK
* @param phy_opts Additional PHY options. Valid values are:
* - BLE_GAP_LE_PHY_CODED_ANY
* - BLE_GAP_LE_PHY_CODED_S2
* - BLE_GAP_LE_PHY_CODED_S8
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_prefered_le_phy(uint16_t conn_handle, uint8_t tx_phys_mask,
uint8_t rx_phys_mask, uint16_t phy_opts);
#if MYNEWT_VAL(BLE_CONN_SUBRATING)
/**
* Set default subrate
*
* @param subrate_min Min subrate factor allowed in request by a peripheral
* @param subrate_max Max subrate factor allowed in request by a peripheral
* @param max_latency Max peripheral latency allowed in units of
* subrated conn interval.
*
* @param cont_num Min number of underlying conn event to remain active
* after a packet containing PDU with non-zero length field
* is sent or received in request by a peripheral.
*
* @param supervision_timeout Max supervision timeout allowed in request by a peripheral
*/
int ble_gap_set_default_subrate(uint16_t subrate_min, uint16_t subrate_max, uint16_t max_latency,
uint16_t cont_num, uint16_t supervision_timeout);
/**
* Subrate Request
*
* @param conn_handle Connection Handle of the ACL.
* @param subrate_min Min subrate factor to be applied
* @param subrate_max Max subrate factor to be applied
* @param max_latency Max peripheral latency allowed in units of
* subrated conn interval.
*
* @param cont_num Min number of underlying conn event to remain active
* after a packet containing PDU with non-zero length field
* is sent or received in request by a peripheral.
*
* @param supervision_timeout Max supervision timeout allowed for this connection
*/
int
ble_gap_subrate_req(uint16_t conn_handle, uint16_t subrate_min, uint16_t subrate_max,
uint16_t max_latency, uint16_t cont_num,
uint16_t supervision_timeout);
#endif
#if MYNEWT_VAL(BLE_ISO)
/**
* Create CIS by Central.
*
* @param cis_cnt The number of CISes to create.
* @param params The parameters used to create CISes.
* @param cb The callback to associate with the CIS creation procedure.
* When the CIS creation procedure completes, the result is
* reported through this callback.
* @param cb_arg The optional argument to pass to the callback function.
*
* @return 0 on success, error code on failure.
*/
int ble_gap_create_cis(uint8_t cis_cnt, const struct ble_hci_le_create_cis_params *params,
ble_gap_event_fn *cb, void *cb_arg);
/**
* Accept CIS request by Peripheral.
*
* @param cis_handle Connection handle of the CIS.
* @param cb The callback to associate with the CIS creation procedure.
* When the CIS creation procedure completes, the result is
* reported through this callback.
* @param cb_arg The optional argument to pass to the callback function.
*
* @return 0 on success, error code on failure.
*/
int ble_gap_accept_cis_request(uint16_t cis_handle, ble_gap_event_fn *cb, void *cb_arg);
/**
* Reject CIS request by Peripheral.
*
* @param cis_handle Connection handle of the CIS.
* @param reason Reason the CIS request was rejected.
*
* @return 0 on success, error code on failure.
*/
int ble_gap_reject_cis_request(uint16_t cis_handle, uint8_t reason);
/**
* Disconnect CIS.
*
* @param cis_handle Connection handle of the CIS.
* @param reason Reason the CIS was disconnected.
*
* @return 0 on success, error code on failure.
*/
int ble_gap_iso_disconnect(uint16_t cis_handle, uint8_t reason);
/**
* Create BIG Broadcaster.
*
* @param big_handle Identifier of the BIG.
* @param adv_handle Associated periodic advertising train.
* @param num_bis Total number of BISes in the BIG.
* @param sdu_interval The interval, in microseconds, of SDUs.
* @param max_sdu Maximum size, in octets, of an SDU.
* @param max_transport_latency Maximum transport latency, in milliseconds.
* @param rtn The number of times that every BIS PDU should be retransmitted.
* @param phy Transmitter PHY.
* @param packing Sequential or Interleaved.
* @param framing Unframed or framed.
* @param encryption Unencrypted or encrypted.
* @param broadcast_code The code used to derive the BIG session key.
* @param cb The callback to associate with the BIG creation procedure.
* When the BIG creation procedure completes, the result is
* reported through this callback.
* @param cb_arg The optional argument to pass to the callback function.
*
* @return 0 on success, error code on failure.
*/
int ble_gap_create_big(uint8_t big_handle, uint8_t adv_handle, uint8_t num_bis,
uint32_t sdu_interval, uint16_t max_sdu,
uint16_t max_transport_latency, uint8_t rtn,
uint8_t phy, uint8_t packing, uint8_t framing,
uint8_t encryption, uint8_t broadcast_code[16],
ble_gap_event_fn *cb, void *cb_arg);
#if MYNEWT_VAL(BLE_ISO_TEST)
/**
* Create BIG Broadcaster with test command.
*
* @param big_handle Identifier of the BIG.
* @param adv_handle Associated periodic advertising train.
* @param num_bis Total number of BISes in the BIG.
* @param sdu_interval The interval, in microseconds, of ISO SDUs.
* @param iso_interval The time between consecutive BIG anchor points (unit 1.25ms).
* @param nse The total number of subevents in each interval of each BIS in the BIG.
* @param max_sdu Maximum size, in octets, of an SDU.
* @param max_pdu Maximum size, in octets, of payload.
* @param phy Transmitter PHY.
* @param packing Sequential or Interleaved.
* @param framing Unframed or framed.
* @param bn The number of new payloads in each interval for each BIS.
* @param irc The number of times the payloads are transmitted in a given event.
* @param pto Offset used for pre-transmissions.
* @param encryption Unencrypted or encrypted.
* @param broadcast_code The code used to derive the BIG session key.
* @param cb The callback to associate with the BIG creation procedure.
* When the BIG creation procedure completes, the result is
* reported through this callback.
* @param cb_arg The optional argument to pass to the callback function.
*
* @return 0 on success, error code on failure.
*/
int ble_gap_create_big_test(uint8_t big_handle, uint8_t adv_handle, uint8_t num_bis,
uint32_t sdu_interval, uint16_t iso_interval, uint8_t nse,
uint16_t max_sdu, uint16_t max_pdu, uint8_t phy,
uint8_t packing, uint8_t framing, uint8_t bn, uint8_t irc,
uint8_t pto, uint8_t encryption, uint8_t broadcast_code[16],
ble_gap_event_fn *cb, void *cb_arg);
#endif /* MYNEWT_VAL(BLE_ISO_TEST) */
/**
* Terminate BIG Broadcaster.
*
* @param big_handle Identifier of the BIG.
* @param reason Reason the BIG is terminated.
*
* @return 0 on success, error code on failure.
*/
int ble_gap_terminate_big(uint8_t big_handle, uint8_t reason);
/**
* Create BIG Synchronized Receiver.
*
* @param big_handle Identifier of the BIG.
* @param sync_handle Associated periodic advertising train.
* @param encryption Unencrypted or encrypted.
* @param broadcast_code The code used to derive the BIG session key.
* @param mse Maximum number of subevents that should be used to receive in each BIS event.
* @param sync_timeout Synchronization timeout for the BIG (unit 10ms).
* @param num_bis Total number of BISes in the BIG.
* @param bis_index Indexes of the BISes.
* @param cb The callback to associate with the BIG creation procedure.
* When the BIG creation procedure completes, the result is
* reported through this callback.
* @param cb_arg The optional argument to pass to the callback function.
*
* @return 0 on success, error code on failure.
*/
int ble_gap_big_create_sync(uint8_t big_handle, uint16_t sync_handle,
uint8_t encryption, uint8_t broadcast_code[16],
uint8_t mse, uint16_t sync_timeout,
uint8_t num_bis, uint8_t *bis_index,
ble_gap_event_fn *cb, void *cb_arg);
/**
* Terminate BIG Synchronized Receiver.
*
* @param big_handle Identifier of the BIG.
*
* @return 0 on success, error code on failure.
*/
int ble_gap_big_terminate_sync(uint8_t big_handle);
#endif /* MYNEWT_VAL(BLE_ISO) */
/**
* Event listener structure
*
* This should be used as an opaque structure and not modified manually.
*/
struct ble_gap_event_listener {
ble_gap_event_fn *fn;
void *arg;
SLIST_ENTRY(ble_gap_event_listener) link;
};
/**
* Registers listener for GAP events
*
* On success listener structure will be initialized automatically and does not
* need to be initialized prior to calling this function. To change callback
* and/or argument unregister listener first and register it again.
*
* @param listener Listener structure
* @param fn Callback function
* @param arg Callback argument
*
* @return 0 on success
* BLE_HS_EINVAL if no callback is specified
* BLE_HS_EALREADY if listener is already registered
*/
int ble_gap_event_listener_register(struct ble_gap_event_listener *listener,
ble_gap_event_fn *fn, void *arg);
/**
* Unregisters listener for GAP events
*
* @param listener Listener structure
*
* @return 0 on success
* BLE_HS_ENOENT if listener was not registered
*/
int ble_gap_event_listener_unregister(struct ble_gap_event_listener *listener);
#if MYNEWT_VAL(BLE_POWER_CONTROL)
/**
* Enable Set Path Loss Reporting.
*
* @param conn_handle Connection handle
* @params enable 1: Enable
* 0: Disable
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_path_loss_reporting_enable(uint16_t conn_handle, uint8_t enable);
/**
* Enable Reporting of Transmit Power
*
* @param conn_handle Connection handle
* @params local_enable 1: Enable local transmit power reports
* 0: Disable local transmit power reports
*
* @params remote_enable 1: Enable remote transmit power reports
* 0: Disable remote transmit power reports
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_transmit_power_reporting_enable(uint16_t conn_handle,
uint8_t local_enable,
uint8_t remote_enable);
/**
* LE Enhanced Read Transmit Power Level
*
* @param conn_handle Connection handle
* @params phy Advertising Phy
*
* @params status 0 on success; nonzero on failure.
* @params conn_handle Connection handle
* @params phy Advertising Phy
*
* @params curr_tx_power_level Current trasnmit Power Level
*
* @params mx_tx_power_level Maximum transmit power level
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_enh_read_transmit_power_level(uint16_t conn_handle, uint8_t phy,
uint8_t *out_status, uint8_t *out_phy,
uint8_t *out_curr_tx_power_level,
uint8_t *out_max_tx_power_level);
/**
* Read Remote Transmit Power Level
*
* @param conn_handle Connection handle
* @params phy Advertising Phy
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_read_remote_transmit_power_level(uint16_t conn_handle, uint8_t phy);
/**
* Set Path Loss Reproting Param
*
* @param conn_handle Connection handle
* @params high_threshold High Threshold value for path loss
* @params high_hysteresis Hysteresis value for high threshold
* @params low_threshold Low Threshold value for path loss
* @params low_hysteresis Hysteresis value for low threshold
* @params min_time_spent Minimum time controller observes the path loss
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_path_loss_reporting_param(uint16_t conn_handle, uint8_t high_threshold,
uint8_t high_hysteresis, uint8_t low_threshold,
uint8_t low_hysteresis, uint16_t min_time_spent);
#endif
#if MYNEWT_VAL(BLE_UTIL_API)
/**
* Set Data Related Address Changes Param
*
* @param adv_handle Advertising handle
* @param change_reason Reasons for refreshing addresses
*
* @return 0 on success; nonzero on failure.
*/
int ble_gap_set_data_related_addr_change_param(uint8_t adv_handle, uint8_t change_reason);
#endif
#if MYNEWT_VAL(BLE_DTM_MODE_TEST)
/**
* Start a test where the DUT generates reference packets at a fixed interval.
*
* @param tx_chan Channel for sending test data,
* tx_channel = (Frequency -2402)/2, tx_channel range = 0x00-0x27,
* Frequency range = 2402 MHz to 2480 MHz.
*
* @param test_data_len Length in bytes of payload data in each packet
* @param payload Packet Payload type. Valid range: 0x00 - 0x07
*
* @return 0 on success; nonzero on failure
*/
int ble_gap_dtm_tx_start(uint8_t tx_chan, uint8_t test_data_len, uint8_t payload);
/**
* Start a test where the DUT receives test reference packets at a fixed interval.
*
* @param rx_chan Channel for test data reception,
* rx_channel = (Frequency -2402)/2, tx_channel range = 0x00-0x27,
* Frequency range = 2402 MHz to 2480 MHz.
*
* @return 0 on success; nonzero on failure
*/
int ble_gap_dtm_rx_start(uint8_t rx_chan);
/**
* Stop any test which is in progress
*
* @return 0 on success; nonzero on failure
*/
int ble_gap_dtm_stop(void);
/**
* Start a test where the DUT generates reference packets at a fixed interval.
*
* @param tx_chan Channel for sending test data,
* tx_channel = (Frequency -2402)/2, tx_channel range = 0x00-0x27,
* Frequency range: 2402 MHz to 2480 MHz
*
* @param test_data_len Length in bytes of payload data in each packet
* @param payload Packet payload type. Valid range: 0x00 - 0x07
* @param phy Phy used by transmitter 1M phy: 0x01, 2M phy:0x02, coded phy:0x03.
*
* @return 0 on sucess; nonzero on failure
*/
int ble_gap_dtm_enh_tx_start(uint8_t tx_chan, uint8_t test_data_len, uint8_t payload,
uint8_t phy);
/**
* Start a test where the DUT receives test reference packets at fixed interval
*
* @param rx_chan Channel for test data reception,
* rx_channel = (Frequency -2402)/2, tx_channel range = 0x00-0x27,
* Frequency range: 2402 MHz to 2480 MHz
*
* @param index modulation index, 0x00:standard modulation index, 0x01:stable modulation index
* @param phy Phy type used by the receiver, 1M phy: 0x01, 2M phy:0x02, coded phy:0x03
*
* @return 0 on success; nonzero on failure
*/
int ble_gap_dtm_enh_rx_start(uint8_t rx_chan, uint8_t index, uint8_t phy);
#endif
/**
* Set Read Remote Version Information is used to retrieve the version, manufacturer,
* and subversion information of remote controller after connection established
*
* @param conn_handle Connection handle
* @param version Defines the specification version of the LE Controller
* @param manufacturer Indicates the manufacturer of the remote Controller
* @param subversion Manufacturer specific version
* @return 0 on success; nonzero on failure
*/
int ble_gap_read_rem_ver_info(uint16_t conn_handle, uint8_t *version, uint16_t *manufacturer, uint16_t *subversion);
#if MYNEWT_VAL(BLE_UTIL_API)
/**
* Read local resolvable address command
*
* @param peer_addr_type Peer Identity Address type
*
* @param peer_addr Peer Identity Address
*
* @param out_addr Local Resolvable Address received from controller.
*
* @return 0 on success; nonzero on failure
*/
int ble_gap_rd_local_resolv_addr(uint8_t peer_addr_type, const ble_addr_t *peer_addr,
uint8_t *out_addr);
#endif
/**
* Read local IRK command
*
* @param out_irk Local Identity Resolving Key received from the Host
*
* @return 0 on success; BLE_HS_EINVAL if @param out_irk is NULL
*
*/
int ble_gap_read_local_irk(uint8_t * out_irk);
#if MYNEWT_VAL(BLE_CHANNEL_SOUNDING)
/**
* Set or clear a bit controlled by the host in the link layer featureSet
* stored in the Controller
*
* @param bit_num Bit position in the FeatureSet
*
* @param bit_val The Host feature is disabled or enabled (0 & 1)
*
* return 0 on success; nonzero on failure
*/
int ble_gap_set_host_feat(uint8_t bit_num,uint8_t bit_val);
#endif
#ifdef __cplusplus
}
#endif
/**
* @}
*/
#endif
Reference in New Issue View Git Blame Copy Permalink