Productize / nRF51822

library for BLE_GAP_backpack

Dependencies:   nrf51-sdk

Fork of nRF51822 by Nordic Semiconductor

btle/btle_discovery.h@306:76e2e7349319, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:29 2015 +0100
Revision:
306:76e2e7349319
Parent:
305:293634834813
Child:
307:3889582936c9
Synchronized with git rev 579beff9

Author: Rohit Grover

add CharUUIDDiscoveryQueue

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 247:df37e7bb3f71 22
rgrover1 247:df37e7bb3f71 23 void bleGattcEventHandler(const ble_evt_t *p_ble_evt);
rgrover1 239:693a1f145b5a 24
rgrover1 250:db3c51656388 25 class NordicServiceDiscovery : public ServiceDiscovery
rgrover1 250:db3c51656388 26 {
rgrover1 248:71ef03789dd3 27 public:
rgrover1 260:ea2798f615e5 28 static const uint16_t SRV_DISC_START_HANDLE = 0x0001; /**< The start handle value used during service discovery. */
rgrover1 284:29fb6af6671d 29 static const uint16_t SRV_DISC_END_HANDLE = 0xFFFF; /**< The end handle value used during service discovery. */
rgrover1 260:ea2798f615e5 30
rgrover1 289:b33301b019e6 31 public:
rgrover1 248:71ef03789dd3 32 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 33 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 34
rgrover1 260:ea2798f615e5 35 public:
rgrover1 288:1d85c4a4d397 36 NordicServiceDiscovery() : serviceIndex(0),
rgrover1 288:1d85c4a4d397 37 numServices(0),
rgrover1 288:1d85c4a4d397 38 characteristicIndex(0),
rgrover1 288:1d85c4a4d397 39 numCharacteristics(0),
rgrover1 288:1d85c4a4d397 40 state(INACTIVE),
rgrover1 288:1d85c4a4d397 41 services(),
rgrover1 288:1d85c4a4d397 42 characteristics(),
rgrover1 305:293634834813 43 serviceUUIDDiscoveryQueue(this),
rgrover1 306:76e2e7349319 44 charUUIDDiscoveryQueue(this),
rgrover1 288:1d85c4a4d397 45 onTerminationCallback(NULL) {
rgrover1 288:1d85c4a4d397 46 /* empty */
rgrover1 288:1d85c4a4d397 47 }
rgrover1 288:1d85c4a4d397 48
rgrover1 288:1d85c4a4d397 49 public:
rgrover1 260:ea2798f615e5 50 ble_error_t launchCharacteristicDiscovery(Gap::Handle_t connectionHandle, Gap::Handle_t startHandle, Gap::Handle_t endHandle);
rgrover1 239:693a1f145b5a 51
rgrover1 239:693a1f145b5a 52 public:
rgrover1 248:71ef03789dd3 53 void setupDiscoveredServices(const ble_gattc_evt_prim_srvc_disc_rsp_t *response);
rgrover1 248:71ef03789dd3 54 void setupDiscoveredCharacteristics(const ble_gattc_evt_char_disc_rsp_t *response);
rgrover1 248:71ef03789dd3 55
rgrover1 290:83c994bf62d0 56 void triggerServiceUUIDDiscovery(void);
rgrover1 290:83c994bf62d0 57 void processDiscoverUUIDResponse(const ble_gattc_evt_char_val_by_uuid_read_rsp_t *response);
rgrover1 290:83c994bf62d0 58 void removeFirstServiceNeedingUUIDDiscovery(void);
rgrover1 290:83c994bf62d0 59
rgrover1 248:71ef03789dd3 60 void terminateServiceDiscovery(void) {
rgrover1 280:cbaa4cb83548 61 bool wasActive = isActive();
rgrover1 286:042b01e59cf8 62 state = INACTIVE;
rgrover1 280:cbaa4cb83548 63
rgrover1 280:cbaa4cb83548 64 if (wasActive && onTerminationCallback) {
rgrover1 280:cbaa4cb83548 65 onTerminationCallback(connHandle);
rgrover1 280:cbaa4cb83548 66 }
rgrover1 239:693a1f145b5a 67 }
rgrover1 239:693a1f145b5a 68
rgrover1 245:3abc61d38db3 69 void terminateCharacteristicDiscovery(void) {
rgrover1 286:042b01e59cf8 70 if (state == CHARACTERISTIC_DISCOVERY_ACTIVE) {
rgrover1 286:042b01e59cf8 71 state = SERVICE_DISCOVERY_ACTIVE;
rgrover1 286:042b01e59cf8 72 }
rgrover1 245:3abc61d38db3 73 serviceIndex++; /* Progress service index to keep discovery alive. */
rgrover1 245:3abc61d38db3 74 }
rgrover1 245:3abc61d38db3 75
rgrover1 279:6e5e79f1fb61 76 bool isActive(void) const {
rgrover1 286:042b01e59cf8 77 return state != INACTIVE;
rgrover1 279:6e5e79f1fb61 78 }
rgrover1 279:6e5e79f1fb61 79
rgrover1 280:cbaa4cb83548 80 void setOnTermination(TerminationCallback_t callback) {
rgrover1 280:cbaa4cb83548 81 onTerminationCallback = callback;
rgrover1 280:cbaa4cb83548 82 }
rgrover1 280:cbaa4cb83548 83
rgrover1 260:ea2798f615e5 84 private:
rgrover1 239:693a1f145b5a 85 void resetDiscoveredServices(void) {
rgrover1 242:73fc02cc20b1 86 numServices = 0;
rgrover1 242:73fc02cc20b1 87 serviceIndex = 0;
rgrover1 239:693a1f145b5a 88 memset(services, 0, sizeof(DiscoveredService) * BLE_DB_DISCOVERY_MAX_SRV);
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 memset(characteristics, 0, sizeof(DiscoveredCharacteristic) * BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV);
rgrover1 245:3abc61d38db3 95 }
rgrover1 245:3abc61d38db3 96
rgrover1 245:3abc61d38db3 97 public:
rgrover1 243:a966506d1e5b 98 void serviceDiscoveryStarted(Gap::Handle_t connectionHandle) {
rgrover1 291:d7590ed48009 99 connHandle = connectionHandle;
rgrover1 243:a966506d1e5b 100 resetDiscoveredServices();
rgrover1 286:042b01e59cf8 101 state = SERVICE_DISCOVERY_ACTIVE;
rgrover1 243:a966506d1e5b 102 }
rgrover1 243:a966506d1e5b 103
rgrover1 260:ea2798f615e5 104 private:
rgrover1 245:3abc61d38db3 105 void characteristicDiscoveryStarted(Gap::Handle_t connectionHandle) {
rgrover1 291:d7590ed48009 106 connHandle = connectionHandle;
rgrover1 245:3abc61d38db3 107 resetDiscoveredCharacteristics();
rgrover1 286:042b01e59cf8 108 state = CHARACTERISTIC_DISCOVERY_ACTIVE;
rgrover1 245:3abc61d38db3 109 }
rgrover1 245:3abc61d38db3 110
rgrover1 251:d4e0cf5e8751 111 private:
rgrover1 293:cd86acfe41be 112 /**
rgrover1 293:cd86acfe41be 113 * A datatype to contain service-indices for which long UUIDs need to be
rgrover1 293:cd86acfe41be 114 * discovered using read_val_by_uuid().
rgrover1 293:cd86acfe41be 115 */
rgrover1 305:293634834813 116 class ServiceUUIDDiscoveryQueue {
rgrover1 292:01b717803437 117 public:
rgrover1 305:293634834813 118 ServiceUUIDDiscoveryQueue(NordicServiceDiscovery *parent) :
rgrover1 292:01b717803437 119 numIndices(0),
rgrover1 292:01b717803437 120 serviceIndices(),
rgrover1 301:59e7404a4ea3 121 parentDiscoveryObject(parent) {
rgrover1 292:01b717803437 122 /* empty */
rgrover1 292:01b717803437 123 }
rgrover1 292:01b717803437 124
rgrover1 292:01b717803437 125 public:
rgrover1 292:01b717803437 126 void reset(void) {
rgrover1 292:01b717803437 127 numIndices = 0;
rgrover1 304:8677dcdb218d 128 for (unsigned i = 0; i < BLE_DB_DISCOVERY_MAX_SRV; i++) {
rgrover1 304:8677dcdb218d 129 serviceIndices[i] = INVALID_INDEX;
rgrover1 292:01b717803437 130 }
rgrover1 292:01b717803437 131 }
rgrover1 299:19064275c0e0 132 void enqueue(int serviceIndex) {
rgrover1 292:01b717803437 133 serviceIndices[numIndices++] = serviceIndex;
rgrover1 292:01b717803437 134 }
rgrover1 299:19064275c0e0 135 int dequeue(void) {
rgrover1 299:19064275c0e0 136 if (numIndices == 0) {
rgrover1 304:8677dcdb218d 137 return INVALID_INDEX;
rgrover1 299:19064275c0e0 138 }
rgrover1 299:19064275c0e0 139
rgrover1 299:19064275c0e0 140 unsigned valueToReturn = serviceIndices[0];
rgrover1 292:01b717803437 141 numIndices--;
rgrover1 299:19064275c0e0 142 for (unsigned i = 0; i < numIndices; i++) {
rgrover1 299:19064275c0e0 143 serviceIndices[i] = serviceIndices[i + 1];
rgrover1 292:01b717803437 144 }
rgrover1 299:19064275c0e0 145
rgrover1 299:19064275c0e0 146 return valueToReturn;
rgrover1 292:01b717803437 147 }
rgrover1 302:507e99065379 148 unsigned getFirst(void) const {
rgrover1 302:507e99065379 149 return serviceIndices[0];
rgrover1 302:507e99065379 150 }
rgrover1 292:01b717803437 151 size_t getCount(void) const {
rgrover1 292:01b717803437 152 return numIndices;
rgrover1 292:01b717803437 153 }
rgrover1 292:01b717803437 154
rgrover1 303:697d18859583 155 /**
rgrover1 303:697d18859583 156 * Trigger UUID discovery for the first of the enqueued ServiceIndices.
rgrover1 303:697d18859583 157 */
rgrover1 292:01b717803437 158 void triggerFirst(void);
rgrover1 292:01b717803437 159
rgrover1 292:01b717803437 160 private:
rgrover1 304:8677dcdb218d 161 static const int INVALID_INDEX = -1;
rgrover1 292:01b717803437 162
rgrover1 292:01b717803437 163 private:
rgrover1 292:01b717803437 164 size_t numIndices;
rgrover1 292:01b717803437 165 int serviceIndices[BLE_DB_DISCOVERY_MAX_SRV];
rgrover1 292:01b717803437 166
rgrover1 301:59e7404a4ea3 167 NordicServiceDiscovery *parentDiscoveryObject;
rgrover1 292:01b717803437 168 };
rgrover1 305:293634834813 169 friend class ServiceUUIDDiscoveryQueue;
rgrover1 292:01b717803437 170
rgrover1 306:76e2e7349319 171 /**
rgrover1 306:76e2e7349319 172 * A datatype to contain characteristic-indices for which long UUIDs need to
rgrover1 306:76e2e7349319 173 * be discovered using read_val_by_uuid().
rgrover1 306:76e2e7349319 174 */
rgrover1 306:76e2e7349319 175 class CharUUIDDiscoveryQueue {
rgrover1 306:76e2e7349319 176 public:
rgrover1 306:76e2e7349319 177 CharUUIDDiscoveryQueue(NordicServiceDiscovery *parent) :
rgrover1 306:76e2e7349319 178 numIndices(0),
rgrover1 306:76e2e7349319 179 charIndices(),
rgrover1 306:76e2e7349319 180 parentDiscoveryObject(parent) {
rgrover1 306:76e2e7349319 181 /* empty */
rgrover1 306:76e2e7349319 182 }
rgrover1 306:76e2e7349319 183
rgrover1 306:76e2e7349319 184 public:
rgrover1 306:76e2e7349319 185 void reset(void) {
rgrover1 306:76e2e7349319 186 numIndices = 0;
rgrover1 306:76e2e7349319 187 for (unsigned i = 0; i < BLE_DB_DISCOVERY_MAX_SRV; i++) {
rgrover1 306:76e2e7349319 188 charIndices[i] = INVALID_INDEX;
rgrover1 306:76e2e7349319 189 }
rgrover1 306:76e2e7349319 190 }
rgrover1 306:76e2e7349319 191 void enqueue(int serviceIndex) {
rgrover1 306:76e2e7349319 192 charIndices[numIndices++] = serviceIndex;
rgrover1 306:76e2e7349319 193 }
rgrover1 306:76e2e7349319 194 int dequeue(void) {
rgrover1 306:76e2e7349319 195 if (numIndices == 0) {
rgrover1 306:76e2e7349319 196 return INVALID_INDEX;
rgrover1 306:76e2e7349319 197 }
rgrover1 306:76e2e7349319 198
rgrover1 306:76e2e7349319 199 unsigned valueToReturn = charIndices[0];
rgrover1 306:76e2e7349319 200 numIndices--;
rgrover1 306:76e2e7349319 201 for (unsigned i = 0; i < numIndices; i++) {
rgrover1 306:76e2e7349319 202 charIndices[i] = charIndices[i + 1];
rgrover1 306:76e2e7349319 203 }
rgrover1 306:76e2e7349319 204
rgrover1 306:76e2e7349319 205 return valueToReturn;
rgrover1 306:76e2e7349319 206 }
rgrover1 306:76e2e7349319 207 unsigned getFirst(void) const {
rgrover1 306:76e2e7349319 208 return charIndices[0];
rgrover1 306:76e2e7349319 209 }
rgrover1 306:76e2e7349319 210 size_t getCount(void) const {
rgrover1 306:76e2e7349319 211 return numIndices;
rgrover1 306:76e2e7349319 212 }
rgrover1 306:76e2e7349319 213
rgrover1 306:76e2e7349319 214 /**
rgrover1 306:76e2e7349319 215 * Trigger UUID discovery for the first of the enqueued charIndices.
rgrover1 306:76e2e7349319 216 */
rgrover1 306:76e2e7349319 217 void triggerFirst(void);
rgrover1 306:76e2e7349319 218
rgrover1 306:76e2e7349319 219 private:
rgrover1 306:76e2e7349319 220 static const int INVALID_INDEX = -1;
rgrover1 306:76e2e7349319 221
rgrover1 306:76e2e7349319 222 private:
rgrover1 306:76e2e7349319 223 size_t numIndices;
rgrover1 306:76e2e7349319 224 int charIndices[BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV];
rgrover1 306:76e2e7349319 225
rgrover1 306:76e2e7349319 226 NordicServiceDiscovery *parentDiscoveryObject;
rgrover1 306:76e2e7349319 227 };
rgrover1 306:76e2e7349319 228 friend class CharUUIDDiscoveryQueue;
rgrover1 306:76e2e7349319 229
rgrover1 292:01b717803437 230 private:
rgrover1 251:d4e0cf5e8751 231 friend void bleGattcEventHandler(const ble_evt_t *p_ble_evt);
rgrover1 251:d4e0cf5e8751 232 void progressCharacteristicDiscovery(void);
rgrover1 251:d4e0cf5e8751 233 void progressServiceDiscovery(void);
rgrover1 239:693a1f145b5a 234
rgrover1 248:71ef03789dd3 235 private:
rgrover1 248:71ef03789dd3 236 uint8_t serviceIndex; /**< Index of the current service being discovered. This is intended for internal use during service discovery.*/
rgrover1 248:71ef03789dd3 237 uint8_t numServices; /**< Number of services at the peers GATT database.*/
rgrover1 248:71ef03789dd3 238 uint8_t characteristicIndex; /**< Index of the current characteristic being discovered. This is intended for internal use during service discovery.*/
rgrover1 248:71ef03789dd3 239 uint8_t numCharacteristics; /**< Number of characteristics within the service.*/
rgrover1 248:71ef03789dd3 240
rgrover1 286:042b01e59cf8 241 enum State_t {
rgrover1 286:042b01e59cf8 242 INACTIVE,
rgrover1 286:042b01e59cf8 243 SERVICE_DISCOVERY_ACTIVE,
rgrover1 286:042b01e59cf8 244 CHARACTERISTIC_DISCOVERY_ACTIVE,
rgrover1 290:83c994bf62d0 245 DISCOVER_SERVICE_UUIDS,
rgrover1 306:76e2e7349319 246 DISCOVER_CHARACTERISTIC_UUIDS,
rgrover1 286:042b01e59cf8 247 } state;
rgrover1 248:71ef03789dd3 248
rgrover1 248:71ef03789dd3 249 DiscoveredService services[BLE_DB_DISCOVERY_MAX_SRV]; /**< Information related to the current service being discovered.
rgrover1 248:71ef03789dd3 250 * This is intended for internal use during service discovery. */
rgrover1 248:71ef03789dd3 251 DiscoveredCharacteristic characteristics[BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV];
rgrover1 280:cbaa4cb83548 252
rgrover1 305:293634834813 253 ServiceUUIDDiscoveryQueue serviceUUIDDiscoveryQueue;
rgrover1 306:76e2e7349319 254 CharUUIDDiscoveryQueue charUUIDDiscoveryQueue;
rgrover1 292:01b717803437 255
rgrover1 280:cbaa4cb83548 256 TerminationCallback_t onTerminationCallback;
rgrover1 240:75b69581d1dd 257 };
rgrover1 240:75b69581d1dd 258
rgrover1 239:693a1f145b5a 259 #endif /*_BTLE_DISCOVERY_H_*/