Wang Xinglu / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Dependencies:   nRF51822

Dependents:   LinkNode_LIS3DH

Fork of BLE_API by Bluetooth Low Energy

public/Gap.h@686:1962fb48d9ef, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:53:03 2015 +0100
Revision:
686:1962fb48d9ef
Parent:
685:676b116f7be2
Child:
687:85b0a8f457a1
Synchronized with git rev 692fe6d4

Author: Rohit Grover

setup Gap::onConnection()

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 260:ea7f9f14cc15 1 /* mbed Microcontroller Library
rgrover1 260:ea7f9f14cc15 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 260:ea7f9f14cc15 3 *
rgrover1 260:ea7f9f14cc15 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 260:ea7f9f14cc15 5 * you may not use this file except in compliance with the License.
rgrover1 260:ea7f9f14cc15 6 * You may obtain a copy of the License at
rgrover1 260:ea7f9f14cc15 7 *
rgrover1 260:ea7f9f14cc15 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 260:ea7f9f14cc15 9 *
rgrover1 260:ea7f9f14cc15 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 260:ea7f9f14cc15 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 260:ea7f9f14cc15 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 260:ea7f9f14cc15 13 * See the License for the specific language governing permissions and
rgrover1 260:ea7f9f14cc15 14 * limitations under the License.
rgrover1 260:ea7f9f14cc15 15 */
rgrover1 260:ea7f9f14cc15 16
rgrover1 260:ea7f9f14cc15 17 #ifndef __GAP_H__
rgrover1 260:ea7f9f14cc15 18 #define __GAP_H__
rgrover1 260:ea7f9f14cc15 19
rgrover1 674:923c47bd1547 20 #include "GapAdvertisingData.h"
rgrover1 674:923c47bd1547 21 #include "GapAdvertisingParams.h"
rgrover1 674:923c47bd1547 22 #include "GapScanningParams.h"
rgrover1 260:ea7f9f14cc15 23 #include "GapEvents.h"
rgrover1 260:ea7f9f14cc15 24 #include "CallChain.h"
rgrover1 406:cec6778acc66 25 #include "FunctionPointerWithContext.h"
rgrover1 260:ea7f9f14cc15 26
rgrover1 260:ea7f9f14cc15 27 using namespace mbed;
rgrover1 260:ea7f9f14cc15 28
rgrover1 670:5e4aecd9af5b 29 /* Forward declarations for classes which will only be used for pointers or references in the following. */
rgrover1 670:5e4aecd9af5b 30 class GapAdvertisingParams;
rgrover1 670:5e4aecd9af5b 31 class GapScanningParams;
rgrover1 670:5e4aecd9af5b 32 class GapAdvertisingData;
rgrover1 397:9f5bfae7ea50 33
rgrover1 260:ea7f9f14cc15 34 class Gap {
rgrover1 260:ea7f9f14cc15 35 public:
rgrover1 375:9cb0b006227e 36 enum AddressType_t {
rgrover1 260:ea7f9f14cc15 37 ADDR_TYPE_PUBLIC = 0,
rgrover1 260:ea7f9f14cc15 38 ADDR_TYPE_RANDOM_STATIC,
rgrover1 260:ea7f9f14cc15 39 ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE,
rgrover1 260:ea7f9f14cc15 40 ADDR_TYPE_RANDOM_PRIVATE_NON_RESOLVABLE
rgrover1 375:9cb0b006227e 41 };
rgrover1 402:0e714ad205b4 42 typedef enum AddressType_t addr_type_t; /* @Note: deprecated. Use AddressType_t instead. */
rgrover1 260:ea7f9f14cc15 43
rgrover1 260:ea7f9f14cc15 44 static const unsigned ADDR_LEN = 6;
rgrover1 375:9cb0b006227e 45 typedef uint8_t Address_t[ADDR_LEN]; /* 48-bit address, LSB format. */
rgrover1 402:0e714ad205b4 46 typedef Address_t address_t; /* @Note: deprecated. Use Address_t instead. */
rgrover1 260:ea7f9f14cc15 47
rgrover1 684:448cdd97e926 48 enum TimeoutSource_t {
rgrover1 684:448cdd97e926 49 TIMEOUT_SRC_ADVERTISING = 0x00, /**< Advertising timeout. */
rgrover1 684:448cdd97e926 50 TIMEOUT_SRC_SECURITY_REQUEST = 0x01, /**< Security request timeout. */
rgrover1 684:448cdd97e926 51 TIMEOUT_SRC_SCAN = 0x02, /**< Scanning timeout. */
rgrover1 684:448cdd97e926 52 TIMEOUT_SRC_CONN = 0x03, /**< Connection timeout. */
rgrover1 684:448cdd97e926 53 };
rgrover1 684:448cdd97e926 54
rgrover1 260:ea7f9f14cc15 55 /**
rgrover1 260:ea7f9f14cc15 56 * Enumeration for disconnection reasons. The values for these reasons are
rgrover1 260:ea7f9f14cc15 57 * derived from Nordic's implementation; but the reasons are meant to be
rgrover1 260:ea7f9f14cc15 58 * independent of the transport. If you are returned a reason which is not
rgrover1 260:ea7f9f14cc15 59 * covered by this enumeration, then please refer to the underlying
rgrover1 260:ea7f9f14cc15 60 * transport library.
rgrover1 260:ea7f9f14cc15 61 */
rgrover1 260:ea7f9f14cc15 62 enum DisconnectionReason_t {
rgrover1 669:7179b4a5aa7d 63 CONNECTION_TIMEOUT = 0x08,
rgrover1 669:7179b4a5aa7d 64 REMOTE_USER_TERMINATED_CONNECTION = 0x13,
rgrover1 669:7179b4a5aa7d 65 REMOTE_DEV_TERMINATION_DUE_TO_LOW_RESOURCES = 0x14, /**< Remote Device Terminated Connection due to low resources.*/
rgrover1 669:7179b4a5aa7d 66 REMOTE_DEV_TERMINATION_DUE_TO_POWER_OFF = 0x15, /**< Remote Device Terminated Connection due to power off. */
rgrover1 669:7179b4a5aa7d 67 LOCAL_HOST_TERMINATED_CONNECTION = 0x16,
rgrover1 669:7179b4a5aa7d 68 CONN_INTERVAL_UNACCEPTABLE = 0x3B,
rgrover1 260:ea7f9f14cc15 69 };
rgrover1 260:ea7f9f14cc15 70
rgrover1 260:ea7f9f14cc15 71 /* Describes the current state of the device (more than one bit can be set) */
rgrover1 413:4d5fb1522cfb 72 struct GapState_t {
rgrover1 260:ea7f9f14cc15 73 unsigned advertising : 1; /**< peripheral is currently advertising */
rgrover1 260:ea7f9f14cc15 74 unsigned connected : 1; /**< peripheral is connected to a central */
rgrover1 413:4d5fb1522cfb 75 };
rgrover1 260:ea7f9f14cc15 76
rgrover1 567:e4b38e43de7c 77 typedef uint16_t Handle_t;
rgrover1 260:ea7f9f14cc15 78
rgrover1 260:ea7f9f14cc15 79 typedef struct {
rgrover1 260:ea7f9f14cc15 80 uint16_t minConnectionInterval; /**< Minimum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 260:ea7f9f14cc15 81 uint16_t maxConnectionInterval; /**< Maximum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 260:ea7f9f14cc15 82 uint16_t slaveLatency; /**< Slave Latency in number of connection events, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 260:ea7f9f14cc15 83 uint16_t connectionSupervisionTimeout; /**< Connection Supervision Timeout in 10 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 260:ea7f9f14cc15 84 } ConnectionParams_t;
rgrover1 260:ea7f9f14cc15 85
rgrover1 670:5e4aecd9af5b 86 enum Role_t {
rgrover1 670:5e4aecd9af5b 87 PERIPHERAL = 0x1, /**< Peripheral Role. */
rgrover1 670:5e4aecd9af5b 88 CENTRAL = 0x2, /**< Central Role. */
rgrover1 670:5e4aecd9af5b 89 };
rgrover1 670:5e4aecd9af5b 90
rgrover1 670:5e4aecd9af5b 91 struct AdvertisementCallbackParams_t {
rgrover1 670:5e4aecd9af5b 92 Address_t peerAddr;
rgrover1 670:5e4aecd9af5b 93 int8_t rssi;
rgrover1 670:5e4aecd9af5b 94 bool isScanResponse;
rgrover1 680:dabce2969adf 95 GapAdvertisingParams::AdvertisingType_t type;
rgrover1 670:5e4aecd9af5b 96 uint8_t advertisingDataLen;
rgrover1 670:5e4aecd9af5b 97 const uint8_t *advertisingData;
rgrover1 670:5e4aecd9af5b 98 };
rgrover1 670:5e4aecd9af5b 99 typedef FunctionPointerWithContext<const AdvertisementCallbackParams_t *> AdvertisementReportCallback_t;
rgrover1 670:5e4aecd9af5b 100
rgrover1 670:5e4aecd9af5b 101 struct ConnectionCallbackParams_t {
rgrover1 670:5e4aecd9af5b 102 Handle_t handle;
rgrover1 670:5e4aecd9af5b 103 Role_t role;
rgrover1 670:5e4aecd9af5b 104 AddressType_t peerAddrType;
rgrover1 670:5e4aecd9af5b 105 Address_t peerAddr;
rgrover1 670:5e4aecd9af5b 106 AddressType_t ownAddrType;
rgrover1 670:5e4aecd9af5b 107 Address_t ownAddr;
rgrover1 670:5e4aecd9af5b 108 const ConnectionParams_t *connectionParams;
rgrover1 670:5e4aecd9af5b 109
rgrover1 670:5e4aecd9af5b 110 ConnectionCallbackParams_t(Handle_t handleIn,
rgrover1 670:5e4aecd9af5b 111 Role_t roleIn,
rgrover1 670:5e4aecd9af5b 112 AddressType_t peerAddrTypeIn,
rgrover1 670:5e4aecd9af5b 113 const uint8_t *peerAddrIn,
rgrover1 670:5e4aecd9af5b 114 AddressType_t ownAddrTypeIn,
rgrover1 670:5e4aecd9af5b 115 const uint8_t *ownAddrIn,
rgrover1 670:5e4aecd9af5b 116 const ConnectionParams_t *connectionParamsIn) :
rgrover1 670:5e4aecd9af5b 117 handle(handleIn),
rgrover1 670:5e4aecd9af5b 118 role(roleIn),
rgrover1 670:5e4aecd9af5b 119 peerAddrType(peerAddrTypeIn),
rgrover1 670:5e4aecd9af5b 120 peerAddr(),
rgrover1 670:5e4aecd9af5b 121 ownAddrType(ownAddrTypeIn),
rgrover1 670:5e4aecd9af5b 122 ownAddr(),
rgrover1 670:5e4aecd9af5b 123 connectionParams(connectionParamsIn) {
rgrover1 670:5e4aecd9af5b 124 memcpy(peerAddr, peerAddrIn, ADDR_LEN);
rgrover1 670:5e4aecd9af5b 125 memcpy(ownAddr, ownAddrIn, ADDR_LEN);
rgrover1 670:5e4aecd9af5b 126 }
rgrover1 670:5e4aecd9af5b 127 };
rgrover1 670:5e4aecd9af5b 128
rgrover1 567:e4b38e43de7c 129 enum SecurityMode_t {
rgrover1 567:e4b38e43de7c 130 SECURITY_MODE_NO_ACCESS,
rgrover1 567:e4b38e43de7c 131 SECURITY_MODE_ENCRYPTION_OPEN_LINK, /**< require no protection, open link. */
rgrover1 567:e4b38e43de7c 132 SECURITY_MODE_ENCRYPTION_NO_MITM, /**< require encryption, but no MITM protection. */
rgrover1 567:e4b38e43de7c 133 SECURITY_MODE_ENCRYPTION_WITH_MITM, /**< require encryption and MITM protection. */
rgrover1 567:e4b38e43de7c 134 SECURITY_MODE_SIGNED_NO_MITM, /**< require signing or encryption, but no MITM protection. */
rgrover1 567:e4b38e43de7c 135 SECURITY_MODE_SIGNED_WITH_MITM, /**< require signing or encryption, and MITM protection. */
rgrover1 567:e4b38e43de7c 136 };
rgrover1 567:e4b38e43de7c 137
rgrover1 567:e4b38e43de7c 138 /**
rgrover1 567:e4b38e43de7c 139 * @brief Defines possible security status/states.
rgrover1 567:e4b38e43de7c 140 *
rgrover1 567:e4b38e43de7c 141 * @details Defines possible security status/states of a link when requested by getLinkSecurity().
rgrover1 567:e4b38e43de7c 142 */
rgrover1 567:e4b38e43de7c 143 enum LinkSecurityStatus_t {
rgrover1 567:e4b38e43de7c 144 NOT_ENCRYPTED, /**< The link is not secured. */
rgrover1 567:e4b38e43de7c 145 ENCRYPTION_IN_PROGRESS, /**< Link security is being established.*/
rgrover1 567:e4b38e43de7c 146 ENCRYPTED /**< The link is secure.*/
rgrover1 527:493185cebc03 147 };
rgrover1 527:493185cebc03 148
rgrover1 567:e4b38e43de7c 149 enum SecurityIOCapabilities_t {
rgrover1 567:e4b38e43de7c 150 IO_CAPS_DISPLAY_ONLY = 0x00, /**< Display Only. */
rgrover1 567:e4b38e43de7c 151 IO_CAPS_DISPLAY_YESNO = 0x01, /**< Display and Yes/No entry. */
rgrover1 567:e4b38e43de7c 152 IO_CAPS_KEYBOARD_ONLY = 0x02, /**< Keyboard Only. */
rgrover1 567:e4b38e43de7c 153 IO_CAPS_NONE = 0x03, /**< No I/O capabilities. */
rgrover1 567:e4b38e43de7c 154 IO_CAPS_KEYBOARD_DISPLAY = 0x04, /**< Keyboard and Display. */
rgrover1 527:493185cebc03 155 };
rgrover1 527:493185cebc03 156
rgrover1 567:e4b38e43de7c 157 enum SecurityCompletionStatus_t {
rgrover1 567:e4b38e43de7c 158 SEC_STATUS_SUCCESS = 0x00, /**< Procedure completed with success. */
rgrover1 567:e4b38e43de7c 159 SEC_STATUS_TIMEOUT = 0x01, /**< Procedure timed out. */
rgrover1 567:e4b38e43de7c 160 SEC_STATUS_PDU_INVALID = 0x02, /**< Invalid PDU received. */
rgrover1 567:e4b38e43de7c 161 SEC_STATUS_PASSKEY_ENTRY_FAILED = 0x81, /**< Passkey entry failed (user canceled or other). */
rgrover1 567:e4b38e43de7c 162 SEC_STATUS_OOB_NOT_AVAILABLE = 0x82, /**< Out of Band Key not available. */
rgrover1 567:e4b38e43de7c 163 SEC_STATUS_AUTH_REQ = 0x83, /**< Authentication requirements not met. */
rgrover1 567:e4b38e43de7c 164 SEC_STATUS_CONFIRM_VALUE = 0x84, /**< Confirm value failed. */
rgrover1 567:e4b38e43de7c 165 SEC_STATUS_PAIRING_NOT_SUPP = 0x85, /**< Pairing not supported. */
rgrover1 567:e4b38e43de7c 166 SEC_STATUS_ENC_KEY_SIZE = 0x86, /**< Encryption key size. */
rgrover1 567:e4b38e43de7c 167 SEC_STATUS_SMP_CMD_UNSUPPORTED = 0x87, /**< Unsupported SMP command. */
rgrover1 567:e4b38e43de7c 168 SEC_STATUS_UNSPECIFIED = 0x88, /**< Unspecified reason. */
rgrover1 567:e4b38e43de7c 169 SEC_STATUS_REPEATED_ATTEMPTS = 0x89, /**< Too little time elapsed since last attempt. */
rgrover1 567:e4b38e43de7c 170 SEC_STATUS_INVALID_PARAMS = 0x8A, /**< Invalid parameters. */
rgrover1 527:493185cebc03 171 };
rgrover1 527:493185cebc03 172
rgrover1 567:e4b38e43de7c 173 /**
rgrover1 567:e4b38e43de7c 174 * Declaration of type containing a passkey to be used during pairing. This
rgrover1 567:e4b38e43de7c 175 * is passed into initializeSecurity() to specify a pre-programmed passkey
rgrover1 567:e4b38e43de7c 176 * for authentication instead of generating a random one.
rgrover1 567:e4b38e43de7c 177 */
rgrover1 567:e4b38e43de7c 178 static const unsigned PASSKEY_LEN = 6;
rgrover1 567:e4b38e43de7c 179 typedef uint8_t Passkey_t[PASSKEY_LEN]; /**< 6-digit passkey in ASCII ('0'-'9' digits only). */
rgrover1 567:e4b38e43de7c 180
rgrover1 260:ea7f9f14cc15 181 static const uint16_t UNIT_1_25_MS = 1250; /**< Number of microseconds in 1.25 milliseconds. */
rgrover1 398:9d7666c2305f 182 static const uint16_t UNIT_0_625_MS = 625; /**< Number of microseconds in 0.625 milliseconds. */
rgrover1 260:ea7f9f14cc15 183 static uint16_t MSEC_TO_GAP_DURATION_UNITS(uint32_t durationInMillis) {
rgrover1 260:ea7f9f14cc15 184 return (durationInMillis * 1000) / UNIT_1_25_MS;
rgrover1 260:ea7f9f14cc15 185 }
rgrover1 260:ea7f9f14cc15 186 static uint16_t MSEC_TO_ADVERTISEMENT_DURATION_UNITS(uint32_t durationInMillis) {
rgrover1 260:ea7f9f14cc15 187 return (durationInMillis * 1000) / UNIT_0_625_MS;
rgrover1 260:ea7f9f14cc15 188 }
rgrover1 399:1a69d53f00cc 189 static uint16_t ADVERTISEMENT_DURATION_UNITS_TO_MS(uint16_t gapUnits) {
rgrover1 325:501ad8b8bbe5 190 return (gapUnits * UNIT_0_625_MS) / 1000;
rgrover1 325:501ad8b8bbe5 191 }
rgrover1 260:ea7f9f14cc15 192
rgrover1 684:448cdd97e926 193 typedef void (*TimeoutEventCallback_t)(TimeoutSource_t source);
rgrover1 670:5e4aecd9af5b 194 typedef void (*ConnectionEventCallback_t)(const ConnectionCallbackParams_t *params);
rgrover1 567:e4b38e43de7c 195 typedef void (*HandleSpecificEvent_t)(Handle_t handle);
rgrover1 260:ea7f9f14cc15 196 typedef void (*DisconnectionEventCallback_t)(Handle_t, DisconnectionReason_t);
rgrover1 567:e4b38e43de7c 197 typedef void (*RadioNotificationEventCallback_t) (bool radio_active); /* gets passed true for ACTIVE; false for INACTIVE. */
rgrover1 567:e4b38e43de7c 198 typedef void (*SecuritySetupInitiatedCallback_t)(Handle_t, bool allowBonding, bool requireMITM, SecurityIOCapabilities_t iocaps);
rgrover1 567:e4b38e43de7c 199 typedef void (*SecuritySetupCompletedCallback_t)(Handle_t, SecurityCompletionStatus_t status);
rgrover1 567:e4b38e43de7c 200 typedef void (*LinkSecuredCallback_t)(Handle_t handle, SecurityMode_t securityMode);
rgrover1 567:e4b38e43de7c 201 typedef void (*PasskeyDisplayCallback_t)(Handle_t handle, const Passkey_t passkey);
rgrover1 260:ea7f9f14cc15 202
rgrover1 680:dabce2969adf 203 /*
rgrover1 680:dabce2969adf 204 * These functions must be defined in the platform-specific sub-class.
rgrover1 680:dabce2969adf 205 */
rgrover1 669:7179b4a5aa7d 206 public:
rgrover1 680:dabce2969adf 207 /**
rgrover1 680:dabce2969adf 208 * Set the BTLE MAC address and type. Please note that the address format is
rgrover1 680:dabce2969adf 209 * LSB (least significant byte first). Please refer to Address_t.
rgrover1 680:dabce2969adf 210 *
rgrover1 680:dabce2969adf 211 * @return BLE_ERROR_NONE on success.
rgrover1 680:dabce2969adf 212 */
rgrover1 680:dabce2969adf 213 virtual ble_error_t setAddress(AddressType_t type, const Address_t address) = 0;
rgrover1 680:dabce2969adf 214
rgrover1 680:dabce2969adf 215 /**
rgrover1 680:dabce2969adf 216 * Fetch the BTLE MAC address and type.
rgrover1 680:dabce2969adf 217 *
rgrover1 680:dabce2969adf 218 * @return BLE_ERROR_NONE on success.
rgrover1 680:dabce2969adf 219 */
rgrover1 680:dabce2969adf 220 virtual ble_error_t getAddress(AddressType_t *typeP, Address_t address) = 0;
rgrover1 680:dabce2969adf 221
rgrover1 680:dabce2969adf 222 /**
rgrover1 680:dabce2969adf 223 * @return Minimum Advertising interval in milliseconds.
rgrover1 680:dabce2969adf 224 */
rgrover1 680:dabce2969adf 225 virtual uint16_t getMinAdvertisingInterval(void) const = 0;
rgrover1 680:dabce2969adf 226
rgrover1 680:dabce2969adf 227 /**
rgrover1 680:dabce2969adf 228 * @return Minimum Advertising interval in milliseconds for non-connectible mode.
rgrover1 680:dabce2969adf 229 */
rgrover1 680:dabce2969adf 230 virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const = 0;
rgrover1 680:dabce2969adf 231
rgrover1 680:dabce2969adf 232 /**
rgrover1 680:dabce2969adf 233 * @return Maximum Advertising interval in milliseconds.
rgrover1 680:dabce2969adf 234 */
rgrover1 680:dabce2969adf 235 virtual uint16_t getMaxAdvertisingInterval(void) const = 0;
rgrover1 680:dabce2969adf 236
rgrover1 680:dabce2969adf 237 virtual ble_error_t stopAdvertising(void) = 0;
rgrover1 680:dabce2969adf 238
rgrover1 680:dabce2969adf 239 /**
rgrover1 680:dabce2969adf 240 * Stop scanning. The current scanning parameters remain in effect.
rgrover1 680:dabce2969adf 241 *
rgrover1 680:dabce2969adf 242 * @retval BLE_ERROR_NONE if successfully stopped scanning procedure.
rgrover1 680:dabce2969adf 243 */
rgrover1 680:dabce2969adf 244 virtual ble_error_t stopScan() = 0;
rgrover1 680:dabce2969adf 245
rgrover1 680:dabce2969adf 246 /**
rgrover1 680:dabce2969adf 247 * Create a connection (GAP Link Establishment).
rgrover1 680:dabce2969adf 248 *
rgrover1 680:dabce2969adf 249 * @param peerAddr
rgrover1 680:dabce2969adf 250 * 48-bit address, LSB format.
rgrover1 680:dabce2969adf 251 * @param peerAddrType
rgrover1 680:dabce2969adf 252 * Address type of the peer.
rgrover1 680:dabce2969adf 253 * @param connectionParams
rgrover1 680:dabce2969adf 254 * Connection parameters.
rgrover1 680:dabce2969adf 255 * @param scanParams
rgrover1 680:dabce2969adf 256 * Paramters to be used while scanning for the peer.
rgrover1 680:dabce2969adf 257 * @return BLE_ERROR_NONE if connection establishment procedure is started
rgrover1 686:1962fb48d9ef 258 * successfully. The connectionCallback (if set) will be invoked upon
rgrover1 680:dabce2969adf 259 * a connection event.
rgrover1 680:dabce2969adf 260 */
rgrover1 670:5e4aecd9af5b 261 virtual ble_error_t connect(const Address_t peerAddr,
rgrover1 670:5e4aecd9af5b 262 Gap::AddressType_t peerAddrType,
rgrover1 670:5e4aecd9af5b 263 const ConnectionParams_t *connectionParams,
rgrover1 670:5e4aecd9af5b 264 const GapScanningParams *scanParams) = 0;
rgrover1 680:dabce2969adf 265
rgrover1 680:dabce2969adf 266 /**
rgrover1 680:dabce2969adf 267 * This call initiates the disconnection procedure, and its completion will
rgrover1 680:dabce2969adf 268 * be communicated to the application with an invocation of the
rgrover1 680:dabce2969adf 269 * onDisconnection callback.
rgrover1 680:dabce2969adf 270 *
rgrover1 680:dabce2969adf 271 * @param reason
rgrover1 680:dabce2969adf 272 * The reason for disconnection to be sent back to the peer.
rgrover1 680:dabce2969adf 273 */
rgrover1 680:dabce2969adf 274 virtual ble_error_t disconnect(DisconnectionReason_t reason) = 0;
rgrover1 537:00d5affbb2b2 275
rgrover1 680:dabce2969adf 276 /**
rgrover1 680:dabce2969adf 277 * Get the GAP peripheral preferred connection parameters. These are the
rgrover1 680:dabce2969adf 278 * defaults that the peripheral would like to have in a connection. The
rgrover1 680:dabce2969adf 279 * choice of the connection parameters is eventually up to the central.
rgrover1 680:dabce2969adf 280 *
rgrover1 680:dabce2969adf 281 * @param[out] params
rgrover1 680:dabce2969adf 282 * The structure where the parameters will be stored. Memory
rgrover1 680:dabce2969adf 283 * for this is owned by the caller.
rgrover1 680:dabce2969adf 284 *
rgrover1 680:dabce2969adf 285 * @return BLE_ERROR_NONE if the parameters were successfully filled into
rgrover1 680:dabce2969adf 286 * the given structure pointed to by params.
rgrover1 680:dabce2969adf 287 */
rgrover1 680:dabce2969adf 288 virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params) = 0;
rgrover1 680:dabce2969adf 289
rgrover1 680:dabce2969adf 290 /**
rgrover1 680:dabce2969adf 291 * Set the GAP peripheral preferred connection parameters. These are the
rgrover1 680:dabce2969adf 292 * defaults that the peripheral would like to have in a connection. The
rgrover1 680:dabce2969adf 293 * choice of the connection parameters is eventually up to the central.
rgrover1 680:dabce2969adf 294 *
rgrover1 680:dabce2969adf 295 * @param[in] params
rgrover1 680:dabce2969adf 296 * The structure containing the desired parameters.
rgrover1 680:dabce2969adf 297 */
rgrover1 680:dabce2969adf 298 virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params) = 0;
rgrover1 680:dabce2969adf 299
rgrover1 680:dabce2969adf 300 /**
rgrover1 680:dabce2969adf 301 * Update connection parameters while in the peripheral role.
rgrover1 680:dabce2969adf 302 * @details In the peripheral role, this will send the corresponding L2CAP request to the connected peer and wait for
rgrover1 680:dabce2969adf 303 * the central to perform the procedure.
rgrover1 680:dabce2969adf 304 * @param[in] handle
rgrover1 680:dabce2969adf 305 * Connection Handle
rgrover1 680:dabce2969adf 306 * @param[in] params
rgrover1 680:dabce2969adf 307 * Pointer to desired connection parameters. If NULL is provided on a peripheral role,
rgrover1 680:dabce2969adf 308 * the parameters in the PPCP characteristic of the GAP service will be used instead.
rgrover1 680:dabce2969adf 309 */
rgrover1 680:dabce2969adf 310 virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params) = 0;
rgrover1 680:dabce2969adf 311
rgrover1 680:dabce2969adf 312 virtual ble_error_t purgeAllBondingState(void) = 0;
rgrover1 567:e4b38e43de7c 313 virtual ble_error_t getLinkSecurity(Handle_t connectionHandle, LinkSecurityStatus_t *securityStatusP) = 0;
rgrover1 537:00d5affbb2b2 314
rgrover1 680:dabce2969adf 315 /**
rgrover1 680:dabce2969adf 316 * Set the device name characteristic in the GAP service.
rgrover1 680:dabce2969adf 317 * @param[in] deviceName
rgrover1 680:dabce2969adf 318 * The new value for the device-name. This is a UTF-8 encoded, <b>NULL-terminated</b> string.
rgrover1 680:dabce2969adf 319 */
rgrover1 680:dabce2969adf 320 virtual ble_error_t setDeviceName(const uint8_t *deviceName) = 0;
rgrover1 680:dabce2969adf 321
rgrover1 680:dabce2969adf 322 /**
rgrover1 680:dabce2969adf 323 * Get the value of the device name characteristic in the GAP service.
rgrover1 680:dabce2969adf 324 * @param[out] deviceName
rgrover1 680:dabce2969adf 325 * Pointer to an empty buffer where the UTF-8 *non NULL-
rgrover1 680:dabce2969adf 326 * terminated* string will be placed. Set this
rgrover1 680:dabce2969adf 327 * value to NULL in order to obtain the deviceName-length
rgrover1 680:dabce2969adf 328 * from the 'length' parameter.
rgrover1 680:dabce2969adf 329 *
rgrover1 680:dabce2969adf 330 * @param[in/out] lengthP
rgrover1 680:dabce2969adf 331 * (on input) Length of the buffer pointed to by deviceName;
rgrover1 680:dabce2969adf 332 * (on output) the complete device name length (without the
rgrover1 680:dabce2969adf 333 * null terminator).
rgrover1 680:dabce2969adf 334 *
rgrover1 680:dabce2969adf 335 * @note If the device name is longer than the size of the supplied buffer,
rgrover1 680:dabce2969adf 336 * length will return the complete device name length, and not the
rgrover1 680:dabce2969adf 337 * number of bytes actually returned in deviceName. The application may
rgrover1 680:dabce2969adf 338 * use this information to retry with a suitable buffer size.
rgrover1 680:dabce2969adf 339 */
rgrover1 567:e4b38e43de7c 340 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP) = 0;
rgrover1 680:dabce2969adf 341
rgrover1 680:dabce2969adf 342 /**
rgrover1 680:dabce2969adf 343 * Set the appearance characteristic in the GAP service.
rgrover1 680:dabce2969adf 344 * @param[in] appearance
rgrover1 680:dabce2969adf 345 * The new value for the device-appearance.
rgrover1 680:dabce2969adf 346 */
rgrover1 680:dabce2969adf 347 virtual ble_error_t setAppearance(GapAdvertisingData::Appearance appearance) = 0;
rgrover1 680:dabce2969adf 348
rgrover1 680:dabce2969adf 349 /**
rgrover1 680:dabce2969adf 350 * Get the appearance characteristic in the GAP service.
rgrover1 680:dabce2969adf 351 * @param[out] appearance
rgrover1 680:dabce2969adf 352 * The new value for the device-appearance.
rgrover1 680:dabce2969adf 353 */
rgrover1 680:dabce2969adf 354 virtual ble_error_t getAppearance(GapAdvertisingData::Appearance *appearanceP) = 0;
rgrover1 534:754131484cf1 355
rgrover1 680:dabce2969adf 356 /**
rgrover1 680:dabce2969adf 357 * Set the radio's transmit power.
rgrover1 680:dabce2969adf 358 * @param[in] txPower Radio transmit power in dBm.
rgrover1 680:dabce2969adf 359 */
rgrover1 680:dabce2969adf 360 virtual ble_error_t setTxPower(int8_t txPower) = 0;
rgrover1 680:dabce2969adf 361
rgrover1 680:dabce2969adf 362 /**
rgrover1 680:dabce2969adf 363 * Query the underlying stack for permitted arguments for setTxPower().
rgrover1 680:dabce2969adf 364 *
rgrover1 680:dabce2969adf 365 * @param[out] valueArrayPP
rgrover1 680:dabce2969adf 366 * Out parameter to receive the immutable array of Tx values.
rgrover1 680:dabce2969adf 367 * @param[out] countP
rgrover1 680:dabce2969adf 368 * Out parameter to receive the array's size.
rgrover1 680:dabce2969adf 369 */
rgrover1 680:dabce2969adf 370 virtual void getPermittedTxPowerValues(const int8_t **, size_t *) = 0;
rgrover1 669:7179b4a5aa7d 371
rgrover1 685:676b116f7be2 372 public:
rgrover1 685:676b116f7be2 373 virtual ble_error_t startRadioScan(const GapScanningParams &scanningParams) = 0;
rgrover1 685:676b116f7be2 374
rgrover1 677:09070e7285e5 375 /*
rgrover1 680:dabce2969adf 376 * APIs with non-virtual implementations.
rgrover1 677:09070e7285e5 377 */
rgrover1 677:09070e7285e5 378 public:
rgrover1 680:dabce2969adf 379 /**
rgrover1 680:dabce2969adf 380 * Returns the current GAP state of the device using a bitmask which
rgrover1 680:dabce2969adf 381 * describes whether the device is advertising and/or connected.
rgrover1 680:dabce2969adf 382 */
rgrover1 680:dabce2969adf 383 GapState_t getState(void) const {
rgrover1 680:dabce2969adf 384 return state;
rgrover1 680:dabce2969adf 385 }
rgrover1 680:dabce2969adf 386
rgrover1 680:dabce2969adf 387 /**
rgrover1 680:dabce2969adf 388 * Set the GAP advertising mode to use for this device.
rgrover1 680:dabce2969adf 389 */
rgrover1 680:dabce2969adf 390 void setAdvertisingType(GapAdvertisingParams::AdvertisingType_t advType) {
rgrover1 677:09070e7285e5 391 _advParams.setAdvertisingType(advType);
rgrover1 677:09070e7285e5 392 }
rgrover1 677:09070e7285e5 393
rgrover1 680:dabce2969adf 394 /**
rgrover1 680:dabce2969adf 395 * @param[in] interval
rgrover1 680:dabce2969adf 396 * Advertising interval in units of milliseconds. Advertising
rgrover1 680:dabce2969adf 397 * is disabled if interval is 0. If interval is smaller than
rgrover1 680:dabce2969adf 398 * the minimum supported value, then the minimum supported
rgrover1 680:dabce2969adf 399 * value is used instead. This minimum value can be discovered
rgrover1 680:dabce2969adf 400 * using getMinAdvertisingInterval().
rgrover1 680:dabce2969adf 401 *
rgrover1 680:dabce2969adf 402 * This field must be set to 0 if connectionMode is equal
rgrover1 680:dabce2969adf 403 * to ADV_CONNECTABLE_DIRECTED.
rgrover1 680:dabce2969adf 404 *
rgrover1 680:dabce2969adf 405 * @note: Decreasing this value will allow central devices to detect a
rgrover1 680:dabce2969adf 406 * peripheral faster at the expense of more power being used by the radio
rgrover1 680:dabce2969adf 407 * due to the higher data transmit rate.
rgrover1 680:dabce2969adf 408 *
rgrover1 680:dabce2969adf 409 * @note: This API is now *deprecated* and will be dropped in the future.
rgrover1 680:dabce2969adf 410 * You should use the parallel API from Gap directly. A former call to
rgrover1 680:dabce2969adf 411 * ble.setAdvertisingInterval(...) should now be achieved using
rgrover1 680:dabce2969adf 412 * ble.gap().setAdvertisingInterval(...).
rgrover1 680:dabce2969adf 413 *
rgrover1 680:dabce2969adf 414 * @Note: [WARNING] This API previously used 0.625ms as the unit for its
rgrover1 680:dabce2969adf 415 * 'interval' argument. That required an explicit conversion from
rgrover1 680:dabce2969adf 416 * milliseconds using Gap::MSEC_TO_GAP_DURATION_UNITS(). This conversion is
rgrover1 680:dabce2969adf 417 * no longer required as the new units are milliseconds. Any application
rgrover1 680:dabce2969adf 418 * code depending on the old semantics would need to be updated accordingly.
rgrover1 680:dabce2969adf 419 */
rgrover1 677:09070e7285e5 420 void setAdvertisingInterval(uint16_t interval) {
rgrover1 677:09070e7285e5 421 if (interval == 0) {
rgrover1 677:09070e7285e5 422 stopAdvertising();
rgrover1 677:09070e7285e5 423 } else if (interval < getMinAdvertisingInterval()) {
rgrover1 677:09070e7285e5 424 interval = getMinAdvertisingInterval();
rgrover1 677:09070e7285e5 425 }
rgrover1 677:09070e7285e5 426 _advParams.setInterval(MSEC_TO_ADVERTISEMENT_DURATION_UNITS(interval));
rgrover1 677:09070e7285e5 427 }
rgrover1 677:09070e7285e5 428
rgrover1 680:dabce2969adf 429 /**
rgrover1 680:dabce2969adf 430 * @param[in] timeout
rgrover1 680:dabce2969adf 431 * Advertising timeout (in seconds) between 0x1 and 0x3FFF (1
rgrover1 680:dabce2969adf 432 * and 16383). Use 0 to disable the advertising timeout.
rgrover1 680:dabce2969adf 433 */
rgrover1 680:dabce2969adf 434 void setAdvertisingTimeout(uint16_t timeout) {
rgrover1 680:dabce2969adf 435 _advParams.setTimeout(timeout);
rgrover1 680:dabce2969adf 436 }
rgrover1 680:dabce2969adf 437
rgrover1 680:dabce2969adf 438 /**
rgrover1 680:dabce2969adf 439 * Start advertising.
rgrover1 680:dabce2969adf 440 */
rgrover1 674:923c47bd1547 441 ble_error_t startAdvertising(void) {
rgrover1 677:09070e7285e5 442 setAdvertisingData(); /* update the underlying stack */
rgrover1 675:30aab0f789f6 443 return startAdvertising(_advParams);
rgrover1 674:923c47bd1547 444 }
rgrover1 674:923c47bd1547 445
rgrover1 677:09070e7285e5 446 /**
rgrover1 677:09070e7285e5 447 * Reset any advertising payload prepared from prior calls to
rgrover1 680:dabce2969adf 448 * accumulateAdvertisingPayload(). This automatically propagates the re-
rgrover1 680:dabce2969adf 449 * initialized adv payload to the underlying stack.
rgrover1 677:09070e7285e5 450 *
rgrover1 677:09070e7285e5 451 * Note: This should be followed by a call to setAdvertisingPayload() or
rgrover1 677:09070e7285e5 452 * startAdvertising() before the update takes effect.
rgrover1 677:09070e7285e5 453 */
rgrover1 677:09070e7285e5 454 void clearAdvertisingPayload(void) {
rgrover1 677:09070e7285e5 455 _advPayload.clear();
rgrover1 680:dabce2969adf 456 setAdvertisingData();
rgrover1 677:09070e7285e5 457 }
rgrover1 677:09070e7285e5 458
rgrover1 677:09070e7285e5 459 /**
rgrover1 677:09070e7285e5 460 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 677:09070e7285e5 461 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 677:09070e7285e5 462 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 677:09070e7285e5 463 * small.
rgrover1 677:09070e7285e5 464 *
rgrover1 680:dabce2969adf 465 * @param[in] flags
rgrover1 680:dabce2969adf 466 * The flags to be added. Please refer to
rgrover1 680:dabce2969adf 467 * GapAdvertisingData::Flags for valid flags. Multiple
rgrover1 680:dabce2969adf 468 * flags may be specified in combination.
rgrover1 677:09070e7285e5 469 */
rgrover1 677:09070e7285e5 470 ble_error_t accumulateAdvertisingPayload(uint8_t flags) {
rgrover1 680:dabce2969adf 471 ble_error_t rc;
rgrover1 680:dabce2969adf 472 if ((rc = _advPayload.addFlags(flags)) != BLE_ERROR_NONE) {
rgrover1 680:dabce2969adf 473 return rc;
rgrover1 680:dabce2969adf 474 }
rgrover1 680:dabce2969adf 475
rgrover1 680:dabce2969adf 476 return setAdvertisingData();
rgrover1 677:09070e7285e5 477 }
rgrover1 677:09070e7285e5 478
rgrover1 677:09070e7285e5 479 /**
rgrover1 677:09070e7285e5 480 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 677:09070e7285e5 481 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 677:09070e7285e5 482 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 677:09070e7285e5 483 * small.
rgrover1 677:09070e7285e5 484 *
rgrover1 677:09070e7285e5 485 * @param app
rgrover1 677:09070e7285e5 486 * The appearance of the peripheral.
rgrover1 677:09070e7285e5 487 */
rgrover1 677:09070e7285e5 488 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::Appearance app) {
rgrover1 677:09070e7285e5 489 setAppearance(app);
rgrover1 680:dabce2969adf 490
rgrover1 680:dabce2969adf 491 ble_error_t rc;
rgrover1 680:dabce2969adf 492 if ((rc = _advPayload.addAppearance(app)) != BLE_ERROR_NONE) {
rgrover1 680:dabce2969adf 493 return rc;
rgrover1 680:dabce2969adf 494 }
rgrover1 680:dabce2969adf 495
rgrover1 680:dabce2969adf 496 return setAdvertisingData();
rgrover1 677:09070e7285e5 497 }
rgrover1 677:09070e7285e5 498
rgrover1 677:09070e7285e5 499 /**
rgrover1 677:09070e7285e5 500 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 677:09070e7285e5 501 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
rgrover1 677:09070e7285e5 502 * as an additional 31 bytes if the advertising payload proves to be too
rgrover1 677:09070e7285e5 503 * small.
rgrover1 677:09070e7285e5 504 *
rgrover1 677:09070e7285e5 505 * @param app
rgrover1 677:09070e7285e5 506 * The max transmit power to be used by the controller. This is
rgrover1 677:09070e7285e5 507 * only a hint.
rgrover1 677:09070e7285e5 508 */
rgrover1 677:09070e7285e5 509 ble_error_t accumulateAdvertisingPayloadTxPower(int8_t power) {
rgrover1 680:dabce2969adf 510 ble_error_t rc;
rgrover1 680:dabce2969adf 511 if ((rc = _advPayload.addTxPower(power)) != BLE_ERROR_NONE) {
rgrover1 680:dabce2969adf 512 return rc;
rgrover1 680:dabce2969adf 513 }
rgrover1 680:dabce2969adf 514
rgrover1 680:dabce2969adf 515 return setAdvertisingData();
rgrover1 677:09070e7285e5 516 }
rgrover1 677:09070e7285e5 517
rgrover1 677:09070e7285e5 518 /**
rgrover1 677:09070e7285e5 519 * Accumulate a variable length byte-stream as an AD structure in the
rgrover1 677:09070e7285e5 520 * advertising payload. Please note that the payload is limited to 31 bytes.
rgrover1 677:09070e7285e5 521 * The SCAN_RESPONSE message may be used as an additional 31 bytes if the
rgrover1 677:09070e7285e5 522 * advertising payload proves to be too small.
rgrover1 677:09070e7285e5 523 *
rgrover1 677:09070e7285e5 524 * @param type The type which describes the variable length data.
rgrover1 677:09070e7285e5 525 * @param data data bytes.
rgrover1 677:09070e7285e5 526 * @param len length of data.
rgrover1 677:09070e7285e5 527 */
rgrover1 677:09070e7285e5 528 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
rgrover1 677:09070e7285e5 529 if (type == GapAdvertisingData::COMPLETE_LOCAL_NAME) {
rgrover1 677:09070e7285e5 530 setDeviceName(data);
rgrover1 677:09070e7285e5 531 }
rgrover1 680:dabce2969adf 532
rgrover1 680:dabce2969adf 533 ble_error_t rc;
rgrover1 680:dabce2969adf 534 if ((rc = _advPayload.addData(type, data, len)) != BLE_ERROR_NONE) {
rgrover1 680:dabce2969adf 535 return rc;
rgrover1 680:dabce2969adf 536 }
rgrover1 680:dabce2969adf 537
rgrover1 680:dabce2969adf 538 return setAdvertisingData();
rgrover1 680:dabce2969adf 539 }
rgrover1 680:dabce2969adf 540
rgrover1 680:dabce2969adf 541 /**
rgrover1 680:dabce2969adf 542 * Setup a particular, user-constructed advertisement payload for the
rgrover1 680:dabce2969adf 543 * underlying stack. It would be uncommon for this API to be used directly;
rgrover1 680:dabce2969adf 544 * there are other APIs to build an advertisement payload (see above).
rgrover1 680:dabce2969adf 545 */
rgrover1 680:dabce2969adf 546 ble_error_t setAdvertisingPayload(const GapAdvertisingData &payload) {
rgrover1 680:dabce2969adf 547 _advPayload = payload;
rgrover1 680:dabce2969adf 548 return setAdvertisingData();
rgrover1 680:dabce2969adf 549 }
rgrover1 680:dabce2969adf 550
rgrover1 680:dabce2969adf 551 /**
rgrover1 680:dabce2969adf 552 * @return Read back advertising data. Useful for storing and
rgrover1 680:dabce2969adf 553 * restoring payload.
rgrover1 680:dabce2969adf 554 */
rgrover1 680:dabce2969adf 555 const GapAdvertisingData &getAdvertisingPayload(void) const {
rgrover1 680:dabce2969adf 556 return _advPayload;
rgrover1 677:09070e7285e5 557 }
rgrover1 677:09070e7285e5 558
rgrover1 677:09070e7285e5 559 /**
rgrover1 677:09070e7285e5 560 * Accumulate a variable length byte-stream as an AD structure in the
rgrover1 677:09070e7285e5 561 * scanResponse payload.
rgrover1 677:09070e7285e5 562 *
rgrover1 680:dabce2969adf 563 * @param[in] type The type which describes the variable length data.
rgrover1 680:dabce2969adf 564 * @param[in] data data bytes.
rgrover1 680:dabce2969adf 565 * @param[in] len length of data.
rgrover1 677:09070e7285e5 566 */
rgrover1 677:09070e7285e5 567 ble_error_t accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
rgrover1 680:dabce2969adf 568 ble_error_t rc;
rgrover1 680:dabce2969adf 569 if ((rc = _scanResponse.addData(type, data, len)) != BLE_ERROR_NONE) {
rgrover1 680:dabce2969adf 570 return rc;
rgrover1 680:dabce2969adf 571 }
rgrover1 680:dabce2969adf 572
rgrover1 680:dabce2969adf 573 return setAdvertisingData();
rgrover1 677:09070e7285e5 574 }
rgrover1 677:09070e7285e5 575
rgrover1 677:09070e7285e5 576 /**
rgrover1 677:09070e7285e5 577 * Reset any scan response prepared from prior calls to
rgrover1 677:09070e7285e5 578 * accumulateScanResponse().
rgrover1 677:09070e7285e5 579 *
rgrover1 677:09070e7285e5 580 * Note: This should be followed by a call to setAdvertisingPayload() or
rgrover1 677:09070e7285e5 581 * startAdvertising() before the update takes effect.
rgrover1 677:09070e7285e5 582 */
rgrover1 677:09070e7285e5 583 void clearScanResponse(void) {
rgrover1 677:09070e7285e5 584 _scanResponse.clear();
rgrover1 680:dabce2969adf 585 setAdvertisingData();
rgrover1 680:dabce2969adf 586 }
rgrover1 680:dabce2969adf 587
rgrover1 680:dabce2969adf 588 /**
rgrover1 680:dabce2969adf 589 * Setup parameters for GAP scanning--i.e. observer mode.
rgrover1 680:dabce2969adf 590 * @param[in] interval
rgrover1 680:dabce2969adf 591 * Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 680:dabce2969adf 592 * @param[in] window
rgrover1 680:dabce2969adf 593 * Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 680:dabce2969adf 594 * @param[in] timeout
rgrover1 680:dabce2969adf 595 * Scan timeout (in seconds) between 0x0001 and 0xFFFF, 0x0000 disables timeout.
rgrover1 680:dabce2969adf 596 * @param[in] activeScanning
rgrover1 680:dabce2969adf 597 * Set to True if active-scanning is required. This is used to fetch the
rgrover1 680:dabce2969adf 598 * scan response from a peer if possible.
rgrover1 680:dabce2969adf 599 *
rgrover1 680:dabce2969adf 600 * The scanning window divided by the interval determines the duty cycle for
rgrover1 680:dabce2969adf 601 * scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1 680:dabce2969adf 602 * then the controller will scan for 10 percent of the time. It is possible
rgrover1 680:dabce2969adf 603 * to have the interval and window set to the same value. In this case,
rgrover1 680:dabce2969adf 604 * scanning is continuous, with a change of scanning frequency once every
rgrover1 680:dabce2969adf 605 * interval.
rgrover1 680:dabce2969adf 606 *
rgrover1 680:dabce2969adf 607 * Once the scanning parameters have been configured, scanning can be
rgrover1 680:dabce2969adf 608 * enabled by using startScan().
rgrover1 680:dabce2969adf 609 *
rgrover1 680:dabce2969adf 610 * @Note: The scan interval and window are recommendations to the BLE stack.
rgrover1 680:dabce2969adf 611 */
rgrover1 680:dabce2969adf 612 ble_error_t setScanParams(uint16_t interval = GapScanningParams::SCAN_INTERVAL_MAX,
rgrover1 680:dabce2969adf 613 uint16_t window = GapScanningParams::SCAN_WINDOW_MAX,
rgrover1 680:dabce2969adf 614 uint16_t timeout = 0,
rgrover1 680:dabce2969adf 615 bool activeScanning = false) {
rgrover1 680:dabce2969adf 616 ble_error_t rc;
rgrover1 680:dabce2969adf 617 if (((rc = _scanningParams.setInterval(interval)) == BLE_ERROR_NONE) &&
rgrover1 680:dabce2969adf 618 ((rc = _scanningParams.setWindow(window)) == BLE_ERROR_NONE) &&
rgrover1 680:dabce2969adf 619 ((rc = _scanningParams.setTimeout(timeout)) == BLE_ERROR_NONE)) {
rgrover1 680:dabce2969adf 620 _scanningParams.setActiveScanning(activeScanning);
rgrover1 680:dabce2969adf 621 return BLE_ERROR_NONE;
rgrover1 680:dabce2969adf 622 }
rgrover1 680:dabce2969adf 623
rgrover1 680:dabce2969adf 624 return rc;
rgrover1 677:09070e7285e5 625 }
rgrover1 677:09070e7285e5 626
rgrover1 680:dabce2969adf 627 /**
rgrover1 680:dabce2969adf 628 * Setup the scanInterval parameter for GAP scanning--i.e. observer mode.
rgrover1 680:dabce2969adf 629 * @param[in] interval
rgrover1 680:dabce2969adf 630 * Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 680:dabce2969adf 631 *
rgrover1 680:dabce2969adf 632 * The scanning window divided by the interval determines the duty cycle for
rgrover1 680:dabce2969adf 633 * scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1 680:dabce2969adf 634 * then the controller will scan for 10 percent of the time. It is possible
rgrover1 680:dabce2969adf 635 * to have the interval and window set to the same value. In this case,
rgrover1 680:dabce2969adf 636 * scanning is continuous, with a change of scanning frequency once every
rgrover1 680:dabce2969adf 637 * interval.
rgrover1 680:dabce2969adf 638 *
rgrover1 680:dabce2969adf 639 * Once the scanning parameters have been configured, scanning can be
rgrover1 680:dabce2969adf 640 * enabled by using startScan().
rgrover1 680:dabce2969adf 641 */
rgrover1 680:dabce2969adf 642 ble_error_t setScanInterval(uint16_t interval) {
rgrover1 680:dabce2969adf 643 return _scanningParams.setInterval(interval);
rgrover1 680:dabce2969adf 644 }
rgrover1 674:923c47bd1547 645
rgrover1 680:dabce2969adf 646 /**
rgrover1 680:dabce2969adf 647 * Setup the scanWindow parameter for GAP scanning--i.e. observer mode.
rgrover1 680:dabce2969adf 648 * @param[in] window
rgrover1 680:dabce2969adf 649 * Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 680:dabce2969adf 650 *
rgrover1 680:dabce2969adf 651 * The scanning window divided by the interval determines the duty cycle for
rgrover1 680:dabce2969adf 652 * scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1 680:dabce2969adf 653 * then the controller will scan for 10 percent of the time. It is possible
rgrover1 680:dabce2969adf 654 * to have the interval and window set to the same value. In this case,
rgrover1 680:dabce2969adf 655 * scanning is continuous, with a change of scanning frequency once every
rgrover1 680:dabce2969adf 656 * interval.
rgrover1 680:dabce2969adf 657 *
rgrover1 680:dabce2969adf 658 * Once the scanning parameters have been configured, scanning can be
rgrover1 680:dabce2969adf 659 * enabled by using startScan().
rgrover1 680:dabce2969adf 660 */
rgrover1 680:dabce2969adf 661 ble_error_t setScanWindow(uint16_t window) {
rgrover1 680:dabce2969adf 662 return _scanningParams.setWindow(window);
rgrover1 680:dabce2969adf 663 }
rgrover1 680:dabce2969adf 664
rgrover1 680:dabce2969adf 665 /**
rgrover1 680:dabce2969adf 666 * Setup parameters for GAP scanning--i.e. observer mode.
rgrover1 680:dabce2969adf 667 * @param[in] timeout
rgrover1 680:dabce2969adf 668 * Scan timeout (in seconds) between 0x0001 and 0xFFFF, 0x0000 disables timeout.
rgrover1 680:dabce2969adf 669 *
rgrover1 680:dabce2969adf 670 * Once the scanning parameters have been configured, scanning can be
rgrover1 680:dabce2969adf 671 * enabled by using startScan().
rgrover1 680:dabce2969adf 672 */
rgrover1 680:dabce2969adf 673 ble_error_t setScanTimeout(uint16_t timeout) {
rgrover1 680:dabce2969adf 674 return _scanningParams.setTimeout(timeout);
rgrover1 680:dabce2969adf 675 }
rgrover1 680:dabce2969adf 676
rgrover1 680:dabce2969adf 677 /**
rgrover1 680:dabce2969adf 678 * Setup parameters for GAP scanning--i.e. observer mode.
rgrover1 680:dabce2969adf 679 * @param[in] activeScanning
rgrover1 680:dabce2969adf 680 * Set to True if active-scanning is required. This is used to fetch the
rgrover1 680:dabce2969adf 681 * scan response from a peer if possible.
rgrover1 680:dabce2969adf 682 *
rgrover1 680:dabce2969adf 683 * Once the scanning parameters have been configured, scanning can be
rgrover1 680:dabce2969adf 684 * enabled by using startScan().
rgrover1 680:dabce2969adf 685 */
rgrover1 680:dabce2969adf 686 void setActiveScanning(bool activeScanning) {
rgrover1 680:dabce2969adf 687 _scanningParams.setActiveScanning(activeScanning);
rgrover1 680:dabce2969adf 688 }
rgrover1 680:dabce2969adf 689
rgrover1 680:dabce2969adf 690 /**
rgrover1 680:dabce2969adf 691 * Start scanning (Observer Procedure) based on the parameters currently in
rgrover1 680:dabce2969adf 692 * effect.
rgrover1 680:dabce2969adf 693 *
rgrover1 680:dabce2969adf 694 * @param[in] callback
rgrover1 680:dabce2969adf 695 * The application specific callback to be invoked upon
rgrover1 680:dabce2969adf 696 * receiving every advertisement report. This can be passed in
rgrover1 680:dabce2969adf 697 * as NULL, in which case scanning may not be enabled at all.
rgrover1 680:dabce2969adf 698 */
rgrover1 674:923c47bd1547 699 ble_error_t startScan(void (*callback)(const AdvertisementCallbackParams_t *params)) {
rgrover1 407:ca6b956b33d1 700 ble_error_t err = BLE_ERROR_NONE;
rgrover1 407:ca6b956b33d1 701 if (callback) {
rgrover1 675:30aab0f789f6 702 if ((err = startRadioScan(_scanningParams)) == BLE_ERROR_NONE) {
rgrover1 407:ca6b956b33d1 703 onAdvertisementReport.attach(callback);
rgrover1 407:ca6b956b33d1 704 }
rgrover1 407:ca6b956b33d1 705 }
rgrover1 407:ca6b956b33d1 706
rgrover1 407:ca6b956b33d1 707 return err;
rgrover1 407:ca6b956b33d1 708 }
rgrover1 407:ca6b956b33d1 709
rgrover1 680:dabce2969adf 710 /**
rgrover1 680:dabce2969adf 711 * Same as above, but this takes an (object, method) pair for a callback.
rgrover1 680:dabce2969adf 712 */
rgrover1 407:ca6b956b33d1 713 template<typename T>
rgrover1 674:923c47bd1547 714 ble_error_t startScan(T *object, void (T::*callbackMember)(const AdvertisementCallbackParams_t *params)) {
rgrover1 407:ca6b956b33d1 715 ble_error_t err = BLE_ERROR_NONE;
rgrover1 407:ca6b956b33d1 716 if (object && callbackMember) {
rgrover1 675:30aab0f789f6 717 if ((err = startRadioScan(_scanningParams)) == BLE_ERROR_NONE) {
rgrover1 407:ca6b956b33d1 718 onAdvertisementReport.attach(object, callbackMember);
rgrover1 407:ca6b956b33d1 719 }
rgrover1 407:ca6b956b33d1 720 }
rgrover1 407:ca6b956b33d1 721
rgrover1 407:ca6b956b33d1 722 return err;
rgrover1 407:ca6b956b33d1 723 }
rgrover1 407:ca6b956b33d1 724
rgrover1 680:dabce2969adf 725 private:
rgrover1 680:dabce2969adf 726 ble_error_t setAdvertisingData(void) {
rgrover1 680:dabce2969adf 727 return setAdvertisingData(_advPayload, _scanResponse);
rgrover1 680:dabce2969adf 728 }
rgrover1 680:dabce2969adf 729
rgrover1 680:dabce2969adf 730 private:
rgrover1 680:dabce2969adf 731 virtual ble_error_t setAdvertisingData(const GapAdvertisingData &, const GapAdvertisingData &) = 0;
rgrover1 680:dabce2969adf 732 virtual ble_error_t startAdvertising(const GapAdvertisingParams &) = 0;
rgrover1 680:dabce2969adf 733
rgrover1 680:dabce2969adf 734 public:
rgrover1 680:dabce2969adf 735 /**
rgrover1 680:dabce2969adf 736 * Accessors to read back currently active advertising params.
rgrover1 680:dabce2969adf 737 */
rgrover1 680:dabce2969adf 738 GapAdvertisingParams &getAdvertisingParams(void) {
rgrover1 680:dabce2969adf 739 return _advParams;
rgrover1 680:dabce2969adf 740 }
rgrover1 680:dabce2969adf 741 const GapAdvertisingParams &getAdvertisingParams(void) const {
rgrover1 680:dabce2969adf 742 return _advParams;
rgrover1 680:dabce2969adf 743 }
rgrover1 680:dabce2969adf 744
rgrover1 680:dabce2969adf 745 /**
rgrover1 680:dabce2969adf 746 * Setup a particular, user-constructed set of advertisement parameters for
rgrover1 680:dabce2969adf 747 * the underlying stack. It would be uncommon for this API to be used
rgrover1 680:dabce2969adf 748 * directly; there are other APIs to tweak advertisement parameters
rgrover1 680:dabce2969adf 749 * individually.
rgrover1 680:dabce2969adf 750 */
rgrover1 680:dabce2969adf 751 void setAdvertisingParams(const GapAdvertisingParams &newParams) {
rgrover1 680:dabce2969adf 752 _advParams = newParams;
rgrover1 680:dabce2969adf 753 }
rgrover1 680:dabce2969adf 754
rgrover1 684:448cdd97e926 755 /* Event callback handlers */
rgrover1 669:7179b4a5aa7d 756 public:
rgrover1 684:448cdd97e926 757 /**
rgrover1 684:448cdd97e926 758 * Setup a callback for timeout events. Refer to TimeoutSource_t for
rgrover1 684:448cdd97e926 759 * possible event types.
rgrover1 684:448cdd97e926 760 */
rgrover1 684:448cdd97e926 761 void onTimeout(TimeoutEventCallback_t callback) {timeoutCallback = callback;}
rgrover1 684:448cdd97e926 762
rgrover1 686:1962fb48d9ef 763 /**
rgrover1 686:1962fb48d9ef 764 * Setup a callback for connection events. Refer to ConnectionEventCallback_t.
rgrover1 686:1962fb48d9ef 765 */
rgrover1 686:1962fb48d9ef 766 void onConnection(ConnectionEventCallback_t callback) {connectionCallback = callback;}
rgrover1 260:ea7f9f14cc15 767
rgrover1 260:ea7f9f14cc15 768 /**
rgrover1 260:ea7f9f14cc15 769 * Set the application callback for disconnection events.
rgrover1 260:ea7f9f14cc15 770 * @param callback
rgrover1 260:ea7f9f14cc15 771 * Pointer to the unique callback.
rgrover1 260:ea7f9f14cc15 772 */
rgrover1 567:e4b38e43de7c 773 void setOnDisconnection(DisconnectionEventCallback_t callback) {onDisconnection = callback;}
rgrover1 567:e4b38e43de7c 774
rgrover1 567:e4b38e43de7c 775 /**
rgrover1 567:e4b38e43de7c 776 * Set the application callback for radio-notification events.
rgrover1 567:e4b38e43de7c 777 * @param callback
rgrover1 567:e4b38e43de7c 778 * Handler to be executed in response to a radio notification event.
rgrover1 567:e4b38e43de7c 779 */
rgrover1 567:e4b38e43de7c 780 virtual void setOnRadioNotification(RadioNotificationEventCallback_t callback) {onRadioNotification = callback;}
rgrover1 567:e4b38e43de7c 781
rgrover1 567:e4b38e43de7c 782 /**
rgrover1 567:e4b38e43de7c 783 * To indicate that security procedure for link has started.
rgrover1 567:e4b38e43de7c 784 */
rgrover1 567:e4b38e43de7c 785 virtual void setOnSecuritySetupInitiated(SecuritySetupInitiatedCallback_t callback) {onSecuritySetupInitiated = callback;}
rgrover1 567:e4b38e43de7c 786
rgrover1 567:e4b38e43de7c 787 /**
rgrover1 567:e4b38e43de7c 788 * To indicate that security procedure for link has completed.
rgrover1 567:e4b38e43de7c 789 */
rgrover1 567:e4b38e43de7c 790 virtual void setOnSecuritySetupCompleted(SecuritySetupCompletedCallback_t callback) {onSecuritySetupCompleted = callback;}
rgrover1 567:e4b38e43de7c 791
rgrover1 567:e4b38e43de7c 792 /**
rgrover1 567:e4b38e43de7c 793 * To indicate that link with the peer is secured. For bonded devices,
rgrover1 567:e4b38e43de7c 794 * subsequent re-connections with bonded peer will result only in this callback
rgrover1 567:e4b38e43de7c 795 * when the link is secured and setup procedures will not occur unless the
rgrover1 567:e4b38e43de7c 796 * bonding information is either lost or deleted on either or both sides.
rgrover1 567:e4b38e43de7c 797 */
rgrover1 567:e4b38e43de7c 798 virtual void setOnLinkSecured(LinkSecuredCallback_t callback) {onLinkSecured = callback;}
rgrover1 567:e4b38e43de7c 799
rgrover1 567:e4b38e43de7c 800 /**
rgrover1 567:e4b38e43de7c 801 * To indicate that device context is stored persistently.
rgrover1 567:e4b38e43de7c 802 */
rgrover1 567:e4b38e43de7c 803 virtual void setOnSecurityContextStored(HandleSpecificEvent_t callback) {onSecurityContextStored = callback;}
rgrover1 567:e4b38e43de7c 804
rgrover1 567:e4b38e43de7c 805 /**
rgrover1 567:e4b38e43de7c 806 * To set the callback for when the passkey needs to be displayed on a peripheral with DISPLAY capability.
rgrover1 567:e4b38e43de7c 807 */
rgrover1 567:e4b38e43de7c 808 virtual void setOnPasskeyDisplay(PasskeyDisplayCallback_t callback) {onPasskeyDisplay = callback;}
rgrover1 544:840f428d18c7 809
rgrover1 544:840f428d18c7 810 /**
rgrover1 544:840f428d18c7 811 * Append to a chain of callbacks to be invoked upon disconnection; these
rgrover1 544:840f428d18c7 812 * callbacks receive no context and are therefore different from the
rgrover1 567:e4b38e43de7c 813 * onDisconnection callback.
rgrover1 544:840f428d18c7 814 * @param callback
rgrover1 544:840f428d18c7 815 * function pointer to be invoked upon disconnection; receives no context.
rgrover1 567:e4b38e43de7c 816 *
rgrover1 567:e4b38e43de7c 817 * @note the disconnection CallChain should have been merged with
rgrover1 567:e4b38e43de7c 818 * onDisconnctionCallback; but this was not possible because
rgrover1 567:e4b38e43de7c 819 * FunctionPointer (which is a building block for CallChain) doesn't
rgrover1 567:e4b38e43de7c 820 * accept variadic templates.
rgrover1 544:840f428d18c7 821 */
rgrover1 544:840f428d18c7 822 template<typename T>
rgrover1 544:840f428d18c7 823 void addToDisconnectionCallChain(T *tptr, void (T::*mptr)(void)) {disconnectionCallChain.add(tptr, mptr);}
rgrover1 260:ea7f9f14cc15 824
rgrover1 260:ea7f9f14cc15 825 protected:
rgrover1 349:b8b2b3973c47 826 Gap() :
rgrover1 675:30aab0f789f6 827 _advParams(),
rgrover1 675:30aab0f789f6 828 _advPayload(),
rgrover1 675:30aab0f789f6 829 _scanningParams(),
rgrover1 675:30aab0f789f6 830 _scanResponse(),
rgrover1 349:b8b2b3973c47 831 state(),
rgrover1 684:448cdd97e926 832 timeoutCallback(NULL),
rgrover1 686:1962fb48d9ef 833 connectionCallback(NULL),
rgrover1 567:e4b38e43de7c 834 onDisconnection(NULL),
rgrover1 567:e4b38e43de7c 835 onRadioNotification(),
rgrover1 567:e4b38e43de7c 836 onSecuritySetupInitiated(),
rgrover1 567:e4b38e43de7c 837 onSecuritySetupCompleted(),
rgrover1 567:e4b38e43de7c 838 onLinkSecured(),
rgrover1 567:e4b38e43de7c 839 onSecurityContextStored(),
rgrover1 567:e4b38e43de7c 840 onPasskeyDisplay(),
rgrover1 382:dcd0428dadb0 841 onAdvertisementReport(),
rgrover1 349:b8b2b3973c47 842 disconnectionCallChain() {
rgrover1 675:30aab0f789f6 843 _advPayload.clear();
rgrover1 675:30aab0f789f6 844 _scanResponse.clear();
rgrover1 260:ea7f9f14cc15 845 }
rgrover1 260:ea7f9f14cc15 846
rgrover1 260:ea7f9f14cc15 847 public:
rgrover1 670:5e4aecd9af5b 848 void processConnectionEvent(Handle_t handle,
rgrover1 670:5e4aecd9af5b 849 Role_t role,
rgrover1 670:5e4aecd9af5b 850 AddressType_t peerAddrType,
rgrover1 670:5e4aecd9af5b 851 const Address_t peerAddr,
rgrover1 670:5e4aecd9af5b 852 AddressType_t ownAddrType,
rgrover1 670:5e4aecd9af5b 853 const Address_t ownAddr,
rgrover1 670:5e4aecd9af5b 854 const ConnectionParams_t *connectionParams) {
rgrover1 260:ea7f9f14cc15 855 state.connected = 1;
rgrover1 686:1962fb48d9ef 856 if (connectionCallback) {
rgrover1 670:5e4aecd9af5b 857 ConnectionCallbackParams_t callbackParams(handle, role, peerAddrType, peerAddr, ownAddrType, ownAddr, connectionParams);
rgrover1 686:1962fb48d9ef 858 connectionCallback(&callbackParams);
rgrover1 260:ea7f9f14cc15 859 }
rgrover1 260:ea7f9f14cc15 860 }
rgrover1 260:ea7f9f14cc15 861
rgrover1 260:ea7f9f14cc15 862 void processDisconnectionEvent(Handle_t handle, DisconnectionReason_t reason) {
rgrover1 260:ea7f9f14cc15 863 state.connected = 0;
rgrover1 567:e4b38e43de7c 864 if (onDisconnection) {
rgrover1 567:e4b38e43de7c 865 onDisconnection(handle, reason);
rgrover1 260:ea7f9f14cc15 866 }
rgrover1 260:ea7f9f14cc15 867 disconnectionCallChain.call();
rgrover1 260:ea7f9f14cc15 868 }
rgrover1 260:ea7f9f14cc15 869
rgrover1 567:e4b38e43de7c 870 void processSecuritySetupInitiatedEvent(Handle_t handle, bool allowBonding, bool requireMITM, SecurityIOCapabilities_t iocaps) {
rgrover1 567:e4b38e43de7c 871 if (onSecuritySetupInitiated) {
rgrover1 567:e4b38e43de7c 872 onSecuritySetupInitiated(handle, allowBonding, requireMITM, iocaps);
rgrover1 567:e4b38e43de7c 873 }
rgrover1 567:e4b38e43de7c 874 }
rgrover1 567:e4b38e43de7c 875
rgrover1 567:e4b38e43de7c 876 void processSecuritySetupCompletedEvent(Handle_t handle, SecurityCompletionStatus_t status) {
rgrover1 567:e4b38e43de7c 877 if (onSecuritySetupCompleted) {
rgrover1 567:e4b38e43de7c 878 onSecuritySetupCompleted(handle, status);
rgrover1 567:e4b38e43de7c 879 }
rgrover1 567:e4b38e43de7c 880 }
rgrover1 567:e4b38e43de7c 881
rgrover1 567:e4b38e43de7c 882 void processLinkSecuredEvent(Handle_t handle, SecurityMode_t securityMode) {
rgrover1 567:e4b38e43de7c 883 if (onLinkSecured) {
rgrover1 567:e4b38e43de7c 884 onLinkSecured(handle, securityMode);
rgrover1 567:e4b38e43de7c 885 }
rgrover1 567:e4b38e43de7c 886 }
rgrover1 567:e4b38e43de7c 887
rgrover1 567:e4b38e43de7c 888 void processSecurityContextStoredEvent(Handle_t handle) {
rgrover1 567:e4b38e43de7c 889 if (onSecurityContextStored) {
rgrover1 567:e4b38e43de7c 890 onSecurityContextStored(handle);
rgrover1 567:e4b38e43de7c 891 }
rgrover1 567:e4b38e43de7c 892 }
rgrover1 567:e4b38e43de7c 893
rgrover1 567:e4b38e43de7c 894 void processPasskeyDisplayEvent(Handle_t handle, const Passkey_t passkey) {
rgrover1 567:e4b38e43de7c 895 if (onPasskeyDisplay) {
rgrover1 567:e4b38e43de7c 896 onPasskeyDisplay(handle, passkey);
rgrover1 567:e4b38e43de7c 897 }
rgrover1 567:e4b38e43de7c 898 }
rgrover1 567:e4b38e43de7c 899
rgrover1 680:dabce2969adf 900 void processAdvertisementReport(const Address_t peerAddr,
rgrover1 680:dabce2969adf 901 int8_t rssi,
rgrover1 680:dabce2969adf 902 bool isScanResponse,
rgrover1 680:dabce2969adf 903 GapAdvertisingParams::AdvertisingType_t type,
rgrover1 680:dabce2969adf 904 uint8_t advertisingDataLen,
rgrover1 680:dabce2969adf 905 const uint8_t *advertisingData) {
rgrover1 406:cec6778acc66 906 AdvertisementCallbackParams_t params;
rgrover1 406:cec6778acc66 907 memcpy(params.peerAddr, peerAddr, ADDR_LEN);
rgrover1 406:cec6778acc66 908 params.rssi = rssi;
rgrover1 406:cec6778acc66 909 params.isScanResponse = isScanResponse;
rgrover1 406:cec6778acc66 910 params.type = type;
rgrover1 406:cec6778acc66 911 params.advertisingDataLen = advertisingDataLen;
rgrover1 406:cec6778acc66 912 params.advertisingData = advertisingData;
rgrover1 406:cec6778acc66 913 onAdvertisementReport.call(&params);
rgrover1 382:dcd0428dadb0 914 }
rgrover1 382:dcd0428dadb0 915
rgrover1 684:448cdd97e926 916 void processTimeoutEvent(TimeoutSource_t source) {
rgrover1 684:448cdd97e926 917 if (timeoutCallback) {
rgrover1 684:448cdd97e926 918 timeoutCallback(source);
rgrover1 260:ea7f9f14cc15 919 }
rgrover1 260:ea7f9f14cc15 920 }
rgrover1 260:ea7f9f14cc15 921
rgrover1 260:ea7f9f14cc15 922 protected:
rgrover1 675:30aab0f789f6 923 GapAdvertisingParams _advParams;
rgrover1 675:30aab0f789f6 924 GapAdvertisingData _advPayload;
rgrover1 675:30aab0f789f6 925 GapScanningParams _scanningParams;
rgrover1 675:30aab0f789f6 926 GapAdvertisingData _scanResponse;
rgrover1 674:923c47bd1547 927
rgrover1 363:a3d59a6e5da0 928 GapState_t state;
rgrover1 260:ea7f9f14cc15 929
rgrover1 337:e7c2eb38f5cc 930 protected:
rgrover1 684:448cdd97e926 931 TimeoutEventCallback_t timeoutCallback;
rgrover1 686:1962fb48d9ef 932 ConnectionEventCallback_t connectionCallback;
rgrover1 567:e4b38e43de7c 933 DisconnectionEventCallback_t onDisconnection;
rgrover1 567:e4b38e43de7c 934 RadioNotificationEventCallback_t onRadioNotification;
rgrover1 567:e4b38e43de7c 935 SecuritySetupInitiatedCallback_t onSecuritySetupInitiated;
rgrover1 567:e4b38e43de7c 936 SecuritySetupCompletedCallback_t onSecuritySetupCompleted;
rgrover1 567:e4b38e43de7c 937 LinkSecuredCallback_t onLinkSecured;
rgrover1 567:e4b38e43de7c 938 HandleSpecificEvent_t onSecurityContextStored;
rgrover1 567:e4b38e43de7c 939 PasskeyDisplayCallback_t onPasskeyDisplay;
rgrover1 385:6e66d1c6de00 940 AdvertisementReportCallback_t onAdvertisementReport;
rgrover1 363:a3d59a6e5da0 941 CallChain disconnectionCallChain;
rgrover1 260:ea7f9f14cc15 942
rgrover1 260:ea7f9f14cc15 943 private:
rgrover1 260:ea7f9f14cc15 944 /* disallow copy and assignment */
rgrover1 260:ea7f9f14cc15 945 Gap(const Gap &);
rgrover1 260:ea7f9f14cc15 946 Gap& operator=(const Gap &);
rgrover1 260:ea7f9f14cc15 947 };
rgrover1 260:ea7f9f14cc15 948
rgrover1 260:ea7f9f14cc15 949 #endif // ifndef __GAP_H__