shunpei kataoka / nRF51822

PBL mbed final

Fork of nRF51822 by Shuta Nakamae

source/nRF51ServiceDiscovery.h@391:8cc3528a1233, 2015-07-21 (annotated)

Committer:
rgrover1
Date:
Tue Jul 21 13:23:45 2015 +0100
Revision:
391:8cc3528a1233
Parent:
389:5982ee136c47 
Synchronized with git rev 4ec44d75

Author: Andrew Fernandes

Change DiscoveredCharacteristic API to return long or short UUIDs.

Who changed what in which revision?

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