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