Igor Levkov / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   BLE_PowerBank_HeyFaradey

Fork of BLE_API by Bluetooth Low Energy

public/Gap.h@667:875aecb84719, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:53:01 2015 +0100
Revision:
667:875aecb84719
Parent:
666:b4a737539c2c
Child:
669:7179b4a5aa7d
Synchronized with git rev 43177a02

Author: Rohit Grover

remove un-necessary comments in GattClient.h

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 260:ea7f9f14cc15 20 #include "GapEvents.h"
rgrover1 260:ea7f9f14cc15 21 #include "CallChain.h"
rgrover1 406:cec6778acc66 22 #include "FunctionPointerWithContext.h"
rgrover1 260:ea7f9f14cc15 23
rgrover1 260:ea7f9f14cc15 24 using namespace mbed;
rgrover1 260:ea7f9f14cc15 25
rgrover1 667:875aecb84719 26 /* Forward declarations for classes which will only be used for pointers or references in the following. */
rgrover1 667:875aecb84719 27 class GapAdvertisingParams;
rgrover1 667:875aecb84719 28 class GapScanningParams;
rgrover1 667:875aecb84719 29 class GapAdvertisingData;
rgrover1 397:9f5bfae7ea50 30
rgrover1 260:ea7f9f14cc15 31 class Gap {
rgrover1 260:ea7f9f14cc15 32 public:
rgrover1 375:9cb0b006227e 33 enum AddressType_t {
rgrover1 260:ea7f9f14cc15 34 ADDR_TYPE_PUBLIC = 0,
rgrover1 260:ea7f9f14cc15 35 ADDR_TYPE_RANDOM_STATIC,
rgrover1 260:ea7f9f14cc15 36 ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE,
rgrover1 260:ea7f9f14cc15 37 ADDR_TYPE_RANDOM_PRIVATE_NON_RESOLVABLE
rgrover1 375:9cb0b006227e 38 };
rgrover1 402:0e714ad205b4 39 typedef enum AddressType_t addr_type_t; /* @Note: deprecated. Use AddressType_t instead. */
rgrover1 260:ea7f9f14cc15 40
rgrover1 260:ea7f9f14cc15 41 static const unsigned ADDR_LEN = 6;
rgrover1 375:9cb0b006227e 42 typedef uint8_t Address_t[ADDR_LEN]; /* 48-bit address, LSB format. */
rgrover1 402:0e714ad205b4 43 typedef Address_t address_t; /* @Note: deprecated. Use Address_t instead. */
rgrover1 260:ea7f9f14cc15 44
rgrover1 567:e4b38e43de7c 45 enum AdvertisementType_t {
rgrover1 567:e4b38e43de7c 46 ADV_IND = 0x00, /**< Connectable undirected. */
rgrover1 567:e4b38e43de7c 47 ADV_DIRECT_IND = 0x01, /**< Connectable directed. */
rgrover1 567:e4b38e43de7c 48 ADV_SCAN_IND = 0x02, /**< Scannable undirected. */
rgrover1 567:e4b38e43de7c 49 ADV_NONCONN_IND = 0x03, /**< Non connectable undirected. */
rgrover1 541:aa30f63e7b3f 50 };
rgrover1 541:aa30f63e7b3f 51
rgrover1 260:ea7f9f14cc15 52 /**
rgrover1 260:ea7f9f14cc15 53 * Enumeration for disconnection reasons. The values for these reasons are
rgrover1 260:ea7f9f14cc15 54 * derived from Nordic's implementation; but the reasons are meant to be
rgrover1 260:ea7f9f14cc15 55 * independent of the transport. If you are returned a reason which is not
rgrover1 260:ea7f9f14cc15 56 * covered by this enumeration, then please refer to the underlying
rgrover1 260:ea7f9f14cc15 57 * transport library.
rgrover1 260:ea7f9f14cc15 58 */
rgrover1 260:ea7f9f14cc15 59 enum DisconnectionReason_t {
rgrover1 667:875aecb84719 60 REMOTE_USER_TERMINATED_CONNECTION = 0x13,
rgrover1 667:875aecb84719 61 LOCAL_HOST_TERMINATED_CONNECTION = 0x16,
rgrover1 667:875aecb84719 62 CONN_INTERVAL_UNACCEPTABLE = 0x3B,
rgrover1 260:ea7f9f14cc15 63 };
rgrover1 260:ea7f9f14cc15 64
rgrover1 260:ea7f9f14cc15 65 /* Describes the current state of the device (more than one bit can be set) */
rgrover1 413:4d5fb1522cfb 66 struct GapState_t {
rgrover1 260:ea7f9f14cc15 67 unsigned advertising : 1; /**< peripheral is currently advertising */
rgrover1 260:ea7f9f14cc15 68 unsigned connected : 1; /**< peripheral is connected to a central */
rgrover1 413:4d5fb1522cfb 69 };
rgrover1 260:ea7f9f14cc15 70
rgrover1 567:e4b38e43de7c 71 typedef uint16_t Handle_t;
rgrover1 260:ea7f9f14cc15 72
rgrover1 260:ea7f9f14cc15 73 typedef struct {
rgrover1 260:ea7f9f14cc15 74 uint16_t minConnectionInterval; /**< Minimum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 260:ea7f9f14cc15 75 uint16_t maxConnectionInterval; /**< Maximum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 260:ea7f9f14cc15 76 uint16_t slaveLatency; /**< Slave Latency in number of connection events, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 260:ea7f9f14cc15 77 uint16_t connectionSupervisionTimeout; /**< Connection Supervision Timeout in 10 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 260:ea7f9f14cc15 78 } ConnectionParams_t;
rgrover1 260:ea7f9f14cc15 79
rgrover1 667:875aecb84719 80 enum Role_t {
rgrover1 667:875aecb84719 81 PERIPHERAL = 0x1, /**< Peripheral Role. */
rgrover1 667:875aecb84719 82 CENTRAL = 0x2, /**< Central Role. */
rgrover1 667:875aecb84719 83 };
rgrover1 667:875aecb84719 84
rgrover1 667:875aecb84719 85 struct AdvertisementCallbackParams_t {
rgrover1 667:875aecb84719 86 Address_t peerAddr;
rgrover1 667:875aecb84719 87 int8_t rssi;
rgrover1 667:875aecb84719 88 bool isScanResponse;
rgrover1 667:875aecb84719 89 AdvertisementType_t type;
rgrover1 667:875aecb84719 90 uint8_t advertisingDataLen;
rgrover1 667:875aecb84719 91 const uint8_t *advertisingData;
rgrover1 667:875aecb84719 92 };
rgrover1 667:875aecb84719 93 typedef FunctionPointerWithContext<const AdvertisementCallbackParams_t *> AdvertisementReportCallback_t;
rgrover1 667:875aecb84719 94
rgrover1 667:875aecb84719 95 struct ConnectionCallbackParams_t {
rgrover1 667:875aecb84719 96 Handle_t handle;
rgrover1 667:875aecb84719 97 Role_t role;
rgrover1 667:875aecb84719 98 AddressType_t peerAddrType;
rgrover1 667:875aecb84719 99 Address_t peerAddr;
rgrover1 667:875aecb84719 100 AddressType_t ownAddrType;
rgrover1 667:875aecb84719 101 Address_t ownAddr;
rgrover1 667:875aecb84719 102 const ConnectionParams_t *connectionParams;
rgrover1 667:875aecb84719 103
rgrover1 667:875aecb84719 104 ConnectionCallbackParams_t(Handle_t handleIn,
rgrover1 667:875aecb84719 105 Role_t roleIn,
rgrover1 667:875aecb84719 106 AddressType_t peerAddrTypeIn,
rgrover1 667:875aecb84719 107 const uint8_t *peerAddrIn,
rgrover1 667:875aecb84719 108 AddressType_t ownAddrTypeIn,
rgrover1 667:875aecb84719 109 const uint8_t *ownAddrIn,
rgrover1 667:875aecb84719 110 const ConnectionParams_t *connectionParamsIn) :
rgrover1 667:875aecb84719 111 handle(handleIn),
rgrover1 667:875aecb84719 112 role(roleIn),
rgrover1 667:875aecb84719 113 peerAddrType(peerAddrTypeIn),
rgrover1 667:875aecb84719 114 peerAddr(),
rgrover1 667:875aecb84719 115 ownAddrType(ownAddrTypeIn),
rgrover1 667:875aecb84719 116 ownAddr(),
rgrover1 667:875aecb84719 117 connectionParams(connectionParamsIn) {
rgrover1 667:875aecb84719 118 memcpy(peerAddr, peerAddrIn, ADDR_LEN);
rgrover1 667:875aecb84719 119 memcpy(ownAddr, ownAddrIn, ADDR_LEN);
rgrover1 667:875aecb84719 120 }
rgrover1 667:875aecb84719 121 };
rgrover1 667:875aecb84719 122
rgrover1 567:e4b38e43de7c 123 enum SecurityMode_t {
rgrover1 567:e4b38e43de7c 124 SECURITY_MODE_NO_ACCESS,
rgrover1 567:e4b38e43de7c 125 SECURITY_MODE_ENCRYPTION_OPEN_LINK, /**< require no protection, open link. */
rgrover1 567:e4b38e43de7c 126 SECURITY_MODE_ENCRYPTION_NO_MITM, /**< require encryption, but no MITM protection. */
rgrover1 567:e4b38e43de7c 127 SECURITY_MODE_ENCRYPTION_WITH_MITM, /**< require encryption and MITM protection. */
rgrover1 567:e4b38e43de7c 128 SECURITY_MODE_SIGNED_NO_MITM, /**< require signing or encryption, but no MITM protection. */
rgrover1 567:e4b38e43de7c 129 SECURITY_MODE_SIGNED_WITH_MITM, /**< require signing or encryption, and MITM protection. */
rgrover1 567:e4b38e43de7c 130 };
rgrover1 567:e4b38e43de7c 131
rgrover1 567:e4b38e43de7c 132 /**
rgrover1 567:e4b38e43de7c 133 * @brief Defines possible security status/states.
rgrover1 567:e4b38e43de7c 134 *
rgrover1 567:e4b38e43de7c 135 * @details Defines possible security status/states of a link when requested by getLinkSecurity().
rgrover1 567:e4b38e43de7c 136 */
rgrover1 567:e4b38e43de7c 137 enum LinkSecurityStatus_t {
rgrover1 567:e4b38e43de7c 138 NOT_ENCRYPTED, /**< The link is not secured. */
rgrover1 567:e4b38e43de7c 139 ENCRYPTION_IN_PROGRESS, /**< Link security is being established.*/
rgrover1 567:e4b38e43de7c 140 ENCRYPTED /**< The link is secure.*/
rgrover1 527:493185cebc03 141 };
rgrover1 527:493185cebc03 142
rgrover1 567:e4b38e43de7c 143 enum SecurityIOCapabilities_t {
rgrover1 567:e4b38e43de7c 144 IO_CAPS_DISPLAY_ONLY = 0x00, /**< Display Only. */
rgrover1 567:e4b38e43de7c 145 IO_CAPS_DISPLAY_YESNO = 0x01, /**< Display and Yes/No entry. */
rgrover1 567:e4b38e43de7c 146 IO_CAPS_KEYBOARD_ONLY = 0x02, /**< Keyboard Only. */
rgrover1 567:e4b38e43de7c 147 IO_CAPS_NONE = 0x03, /**< No I/O capabilities. */
rgrover1 567:e4b38e43de7c 148 IO_CAPS_KEYBOARD_DISPLAY = 0x04, /**< Keyboard and Display. */
rgrover1 527:493185cebc03 149 };
rgrover1 527:493185cebc03 150
rgrover1 567:e4b38e43de7c 151 enum SecurityCompletionStatus_t {
rgrover1 567:e4b38e43de7c 152 SEC_STATUS_SUCCESS = 0x00, /**< Procedure completed with success. */
rgrover1 567:e4b38e43de7c 153 SEC_STATUS_TIMEOUT = 0x01, /**< Procedure timed out. */
rgrover1 567:e4b38e43de7c 154 SEC_STATUS_PDU_INVALID = 0x02, /**< Invalid PDU received. */
rgrover1 567:e4b38e43de7c 155 SEC_STATUS_PASSKEY_ENTRY_FAILED = 0x81, /**< Passkey entry failed (user canceled or other). */
rgrover1 567:e4b38e43de7c 156 SEC_STATUS_OOB_NOT_AVAILABLE = 0x82, /**< Out of Band Key not available. */
rgrover1 567:e4b38e43de7c 157 SEC_STATUS_AUTH_REQ = 0x83, /**< Authentication requirements not met. */
rgrover1 567:e4b38e43de7c 158 SEC_STATUS_CONFIRM_VALUE = 0x84, /**< Confirm value failed. */
rgrover1 567:e4b38e43de7c 159 SEC_STATUS_PAIRING_NOT_SUPP = 0x85, /**< Pairing not supported. */
rgrover1 567:e4b38e43de7c 160 SEC_STATUS_ENC_KEY_SIZE = 0x86, /**< Encryption key size. */
rgrover1 567:e4b38e43de7c 161 SEC_STATUS_SMP_CMD_UNSUPPORTED = 0x87, /**< Unsupported SMP command. */
rgrover1 567:e4b38e43de7c 162 SEC_STATUS_UNSPECIFIED = 0x88, /**< Unspecified reason. */
rgrover1 567:e4b38e43de7c 163 SEC_STATUS_REPEATED_ATTEMPTS = 0x89, /**< Too little time elapsed since last attempt. */
rgrover1 567:e4b38e43de7c 164 SEC_STATUS_INVALID_PARAMS = 0x8A, /**< Invalid parameters. */
rgrover1 527:493185cebc03 165 };
rgrover1 527:493185cebc03 166
rgrover1 567:e4b38e43de7c 167 /**
rgrover1 567:e4b38e43de7c 168 * Declaration of type containing a passkey to be used during pairing. This
rgrover1 567:e4b38e43de7c 169 * is passed into initializeSecurity() to specify a pre-programmed passkey
rgrover1 567:e4b38e43de7c 170 * for authentication instead of generating a random one.
rgrover1 567:e4b38e43de7c 171 */
rgrover1 567:e4b38e43de7c 172 static const unsigned PASSKEY_LEN = 6;
rgrover1 567:e4b38e43de7c 173 typedef uint8_t Passkey_t[PASSKEY_LEN]; /**< 6-digit passkey in ASCII ('0'-'9' digits only). */
rgrover1 567:e4b38e43de7c 174
rgrover1 260:ea7f9f14cc15 175 static const uint16_t UNIT_1_25_MS = 1250; /**< Number of microseconds in 1.25 milliseconds. */
rgrover1 398:9d7666c2305f 176 static const uint16_t UNIT_0_625_MS = 625; /**< Number of microseconds in 0.625 milliseconds. */
rgrover1 260:ea7f9f14cc15 177 static uint16_t MSEC_TO_GAP_DURATION_UNITS(uint32_t durationInMillis) {
rgrover1 260:ea7f9f14cc15 178 return (durationInMillis * 1000) / UNIT_1_25_MS;
rgrover1 260:ea7f9f14cc15 179 }
rgrover1 260:ea7f9f14cc15 180 static uint16_t MSEC_TO_ADVERTISEMENT_DURATION_UNITS(uint32_t durationInMillis) {
rgrover1 260:ea7f9f14cc15 181 return (durationInMillis * 1000) / UNIT_0_625_MS;
rgrover1 260:ea7f9f14cc15 182 }
rgrover1 399:1a69d53f00cc 183 static uint16_t ADVERTISEMENT_DURATION_UNITS_TO_MS(uint16_t gapUnits) {
rgrover1 325:501ad8b8bbe5 184 return (gapUnits * UNIT_0_625_MS) / 1000;
rgrover1 325:501ad8b8bbe5 185 }
rgrover1 260:ea7f9f14cc15 186
rgrover1 567:e4b38e43de7c 187 typedef void (*EventCallback_t)(void);
rgrover1 667:875aecb84719 188 typedef void (*ConnectionEventCallback_t)(const ConnectionCallbackParams_t *params);
rgrover1 567:e4b38e43de7c 189 typedef void (*HandleSpecificEvent_t)(Handle_t handle);
rgrover1 260:ea7f9f14cc15 190 typedef void (*DisconnectionEventCallback_t)(Handle_t, DisconnectionReason_t);
rgrover1 567:e4b38e43de7c 191 typedef void (*RadioNotificationEventCallback_t) (bool radio_active); /* gets passed true for ACTIVE; false for INACTIVE. */
rgrover1 567:e4b38e43de7c 192 typedef void (*SecuritySetupInitiatedCallback_t)(Handle_t, bool allowBonding, bool requireMITM, SecurityIOCapabilities_t iocaps);
rgrover1 567:e4b38e43de7c 193 typedef void (*SecuritySetupCompletedCallback_t)(Handle_t, SecurityCompletionStatus_t status);
rgrover1 567:e4b38e43de7c 194 typedef void (*LinkSecuredCallback_t)(Handle_t handle, SecurityMode_t securityMode);
rgrover1 567:e4b38e43de7c 195 typedef void (*PasskeyDisplayCallback_t)(Handle_t handle, const Passkey_t passkey);
rgrover1 260:ea7f9f14cc15 196
rgrover1 667:875aecb84719 197 friend class BLEDevice;
rgrover1 534:754131484cf1 198
rgrover1 667:875aecb84719 199 private:
rgrover1 567:e4b38e43de7c 200 /* These functions must be defined in the sub-class */
rgrover1 667:875aecb84719 201 virtual ble_error_t setAddress(AddressType_t type, const Address_t address) = 0;
rgrover1 667:875aecb84719 202 virtual ble_error_t getAddress(AddressType_t *typeP, Address_t address) = 0;
rgrover1 567:e4b38e43de7c 203 virtual ble_error_t setAdvertisingData(const GapAdvertisingData &, const GapAdvertisingData &) = 0;
rgrover1 567:e4b38e43de7c 204 virtual ble_error_t startAdvertising(const GapAdvertisingParams &) = 0;
rgrover1 567:e4b38e43de7c 205 virtual ble_error_t stopAdvertising(void) = 0;
rgrover1 567:e4b38e43de7c 206 virtual ble_error_t stopScan() = 0;
rgrover1 567:e4b38e43de7c 207 virtual uint16_t getMinAdvertisingInterval(void) const = 0;
rgrover1 567:e4b38e43de7c 208 virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const = 0;
rgrover1 567:e4b38e43de7c 209 virtual uint16_t getMaxAdvertisingInterval(void) const = 0;
rgrover1 667:875aecb84719 210 virtual ble_error_t connect(const Address_t peerAddr,
rgrover1 667:875aecb84719 211 Gap::AddressType_t peerAddrType,
rgrover1 667:875aecb84719 212 const ConnectionParams_t *connectionParams,
rgrover1 667:875aecb84719 213 const GapScanningParams *scanParams) = 0;
rgrover1 567:e4b38e43de7c 214 virtual ble_error_t disconnect(DisconnectionReason_t reason) = 0;
rgrover1 567:e4b38e43de7c 215 virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params) = 0;
rgrover1 567:e4b38e43de7c 216 virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params) = 0;
rgrover1 567:e4b38e43de7c 217 virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params) = 0;
rgrover1 537:00d5affbb2b2 218
rgrover1 567:e4b38e43de7c 219 virtual ble_error_t purgeAllBondingState(void) = 0;
rgrover1 567:e4b38e43de7c 220 virtual ble_error_t getLinkSecurity(Handle_t connectionHandle, LinkSecurityStatus_t *securityStatusP) = 0;
rgrover1 537:00d5affbb2b2 221
rgrover1 567:e4b38e43de7c 222 virtual ble_error_t setDeviceName(const uint8_t *deviceName) = 0;
rgrover1 567:e4b38e43de7c 223 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP) = 0;
rgrover1 567:e4b38e43de7c 224 virtual ble_error_t setAppearance(uint16_t appearance) = 0;
rgrover1 567:e4b38e43de7c 225 virtual ble_error_t getAppearance(uint16_t *appearanceP) = 0;
rgrover1 534:754131484cf1 226
rgrover1 567:e4b38e43de7c 227 ble_error_t startScan(const GapScanningParams &scanningParams, void (*callback)(const AdvertisementCallbackParams_t *params)) {
rgrover1 407:ca6b956b33d1 228 ble_error_t err = BLE_ERROR_NONE;
rgrover1 407:ca6b956b33d1 229 if (callback) {
rgrover1 567:e4b38e43de7c 230 if ((err = startRadioScan(scanningParams)) == BLE_ERROR_NONE) {
rgrover1 407:ca6b956b33d1 231 onAdvertisementReport.attach(callback);
rgrover1 407:ca6b956b33d1 232 }
rgrover1 407:ca6b956b33d1 233 }
rgrover1 407:ca6b956b33d1 234
rgrover1 407:ca6b956b33d1 235 return err;
rgrover1 407:ca6b956b33d1 236 }
rgrover1 407:ca6b956b33d1 237
rgrover1 407:ca6b956b33d1 238 template<typename T>
rgrover1 567:e4b38e43de7c 239 ble_error_t startScan(const GapScanningParams &scanningParams, T *object, void (T::*callbackMember)(const AdvertisementCallbackParams_t *params)) {
rgrover1 407:ca6b956b33d1 240 ble_error_t err = BLE_ERROR_NONE;
rgrover1 407:ca6b956b33d1 241 if (object && callbackMember) {
rgrover1 567:e4b38e43de7c 242 if ((err = startRadioScan(scanningParams)) == BLE_ERROR_NONE) {
rgrover1 407:ca6b956b33d1 243 onAdvertisementReport.attach(object, callbackMember);
rgrover1 407:ca6b956b33d1 244 }
rgrover1 407:ca6b956b33d1 245 }
rgrover1 407:ca6b956b33d1 246
rgrover1 407:ca6b956b33d1 247 return err;
rgrover1 407:ca6b956b33d1 248 }
rgrover1 407:ca6b956b33d1 249
rgrover1 667:875aecb84719 250 protected:
rgrover1 567:e4b38e43de7c 251 virtual ble_error_t startRadioScan(const GapScanningParams &scanningParams) = 0;
rgrover1 537:00d5affbb2b2 252
rgrover1 567:e4b38e43de7c 253 /* Event callback handlers */
rgrover1 567:e4b38e43de7c 254 void setOnTimeout(EventCallback_t callback) {onTimeout = callback;}
rgrover1 567:e4b38e43de7c 255 void setOnConnection(ConnectionEventCallback_t callback) {onConnection = callback;}
rgrover1 260:ea7f9f14cc15 256
rgrover1 260:ea7f9f14cc15 257 /**
rgrover1 260:ea7f9f14cc15 258 * Set the application callback for disconnection events.
rgrover1 260:ea7f9f14cc15 259 * @param callback
rgrover1 260:ea7f9f14cc15 260 * Pointer to the unique callback.
rgrover1 260:ea7f9f14cc15 261 */
rgrover1 567:e4b38e43de7c 262 void setOnDisconnection(DisconnectionEventCallback_t callback) {onDisconnection = callback;}
rgrover1 567:e4b38e43de7c 263
rgrover1 567:e4b38e43de7c 264 /**
rgrover1 567:e4b38e43de7c 265 * Set the application callback for radio-notification events.
rgrover1 567:e4b38e43de7c 266 * @param callback
rgrover1 567:e4b38e43de7c 267 * Handler to be executed in response to a radio notification event.
rgrover1 567:e4b38e43de7c 268 */
rgrover1 567:e4b38e43de7c 269 virtual void setOnRadioNotification(RadioNotificationEventCallback_t callback) {onRadioNotification = callback;}
rgrover1 567:e4b38e43de7c 270
rgrover1 567:e4b38e43de7c 271 /**
rgrover1 567:e4b38e43de7c 272 * To indicate that security procedure for link has started.
rgrover1 567:e4b38e43de7c 273 */
rgrover1 567:e4b38e43de7c 274 virtual void setOnSecuritySetupInitiated(SecuritySetupInitiatedCallback_t callback) {onSecuritySetupInitiated = callback;}
rgrover1 567:e4b38e43de7c 275
rgrover1 567:e4b38e43de7c 276 /**
rgrover1 567:e4b38e43de7c 277 * To indicate that security procedure for link has completed.
rgrover1 567:e4b38e43de7c 278 */
rgrover1 567:e4b38e43de7c 279 virtual void setOnSecuritySetupCompleted(SecuritySetupCompletedCallback_t callback) {onSecuritySetupCompleted = callback;}
rgrover1 567:e4b38e43de7c 280
rgrover1 567:e4b38e43de7c 281 /**
rgrover1 567:e4b38e43de7c 282 * To indicate that link with the peer is secured. For bonded devices,
rgrover1 567:e4b38e43de7c 283 * subsequent re-connections with bonded peer will result only in this callback
rgrover1 567:e4b38e43de7c 284 * when the link is secured and setup procedures will not occur unless the
rgrover1 567:e4b38e43de7c 285 * bonding information is either lost or deleted on either or both sides.
rgrover1 567:e4b38e43de7c 286 */
rgrover1 567:e4b38e43de7c 287 virtual void setOnLinkSecured(LinkSecuredCallback_t callback) {onLinkSecured = callback;}
rgrover1 567:e4b38e43de7c 288
rgrover1 567:e4b38e43de7c 289 /**
rgrover1 567:e4b38e43de7c 290 * To indicate that device context is stored persistently.
rgrover1 567:e4b38e43de7c 291 */
rgrover1 567:e4b38e43de7c 292 virtual void setOnSecurityContextStored(HandleSpecificEvent_t callback) {onSecurityContextStored = callback;}
rgrover1 567:e4b38e43de7c 293
rgrover1 567:e4b38e43de7c 294 /**
rgrover1 567:e4b38e43de7c 295 * To set the callback for when the passkey needs to be displayed on a peripheral with DISPLAY capability.
rgrover1 567:e4b38e43de7c 296 */
rgrover1 567:e4b38e43de7c 297 virtual void setOnPasskeyDisplay(PasskeyDisplayCallback_t callback) {onPasskeyDisplay = callback;}
rgrover1 544:840f428d18c7 298
rgrover1 544:840f428d18c7 299 /**
rgrover1 544:840f428d18c7 300 * Append to a chain of callbacks to be invoked upon disconnection; these
rgrover1 544:840f428d18c7 301 * callbacks receive no context and are therefore different from the
rgrover1 567:e4b38e43de7c 302 * onDisconnection callback.
rgrover1 544:840f428d18c7 303 * @param callback
rgrover1 544:840f428d18c7 304 * function pointer to be invoked upon disconnection; receives no context.
rgrover1 567:e4b38e43de7c 305 *
rgrover1 567:e4b38e43de7c 306 * @note the disconnection CallChain should have been merged with
rgrover1 567:e4b38e43de7c 307 * onDisconnctionCallback; but this was not possible because
rgrover1 567:e4b38e43de7c 308 * FunctionPointer (which is a building block for CallChain) doesn't
rgrover1 567:e4b38e43de7c 309 * accept variadic templates.
rgrover1 544:840f428d18c7 310 */
rgrover1 544:840f428d18c7 311 template<typename T>
rgrover1 544:840f428d18c7 312 void addToDisconnectionCallChain(T *tptr, void (T::*mptr)(void)) {disconnectionCallChain.add(tptr, mptr);}
rgrover1 260:ea7f9f14cc15 313
rgrover1 667:875aecb84719 314 private:
rgrover1 567:e4b38e43de7c 315 GapState_t getState(void) const {
rgrover1 567:e4b38e43de7c 316 return state;
rgrover1 567:e4b38e43de7c 317 }
rgrover1 341:8a104d9d80c1 318
rgrover1 260:ea7f9f14cc15 319 protected:
rgrover1 349:b8b2b3973c47 320 Gap() :
rgrover1 349:b8b2b3973c47 321 state(),
rgrover1 567:e4b38e43de7c 322 onTimeout(NULL),
rgrover1 567:e4b38e43de7c 323 onConnection(NULL),
rgrover1 567:e4b38e43de7c 324 onDisconnection(NULL),
rgrover1 567:e4b38e43de7c 325 onRadioNotification(),
rgrover1 567:e4b38e43de7c 326 onSecuritySetupInitiated(),
rgrover1 567:e4b38e43de7c 327 onSecuritySetupCompleted(),
rgrover1 567:e4b38e43de7c 328 onLinkSecured(),
rgrover1 567:e4b38e43de7c 329 onSecurityContextStored(),
rgrover1 567:e4b38e43de7c 330 onPasskeyDisplay(),
rgrover1 382:dcd0428dadb0 331 onAdvertisementReport(),
rgrover1 349:b8b2b3973c47 332 disconnectionCallChain() {
rgrover1 567:e4b38e43de7c 333 /* empty */
rgrover1 260:ea7f9f14cc15 334 }
rgrover1 260:ea7f9f14cc15 335
rgrover1 260:ea7f9f14cc15 336 public:
rgrover1 667:875aecb84719 337 void processConnectionEvent(Handle_t handle,
rgrover1 667:875aecb84719 338 Role_t role,
rgrover1 667:875aecb84719 339 AddressType_t peerAddrType,
rgrover1 667:875aecb84719 340 const Address_t peerAddr,
rgrover1 667:875aecb84719 341 AddressType_t ownAddrType,
rgrover1 667:875aecb84719 342 const Address_t ownAddr,
rgrover1 667:875aecb84719 343 const ConnectionParams_t *connectionParams) {
rgrover1 260:ea7f9f14cc15 344 state.connected = 1;
rgrover1 567:e4b38e43de7c 345 if (onConnection) {
rgrover1 667:875aecb84719 346 ConnectionCallbackParams_t callbackParams(handle, role, peerAddrType, peerAddr, ownAddrType, ownAddr, connectionParams);
rgrover1 667:875aecb84719 347 onConnection(&callbackParams);
rgrover1 260:ea7f9f14cc15 348 }
rgrover1 260:ea7f9f14cc15 349 }
rgrover1 260:ea7f9f14cc15 350
rgrover1 260:ea7f9f14cc15 351 void processDisconnectionEvent(Handle_t handle, DisconnectionReason_t reason) {
rgrover1 260:ea7f9f14cc15 352 state.connected = 0;
rgrover1 567:e4b38e43de7c 353 if (onDisconnection) {
rgrover1 567:e4b38e43de7c 354 onDisconnection(handle, reason);
rgrover1 260:ea7f9f14cc15 355 }
rgrover1 260:ea7f9f14cc15 356 disconnectionCallChain.call();
rgrover1 260:ea7f9f14cc15 357 }
rgrover1 260:ea7f9f14cc15 358
rgrover1 567:e4b38e43de7c 359 void processSecuritySetupInitiatedEvent(Handle_t handle, bool allowBonding, bool requireMITM, SecurityIOCapabilities_t iocaps) {
rgrover1 567:e4b38e43de7c 360 if (onSecuritySetupInitiated) {
rgrover1 567:e4b38e43de7c 361 onSecuritySetupInitiated(handle, allowBonding, requireMITM, iocaps);
rgrover1 567:e4b38e43de7c 362 }
rgrover1 567:e4b38e43de7c 363 }
rgrover1 567:e4b38e43de7c 364
rgrover1 567:e4b38e43de7c 365 void processSecuritySetupCompletedEvent(Handle_t handle, SecurityCompletionStatus_t status) {
rgrover1 567:e4b38e43de7c 366 if (onSecuritySetupCompleted) {
rgrover1 567:e4b38e43de7c 367 onSecuritySetupCompleted(handle, status);
rgrover1 567:e4b38e43de7c 368 }
rgrover1 567:e4b38e43de7c 369 }
rgrover1 567:e4b38e43de7c 370
rgrover1 567:e4b38e43de7c 371 void processLinkSecuredEvent(Handle_t handle, SecurityMode_t securityMode) {
rgrover1 567:e4b38e43de7c 372 if (onLinkSecured) {
rgrover1 567:e4b38e43de7c 373 onLinkSecured(handle, securityMode);
rgrover1 567:e4b38e43de7c 374 }
rgrover1 567:e4b38e43de7c 375 }
rgrover1 567:e4b38e43de7c 376
rgrover1 567:e4b38e43de7c 377 void processSecurityContextStoredEvent(Handle_t handle) {
rgrover1 567:e4b38e43de7c 378 if (onSecurityContextStored) {
rgrover1 567:e4b38e43de7c 379 onSecurityContextStored(handle);
rgrover1 567:e4b38e43de7c 380 }
rgrover1 567:e4b38e43de7c 381 }
rgrover1 567:e4b38e43de7c 382
rgrover1 567:e4b38e43de7c 383 void processPasskeyDisplayEvent(Handle_t handle, const Passkey_t passkey) {
rgrover1 567:e4b38e43de7c 384 if (onPasskeyDisplay) {
rgrover1 567:e4b38e43de7c 385 onPasskeyDisplay(handle, passkey);
rgrover1 567:e4b38e43de7c 386 }
rgrover1 567:e4b38e43de7c 387 }
rgrover1 567:e4b38e43de7c 388
rgrover1 567:e4b38e43de7c 389 void processAdvertisementReport(const Address_t peerAddr,
rgrover1 567:e4b38e43de7c 390 int8_t rssi,
rgrover1 567:e4b38e43de7c 391 bool isScanResponse,
rgrover1 567:e4b38e43de7c 392 AdvertisementType_t type,
rgrover1 567:e4b38e43de7c 393 uint8_t advertisingDataLen,
rgrover1 567:e4b38e43de7c 394 const uint8_t *advertisingData) {
rgrover1 406:cec6778acc66 395 AdvertisementCallbackParams_t params;
rgrover1 406:cec6778acc66 396 memcpy(params.peerAddr, peerAddr, ADDR_LEN);
rgrover1 406:cec6778acc66 397 params.rssi = rssi;
rgrover1 406:cec6778acc66 398 params.isScanResponse = isScanResponse;
rgrover1 406:cec6778acc66 399 params.type = type;
rgrover1 406:cec6778acc66 400 params.advertisingDataLen = advertisingDataLen;
rgrover1 406:cec6778acc66 401 params.advertisingData = advertisingData;
rgrover1 406:cec6778acc66 402 onAdvertisementReport.call(&params);
rgrover1 382:dcd0428dadb0 403 }
rgrover1 382:dcd0428dadb0 404
rgrover1 567:e4b38e43de7c 405 void processEvent(GapEvents::gapEvent_e type) {
rgrover1 567:e4b38e43de7c 406 switch (type) {
rgrover1 567:e4b38e43de7c 407 case GapEvents::GAP_EVENT_TIMEOUT:
rgrover1 567:e4b38e43de7c 408 state.advertising = 0;
rgrover1 567:e4b38e43de7c 409 if (onTimeout) {
rgrover1 567:e4b38e43de7c 410 onTimeout();
rgrover1 567:e4b38e43de7c 411 }
rgrover1 567:e4b38e43de7c 412 break;
rgrover1 567:e4b38e43de7c 413 default:
rgrover1 567:e4b38e43de7c 414 break;
rgrover1 260:ea7f9f14cc15 415 }
rgrover1 260:ea7f9f14cc15 416 }
rgrover1 260:ea7f9f14cc15 417
rgrover1 260:ea7f9f14cc15 418 protected:
rgrover1 363:a3d59a6e5da0 419 GapState_t state;
rgrover1 260:ea7f9f14cc15 420
rgrover1 337:e7c2eb38f5cc 421 protected:
rgrover1 567:e4b38e43de7c 422 EventCallback_t onTimeout;
rgrover1 567:e4b38e43de7c 423 ConnectionEventCallback_t onConnection;
rgrover1 567:e4b38e43de7c 424 DisconnectionEventCallback_t onDisconnection;
rgrover1 567:e4b38e43de7c 425 RadioNotificationEventCallback_t onRadioNotification;
rgrover1 567:e4b38e43de7c 426 SecuritySetupInitiatedCallback_t onSecuritySetupInitiated;
rgrover1 567:e4b38e43de7c 427 SecuritySetupCompletedCallback_t onSecuritySetupCompleted;
rgrover1 567:e4b38e43de7c 428 LinkSecuredCallback_t onLinkSecured;
rgrover1 567:e4b38e43de7c 429 HandleSpecificEvent_t onSecurityContextStored;
rgrover1 567:e4b38e43de7c 430 PasskeyDisplayCallback_t onPasskeyDisplay;
rgrover1 385:6e66d1c6de00 431 AdvertisementReportCallback_t onAdvertisementReport;
rgrover1 363:a3d59a6e5da0 432 CallChain disconnectionCallChain;
rgrover1 260:ea7f9f14cc15 433
rgrover1 260:ea7f9f14cc15 434 private:
rgrover1 260:ea7f9f14cc15 435 /* disallow copy and assignment */
rgrover1 260:ea7f9f14cc15 436 Gap(const Gap &);
rgrover1 260:ea7f9f14cc15 437 Gap& operator=(const Gap &);
rgrover1 260:ea7f9f14cc15 438 };
rgrover1 260:ea7f9f14cc15 439
rgrover1 260:ea7f9f14cc15 440 #endif // ifndef __GAP_H__