Shuta Nakamae / 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

btle/btle_gattc.cpp@236:631719c927ed, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:21 2015 +0100
Revision:
236:631719c927ed
Parent:
235:10bb73f9d15d
Child:
237:f07be5960a98
Synchronized with git rev b24ffe4d

Author: Rohit Grover

define property masks for DiscoveredCharacteristic

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 194:c99fc3160091 1 /* mbed Microcontroller Library
rgrover1 194:c99fc3160091 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 194:c99fc3160091 3 *
rgrover1 194:c99fc3160091 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 194:c99fc3160091 5 * you may not use this file except in compliance with the License.
rgrover1 194:c99fc3160091 6 * You may obtain a copy of the License at
rgrover1 194:c99fc3160091 7 *
rgrover1 194:c99fc3160091 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 194:c99fc3160091 9 *
rgrover1 194:c99fc3160091 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 194:c99fc3160091 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 194:c99fc3160091 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 194:c99fc3160091 13 * See the License for the specific language governing permissions and
rgrover1 194:c99fc3160091 14 * limitations under the License.
rgrover1 194:c99fc3160091 15 */
rgrover1 194:c99fc3160091 16
rgrover1 194:c99fc3160091 17 #include "btle_gattc.h"
rgrover1 195:061ed80ffbcf 18 #include "UUID.h"
rgrover1 194:c99fc3160091 19
rgrover1 194:c99fc3160091 20 #define BLE_DB_DISCOVERY_MAX_SRV 4 /**< Maximum number of services supported by this module. This also indicates the maximum number of users allowed to be registered to this module. (one user per service). */
rgrover1 194:c99fc3160091 21 #define BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV 4 /**< Maximum number of characteristics per service supported by this module. */
rgrover1 194:c99fc3160091 22
rgrover1 230:4c2bb92598b7 23 #define SRV_DISC_START_HANDLE 0x0001 /**< The start handle value used during service discovery. */
rgrover1 194:c99fc3160091 24
rgrover1 194:c99fc3160091 25
rgrover1 221:61527a178b9a 26 void launchServiceDiscovery(Gap::Handle_t connectionHandle);
rgrover1 221:61527a178b9a 27 void launchCharacteristicDiscovery(Gap::Handle_t connectionHandle, Gap::Handle_t startHandle, Gap::Handle_t endHandle);
rgrover1 221:61527a178b9a 28
rgrover1 221:61527a178b9a 29
rgrover1 194:c99fc3160091 30 /**@brief Structure for holding information about the service and the characteristics found during
rgrover1 194:c99fc3160091 31 * the discovery process.
rgrover1 194:c99fc3160091 32 */
rgrover1 195:061ed80ffbcf 33 struct DiscoveredService {
rgrover1 195:061ed80ffbcf 34 void setup(ShortUUIDBytes_t uuidIn, Gap::Handle_t start, Gap::Handle_t end) {
rgrover1 195:061ed80ffbcf 35 uuid = uuidIn;
rgrover1 195:061ed80ffbcf 36 startHandle = start;
rgrover1 195:061ed80ffbcf 37 endHandle = end;
rgrover1 195:061ed80ffbcf 38 }
rgrover1 201:a13ada00eac7 39
rgrover1 208:12b6b06ffcd6 40 ShortUUIDBytes_t uuid; /**< UUID of the service. */
rgrover1 208:12b6b06ffcd6 41 Gap::Handle_t startHandle; /**< Service Handle Range. */
rgrover1 208:12b6b06ffcd6 42 Gap::Handle_t endHandle; /**< Service Handle Range. */
rgrover1 195:061ed80ffbcf 43 };
rgrover1 194:c99fc3160091 44
rgrover1 210:e7749aec4203 45 /**@brief Structure for holding information about the service and the characteristics found during
rgrover1 210:e7749aec4203 46 * the discovery process.
rgrover1 210:e7749aec4203 47 */
rgrover1 210:e7749aec4203 48 struct DiscoveredCharacteristic {
rgrover1 234:80732a210425 49 struct Properties_t {
rgrover1 236:631719c927ed 50 static const uint8_t BROADCAST_PROPERTY_MASK = 0x01;
rgrover1 236:631719c927ed 51 static const uint8_t READ_PROPERTY_MASK = 0x02;
rgrover1 236:631719c927ed 52 static const uint8_t WRITE_WO_RESPONSE_PROPERTY_MASK = 0x04;
rgrover1 236:631719c927ed 53 static const uint8_t WRITE_PROPERTY_MASK = 0x08;
rgrover1 236:631719c927ed 54 static const uint8_t NOTIFY_PROPERTY_MASK = 0x10;
rgrover1 236:631719c927ed 55 static const uint8_t INDICATE_PROPERTY_MASK = 0x20;
rgrover1 236:631719c927ed 56 static const uint8_t AUTH_SIGNED_PROPERTY_MASK = 0x40;
rgrover1 236:631719c927ed 57
rgrover1 234:80732a210425 58 Properties_t() : broadcast(0), read(0), write_wo_resp(0), write(0), notify(0), indicate(0), auth_signed_wr(0) {
rgrover1 234:80732a210425 59 /* empty */
rgrover1 234:80732a210425 60 }
rgrover1 236:631719c927ed 61
rgrover1 234:80732a210425 62 Properties_t(uint8_t props) :
rgrover1 236:631719c927ed 63 broadcast(props & BROADCAST_PROPERTY_MASK),
rgrover1 236:631719c927ed 64 read(props & READ_PROPERTY_MASK),
rgrover1 236:631719c927ed 65 write_wo_resp(props & WRITE_WO_RESPONSE_PROPERTY_MASK),
rgrover1 236:631719c927ed 66 write(props & WRITE_PROPERTY_MASK),
rgrover1 236:631719c927ed 67 notify(props & NOTIFY_PROPERTY_MASK),
rgrover1 236:631719c927ed 68 indicate(props & INDICATE_PROPERTY_MASK),
rgrover1 236:631719c927ed 69 auth_signed_wr(props & AUTH_SIGNED_PROPERTY_MASK) {
rgrover1 234:80732a210425 70 /* empty*/
rgrover1 234:80732a210425 71 }
rgrover1 234:80732a210425 72
rgrover1 234:80732a210425 73 uint8_t broadcast :1; /**< Broadcasting of the value permitted. */
rgrover1 234:80732a210425 74 uint8_t read :1; /**< Reading the value permitted. */
rgrover1 234:80732a210425 75 uint8_t write_wo_resp :1; /**< Writing the value with Write Command permitted. */
rgrover1 234:80732a210425 76 uint8_t write :1; /**< Writing the value with Write Request permitted. */
rgrover1 234:80732a210425 77 uint8_t notify :1; /**< Notications of the value permitted. */
rgrover1 234:80732a210425 78 uint8_t indicate :1; /**< Indications of the value permitted. */
rgrover1 234:80732a210425 79 uint8_t auth_signed_wr :1; /**< Writing the value with Signed Write Command permitted. */
rgrover1 234:80732a210425 80 };
rgrover1 234:80732a210425 81
rgrover1 234:80732a210425 82 void setup(ShortUUIDBytes_t uuidIn, Properties_t propsIn, Gap::Handle_t declHandleIn, Gap::Handle_t valueHandleIn) {
rgrover1 210:e7749aec4203 83 uuid = uuidIn;
rgrover1 215:36f6796651ab 84 props = propsIn;
rgrover1 215:36f6796651ab 85 declHandle = declHandleIn;
rgrover1 215:36f6796651ab 86 valueHandle = valueHandleIn;
rgrover1 210:e7749aec4203 87 }
rgrover1 210:e7749aec4203 88
rgrover1 234:80732a210425 89 ShortUUIDBytes_t uuid;
rgrover1 234:80732a210425 90 Properties_t props;
rgrover1 234:80732a210425 91 Gap::Handle_t declHandle;
rgrover1 234:80732a210425 92 Gap::Handle_t valueHandle;
rgrover1 210:e7749aec4203 93 };
rgrover1 210:e7749aec4203 94
rgrover1 222:0ba395e1303d 95 struct DiscoveryStatus {
rgrover1 214:196183e51de3 96 void terminateServiceDiscovery(void) {
rgrover1 214:196183e51de3 97 serviceDiscoveryInProgress = false;
rgrover1 214:196183e51de3 98 printf("end of service discovery\r\n");
rgrover1 214:196183e51de3 99 }
rgrover1 214:196183e51de3 100
rgrover1 214:196183e51de3 101 void terminateCharacteristicDiscovery(void) {
rgrover1 214:196183e51de3 102 characteristicDiscoveryInProgress = false;
rgrover1 214:196183e51de3 103 serviceDiscoveryInProgress = true;
rgrover1 217:c57cbfdfb5ca 104 currSrvInd++; /* Progress service index to keep discovery alive. */
rgrover1 214:196183e51de3 105 }
rgrover1 214:196183e51de3 106
rgrover1 214:196183e51de3 107 void resetDiscoveredServices(void) {
rgrover1 227:7a0bb8545c75 108 srvCount = 0;
rgrover1 227:7a0bb8545c75 109 currSrvInd = 0;
rgrover1 214:196183e51de3 110 memset(services, 0, sizeof(DiscoveredService) * BLE_DB_DISCOVERY_MAX_SRV);
rgrover1 214:196183e51de3 111 }
rgrover1 214:196183e51de3 112
rgrover1 227:7a0bb8545c75 113 void resetDiscoveredCharacteristics(void) {
rgrover1 227:7a0bb8545c75 114 charCount = 0;
rgrover1 227:7a0bb8545c75 115 currCharInd = 0;
rgrover1 227:7a0bb8545c75 116 memset(characteristics, 0, sizeof(DiscoveredCharacteristic) * BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV);
rgrover1 227:7a0bb8545c75 117 }
rgrover1 227:7a0bb8545c75 118
rgrover1 214:196183e51de3 119 void serviceDiscoveryStarted(Gap::Handle_t connectionHandle) {
rgrover1 214:196183e51de3 120 connHandle = connectionHandle;
rgrover1 227:7a0bb8545c75 121 resetDiscoveredServices();
rgrover1 214:196183e51de3 122 serviceDiscoveryInProgress = true;
rgrover1 214:196183e51de3 123 characteristicDiscoveryInProgress = false;
rgrover1 214:196183e51de3 124 }
rgrover1 214:196183e51de3 125
rgrover1 214:196183e51de3 126 void characteristicDiscoveryStarted(Gap::Handle_t connectionHandle) {
rgrover1 214:196183e51de3 127 connHandle = connectionHandle;
rgrover1 227:7a0bb8545c75 128 resetDiscoveredCharacteristics();
rgrover1 214:196183e51de3 129 characteristicDiscoveryInProgress = true;
rgrover1 214:196183e51de3 130 serviceDiscoveryInProgress = false;
rgrover1 214:196183e51de3 131 }
rgrover1 214:196183e51de3 132
rgrover1 225:08f36b78e0f1 133 void setupDiscoveredServices(const ble_gattc_evt_prim_srvc_disc_rsp_t *response) {
rgrover1 225:08f36b78e0f1 134 currSrvInd = 0;
rgrover1 225:08f36b78e0f1 135 srvCount = response->count;
rgrover1 225:08f36b78e0f1 136
rgrover1 233:0b15e714801b 137 /* Account for the limitation on the number of discovered services we can handle at a time. */
rgrover1 233:0b15e714801b 138 if (srvCount > BLE_DB_DISCOVERY_MAX_SRV) {
rgrover1 233:0b15e714801b 139 srvCount = BLE_DB_DISCOVERY_MAX_SRV;
rgrover1 233:0b15e714801b 140 }
rgrover1 233:0b15e714801b 141
rgrover1 225:08f36b78e0f1 142 for (unsigned serviceIndex = 0; serviceIndex < srvCount; serviceIndex++) {
rgrover1 225:08f36b78e0f1 143 services[serviceIndex].setup(response->services[serviceIndex].uuid.uuid,
rgrover1 225:08f36b78e0f1 144 response->services[serviceIndex].handle_range.start_handle,
rgrover1 225:08f36b78e0f1 145 response->services[serviceIndex].handle_range.end_handle);
rgrover1 225:08f36b78e0f1 146 }
rgrover1 225:08f36b78e0f1 147 }
rgrover1 225:08f36b78e0f1 148
rgrover1 225:08f36b78e0f1 149 void setupDiscoveredCharacteristics(const ble_gattc_evt_char_disc_rsp_t *response) {
rgrover1 225:08f36b78e0f1 150 currCharInd = 0;
rgrover1 225:08f36b78e0f1 151 charCount = response->count;
rgrover1 225:08f36b78e0f1 152
rgrover1 233:0b15e714801b 153 /* Account for the limitation on the number of discovered characteristics we can handle at a time. */
rgrover1 233:0b15e714801b 154 if (charCount > BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV) {
rgrover1 233:0b15e714801b 155 charCount = BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV;
rgrover1 233:0b15e714801b 156 }
rgrover1 233:0b15e714801b 157
rgrover1 225:08f36b78e0f1 158 for (unsigned charIndex = 0; charIndex < charCount; charIndex++) {
rgrover1 225:08f36b78e0f1 159 characteristics[charIndex].setup(response->chars[charIndex].uuid.uuid,
rgrover1 234:80732a210425 160 *(const uint8_t *)(&response->chars[charIndex].char_props),
rgrover1 225:08f36b78e0f1 161 response->chars[charIndex].handle_decl,
rgrover1 225:08f36b78e0f1 162 response->chars[charIndex].handle_value);
rgrover1 225:08f36b78e0f1 163 }
rgrover1 225:08f36b78e0f1 164 }
rgrover1 225:08f36b78e0f1 165
rgrover1 223:cfa98ce48348 166 void progressCharacteristicDiscovery() {
rgrover1 223:cfa98ce48348 167 while (characteristicDiscoveryInProgress && (currCharInd < charCount)) {
rgrover1 231:4362ce7ffbd7 168 /* THIS IS WHERE THE CALLBACK WILL GO */
rgrover1 231:4362ce7ffbd7 169 printf("%x [%u]\r\n", characteristics[currCharInd].uuid, characteristics[currCharInd].valueHandle);
rgrover1 231:4362ce7ffbd7 170
rgrover1 223:cfa98ce48348 171 currCharInd++;
rgrover1 223:cfa98ce48348 172 }
rgrover1 223:cfa98ce48348 173
rgrover1 223:cfa98ce48348 174 if (characteristicDiscoveryInProgress) {
rgrover1 223:cfa98ce48348 175 Gap::Handle_t startHandle = characteristics[currCharInd - 1].valueHandle + 1;
rgrover1 223:cfa98ce48348 176 Gap::Handle_t endHandle = services[currSrvInd].endHandle;
rgrover1 227:7a0bb8545c75 177 resetDiscoveredCharacteristics();
rgrover1 223:cfa98ce48348 178
rgrover1 223:cfa98ce48348 179 if (startHandle < endHandle) {
rgrover1 223:cfa98ce48348 180 ble_gattc_handle_range_t handleRange = {
rgrover1 223:cfa98ce48348 181 .start_handle = startHandle,
rgrover1 223:cfa98ce48348 182 .end_handle = endHandle
rgrover1 223:cfa98ce48348 183 };
rgrover1 223:cfa98ce48348 184 printf("char discovery returned %u\r\n", sd_ble_gattc_characteristics_discover(connHandle, &handleRange));
rgrover1 223:cfa98ce48348 185 } else {
rgrover1 223:cfa98ce48348 186 terminateCharacteristicDiscovery();
rgrover1 223:cfa98ce48348 187 }
rgrover1 223:cfa98ce48348 188 }
rgrover1 223:cfa98ce48348 189 }
rgrover1 223:cfa98ce48348 190
rgrover1 223:cfa98ce48348 191 void progressServiceDiscovery() {
rgrover1 223:cfa98ce48348 192 while (serviceDiscoveryInProgress && (currSrvInd < srvCount)) {
rgrover1 231:4362ce7ffbd7 193 /* THIS IS WHERE THE CALLBACK WILL GO */
rgrover1 231:4362ce7ffbd7 194 printf("%x [%u %u]\r\n", services[currSrvInd].uuid, services[currSrvInd].startHandle, services[currSrvInd].endHandle);
rgrover1 223:cfa98ce48348 195
rgrover1 231:4362ce7ffbd7 196 if (true) { /* characteristic discovery is optional. */
rgrover1 231:4362ce7ffbd7 197 launchCharacteristicDiscovery(connHandle, services[currSrvInd].startHandle, services[currSrvInd].endHandle);
rgrover1 231:4362ce7ffbd7 198 } else {
rgrover1 231:4362ce7ffbd7 199 currSrvInd++; /* Progress service index to keep discovery alive. */
rgrover1 231:4362ce7ffbd7 200 }
rgrover1 223:cfa98ce48348 201 }
rgrover1 223:cfa98ce48348 202 if (serviceDiscoveryInProgress && (srvCount > 0) && (currSrvInd > 0)) {
rgrover1 223:cfa98ce48348 203 Gap::Handle_t endHandle = services[currSrvInd - 1].endHandle;
rgrover1 223:cfa98ce48348 204 resetDiscoveredServices();
rgrover1 227:7a0bb8545c75 205
rgrover1 231:4362ce7ffbd7 206 printf("services discover returned %u\r\n", sd_ble_gattc_primary_services_discover(connHandle, endHandle, NULL));
rgrover1 223:cfa98ce48348 207 }
rgrover1 223:cfa98ce48348 208 }
rgrover1 223:cfa98ce48348 209
rgrover1 216:3443c78324b6 210 DiscoveredService services[BLE_DB_DISCOVERY_MAX_SRV]; /**< Information related to the current service being discovered.
rgrover1 216:3443c78324b6 211 * This is intended for internal use during service discovery. */
rgrover1 216:3443c78324b6 212 DiscoveredCharacteristic characteristics[BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV];
rgrover1 205:7b1c55e70f45 213
rgrover1 206:d8c5b97557f2 214 uint16_t connHandle; /**< Connection handle as provided by the SoftDevice. */
rgrover1 209:d24159a1dad5 215 uint8_t currSrvInd; /**< Index of the current service being discovered. This is intended for internal use during service discovery.*/
rgrover1 206:d8c5b97557f2 216 uint8_t srvCount; /**< Number of services at the peers GATT database.*/
rgrover1 206:d8c5b97557f2 217 uint8_t currCharInd; /**< Index of the current characteristic being discovered. This is intended for internal use during service discovery.*/
rgrover1 209:d24159a1dad5 218 uint8_t charCount; /**< Number of characteristics within the service.*/
rgrover1 206:d8c5b97557f2 219
rgrover1 206:d8c5b97557f2 220 bool serviceDiscoveryInProgress;
rgrover1 206:d8c5b97557f2 221 bool characteristicDiscoveryInProgress;
rgrover1 198:a69d3d4797e8 222 };
rgrover1 194:c99fc3160091 223
rgrover1 222:0ba395e1303d 224 static DiscoveryStatus discoveryStatus;
rgrover1 195:061ed80ffbcf 225
rgrover1 194:c99fc3160091 226 void launchServiceDiscovery(Gap::Handle_t connectionHandle)
rgrover1 194:c99fc3160091 227 {
rgrover1 214:196183e51de3 228 discoveryStatus.serviceDiscoveryStarted(connectionHandle);
rgrover1 194:c99fc3160091 229 printf("launch service discovery returned %u\r\n", sd_ble_gattc_primary_services_discover(connectionHandle, SRV_DISC_START_HANDLE, NULL));
rgrover1 194:c99fc3160091 230 }
rgrover1 194:c99fc3160091 231
rgrover1 202:3ce954ce3eb8 232 void launchCharacteristicDiscovery(Gap::Handle_t connectionHandle, Gap::Handle_t startHandle, Gap::Handle_t endHandle) {
rgrover1 214:196183e51de3 233 discoveryStatus.characteristicDiscoveryStarted(connectionHandle);
rgrover1 211:bf81b20ede23 234
rgrover1 211:bf81b20ede23 235 ble_gattc_handle_range_t handleRange = {
rgrover1 211:bf81b20ede23 236 .start_handle = startHandle,
rgrover1 211:bf81b20ede23 237 .end_handle = endHandle
rgrover1 211:bf81b20ede23 238 };
rgrover1 211:bf81b20ede23 239 printf("launch characteristic discovery returned %u\r\n", sd_ble_gattc_characteristics_discover(connectionHandle, &handleRange));
rgrover1 202:3ce954ce3eb8 240 }
rgrover1 202:3ce954ce3eb8 241
rgrover1 194:c99fc3160091 242 void bleGattcEventHandler(const ble_evt_t *p_ble_evt)
rgrover1 194:c99fc3160091 243 {
rgrover1 194:c99fc3160091 244 switch (p_ble_evt->header.evt_id) {
rgrover1 194:c99fc3160091 245 case BLE_GATTC_EVT_PRIM_SRVC_DISC_RSP:
rgrover1 194:c99fc3160091 246 switch (p_ble_evt->evt.gattc_evt.gatt_status) {
rgrover1 235:10bb73f9d15d 247 case BLE_GATT_STATUS_SUCCESS:
rgrover1 225:08f36b78e0f1 248 discoveryStatus.setupDiscoveredServices(&p_ble_evt->evt.gattc_evt.params.prim_srvc_disc_rsp);
rgrover1 195:061ed80ffbcf 249 break;
rgrover1 195:061ed80ffbcf 250
rgrover1 229:6394db9a71ba 251 case BLE_GATT_STATUS_ATTERR_ATTRIBUTE_NOT_FOUND:
rgrover1 229:6394db9a71ba 252 default:
rgrover1 214:196183e51de3 253 discoveryStatus.terminateServiceDiscovery();
rgrover1 194:c99fc3160091 254 break;
rgrover1 194:c99fc3160091 255 }
rgrover1 194:c99fc3160091 256 break;
rgrover1 194:c99fc3160091 257
rgrover1 235:10bb73f9d15d 258 case BLE_GATTC_EVT_CHAR_DISC_RSP:
rgrover1 194:c99fc3160091 259 switch (p_ble_evt->evt.gattc_evt.gatt_status) {
rgrover1 235:10bb73f9d15d 260 case BLE_GATT_STATUS_SUCCESS:
rgrover1 225:08f36b78e0f1 261 discoveryStatus.setupDiscoveredCharacteristics(&p_ble_evt->evt.gattc_evt.params.char_disc_rsp);
rgrover1 219:681be3608738 262 break;
rgrover1 212:f2316b17d8be 263
rgrover1 229:6394db9a71ba 264 case BLE_GATT_STATUS_ATTERR_ATTRIBUTE_NOT_FOUND:
rgrover1 229:6394db9a71ba 265 default:
rgrover1 214:196183e51de3 266 discoveryStatus.terminateCharacteristicDiscovery();
rgrover1 212:f2316b17d8be 267 break;
rgrover1 194:c99fc3160091 268 }
rgrover1 194:c99fc3160091 269 break;
rgrover1 194:c99fc3160091 270 }
rgrover1 195:061ed80ffbcf 271
rgrover1 223:cfa98ce48348 272 discoveryStatus.progressCharacteristicDiscovery();
rgrover1 223:cfa98ce48348 273 discoveryStatus.progressServiceDiscovery();
rgrover1 194:c99fc3160091 274 }