Productize / nRF51822

library for BLE_GAP_backpack

Dependencies:   nrf51-sdk

Fork of nRF51822 by Nordic Semiconductor

btle/btle_discovery.h@260:ea2798f615e5, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:23 2015 +0100
Revision:
260:ea2798f615e5
Parent:
259:14fc2ba60072
Child:
261:09e21ff74153
Synchronized with git rev c0ee657c

Author: Rohit Grover

reshuffle access qualifiers for members of NordicServiceDiscovery

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 239:693a1f145b5a 21 #include "UUID.h"
rgrover1 239:693a1f145b5a 22 #include "Gap.h"
rgrover1 247:df37e7bb3f71 23
rgrover1 247:df37e7bb3f71 24 void bleGattcEventHandler(const ble_evt_t *p_ble_evt);
rgrover1 239:693a1f145b5a 25
rgrover1 239:693a1f145b5a 26 /**@brief Structure for holding information about the service and the characteristics found during
rgrover1 239:693a1f145b5a 27 * the discovery process.
rgrover1 239:693a1f145b5a 28 */
rgrover1 239:693a1f145b5a 29 struct DiscoveredService {
rgrover1 239:693a1f145b5a 30 void setup(ShortUUIDBytes_t uuidIn, Gap::Handle_t start, Gap::Handle_t end) {
rgrover1 239:693a1f145b5a 31 uuid = uuidIn;
rgrover1 239:693a1f145b5a 32 startHandle = start;
rgrover1 239:693a1f145b5a 33 endHandle = end;
rgrover1 239:693a1f145b5a 34 }
rgrover1 239:693a1f145b5a 35
rgrover1 252:4b3f294415f5 36 ShortUUIDBytes_t uuid; /**< UUID of the service. */
rgrover1 239:693a1f145b5a 37 Gap::Handle_t startHandle; /**< Service Handle Range. */
rgrover1 239:693a1f145b5a 38 Gap::Handle_t endHandle; /**< Service Handle Range. */
rgrover1 239:693a1f145b5a 39 };
rgrover1 239:693a1f145b5a 40
rgrover1 239:693a1f145b5a 41 /**@brief Structure for holding information about the service and the characteristics found during
rgrover1 239:693a1f145b5a 42 * the discovery process.
rgrover1 239:693a1f145b5a 43 */
rgrover1 239:693a1f145b5a 44 struct DiscoveredCharacteristic {
rgrover1 239:693a1f145b5a 45 struct Properties_t {
rgrover1 239:693a1f145b5a 46 static const uint8_t BROADCAST_PROPERTY_MASK = 0x01;
rgrover1 239:693a1f145b5a 47 static const uint8_t READ_PROPERTY_MASK = 0x02;
rgrover1 239:693a1f145b5a 48 static const uint8_t WRITE_WO_RESPONSE_PROPERTY_MASK = 0x04;
rgrover1 239:693a1f145b5a 49 static const uint8_t WRITE_PROPERTY_MASK = 0x08;
rgrover1 239:693a1f145b5a 50 static const uint8_t NOTIFY_PROPERTY_MASK = 0x10;
rgrover1 239:693a1f145b5a 51 static const uint8_t INDICATE_PROPERTY_MASK = 0x20;
rgrover1 239:693a1f145b5a 52 static const uint8_t AUTH_SIGNED_PROPERTY_MASK = 0x40;
rgrover1 239:693a1f145b5a 53
rgrover1 239:693a1f145b5a 54 Properties_t() : broadcast(0), read(0), write_wo_resp(0), write(0), notify(0), indicate(0), auth_signed_wr(0) {
rgrover1 239:693a1f145b5a 55 /* empty */
rgrover1 239:693a1f145b5a 56 }
rgrover1 239:693a1f145b5a 57
rgrover1 239:693a1f145b5a 58 Properties_t(uint8_t props) :
rgrover1 239:693a1f145b5a 59 broadcast(props & BROADCAST_PROPERTY_MASK),
rgrover1 239:693a1f145b5a 60 read(props & READ_PROPERTY_MASK),
rgrover1 239:693a1f145b5a 61 write_wo_resp(props & WRITE_WO_RESPONSE_PROPERTY_MASK),
rgrover1 239:693a1f145b5a 62 write(props & WRITE_PROPERTY_MASK),
rgrover1 239:693a1f145b5a 63 notify(props & NOTIFY_PROPERTY_MASK),
rgrover1 239:693a1f145b5a 64 indicate(props & INDICATE_PROPERTY_MASK),
rgrover1 239:693a1f145b5a 65 auth_signed_wr(props & AUTH_SIGNED_PROPERTY_MASK) {
rgrover1 239:693a1f145b5a 66 /* empty*/
rgrover1 239:693a1f145b5a 67 }
rgrover1 239:693a1f145b5a 68
rgrover1 239:693a1f145b5a 69 uint8_t broadcast :1; /**< Broadcasting of the value permitted. */
rgrover1 239:693a1f145b5a 70 uint8_t read :1; /**< Reading the value permitted. */
rgrover1 239:693a1f145b5a 71 uint8_t write_wo_resp :1; /**< Writing the value with Write Command permitted. */
rgrover1 239:693a1f145b5a 72 uint8_t write :1; /**< Writing the value with Write Request permitted. */
rgrover1 239:693a1f145b5a 73 uint8_t notify :1; /**< Notications of the value permitted. */
rgrover1 239:693a1f145b5a 74 uint8_t indicate :1; /**< Indications of the value permitted. */
rgrover1 239:693a1f145b5a 75 uint8_t auth_signed_wr :1; /**< Writing the value with Signed Write Command permitted. */
rgrover1 239:693a1f145b5a 76 };
rgrover1 239:693a1f145b5a 77
rgrover1 239:693a1f145b5a 78 void setup(ShortUUIDBytes_t uuidIn, Properties_t propsIn, Gap::Handle_t declHandleIn, Gap::Handle_t valueHandleIn) {
rgrover1 239:693a1f145b5a 79 uuid = uuidIn;
rgrover1 239:693a1f145b5a 80 props = propsIn;
rgrover1 239:693a1f145b5a 81 declHandle = declHandleIn;
rgrover1 239:693a1f145b5a 82 valueHandle = valueHandleIn;
rgrover1 239:693a1f145b5a 83 }
rgrover1 239:693a1f145b5a 84
rgrover1 239:693a1f145b5a 85 ShortUUIDBytes_t uuid;
rgrover1 239:693a1f145b5a 86 Properties_t props;
rgrover1 239:693a1f145b5a 87 Gap::Handle_t declHandle;
rgrover1 239:693a1f145b5a 88 Gap::Handle_t valueHandle;
rgrover1 239:693a1f145b5a 89 };
rgrover1 239:693a1f145b5a 90
rgrover1 239:693a1f145b5a 91 class ServiceDiscovery {
rgrover1 239:693a1f145b5a 92 public:
rgrover1 253:f30c1233e9db 93 typedef void (*ServiceCallback_t)(const DiscoveredService &);
rgrover1 253:f30c1233e9db 94 typedef void (*CharacteristicCallback_t)(const DiscoveredCharacteristic &);
rgrover1 239:693a1f145b5a 95
rgrover1 239:693a1f145b5a 96 public:
rgrover1 239:693a1f145b5a 97 static ble_error_t launch(Gap::Handle_t connectionHandle,
rgrover1 239:693a1f145b5a 98 ServiceCallback_t sc,
rgrover1 239:693a1f145b5a 99 CharacteristicCallback_t cc = NULL);
rgrover1 239:693a1f145b5a 100 static ble_error_t launch(Gap::Handle_t connectionHandle,
rgrover1 256:2f2e9f1d6275 101 UUID matchingServiceUUIDIn,
rgrover1 239:693a1f145b5a 102 ServiceCallback_t sc,
rgrover1 256:2f2e9f1d6275 103 UUID matchingCharacteristicUUIDIn = ShortUUIDBytes_t(BLE_UUID_UNKNOWN),
rgrover1 239:693a1f145b5a 104 CharacteristicCallback_t cc = NULL);
rgrover1 239:693a1f145b5a 105
rgrover1 248:71ef03789dd3 106 static void terminate(void);
rgrover1 248:71ef03789dd3 107
rgrover1 248:71ef03789dd3 108 protected:
rgrover1 248:71ef03789dd3 109 Gap::Handle_t connHandle; /**< Connection handle as provided by the SoftDevice. */
rgrover1 256:2f2e9f1d6275 110 UUID matchingServiceUUID;
rgrover1 248:71ef03789dd3 111 ServiceCallback_t serviceCallback;
rgrover1 256:2f2e9f1d6275 112 UUID matchingCharacteristicUUID;
rgrover1 248:71ef03789dd3 113 CharacteristicCallback_t characteristicCallback;
rgrover1 248:71ef03789dd3 114 };
rgrover1 248:71ef03789dd3 115
rgrover1 250:db3c51656388 116 class NordicServiceDiscovery : public ServiceDiscovery
rgrover1 250:db3c51656388 117 {
rgrover1 248:71ef03789dd3 118 public:
rgrover1 260:ea2798f615e5 119 static const uint16_t SRV_DISC_START_HANDLE = 0x0001; /**< The start handle value used during service discovery. */
rgrover1 260:ea2798f615e5 120
rgrover1 260:ea2798f615e5 121 private:
rgrover1 248:71ef03789dd3 122 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 123 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 124
rgrover1 260:ea2798f615e5 125 public:
rgrover1 260:ea2798f615e5 126 ble_error_t launchCharacteristicDiscovery(Gap::Handle_t connectionHandle, Gap::Handle_t startHandle, Gap::Handle_t endHandle);
rgrover1 239:693a1f145b5a 127
rgrover1 239:693a1f145b5a 128 public:
rgrover1 248:71ef03789dd3 129 void setupDiscoveredServices(const ble_gattc_evt_prim_srvc_disc_rsp_t *response);
rgrover1 248:71ef03789dd3 130 void setupDiscoveredCharacteristics(const ble_gattc_evt_char_disc_rsp_t *response);
rgrover1 248:71ef03789dd3 131
rgrover1 248:71ef03789dd3 132 void terminateServiceDiscovery(void) {
rgrover1 242:73fc02cc20b1 133 sDiscoveryActive = false;
rgrover1 248:71ef03789dd3 134 cDiscoveryActive = false;
rgrover1 239:693a1f145b5a 135 }
rgrover1 239:693a1f145b5a 136
rgrover1 245:3abc61d38db3 137 void terminateCharacteristicDiscovery(void) {
rgrover1 245:3abc61d38db3 138 cDiscoveryActive = false;
rgrover1 245:3abc61d38db3 139 sDiscoveryActive = true;
rgrover1 245:3abc61d38db3 140 serviceIndex++; /* Progress service index to keep discovery alive. */
rgrover1 245:3abc61d38db3 141 }
rgrover1 245:3abc61d38db3 142
rgrover1 260:ea2798f615e5 143 private:
rgrover1 239:693a1f145b5a 144 void resetDiscoveredServices(void) {
rgrover1 242:73fc02cc20b1 145 numServices = 0;
rgrover1 242:73fc02cc20b1 146 serviceIndex = 0;
rgrover1 239:693a1f145b5a 147 memset(services, 0, sizeof(DiscoveredService) * BLE_DB_DISCOVERY_MAX_SRV);
rgrover1 239:693a1f145b5a 148 }
rgrover1 239:693a1f145b5a 149
rgrover1 245:3abc61d38db3 150 void resetDiscoveredCharacteristics(void) {
rgrover1 245:3abc61d38db3 151 numCharacteristics = 0;
rgrover1 245:3abc61d38db3 152 characteristicIndex = 0;
rgrover1 245:3abc61d38db3 153 memset(characteristics, 0, sizeof(DiscoveredCharacteristic) * BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV);
rgrover1 245:3abc61d38db3 154 }
rgrover1 245:3abc61d38db3 155
rgrover1 245:3abc61d38db3 156 public:
rgrover1 243:a966506d1e5b 157 void serviceDiscoveryStarted(Gap::Handle_t connectionHandle) {
rgrover1 243:a966506d1e5b 158 connHandle = connectionHandle;
rgrover1 243:a966506d1e5b 159 resetDiscoveredServices();
rgrover1 243:a966506d1e5b 160 sDiscoveryActive = true;
rgrover1 243:a966506d1e5b 161 cDiscoveryActive = false;
rgrover1 243:a966506d1e5b 162 }
rgrover1 243:a966506d1e5b 163
rgrover1 260:ea2798f615e5 164 private:
rgrover1 245:3abc61d38db3 165 void characteristicDiscoveryStarted(Gap::Handle_t connectionHandle) {
rgrover1 245:3abc61d38db3 166 connHandle = connectionHandle;
rgrover1 245:3abc61d38db3 167 resetDiscoveredCharacteristics();
rgrover1 245:3abc61d38db3 168 cDiscoveryActive = true;
rgrover1 245:3abc61d38db3 169 sDiscoveryActive = false;
rgrover1 245:3abc61d38db3 170 }
rgrover1 245:3abc61d38db3 171
rgrover1 251:d4e0cf5e8751 172 private:
rgrover1 251:d4e0cf5e8751 173 friend void bleGattcEventHandler(const ble_evt_t *p_ble_evt);
rgrover1 251:d4e0cf5e8751 174 void progressCharacteristicDiscovery(void);
rgrover1 251:d4e0cf5e8751 175 void progressServiceDiscovery(void);
rgrover1 239:693a1f145b5a 176
rgrover1 248:71ef03789dd3 177 private:
rgrover1 248:71ef03789dd3 178 uint8_t serviceIndex; /**< Index of the current service being discovered. This is intended for internal use during service discovery.*/
rgrover1 248:71ef03789dd3 179 uint8_t numServices; /**< Number of services at the peers GATT database.*/
rgrover1 248:71ef03789dd3 180 uint8_t characteristicIndex; /**< Index of the current characteristic being discovered. This is intended for internal use during service discovery.*/
rgrover1 248:71ef03789dd3 181 uint8_t numCharacteristics; /**< Number of characteristics within the service.*/
rgrover1 248:71ef03789dd3 182
rgrover1 248:71ef03789dd3 183 bool sDiscoveryActive;
rgrover1 248:71ef03789dd3 184 bool cDiscoveryActive;
rgrover1 248:71ef03789dd3 185
rgrover1 248:71ef03789dd3 186 DiscoveredService services[BLE_DB_DISCOVERY_MAX_SRV]; /**< Information related to the current service being discovered.
rgrover1 248:71ef03789dd3 187 * This is intended for internal use during service discovery. */
rgrover1 248:71ef03789dd3 188 DiscoveredCharacteristic characteristics[BLE_DB_DISCOVERY_MAX_CHAR_PER_SRV];
rgrover1 240:75b69581d1dd 189 };
rgrover1 240:75b69581d1dd 190
rgrover1 239:693a1f145b5a 191 #endif /*_BTLE_DISCOVERY_H_*/