Microbug / BLE_API

Minor temporary patch to allow DFU packet callback

Fork of BLE_API by Bluetooth Low Energy

public/Gap.h@392:3201f029c2eb, 2015-05-13 (annotated)

Committer:
rgrover1
Date:
Wed May 13 08:51:08 2015 +0100
Revision:
392:3201f029c2eb
Parent:
388:3fa9ce3b1b7a
Child:
397:9f5bfae7ea50
Synchronized with git rev abf33168

Author: Rohit Grover

shorten *scanning* to *scan* in APIs

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