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

Committer:
rgrover1
Date:
Fri Jun 19 15:52:52 2015 +0100
Revision:
597:d5c689f48cf9
Parent:
596:0ee6d5f6712a
Child:
598:5e2bbddc8701
Synchronized with git rev 93033eca

Author: Rohit Grover

rehome a declaration

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