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

ble/Gap.h@1115:82d4a8a56d91, 2016-01-11 (annotated)

Committer:
vcoubard
Date:
Mon Jan 11 08:52:01 2016 +0000
Revision:
1115:82d4a8a56d91
Parent:
1111:30326e58c830
Child:
1116:9cb51490b3f7
Synchronized with git rev f7570e8b

Author: Andres Amaya Garcia

Early whitelisting API

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 710:b2e1a2660ec2 1 /* mbed Microcontroller Library
rgrover1 710:b2e1a2660ec2 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 710:b2e1a2660ec2 3 *
rgrover1 710:b2e1a2660ec2 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 710:b2e1a2660ec2 5 * you may not use this file except in compliance with the License.
rgrover1 710:b2e1a2660ec2 6 * You may obtain a copy of the License at
rgrover1 710:b2e1a2660ec2 7 *
rgrover1 710:b2e1a2660ec2 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 710:b2e1a2660ec2 9 *
rgrover1 710:b2e1a2660ec2 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 710:b2e1a2660ec2 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 710:b2e1a2660ec2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 710:b2e1a2660ec2 13 * See the License for the specific language governing permissions and
rgrover1 710:b2e1a2660ec2 14 * limitations under the License.
rgrover1 710:b2e1a2660ec2 15 */
rgrover1 710:b2e1a2660ec2 16
rgrover1 710:b2e1a2660ec2 17 #ifndef __GAP_H__
rgrover1 710:b2e1a2660ec2 18 #define __GAP_H__
rgrover1 710:b2e1a2660ec2 19
vcoubard 1078:79c089630b38 20 #include "ble/BLEProtocol.h"
rgrover1 710:b2e1a2660ec2 21 #include "GapAdvertisingData.h"
rgrover1 710:b2e1a2660ec2 22 #include "GapAdvertisingParams.h"
rgrover1 710:b2e1a2660ec2 23 #include "GapScanningParams.h"
rgrover1 710:b2e1a2660ec2 24 #include "GapEvents.h"
rgrover1 829:9072de50087b 25 #include "CallChainOfFunctionPointersWithContext.h"
rgrover1 710:b2e1a2660ec2 26 #include "FunctionPointerWithContext.h"
vcoubard 1115:82d4a8a56d91 27 #include <set>
rgrover1 710:b2e1a2660ec2 28
vcoubard 1048:efb29faf12fc 29 /* Forward declarations for classes that will only be used for pointers or references in the following. */
rgrover1 710:b2e1a2660ec2 30 class GapAdvertisingParams;
rgrover1 710:b2e1a2660ec2 31 class GapScanningParams;
rgrover1 710:b2e1a2660ec2 32 class GapAdvertisingData;
rgrover1 710:b2e1a2660ec2 33
rgrover1 710:b2e1a2660ec2 34 class Gap {
vcoubard 1078:79c089630b38 35 /*
vcoubard 1078:79c089630b38 36 * DEPRECATION ALERT: all of the APIs in this `public` block are deprecated.
vcoubard 1078:79c089630b38 37 * They have been relocated to the class BLEProtocol.
vcoubard 1078:79c089630b38 38 */
rgrover1 710:b2e1a2660ec2 39 public:
vcoubard 1078:79c089630b38 40 /**
vcoubard 1078:79c089630b38 41 * Address-type for BLEProtocol addresses.
vcoubard 1091:58b2dac13261 42 *
vcoubard 1086:75d4e8ce277d 43 * @note: deprecated. Use BLEProtocol::AddressType_t instead.
vcoubard 1078:79c089630b38 44 */
vcoubard 1086:75d4e8ce277d 45 typedef BLEProtocol::AddressType_t AddressType_t;
vcoubard 1086:75d4e8ce277d 46
vcoubard 1086:75d4e8ce277d 47 /**
vcoubard 1086:75d4e8ce277d 48 * Address-type for BLEProtocol addresses.
vcoubard 1086:75d4e8ce277d 49 * @note: deprecated. Use BLEProtocol::AddressType_t instead.
vcoubard 1087:4c6e11878033 50 */
vcoubard 1087:4c6e11878033 51 typedef BLEProtocol::AddressType_t addr_type_t;
vcoubard 1087:4c6e11878033 52
vcoubard 1091:58b2dac13261 53 /**
vcoubard 1091:58b2dac13261 54 * Address-type for BLEProtocol addresses.
vcoubard 1115:82d4a8a56d91 55 * @note: deprecated. Use BLEProtocol::AddressType_t instead.
vcoubard 1091:58b2dac13261 56 *
vcoubard 1091:58b2dac13261 57 * DEPRECATION ALERT: The following constants have been left in their
vcoubard 1091:58b2dac13261 58 * deprecated state to transparenly support existing applications which may
vcoubard 1091:58b2dac13261 59 * have used Gap::ADDR_TYPE_*.
vcoubard 1091:58b2dac13261 60 */
vcoubard 1115:82d4a8a56d91 61 enum {
vcoubard 1091:58b2dac13261 62 ADDR_TYPE_PUBLIC = BLEProtocol::AddressType::PUBLIC,
vcoubard 1091:58b2dac13261 63 ADDR_TYPE_RANDOM_STATIC = BLEProtocol::AddressType::RANDOM_STATIC,
vcoubard 1091:58b2dac13261 64 ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE = BLEProtocol::AddressType::RANDOM_PRIVATE_RESOLVABLE,
vcoubard 1091:58b2dac13261 65 ADDR_TYPE_RANDOM_PRIVATE_NON_RESOLVABLE = BLEProtocol::AddressType::RANDOM_PRIVATE_NON_RESOLVABLE
vcoubard 1091:58b2dac13261 66 };
vcoubard 1091:58b2dac13261 67
vcoubard 1078:79c089630b38 68 static const unsigned ADDR_LEN = BLEProtocol::ADDR_LEN; /**< Length (in octets) of the BLE MAC address. */
vcoubard 1115:82d4a8a56d91 69 typedef BLEProtocol::AddressBytes_t Address_t; /**< 48-bit address, LSB format. @Note: Deprecated. Use BLEProtocol::Address_t instead. */
vcoubard 1115:82d4a8a56d91 70 typedef BLEProtocol::AddressBytes_t address_t; /**< 48-bit address, LSB format. @Note: Deprecated. Use BLEProtocol::Address_t instead. */
vcoubard 1078:79c089630b38 71
vcoubard 1078:79c089630b38 72 public:
rgrover1 710:b2e1a2660ec2 73 enum TimeoutSource_t {
rgrover1 710:b2e1a2660ec2 74 TIMEOUT_SRC_ADVERTISING = 0x00, /**< Advertising timeout. */
rgrover1 710:b2e1a2660ec2 75 TIMEOUT_SRC_SECURITY_REQUEST = 0x01, /**< Security request timeout. */
rgrover1 710:b2e1a2660ec2 76 TIMEOUT_SRC_SCAN = 0x02, /**< Scanning timeout. */
rgrover1 710:b2e1a2660ec2 77 TIMEOUT_SRC_CONN = 0x03, /**< Connection timeout. */
rgrover1 710:b2e1a2660ec2 78 };
rgrover1 710:b2e1a2660ec2 79
rgrover1 710:b2e1a2660ec2 80 /**
rgrover1 710:b2e1a2660ec2 81 * Enumeration for disconnection reasons. The values for these reasons are
vcoubard 1048:efb29faf12fc 82 * derived from Nordic's implementation, but the reasons are meant to be
vcoubard 1048:efb29faf12fc 83 * independent of the transport. If you are returned a reason that is not
vcoubard 1048:efb29faf12fc 84 * covered by this enumeration, please refer to the underlying
rgrover1 710:b2e1a2660ec2 85 * transport library.
rgrover1 710:b2e1a2660ec2 86 */
rgrover1 710:b2e1a2660ec2 87 enum DisconnectionReason_t {
rgrover1 710:b2e1a2660ec2 88 CONNECTION_TIMEOUT = 0x08,
rgrover1 710:b2e1a2660ec2 89 REMOTE_USER_TERMINATED_CONNECTION = 0x13,
vcoubard 1048:efb29faf12fc 90 REMOTE_DEV_TERMINATION_DUE_TO_LOW_RESOURCES = 0x14, /**< Remote device terminated connection due to low resources.*/
vcoubard 1048:efb29faf12fc 91 REMOTE_DEV_TERMINATION_DUE_TO_POWER_OFF = 0x15, /**< Remote device terminated connection due to power off. */
rgrover1 710:b2e1a2660ec2 92 LOCAL_HOST_TERMINATED_CONNECTION = 0x16,
rgrover1 710:b2e1a2660ec2 93 CONN_INTERVAL_UNACCEPTABLE = 0x3B,
rgrover1 710:b2e1a2660ec2 94 };
rgrover1 710:b2e1a2660ec2 95
vcoubard 1048:efb29faf12fc 96 /* Describes the current state of the device (more than one bit can be set). */
rgrover1 710:b2e1a2660ec2 97 struct GapState_t {
vcoubard 1048:efb29faf12fc 98 unsigned advertising : 1; /**< Peripheral is currently advertising. */
vcoubard 1048:efb29faf12fc 99 unsigned connected : 1; /**< Peripheral is connected to a central. */
rgrover1 710:b2e1a2660ec2 100 };
rgrover1 710:b2e1a2660ec2 101
rgrover1 710:b2e1a2660ec2 102 typedef uint16_t Handle_t; /* Type for connection handle. */
rgrover1 710:b2e1a2660ec2 103
rgrover1 710:b2e1a2660ec2 104 typedef struct {
rgrover1 710:b2e1a2660ec2 105 uint16_t minConnectionInterval; /**< Minimum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 710:b2e1a2660ec2 106 uint16_t maxConnectionInterval; /**< Maximum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 710:b2e1a2660ec2 107 uint16_t slaveLatency; /**< Slave Latency in number of connection events, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 710:b2e1a2660ec2 108 uint16_t connectionSupervisionTimeout; /**< Connection Supervision Timeout in 10 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 710:b2e1a2660ec2 109 } ConnectionParams_t;
rgrover1 710:b2e1a2660ec2 110
rgrover1 710:b2e1a2660ec2 111 enum Role_t {
rgrover1 710:b2e1a2660ec2 112 PERIPHERAL = 0x1, /**< Peripheral Role. */
rgrover1 710:b2e1a2660ec2 113 CENTRAL = 0x2, /**< Central Role. */
rgrover1 710:b2e1a2660ec2 114 };
rgrover1 710:b2e1a2660ec2 115
rgrover1 710:b2e1a2660ec2 116 struct AdvertisementCallbackParams_t {
vcoubard 1115:82d4a8a56d91 117 BLEProtocol::AddressBytes_t peerAddr;
vcoubard 1079:6e2d9514f3df 118 int8_t rssi;
vcoubard 1079:6e2d9514f3df 119 bool isScanResponse;
vcoubard 1079:6e2d9514f3df 120 GapAdvertisingParams::AdvertisingType_t type;
vcoubard 1079:6e2d9514f3df 121 uint8_t advertisingDataLen;
vcoubard 1079:6e2d9514f3df 122 const uint8_t *advertisingData;
rgrover1 710:b2e1a2660ec2 123 };
rgrover1 710:b2e1a2660ec2 124 typedef FunctionPointerWithContext<const AdvertisementCallbackParams_t *> AdvertisementReportCallback_t;
rgrover1 710:b2e1a2660ec2 125
rgrover1 710:b2e1a2660ec2 126 struct ConnectionCallbackParams_t {
vcoubard 1078:79c089630b38 127 Handle_t handle;
vcoubard 1078:79c089630b38 128 Role_t role;
vcoubard 1078:79c089630b38 129 BLEProtocol::AddressType_t peerAddrType;
vcoubard 1115:82d4a8a56d91 130 BLEProtocol::AddressBytes_t peerAddr;
vcoubard 1078:79c089630b38 131 BLEProtocol::AddressType_t ownAddrType;
vcoubard 1115:82d4a8a56d91 132 BLEProtocol::AddressBytes_t ownAddr;
vcoubard 1078:79c089630b38 133 const ConnectionParams_t *connectionParams;
rgrover1 710:b2e1a2660ec2 134
vcoubard 1078:79c089630b38 135 ConnectionCallbackParams_t(Handle_t handleIn,
vcoubard 1078:79c089630b38 136 Role_t roleIn,
vcoubard 1078:79c089630b38 137 BLEProtocol::AddressType_t peerAddrTypeIn,
vcoubard 1078:79c089630b38 138 const uint8_t *peerAddrIn,
vcoubard 1078:79c089630b38 139 BLEProtocol::AddressType_t ownAddrTypeIn,
vcoubard 1078:79c089630b38 140 const uint8_t *ownAddrIn,
vcoubard 1078:79c089630b38 141 const ConnectionParams_t *connectionParamsIn) :
rgrover1 710:b2e1a2660ec2 142 handle(handleIn),
rgrover1 710:b2e1a2660ec2 143 role(roleIn),
rgrover1 710:b2e1a2660ec2 144 peerAddrType(peerAddrTypeIn),
rgrover1 710:b2e1a2660ec2 145 peerAddr(),
rgrover1 710:b2e1a2660ec2 146 ownAddrType(ownAddrTypeIn),
rgrover1 710:b2e1a2660ec2 147 ownAddr(),
rgrover1 710:b2e1a2660ec2 148 connectionParams(connectionParamsIn) {
rgrover1 710:b2e1a2660ec2 149 memcpy(peerAddr, peerAddrIn, ADDR_LEN);
rgrover1 710:b2e1a2660ec2 150 memcpy(ownAddr, ownAddrIn, ADDR_LEN);
rgrover1 710:b2e1a2660ec2 151 }
rgrover1 710:b2e1a2660ec2 152 };
rgrover1 710:b2e1a2660ec2 153
rgrover1 829:9072de50087b 154 struct DisconnectionCallbackParams_t {
rgrover1 829:9072de50087b 155 Handle_t handle;
rgrover1 829:9072de50087b 156 DisconnectionReason_t reason;
rgrover1 829:9072de50087b 157
rgrover1 829:9072de50087b 158 DisconnectionCallbackParams_t(Handle_t handleIn,
rgrover1 829:9072de50087b 159 DisconnectionReason_t reasonIn) :
rgrover1 829:9072de50087b 160 handle(handleIn),
rgrover1 829:9072de50087b 161 reason(reasonIn)
rgrover1 829:9072de50087b 162 {}
rgrover1 829:9072de50087b 163 };
rgrover1 829:9072de50087b 164
rgrover1 710:b2e1a2660ec2 165 static const uint16_t UNIT_1_25_MS = 1250; /**< Number of microseconds in 1.25 milliseconds. */
rgrover1 710:b2e1a2660ec2 166 static uint16_t MSEC_TO_GAP_DURATION_UNITS(uint32_t durationInMillis) {
rgrover1 710:b2e1a2660ec2 167 return (durationInMillis * 1000) / UNIT_1_25_MS;
rgrover1 710:b2e1a2660ec2 168 }
rgrover1 766:03f1a26f132f 169
vcoubard 1052:b55e1ad3e1b3 170 typedef FunctionPointerWithContext<TimeoutSource_t> TimeoutEventCallback_t;
vcoubard 1052:b55e1ad3e1b3 171 typedef CallChainOfFunctionPointersWithContext<TimeoutSource_t> TimeoutEventCallbackChain_t;
rgrover1 710:b2e1a2660ec2 172
vcoubard 1052:b55e1ad3e1b3 173 typedef FunctionPointerWithContext<const ConnectionCallbackParams_t *> ConnectionEventCallback_t;
vcoubard 1052:b55e1ad3e1b3 174 typedef CallChainOfFunctionPointersWithContext<const ConnectionCallbackParams_t *> ConnectionEventCallbackChain_t;
vcoubard 1052:b55e1ad3e1b3 175
vcoubard 1052:b55e1ad3e1b3 176 typedef FunctionPointerWithContext<const DisconnectionCallbackParams_t*> DisconnectionEventCallback_t;
vcoubard 1054:f59e5d9a992a 177 typedef CallChainOfFunctionPointersWithContext<const DisconnectionCallbackParams_t*> DisconnectionEventCallbackChain_t;
vcoubard 1052:b55e1ad3e1b3 178
rgrover1 753:0f60274cd3ad 179 typedef FunctionPointerWithContext<bool> RadioNotificationEventCallback_t;
rgrover1 710:b2e1a2660ec2 180
vcoubard 1090:148d8b9b56a5 181 typedef FunctionPointerWithContext<const Gap *> GapShutdownCallback_t;
vcoubard 1090:148d8b9b56a5 182 typedef CallChainOfFunctionPointersWithContext<const Gap *> GapShutdownCallbackChain_t;
vcoubard 1090:148d8b9b56a5 183
rgrover1 710:b2e1a2660ec2 184 /*
rgrover1 710:b2e1a2660ec2 185 * The following functions are meant to be overridden in the platform-specific sub-class.
rgrover1 710:b2e1a2660ec2 186 */
rgrover1 710:b2e1a2660ec2 187 public:
rgrover1 710:b2e1a2660ec2 188 /**
rgrover1 710:b2e1a2660ec2 189 * Set the BTLE MAC address and type. Please note that the address format is
vcoubard 1079:6e2d9514f3df 190 * least significant byte first (LSB). Please refer to BLEProtocol::Address_t.
rgrover1 710:b2e1a2660ec2 191 *
rgrover1 710:b2e1a2660ec2 192 * @return BLE_ERROR_NONE on success.
rgrover1 710:b2e1a2660ec2 193 */
vcoubard 1115:82d4a8a56d91 194 virtual ble_error_t setAddress(BLEProtocol::AddressType_t type, const BLEProtocol::AddressBytes_t address) {
rgrover1 734:4872b70437ce 195 /* avoid compiler warnings about unused variables */
rgrover1 734:4872b70437ce 196 (void)type;
rgrover1 734:4872b70437ce 197 (void)address;
rgrover1 734:4872b70437ce 198
rgrover1 728:997ba5e7b3b6 199 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 200 }
rgrover1 710:b2e1a2660ec2 201
rgrover1 710:b2e1a2660ec2 202 /**
rgrover1 710:b2e1a2660ec2 203 * Fetch the BTLE MAC address and type.
rgrover1 710:b2e1a2660ec2 204 *
rgrover1 710:b2e1a2660ec2 205 * @return BLE_ERROR_NONE on success.
rgrover1 710:b2e1a2660ec2 206 */
vcoubard 1115:82d4a8a56d91 207 virtual ble_error_t getAddress(BLEProtocol::AddressType_t *typeP, BLEProtocol::AddressBytes_t address) {
vcoubard 1048:efb29faf12fc 208 /* Avoid compiler warnings about unused variables. */
rgrover1 734:4872b70437ce 209 (void)typeP;
rgrover1 734:4872b70437ce 210 (void)address;
rgrover1 734:4872b70437ce 211
rgrover1 728:997ba5e7b3b6 212 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 213 }
rgrover1 710:b2e1a2660ec2 214
rgrover1 710:b2e1a2660ec2 215 /**
vcoubard 1056:ce2fb3d09929 216 * @return Minimum Advertising interval in milliseconds for connectable
vcoubard 1056:ce2fb3d09929 217 * undirected and connectable directed event types.
rgrover1 710:b2e1a2660ec2 218 */
rgrover1 710:b2e1a2660ec2 219 virtual uint16_t getMinAdvertisingInterval(void) const {
rgrover1 742:861ed7eb186d 220 return 0; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 221 }
rgrover1 710:b2e1a2660ec2 222
rgrover1 710:b2e1a2660ec2 223 /**
vcoubard 1056:ce2fb3d09929 224 * @return Minimum Advertising interval in milliseconds for scannable
vcoubard 1056:ce2fb3d09929 225 * undirected and non-connectable undirected event types.
rgrover1 710:b2e1a2660ec2 226 */
rgrover1 710:b2e1a2660ec2 227 virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const {
rgrover1 742:861ed7eb186d 228 return 0; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 229 }
rgrover1 710:b2e1a2660ec2 230
rgrover1 710:b2e1a2660ec2 231 /**
rgrover1 710:b2e1a2660ec2 232 * @return Maximum Advertising interval in milliseconds.
rgrover1 710:b2e1a2660ec2 233 */
rgrover1 710:b2e1a2660ec2 234 virtual uint16_t getMaxAdvertisingInterval(void) const {
rgrover1 742:861ed7eb186d 235 return 0xFFFF; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 236 }
rgrover1 710:b2e1a2660ec2 237
rgrover1 710:b2e1a2660ec2 238 virtual ble_error_t stopAdvertising(void) {
rgrover1 728:997ba5e7b3b6 239 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 240 }
rgrover1 710:b2e1a2660ec2 241
rgrover1 710:b2e1a2660ec2 242 /**
rgrover1 710:b2e1a2660ec2 243 * Stop scanning. The current scanning parameters remain in effect.
rgrover1 710:b2e1a2660ec2 244 *
rgrover1 710:b2e1a2660ec2 245 * @retval BLE_ERROR_NONE if successfully stopped scanning procedure.
rgrover1 710:b2e1a2660ec2 246 */
rgrover1 710:b2e1a2660ec2 247 virtual ble_error_t stopScan() {
rgrover1 728:997ba5e7b3b6 248 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 249 }
rgrover1 710:b2e1a2660ec2 250
rgrover1 710:b2e1a2660ec2 251 /**
rgrover1 710:b2e1a2660ec2 252 * Create a connection (GAP Link Establishment).
rgrover1 710:b2e1a2660ec2 253 *
rgrover1 710:b2e1a2660ec2 254 * @param peerAddr
rgrover1 710:b2e1a2660ec2 255 * 48-bit address, LSB format.
rgrover1 710:b2e1a2660ec2 256 * @param peerAddrType
rgrover1 710:b2e1a2660ec2 257 * Address type of the peer.
rgrover1 710:b2e1a2660ec2 258 * @param connectionParams
rgrover1 710:b2e1a2660ec2 259 * Connection parameters.
rgrover1 710:b2e1a2660ec2 260 * @param scanParams
rgrover1 710:b2e1a2660ec2 261 * Paramters to be used while scanning for the peer.
rgrover1 710:b2e1a2660ec2 262 * @return BLE_ERROR_NONE if connection establishment procedure is started
rgrover1 829:9072de50087b 263 * successfully. The connectionCallChain (if set) will be invoked upon
rgrover1 710:b2e1a2660ec2 264 * a connection event.
rgrover1 710:b2e1a2660ec2 265 */
vcoubard 1115:82d4a8a56d91 266 virtual ble_error_t connect(const BLEProtocol::AddressBytes_t peerAddr,
vcoubard 1079:6e2d9514f3df 267 BLEProtocol::AddressType_t peerAddrType,
vcoubard 1079:6e2d9514f3df 268 const ConnectionParams_t *connectionParams,
vcoubard 1079:6e2d9514f3df 269 const GapScanningParams *scanParams) {
vcoubard 1048:efb29faf12fc 270 /* Avoid compiler warnings about unused variables. */
rgrover1 734:4872b70437ce 271 (void)peerAddr;
rgrover1 734:4872b70437ce 272 (void)peerAddrType;
rgrover1 734:4872b70437ce 273 (void)connectionParams;
rgrover1 734:4872b70437ce 274 (void)scanParams;
rgrover1 734:4872b70437ce 275
rgrover1 728:997ba5e7b3b6 276 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 277 }
rgrover1 710:b2e1a2660ec2 278
rgrover1 710:b2e1a2660ec2 279 /**
rgrover1 710:b2e1a2660ec2 280 * This call initiates the disconnection procedure, and its completion will
rgrover1 710:b2e1a2660ec2 281 * be communicated to the application with an invocation of the
rgrover1 710:b2e1a2660ec2 282 * disconnectionCallback.
rgrover1 710:b2e1a2660ec2 283 *
rgrover1 710:b2e1a2660ec2 284 * @param reason
vcoubard 1048:efb29faf12fc 285 * The reason for disconnection; to be sent back to the peer.
rgrover1 710:b2e1a2660ec2 286 */
rgrover1 710:b2e1a2660ec2 287 virtual ble_error_t disconnect(Handle_t connectionHandle, DisconnectionReason_t reason) {
rgrover1 734:4872b70437ce 288 /* avoid compiler warnings about unused variables */
rgrover1 734:4872b70437ce 289 (void)connectionHandle;
rgrover1 734:4872b70437ce 290 (void)reason;
rgrover1 734:4872b70437ce 291
rgrover1 728:997ba5e7b3b6 292 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 293 }
rgrover1 710:b2e1a2660ec2 294
rgrover1 710:b2e1a2660ec2 295 /**
rgrover1 710:b2e1a2660ec2 296 * This call initiates the disconnection procedure, and its completion will
rgrover1 710:b2e1a2660ec2 297 * be communicated to the application with an invocation of the
rgrover1 710:b2e1a2660ec2 298 * disconnectionCallback.
rgrover1 710:b2e1a2660ec2 299 *
rgrover1 710:b2e1a2660ec2 300 * @param reason
vcoubard 1048:efb29faf12fc 301 * The reason for disconnection; to be sent back to the peer.
rgrover1 710:b2e1a2660ec2 302 *
vcoubard 1048:efb29faf12fc 303 * @note: This version of disconnect() doesn't take a connection handle. It
vcoubard 1048:efb29faf12fc 304 * works reliably only for stacks that are limited to a single
rgrover1 710:b2e1a2660ec2 305 * connection. This API should be considered *deprecated* in favour of the
vcoubard 1048:efb29faf12fc 306 * alternative, which takes a connection handle. It will be dropped in the future.
rgrover1 710:b2e1a2660ec2 307 */
rgrover1 710:b2e1a2660ec2 308 virtual ble_error_t disconnect(DisconnectionReason_t reason) {
vcoubard 1048:efb29faf12fc 309 /* Avoid compiler warnings about unused variables. */
rgrover1 734:4872b70437ce 310 (void)reason;
rgrover1 734:4872b70437ce 311
rgrover1 728:997ba5e7b3b6 312 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 313 }
rgrover1 710:b2e1a2660ec2 314
rgrover1 710:b2e1a2660ec2 315 /**
rgrover1 710:b2e1a2660ec2 316 * Get the GAP peripheral preferred connection parameters. These are the
rgrover1 710:b2e1a2660ec2 317 * defaults that the peripheral would like to have in a connection. The
rgrover1 710:b2e1a2660ec2 318 * choice of the connection parameters is eventually up to the central.
rgrover1 710:b2e1a2660ec2 319 *
rgrover1 710:b2e1a2660ec2 320 * @param[out] params
rgrover1 710:b2e1a2660ec2 321 * The structure where the parameters will be stored. Memory
rgrover1 710:b2e1a2660ec2 322 * for this is owned by the caller.
rgrover1 710:b2e1a2660ec2 323 *
rgrover1 710:b2e1a2660ec2 324 * @return BLE_ERROR_NONE if the parameters were successfully filled into
rgrover1 710:b2e1a2660ec2 325 * the given structure pointed to by params.
rgrover1 710:b2e1a2660ec2 326 */
rgrover1 710:b2e1a2660ec2 327 virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params) {
vcoubard 1048:efb29faf12fc 328 /* Avoid compiler warnings about unused variables. */
rgrover1 734:4872b70437ce 329 (void)params;
rgrover1 734:4872b70437ce 330
rgrover1 728:997ba5e7b3b6 331 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 332 }
rgrover1 710:b2e1a2660ec2 333
rgrover1 710:b2e1a2660ec2 334 /**
rgrover1 710:b2e1a2660ec2 335 * Set the GAP peripheral preferred connection parameters. These are the
rgrover1 710:b2e1a2660ec2 336 * defaults that the peripheral would like to have in a connection. The
rgrover1 710:b2e1a2660ec2 337 * choice of the connection parameters is eventually up to the central.
rgrover1 710:b2e1a2660ec2 338 *
rgrover1 710:b2e1a2660ec2 339 * @param[in] params
rgrover1 710:b2e1a2660ec2 340 * The structure containing the desired parameters.
rgrover1 710:b2e1a2660ec2 341 */
rgrover1 710:b2e1a2660ec2 342 virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params) {
vcoubard 1048:efb29faf12fc 343 /* Avoid compiler warnings about unused variables. */
rgrover1 734:4872b70437ce 344 (void)params;
rgrover1 734:4872b70437ce 345
rgrover1 728:997ba5e7b3b6 346 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 347 }
rgrover1 710:b2e1a2660ec2 348
rgrover1 710:b2e1a2660ec2 349 /**
rgrover1 816:2b4f0ef8c06e 350 * Update connection parameters.
vcoubard 1048:efb29faf12fc 351 * In the central role this will initiate a Link Layer connection parameter update procedure.
vcoubard 1048:efb29faf12fc 352 * In the peripheral role, this will send the corresponding L2CAP request and wait for
rgrover1 816:2b4f0ef8c06e 353 * the central to perform the procedure.
rgrover1 816:2b4f0ef8c06e 354 *
rgrover1 710:b2e1a2660ec2 355 * @param[in] handle
vcoubard 1048:efb29faf12fc 356 * Connection Handle.
rgrover1 710:b2e1a2660ec2 357 * @param[in] params
rgrover1 710:b2e1a2660ec2 358 * Pointer to desired connection parameters. If NULL is provided on a peripheral role,
rgrover1 710:b2e1a2660ec2 359 * the parameters in the PPCP characteristic of the GAP service will be used instead.
rgrover1 710:b2e1a2660ec2 360 */
rgrover1 710:b2e1a2660ec2 361 virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params) {
rgrover1 734:4872b70437ce 362 /* avoid compiler warnings about unused variables */
rgrover1 734:4872b70437ce 363 (void)handle;
rgrover1 734:4872b70437ce 364 (void)params;
rgrover1 734:4872b70437ce 365
rgrover1 728:997ba5e7b3b6 366 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 367 }
rgrover1 710:b2e1a2660ec2 368
rgrover1 710:b2e1a2660ec2 369 /**
rgrover1 710:b2e1a2660ec2 370 * Set the device name characteristic in the GAP service.
rgrover1 710:b2e1a2660ec2 371 * @param[in] deviceName
rgrover1 710:b2e1a2660ec2 372 * The new value for the device-name. This is a UTF-8 encoded, <b>NULL-terminated</b> string.
rgrover1 710:b2e1a2660ec2 373 */
rgrover1 710:b2e1a2660ec2 374 virtual ble_error_t setDeviceName(const uint8_t *deviceName) {
vcoubard 1048:efb29faf12fc 375 /* Avoid compiler warnings about unused variables. */
rgrover1 734:4872b70437ce 376 (void)deviceName;
rgrover1 734:4872b70437ce 377
rgrover1 728:997ba5e7b3b6 378 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 379 }
rgrover1 710:b2e1a2660ec2 380
rgrover1 710:b2e1a2660ec2 381 /**
rgrover1 710:b2e1a2660ec2 382 * Get the value of the device name characteristic in the GAP service.
rgrover1 710:b2e1a2660ec2 383 * @param[out] deviceName
rgrover1 710:b2e1a2660ec2 384 * Pointer to an empty buffer where the UTF-8 *non NULL-
rgrover1 710:b2e1a2660ec2 385 * terminated* string will be placed. Set this
rgrover1 710:b2e1a2660ec2 386 * value to NULL in order to obtain the deviceName-length
rgrover1 710:b2e1a2660ec2 387 * from the 'length' parameter.
rgrover1 710:b2e1a2660ec2 388 *
rgrover1 710:b2e1a2660ec2 389 * @param[in/out] lengthP
rgrover1 710:b2e1a2660ec2 390 * (on input) Length of the buffer pointed to by deviceName;
rgrover1 710:b2e1a2660ec2 391 * (on output) the complete device name length (without the
rgrover1 710:b2e1a2660ec2 392 * null terminator).
rgrover1 710:b2e1a2660ec2 393 *
rgrover1 710:b2e1a2660ec2 394 * @note If the device name is longer than the size of the supplied buffer,
rgrover1 710:b2e1a2660ec2 395 * length will return the complete device name length, and not the
rgrover1 710:b2e1a2660ec2 396 * number of bytes actually returned in deviceName. The application may
rgrover1 710:b2e1a2660ec2 397 * use this information to retry with a suitable buffer size.
rgrover1 710:b2e1a2660ec2 398 */
rgrover1 710:b2e1a2660ec2 399 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP) {
rgrover1 734:4872b70437ce 400 /* avoid compiler warnings about unused variables */
rgrover1 734:4872b70437ce 401 (void)deviceName;
rgrover1 734:4872b70437ce 402 (void)lengthP;
rgrover1 734:4872b70437ce 403
rgrover1 728:997ba5e7b3b6 404 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 405 }
rgrover1 710:b2e1a2660ec2 406
rgrover1 710:b2e1a2660ec2 407 /**
rgrover1 710:b2e1a2660ec2 408 * Set the appearance characteristic in the GAP service.
rgrover1 710:b2e1a2660ec2 409 * @param[in] appearance
rgrover1 710:b2e1a2660ec2 410 * The new value for the device-appearance.
rgrover1 710:b2e1a2660ec2 411 */
rgrover1 710:b2e1a2660ec2 412 virtual ble_error_t setAppearance(GapAdvertisingData::Appearance appearance) {
vcoubard 1048:efb29faf12fc 413 /* Avoid compiler warnings about unused variables. */
rgrover1 734:4872b70437ce 414 (void)appearance;
rgrover1 734:4872b70437ce 415
rgrover1 728:997ba5e7b3b6 416 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 417 }
rgrover1 710:b2e1a2660ec2 418
rgrover1 710:b2e1a2660ec2 419 /**
rgrover1 710:b2e1a2660ec2 420 * Get the appearance characteristic in the GAP service.
rgrover1 710:b2e1a2660ec2 421 * @param[out] appearance
rgrover1 710:b2e1a2660ec2 422 * The new value for the device-appearance.
rgrover1 710:b2e1a2660ec2 423 */
rgrover1 710:b2e1a2660ec2 424 virtual ble_error_t getAppearance(GapAdvertisingData::Appearance *appearanceP) {
vcoubard 1048:efb29faf12fc 425 /* Avoid compiler warnings about unused variables. */
rgrover1 734:4872b70437ce 426 (void)appearanceP;
rgrover1 734:4872b70437ce 427
rgrover1 728:997ba5e7b3b6 428 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 429 }
rgrover1 710:b2e1a2660ec2 430
rgrover1 710:b2e1a2660ec2 431 /**
rgrover1 710:b2e1a2660ec2 432 * Set the radio's transmit power.
rgrover1 710:b2e1a2660ec2 433 * @param[in] txPower Radio transmit power in dBm.
rgrover1 710:b2e1a2660ec2 434 */
rgrover1 710:b2e1a2660ec2 435 virtual ble_error_t setTxPower(int8_t txPower) {
vcoubard 1048:efb29faf12fc 436 /* Avoid compiler warnings about unused variables. */
rgrover1 734:4872b70437ce 437 (void)txPower;
rgrover1 734:4872b70437ce 438
rgrover1 728:997ba5e7b3b6 439 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 440 }
rgrover1 710:b2e1a2660ec2 441
rgrover1 710:b2e1a2660ec2 442 /**
rgrover1 710:b2e1a2660ec2 443 * Query the underlying stack for permitted arguments for setTxPower().
rgrover1 710:b2e1a2660ec2 444 *
rgrover1 710:b2e1a2660ec2 445 * @param[out] valueArrayPP
rgrover1 710:b2e1a2660ec2 446 * Out parameter to receive the immutable array of Tx values.
rgrover1 710:b2e1a2660ec2 447 * @param[out] countP
rgrover1 710:b2e1a2660ec2 448 * Out parameter to receive the array's size.
rgrover1 710:b2e1a2660ec2 449 */
rgrover1 710:b2e1a2660ec2 450 virtual void getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP) {
vcoubard 1048:efb29faf12fc 451 /* Avoid compiler warnings about unused variables. */
rgrover1 734:4872b70437ce 452 (void)valueArrayPP;
rgrover1 734:4872b70437ce 453 (void)countP;
rgrover1 734:4872b70437ce 454
rgrover1 742:861ed7eb186d 455 *countP = 0; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 456 }
rgrover1 710:b2e1a2660ec2 457
rgrover1 710:b2e1a2660ec2 458 protected:
rgrover1 710:b2e1a2660ec2 459 /* Override the following in the underlying adaptation layer to provide the functionality of scanning. */
rgrover1 710:b2e1a2660ec2 460 virtual ble_error_t startRadioScan(const GapScanningParams &scanningParams) {
rgrover1 772:b6d27ab66c94 461 (void)scanningParams;
rgrover1 728:997ba5e7b3b6 462 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 710:b2e1a2660ec2 463 }
rgrover1 710:b2e1a2660ec2 464
rgrover1 710:b2e1a2660ec2 465 /*
rgrover1 710:b2e1a2660ec2 466 * APIs with non-virtual implementations.
rgrover1 710:b2e1a2660ec2 467 */
rgrover1 710:b2e1a2660ec2 468 public:
rgrover1 710:b2e1a2660ec2 469 /**
vcoubard 1048:efb29faf12fc 470 * Returns the current GAP state of the device using a bitmask that
vcoubard 1048:efb29faf12fc 471 * describes whether the device is advertising or connected.
rgrover1 710:b2e1a2660ec2 472 */
rgrover1 710:b2e1a2660ec2 473 GapState_t getState(void) const {
rgrover1 710:b2e1a2660ec2 474 return state;
rgrover1 710:b2e1a2660ec2 475 }
rgrover1 710:b2e1a2660ec2 476
rgrover1 710:b2e1a2660ec2 477 /**
rgrover1 710:b2e1a2660ec2 478 * Set the GAP advertising mode to use for this device.
rgrover1 710:b2e1a2660ec2 479 */
rgrover1 710:b2e1a2660ec2 480 void setAdvertisingType(GapAdvertisingParams::AdvertisingType_t advType) {
rgrover1 710:b2e1a2660ec2 481 _advParams.setAdvertisingType(advType);
rgrover1 710:b2e1a2660ec2 482 }
rgrover1 710:b2e1a2660ec2 483
rgrover1 710:b2e1a2660ec2 484 /**
rgrover1 710:b2e1a2660ec2 485 * @param[in] interval
rgrover1 710:b2e1a2660ec2 486 * Advertising interval in units of milliseconds. Advertising
rgrover1 710:b2e1a2660ec2 487 * is disabled if interval is 0. If interval is smaller than
rgrover1 710:b2e1a2660ec2 488 * the minimum supported value, then the minimum supported
rgrover1 710:b2e1a2660ec2 489 * value is used instead. This minimum value can be discovered
rgrover1 710:b2e1a2660ec2 490 * using getMinAdvertisingInterval().
rgrover1 710:b2e1a2660ec2 491 *
rgrover1 710:b2e1a2660ec2 492 * This field must be set to 0 if connectionMode is equal
rgrover1 710:b2e1a2660ec2 493 * to ADV_CONNECTABLE_DIRECTED.
rgrover1 710:b2e1a2660ec2 494 *
rgrover1 710:b2e1a2660ec2 495 * @note: Decreasing this value will allow central devices to detect a
vcoubard 1048:efb29faf12fc 496 * peripheral faster, at the expense of more power being used by the radio
rgrover1 710:b2e1a2660ec2 497 * due to the higher data transmit rate.
rgrover1 710:b2e1a2660ec2 498 *
rgrover1 710:b2e1a2660ec2 499 * @Note: [WARNING] This API previously used 0.625ms as the unit for its
rgrover1 710:b2e1a2660ec2 500 * 'interval' argument. That required an explicit conversion from
rgrover1 710:b2e1a2660ec2 501 * milliseconds using Gap::MSEC_TO_GAP_DURATION_UNITS(). This conversion is
rgrover1 710:b2e1a2660ec2 502 * no longer required as the new units are milliseconds. Any application
vcoubard 1048:efb29faf12fc 503 * code depending on the old semantics needs to be updated accordingly.
rgrover1 710:b2e1a2660ec2 504 */
rgrover1 710:b2e1a2660ec2 505 void setAdvertisingInterval(uint16_t interval) {
rgrover1 710:b2e1a2660ec2 506 if (interval == 0) {
rgrover1 710:b2e1a2660ec2 507 stopAdvertising();
rgrover1 710:b2e1a2660ec2 508 } else if (interval < getMinAdvertisingInterval()) {
rgrover1 710:b2e1a2660ec2 509 interval = getMinAdvertisingInterval();
rgrover1 710:b2e1a2660ec2 510 }
rgrover1 786:d6d7087d8377 511 _advParams.setInterval(interval);
rgrover1 710:b2e1a2660ec2 512 }
rgrover1 710:b2e1a2660ec2 513
rgrover1 710:b2e1a2660ec2 514 /**
rgrover1 710:b2e1a2660ec2 515 * @param[in] timeout
rgrover1 710:b2e1a2660ec2 516 * Advertising timeout (in seconds) between 0x1 and 0x3FFF (1
rgrover1 710:b2e1a2660ec2 517 * and 16383). Use 0 to disable the advertising timeout.
rgrover1 710:b2e1a2660ec2 518 */
rgrover1 710:b2e1a2660ec2 519 void setAdvertisingTimeout(uint16_t timeout) {
rgrover1 710:b2e1a2660ec2 520 _advParams.setTimeout(timeout);
rgrover1 710:b2e1a2660ec2 521 }
rgrover1 710:b2e1a2660ec2 522
rgrover1 710:b2e1a2660ec2 523 /**
rgrover1 710:b2e1a2660ec2 524 * Start advertising.
rgrover1 710:b2e1a2660ec2 525 */
rgrover1 710:b2e1a2660ec2 526 ble_error_t startAdvertising(void) {
vcoubard 1048:efb29faf12fc 527 setAdvertisingData(); /* Update the underlying stack. */
rgrover1 710:b2e1a2660ec2 528 return startAdvertising(_advParams);
rgrover1 710:b2e1a2660ec2 529 }
rgrover1 710:b2e1a2660ec2 530
rgrover1 710:b2e1a2660ec2 531 /**
rgrover1 710:b2e1a2660ec2 532 * Reset any advertising payload prepared from prior calls to
rgrover1 710:b2e1a2660ec2 533 * accumulateAdvertisingPayload(). This automatically propagates the re-
vcoubard 1048:efb29faf12fc 534 * initialized advertising payload to the underlying stack.
rgrover1 710:b2e1a2660ec2 535 */
rgrover1 710:b2e1a2660ec2 536 void clearAdvertisingPayload(void) {
rgrover1 710:b2e1a2660ec2 537 _advPayload.clear();
rgrover1 710:b2e1a2660ec2 538 setAdvertisingData();
rgrover1 710:b2e1a2660ec2 539 }
rgrover1 710:b2e1a2660ec2 540
rgrover1 710:b2e1a2660ec2 541 /**
rgrover1 710:b2e1a2660ec2 542 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 710:b2e1a2660ec2 543 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
vcoubard 1048:efb29faf12fc 544 * as an additional 31 bytes if the advertising payload is too
rgrover1 710:b2e1a2660ec2 545 * small.
rgrover1 710:b2e1a2660ec2 546 *
rgrover1 710:b2e1a2660ec2 547 * @param[in] flags
rgrover1 710:b2e1a2660ec2 548 * The flags to be added. Please refer to
rgrover1 710:b2e1a2660ec2 549 * GapAdvertisingData::Flags for valid flags. Multiple
rgrover1 710:b2e1a2660ec2 550 * flags may be specified in combination.
rgrover1 710:b2e1a2660ec2 551 */
rgrover1 710:b2e1a2660ec2 552 ble_error_t accumulateAdvertisingPayload(uint8_t flags) {
rgrover1 710:b2e1a2660ec2 553 ble_error_t rc;
rgrover1 710:b2e1a2660ec2 554 if ((rc = _advPayload.addFlags(flags)) != BLE_ERROR_NONE) {
rgrover1 710:b2e1a2660ec2 555 return rc;
rgrover1 710:b2e1a2660ec2 556 }
rgrover1 710:b2e1a2660ec2 557
rgrover1 710:b2e1a2660ec2 558 return setAdvertisingData();
rgrover1 710:b2e1a2660ec2 559 }
rgrover1 710:b2e1a2660ec2 560
rgrover1 710:b2e1a2660ec2 561 /**
rgrover1 710:b2e1a2660ec2 562 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 710:b2e1a2660ec2 563 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
vcoubard 1048:efb29faf12fc 564 * as an additional 31 bytes if the advertising payload is too
rgrover1 710:b2e1a2660ec2 565 * small.
rgrover1 710:b2e1a2660ec2 566 *
rgrover1 710:b2e1a2660ec2 567 * @param app
rgrover1 710:b2e1a2660ec2 568 * The appearance of the peripheral.
rgrover1 710:b2e1a2660ec2 569 */
rgrover1 710:b2e1a2660ec2 570 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::Appearance app) {
rgrover1 710:b2e1a2660ec2 571 setAppearance(app);
rgrover1 710:b2e1a2660ec2 572
rgrover1 710:b2e1a2660ec2 573 ble_error_t rc;
rgrover1 710:b2e1a2660ec2 574 if ((rc = _advPayload.addAppearance(app)) != BLE_ERROR_NONE) {
rgrover1 710:b2e1a2660ec2 575 return rc;
rgrover1 710:b2e1a2660ec2 576 }
rgrover1 710:b2e1a2660ec2 577
rgrover1 710:b2e1a2660ec2 578 return setAdvertisingData();
rgrover1 710:b2e1a2660ec2 579 }
rgrover1 710:b2e1a2660ec2 580
rgrover1 710:b2e1a2660ec2 581 /**
rgrover1 710:b2e1a2660ec2 582 * Accumulate an AD structure in the advertising payload. Please note that
rgrover1 710:b2e1a2660ec2 583 * the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
vcoubard 1048:efb29faf12fc 584 * as an additional 31 bytes if the advertising payload is too
rgrover1 710:b2e1a2660ec2 585 * small.
rgrover1 710:b2e1a2660ec2 586 *
vcoubard 1048:efb29faf12fc 587 * @param power
rgrover1 764:1e560f0d45e1 588 * The max transmit power to be used by the controller (in dBm).
rgrover1 710:b2e1a2660ec2 589 */
rgrover1 710:b2e1a2660ec2 590 ble_error_t accumulateAdvertisingPayloadTxPower(int8_t power) {
rgrover1 710:b2e1a2660ec2 591 ble_error_t rc;
rgrover1 710:b2e1a2660ec2 592 if ((rc = _advPayload.addTxPower(power)) != BLE_ERROR_NONE) {
rgrover1 710:b2e1a2660ec2 593 return rc;
rgrover1 710:b2e1a2660ec2 594 }
rgrover1 710:b2e1a2660ec2 595
rgrover1 710:b2e1a2660ec2 596 return setAdvertisingData();
rgrover1 710:b2e1a2660ec2 597 }
rgrover1 710:b2e1a2660ec2 598
rgrover1 710:b2e1a2660ec2 599 /**
rgrover1 710:b2e1a2660ec2 600 * Accumulate a variable length byte-stream as an AD structure in the
rgrover1 710:b2e1a2660ec2 601 * advertising payload. Please note that the payload is limited to 31 bytes.
rgrover1 710:b2e1a2660ec2 602 * The SCAN_RESPONSE message may be used as an additional 31 bytes if the
vcoubard 1048:efb29faf12fc 603 * advertising payload is too small.
rgrover1 710:b2e1a2660ec2 604 *
vcoubard 1048:efb29faf12fc 605 * @param type The type describing the variable length data.
vcoubard 1048:efb29faf12fc 606 * @param data Data bytes.
vcoubard 1048:efb29faf12fc 607 * @param len Length of data.
vcoubard 1104:0244fbb0324e 608 *
vcoubard 1104:0244fbb0324e 609 * @return BLE_ERROR_NONE if the advertisement payload was updated based on
vcoubard 1104:0244fbb0324e 610 * matching AD type; otherwise, an appropriate error.
vcoubard 1104:0244fbb0324e 611 *
vcoubard 1104:0244fbb0324e 612 * @note When the specified AD type is INCOMPLETE_LIST_16BIT_SERVICE_IDS,
vcoubard 1104:0244fbb0324e 613 * COMPLETE_LIST_16BIT_SERVICE_IDS, INCOMPLETE_LIST_32BIT_SERVICE_IDS,
vcoubard 1104:0244fbb0324e 614 * COMPLETE_LIST_32BIT_SERVICE_IDS, INCOMPLETE_LIST_128BIT_SERVICE_IDS,
vcoubard 1104:0244fbb0324e 615 * COMPLETE_LIST_128BIT_SERVICE_IDS or LIST_128BIT_SOLICITATION_IDS the
vcoubard 1104:0244fbb0324e 616 * supplied value is appended to the values previously added to the
vcoubard 1104:0244fbb0324e 617 * payload.
rgrover1 710:b2e1a2660ec2 618 */
rgrover1 710:b2e1a2660ec2 619 ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
rgrover1 710:b2e1a2660ec2 620 if (type == GapAdvertisingData::COMPLETE_LOCAL_NAME) {
rgrover1 710:b2e1a2660ec2 621 setDeviceName(data);
rgrover1 710:b2e1a2660ec2 622 }
rgrover1 710:b2e1a2660ec2 623
rgrover1 710:b2e1a2660ec2 624 ble_error_t rc;
rgrover1 710:b2e1a2660ec2 625 if ((rc = _advPayload.addData(type, data, len)) != BLE_ERROR_NONE) {
rgrover1 710:b2e1a2660ec2 626 return rc;
rgrover1 710:b2e1a2660ec2 627 }
rgrover1 710:b2e1a2660ec2 628
rgrover1 710:b2e1a2660ec2 629 return setAdvertisingData();
rgrover1 710:b2e1a2660ec2 630 }
rgrover1 710:b2e1a2660ec2 631
rgrover1 710:b2e1a2660ec2 632 /**
rgrover1 765:4cd91998cd48 633 * Update a particular ADV field in the advertising payload (based on
vcoubard 1104:0244fbb0324e 634 * matching type).
rgrover1 763:36c3e2b1f1ae 635 *
vcoubard 1048:efb29faf12fc 636 * @param[in] type The ADV type field describing the variable length data.
vcoubard 1048:efb29faf12fc 637 * @param[in] data Data bytes.
vcoubard 1048:efb29faf12fc 638 * @param[in] len Length of data.
rgrover1 765:4cd91998cd48 639 *
rgrover1 765:4cd91998cd48 640 * @note: If advertisements are enabled, then the update will take effect immediately.
rgrover1 765:4cd91998cd48 641 *
rgrover1 765:4cd91998cd48 642 * @return BLE_ERROR_NONE if the advertisement payload was updated based on
vcoubard 1104:0244fbb0324e 643 * matching AD type; otherwise, an appropriate error.
rgrover1 763:36c3e2b1f1ae 644 */
rgrover1 763:36c3e2b1f1ae 645 ble_error_t updateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
rgrover1 763:36c3e2b1f1ae 646 if (type == GapAdvertisingData::COMPLETE_LOCAL_NAME) {
rgrover1 763:36c3e2b1f1ae 647 setDeviceName(data);
rgrover1 763:36c3e2b1f1ae 648 }
rgrover1 763:36c3e2b1f1ae 649
rgrover1 763:36c3e2b1f1ae 650 ble_error_t rc;
rgrover1 763:36c3e2b1f1ae 651 if ((rc = _advPayload.updateData(type, data, len)) != BLE_ERROR_NONE) {
rgrover1 763:36c3e2b1f1ae 652 return rc;
rgrover1 763:36c3e2b1f1ae 653 }
rgrover1 763:36c3e2b1f1ae 654
rgrover1 763:36c3e2b1f1ae 655 return setAdvertisingData();
rgrover1 763:36c3e2b1f1ae 656 }
rgrover1 763:36c3e2b1f1ae 657
rgrover1 763:36c3e2b1f1ae 658 /**
vcoubard 1048:efb29faf12fc 659 * Set up a particular, user-constructed advertisement payload for the
rgrover1 710:b2e1a2660ec2 660 * underlying stack. It would be uncommon for this API to be used directly;
rgrover1 710:b2e1a2660ec2 661 * there are other APIs to build an advertisement payload (see above).
rgrover1 710:b2e1a2660ec2 662 */
rgrover1 710:b2e1a2660ec2 663 ble_error_t setAdvertisingPayload(const GapAdvertisingData &payload) {
rgrover1 710:b2e1a2660ec2 664 _advPayload = payload;
rgrover1 710:b2e1a2660ec2 665 return setAdvertisingData();
rgrover1 710:b2e1a2660ec2 666 }
rgrover1 710:b2e1a2660ec2 667
rgrover1 710:b2e1a2660ec2 668 /**
rgrover1 710:b2e1a2660ec2 669 * @return Read back advertising data. Useful for storing and
rgrover1 710:b2e1a2660ec2 670 * restoring payload.
rgrover1 710:b2e1a2660ec2 671 */
rgrover1 710:b2e1a2660ec2 672 const GapAdvertisingData &getAdvertisingPayload(void) const {
rgrover1 710:b2e1a2660ec2 673 return _advPayload;
rgrover1 710:b2e1a2660ec2 674 }
rgrover1 710:b2e1a2660ec2 675
rgrover1 710:b2e1a2660ec2 676 /**
rgrover1 710:b2e1a2660ec2 677 * Accumulate a variable length byte-stream as an AD structure in the
rgrover1 710:b2e1a2660ec2 678 * scanResponse payload.
rgrover1 710:b2e1a2660ec2 679 *
vcoubard 1048:efb29faf12fc 680 * @param[in] type The type describing the variable length data.
vcoubard 1048:efb29faf12fc 681 * @param[in] data Data bytes.
vcoubard 1048:efb29faf12fc 682 * @param[in] len Length of data.
rgrover1 710:b2e1a2660ec2 683 */
rgrover1 710:b2e1a2660ec2 684 ble_error_t accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len) {
rgrover1 710:b2e1a2660ec2 685 ble_error_t rc;
rgrover1 710:b2e1a2660ec2 686 if ((rc = _scanResponse.addData(type, data, len)) != BLE_ERROR_NONE) {
rgrover1 710:b2e1a2660ec2 687 return rc;
rgrover1 710:b2e1a2660ec2 688 }
rgrover1 710:b2e1a2660ec2 689
rgrover1 710:b2e1a2660ec2 690 return setAdvertisingData();
rgrover1 710:b2e1a2660ec2 691 }
rgrover1 710:b2e1a2660ec2 692
rgrover1 710:b2e1a2660ec2 693 /**
rgrover1 710:b2e1a2660ec2 694 * Reset any scan response prepared from prior calls to
rgrover1 710:b2e1a2660ec2 695 * accumulateScanResponse().
rgrover1 710:b2e1a2660ec2 696 *
rgrover1 710:b2e1a2660ec2 697 * Note: This should be followed by a call to setAdvertisingPayload() or
rgrover1 710:b2e1a2660ec2 698 * startAdvertising() before the update takes effect.
rgrover1 710:b2e1a2660ec2 699 */
rgrover1 710:b2e1a2660ec2 700 void clearScanResponse(void) {
rgrover1 710:b2e1a2660ec2 701 _scanResponse.clear();
rgrover1 710:b2e1a2660ec2 702 setAdvertisingData();
rgrover1 710:b2e1a2660ec2 703 }
rgrover1 710:b2e1a2660ec2 704
rgrover1 710:b2e1a2660ec2 705 /**
vcoubard 1048:efb29faf12fc 706 * Set up parameters for GAP scanning (observer mode).
rgrover1 710:b2e1a2660ec2 707 * @param[in] interval
rgrover1 710:b2e1a2660ec2 708 * Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 710:b2e1a2660ec2 709 * @param[in] window
rgrover1 710:b2e1a2660ec2 710 * Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 710:b2e1a2660ec2 711 * @param[in] timeout
vcoubard 1048:efb29faf12fc 712 * Scan timeout (in seconds) between 0x0001 and 0xFFFF; 0x0000 disables the timeout.
rgrover1 710:b2e1a2660ec2 713 * @param[in] activeScanning
rgrover1 710:b2e1a2660ec2 714 * Set to True if active-scanning is required. This is used to fetch the
rgrover1 710:b2e1a2660ec2 715 * scan response from a peer if possible.
rgrover1 710:b2e1a2660ec2 716 *
rgrover1 710:b2e1a2660ec2 717 * The scanning window divided by the interval determines the duty cycle for
rgrover1 710:b2e1a2660ec2 718 * scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1 710:b2e1a2660ec2 719 * then the controller will scan for 10 percent of the time. It is possible
rgrover1 710:b2e1a2660ec2 720 * to have the interval and window set to the same value. In this case,
rgrover1 710:b2e1a2660ec2 721 * scanning is continuous, with a change of scanning frequency once every
rgrover1 710:b2e1a2660ec2 722 * interval.
rgrover1 710:b2e1a2660ec2 723 *
rgrover1 710:b2e1a2660ec2 724 * Once the scanning parameters have been configured, scanning can be
rgrover1 710:b2e1a2660ec2 725 * enabled by using startScan().
rgrover1 710:b2e1a2660ec2 726 *
rgrover1 710:b2e1a2660ec2 727 * @Note: The scan interval and window are recommendations to the BLE stack.
rgrover1 710:b2e1a2660ec2 728 */
rgrover1 710:b2e1a2660ec2 729 ble_error_t setScanParams(uint16_t interval = GapScanningParams::SCAN_INTERVAL_MAX,
rgrover1 710:b2e1a2660ec2 730 uint16_t window = GapScanningParams::SCAN_WINDOW_MAX,
rgrover1 710:b2e1a2660ec2 731 uint16_t timeout = 0,
rgrover1 710:b2e1a2660ec2 732 bool activeScanning = false) {
rgrover1 710:b2e1a2660ec2 733 ble_error_t rc;
rgrover1 710:b2e1a2660ec2 734 if (((rc = _scanningParams.setInterval(interval)) == BLE_ERROR_NONE) &&
rgrover1 710:b2e1a2660ec2 735 ((rc = _scanningParams.setWindow(window)) == BLE_ERROR_NONE) &&
rgrover1 710:b2e1a2660ec2 736 ((rc = _scanningParams.setTimeout(timeout)) == BLE_ERROR_NONE)) {
rgrover1 710:b2e1a2660ec2 737 _scanningParams.setActiveScanning(activeScanning);
rgrover1 710:b2e1a2660ec2 738 return BLE_ERROR_NONE;
rgrover1 710:b2e1a2660ec2 739 }
rgrover1 710:b2e1a2660ec2 740
rgrover1 710:b2e1a2660ec2 741 return rc;
rgrover1 710:b2e1a2660ec2 742 }
rgrover1 710:b2e1a2660ec2 743
rgrover1 710:b2e1a2660ec2 744 /**
vcoubard 1048:efb29faf12fc 745 * Set up the scanInterval parameter for GAP scanning (observer mode).
rgrover1 710:b2e1a2660ec2 746 * @param[in] interval
rgrover1 710:b2e1a2660ec2 747 * Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 710:b2e1a2660ec2 748 *
rgrover1 710:b2e1a2660ec2 749 * The scanning window divided by the interval determines the duty cycle for
rgrover1 710:b2e1a2660ec2 750 * scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1 710:b2e1a2660ec2 751 * then the controller will scan for 10 percent of the time. It is possible
rgrover1 710:b2e1a2660ec2 752 * to have the interval and window set to the same value. In this case,
rgrover1 710:b2e1a2660ec2 753 * scanning is continuous, with a change of scanning frequency once every
rgrover1 710:b2e1a2660ec2 754 * interval.
rgrover1 710:b2e1a2660ec2 755 *
rgrover1 710:b2e1a2660ec2 756 * Once the scanning parameters have been configured, scanning can be
rgrover1 710:b2e1a2660ec2 757 * enabled by using startScan().
rgrover1 710:b2e1a2660ec2 758 */
rgrover1 710:b2e1a2660ec2 759 ble_error_t setScanInterval(uint16_t interval) {
rgrover1 710:b2e1a2660ec2 760 return _scanningParams.setInterval(interval);
rgrover1 710:b2e1a2660ec2 761 }
rgrover1 710:b2e1a2660ec2 762
rgrover1 710:b2e1a2660ec2 763 /**
vcoubard 1048:efb29faf12fc 764 * Set up the scanWindow parameter for GAP scanning (observer mode).
rgrover1 710:b2e1a2660ec2 765 * @param[in] window
rgrover1 710:b2e1a2660ec2 766 * Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
rgrover1 710:b2e1a2660ec2 767 *
rgrover1 710:b2e1a2660ec2 768 * The scanning window divided by the interval determines the duty cycle for
rgrover1 710:b2e1a2660ec2 769 * scanning. For example, if the interval is 100ms and the window is 10ms,
rgrover1 710:b2e1a2660ec2 770 * then the controller will scan for 10 percent of the time. It is possible
rgrover1 710:b2e1a2660ec2 771 * to have the interval and window set to the same value. In this case,
rgrover1 710:b2e1a2660ec2 772 * scanning is continuous, with a change of scanning frequency once every
rgrover1 710:b2e1a2660ec2 773 * interval.
rgrover1 710:b2e1a2660ec2 774 *
rgrover1 710:b2e1a2660ec2 775 * Once the scanning parameters have been configured, scanning can be
rgrover1 710:b2e1a2660ec2 776 * enabled by using startScan().
rgrover1 770:079b714e9c1a 777 *
rgrover1 770:079b714e9c1a 778 * If scanning is already active, the updated value of scanWindow will be
rgrover1 770:079b714e9c1a 779 * propagated to the underlying BLE stack.
rgrover1 710:b2e1a2660ec2 780 */
rgrover1 710:b2e1a2660ec2 781 ble_error_t setScanWindow(uint16_t window) {
rgrover1 770:079b714e9c1a 782 ble_error_t rc;
rgrover1 770:079b714e9c1a 783 if ((rc = _scanningParams.setWindow(window)) != BLE_ERROR_NONE) {
rgrover1 770:079b714e9c1a 784 return rc;
rgrover1 770:079b714e9c1a 785 }
rgrover1 770:079b714e9c1a 786
rgrover1 770:079b714e9c1a 787 /* If scanning is already active, propagate the new setting to the stack. */
rgrover1 770:079b714e9c1a 788 if (scanningActive) {
rgrover1 770:079b714e9c1a 789 return startRadioScan(_scanningParams);
rgrover1 770:079b714e9c1a 790 }
rgrover1 770:079b714e9c1a 791
rgrover1 770:079b714e9c1a 792 return BLE_ERROR_NONE;
rgrover1 710:b2e1a2660ec2 793 }
rgrover1 710:b2e1a2660ec2 794
rgrover1 710:b2e1a2660ec2 795 /**
vcoubard 1048:efb29faf12fc 796 * Set up parameters for GAP scanning (observer mode).
rgrover1 710:b2e1a2660ec2 797 * @param[in] timeout
vcoubard 1048:efb29faf12fc 798 * Scan timeout (in seconds) between 0x0001 and 0xFFFF; 0x0000 disables the timeout.
rgrover1 710:b2e1a2660ec2 799 *
rgrover1 710:b2e1a2660ec2 800 * Once the scanning parameters have been configured, scanning can be
rgrover1 710:b2e1a2660ec2 801 * enabled by using startScan().
rgrover1 770:079b714e9c1a 802 *
rgrover1 770:079b714e9c1a 803 * If scanning is already active, the updated value of scanTimeout will be
rgrover1 770:079b714e9c1a 804 * propagated to the underlying BLE stack.
rgrover1 710:b2e1a2660ec2 805 */
rgrover1 710:b2e1a2660ec2 806 ble_error_t setScanTimeout(uint16_t timeout) {
rgrover1 770:079b714e9c1a 807 ble_error_t rc;
rgrover1 770:079b714e9c1a 808 if ((rc = _scanningParams.setTimeout(timeout)) != BLE_ERROR_NONE) {
rgrover1 770:079b714e9c1a 809 return rc;
rgrover1 770:079b714e9c1a 810 }
rgrover1 770:079b714e9c1a 811
rgrover1 770:079b714e9c1a 812 /* If scanning is already active, propagate the new settings to the stack. */
rgrover1 770:079b714e9c1a 813 if (scanningActive) {
rgrover1 770:079b714e9c1a 814 return startRadioScan(_scanningParams);
rgrover1 770:079b714e9c1a 815 }
rgrover1 770:079b714e9c1a 816
rgrover1 770:079b714e9c1a 817 return BLE_ERROR_NONE;
rgrover1 710:b2e1a2660ec2 818 }
rgrover1 710:b2e1a2660ec2 819
rgrover1 710:b2e1a2660ec2 820 /**
vcoubard 1048:efb29faf12fc 821 * Set up parameters for GAP scanning (observer mode).
rgrover1 710:b2e1a2660ec2 822 * @param[in] activeScanning
rgrover1 710:b2e1a2660ec2 823 * Set to True if active-scanning is required. This is used to fetch the
rgrover1 710:b2e1a2660ec2 824 * scan response from a peer if possible.
rgrover1 710:b2e1a2660ec2 825 *
rgrover1 710:b2e1a2660ec2 826 * Once the scanning parameters have been configured, scanning can be
rgrover1 710:b2e1a2660ec2 827 * enabled by using startScan().
rgrover1 770:079b714e9c1a 828 *
rgrover1 770:079b714e9c1a 829 * If scanning is already in progress, then active-scanning will be enabled
rgrover1 770:079b714e9c1a 830 * for the underlying BLE stack.
rgrover1 710:b2e1a2660ec2 831 */
rgrover1 770:079b714e9c1a 832 ble_error_t setActiveScanning(bool activeScanning) {
rgrover1 710:b2e1a2660ec2 833 _scanningParams.setActiveScanning(activeScanning);
rgrover1 770:079b714e9c1a 834
rgrover1 770:079b714e9c1a 835 /* If scanning is already active, propagate the new settings to the stack. */
rgrover1 770:079b714e9c1a 836 if (scanningActive) {
rgrover1 770:079b714e9c1a 837 return startRadioScan(_scanningParams);
rgrover1 770:079b714e9c1a 838 }
rgrover1 770:079b714e9c1a 839
rgrover1 770:079b714e9c1a 840 return BLE_ERROR_NONE;
rgrover1 710:b2e1a2660ec2 841 }
rgrover1 710:b2e1a2660ec2 842
rgrover1 710:b2e1a2660ec2 843 /**
rgrover1 710:b2e1a2660ec2 844 * Start scanning (Observer Procedure) based on the parameters currently in
rgrover1 710:b2e1a2660ec2 845 * effect.
rgrover1 710:b2e1a2660ec2 846 *
rgrover1 710:b2e1a2660ec2 847 * @param[in] callback
vcoubard 1048:efb29faf12fc 848 * The application-specific callback to be invoked upon
rgrover1 710:b2e1a2660ec2 849 * receiving every advertisement report. This can be passed in
rgrover1 710:b2e1a2660ec2 850 * as NULL, in which case scanning may not be enabled at all.
rgrover1 710:b2e1a2660ec2 851 */
rgrover1 710:b2e1a2660ec2 852 ble_error_t startScan(void (*callback)(const AdvertisementCallbackParams_t *params)) {
rgrover1 710:b2e1a2660ec2 853 ble_error_t err = BLE_ERROR_NONE;
rgrover1 710:b2e1a2660ec2 854 if (callback) {
rgrover1 710:b2e1a2660ec2 855 if ((err = startRadioScan(_scanningParams)) == BLE_ERROR_NONE) {
rgrover1 770:079b714e9c1a 856 scanningActive = true;
rgrover1 710:b2e1a2660ec2 857 onAdvertisementReport.attach(callback);
rgrover1 710:b2e1a2660ec2 858 }
rgrover1 710:b2e1a2660ec2 859 }
rgrover1 710:b2e1a2660ec2 860
rgrover1 710:b2e1a2660ec2 861 return err;
rgrover1 710:b2e1a2660ec2 862 }
rgrover1 710:b2e1a2660ec2 863
rgrover1 710:b2e1a2660ec2 864 /**
rgrover1 710:b2e1a2660ec2 865 * Same as above, but this takes an (object, method) pair for a callback.
rgrover1 710:b2e1a2660ec2 866 */
rgrover1 710:b2e1a2660ec2 867 template<typename T>
rgrover1 710:b2e1a2660ec2 868 ble_error_t startScan(T *object, void (T::*callbackMember)(const AdvertisementCallbackParams_t *params)) {
rgrover1 710:b2e1a2660ec2 869 ble_error_t err = BLE_ERROR_NONE;
rgrover1 710:b2e1a2660ec2 870 if (object && callbackMember) {
rgrover1 710:b2e1a2660ec2 871 if ((err = startRadioScan(_scanningParams)) == BLE_ERROR_NONE) {
rgrover1 770:079b714e9c1a 872 scanningActive = true;
rgrover1 710:b2e1a2660ec2 873 onAdvertisementReport.attach(object, callbackMember);
rgrover1 710:b2e1a2660ec2 874 }
rgrover1 710:b2e1a2660ec2 875 }
rgrover1 710:b2e1a2660ec2 876
rgrover1 710:b2e1a2660ec2 877 return err;
rgrover1 710:b2e1a2660ec2 878 }
rgrover1 710:b2e1a2660ec2 879
rgrover1 753:0f60274cd3ad 880 /**
rgrover1 753:0f60274cd3ad 881 * Initialize radio-notification events to be generated from the stack.
vcoubard 1048:efb29faf12fc 882 * This API doesn't need to be called directly.
rgrover1 753:0f60274cd3ad 883 *
rgrover1 753:0f60274cd3ad 884 * Radio Notification is a feature that enables ACTIVE and INACTIVE
rgrover1 753:0f60274cd3ad 885 * (nACTIVE) signals from the stack that notify the application when the
rgrover1 753:0f60274cd3ad 886 * radio is in use.
rgrover1 753:0f60274cd3ad 887 *
vcoubard 1048:efb29faf12fc 888 * The ACTIVE signal is sent before the radio event starts. The nACTIVE
vcoubard 1048:efb29faf12fc 889 * signal is sent at the end of the radio event. These signals can be used
rgrover1 753:0f60274cd3ad 890 * by the application programmer to synchronize application logic with radio
rgrover1 753:0f60274cd3ad 891 * activity. For example, the ACTIVE signal can be used to shut off external
vcoubard 1048:efb29faf12fc 892 * devices, to manage peak current drawn during periods when the radio is on,
rgrover1 753:0f60274cd3ad 893 * or to trigger sensor data collection for transmission in the Radio Event.
rgrover1 753:0f60274cd3ad 894 *
rgrover1 753:0f60274cd3ad 895 * @return BLE_ERROR_NONE on successful initialization, otherwise an error code.
rgrover1 753:0f60274cd3ad 896 */
rgrover1 753:0f60274cd3ad 897 virtual ble_error_t initRadioNotification(void) {
rgrover1 753:0f60274cd3ad 898 return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porter(s): override this API if this capability is supported. */
rgrover1 753:0f60274cd3ad 899 }
rgrover1 753:0f60274cd3ad 900
rgrover1 710:b2e1a2660ec2 901 private:
rgrover1 710:b2e1a2660ec2 902 ble_error_t setAdvertisingData(void) {
rgrover1 710:b2e1a2660ec2 903 return setAdvertisingData(_advPayload, _scanResponse);
rgrover1 710:b2e1a2660ec2 904 }
rgrover1 710:b2e1a2660ec2 905
rgrover1 710:b2e1a2660ec2 906 private:
rgrover1 896:791741895cd8 907 virtual ble_error_t setAdvertisingData(const GapAdvertisingData &advData, const GapAdvertisingData &scanResponse) = 0;
rgrover1 896:791741895cd8 908 virtual ble_error_t startAdvertising(const GapAdvertisingParams &) = 0;
rgrover1 710:b2e1a2660ec2 909
rgrover1 710:b2e1a2660ec2 910 public:
rgrover1 710:b2e1a2660ec2 911 /**
rgrover1 710:b2e1a2660ec2 912 * Accessors to read back currently active advertising params.
rgrover1 710:b2e1a2660ec2 913 */
rgrover1 710:b2e1a2660ec2 914 GapAdvertisingParams &getAdvertisingParams(void) {
rgrover1 710:b2e1a2660ec2 915 return _advParams;
rgrover1 710:b2e1a2660ec2 916 }
rgrover1 710:b2e1a2660ec2 917 const GapAdvertisingParams &getAdvertisingParams(void) const {
rgrover1 710:b2e1a2660ec2 918 return _advParams;
rgrover1 710:b2e1a2660ec2 919 }
rgrover1 710:b2e1a2660ec2 920
rgrover1 710:b2e1a2660ec2 921 /**
vcoubard 1048:efb29faf12fc 922 * Set up a particular, user-constructed set of advertisement parameters for
rgrover1 710:b2e1a2660ec2 923 * the underlying stack. It would be uncommon for this API to be used
rgrover1 710:b2e1a2660ec2 924 * directly; there are other APIs to tweak advertisement parameters
rgrover1 710:b2e1a2660ec2 925 * individually.
rgrover1 710:b2e1a2660ec2 926 */
rgrover1 710:b2e1a2660ec2 927 void setAdvertisingParams(const GapAdvertisingParams &newParams) {
rgrover1 710:b2e1a2660ec2 928 _advParams = newParams;
rgrover1 710:b2e1a2660ec2 929 }
rgrover1 710:b2e1a2660ec2 930
rgrover1 710:b2e1a2660ec2 931 /* Event callback handlers. */
rgrover1 710:b2e1a2660ec2 932 public:
rgrover1 710:b2e1a2660ec2 933 /**
vcoubard 1048:efb29faf12fc 934 * Set up a callback for timeout events. Refer to TimeoutSource_t for
rgrover1 710:b2e1a2660ec2 935 * possible event types.
vcoubard 1052:b55e1ad3e1b3 936 * @note It is possible to unregister callbacks using onTimeout().detach(callback)
rgrover1 710:b2e1a2660ec2 937 */
vcoubard 1052:b55e1ad3e1b3 938 void onTimeout(TimeoutEventCallback_t callback) {
vcoubard 1052:b55e1ad3e1b3 939 timeoutCallbackChain.add(callback);
vcoubard 1052:b55e1ad3e1b3 940 }
vcoubard 1052:b55e1ad3e1b3 941
vcoubard 1052:b55e1ad3e1b3 942 /**
vcoubard 1052:b55e1ad3e1b3 943 * @brief provide access to the callchain of timeout event callbacks
vcoubard 1052:b55e1ad3e1b3 944 * It is possible to register callbacks using onTimeout().add(callback);
vcoubard 1054:f59e5d9a992a 945 * It is possible to unregister callbacks using onTimeout().detach(callback)
vcoubard 1052:b55e1ad3e1b3 946 * @return The timeout event callbacks chain
vcoubard 1052:b55e1ad3e1b3 947 */
vcoubard 1052:b55e1ad3e1b3 948 TimeoutEventCallbackChain_t& onTimeout() {
vcoubard 1052:b55e1ad3e1b3 949 return timeoutCallbackChain;
vcoubard 1052:b55e1ad3e1b3 950 }
rgrover1 710:b2e1a2660ec2 951
rgrover1 710:b2e1a2660ec2 952 /**
rgrover1 829:9072de50087b 953 * Append to a chain of callbacks to be invoked upon GAP connection.
vcoubard 1052:b55e1ad3e1b3 954 * @note It is possible to unregister callbacks using onConnection().detach(callback)
rgrover1 710:b2e1a2660ec2 955 */
rgrover1 829:9072de50087b 956 void onConnection(ConnectionEventCallback_t callback) {connectionCallChain.add(callback);}
rgrover1 710:b2e1a2660ec2 957
rgrover1 829:9072de50087b 958 template<typename T>
rgrover1 829:9072de50087b 959 void onConnection(T *tptr, void (T::*mptr)(const ConnectionCallbackParams_t*)) {connectionCallChain.add(tptr, mptr);}
rgrover1 710:b2e1a2660ec2 960
rgrover1 710:b2e1a2660ec2 961 /**
vcoubard 1052:b55e1ad3e1b3 962 * @brief provide access to the callchain of connection event callbacks
vcoubard 1052:b55e1ad3e1b3 963 * It is possible to register callbacks using onConnection().add(callback);
vcoubard 1054:f59e5d9a992a 964 * It is possible to unregister callbacks using onConnection().detach(callback)
vcoubard 1052:b55e1ad3e1b3 965 * @return The connection event callbacks chain
vcoubard 1052:b55e1ad3e1b3 966 */
vcoubard 1054:f59e5d9a992a 967 ConnectionEventCallbackChain_t& onConnection() {
vcoubard 1052:b55e1ad3e1b3 968 return connectionCallChain;
vcoubard 1052:b55e1ad3e1b3 969 }
vcoubard 1052:b55e1ad3e1b3 970
vcoubard 1052:b55e1ad3e1b3 971 /**
rgrover1 829:9072de50087b 972 * Append to a chain of callbacks to be invoked upon GAP disconnection.
vcoubard 1052:b55e1ad3e1b3 973 * @note It is possible to unregister callbacks using onDisconnection().detach(callback)
rgrover1 816:2b4f0ef8c06e 974 */
rgrover1 829:9072de50087b 975 void onDisconnection(DisconnectionEventCallback_t callback) {disconnectionCallChain.add(callback);}
rgrover1 816:2b4f0ef8c06e 976
rgrover1 710:b2e1a2660ec2 977 template<typename T>
rgrover1 829:9072de50087b 978 void onDisconnection(T *tptr, void (T::*mptr)(const DisconnectionCallbackParams_t*)) {disconnectionCallChain.add(tptr, mptr);}
rgrover1 710:b2e1a2660ec2 979
rgrover1 710:b2e1a2660ec2 980 /**
vcoubard 1052:b55e1ad3e1b3 981 * @brief provide access to the callchain of disconnection event callbacks
vcoubard 1052:b55e1ad3e1b3 982 * It is possible to register callbacks using onDisconnection().add(callback);
vcoubard 1054:f59e5d9a992a 983 * It is possible to unregister callbacks using onDisconnection().detach(callback)
vcoubard 1052:b55e1ad3e1b3 984 * @return The disconnection event callbacks chain
vcoubard 1052:b55e1ad3e1b3 985 */
vcoubard 1052:b55e1ad3e1b3 986 DisconnectionEventCallbackChain_t& onDisconnection() {
vcoubard 1052:b55e1ad3e1b3 987 return disconnectionCallChain;
vcoubard 1052:b55e1ad3e1b3 988 }
vcoubard 1052:b55e1ad3e1b3 989
vcoubard 1052:b55e1ad3e1b3 990 /**
rgrover1 710:b2e1a2660ec2 991 * Set the application callback for radio-notification events.
rgrover1 710:b2e1a2660ec2 992 *
rgrover1 710:b2e1a2660ec2 993 * Radio Notification is a feature that enables ACTIVE and INACTIVE
rgrover1 710:b2e1a2660ec2 994 * (nACTIVE) signals from the stack that notify the application when the
rgrover1 753:0f60274cd3ad 995 * radio is in use.
rgrover1 710:b2e1a2660ec2 996 *
vcoubard 1048:efb29faf12fc 997 * The ACTIVE signal is sent before the radio event starts. The nACTIVE
vcoubard 1048:efb29faf12fc 998 * signal is sent at the end of the radio event. These signals can be used
rgrover1 710:b2e1a2660ec2 999 * by the application programmer to synchronize application logic with radio
rgrover1 710:b2e1a2660ec2 1000 * activity. For example, the ACTIVE signal can be used to shut off external
vcoubard 1048:efb29faf12fc 1001 * devices, to manage peak current drawn during periods when the radio is on,
rgrover1 710:b2e1a2660ec2 1002 * or to trigger sensor data collection for transmission in the Radio Event.
rgrover1 710:b2e1a2660ec2 1003 *
rgrover1 710:b2e1a2660ec2 1004 * @param callback
rgrover1 710:b2e1a2660ec2 1005 * The application handler to be invoked in response to a radio
rgrover1 710:b2e1a2660ec2 1006 * ACTIVE/INACTIVE event.
rgrover1 754:9b391fb5c5d7 1007 *
vcoubard 1048:efb29faf12fc 1008 * Or in the other version:
rgrover1 754:9b391fb5c5d7 1009 *
rgrover1 754:9b391fb5c5d7 1010 * @param tptr
rgrover1 754:9b391fb5c5d7 1011 * Pointer to the object of a class defining the member callback
rgrover1 754:9b391fb5c5d7 1012 * function (mptr).
rgrover1 754:9b391fb5c5d7 1013 * @param mptr
rgrover1 754:9b391fb5c5d7 1014 * The member callback (within the context of an object) to be
rgrover1 754:9b391fb5c5d7 1015 * invoked in response to a radio ACTIVE/INACTIVE event.
rgrover1 710:b2e1a2660ec2 1016 */
rgrover1 753:0f60274cd3ad 1017 void onRadioNotification(void (*callback)(bool param)) {
rgrover1 753:0f60274cd3ad 1018 radioNotificationCallback.attach(callback);
rgrover1 753:0f60274cd3ad 1019 }
rgrover1 753:0f60274cd3ad 1020 template <typename T>
rgrover1 753:0f60274cd3ad 1021 void onRadioNotification(T *tptr, void (T::*mptr)(bool)) {
rgrover1 753:0f60274cd3ad 1022 radioNotificationCallback.attach(tptr, mptr);
rgrover1 753:0f60274cd3ad 1023 }
rgrover1 710:b2e1a2660ec2 1024
vcoubard 1090:148d8b9b56a5 1025 /**
vcoubard 1090:148d8b9b56a5 1026 * Setup a callback to be invoked to notify the user application that the
vcoubard 1090:148d8b9b56a5 1027 * Gap instance is about to shutdown (possibly as a result of a call
vcoubard 1090:148d8b9b56a5 1028 * to BLE::shutdown()).
vcoubard 1090:148d8b9b56a5 1029 *
vcoubard 1090:148d8b9b56a5 1030 * @Note: It is possible to chain together multiple onShutdown callbacks
vcoubard 1090:148d8b9b56a5 1031 * (potentially from different modules of an application) to be notified
vcoubard 1090:148d8b9b56a5 1032 * before the Gap instance is shutdown.
vcoubard 1090:148d8b9b56a5 1033 *
vcoubard 1090:148d8b9b56a5 1034 * @Note: It is also possible to set up a callback into a member function of
vcoubard 1090:148d8b9b56a5 1035 * some object.
vcoubard 1090:148d8b9b56a5 1036 *
vcoubard 1090:148d8b9b56a5 1037 * @Note It is possible to unregister a callback using onShutdown().detach(callback)
vcoubard 1090:148d8b9b56a5 1038 */
vcoubard 1090:148d8b9b56a5 1039 void onShutdown(const GapShutdownCallback_t& callback) {
vcoubard 1090:148d8b9b56a5 1040 shutdownCallChain.add(callback);
vcoubard 1090:148d8b9b56a5 1041 }
vcoubard 1090:148d8b9b56a5 1042 template <typename T>
vcoubard 1090:148d8b9b56a5 1043 void onShutdown(T *objPtr, void (T::*memberPtr)(void)) {
vcoubard 1090:148d8b9b56a5 1044 shutdownCallChain.add(objPtr, memberPtr);
vcoubard 1090:148d8b9b56a5 1045 }
vcoubard 1090:148d8b9b56a5 1046
vcoubard 1090:148d8b9b56a5 1047 /**
vcoubard 1090:148d8b9b56a5 1048 * @brief provide access to the callchain of shutdown event callbacks
vcoubard 1090:148d8b9b56a5 1049 * It is possible to register callbacks using onShutdown().add(callback);
vcoubard 1090:148d8b9b56a5 1050 * It is possible to unregister callbacks using onShutdown().detach(callback)
vcoubard 1090:148d8b9b56a5 1051 * @return The shutdown event callbacks chain
vcoubard 1090:148d8b9b56a5 1052 */
vcoubard 1090:148d8b9b56a5 1053 GapShutdownCallbackChain_t& onShutdown() {
vcoubard 1090:148d8b9b56a5 1054 return shutdownCallChain;
vcoubard 1090:148d8b9b56a5 1055 }
vcoubard 1090:148d8b9b56a5 1056
vcoubard 1082:127667021827 1057 public:
vcoubard 1082:127667021827 1058 /**
vcoubard 1090:148d8b9b56a5 1059 * Notify all registered onShutdown callbacks that the Gap instance is
vcoubard 1090:148d8b9b56a5 1060 * about to be shutdown and clear all Gap state of the
vcoubard 1090:148d8b9b56a5 1061 * associated object.
vcoubard 1082:127667021827 1062 *
vcoubard 1082:127667021827 1063 * This function is meant to be overridden in the platform-specific
vcoubard 1082:127667021827 1064 * sub-class. Nevertheless, the sub-class is only expected to reset its
vcoubard 1082:127667021827 1065 * state and not the data held in Gap members. This shall be achieved by a
vcoubard 1082:127667021827 1066 * call to Gap::reset() from the sub-class' reset() implementation.
vcoubard 1082:127667021827 1067 *
vcoubard 1082:127667021827 1068 * @return BLE_ERROR_NONE on success.
vcoubard 1082:127667021827 1069 *
vcoubard 1082:127667021827 1070 * @note: Currently a call to reset() does not reset the advertising and
vcoubard 1082:127667021827 1071 * scan parameters to default values.
vcoubard 1082:127667021827 1072 */
vcoubard 1082:127667021827 1073 virtual ble_error_t reset(void) {
vcoubard 1090:148d8b9b56a5 1074 /* Notify that the instance is about to shutdown */
vcoubard 1090:148d8b9b56a5 1075 shutdownCallChain.call(this);
vcoubard 1090:148d8b9b56a5 1076 shutdownCallChain.clear();
vcoubard 1090:148d8b9b56a5 1077
vcoubard 1082:127667021827 1078 /* Clear Gap state */
vcoubard 1082:127667021827 1079 state.advertising = 0;
vcoubard 1084:40c1e518d6de 1080 state.connected = 0;
vcoubard 1082:127667021827 1081
vcoubard 1082:127667021827 1082 /* Clear scanning state */
vcoubard 1082:127667021827 1083 scanningActive = false;
vcoubard 1082:127667021827 1084
vcoubard 1082:127667021827 1085 /* Clear advertising and scanning data */
vcoubard 1082:127667021827 1086 _advPayload.clear();
vcoubard 1082:127667021827 1087 _scanResponse.clear();
vcoubard 1082:127667021827 1088
vcoubard 1082:127667021827 1089 /* Clear callbacks */
vcoubard 1082:127667021827 1090 timeoutCallbackChain.clear();
vcoubard 1082:127667021827 1091 connectionCallChain.clear();
vcoubard 1082:127667021827 1092 disconnectionCallChain.clear();
vcoubard 1082:127667021827 1093 radioNotificationCallback = NULL;
vcoubard 1084:40c1e518d6de 1094 onAdvertisementReport = NULL;
vcoubard 1082:127667021827 1095
vcoubard 1082:127667021827 1096 return BLE_ERROR_NONE;
vcoubard 1082:127667021827 1097 }
vcoubard 1082:127667021827 1098
rgrover1 710:b2e1a2660ec2 1099 protected:
rgrover1 710:b2e1a2660ec2 1100 Gap() :
rgrover1 710:b2e1a2660ec2 1101 _advParams(),
rgrover1 710:b2e1a2660ec2 1102 _advPayload(),
rgrover1 710:b2e1a2660ec2 1103 _scanningParams(),
rgrover1 710:b2e1a2660ec2 1104 _scanResponse(),
rgrover1 710:b2e1a2660ec2 1105 state(),
rgrover1 770:079b714e9c1a 1106 scanningActive(false),
vcoubard 1052:b55e1ad3e1b3 1107 timeoutCallbackChain(),
rgrover1 710:b2e1a2660ec2 1108 radioNotificationCallback(),
rgrover1 710:b2e1a2660ec2 1109 onAdvertisementReport(),
rgrover1 816:2b4f0ef8c06e 1110 connectionCallChain(),
rgrover1 710:b2e1a2660ec2 1111 disconnectionCallChain() {
rgrover1 710:b2e1a2660ec2 1112 _advPayload.clear();
rgrover1 710:b2e1a2660ec2 1113 _scanResponse.clear();
rgrover1 710:b2e1a2660ec2 1114 }
rgrover1 710:b2e1a2660ec2 1115
rgrover1 710:b2e1a2660ec2 1116 /* Entry points for the underlying stack to report events back to the user. */
rgrover1 710:b2e1a2660ec2 1117 public:
vcoubard 1079:6e2d9514f3df 1118 void processConnectionEvent(Handle_t handle,
vcoubard 1079:6e2d9514f3df 1119 Role_t role,
vcoubard 1079:6e2d9514f3df 1120 BLEProtocol::AddressType_t peerAddrType,
vcoubard 1115:82d4a8a56d91 1121 const BLEProtocol::AddressBytes_t peerAddr,
vcoubard 1079:6e2d9514f3df 1122 BLEProtocol::AddressType_t ownAddrType,
vcoubard 1115:82d4a8a56d91 1123 const BLEProtocol::AddressBytes_t ownAddr,
vcoubard 1079:6e2d9514f3df 1124 const ConnectionParams_t *connectionParams) {
rgrover1 710:b2e1a2660ec2 1125 state.connected = 1;
rgrover1 829:9072de50087b 1126 ConnectionCallbackParams_t callbackParams(handle, role, peerAddrType, peerAddr, ownAddrType, ownAddr, connectionParams);
rgrover1 829:9072de50087b 1127 connectionCallChain.call(&callbackParams);
rgrover1 710:b2e1a2660ec2 1128 }
rgrover1 710:b2e1a2660ec2 1129
rgrover1 710:b2e1a2660ec2 1130 void processDisconnectionEvent(Handle_t handle, DisconnectionReason_t reason) {
rgrover1 710:b2e1a2660ec2 1131 state.connected = 0;
rgrover1 829:9072de50087b 1132 DisconnectionCallbackParams_t callbackParams(handle, reason);
rgrover1 829:9072de50087b 1133 disconnectionCallChain.call(&callbackParams);
rgrover1 710:b2e1a2660ec2 1134 }
rgrover1 710:b2e1a2660ec2 1135
vcoubard 1115:82d4a8a56d91 1136 void processAdvertisementReport(const BLEProtocol::AddressBytes_t peerAddr,
vcoubard 1079:6e2d9514f3df 1137 int8_t rssi,
vcoubard 1079:6e2d9514f3df 1138 bool isScanResponse,
rgrover1 710:b2e1a2660ec2 1139 GapAdvertisingParams::AdvertisingType_t type,
vcoubard 1079:6e2d9514f3df 1140 uint8_t advertisingDataLen,
vcoubard 1079:6e2d9514f3df 1141 const uint8_t *advertisingData) {
rgrover1 710:b2e1a2660ec2 1142 AdvertisementCallbackParams_t params;
rgrover1 710:b2e1a2660ec2 1143 memcpy(params.peerAddr, peerAddr, ADDR_LEN);
rgrover1 710:b2e1a2660ec2 1144 params.rssi = rssi;
rgrover1 710:b2e1a2660ec2 1145 params.isScanResponse = isScanResponse;
rgrover1 710:b2e1a2660ec2 1146 params.type = type;
rgrover1 710:b2e1a2660ec2 1147 params.advertisingDataLen = advertisingDataLen;
rgrover1 710:b2e1a2660ec2 1148 params.advertisingData = advertisingData;
rgrover1 710:b2e1a2660ec2 1149 onAdvertisementReport.call(&params);
rgrover1 710:b2e1a2660ec2 1150 }
rgrover1 710:b2e1a2660ec2 1151
rgrover1 710:b2e1a2660ec2 1152 void processTimeoutEvent(TimeoutSource_t source) {
vcoubard 1052:b55e1ad3e1b3 1153 if (timeoutCallbackChain) {
vcoubard 1052:b55e1ad3e1b3 1154 timeoutCallbackChain(source);
rgrover1 710:b2e1a2660ec2 1155 }
rgrover1 710:b2e1a2660ec2 1156 }
rgrover1 710:b2e1a2660ec2 1157
vcoubard 1115:82d4a8a56d91 1158 ///////////////////////////////////////////////////
vcoubard 1115:82d4a8a56d91 1159 public:
vcoubard 1115:82d4a8a56d91 1160 enum AdvertisingPolicyMode_t {
vcoubard 1115:82d4a8a56d91 1161 ADV_POLICY_IGNORE_WHITELIST = 0,
vcoubard 1115:82d4a8a56d91 1162 ADV_POLICY_FILTER_SCAN_REQS = 1,
vcoubard 1115:82d4a8a56d91 1163 ADV_POLICY_FILTER_CONN_REQS = 2,
vcoubard 1115:82d4a8a56d91 1164 ADV_POLICY_FILTER_ALL_REQS = 3,
vcoubard 1115:82d4a8a56d91 1165 };
vcoubard 1115:82d4a8a56d91 1166
vcoubard 1115:82d4a8a56d91 1167 enum ScanningPolicyMode_t {
vcoubard 1115:82d4a8a56d91 1168 SCAN_POLICY_IGNORE_WHITELIST = 0,
vcoubard 1115:82d4a8a56d91 1169 SCAN_POLICY_FILTER_ALL_ADV = 1,
vcoubard 1115:82d4a8a56d91 1170 };
vcoubard 1115:82d4a8a56d91 1171
vcoubard 1115:82d4a8a56d91 1172 enum InitiatorPolicyMode_t {
vcoubard 1115:82d4a8a56d91 1173 INIT_POLICY_IGNORE_WHITELIST = 0,
vcoubard 1115:82d4a8a56d91 1174 INIT_POLICY_FILTER_ALL_ADV = 1,
vcoubard 1115:82d4a8a56d91 1175 };
vcoubard 1115:82d4a8a56d91 1176
vcoubard 1115:82d4a8a56d91 1177 // Things to be implemented by the porter
vcoubard 1115:82d4a8a56d91 1178 virtual int8_t getMaxWhitelistSize(void) const
vcoubard 1115:82d4a8a56d91 1179 {
vcoubard 1115:82d4a8a56d91 1180 return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard 1115:82d4a8a56d91 1181 }
vcoubard 1115:82d4a8a56d91 1182
vcoubard 1115:82d4a8a56d91 1183 virtual ble_error_t getWhitelist(std::set<BLEProtocol::Address_t> &whitelist) const
vcoubard 1115:82d4a8a56d91 1184 {
vcoubard 1115:82d4a8a56d91 1185 (void) whitelist;
vcoubard 1115:82d4a8a56d91 1186 return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard 1115:82d4a8a56d91 1187 }
vcoubard 1115:82d4a8a56d91 1188
vcoubard 1115:82d4a8a56d91 1189 virtual ble_error_t setWhitelist(std::set<BLEProtocol::Address_t> whitelist)
vcoubard 1115:82d4a8a56d91 1190 {
vcoubard 1115:82d4a8a56d91 1191 (void) whitelist;
vcoubard 1115:82d4a8a56d91 1192 return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard 1115:82d4a8a56d91 1193 }
vcoubard 1115:82d4a8a56d91 1194
vcoubard 1115:82d4a8a56d91 1195 // Accessors
vcoubard 1115:82d4a8a56d91 1196 virtual void setAdvertisingPolicyMode(AdvertisingPolicyMode_t mode)
vcoubard 1115:82d4a8a56d91 1197 {
vcoubard 1115:82d4a8a56d91 1198 (void) mode;
vcoubard 1115:82d4a8a56d91 1199 }
vcoubard 1115:82d4a8a56d91 1200
vcoubard 1115:82d4a8a56d91 1201 virtual void setScanningPolicyMode(ScanningPolicyMode_t mode)
vcoubard 1115:82d4a8a56d91 1202 {
vcoubard 1115:82d4a8a56d91 1203 (void) mode;
vcoubard 1115:82d4a8a56d91 1204 }
vcoubard 1115:82d4a8a56d91 1205
vcoubard 1115:82d4a8a56d91 1206 virtual void setInitiatorPolicyMode(InitiatorPolicyMode_t mode)
vcoubard 1115:82d4a8a56d91 1207 {
vcoubard 1115:82d4a8a56d91 1208 (void) mode;
vcoubard 1115:82d4a8a56d91 1209 }
vcoubard 1115:82d4a8a56d91 1210
vcoubard 1115:82d4a8a56d91 1211 virtual AdvertisingPolicyMode_t getAdvertisingPolicyMode(void) const
vcoubard 1115:82d4a8a56d91 1212 {
vcoubard 1115:82d4a8a56d91 1213 return ADV_POLICY_IGNORE_WHITELIST;
vcoubard 1115:82d4a8a56d91 1214 }
vcoubard 1115:82d4a8a56d91 1215
vcoubard 1115:82d4a8a56d91 1216 virtual ScanningPolicyMode_t getScanningPolicyMode(void) const
vcoubard 1115:82d4a8a56d91 1217 {
vcoubard 1115:82d4a8a56d91 1218 return SCAN_POLICY_IGNORE_WHITELIST;
vcoubard 1115:82d4a8a56d91 1219 }
vcoubard 1115:82d4a8a56d91 1220
vcoubard 1115:82d4a8a56d91 1221 virtual InitiatorPolicyMode_t getInitiatorPolicyMode(void) const
vcoubard 1115:82d4a8a56d91 1222 {
vcoubard 1115:82d4a8a56d91 1223 return INIT_POLICY_IGNORE_WHITELIST;
vcoubard 1115:82d4a8a56d91 1224 }
vcoubard 1115:82d4a8a56d91 1225
vcoubard 1115:82d4a8a56d91 1226 ///////////////////////////////////////////////////
vcoubard 1115:82d4a8a56d91 1227
rgrover1 710:b2e1a2660ec2 1228 protected:
rgrover1 710:b2e1a2660ec2 1229 GapAdvertisingParams _advParams;
rgrover1 710:b2e1a2660ec2 1230 GapAdvertisingData _advPayload;
rgrover1 710:b2e1a2660ec2 1231 GapScanningParams _scanningParams;
rgrover1 710:b2e1a2660ec2 1232 GapAdvertisingData _scanResponse;
rgrover1 710:b2e1a2660ec2 1233
rgrover1 710:b2e1a2660ec2 1234 GapState_t state;
rgrover1 770:079b714e9c1a 1235 bool scanningActive;
rgrover1 710:b2e1a2660ec2 1236
rgrover1 710:b2e1a2660ec2 1237 protected:
vcoubard 1052:b55e1ad3e1b3 1238 TimeoutEventCallbackChain_t timeoutCallbackChain;
vcoubard 1052:b55e1ad3e1b3 1239 RadioNotificationEventCallback_t radioNotificationCallback;
vcoubard 1052:b55e1ad3e1b3 1240 AdvertisementReportCallback_t onAdvertisementReport;
vcoubard 1052:b55e1ad3e1b3 1241 ConnectionEventCallbackChain_t connectionCallChain;
vcoubard 1052:b55e1ad3e1b3 1242 DisconnectionEventCallbackChain_t disconnectionCallChain;
rgrover1 710:b2e1a2660ec2 1243
rgrover1 710:b2e1a2660ec2 1244 private:
vcoubard 1090:148d8b9b56a5 1245 GapShutdownCallbackChain_t shutdownCallChain;
vcoubard 1090:148d8b9b56a5 1246
vcoubard 1090:148d8b9b56a5 1247 private:
vcoubard 1048:efb29faf12fc 1248 /* Disallow copy and assignment. */
rgrover1 710:b2e1a2660ec2 1249 Gap(const Gap &);
rgrover1 710:b2e1a2660ec2 1250 Gap& operator=(const Gap &);
rgrover1 710:b2e1a2660ec2 1251 };
rgrover1 710:b2e1a2660ec2 1252
rgrover1 710:b2e1a2660ec2 1253 #endif // ifndef __GAP_H__