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@532:a709cfc1500d, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:52:07 2015 +0100
Revision:
532:a709cfc1500d
Parent:
531:bdcd44b03974
Child:
533:c2aafeedaf8c
Synchronized with git rev f3de0034

Author: Rohit Grover

rename members within GAP with an underscore prefix

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 531:bdcd44b03974 20 #include "GapAdvertisingData.h"
rgrover1 531:bdcd44b03974 21 #include "GapAdvertisingParams.h"
rgrover1 531:bdcd44b03974 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 527:493185cebc03 29 /* Forward declarations for classes which will only be used for pointers or references in the following. */
rgrover1 527:493185cebc03 30 class GapAdvertisingParams;
rgrover1 527:493185cebc03 31 class GapScanningParams;
rgrover1 527:493185cebc03 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 380:2109a08c311c 48 enum AdvertisementType_t {
rgrover1 380:2109a08c311c 49 ADV_IND = 0x00, /**< Connectable undirected. */
rgrover1 380:2109a08c311c 50 ADV_DIRECT_IND = 0x01, /**< Connectable directed. */
rgrover1 380:2109a08c311c 51 ADV_SCAN_IND = 0x02, /**< Scannable undirected. */
rgrover1 380:2109a08c311c 52 ADV_NONCONN_IND = 0x03, /**< Non connectable undirected. */
rgrover1 380:2109a08c311c 53 };
rgrover1 380:2109a08c311c 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 526:caa67c3187a0 63 CONNECTION_TIMEOUT = 0x08,
rgrover1 526:caa67c3187a0 64 REMOTE_USER_TERMINATED_CONNECTION = 0x13,
rgrover1 526:caa67c3187a0 65 REMOTE_DEV_TERMINATION_DUE_TO_LOW_RESOURCES = 0x14, /**< Remote Device Terminated Connection due to low resources.*/
rgrover1 526:caa67c3187a0 66 REMOTE_DEV_TERMINATION_DUE_TO_POWER_OFF = 0x15, /**< Remote Device Terminated Connection due to power off. */
rgrover1 526:caa67c3187a0 67 LOCAL_HOST_TERMINATED_CONNECTION = 0x16,
rgrover1 526:caa67c3187a0 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 260:ea7f9f14cc15 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 527:493185cebc03 86 enum Role_t {
rgrover1 527:493185cebc03 87 PERIPHERAL = 0x1, /**< Peripheral Role. */
rgrover1 527:493185cebc03 88 CENTRAL = 0x2, /**< Central Role. */
rgrover1 527:493185cebc03 89 };
rgrover1 527:493185cebc03 90
rgrover1 527:493185cebc03 91 struct AdvertisementCallbackParams_t {
rgrover1 527:493185cebc03 92 Address_t peerAddr;
rgrover1 527:493185cebc03 93 int8_t rssi;
rgrover1 527:493185cebc03 94 bool isScanResponse;
rgrover1 527:493185cebc03 95 AdvertisementType_t type;
rgrover1 527:493185cebc03 96 uint8_t advertisingDataLen;
rgrover1 527:493185cebc03 97 const uint8_t *advertisingData;
rgrover1 527:493185cebc03 98 };
rgrover1 527:493185cebc03 99 typedef FunctionPointerWithContext<const AdvertisementCallbackParams_t *> AdvertisementReportCallback_t;
rgrover1 527:493185cebc03 100
rgrover1 527:493185cebc03 101 struct ConnectionCallbackParams_t {
rgrover1 527:493185cebc03 102 Handle_t handle;
rgrover1 527:493185cebc03 103 Role_t role;
rgrover1 527:493185cebc03 104 AddressType_t peerAddrType;
rgrover1 527:493185cebc03 105 Address_t peerAddr;
rgrover1 527:493185cebc03 106 AddressType_t ownAddrType;
rgrover1 527:493185cebc03 107 Address_t ownAddr;
rgrover1 527:493185cebc03 108 const ConnectionParams_t *connectionParams;
rgrover1 527:493185cebc03 109
rgrover1 527:493185cebc03 110 ConnectionCallbackParams_t(Handle_t handleIn,
rgrover1 527:493185cebc03 111 Role_t roleIn,
rgrover1 527:493185cebc03 112 AddressType_t peerAddrTypeIn,
rgrover1 527:493185cebc03 113 const uint8_t *peerAddrIn,
rgrover1 527:493185cebc03 114 AddressType_t ownAddrTypeIn,
rgrover1 527:493185cebc03 115 const uint8_t *ownAddrIn,
rgrover1 527:493185cebc03 116 const ConnectionParams_t *connectionParamsIn) :
rgrover1 527:493185cebc03 117 handle(handleIn),
rgrover1 527:493185cebc03 118 role(roleIn),
rgrover1 527:493185cebc03 119 peerAddrType(peerAddrTypeIn),
rgrover1 527:493185cebc03 120 peerAddr(),
rgrover1 527:493185cebc03 121 ownAddrType(ownAddrTypeIn),
rgrover1 527:493185cebc03 122 ownAddr(),
rgrover1 527:493185cebc03 123 connectionParams(connectionParamsIn) {
rgrover1 527:493185cebc03 124 memcpy(peerAddr, peerAddrIn, ADDR_LEN);
rgrover1 527:493185cebc03 125 memcpy(ownAddr, ownAddrIn, ADDR_LEN);
rgrover1 527:493185cebc03 126 }
rgrover1 527:493185cebc03 127 };
rgrover1 527:493185cebc03 128
rgrover1 360:7d37e1adef33 129 enum SecurityMode_t {
rgrover1 361:9686f5c882fa 130 SECURITY_MODE_NO_ACCESS,
rgrover1 372:0db007a23f71 131 SECURITY_MODE_ENCRYPTION_OPEN_LINK, /**< require no protection, open link. */
rgrover1 372:0db007a23f71 132 SECURITY_MODE_ENCRYPTION_NO_MITM, /**< require encryption, but no MITM protection. */
rgrover1 372:0db007a23f71 133 SECURITY_MODE_ENCRYPTION_WITH_MITM, /**< require encryption and MITM protection. */
rgrover1 372:0db007a23f71 134 SECURITY_MODE_SIGNED_NO_MITM, /**< require signing or encryption, but no MITM protection. */
rgrover1 372:0db007a23f71 135 SECURITY_MODE_SIGNED_WITH_MITM, /**< require signing or encryption, and MITM protection. */
rgrover1 360:7d37e1adef33 136 };
rgrover1 360:7d37e1adef33 137
rgrover1 352:79d7cb60ae27 138 /**
rgrover1 352:79d7cb60ae27 139 * @brief Defines possible security status/states.
rgrover1 352:79d7cb60ae27 140 *
rgrover1 352:79d7cb60ae27 141 * @details Defines possible security status/states of a link when requested by getLinkSecurity().
rgrover1 352:79d7cb60ae27 142 */
rgrover1 352:79d7cb60ae27 143 enum LinkSecurityStatus_t {
rgrover1 352:79d7cb60ae27 144 NOT_ENCRYPTED, /**< The link is not secured. */
rgrover1 352:79d7cb60ae27 145 ENCRYPTION_IN_PROGRESS, /**< Link security is being established.*/
rgrover1 352:79d7cb60ae27 146 ENCRYPTED /**< The link is secure.*/
rgrover1 352:79d7cb60ae27 147 };
rgrover1 352:79d7cb60ae27 148
rgrover1 357:d4bb5d2b837a 149 enum SecurityIOCapabilities_t {
rgrover1 357:d4bb5d2b837a 150 IO_CAPS_DISPLAY_ONLY = 0x00, /**< Display Only. */
rgrover1 357:d4bb5d2b837a 151 IO_CAPS_DISPLAY_YESNO = 0x01, /**< Display and Yes/No entry. */
rgrover1 357:d4bb5d2b837a 152 IO_CAPS_KEYBOARD_ONLY = 0x02, /**< Keyboard Only. */
rgrover1 357:d4bb5d2b837a 153 IO_CAPS_NONE = 0x03, /**< No I/O capabilities. */
rgrover1 357:d4bb5d2b837a 154 IO_CAPS_KEYBOARD_DISPLAY = 0x04, /**< Keyboard and Display. */
rgrover1 357:d4bb5d2b837a 155 };
rgrover1 357:d4bb5d2b837a 156
rgrover1 359:611485c370f5 157 enum SecurityCompletionStatus_t {
rgrover1 359:611485c370f5 158 SEC_STATUS_SUCCESS = 0x00, /**< Procedure completed with success. */
rgrover1 359:611485c370f5 159 SEC_STATUS_TIMEOUT = 0x01, /**< Procedure timed out. */
rgrover1 359:611485c370f5 160 SEC_STATUS_PDU_INVALID = 0x02, /**< Invalid PDU received. */
rgrover1 367:c3f4ad55ed33 161 SEC_STATUS_PASSKEY_ENTRY_FAILED = 0x81, /**< Passkey entry failed (user canceled or other). */
rgrover1 359:611485c370f5 162 SEC_STATUS_OOB_NOT_AVAILABLE = 0x82, /**< Out of Band Key not available. */
rgrover1 359:611485c370f5 163 SEC_STATUS_AUTH_REQ = 0x83, /**< Authentication requirements not met. */
rgrover1 359:611485c370f5 164 SEC_STATUS_CONFIRM_VALUE = 0x84, /**< Confirm value failed. */
rgrover1 359:611485c370f5 165 SEC_STATUS_PAIRING_NOT_SUPP = 0x85, /**< Pairing not supported. */
rgrover1 359:611485c370f5 166 SEC_STATUS_ENC_KEY_SIZE = 0x86, /**< Encryption key size. */
rgrover1 359:611485c370f5 167 SEC_STATUS_SMP_CMD_UNSUPPORTED = 0x87, /**< Unsupported SMP command. */
rgrover1 359:611485c370f5 168 SEC_STATUS_UNSPECIFIED = 0x88, /**< Unspecified reason. */
rgrover1 359:611485c370f5 169 SEC_STATUS_REPEATED_ATTEMPTS = 0x89, /**< Too little time elapsed since last attempt. */
rgrover1 359:611485c370f5 170 SEC_STATUS_INVALID_PARAMS = 0x8A, /**< Invalid parameters. */
rgrover1 359:611485c370f5 171 };
rgrover1 359:611485c370f5 172
rgrover1 357:d4bb5d2b837a 173 /**
rgrover1 357:d4bb5d2b837a 174 * Declaration of type containing a passkey to be used during pairing. This
rgrover1 357:d4bb5d2b837a 175 * is passed into initializeSecurity() to specify a pre-programmed passkey
rgrover1 357:d4bb5d2b837a 176 * for authentication instead of generating a random one.
rgrover1 357:d4bb5d2b837a 177 */
rgrover1 357:d4bb5d2b837a 178 static const unsigned PASSKEY_LEN = 6;
rgrover1 357:d4bb5d2b837a 179 typedef uint8_t Passkey_t[PASSKEY_LEN]; /**< 6-digit passkey in ASCII ('0'-'9' digits only). */
rgrover1 357:d4bb5d2b837a 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 260:ea7f9f14cc15 193 typedef void (*EventCallback_t)(void);
rgrover1 527:493185cebc03 194 typedef void (*ConnectionEventCallback_t)(const ConnectionCallbackParams_t *params);
rgrover1 349:b8b2b3973c47 195 typedef void (*HandleSpecificEvent_t)(Handle_t handle);
rgrover1 260:ea7f9f14cc15 196 typedef void (*DisconnectionEventCallback_t)(Handle_t, DisconnectionReason_t);
rgrover1 341:8a104d9d80c1 197 typedef void (*RadioNotificationEventCallback_t) (bool radio_active); /* gets passed true for ACTIVE; false for INACTIVE. */
rgrover1 363:a3d59a6e5da0 198 typedef void (*SecuritySetupInitiatedCallback_t)(Handle_t, bool allowBonding, bool requireMITM, SecurityIOCapabilities_t iocaps);
rgrover1 363:a3d59a6e5da0 199 typedef void (*SecuritySetupCompletedCallback_t)(Handle_t, SecurityCompletionStatus_t status);
rgrover1 362:3b1ff00ad8a4 200 typedef void (*LinkSecuredCallback_t)(Handle_t handle, SecurityMode_t securityMode);
rgrover1 369:9a76cc068644 201 typedef void (*PasskeyDisplayCallback_t)(Handle_t handle, const Passkey_t passkey);
rgrover1 260:ea7f9f14cc15 202
rgrover1 526:caa67c3187a0 203 public:
rgrover1 260:ea7f9f14cc15 204 /* These functions must be defined in the sub-class */
rgrover1 531:bdcd44b03974 205 virtual ble_error_t setAddress(AddressType_t type, const Address_t address) = 0;
rgrover1 527:493185cebc03 206 virtual ble_error_t getAddress(AddressType_t *typeP, Address_t address) = 0;
rgrover1 260:ea7f9f14cc15 207 virtual ble_error_t stopAdvertising(void) = 0;
rgrover1 392:3201f029c2eb 208 virtual ble_error_t stopScan() = 0;
rgrover1 325:501ad8b8bbe5 209 virtual uint16_t getMinAdvertisingInterval(void) const = 0;
rgrover1 325:501ad8b8bbe5 210 virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const = 0;
rgrover1 325:501ad8b8bbe5 211 virtual uint16_t getMaxAdvertisingInterval(void) const = 0;
rgrover1 527:493185cebc03 212 virtual ble_error_t connect(const Address_t peerAddr,
rgrover1 527:493185cebc03 213 Gap::AddressType_t peerAddrType,
rgrover1 527:493185cebc03 214 const ConnectionParams_t *connectionParams,
rgrover1 527:493185cebc03 215 const GapScanningParams *scanParams) = 0;
rgrover1 260:ea7f9f14cc15 216 virtual ble_error_t disconnect(DisconnectionReason_t reason) = 0;
rgrover1 260:ea7f9f14cc15 217 virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params) = 0;
rgrover1 260:ea7f9f14cc15 218 virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params) = 0;
rgrover1 260:ea7f9f14cc15 219 virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params) = 0;
rgrover1 260:ea7f9f14cc15 220
rgrover1 353:5ed63cda3038 221 virtual ble_error_t purgeAllBondingState(void) = 0;
rgrover1 352:79d7cb60ae27 222 virtual ble_error_t getLinkSecurity(Handle_t connectionHandle, LinkSecurityStatus_t *securityStatusP) = 0;
rgrover1 352:79d7cb60ae27 223
rgrover1 260:ea7f9f14cc15 224 virtual ble_error_t setDeviceName(const uint8_t *deviceName) = 0;
rgrover1 260:ea7f9f14cc15 225 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP) = 0;
rgrover1 260:ea7f9f14cc15 226 virtual ble_error_t setAppearance(uint16_t appearance) = 0;
rgrover1 260:ea7f9f14cc15 227 virtual ble_error_t getAppearance(uint16_t *appearanceP) = 0;
rgrover1 260:ea7f9f14cc15 228
rgrover1 526:caa67c3187a0 229 virtual ble_error_t setTxPower(int8_t txPower) = 0;
rgrover1 526:caa67c3187a0 230 virtual void getPermittedTxPowerValues(const int8_t **, size_t *) = 0;
rgrover1 526:caa67c3187a0 231
rgrover1 531:bdcd44b03974 232 ble_error_t startAdvertising(void) {
rgrover1 532:a709cfc1500d 233 return startAdvertising(_advParams);
rgrover1 531:bdcd44b03974 234 }
rgrover1 531:bdcd44b03974 235
rgrover1 531:bdcd44b03974 236 ble_error_t setAdvertisingData(void) {
rgrover1 531:bdcd44b03974 237 if (needToSetAdvPayload) {
rgrover1 531:bdcd44b03974 238 needToSetAdvPayload = false;
rgrover1 532:a709cfc1500d 239 return setAdvertisingData(_advPayload, _scanResponse);
rgrover1 531:bdcd44b03974 240 }
rgrover1 531:bdcd44b03974 241
rgrover1 531:bdcd44b03974 242 return BLE_ERROR_NONE;
rgrover1 531:bdcd44b03974 243 }
rgrover1 531:bdcd44b03974 244
rgrover1 531:bdcd44b03974 245 private:
rgrover1 531:bdcd44b03974 246 virtual ble_error_t setAdvertisingData(const GapAdvertisingData &, const GapAdvertisingData &) = 0;
rgrover1 531:bdcd44b03974 247 virtual ble_error_t startAdvertising(const GapAdvertisingParams &) = 0;
rgrover1 531:bdcd44b03974 248
rgrover1 531:bdcd44b03974 249 public:
rgrover1 531:bdcd44b03974 250 ble_error_t startScan(void (*callback)(const AdvertisementCallbackParams_t *params)) {
rgrover1 407:ca6b956b33d1 251 ble_error_t err = BLE_ERROR_NONE;
rgrover1 407:ca6b956b33d1 252 if (callback) {
rgrover1 532:a709cfc1500d 253 if ((err = startRadioScan(_scanningParams)) == BLE_ERROR_NONE) {
rgrover1 407:ca6b956b33d1 254 onAdvertisementReport.attach(callback);
rgrover1 407:ca6b956b33d1 255 }
rgrover1 407:ca6b956b33d1 256 }
rgrover1 407:ca6b956b33d1 257
rgrover1 407:ca6b956b33d1 258 return err;
rgrover1 407:ca6b956b33d1 259 }
rgrover1 407:ca6b956b33d1 260
rgrover1 407:ca6b956b33d1 261 template<typename T>
rgrover1 531:bdcd44b03974 262 ble_error_t startScan(T *object, void (T::*callbackMember)(const AdvertisementCallbackParams_t *params)) {
rgrover1 407:ca6b956b33d1 263 ble_error_t err = BLE_ERROR_NONE;
rgrover1 407:ca6b956b33d1 264 if (object && callbackMember) {
rgrover1 532:a709cfc1500d 265 if ((err = startRadioScan(_scanningParams)) == BLE_ERROR_NONE) {
rgrover1 407:ca6b956b33d1 266 onAdvertisementReport.attach(object, callbackMember);
rgrover1 407:ca6b956b33d1 267 }
rgrover1 407:ca6b956b33d1 268 }
rgrover1 407:ca6b956b33d1 269
rgrover1 407:ca6b956b33d1 270 return err;
rgrover1 407:ca6b956b33d1 271 }
rgrover1 407:ca6b956b33d1 272
rgrover1 526:caa67c3187a0 273 public:
rgrover1 407:ca6b956b33d1 274 virtual ble_error_t startRadioScan(const GapScanningParams &scanningParams) = 0;
rgrover1 407:ca6b956b33d1 275
rgrover1 260:ea7f9f14cc15 276 /* Event callback handlers */
rgrover1 260:ea7f9f14cc15 277 void setOnTimeout(EventCallback_t callback) {onTimeout = callback;}
rgrover1 260:ea7f9f14cc15 278 void setOnConnection(ConnectionEventCallback_t callback) {onConnection = callback;}
rgrover1 260:ea7f9f14cc15 279
rgrover1 260:ea7f9f14cc15 280 /**
rgrover1 260:ea7f9f14cc15 281 * Set the application callback for disconnection events.
rgrover1 260:ea7f9f14cc15 282 * @param callback
rgrover1 260:ea7f9f14cc15 283 * Pointer to the unique callback.
rgrover1 260:ea7f9f14cc15 284 */
rgrover1 260:ea7f9f14cc15 285 void setOnDisconnection(DisconnectionEventCallback_t callback) {onDisconnection = callback;}
rgrover1 260:ea7f9f14cc15 286
rgrover1 260:ea7f9f14cc15 287 /**
rgrover1 341:8a104d9d80c1 288 * Set the application callback for radio-notification events.
rgrover1 341:8a104d9d80c1 289 * @param callback
rgrover1 367:c3f4ad55ed33 290 * Handler to be executed in response to a radio notification event.
rgrover1 341:8a104d9d80c1 291 */
rgrover1 341:8a104d9d80c1 292 virtual void setOnRadioNotification(RadioNotificationEventCallback_t callback) {onRadioNotification = callback;}
rgrover1 341:8a104d9d80c1 293
rgrover1 341:8a104d9d80c1 294 /**
rgrover1 349:b8b2b3973c47 295 * To indicate that security procedure for link has started.
rgrover1 349:b8b2b3973c47 296 */
rgrover1 364:03a7a439a3bf 297 virtual void setOnSecuritySetupInitiated(SecuritySetupInitiatedCallback_t callback) {onSecuritySetupInitiated = callback;}
rgrover1 349:b8b2b3973c47 298
rgrover1 349:b8b2b3973c47 299 /**
rgrover1 349:b8b2b3973c47 300 * To indicate that security procedure for link has completed.
rgrover1 349:b8b2b3973c47 301 */
rgrover1 364:03a7a439a3bf 302 virtual void setOnSecuritySetupCompleted(SecuritySetupCompletedCallback_t callback) {onSecuritySetupCompleted = callback;}
rgrover1 349:b8b2b3973c47 303
rgrover1 349:b8b2b3973c47 304 /**
rgrover1 349:b8b2b3973c47 305 * To indicate that link with the peer is secured. For bonded devices,
rgrover1 367:c3f4ad55ed33 306 * subsequent re-connections with bonded peer will result only in this callback
rgrover1 349:b8b2b3973c47 307 * when the link is secured and setup procedures will not occur unless the
rgrover1 349:b8b2b3973c47 308 * bonding information is either lost or deleted on either or both sides.
rgrover1 349:b8b2b3973c47 309 */
rgrover1 362:3b1ff00ad8a4 310 virtual void setOnLinkSecured(LinkSecuredCallback_t callback) {onLinkSecured = callback;}
rgrover1 349:b8b2b3973c47 311
rgrover1 349:b8b2b3973c47 312 /**
rgrover1 349:b8b2b3973c47 313 * To indicate that device context is stored persistently.
rgrover1 349:b8b2b3973c47 314 */
rgrover1 349:b8b2b3973c47 315 virtual void setOnSecurityContextStored(HandleSpecificEvent_t callback) {onSecurityContextStored = callback;}
rgrover1 349:b8b2b3973c47 316
rgrover1 349:b8b2b3973c47 317 /**
rgrover1 369:9a76cc068644 318 * To set the callback for when the passkey needs to be displayed on a peripheral with DISPLAY capability.
rgrover1 369:9a76cc068644 319 */
rgrover1 369:9a76cc068644 320 virtual void setOnPasskeyDisplay(PasskeyDisplayCallback_t callback) {onPasskeyDisplay = callback;}
rgrover1 369:9a76cc068644 321
rgrover1 369:9a76cc068644 322 /**
rgrover1 260:ea7f9f14cc15 323 * Append to a chain of callbacks to be invoked upon disconnection; these
rgrover1 260:ea7f9f14cc15 324 * callbacks receive no context and are therefore different from the
rgrover1 260:ea7f9f14cc15 325 * onDisconnection callback.
rgrover1 260:ea7f9f14cc15 326 * @param callback
rgrover1 260:ea7f9f14cc15 327 * function pointer to be invoked upon disconnection; receives no context.
rgrover1 260:ea7f9f14cc15 328 *
rgrover1 260:ea7f9f14cc15 329 * @note the disconnection CallChain should have been merged with
rgrover1 260:ea7f9f14cc15 330 * onDisconnctionCallback; but this was not possible because
rgrover1 260:ea7f9f14cc15 331 * FunctionPointer (which is a building block for CallChain) doesn't
rgrover1 260:ea7f9f14cc15 332 * accept variadic templates.
rgrover1 260:ea7f9f14cc15 333 */
rgrover1 260:ea7f9f14cc15 334 template<typename T>
rgrover1 260:ea7f9f14cc15 335 void addToDisconnectionCallChain(T *tptr, void (T::*mptr)(void)) {disconnectionCallChain.add(tptr, mptr);}
rgrover1 260:ea7f9f14cc15 336
rgrover1 531:bdcd44b03974 337 GapAdvertisingParams &getAdvParams(void) {
rgrover1 532:a709cfc1500d 338 return _advParams;
rgrover1 531:bdcd44b03974 339 }
rgrover1 531:bdcd44b03974 340 const GapAdvertisingParams &getAdvParams(void) const {
rgrover1 532:a709cfc1500d 341 return _advParams;
rgrover1 531:bdcd44b03974 342 }
rgrover1 531:bdcd44b03974 343 void setAdvParams(const GapAdvertisingParams &newParams) {
rgrover1 532:a709cfc1500d 344 _advParams = newParams;
rgrover1 531:bdcd44b03974 345 }
rgrover1 531:bdcd44b03974 346
rgrover1 531:bdcd44b03974 347 GapAdvertisingData &getAdvPayload(void) {
rgrover1 531:bdcd44b03974 348 needToSetAdvPayload = true;
rgrover1 532:a709cfc1500d 349 return _advPayload;
rgrover1 531:bdcd44b03974 350 }
rgrover1 531:bdcd44b03974 351 const GapAdvertisingData &getAdvPayload(void) const {
rgrover1 532:a709cfc1500d 352 return _advPayload;
rgrover1 531:bdcd44b03974 353 }
rgrover1 531:bdcd44b03974 354
rgrover1 531:bdcd44b03974 355 GapAdvertisingData &getScanResponse(void) {
rgrover1 531:bdcd44b03974 356 needToSetAdvPayload = true;
rgrover1 532:a709cfc1500d 357 return _scanResponse;
rgrover1 531:bdcd44b03974 358 }
rgrover1 531:bdcd44b03974 359 const GapAdvertisingData &getScanResponse(void) const {
rgrover1 532:a709cfc1500d 360 return _scanResponse;
rgrover1 531:bdcd44b03974 361 }
rgrover1 531:bdcd44b03974 362
rgrover1 531:bdcd44b03974 363 GapScanningParams &getScanningParams(void) {
rgrover1 532:a709cfc1500d 364 return _scanningParams;
rgrover1 531:bdcd44b03974 365 }
rgrover1 531:bdcd44b03974 366 const GapScanningParams &getScanningParams(void) const {
rgrover1 532:a709cfc1500d 367 return _scanningParams;
rgrover1 531:bdcd44b03974 368 }
rgrover1 531:bdcd44b03974 369
rgrover1 526:caa67c3187a0 370 public:
rgrover1 260:ea7f9f14cc15 371 GapState_t getState(void) const {
rgrover1 260:ea7f9f14cc15 372 return state;
rgrover1 260:ea7f9f14cc15 373 }
rgrover1 260:ea7f9f14cc15 374
rgrover1 260:ea7f9f14cc15 375 protected:
rgrover1 349:b8b2b3973c47 376 Gap() :
rgrover1 532:a709cfc1500d 377 _advParams(),
rgrover1 532:a709cfc1500d 378 _advPayload(),
rgrover1 531:bdcd44b03974 379 needToSetAdvPayload(true),
rgrover1 532:a709cfc1500d 380 _scanningParams(),
rgrover1 532:a709cfc1500d 381 _scanResponse(),
rgrover1 349:b8b2b3973c47 382 state(),
rgrover1 349:b8b2b3973c47 383 onTimeout(NULL),
rgrover1 349:b8b2b3973c47 384 onConnection(NULL),
rgrover1 349:b8b2b3973c47 385 onDisconnection(NULL),
rgrover1 349:b8b2b3973c47 386 onRadioNotification(),
rgrover1 364:03a7a439a3bf 387 onSecuritySetupInitiated(),
rgrover1 364:03a7a439a3bf 388 onSecuritySetupCompleted(),
rgrover1 349:b8b2b3973c47 389 onLinkSecured(),
rgrover1 349:b8b2b3973c47 390 onSecurityContextStored(),
rgrover1 369:9a76cc068644 391 onPasskeyDisplay(),
rgrover1 382:dcd0428dadb0 392 onAdvertisementReport(),
rgrover1 349:b8b2b3973c47 393 disconnectionCallChain() {
rgrover1 532:a709cfc1500d 394 _advPayload.clear();
rgrover1 532:a709cfc1500d 395 _scanResponse.clear();
rgrover1 260:ea7f9f14cc15 396 }
rgrover1 260:ea7f9f14cc15 397
rgrover1 260:ea7f9f14cc15 398 public:
rgrover1 527:493185cebc03 399 void processConnectionEvent(Handle_t handle,
rgrover1 527:493185cebc03 400 Role_t role,
rgrover1 527:493185cebc03 401 AddressType_t peerAddrType,
rgrover1 527:493185cebc03 402 const Address_t peerAddr,
rgrover1 527:493185cebc03 403 AddressType_t ownAddrType,
rgrover1 527:493185cebc03 404 const Address_t ownAddr,
rgrover1 527:493185cebc03 405 const ConnectionParams_t *connectionParams) {
rgrover1 260:ea7f9f14cc15 406 state.connected = 1;
rgrover1 260:ea7f9f14cc15 407 if (onConnection) {
rgrover1 527:493185cebc03 408 ConnectionCallbackParams_t callbackParams(handle, role, peerAddrType, peerAddr, ownAddrType, ownAddr, connectionParams);
rgrover1 527:493185cebc03 409 onConnection(&callbackParams);
rgrover1 260:ea7f9f14cc15 410 }
rgrover1 260:ea7f9f14cc15 411 }
rgrover1 260:ea7f9f14cc15 412
rgrover1 260:ea7f9f14cc15 413 void processDisconnectionEvent(Handle_t handle, DisconnectionReason_t reason) {
rgrover1 260:ea7f9f14cc15 414 state.connected = 0;
rgrover1 260:ea7f9f14cc15 415 if (onDisconnection) {
rgrover1 260:ea7f9f14cc15 416 onDisconnection(handle, reason);
rgrover1 260:ea7f9f14cc15 417 }
rgrover1 260:ea7f9f14cc15 418 disconnectionCallChain.call();
rgrover1 260:ea7f9f14cc15 419 }
rgrover1 260:ea7f9f14cc15 420
rgrover1 363:a3d59a6e5da0 421 void processSecuritySetupInitiatedEvent(Handle_t handle, bool allowBonding, bool requireMITM, SecurityIOCapabilities_t iocaps) {
rgrover1 364:03a7a439a3bf 422 if (onSecuritySetupInitiated) {
rgrover1 364:03a7a439a3bf 423 onSecuritySetupInitiated(handle, allowBonding, requireMITM, iocaps);
rgrover1 349:b8b2b3973c47 424 }
rgrover1 349:b8b2b3973c47 425 }
rgrover1 349:b8b2b3973c47 426
rgrover1 363:a3d59a6e5da0 427 void processSecuritySetupCompletedEvent(Handle_t handle, SecurityCompletionStatus_t status) {
rgrover1 364:03a7a439a3bf 428 if (onSecuritySetupCompleted) {
rgrover1 364:03a7a439a3bf 429 onSecuritySetupCompleted(handle, status);
rgrover1 349:b8b2b3973c47 430 }
rgrover1 349:b8b2b3973c47 431 }
rgrover1 349:b8b2b3973c47 432
rgrover1 362:3b1ff00ad8a4 433 void processLinkSecuredEvent(Handle_t handle, SecurityMode_t securityMode) {
rgrover1 349:b8b2b3973c47 434 if (onLinkSecured) {
rgrover1 362:3b1ff00ad8a4 435 onLinkSecured(handle, securityMode);
rgrover1 349:b8b2b3973c47 436 }
rgrover1 349:b8b2b3973c47 437 }
rgrover1 349:b8b2b3973c47 438
rgrover1 349:b8b2b3973c47 439 void processSecurityContextStoredEvent(Handle_t handle) {
rgrover1 349:b8b2b3973c47 440 if (onSecurityContextStored) {
rgrover1 349:b8b2b3973c47 441 onSecurityContextStored(handle);
rgrover1 349:b8b2b3973c47 442 }
rgrover1 349:b8b2b3973c47 443 }
rgrover1 349:b8b2b3973c47 444
rgrover1 369:9a76cc068644 445 void processPasskeyDisplayEvent(Handle_t handle, const Passkey_t passkey) {
rgrover1 369:9a76cc068644 446 if (onPasskeyDisplay) {
rgrover1 369:9a76cc068644 447 onPasskeyDisplay(handle, passkey);
rgrover1 369:9a76cc068644 448 }
rgrover1 369:9a76cc068644 449 }
rgrover1 369:9a76cc068644 450
rgrover1 405:8fc6e6855806 451 void processAdvertisementReport(const Address_t peerAddr,
rgrover1 382:dcd0428dadb0 452 int8_t rssi,
rgrover1 382:dcd0428dadb0 453 bool isScanResponse,
rgrover1 382:dcd0428dadb0 454 AdvertisementType_t type,
rgrover1 382:dcd0428dadb0 455 uint8_t advertisingDataLen,
rgrover1 382:dcd0428dadb0 456 const uint8_t *advertisingData) {
rgrover1 406:cec6778acc66 457 AdvertisementCallbackParams_t params;
rgrover1 406:cec6778acc66 458 memcpy(params.peerAddr, peerAddr, ADDR_LEN);
rgrover1 406:cec6778acc66 459 params.rssi = rssi;
rgrover1 406:cec6778acc66 460 params.isScanResponse = isScanResponse;
rgrover1 406:cec6778acc66 461 params.type = type;
rgrover1 406:cec6778acc66 462 params.advertisingDataLen = advertisingDataLen;
rgrover1 406:cec6778acc66 463 params.advertisingData = advertisingData;
rgrover1 406:cec6778acc66 464 onAdvertisementReport.call(&params);
rgrover1 382:dcd0428dadb0 465 }
rgrover1 382:dcd0428dadb0 466
rgrover1 260:ea7f9f14cc15 467 void processEvent(GapEvents::gapEvent_e type) {
rgrover1 260:ea7f9f14cc15 468 switch (type) {
rgrover1 260:ea7f9f14cc15 469 case GapEvents::GAP_EVENT_TIMEOUT:
rgrover1 260:ea7f9f14cc15 470 state.advertising = 0;
rgrover1 260:ea7f9f14cc15 471 if (onTimeout) {
rgrover1 260:ea7f9f14cc15 472 onTimeout();
rgrover1 260:ea7f9f14cc15 473 }
rgrover1 260:ea7f9f14cc15 474 break;
rgrover1 267:ad6f6f40eb24 475 default:
rgrover1 267:ad6f6f40eb24 476 break;
rgrover1 260:ea7f9f14cc15 477 }
rgrover1 260:ea7f9f14cc15 478 }
rgrover1 260:ea7f9f14cc15 479
rgrover1 260:ea7f9f14cc15 480 protected:
rgrover1 532:a709cfc1500d 481 GapAdvertisingParams _advParams;
rgrover1 532:a709cfc1500d 482 GapAdvertisingData _advPayload;
rgrover1 531:bdcd44b03974 483 /* Accumulation of AD structures in the advertisement payload should
rgrover1 531:bdcd44b03974 484 * eventually result in a call to the target's setAdvertisingData() before
rgrover1 531:bdcd44b03974 485 * the server begins advertising. This flag marks the status of the pending update.*/
rgrover1 531:bdcd44b03974 486 bool needToSetAdvPayload;
rgrover1 531:bdcd44b03974 487
rgrover1 532:a709cfc1500d 488 GapScanningParams _scanningParams;
rgrover1 532:a709cfc1500d 489 GapAdvertisingData _scanResponse;
rgrover1 531:bdcd44b03974 490
rgrover1 363:a3d59a6e5da0 491 GapState_t state;
rgrover1 260:ea7f9f14cc15 492
rgrover1 337:e7c2eb38f5cc 493 protected:
rgrover1 363:a3d59a6e5da0 494 EventCallback_t onTimeout;
rgrover1 363:a3d59a6e5da0 495 ConnectionEventCallback_t onConnection;
rgrover1 363:a3d59a6e5da0 496 DisconnectionEventCallback_t onDisconnection;
rgrover1 363:a3d59a6e5da0 497 RadioNotificationEventCallback_t onRadioNotification;
rgrover1 364:03a7a439a3bf 498 SecuritySetupInitiatedCallback_t onSecuritySetupInitiated;
rgrover1 364:03a7a439a3bf 499 SecuritySetupCompletedCallback_t onSecuritySetupCompleted;
rgrover1 363:a3d59a6e5da0 500 LinkSecuredCallback_t onLinkSecured;
rgrover1 363:a3d59a6e5da0 501 HandleSpecificEvent_t onSecurityContextStored;
rgrover1 369:9a76cc068644 502 PasskeyDisplayCallback_t onPasskeyDisplay;
rgrover1 385:6e66d1c6de00 503 AdvertisementReportCallback_t onAdvertisementReport;
rgrover1 363:a3d59a6e5da0 504 CallChain disconnectionCallChain;
rgrover1 260:ea7f9f14cc15 505
rgrover1 260:ea7f9f14cc15 506 private:
rgrover1 260:ea7f9f14cc15 507 /* disallow copy and assignment */
rgrover1 260:ea7f9f14cc15 508 Gap(const Gap &);
rgrover1 260:ea7f9f14cc15 509 Gap& operator=(const Gap &);
rgrover1 260:ea7f9f14cc15 510 };
rgrover1 260:ea7f9f14cc15 511
rgrover1 260:ea7f9f14cc15 512 #endif // ifndef __GAP_H__