Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/nRF51822/source/nRF5xCharacteristicDescriptorDiscoverer.cpp@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MrBedfordVan 0:b9164b348919 1 /* mbed Microcontroller Library
MrBedfordVan 0:b9164b348919 2 * Copyright (c) 2006-2015 ARM Limited
MrBedfordVan 0:b9164b348919 3 *
MrBedfordVan 0:b9164b348919 4 * Licensed under the Apache License, Version 2.0 (the "License");
MrBedfordVan 0:b9164b348919 5 * you may not use this file except in compliance with the License.
MrBedfordVan 0:b9164b348919 6 * You may obtain a copy of the License at
MrBedfordVan 0:b9164b348919 7 *
MrBedfordVan 0:b9164b348919 8 * http://www.apache.org/licenses/LICENSE-2.0
MrBedfordVan 0:b9164b348919 9 *
MrBedfordVan 0:b9164b348919 10 * Unless required by applicable law or agreed to in writing, software
MrBedfordVan 0:b9164b348919 11 * distributed under the License is distributed on an "AS IS" BASIS,
MrBedfordVan 0:b9164b348919 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
MrBedfordVan 0:b9164b348919 13 * See the License for the specific language governing permissions and
MrBedfordVan 0:b9164b348919 14 * limitations under the License.
MrBedfordVan 0:b9164b348919 15 */
MrBedfordVan 0:b9164b348919 16 #include "nRF5xCharacteristicDescriptorDiscoverer.h"
MrBedfordVan 0:b9164b348919 17 #include "ble_err.h"
MrBedfordVan 0:b9164b348919 18 #include "ble/DiscoveredCharacteristicDescriptor.h"
MrBedfordVan 0:b9164b348919 19
MrBedfordVan 0:b9164b348919 20 nRF5xCharacteristicDescriptorDiscoverer::nRF5xCharacteristicDescriptorDiscoverer() :
MrBedfordVan 0:b9164b348919 21 discoveryRunning() {
MrBedfordVan 0:b9164b348919 22 // nothing to do
MrBedfordVan 0:b9164b348919 23 }
MrBedfordVan 0:b9164b348919 24
MrBedfordVan 0:b9164b348919 25 nRF5xCharacteristicDescriptorDiscoverer::~nRF5xCharacteristicDescriptorDiscoverer() {
MrBedfordVan 0:b9164b348919 26 // nothing to do
MrBedfordVan 0:b9164b348919 27 }
MrBedfordVan 0:b9164b348919 28
MrBedfordVan 0:b9164b348919 29 ble_error_t nRF5xCharacteristicDescriptorDiscoverer::launch(
MrBedfordVan 0:b9164b348919 30 const DiscoveredCharacteristic& characteristic,
MrBedfordVan 0:b9164b348919 31 const CharacteristicDescriptorDiscovery::DiscoveryCallback_t& discoveryCallback,
MrBedfordVan 0:b9164b348919 32 const CharacteristicDescriptorDiscovery::TerminationCallback_t& terminationCallback
MrBedfordVan 0:b9164b348919 33 ) {
MrBedfordVan 0:b9164b348919 34 Gap::Handle_t connHandle = characteristic.getConnectionHandle();
MrBedfordVan 0:b9164b348919 35 // it is ok to deduce that the start handle for descriptors is after
MrBedfordVan 0:b9164b348919 36 // the characteristic declaration and the characteristic value declaration
MrBedfordVan 0:b9164b348919 37 // see BLUETOOTH SPECIFICATION Version 4.2 [Vol 3, Part G] (3.3)
MrBedfordVan 0:b9164b348919 38 Gap::Handle_t descriptorStartHandle = characteristic.getDeclHandle() + 2;
MrBedfordVan 0:b9164b348919 39 Gap::Handle_t descriptorEndHandle = characteristic.getLastHandle();
MrBedfordVan 0:b9164b348919 40
MrBedfordVan 0:b9164b348919 41 // check if there is any descriptor to discover
MrBedfordVan 0:b9164b348919 42 if (descriptorEndHandle < descriptorStartHandle) {
MrBedfordVan 0:b9164b348919 43 CharacteristicDescriptorDiscovery::TerminationCallbackParams_t termParams = {
MrBedfordVan 0:b9164b348919 44 characteristic,
MrBedfordVan 0:b9164b348919 45 BLE_ERROR_NONE
MrBedfordVan 0:b9164b348919 46 };
MrBedfordVan 0:b9164b348919 47 terminationCallback.call(&termParams);
MrBedfordVan 0:b9164b348919 48 return BLE_ERROR_NONE;
MrBedfordVan 0:b9164b348919 49 }
MrBedfordVan 0:b9164b348919 50
MrBedfordVan 0:b9164b348919 51 // check if we can run this discovery
MrBedfordVan 0:b9164b348919 52 if (isConnectionInUse(connHandle)) {
MrBedfordVan 0:b9164b348919 53 return BLE_STACK_BUSY;
MrBedfordVan 0:b9164b348919 54 }
MrBedfordVan 0:b9164b348919 55
MrBedfordVan 0:b9164b348919 56 // get a new discovery slot, if none are available, just return
MrBedfordVan 0:b9164b348919 57 Discovery* discovery = getAvailableDiscoverySlot();
MrBedfordVan 0:b9164b348919 58 if(discovery == NULL) {
MrBedfordVan 0:b9164b348919 59 return BLE_STACK_BUSY;
MrBedfordVan 0:b9164b348919 60 }
MrBedfordVan 0:b9164b348919 61
MrBedfordVan 0:b9164b348919 62 // try to launch the discovery
MrBedfordVan 0:b9164b348919 63 ble_error_t err = gattc_descriptors_discover(connHandle, descriptorStartHandle, descriptorEndHandle);
MrBedfordVan 0:b9164b348919 64 if(!err) {
MrBedfordVan 0:b9164b348919 65 // commit the new discovery to its slot
MrBedfordVan 0:b9164b348919 66 *discovery = Discovery(characteristic, discoveryCallback, terminationCallback);
MrBedfordVan 0:b9164b348919 67 }
MrBedfordVan 0:b9164b348919 68
MrBedfordVan 0:b9164b348919 69 return err;
MrBedfordVan 0:b9164b348919 70 }
MrBedfordVan 0:b9164b348919 71
MrBedfordVan 0:b9164b348919 72 bool nRF5xCharacteristicDescriptorDiscoverer::isActive(const DiscoveredCharacteristic& characteristic) const {
MrBedfordVan 0:b9164b348919 73 for(size_t i = 0; i < MAXIMUM_CONCURRENT_CONNECTIONS_COUNT; ++i) {
MrBedfordVan 0:b9164b348919 74 if(discoveryRunning[i].getCharacteristic() == characteristic) {
MrBedfordVan 0:b9164b348919 75 return true;
MrBedfordVan 0:b9164b348919 76 }
MrBedfordVan 0:b9164b348919 77 }
MrBedfordVan 0:b9164b348919 78 return false;
MrBedfordVan 0:b9164b348919 79 }
MrBedfordVan 0:b9164b348919 80
MrBedfordVan 0:b9164b348919 81 void nRF5xCharacteristicDescriptorDiscoverer::requestTerminate(const DiscoveredCharacteristic& characteristic) {
MrBedfordVan 0:b9164b348919 82 Discovery* discovery = findRunningDiscovery(characteristic);
MrBedfordVan 0:b9164b348919 83 if(discovery) {
MrBedfordVan 0:b9164b348919 84 // call terminate anyway
MrBedfordVan 0:b9164b348919 85 terminate(discovery, BLE_ERROR_NONE);
MrBedfordVan 0:b9164b348919 86 }
MrBedfordVan 0:b9164b348919 87 }
MrBedfordVan 0:b9164b348919 88
MrBedfordVan 0:b9164b348919 89 void nRF5xCharacteristicDescriptorDiscoverer::process(uint16_t connectionHandle, const ble_gattc_evt_desc_disc_rsp_t& descriptors) {
MrBedfordVan 0:b9164b348919 90 Discovery* discovery = findRunningDiscovery(connectionHandle);
MrBedfordVan 0:b9164b348919 91 // the discovery has been removed
MrBedfordVan 0:b9164b348919 92 if(!discovery) {
MrBedfordVan 0:b9164b348919 93 return;
MrBedfordVan 0:b9164b348919 94 }
MrBedfordVan 0:b9164b348919 95
MrBedfordVan 0:b9164b348919 96 for (uint16_t i = 0; i < descriptors.count; ++i) {
MrBedfordVan 0:b9164b348919 97 discovery->process(
MrBedfordVan 0:b9164b348919 98 descriptors.descs[i].handle, UUID(descriptors.descs[i].uuid.uuid)
MrBedfordVan 0:b9164b348919 99 );
MrBedfordVan 0:b9164b348919 100 }
MrBedfordVan 0:b9164b348919 101
MrBedfordVan 0:b9164b348919 102 // prepare the next discovery request (if needed)
MrBedfordVan 0:b9164b348919 103 uint16_t startHandle = descriptors.descs[descriptors.count - 1].handle + 1;
MrBedfordVan 0:b9164b348919 104 uint16_t endHandle = discovery->getCharacteristic().getLastHandle();
MrBedfordVan 0:b9164b348919 105
MrBedfordVan 0:b9164b348919 106 if(startHandle > endHandle) {
MrBedfordVan 0:b9164b348919 107 terminate(discovery, BLE_ERROR_NONE);
MrBedfordVan 0:b9164b348919 108 return;
MrBedfordVan 0:b9164b348919 109 }
MrBedfordVan 0:b9164b348919 110
MrBedfordVan 0:b9164b348919 111 ble_error_t err = gattc_descriptors_discover(connectionHandle, startHandle, endHandle);
MrBedfordVan 0:b9164b348919 112 if(err) {
MrBedfordVan 0:b9164b348919 113 terminate(discovery, err);
MrBedfordVan 0:b9164b348919 114 return;
MrBedfordVan 0:b9164b348919 115 }
MrBedfordVan 0:b9164b348919 116 }
MrBedfordVan 0:b9164b348919 117
MrBedfordVan 0:b9164b348919 118 void nRF5xCharacteristicDescriptorDiscoverer::terminate(uint16_t handle, ble_error_t err) {
MrBedfordVan 0:b9164b348919 119 Discovery* discovery = findRunningDiscovery(handle);
MrBedfordVan 0:b9164b348919 120 // the discovery has already been terminated
MrBedfordVan 0:b9164b348919 121 if(!discovery) {
MrBedfordVan 0:b9164b348919 122 return;
MrBedfordVan 0:b9164b348919 123 }
MrBedfordVan 0:b9164b348919 124
MrBedfordVan 0:b9164b348919 125 terminate(discovery, err);
MrBedfordVan 0:b9164b348919 126 }
MrBedfordVan 0:b9164b348919 127
MrBedfordVan 0:b9164b348919 128 void nRF5xCharacteristicDescriptorDiscoverer::terminate(Discovery* discovery, ble_error_t err) {
MrBedfordVan 0:b9164b348919 129 // temporary copy, user code can try to launch a new discovery in the onTerminate
MrBedfordVan 0:b9164b348919 130 // callback. So, this discovery should not appear in such case.
MrBedfordVan 0:b9164b348919 131 Discovery tmp = *discovery;
MrBedfordVan 0:b9164b348919 132 *discovery = Discovery();
MrBedfordVan 0:b9164b348919 133 tmp.terminate(err);
MrBedfordVan 0:b9164b348919 134 }
MrBedfordVan 0:b9164b348919 135
MrBedfordVan 0:b9164b348919 136 nRF5xCharacteristicDescriptorDiscoverer::Discovery*
MrBedfordVan 0:b9164b348919 137 nRF5xCharacteristicDescriptorDiscoverer::findRunningDiscovery(const DiscoveredCharacteristic& characteristic) {
MrBedfordVan 0:b9164b348919 138 for(size_t i = 0; i < MAXIMUM_CONCURRENT_CONNECTIONS_COUNT; ++i) {
MrBedfordVan 0:b9164b348919 139 if((discoveryRunning[i].getCharacteristic() == characteristic) &&
MrBedfordVan 0:b9164b348919 140 (discoveryRunning[i].isEmpty() == false)) {
MrBedfordVan 0:b9164b348919 141 return &discoveryRunning[i];
MrBedfordVan 0:b9164b348919 142 }
MrBedfordVan 0:b9164b348919 143 }
MrBedfordVan 0:b9164b348919 144 return NULL;
MrBedfordVan 0:b9164b348919 145 }
MrBedfordVan 0:b9164b348919 146
MrBedfordVan 0:b9164b348919 147 nRF5xCharacteristicDescriptorDiscoverer::Discovery*
MrBedfordVan 0:b9164b348919 148 nRF5xCharacteristicDescriptorDiscoverer::findRunningDiscovery(uint16_t handle) {
MrBedfordVan 0:b9164b348919 149 for(size_t i = 0; i < MAXIMUM_CONCURRENT_CONNECTIONS_COUNT; ++i) {
MrBedfordVan 0:b9164b348919 150 if((discoveryRunning[i].getCharacteristic().getConnectionHandle() == handle) &&
MrBedfordVan 0:b9164b348919 151 (discoveryRunning[i].isEmpty() == false)) {
MrBedfordVan 0:b9164b348919 152 return &discoveryRunning[i];
MrBedfordVan 0:b9164b348919 153 }
MrBedfordVan 0:b9164b348919 154 }
MrBedfordVan 0:b9164b348919 155 return NULL;
MrBedfordVan 0:b9164b348919 156 }
MrBedfordVan 0:b9164b348919 157
MrBedfordVan 0:b9164b348919 158 nRF5xCharacteristicDescriptorDiscoverer::Discovery*
MrBedfordVan 0:b9164b348919 159 nRF5xCharacteristicDescriptorDiscoverer::getAvailableDiscoverySlot() {
MrBedfordVan 0:b9164b348919 160 for(size_t i = 0; i < MAXIMUM_CONCURRENT_CONNECTIONS_COUNT; ++i) {
MrBedfordVan 0:b9164b348919 161 if(discoveryRunning[i].isEmpty()) {
MrBedfordVan 0:b9164b348919 162 return &discoveryRunning[i];
MrBedfordVan 0:b9164b348919 163 }
MrBedfordVan 0:b9164b348919 164 }
MrBedfordVan 0:b9164b348919 165 return NULL;
MrBedfordVan 0:b9164b348919 166 }
MrBedfordVan 0:b9164b348919 167
MrBedfordVan 0:b9164b348919 168 bool nRF5xCharacteristicDescriptorDiscoverer::isConnectionInUse(uint16_t connHandle) {
MrBedfordVan 0:b9164b348919 169 return findRunningDiscovery(connHandle) != NULL;
MrBedfordVan 0:b9164b348919 170 }
MrBedfordVan 0:b9164b348919 171
MrBedfordVan 0:b9164b348919 172 ble_error_t nRF5xCharacteristicDescriptorDiscoverer::gattc_descriptors_discover(
MrBedfordVan 0:b9164b348919 173 uint16_t connection_handle, uint16_t start_handle, uint16_t end_handle) {
MrBedfordVan 0:b9164b348919 174
MrBedfordVan 0:b9164b348919 175 ble_gattc_handle_range_t discoveryRange = {
MrBedfordVan 0:b9164b348919 176 start_handle,
MrBedfordVan 0:b9164b348919 177 end_handle
MrBedfordVan 0:b9164b348919 178 };
MrBedfordVan 0:b9164b348919 179 uint32_t err = sd_ble_gattc_descriptors_discover(connection_handle, &discoveryRange);
MrBedfordVan 0:b9164b348919 180
MrBedfordVan 0:b9164b348919 181 switch(err) {
MrBedfordVan 0:b9164b348919 182 case NRF_SUCCESS:
MrBedfordVan 0:b9164b348919 183 return BLE_ERROR_NONE;
MrBedfordVan 0:b9164b348919 184 case BLE_ERROR_INVALID_CONN_HANDLE:
MrBedfordVan 0:b9164b348919 185 return BLE_ERROR_INVALID_PARAM;
MrBedfordVan 0:b9164b348919 186 case NRF_ERROR_INVALID_ADDR:
MrBedfordVan 0:b9164b348919 187 return BLE_ERROR_PARAM_OUT_OF_RANGE;
MrBedfordVan 0:b9164b348919 188 case NRF_ERROR_BUSY:
MrBedfordVan 0:b9164b348919 189 return BLE_STACK_BUSY;
MrBedfordVan 0:b9164b348919 190 default:
MrBedfordVan 0:b9164b348919 191 return BLE_ERROR_UNSPECIFIED;
MrBedfordVan 0:b9164b348919 192 }
MrBedfordVan 0:b9164b348919 193 }
MrBedfordVan 0:b9164b348919 194
MrBedfordVan 0:b9164b348919 195 // implementation of nRF5xCharacteristicDescriptorDiscoverer::Discovery
MrBedfordVan 0:b9164b348919 196
MrBedfordVan 0:b9164b348919 197 nRF5xCharacteristicDescriptorDiscoverer::Discovery::Discovery() :
MrBedfordVan 0:b9164b348919 198 characteristic(), onDiscovery(), onTerminate() {
MrBedfordVan 0:b9164b348919 199 }
MrBedfordVan 0:b9164b348919 200
MrBedfordVan 0:b9164b348919 201 nRF5xCharacteristicDescriptorDiscoverer::Discovery::Discovery(
MrBedfordVan 0:b9164b348919 202 const DiscoveredCharacteristic& c, const DiscoveryCallback_t& dCb, const TerminationCallback_t& tCb) :
MrBedfordVan 0:b9164b348919 203 characteristic(c), onDiscovery(dCb), onTerminate(tCb) {
MrBedfordVan 0:b9164b348919 204 }
MrBedfordVan 0:b9164b348919 205
MrBedfordVan 0:b9164b348919 206 void nRF5xCharacteristicDescriptorDiscoverer::Discovery::process(
MrBedfordVan 0:b9164b348919 207 GattAttribute::Handle_t handle, const UUID& uuid) {
MrBedfordVan 0:b9164b348919 208 CharacteristicDescriptorDiscovery::DiscoveryCallbackParams_t params = {
MrBedfordVan 0:b9164b348919 209 characteristic,
MrBedfordVan 0:b9164b348919 210 DiscoveredCharacteristicDescriptor(
MrBedfordVan 0:b9164b348919 211 characteristic.getGattClient(),
MrBedfordVan 0:b9164b348919 212 characteristic.getConnectionHandle(),
MrBedfordVan 0:b9164b348919 213 handle,
MrBedfordVan 0:b9164b348919 214 uuid
MrBedfordVan 0:b9164b348919 215 )
MrBedfordVan 0:b9164b348919 216 };
MrBedfordVan 0:b9164b348919 217 onDiscovery.call(&params);
MrBedfordVan 0:b9164b348919 218 }
MrBedfordVan 0:b9164b348919 219
MrBedfordVan 0:b9164b348919 220 void nRF5xCharacteristicDescriptorDiscoverer::Discovery::terminate(ble_error_t err) {
MrBedfordVan 0:b9164b348919 221 CharacteristicDescriptorDiscovery::TerminationCallbackParams_t params = {
MrBedfordVan 0:b9164b348919 222 characteristic,
MrBedfordVan 0:b9164b348919 223 err
MrBedfordVan 0:b9164b348919 224 };
MrBedfordVan 0:b9164b348919 225
MrBedfordVan 0:b9164b348919 226 onTerminate.call(&params);
MrBedfordVan 0:b9164b348919 227 }
MrBedfordVan 0:b9164b348919 228
MrBedfordVan 0:b9164b348919 229 bool nRF5xCharacteristicDescriptorDiscoverer::Discovery::isEmpty() const {
MrBedfordVan 0:b9164b348919 230 return *this == Discovery();
MrBedfordVan 0:b9164b348919 231 }
MrBedfordVan 0:b9164b348919 232
MrBedfordVan 0:b9164b348919 233 const DiscoveredCharacteristic& nRF5xCharacteristicDescriptorDiscoverer::Discovery::getCharacteristic() const {
MrBedfordVan 0:b9164b348919 234 return characteristic;
MrBedfordVan 0:b9164b348919 235 }