Lancaster University / nRF51822

Clone of the nRF51822 repository from github The correct home is https://github.com/lancaster-university/nRF51822

Dependencies:   nrf51-sdk

Dependents:   microbit-dal microbit-ble-open microbit-dal-eddystone microbit-dal-ble-accelerometer-example ... more

btle/custom/custom_helper.cpp@18:465e0419c178, 2014-06-05 (annotated)

Committer:
Rohit Grover
Date:
Thu Jun 05 08:50:55 2014 +0100
Revision:
18:465e0419c178
Parent:
15:11b0c15979d1
Child:
19:c5b5cb65cc6f
switch to using LongUUID_t and ShortUUID_t

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:eff01767de02 1 /* mbed Microcontroller Library
bogdanm 0:eff01767de02 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 0:eff01767de02 3 *
bogdanm 0:eff01767de02 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 0:eff01767de02 5 * you may not use this file except in compliance with the License.
bogdanm 0:eff01767de02 6 * You may obtain a copy of the License at
bogdanm 0:eff01767de02 7 *
bogdanm 0:eff01767de02 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 0:eff01767de02 9 *
bogdanm 0:eff01767de02 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 0:eff01767de02 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 0:eff01767de02 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 0:eff01767de02 13 * See the License for the specific language governing permissions and
bogdanm 0:eff01767de02 14 * limitations under the License.
bogdanm 0:eff01767de02 15 */
bogdanm 0:eff01767de02 16
bogdanm 0:eff01767de02 17 #include "custom_helper.h"
bogdanm 0:eff01767de02 18
Rohit Grover 15:11b0c15979d1 19 /*
Rohit Grover 15:11b0c15979d1 20 * The current version of the soft-device doesn't handle duplicate 128-bit UUIDs
Rohit Grover 15:11b0c15979d1 21 * very well. It is therefore necessary to filter away duplicates before
Rohit Grover 15:11b0c15979d1 22 * passing long UUIDs to sd_ble_uuid_vs_add(). The following types and data
Rohit Grover 15:11b0c15979d1 23 * structures involved in maintaining a local cache of 128-bit UUIDs.
Rohit Grover 10:68c0e6cabe07 24 */
Rohit Grover 10:68c0e6cabe07 25 typedef struct {
Rohit Grover 18:465e0419c178 26 LongUUID_t uuid;
Rohit Grover 10:68c0e6cabe07 27 uint8_t type;
Rohit Grover 10:68c0e6cabe07 28 } converted_uuid_table_entry_t;
Rohit Grover 10:68c0e6cabe07 29 static const unsigned UUID_TABLE_MAX_ENTRIES = 8; /* This is the maximum number
Rohit Grover 10:68c0e6cabe07 30 * of 128-bit UUIDs with distinct bases that
Rohit Grover 10:68c0e6cabe07 31 * we expect to be in use; increase this
Rohit Grover 10:68c0e6cabe07 32 * limit if needed. */
Rohit Grover 10:68c0e6cabe07 33 static unsigned uuidTableEntries = 0; /* current usage of the table */
Rohit Grover 10:68c0e6cabe07 34 converted_uuid_table_entry_t convertedUUIDTable[UUID_TABLE_MAX_ENTRIES];
Rohit Grover 10:68c0e6cabe07 35
Rohit Grover 10:68c0e6cabe07 36 /**
Rohit Grover 9:3794dc9540f0 37 * lookup the cache of previously converted 128-bit UUIDs to find a type value.
Rohit Grover 9:3794dc9540f0 38 * @param uuid long UUID
Rohit Grover 9:3794dc9540f0 39 * @param recoveredType the type field of the 3-byte nRF's uuid.
Rohit Grover 9:3794dc9540f0 40 * @return true if a match is found.
Rohit Grover 9:3794dc9540f0 41 */
Rohit Grover 9:3794dc9540f0 42 static bool
Rohit Grover 18:465e0419c178 43 lookupConvertedUUIDTable(const LongUUID_t uuid,
Rohit Grover 18:465e0419c178 44 uint8_t *recoveredType)
Rohit Grover 9:3794dc9540f0 45 {
Rohit Grover 10:68c0e6cabe07 46 unsigned i;
Rohit Grover 10:68c0e6cabe07 47 for (i = 0; i < uuidTableEntries; i++) {
Rohit Grover 10:68c0e6cabe07 48 if (memcmp(convertedUUIDTable[i].uuid,
Rohit Grover 10:68c0e6cabe07 49 uuid,
Rohit Grover 18:465e0419c178 50 LENGTH_OF_LONG_UUID) == 0) {
Rohit Grover 10:68c0e6cabe07 51 *recoveredType = convertedUUIDTable[i].type;
Rohit Grover 10:68c0e6cabe07 52 return true;
Rohit Grover 10:68c0e6cabe07 53 }
Rohit Grover 10:68c0e6cabe07 54 }
Rohit Grover 10:68c0e6cabe07 55
Rohit Grover 9:3794dc9540f0 56 return false;
Rohit Grover 9:3794dc9540f0 57 }
Rohit Grover 9:3794dc9540f0 58
Rohit Grover 9:3794dc9540f0 59 static void
Rohit Grover 18:465e0419c178 60 addToConvertedUUIDTable(const LongUUID_t uuid, uint8_t type)
Rohit Grover 9:3794dc9540f0 61 {
Rohit Grover 10:68c0e6cabe07 62 if (uuidTableEntries == UUID_TABLE_MAX_ENTRIES) {
Rohit Grover 10:68c0e6cabe07 63 return; /* recovery needed; or at least the user should be
Rohit Grover 10:68c0e6cabe07 64 * warned about this fact.*/
Rohit Grover 10:68c0e6cabe07 65 }
Rohit Grover 10:68c0e6cabe07 66
Rohit Grover 18:465e0419c178 67 memcpy(convertedUUIDTable[uuidTableEntries].uuid, uuid,LENGTH_OF_LONG_UUID);
Rohit Grover 10:68c0e6cabe07 68 convertedUUIDTable[uuidTableEntries].type = type;
Rohit Grover 10:68c0e6cabe07 69 uuidTableEntries++;
Rohit Grover 9:3794dc9540f0 70 }
Rohit Grover 9:3794dc9540f0 71
Rohit Grover 9:3794dc9540f0 72 /**
Rohit Grover 8:2214f1df6a6a 73 * The nRF transport has its own 3-byte representation of a UUID. If the user-
Rohit Grover 8:2214f1df6a6a 74 * specified UUID is 128-bits wide, then the UUID base needs to be added to the
Rohit Grover 8:2214f1df6a6a 75 * soft-device and converted to a 3-byte handle before being used further. This
Rohit Grover 8:2214f1df6a6a 76 * function is responsible for this translation of user-specified UUIDs into
Rohit Grover 8:2214f1df6a6a 77 * nRF's representation.
Rohit Grover 8:2214f1df6a6a 78 *
Rohit Grover 8:2214f1df6a6a 79 * @param[in] uuid
Rohit Grover 8:2214f1df6a6a 80 * user-specified UUID
Rohit Grover 8:2214f1df6a6a 81 * @return nRF
Rohit Grover 8:2214f1df6a6a 82 * 3-byte UUID (containing a type and 16-bit UUID) representation
Rohit Grover 8:2214f1df6a6a 83 * to be used with SVC calls.
Rohit Grover 8:2214f1df6a6a 84 */
Rohit Grover 12:e151f55035b8 85 ble_uuid_t custom_convert_to_nordic_uuid(const UUID &uuid)
Rohit Grover 8:2214f1df6a6a 86 {
Rohit Grover 10:68c0e6cabe07 87 ble_uuid_t nordicUUID = {
Rohit Grover 18:465e0419c178 88 .uuid = uuid.getShortUUID(),
Rohit Grover 8:2214f1df6a6a 89 .type = BLE_UUID_TYPE_UNKNOWN /* to be set below */
Rohit Grover 8:2214f1df6a6a 90 };
Rohit Grover 8:2214f1df6a6a 91
Rohit Grover 13:b8251438f5c4 92 if (uuid.shortOrLong() == UUID::UUID_TYPE_SHORT) {
Rohit Grover 10:68c0e6cabe07 93 nordicUUID.type = BLE_UUID_TYPE_BLE;
Rohit Grover 8:2214f1df6a6a 94 } else {
Rohit Grover 13:b8251438f5c4 95 if (!lookupConvertedUUIDTable(uuid.getBaseUUID(), &nordicUUID.type)) {
Rohit Grover 13:b8251438f5c4 96 nordicUUID.type = custom_add_uuid_base(uuid.getBaseUUID());
Rohit Grover 13:b8251438f5c4 97 addToConvertedUUIDTable(uuid.getBaseUUID(), nordicUUID.type);
Rohit Grover 9:3794dc9540f0 98 }
Rohit Grover 8:2214f1df6a6a 99 }
Rohit Grover 8:2214f1df6a6a 100
Rohit Grover 10:68c0e6cabe07 101 return nordicUUID;
Rohit Grover 8:2214f1df6a6a 102 }
Rohit Grover 8:2214f1df6a6a 103
bogdanm 0:eff01767de02 104 /**************************************************************************/
bogdanm 0:eff01767de02 105 /*!
bogdanm 0:eff01767de02 106 @brief Adds the base UUID to the custom service. All UUIDs used
bogdanm 0:eff01767de02 107 by this service are based on this 128-bit UUID.
Rohit Grover 6:bbb4357dc135 108
bogdanm 0:eff01767de02 109 @note This UUID needs to be added to the SoftDevice stack before
bogdanm 0:eff01767de02 110 adding the service's primary service via
bogdanm 0:eff01767de02 111 'sd_ble_gatts_service_add'
bogdanm 0:eff01767de02 112
bogdanm 0:eff01767de02 113 @param[in] p_uuid_base A pointer to the 128-bit UUID array (8*16)
Rohit Grover 6:bbb4357dc135 114
bogdanm 0:eff01767de02 115 @returns The UUID type.
bogdanm 0:eff01767de02 116 A return value of 0 should be considered an error.
Rohit Grover 6:bbb4357dc135 117
bogdanm 0:eff01767de02 118 @retval 0x00 BLE_UUID_TYPE_UNKNOWN
bogdanm 0:eff01767de02 119 @retval 0x01 BLE_UUID_TYPE_BLE
bogdanm 0:eff01767de02 120 @retval 0x02 BLE_UUID_TYPE_VENDOR_BEGIN
Rohit Grover 6:bbb4357dc135 121
bogdanm 0:eff01767de02 122 @section EXAMPLE
bogdanm 0:eff01767de02 123 @code
bogdanm 0:eff01767de02 124
bogdanm 0:eff01767de02 125 // Take note that bytes 2/3 are blank since these are used to identify
bogdanm 0:eff01767de02 126 // the primary service and individual characteristics
bogdanm 0:eff01767de02 127 #define CFG_CUSTOM_UUID_BASE "\x6E\x40\x00\x00\xB5\xA3\xF3\x93\xE0\xA9\xE5\x0E\x24\xDC\xCA\x9E"
Rohit Grover 6:bbb4357dc135 128
bogdanm 0:eff01767de02 129 uint8_t uuid_type = custom_add_uuid_base(CFG_CUSTOM_UUID_BASE);
bogdanm 0:eff01767de02 130 ASSERT(uuid_type > 0, ERROR_NOT_FOUND);
Rohit Grover 6:bbb4357dc135 131
bogdanm 0:eff01767de02 132 // We can now safely add the primary service and any characteristics
bogdanm 0:eff01767de02 133 // for our custom service ...
Rohit Grover 6:bbb4357dc135 134
bogdanm 0:eff01767de02 135 @endcode
bogdanm 0:eff01767de02 136 */
bogdanm 0:eff01767de02 137 /**************************************************************************/
Rohit Grover 6:bbb4357dc135 138 uint8_t custom_add_uuid_base(uint8_t const *const p_uuid_base)
bogdanm 0:eff01767de02 139 {
Rohit Grover 6:bbb4357dc135 140 ble_uuid128_t base_uuid;
Rohit Grover 6:bbb4357dc135 141 uint8_t uuid_type = 0;
bogdanm 0:eff01767de02 142
Rohit Grover 6:bbb4357dc135 143 /* Reverse the bytes since ble_uuid128_t is LSB */
Rohit Grover 6:bbb4357dc135 144 for (uint8_t i = 0; i<16; i++) {
Rohit Grover 6:bbb4357dc135 145 base_uuid.uuid128[i] = p_uuid_base[15 - i];
Rohit Grover 6:bbb4357dc135 146 }
bogdanm 0:eff01767de02 147
Rohit Grover 6:bbb4357dc135 148 ASSERT_INT( ERROR_NONE, sd_ble_uuid_vs_add( &base_uuid, &uuid_type ), 0);
bogdanm 0:eff01767de02 149
Rohit Grover 6:bbb4357dc135 150 return uuid_type;
bogdanm 0:eff01767de02 151 }
bogdanm 0:eff01767de02 152
bogdanm 0:eff01767de02 153 /**************************************************************************/
bogdanm 0:eff01767de02 154 /*!
bogdanm 0:eff01767de02 155
bogdanm 0:eff01767de02 156 */
bogdanm 0:eff01767de02 157 /**************************************************************************/
Rohit Grover 6:bbb4357dc135 158 error_t custom_decode_uuid_base(uint8_t const *const p_uuid_base,
Rohit Grover 6:bbb4357dc135 159 ble_uuid_t *p_uuid)
bogdanm 0:eff01767de02 160 {
Rohit Grover 18:465e0419c178 161 LongUUID_t uuid_base_le;
bogdanm 0:eff01767de02 162
Rohit Grover 6:bbb4357dc135 163 /* Reverse the bytes since ble_uuid128_t is LSB */
Rohit Grover 6:bbb4357dc135 164 for (uint8_t i = 0; i<16; i++) {
Rohit Grover 6:bbb4357dc135 165 uuid_base_le[i] = p_uuid_base[15 - i];
Rohit Grover 6:bbb4357dc135 166 }
bogdanm 0:eff01767de02 167
Rohit Grover 6:bbb4357dc135 168 ASSERT_STATUS( sd_ble_uuid_decode(16, uuid_base_le, p_uuid));
bogdanm 0:eff01767de02 169
Rohit Grover 6:bbb4357dc135 170 return ERROR_NONE;
bogdanm 0:eff01767de02 171 }
bogdanm 0:eff01767de02 172
bogdanm 0:eff01767de02 173 /**************************************************************************/
bogdanm 0:eff01767de02 174 /*!
bogdanm 0:eff01767de02 175 @brief Adds a new characteristic to the custom service, assigning
bogdanm 0:eff01767de02 176 properties, a UUID add-on value, etc.
bogdanm 0:eff01767de02 177
bogdanm 0:eff01767de02 178 @param[in] service_handle
bogdanm 0:eff01767de02 179 @param[in] p_uuid The 16-bit value to add to the base UUID
bogdanm 0:eff01767de02 180 for this characteristic (normally >1
bogdanm 0:eff01767de02 181 since 1 is typically used by the primary
bogdanm 0:eff01767de02 182 service).
bogdanm 0:eff01767de02 183 @param[in] char_props The characteristic properties, as
bogdanm 0:eff01767de02 184 defined by ble_gatt_char_props_t
bogdanm 0:eff01767de02 185 @param[in] max_length The maximum length of this characeristic
bogdanm 0:eff01767de02 186 @param[in] p_char_handle
Rohit Grover 6:bbb4357dc135 187
bogdanm 0:eff01767de02 188 @returns
bogdanm 0:eff01767de02 189 @retval ERROR_NONE Everything executed normally
bogdanm 0:eff01767de02 190 */
bogdanm 0:eff01767de02 191 /**************************************************************************/
Rohit Grover 6:bbb4357dc135 192 error_t custom_add_in_characteristic(uint16_t service_handle,
Rohit Grover 6:bbb4357dc135 193 ble_uuid_t *p_uuid,
Rohit Grover 6:bbb4357dc135 194 uint8_t properties,
Rohit Grover 6:bbb4357dc135 195 uint8_t *p_data,
Rohit Grover 6:bbb4357dc135 196 uint16_t min_length,
Rohit Grover 6:bbb4357dc135 197 uint16_t max_length,
Rohit Grover 6:bbb4357dc135 198 ble_gatts_char_handles_t *p_char_handle)
bogdanm 0:eff01767de02 199 {
Rohit Grover 6:bbb4357dc135 200 /* Characteristic metadata */
Rohit Grover 6:bbb4357dc135 201 ble_gatts_attr_md_t cccd_md;
Rohit Grover 6:bbb4357dc135 202 ble_gatt_char_props_t char_props;
bogdanm 0:eff01767de02 203
Rohit Grover 6:bbb4357dc135 204 memcpy(&char_props, &properties, 1);
bogdanm 0:eff01767de02 205
Rohit Grover 6:bbb4357dc135 206 if (char_props.notify || char_props.indicate) {
Rohit Grover 6:bbb4357dc135 207 /* Notification requires cccd */
Rohit Grover 6:bbb4357dc135 208 memclr_( &cccd_md, sizeof(ble_gatts_attr_md_t));
Rohit Grover 6:bbb4357dc135 209 cccd_md.vloc = BLE_GATTS_VLOC_STACK;
Rohit Grover 6:bbb4357dc135 210 BLE_GAP_CONN_SEC_MODE_SET_OPEN(&cccd_md.read_perm);
Rohit Grover 6:bbb4357dc135 211 BLE_GAP_CONN_SEC_MODE_SET_OPEN(&cccd_md.write_perm);
Rohit Grover 6:bbb4357dc135 212 }
bogdanm 0:eff01767de02 213
Rohit Grover 6:bbb4357dc135 214 ble_gatts_char_md_t char_md = {0};
bogdanm 0:eff01767de02 215
Rohit Grover 6:bbb4357dc135 216 char_md.char_props = char_props;
Rohit Grover 6:bbb4357dc135 217 char_md.p_cccd_md =
Rohit Grover 6:bbb4357dc135 218 (char_props.notify || char_props.indicate) ? &cccd_md : NULL;
bogdanm 0:eff01767de02 219
Rohit Grover 6:bbb4357dc135 220 /* Attribute declaration */
Rohit Grover 6:bbb4357dc135 221 ble_gatts_attr_md_t attr_md = {0};
bogdanm 0:eff01767de02 222
Rohit Grover 6:bbb4357dc135 223 attr_md.vloc = BLE_GATTS_VLOC_STACK;
Rohit Grover 6:bbb4357dc135 224 attr_md.vlen = (min_length == max_length) ? 0 : 1;
bogdanm 0:eff01767de02 225
Rohit Grover 6:bbb4357dc135 226 if (char_props.read || char_props.notify || char_props.indicate) {
Rohit Grover 6:bbb4357dc135 227 BLE_GAP_CONN_SEC_MODE_SET_OPEN(&attr_md.read_perm);
Rohit Grover 6:bbb4357dc135 228 }
Rohit Grover 6:bbb4357dc135 229
Rohit Grover 6:bbb4357dc135 230 if (char_props.write) {
Rohit Grover 6:bbb4357dc135 231 BLE_GAP_CONN_SEC_MODE_SET_OPEN(&attr_md.write_perm);
Rohit Grover 6:bbb4357dc135 232 }
bogdanm 0:eff01767de02 233
Rohit Grover 6:bbb4357dc135 234 ble_gatts_attr_t attr_char_value = {0};
bogdanm 0:eff01767de02 235
Rohit Grover 6:bbb4357dc135 236 attr_char_value.p_uuid = p_uuid;
Rohit Grover 6:bbb4357dc135 237 attr_char_value.p_attr_md = &attr_md;
Rohit Grover 6:bbb4357dc135 238 attr_char_value.init_len = min_length;
Rohit Grover 6:bbb4357dc135 239 attr_char_value.max_len = max_length;
Rohit Grover 6:bbb4357dc135 240 attr_char_value.p_value = p_data;
bogdanm 0:eff01767de02 241
bogdanm 0:eff01767de02 242
Rohit Grover 6:bbb4357dc135 243 ASSERT_STATUS ( sd_ble_gatts_characteristic_add(service_handle,
Rohit Grover 6:bbb4357dc135 244 &char_md,
Rohit Grover 6:bbb4357dc135 245 &attr_char_value,
Rohit Grover 6:bbb4357dc135 246 p_char_handle));
bogdanm 0:eff01767de02 247
Rohit Grover 6:bbb4357dc135 248 return ERROR_NONE;
bogdanm 0:eff01767de02 249 }