Oscar Ariza / nRF51822

nordic

Fork of nRF51822 by Nordic Semiconductor

btle/custom/custom_helper.cpp@21:84599842b5fb, 2014-06-06 (annotated)

Committer:
Rohit Grover
Date:
Fri Jun 06 14:13:32 2014 +0100
Revision:
21:84599842b5fb
Parent:
19:c5b5cb65cc6f
Child:
22:c6ee8136847e
white space changes to move away from 80-column rule

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 19:c5b5cb65cc6f 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 21:84599842b5fb 43 lookupConvertedUUIDTable(const LongUUID_t uuid, uint8_t *recoveredType)
Rohit Grover 9:3794dc9540f0 44 {
Rohit Grover 10:68c0e6cabe07 45 unsigned i;
Rohit Grover 10:68c0e6cabe07 46 for (i = 0; i < uuidTableEntries; i++) {
Rohit Grover 10:68c0e6cabe07 47 if (memcmp(convertedUUIDTable[i].uuid,
Rohit Grover 10:68c0e6cabe07 48 uuid,
Rohit Grover 18:465e0419c178 49 LENGTH_OF_LONG_UUID) == 0) {
Rohit Grover 10:68c0e6cabe07 50 *recoveredType = convertedUUIDTable[i].type;
Rohit Grover 10:68c0e6cabe07 51 return true;
Rohit Grover 10:68c0e6cabe07 52 }
Rohit Grover 10:68c0e6cabe07 53 }
Rohit Grover 10:68c0e6cabe07 54
Rohit Grover 9:3794dc9540f0 55 return false;
Rohit Grover 9:3794dc9540f0 56 }
Rohit Grover 9:3794dc9540f0 57
Rohit Grover 9:3794dc9540f0 58 static void
Rohit Grover 18:465e0419c178 59 addToConvertedUUIDTable(const LongUUID_t uuid, uint8_t type)
Rohit Grover 9:3794dc9540f0 60 {
Rohit Grover 10:68c0e6cabe07 61 if (uuidTableEntries == UUID_TABLE_MAX_ENTRIES) {
Rohit Grover 10:68c0e6cabe07 62 return; /* recovery needed; or at least the user should be
Rohit Grover 10:68c0e6cabe07 63 * warned about this fact.*/
Rohit Grover 10:68c0e6cabe07 64 }
Rohit Grover 10:68c0e6cabe07 65
Rohit Grover 18:465e0419c178 66 memcpy(convertedUUIDTable[uuidTableEntries].uuid, uuid,LENGTH_OF_LONG_UUID);
Rohit Grover 10:68c0e6cabe07 67 convertedUUIDTable[uuidTableEntries].type = type;
Rohit Grover 10:68c0e6cabe07 68 uuidTableEntries++;
Rohit Grover 9:3794dc9540f0 69 }
Rohit Grover 9:3794dc9540f0 70
Rohit Grover 9:3794dc9540f0 71 /**
Rohit Grover 8:2214f1df6a6a 72 * The nRF transport has its own 3-byte representation of a UUID. If the user-
Rohit Grover 8:2214f1df6a6a 73 * specified UUID is 128-bits wide, then the UUID base needs to be added to the
Rohit Grover 8:2214f1df6a6a 74 * soft-device and converted to a 3-byte handle before being used further. This
Rohit Grover 8:2214f1df6a6a 75 * function is responsible for this translation of user-specified UUIDs into
Rohit Grover 8:2214f1df6a6a 76 * nRF's representation.
Rohit Grover 8:2214f1df6a6a 77 *
Rohit Grover 8:2214f1df6a6a 78 * @param[in] uuid
Rohit Grover 8:2214f1df6a6a 79 * user-specified UUID
Rohit Grover 8:2214f1df6a6a 80 * @return nRF
Rohit Grover 8:2214f1df6a6a 81 * 3-byte UUID (containing a type and 16-bit UUID) representation
Rohit Grover 8:2214f1df6a6a 82 * to be used with SVC calls.
Rohit Grover 8:2214f1df6a6a 83 */
Rohit Grover 12:e151f55035b8 84 ble_uuid_t custom_convert_to_nordic_uuid(const UUID &uuid)
Rohit Grover 8:2214f1df6a6a 85 {
Rohit Grover 10:68c0e6cabe07 86 ble_uuid_t nordicUUID = {
Rohit Grover 18:465e0419c178 87 .uuid = uuid.getShortUUID(),
Rohit Grover 8:2214f1df6a6a 88 .type = BLE_UUID_TYPE_UNKNOWN /* to be set below */
Rohit Grover 8:2214f1df6a6a 89 };
Rohit Grover 8:2214f1df6a6a 90
Rohit Grover 13:b8251438f5c4 91 if (uuid.shortOrLong() == UUID::UUID_TYPE_SHORT) {
Rohit Grover 10:68c0e6cabe07 92 nordicUUID.type = BLE_UUID_TYPE_BLE;
Rohit Grover 8:2214f1df6a6a 93 } else {
Rohit Grover 13:b8251438f5c4 94 if (!lookupConvertedUUIDTable(uuid.getBaseUUID(), &nordicUUID.type)) {
Rohit Grover 13:b8251438f5c4 95 nordicUUID.type = custom_add_uuid_base(uuid.getBaseUUID());
Rohit Grover 13:b8251438f5c4 96 addToConvertedUUIDTable(uuid.getBaseUUID(), nordicUUID.type);
Rohit Grover 9:3794dc9540f0 97 }
Rohit Grover 8:2214f1df6a6a 98 }
Rohit Grover 8:2214f1df6a6a 99
Rohit Grover 10:68c0e6cabe07 100 return nordicUUID;
Rohit Grover 8:2214f1df6a6a 101 }
Rohit Grover 8:2214f1df6a6a 102
bogdanm 0:eff01767de02 103 /**************************************************************************/
bogdanm 0:eff01767de02 104 /*!
bogdanm 0:eff01767de02 105 @brief Adds the base UUID to the custom service. All UUIDs used
bogdanm 0:eff01767de02 106 by this service are based on this 128-bit UUID.
Rohit Grover 6:bbb4357dc135 107
bogdanm 0:eff01767de02 108 @note This UUID needs to be added to the SoftDevice stack before
bogdanm 0:eff01767de02 109 adding the service's primary service via
bogdanm 0:eff01767de02 110 'sd_ble_gatts_service_add'
bogdanm 0:eff01767de02 111
bogdanm 0:eff01767de02 112 @param[in] p_uuid_base A pointer to the 128-bit UUID array (8*16)
Rohit Grover 6:bbb4357dc135 113
bogdanm 0:eff01767de02 114 @returns The UUID type.
bogdanm 0:eff01767de02 115 A return value of 0 should be considered an error.
Rohit Grover 6:bbb4357dc135 116
bogdanm 0:eff01767de02 117 @retval 0x00 BLE_UUID_TYPE_UNKNOWN
bogdanm 0:eff01767de02 118 @retval 0x01 BLE_UUID_TYPE_BLE
bogdanm 0:eff01767de02 119 @retval 0x02 BLE_UUID_TYPE_VENDOR_BEGIN
Rohit Grover 6:bbb4357dc135 120
bogdanm 0:eff01767de02 121 @section EXAMPLE
bogdanm 0:eff01767de02 122 @code
bogdanm 0:eff01767de02 123
bogdanm 0:eff01767de02 124 // Take note that bytes 2/3 are blank since these are used to identify
bogdanm 0:eff01767de02 125 // the primary service and individual characteristics
bogdanm 0:eff01767de02 126 #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 127
bogdanm 0:eff01767de02 128 uint8_t uuid_type = custom_add_uuid_base(CFG_CUSTOM_UUID_BASE);
bogdanm 0:eff01767de02 129 ASSERT(uuid_type > 0, ERROR_NOT_FOUND);
Rohit Grover 6:bbb4357dc135 130
bogdanm 0:eff01767de02 131 // We can now safely add the primary service and any characteristics
bogdanm 0:eff01767de02 132 // for our custom service ...
Rohit Grover 6:bbb4357dc135 133
bogdanm 0:eff01767de02 134 @endcode
bogdanm 0:eff01767de02 135 */
bogdanm 0:eff01767de02 136 /**************************************************************************/
Rohit Grover 6:bbb4357dc135 137 uint8_t custom_add_uuid_base(uint8_t const *const p_uuid_base)
bogdanm 0:eff01767de02 138 {
Rohit Grover 6:bbb4357dc135 139 ble_uuid128_t base_uuid;
Rohit Grover 6:bbb4357dc135 140 uint8_t uuid_type = 0;
bogdanm 0:eff01767de02 141
Rohit Grover 6:bbb4357dc135 142 /* Reverse the bytes since ble_uuid128_t is LSB */
Rohit Grover 6:bbb4357dc135 143 for (uint8_t i = 0; i<16; i++) {
Rohit Grover 6:bbb4357dc135 144 base_uuid.uuid128[i] = p_uuid_base[15 - i];
Rohit Grover 6:bbb4357dc135 145 }
bogdanm 0:eff01767de02 146
Rohit Grover 6:bbb4357dc135 147 ASSERT_INT( ERROR_NONE, sd_ble_uuid_vs_add( &base_uuid, &uuid_type ), 0);
bogdanm 0:eff01767de02 148
Rohit Grover 6:bbb4357dc135 149 return uuid_type;
bogdanm 0:eff01767de02 150 }
bogdanm 0:eff01767de02 151
bogdanm 0:eff01767de02 152 /**************************************************************************/
bogdanm 0:eff01767de02 153 /*!
bogdanm 0:eff01767de02 154
bogdanm 0:eff01767de02 155 */
bogdanm 0:eff01767de02 156 /**************************************************************************/
Rohit Grover 6:bbb4357dc135 157 error_t custom_decode_uuid_base(uint8_t const *const p_uuid_base,
Rohit Grover 6:bbb4357dc135 158 ble_uuid_t *p_uuid)
bogdanm 0:eff01767de02 159 {
Rohit Grover 18:465e0419c178 160 LongUUID_t uuid_base_le;
bogdanm 0:eff01767de02 161
Rohit Grover 6:bbb4357dc135 162 /* Reverse the bytes since ble_uuid128_t is LSB */
Rohit Grover 6:bbb4357dc135 163 for (uint8_t i = 0; i<16; i++) {
Rohit Grover 6:bbb4357dc135 164 uuid_base_le[i] = p_uuid_base[15 - i];
Rohit Grover 6:bbb4357dc135 165 }
bogdanm 0:eff01767de02 166
Rohit Grover 6:bbb4357dc135 167 ASSERT_STATUS( sd_ble_uuid_decode(16, uuid_base_le, p_uuid));
bogdanm 0:eff01767de02 168
Rohit Grover 6:bbb4357dc135 169 return ERROR_NONE;
bogdanm 0:eff01767de02 170 }
bogdanm 0:eff01767de02 171
bogdanm 0:eff01767de02 172 /**************************************************************************/
bogdanm 0:eff01767de02 173 /*!
bogdanm 0:eff01767de02 174 @brief Adds a new characteristic to the custom service, assigning
bogdanm 0:eff01767de02 175 properties, a UUID add-on value, etc.
bogdanm 0:eff01767de02 176
bogdanm 0:eff01767de02 177 @param[in] service_handle
bogdanm 0:eff01767de02 178 @param[in] p_uuid The 16-bit value to add to the base UUID
bogdanm 0:eff01767de02 179 for this characteristic (normally >1
bogdanm 0:eff01767de02 180 since 1 is typically used by the primary
bogdanm 0:eff01767de02 181 service).
bogdanm 0:eff01767de02 182 @param[in] char_props The characteristic properties, as
bogdanm 0:eff01767de02 183 defined by ble_gatt_char_props_t
bogdanm 0:eff01767de02 184 @param[in] max_length The maximum length of this characeristic
bogdanm 0:eff01767de02 185 @param[in] p_char_handle
Rohit Grover 6:bbb4357dc135 186
bogdanm 0:eff01767de02 187 @returns
bogdanm 0:eff01767de02 188 @retval ERROR_NONE Everything executed normally
bogdanm 0:eff01767de02 189 */
bogdanm 0:eff01767de02 190 /**************************************************************************/
Rohit Grover 19:c5b5cb65cc6f 191 error_t custom_add_in_characteristic(uint16_t service_handle,
Rohit Grover 19:c5b5cb65cc6f 192 ble_uuid_t *p_uuid,
Rohit Grover 19:c5b5cb65cc6f 193 uint8_t properties,
Rohit Grover 19:c5b5cb65cc6f 194 uint8_t *p_data,
Rohit Grover 19:c5b5cb65cc6f 195 uint16_t min_length,
Rohit Grover 19:c5b5cb65cc6f 196 uint16_t max_length,
Rohit Grover 6:bbb4357dc135 197 ble_gatts_char_handles_t *p_char_handle)
bogdanm 0:eff01767de02 198 {
Rohit Grover 6:bbb4357dc135 199 /* Characteristic metadata */
Rohit Grover 6:bbb4357dc135 200 ble_gatts_attr_md_t cccd_md;
Rohit Grover 6:bbb4357dc135 201 ble_gatt_char_props_t char_props;
bogdanm 0:eff01767de02 202
Rohit Grover 6:bbb4357dc135 203 memcpy(&char_props, &properties, 1);
bogdanm 0:eff01767de02 204
Rohit Grover 6:bbb4357dc135 205 if (char_props.notify || char_props.indicate) {
Rohit Grover 6:bbb4357dc135 206 /* Notification requires cccd */
Rohit Grover 6:bbb4357dc135 207 memclr_( &cccd_md, sizeof(ble_gatts_attr_md_t));
Rohit Grover 6:bbb4357dc135 208 cccd_md.vloc = BLE_GATTS_VLOC_STACK;
Rohit Grover 6:bbb4357dc135 209 BLE_GAP_CONN_SEC_MODE_SET_OPEN(&cccd_md.read_perm);
Rohit Grover 6:bbb4357dc135 210 BLE_GAP_CONN_SEC_MODE_SET_OPEN(&cccd_md.write_perm);
Rohit Grover 6:bbb4357dc135 211 }
bogdanm 0:eff01767de02 212
Rohit Grover 6:bbb4357dc135 213 ble_gatts_char_md_t char_md = {0};
bogdanm 0:eff01767de02 214
Rohit Grover 6:bbb4357dc135 215 char_md.char_props = char_props;
Rohit Grover 6:bbb4357dc135 216 char_md.p_cccd_md =
Rohit Grover 6:bbb4357dc135 217 (char_props.notify || char_props.indicate) ? &cccd_md : NULL;
bogdanm 0:eff01767de02 218
Rohit Grover 6:bbb4357dc135 219 /* Attribute declaration */
Rohit Grover 6:bbb4357dc135 220 ble_gatts_attr_md_t attr_md = {0};
bogdanm 0:eff01767de02 221
Rohit Grover 6:bbb4357dc135 222 attr_md.vloc = BLE_GATTS_VLOC_STACK;
Rohit Grover 6:bbb4357dc135 223 attr_md.vlen = (min_length == max_length) ? 0 : 1;
bogdanm 0:eff01767de02 224
Rohit Grover 6:bbb4357dc135 225 if (char_props.read || char_props.notify || char_props.indicate) {
Rohit Grover 6:bbb4357dc135 226 BLE_GAP_CONN_SEC_MODE_SET_OPEN(&attr_md.read_perm);
Rohit Grover 6:bbb4357dc135 227 }
Rohit Grover 6:bbb4357dc135 228
Rohit Grover 6:bbb4357dc135 229 if (char_props.write) {
Rohit Grover 6:bbb4357dc135 230 BLE_GAP_CONN_SEC_MODE_SET_OPEN(&attr_md.write_perm);
Rohit Grover 6:bbb4357dc135 231 }
bogdanm 0:eff01767de02 232
Rohit Grover 6:bbb4357dc135 233 ble_gatts_attr_t attr_char_value = {0};
bogdanm 0:eff01767de02 234
Rohit Grover 6:bbb4357dc135 235 attr_char_value.p_uuid = p_uuid;
Rohit Grover 6:bbb4357dc135 236 attr_char_value.p_attr_md = &attr_md;
Rohit Grover 6:bbb4357dc135 237 attr_char_value.init_len = min_length;
Rohit Grover 6:bbb4357dc135 238 attr_char_value.max_len = max_length;
Rohit Grover 6:bbb4357dc135 239 attr_char_value.p_value = p_data;
bogdanm 0:eff01767de02 240
Rohit Grover 6:bbb4357dc135 241 ASSERT_STATUS ( sd_ble_gatts_characteristic_add(service_handle,
Rohit Grover 6:bbb4357dc135 242 &char_md,
Rohit Grover 6:bbb4357dc135 243 &attr_char_value,
Rohit Grover 6:bbb4357dc135 244 p_char_handle));
bogdanm 0:eff01767de02 245
Rohit Grover 6:bbb4357dc135 246 return ERROR_NONE;
bogdanm 0:eff01767de02 247 }