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 BLUEKITCHEN 24 * GMBH 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 #define BTSTACK_FILE__ "device_information_service_server.c" 39 40 /** 41 * Implementation of the Device Information Service Server 42 * 43 * To use with your application, add '#import <device_information_sevice.gatt' to your .gatt file 44 * and call all functions below. All strings and blobs need to stay valid after calling the functions. 45 * 46 * @note: instead of calling all setters, you can create a local copy of the .gatt file and remove 47 * all Characteristics that are not relevant for your application. 48 */ 49 50 51 #include "btstack_defines.h" 52 #include "ble/att_db.h" 53 #include "ble/att_server.h" 54 #include "btstack_util.h" 55 #include "bluetooth_gatt.h" 56 #include "btstack_debug.h" 57 58 #include "ble/gatt-service/device_information_service_server.h" 59 60 typedef enum { 61 MANUFACTURER_NAME = 0, 62 MODEL_NUMBER, 63 SERIAL_NUMBER, 64 HARDWARE_REVISION, 65 FIRMWARE_REVISION, 66 SOFTWARE_REVISION, 67 SYSTEM_ID, 68 IEEE_REGULATORY_CERTIFICATION, 69 PNP_ID, 70 NUM_INFORMATION_FIELDS 71 } device_information_field_id_t; 72 73 typedef struct { 74 uint8_t * data; 75 uint16_t len; 76 uint16_t value_handle; 77 } device_information_field_t; 78 79 static device_information_field_t device_information_fields[NUM_INFORMATION_FIELDS]; 80 81 static uint8_t device_information_system_id[8]; 82 static uint8_t device_information_ieee_regulatory_certification[4]; 83 static uint8_t device_information_pnp_id[7]; 84 85 static att_service_handler_t device_information_service; 86 static void set_string(device_information_field_id_t field_id, const char * text){ 87 device_information_fields[field_id].data = (uint8_t*) text; 88 device_information_fields[field_id].len = (uint8_t) strlen(text); 89 } 90 91 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){ 92 UNUSED(con_handle); // ok: info same for all devices 93 unsigned int i; 94 for (i=0;i<NUM_INFORMATION_FIELDS;i++){ 95 if ((device_information_fields[i].value_handle == attribute_handle) && (device_information_fields[i].data != NULL)){ 96 return att_read_callback_handle_blob(device_information_fields[i].data, device_information_fields[i].len, offset, buffer, buffer_size); 97 }; 98 } 99 return 0; 100 } 101 102 void device_information_service_server_init(void){ 103 104 const uint16_t device_information_characteristic_uuids[] = { 105 ORG_BLUETOOTH_CHARACTERISTIC_MANUFACTURER_NAME_STRING, 106 ORG_BLUETOOTH_CHARACTERISTIC_MODEL_NUMBER_STRING, 107 ORG_BLUETOOTH_CHARACTERISTIC_SERIAL_NUMBER_STRING, 108 ORG_BLUETOOTH_CHARACTERISTIC_HARDWARE_REVISION_STRING, 109 ORG_BLUETOOTH_CHARACTERISTIC_FIRMWARE_REVISION_STRING, 110 ORG_BLUETOOTH_CHARACTERISTIC_SOFTWARE_REVISION_STRING, 111 ORG_BLUETOOTH_CHARACTERISTIC_SYSTEM_ID, 112 ORG_BLUETOOTH_CHARACTERISTIC_IEEE_11073_20601_REGULATORY_CERTIFICATION_DATA_LIST, 113 ORG_BLUETOOTH_CHARACTERISTIC_PNP_ID 114 }; 115 116 117 // get service handle range 118 uint16_t start_handle = 0; 119 uint16_t end_handle = 0xffff; 120 int service_found = gatt_server_get_handle_range_for_service_with_uuid16(ORG_BLUETOOTH_SERVICE_DEVICE_INFORMATION, &start_handle, &end_handle); 121 btstack_assert(service_found != 0); 122 UNUSED(service_found); 123 124 // set length for fixed size characateristics 125 device_information_fields[SYSTEM_ID].data = device_information_system_id; 126 device_information_fields[SYSTEM_ID].len = 8; 127 device_information_fields[IEEE_REGULATORY_CERTIFICATION].data = device_information_ieee_regulatory_certification; 128 device_information_fields[IEEE_REGULATORY_CERTIFICATION].len = 4; 129 device_information_fields[PNP_ID].data = device_information_pnp_id; 130 device_information_fields[PNP_ID].len = 7; 131 132 // get characteristic value handles 133 int i; 134 for (i=0;i<NUM_INFORMATION_FIELDS;i++){ 135 device_information_fields[i].value_handle = gatt_server_get_value_handle_for_characteristic_with_uuid16(start_handle, end_handle, device_information_characteristic_uuids[i]); 136 } 137 138 // register service with ATT Server 139 device_information_service.start_handle = start_handle; 140 device_information_service.end_handle = end_handle; 141 device_information_service.read_callback = &device_information_service_read_callback; 142 device_information_service.write_callback = NULL; 143 att_server_register_service_handler(&device_information_service); 144 } 145 146 /** 147 * @brief Set Manufacturer Name 148 * @param manufacturer_name 149 */ 150 void device_information_service_server_set_manufacturer_name(const char * manufacturer_name){ 151 set_string(MANUFACTURER_NAME, manufacturer_name); 152 } 153 154 /** 155 * @brief Set Model Number 156 * @param model_number 157 */ 158 void device_information_service_server_set_model_number(const char * model_number){ 159 set_string(MODEL_NUMBER, model_number); 160 } 161 162 /** 163 * @brief Set Serial Number 164 * @param serial_number 165 */ 166 void device_information_service_server_set_serial_number(const char * serial_number){ 167 set_string(SERIAL_NUMBER, serial_number); 168 } 169 170 /** 171 * @brief Set Hardware Revision 172 * @param hardware_revision 173 */ 174 void device_information_service_server_set_hardware_revision(const char * hardware_revision){ 175 set_string(HARDWARE_REVISION, hardware_revision); 176 } 177 178 /** 179 * @brief Set Firmware Revision 180 * @param firmware_revision 181 */ 182 void device_information_service_server_set_firmware_revision(const char * firmware_revision){ 183 set_string(FIRMWARE_REVISION, firmware_revision); 184 } 185 186 /** 187 * @brief Set Software Revision 188 * @param software_revision 189 */ 190 void device_information_service_server_set_software_revision(const char * software_revision){ 191 set_string(SOFTWARE_REVISION, software_revision); 192 } 193 194 /** 195 * @brief Set System ID 196 * @param manufacturer_identifier uint40 197 * @param organizationally_unique_identifier uint24 198 */ 199 void device_information_service_server_set_system_id(uint64_t manufacturer_identifier, uint32_t organizationally_unique_identifier){ 200 little_endian_store_32(device_information_system_id, 0, (uint32_t)(manufacturer_identifier & 0xffffffff)); 201 device_information_system_id[4] = (uint8_t) (manufacturer_identifier >> 32); 202 little_endian_store_16(device_information_system_id, 5, organizationally_unique_identifier); 203 device_information_system_id[7] = organizationally_unique_identifier >> 16; 204 } 205 206 /** 207 * @brief Set IEEE 11073-20601 regulatory certification data list 208 * @note: format duint16. duint16 is two uint16 values concatenated together. 209 * @param ieee_regulatory_certification 210 */ 211 void device_information_service_server_set_ieee_regulatory_certification(uint16_t value_a, uint16_t value_b){ 212 little_endian_store_16(device_information_ieee_regulatory_certification, 0, value_a); 213 little_endian_store_16(device_information_ieee_regulatory_certification, 2, value_b); 214 } 215 216 /** 217 * @brief Set PNP ID 218 * @param vendor_source_id 219 * @param vendor_id 220 * @param product_id 221 */ 222 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){ 223 device_information_pnp_id[0] = vendor_source_id; 224 little_endian_store_16(device_information_pnp_id, 1, vendor_id); 225 little_endian_store_16(device_information_pnp_id, 3, product_id); 226 little_endian_store_16(device_information_pnp_id, 5, product_version); 227 } 228