1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 /** 39 * Implementation of the Device Information Service Server 40 * 41 * To use with your application, add '#import <device_information_sevice.gatt' to your .gatt file 42 * and call all functions below. All strings and blobs need to stay valid after calling the functions. 43 * 44 * @note: instead of calling all setters, you can create a local copy of the .gatt file and remove 45 * all Characteristics that are not relevant for your application. 46 */ 47 48 49 #include "btstack_defines.h" 50 #include "ble/att_db.h" 51 #include "ble/att_server.h" 52 #include "btstack_util.h" 53 #include "bluetooth_gatt.h" 54 55 #include "ble/gatt-service/device_information_service_server.h" 56 57 typedef enum { 58 MANUFACTURER_NAME = 0, 59 MODEL_NUMBER, 60 SERIAL_NUMBER, 61 HARDWARE_REVISION, 62 FIRMWARE_REVISION, 63 SOFTWARE_REVISION, 64 SYSTEM_ID, 65 IEEE_REGULATORY_CERTIFICATION, 66 PNP_ID, 67 NUM_INFORMATION_FIELDS 68 } device_information_field_id_t; 69 70 typedef struct { 71 uint8_t * data; 72 uint16_t len; 73 uint16_t value_handle; 74 } device_information_field_t; 75 76 const uint16_t device_information_characteristic_uuids[] = { 77 ORG_BLUETOOTH_CHARACTERISTIC_MANUFACTURER_NAME_STRING, 78 ORG_BLUETOOTH_CHARACTERISTIC_MODEL_NUMBER_STRING, 79 ORG_BLUETOOTH_CHARACTERISTIC_SERIAL_NUMBER_STRING, 80 ORG_BLUETOOTH_CHARACTERISTIC_HARDWARE_REVISION_STRING, 81 ORG_BLUETOOTH_CHARACTERISTIC_FIRMWARE_REVISION_STRING, 82 ORG_BLUETOOTH_CHARACTERISTIC_SOFTWARE_REVISION_STRING, 83 ORG_BLUETOOTH_CHARACTERISTIC_SYSTEM_ID, 84 ORG_BLUETOOTH_CHARACTERISTIC_IEEE_11073_20601_REGULATORY_CERTIFICATION_DATA_LIST, 85 ORG_BLUETOOTH_CHARACTERISTIC_PNP_ID 86 }; 87 88 static device_information_field_t device_information_fields[NUM_INFORMATION_FIELDS]; 89 90 static uint8_t device_information_system_id[8]; 91 static uint8_t device_information_ieee_regulatory_certification[4]; 92 static uint8_t device_information_pnp_id[7]; 93 94 static att_service_handler_t device_information_service; 95 96 static void set_string(device_information_field_id_t field_id, const char * text){ 97 device_information_fields[field_id].data = (uint8_t*) text; 98 device_information_fields[field_id].len = strlen(text); 99 } 100 101 static uint16_t device_information_service_read_callback(hci_con_handle_t con_handle, uint16_t attribute_handle, uint16_t offset, uint8_t * buffer, uint16_t buffer_size){ 102 int i; 103 for (i=0;i<NUM_INFORMATION_FIELDS;i++){ 104 if (device_information_fields[i].value_handle != attribute_handle) continue; 105 if (buffer == 0){ 106 return device_information_fields[i].len; 107 } 108 int bytes_to_copy = btstack_min(device_information_fields[i].len - offset, buffer_size); 109 memcpy(buffer, &device_information_fields[i].data[offset], bytes_to_copy); 110 return bytes_to_copy; 111 } 112 return 0; 113 } 114 115 void device_information_service_server_init(void){ 116 117 // get service handle range 118 uint16_t start_handle; 119 uint16_t end_handle; 120 int service_found = gatt_server_get_get_handle_range_for_service_with_uuid16(ORG_BLUETOOTH_SERVICE_DEVICE_INFORMATION, &start_handle, &end_handle); 121 if (!service_found) return; 122 123 // get characteristic value handles 124 int i; 125 for (i=0;i<NUM_INFORMATION_FIELDS;i++){ 126 device_information_fields[i].value_handle = gatt_server_get_value_handle_for_characteristic_with_uuid16(start_handle, end_handle, device_information_characteristic_uuids[i]); 127 } 128 129 // register service with ATT DB 130 device_information_service.start_handle = start_handle; 131 device_information_service.end_handle = end_handle; 132 device_information_service.read_callback = &device_information_service_read_callback; 133 device_information_service.write_callback = NULL; 134 att_register_service_handler(&device_information_service); 135 } 136 137 /** 138 * @brief Set Manufacturer Name 139 * @param manufacturer_name 140 */ 141 void device_information_service_server_set_manufacturer_name(const char * manufacturer_name){ 142 set_string(MANUFACTURER_NAME, manufacturer_name); 143 } 144 145 /** 146 * @brief Set Model Number 147 * @param model_number 148 */ 149 void device_information_service_server_set_model_number(const char * model_number){ 150 set_string(MODEL_NUMBER, model_number); 151 } 152 153 /** 154 * @brief Set Serial Number 155 * @param serial_number 156 */ 157 void device_information_service_server_set_serial_number(const char * serial_number){ 158 set_string(SERIAL_NUMBER, serial_number); 159 } 160 161 /** 162 * @brief Set Hardware Revision 163 * @param hardware_revision 164 */ 165 void device_information_service_server_set_hardware_revision(const char * hardware_revision){ 166 set_string(HARDWARE_REVISION, hardware_revision); 167 } 168 169 /** 170 * @brief Set Firmware Revision 171 * @param firmware_revision 172 */ 173 void device_information_service_server_set_firmware_revision(const char * firmware_revision){ 174 set_string(FIRMWARE_REVISION, firmware_revision); 175 } 176 177 /** 178 * @brief Set Software Revision 179 * @param software_revision 180 */ 181 void device_information_service_server_set_software_revision(const char * software_revision){ 182 set_string(SOFTWARE_REVISION, software_revision); 183 } 184 185 /** 186 * @brief Set System ID 187 * @param manufacturer_identifier uint40 188 * @param organizationally_unique_identifier uint24 189 */ 190 void device_information_service_server_set_system_id(uint64_t manufacturer_identifier, uint32_t organizationally_unique_identifier){ 191 device_information_fields[SYSTEM_ID].data = device_information_system_id; 192 device_information_fields[SYSTEM_ID].len = 8; 193 194 little_endian_store_32(device_information_system_id, 0, manufacturer_identifier); 195 device_information_system_id[4] = manufacturer_identifier >> 32; 196 little_endian_store_16(device_information_system_id, 5, organizationally_unique_identifier); 197 device_information_system_id[7] = organizationally_unique_identifier >> 16; 198 } 199 200 /** 201 * @brief Set IEEE 11073-20601 regulatory certification data list 202 * @note: format duint16. duint16 is two uint16 values concatenated together. 203 * @param ieee_regulatory_certification 204 */ 205 void device_information_service_server_set_ieee_regulatory_certification(uint16_t value_a, uint16_t value_b){ 206 device_information_fields[IEEE_REGULATORY_CERTIFICATION].data = device_information_ieee_regulatory_certification; 207 device_information_fields[IEEE_REGULATORY_CERTIFICATION].len = 4; 208 209 little_endian_store_16(device_information_ieee_regulatory_certification, 0, value_a); 210 little_endian_store_16(device_information_ieee_regulatory_certification, 2, value_b); 211 } 212 213 /** 214 * @brief Set PNP ID 215 * @param vendor_source_id 216 * @param vendor_id 217 * @param product_id 218 */ 219 void device_information_service_server_set_pnp_id(uint8_t vendor_source_id, uint16_t vendor_id, uint16_t product_id, uint16_t product_version){ 220 device_information_fields[PNP_ID].data = device_information_pnp_id; 221 device_information_fields[PNP_ID].len = 7; 222 223 device_information_pnp_id[0] = vendor_source_id; 224 little_endian_store_16(device_information_pnp_id, 1, vendor_source_id); 225 little_endian_store_16(device_information_pnp_id, 3, vendor_id); 226 little_endian_store_16(device_information_pnp_id, 5, product_id); 227 } 228