Michael Galis / nRF51822

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of nRF51822 by Nordic Semiconductor

nRFServiceDiscovery.h@333:8eedcd324853, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:32 2015 +0100
Revision:
333:8eedcd324853
Parent:
332:b054000833d4 
Synchronized with git rev f49e3469

Author: Rohit Grover

setup save of GattClient pointer in DiscoveredClient

Who changed what in which revision?

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