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@670:5e4aecd9af5b, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:53:01 2015 +0100
Revision:
670:5e4aecd9af5b
Parent:
669:7179b4a5aa7d
Child:
674:923c47bd1547
Synchronized with git rev 532535b1

Author: Rohit Grover

Merge branch 'gattClient' into develop

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