Productize / nRF51822

library for BLE_GAP_backpack

Dependencies:   nrf51-sdk

Fork of nRF51822 by Nordic Semiconductor

btle/btle_discovery.h@316:1ccf6ee70900, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:30 2015 +0100
Revision:
316:1ccf6ee70900
Parent:
315:044071756a8d
Child:
332:b054000833d4
Synchronized with git rev 4730615c

Author: Rohit Grover

don't memset(0) the discovered Characteristics or Services in reset*(); that destroys the pointer to virtual tables

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 239:693a1f145b5a 1 /* mbed Microcontroller Library
rgrover1 239:693a1f145b5a 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 239:693a1f145b5a 3 *
rgrover1 239:693a1f145b5a 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 239:693a1f145b5a 5 * you may not use this file except in compliance with the License.
rgrover1 239:693a1f145b5a 6 * You may obtain a copy of the License at
rgrover1 239:693a1f145b5a 7 *
rgrover1 239:693a1f145b5a 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 239:693a1f145b5a 9 *
rgrover1 239:693a1f145b5a 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 239:693a1f145b5a 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 239:693a1f145b5a 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 239:693a1f145b5a 13 * See the License for the specific language governing permissions and
rgrover1 239:693a1f145b5a 14 * limitations under the License.
rgrover1 239:693a1f145b5a 15 */
rgrover1 239:693a1f145b5a 16
rgrover1 239:693a1f145b5a 17 #ifndef _BTLE_DISCOVERY_H_
rgrover1 239:693a1f145b5a 18 #define _BTLE_DISCOVERY_H_
rgrover1 239:693a1f145b5a 19
rgrover1 247:df37e7bb3f71 20 #include "ble.h"
rgrover1 263:d5da37e9a93b 21 #include "ServiceDiscovery.h"
rgrover1 315:044071756a8d 22 #include "nRFDiscoveredCharacteristic.h"
rgrover1 247:df37e7bb3f71 23
rgrover1 247:df37e7bb3f71 24 void bleGattcEventHandler(const ble_evt_t *p_ble_evt);
rgrover1 239:693a1f145b5a 25
rgrover1 250:db3c51656388 26 class NordicServiceDiscovery : public ServiceDiscovery
rgrover1 250:db3c51656388 27 {
rgrover1 248:71ef03789dd3 28 public:
rgrover1 260:ea2798f615e5 29 static const uint16_t SRV_DISC_START_HANDLE = 0x0001; /**< The start handle value used during service discovery. */
rgrover1 284:29fb6af6671d 30 static const uint16_t SRV_DISC_END_HANDLE = 0xFFFF; /**< The end handle value used during service discovery. */
rgrover1 260:ea2798f615e5 31
rgrover1 289:b33301b019e6 32 public:
rgrover1 248:71ef03789dd3 33 static const unsigned BLE_DB_DISCOVERY_MAX_SRV = 4; /**< Maximum number of services we can retain information for after a single discovery. */
rgrover1 248:71ef03789dd3 34 static const unsigned BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV = 4; /**< Maximum number of characteristics per service we can retain information for. */
rgrover1 260:ea2798f615e5 35
rgrover1 260:ea2798f615e5 36 public:
rgrover1 288:1d85c4a4d397 37 NordicServiceDiscovery() : serviceIndex(0),
rgrover1 288:1d85c4a4d397 38 numServices(0),
rgrover1 288:1d85c4a4d397 39 characteristicIndex(0),
rgrover1 288:1d85c4a4d397 40 numCharacteristics(0),
rgrover1 288:1d85c4a4d397 41 state(INACTIVE),
rgrover1 288:1d85c4a4d397 42 services(),
rgrover1 288:1d85c4a4d397 43 characteristics(),
rgrover1 305:293634834813 44 serviceUUIDDiscoveryQueue(this),
rgrover1 306:76e2e7349319 45 charUUIDDiscoveryQueue(this),
rgrover1 288:1d85c4a4d397 46 onTerminationCallback(NULL) {
rgrover1 288:1d85c4a4d397 47 /* empty */
rgrover1 288:1d85c4a4d397 48 }
rgrover1 288:1d85c4a4d397 49
rgrover1 288:1d85c4a4d397 50 public:
rgrover1 260:ea2798f615e5 51 ble_error_t launchCharacteristicDiscovery(Gap::Handle_t connectionHandle, Gap::Handle_t startHandle, Gap::Handle_t endHandle);
rgrover1 239:693a1f145b5a 52
rgrover1 239:693a1f145b5a 53 public:
rgrover1 248:71ef03789dd3 54 void setupDiscoveredServices(const ble_gattc_evt_prim_srvc_disc_rsp_t *response);
rgrover1 248:71ef03789dd3 55 void setupDiscoveredCharacteristics(const ble_gattc_evt_char_disc_rsp_t *response);
rgrover1 248:71ef03789dd3 56
rgrover1 290:83c994bf62d0 57 void triggerServiceUUIDDiscovery(void);
rgrover1 290:83c994bf62d0 58 void processDiscoverUUIDResponse(const ble_gattc_evt_char_val_by_uuid_read_rsp_t *response);
rgrover1 290:83c994bf62d0 59 void removeFirstServiceNeedingUUIDDiscovery(void);
rgrover1 290:83c994bf62d0 60
rgrover1 248:71ef03789dd3 61 void terminateServiceDiscovery(void) {
rgrover1 280:cbaa4cb83548 62 bool wasActive = isActive();
rgrover1 286:042b01e59cf8 63 state = INACTIVE;
rgrover1 280:cbaa4cb83548 64
rgrover1 280:cbaa4cb83548 65 if (wasActive && onTerminationCallback) {
rgrover1 280:cbaa4cb83548 66 onTerminationCallback(connHandle);
rgrover1 280:cbaa4cb83548 67 }
rgrover1 239:693a1f145b5a 68 }
rgrover1 239:693a1f145b5a 69
rgrover1 245:3abc61d38db3 70 void terminateCharacteristicDiscovery(void) {
rgrover1 286:042b01e59cf8 71 if (state == CHARACTERISTIC_DISCOVERY_ACTIVE) {
rgrover1 286:042b01e59cf8 72 state = SERVICE_DISCOVERY_ACTIVE;
rgrover1 286:042b01e59cf8 73 }
rgrover1 245:3abc61d38db3 74 serviceIndex++; /* Progress service index to keep discovery alive. */
rgrover1 245:3abc61d38db3 75 }
rgrover1 245:3abc61d38db3 76
rgrover1 279:6e5e79f1fb61 77 bool isActive(void) const {
rgrover1 286:042b01e59cf8 78 return state != INACTIVE;
rgrover1 279:6e5e79f1fb61 79 }
rgrover1 279:6e5e79f1fb61 80
rgrover1 280:cbaa4cb83548 81 void setOnTermination(TerminationCallback_t callback) {
rgrover1 280:cbaa4cb83548 82 onTerminationCallback = callback;
rgrover1 280:cbaa4cb83548 83 }
rgrover1 280:cbaa4cb83548 84
rgrover1 260:ea2798f615e5 85 private:
rgrover1 239:693a1f145b5a 86 void resetDiscoveredServices(void) {
rgrover1 242:73fc02cc20b1 87 numServices = 0;
rgrover1 242:73fc02cc20b1 88 serviceIndex = 0;
rgrover1 239:693a1f145b5a 89 }
rgrover1 239:693a1f145b5a 90
rgrover1 245:3abc61d38db3 91 void resetDiscoveredCharacteristics(void) {
rgrover1 245:3abc61d38db3 92 numCharacteristics = 0;
rgrover1 245:3abc61d38db3 93 characteristicIndex = 0;
rgrover1 245:3abc61d38db3 94 }
rgrover1 245:3abc61d38db3 95
rgrover1 245:3abc61d38db3 96 public:
rgrover1 243:a966506d1e5b 97 void serviceDiscoveryStarted(Gap::Handle_t connectionHandle) {
rgrover1 291:d7590ed48009 98 connHandle = connectionHandle;
rgrover1 243:a966506d1e5b 99 resetDiscoveredServices();
rgrover1 286:042b01e59cf8 100 state = SERVICE_DISCOVERY_ACTIVE;
rgrover1 243:a966506d1e5b 101 }
rgrover1 243:a966506d1e5b 102
rgrover1 260:ea2798f615e5 103 private:
rgrover1 245:3abc61d38db3 104 void characteristicDiscoveryStarted(Gap::Handle_t connectionHandle) {
rgrover1 291:d7590ed48009 105 connHandle = connectionHandle;
rgrover1 245:3abc61d38db3 106 resetDiscoveredCharacteristics();
rgrover1 286:042b01e59cf8 107 state = CHARACTERISTIC_DISCOVERY_ACTIVE;
rgrover1 245:3abc61d38db3 108 }
rgrover1 245:3abc61d38db3 109
rgrover1 251:d4e0cf5e8751 110 private:
rgrover1 293:cd86acfe41be 111 /**
rgrover1 293:cd86acfe41be 112 * A datatype to contain service-indices for which long UUIDs need to be
rgrover1 293:cd86acfe41be 113 * discovered using read_val_by_uuid().
rgrover1 293:cd86acfe41be 114 */
rgrover1 305:293634834813 115 class ServiceUUIDDiscoveryQueue {
rgrover1 292:01b717803437 116 public:
rgrover1 305:293634834813 117 ServiceUUIDDiscoveryQueue(NordicServiceDiscovery *parent) :
rgrover1 292:01b717803437 118 numIndices(0),
rgrover1 292:01b717803437 119 serviceIndices(),
rgrover1 301:59e7404a4ea3 120 parentDiscoveryObject(parent) {
rgrover1 292:01b717803437 121 /* empty */
rgrover1 292:01b717803437 122 }
rgrover1 292:01b717803437 123
rgrover1 292:01b717803437 124 public:
rgrover1 292:01b717803437 125 void reset(void) {
rgrover1 292:01b717803437 126 numIndices = 0;
rgrover1 304:8677dcdb218d 127 for (unsigned i = 0; i < BLE_DB_DISCOVERY_MAX_SRV; i++) {
rgrover1 304:8677dcdb218d 128 serviceIndices[i] = INVALID_INDEX;
rgrover1 292:01b717803437 129 }
rgrover1 292:01b717803437 130 }
rgrover1 299:19064275c0e0 131 void enqueue(int serviceIndex) {
rgrover1 292:01b717803437 132 serviceIndices[numIndices++] = serviceIndex;
rgrover1 292:01b717803437 133 }
rgrover1 299:19064275c0e0 134 int dequeue(void) {
rgrover1 299:19064275c0e0 135 if (numIndices == 0) {
rgrover1 304:8677dcdb218d 136 return INVALID_INDEX;
rgrover1 299:19064275c0e0 137 }
rgrover1 299:19064275c0e0 138
rgrover1 299:19064275c0e0 139 unsigned valueToReturn = serviceIndices[0];
rgrover1 292:01b717803437 140 numIndices--;
rgrover1 299:19064275c0e0 141 for (unsigned i = 0; i < numIndices; i++) {
rgrover1 299:19064275c0e0 142 serviceIndices[i] = serviceIndices[i + 1];
rgrover1 292:01b717803437 143 }
rgrover1 299:19064275c0e0 144
rgrover1 299:19064275c0e0 145 return valueToReturn;
rgrover1 292:01b717803437 146 }
rgrover1 302:507e99065379 147 unsigned getFirst(void) const {
rgrover1 302:507e99065379 148 return serviceIndices[0];
rgrover1 302:507e99065379 149 }
rgrover1 292:01b717803437 150 size_t getCount(void) const {
rgrover1 292:01b717803437 151 return numIndices;
rgrover1 292:01b717803437 152 }
rgrover1 292:01b717803437 153
rgrover1 303:697d18859583 154 /**
rgrover1 303:697d18859583 155 * Trigger UUID discovery for the first of the enqueued ServiceIndices.
rgrover1 303:697d18859583 156 */
rgrover1 292:01b717803437 157 void triggerFirst(void);
rgrover1 292:01b717803437 158
rgrover1 292:01b717803437 159 private:
rgrover1 304:8677dcdb218d 160 static const int INVALID_INDEX = -1;
rgrover1 292:01b717803437 161
rgrover1 292:01b717803437 162 private:
rgrover1 292:01b717803437 163 size_t numIndices;
rgrover1 292:01b717803437 164 int serviceIndices[BLE_DB_DISCOVERY_MAX_SRV];
rgrover1 292:01b717803437 165
rgrover1 301:59e7404a4ea3 166 NordicServiceDiscovery *parentDiscoveryObject;
rgrover1 292:01b717803437 167 };
rgrover1 305:293634834813 168 friend class ServiceUUIDDiscoveryQueue;
rgrover1 292:01b717803437 169
rgrover1 306:76e2e7349319 170 /**
rgrover1 306:76e2e7349319 171 * A datatype to contain characteristic-indices for which long UUIDs need to
rgrover1 306:76e2e7349319 172 * be discovered using read_val_by_uuid().
rgrover1 306:76e2e7349319 173 */
rgrover1 306:76e2e7349319 174 class CharUUIDDiscoveryQueue {
rgrover1 306:76e2e7349319 175 public:
rgrover1 306:76e2e7349319 176 CharUUIDDiscoveryQueue(NordicServiceDiscovery *parent) :
rgrover1 306:76e2e7349319 177 numIndices(0),
rgrover1 306:76e2e7349319 178 charIndices(),
rgrover1 306:76e2e7349319 179 parentDiscoveryObject(parent) {
rgrover1 306:76e2e7349319 180 /* empty */
rgrover1 306:76e2e7349319 181 }
rgrover1 306:76e2e7349319 182
rgrover1 306:76e2e7349319 183 public:
rgrover1 306:76e2e7349319 184 void reset(void) {
rgrover1 306:76e2e7349319 185 numIndices = 0;
rgrover1 306:76e2e7349319 186 for (unsigned i = 0; i < BLE_DB_DISCOVERY_MAX_SRV; i++) {
rgrover1 306:76e2e7349319 187 charIndices[i] = INVALID_INDEX;
rgrover1 306:76e2e7349319 188 }
rgrover1 306:76e2e7349319 189 }
rgrover1 306:76e2e7349319 190 void enqueue(int serviceIndex) {
rgrover1 306:76e2e7349319 191 charIndices[numIndices++] = serviceIndex;
rgrover1 306:76e2e7349319 192 }
rgrover1 306:76e2e7349319 193 int dequeue(void) {
rgrover1 306:76e2e7349319 194 if (numIndices == 0) {
rgrover1 306:76e2e7349319 195 return INVALID_INDEX;
rgrover1 306:76e2e7349319 196 }
rgrover1 306:76e2e7349319 197
rgrover1 306:76e2e7349319 198 unsigned valueToReturn = charIndices[0];
rgrover1 306:76e2e7349319 199 numIndices--;
rgrover1 306:76e2e7349319 200 for (unsigned i = 0; i < numIndices; i++) {
rgrover1 306:76e2e7349319 201 charIndices[i] = charIndices[i + 1];
rgrover1 306:76e2e7349319 202 }
rgrover1 306:76e2e7349319 203
rgrover1 306:76e2e7349319 204 return valueToReturn;
rgrover1 306:76e2e7349319 205 }
rgrover1 306:76e2e7349319 206 unsigned getFirst(void) const {
rgrover1 306:76e2e7349319 207 return charIndices[0];
rgrover1 306:76e2e7349319 208 }
rgrover1 306:76e2e7349319 209 size_t getCount(void) const {
rgrover1 306:76e2e7349319 210 return numIndices;
rgrover1 306:76e2e7349319 211 }
rgrover1 306:76e2e7349319 212
rgrover1 306:76e2e7349319 213 /**
rgrover1 306:76e2e7349319 214 * Trigger UUID discovery for the first of the enqueued charIndices.
rgrover1 306:76e2e7349319 215 */
rgrover1 306:76e2e7349319 216 void triggerFirst(void);
rgrover1 306:76e2e7349319 217
rgrover1 306:76e2e7349319 218 private:
rgrover1 306:76e2e7349319 219 static const int INVALID_INDEX = -1;
rgrover1 306:76e2e7349319 220
rgrover1 306:76e2e7349319 221 private:
rgrover1 306:76e2e7349319 222 size_t numIndices;
rgrover1 306:76e2e7349319 223 int charIndices[BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV];
rgrover1 306:76e2e7349319 224
rgrover1 306:76e2e7349319 225 NordicServiceDiscovery *parentDiscoveryObject;
rgrover1 306:76e2e7349319 226 };
rgrover1 306:76e2e7349319 227 friend class CharUUIDDiscoveryQueue;
rgrover1 306:76e2e7349319 228
rgrover1 292:01b717803437 229 private:
rgrover1 251:d4e0cf5e8751 230 friend void bleGattcEventHandler(const ble_evt_t *p_ble_evt);
rgrover1 251:d4e0cf5e8751 231 void progressCharacteristicDiscovery(void);
rgrover1 251:d4e0cf5e8751 232 void progressServiceDiscovery(void);
rgrover1 239:693a1f145b5a 233
rgrover1 248:71ef03789dd3 234 private:
rgrover1 248:71ef03789dd3 235 uint8_t serviceIndex; /**< Index of the current service being discovered. This is intended for internal use during service discovery.*/
rgrover1 248:71ef03789dd3 236 uint8_t numServices; /**< Number of services at the peers GATT database.*/
rgrover1 248:71ef03789dd3 237 uint8_t characteristicIndex; /**< Index of the current characteristic being discovered. This is intended for internal use during service discovery.*/
rgrover1 248:71ef03789dd3 238 uint8_t numCharacteristics; /**< Number of characteristics within the service.*/
rgrover1 248:71ef03789dd3 239
rgrover1 286:042b01e59cf8 240 enum State_t {
rgrover1 286:042b01e59cf8 241 INACTIVE,
rgrover1 286:042b01e59cf8 242 SERVICE_DISCOVERY_ACTIVE,
rgrover1 286:042b01e59cf8 243 CHARACTERISTIC_DISCOVERY_ACTIVE,
rgrover1 290:83c994bf62d0 244 DISCOVER_SERVICE_UUIDS,
rgrover1 306:76e2e7349319 245 DISCOVER_CHARACTERISTIC_UUIDS,
rgrover1 286:042b01e59cf8 246 } state;
rgrover1 248:71ef03789dd3 247
rgrover1 308:482f16f3f7f5 248 DiscoveredService services[BLE_DB_DISCOVERY_MAX_SRV]; /**< Information related to the current service being discovered.
rgrover1 308:482f16f3f7f5 249 * This is intended for internal use during service discovery. */
rgrover1 308:482f16f3f7f5 250 nRFDiscoveredCharacteristic characteristics[BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV];
rgrover1 280:cbaa4cb83548 251
rgrover1 308:482f16f3f7f5 252 ServiceUUIDDiscoveryQueue serviceUUIDDiscoveryQueue;
rgrover1 308:482f16f3f7f5 253 CharUUIDDiscoveryQueue charUUIDDiscoveryQueue;
rgrover1 292:01b717803437 254
rgrover1 308:482f16f3f7f5 255 TerminationCallback_t onTerminationCallback;
rgrover1 240:75b69581d1dd 256 };
rgrover1 240:75b69581d1dd 257
rgrover1 239:693a1f145b5a 258 #endif /*_BTLE_DISCOVERY_H_*/