xref: /btstack/example/sdp_bnep_query.c (revision 235946f152c66eb4ba735043adb492f7a538d15c)
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 #define __BTSTACK_FILE__ "sdp_bnep_query.c"
39 
40 // *****************************************************************************
41 /* EXAMPLE_START(sdp_bnep_query): Dump remote BNEP PAN protocol UUID and L2CAP PSM
42  *
43  * @text The example shows how the SDP Client is used to get all BNEP service
44  * records from a remote device. It extracts the remote BNEP PAN protocol
45  * UUID and the L2CAP PSM, which are needed to connect to a remote BNEP service.
46  */
47 // *****************************************************************************
48 
49 #include "btstack_config.h"
50 
51 #include <stdint.h>
52 #include <stdio.h>
53 #include <stdlib.h>
54 #include <string.h>
55 
56 #include "btstack.h"
57 
58 int record_id = -1;
59 int attribute_id = -1;
60 
61 static uint8_t   attribute_value[1000];
62 static const int attribute_value_buffer_size = sizeof(attribute_value);
63 
64 static bd_addr_t remote = {0x04,0x0C,0xCE,0xE4,0x85,0xD3};
65 static btstack_packet_callback_registration_t hci_event_callback_registration;
66 
67 static void assertBuffer(int size){
68     if (size > attribute_value_buffer_size){
69         printf("SDP attribute value buffer size exceeded: available %d, required %d", attribute_value_buffer_size, size);
70     }
71 }
72 
73 /* @section SDP Client Setup
74  *
75  * @text As with the previous example, you must register a
76  * callback, i.e. query handler, with the SPD parser, as shown in
77  * Listing SDPClientInit. Via this handler, the SDP client will receive events:
78  * - SDP_EVENT_QUERY_ATTRIBUTE_VALUE containing the results of the query in chunks,
79  * - SDP_EVENT_QUERY_COMPLETE reporting the status and the end of the query.
80  */
81 
82 /* LISTING_START(SDPClientInit): SDP client setup */
83 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
84 static void handle_sdp_client_query_result(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
85 
86 static void sdp_client_init(void){
87 
88     // register for HCI events
89     hci_event_callback_registration.callback = &packet_handler;
90     hci_add_event_handler(&hci_event_callback_registration);
91 
92     // init L2CAP
93     l2cap_init();
94 }
95 /* LISTING_END */
96 
97 
98 /* @section SDP Client Query
99  * To trigger an SDP query to get the a list of service records on a remote device,
100  * you need to call sdp_client_query_uuid16() with the remote address and the
101  * BNEP protocol UUID, as shown in Listing SDPQueryUUID.
102  * In this example we again used fixed address of the remote device. Please update
103  * for your environment.
104  */
105 
106 /* LISTING_START(SDPQueryUUID): Querying the a list of service records on a remote device. */
107 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
108     UNUSED(channel);
109     UNUSED(size);
110 
111     if (packet_type != HCI_EVENT_PACKET) return;
112     uint8_t event = hci_event_packet_get_type(packet);
113 
114     switch (event) {
115         case BTSTACK_EVENT_STATE:
116             // BTstack activated, get started
117             if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){
118                 printf("Start SDP BNEP query.\n");
119                 sdp_client_query_uuid16(&handle_sdp_client_query_result, remote, BLUETOOTH_PROTOCOL_BNEP);
120             }
121             break;
122         default:
123             break;
124     }
125 }
126 /* LISTING_END */
127 
128 static char * get_string_from_data_element(uint8_t * element){
129     de_size_t de_size = de_get_size_type(element);
130     int pos     = de_get_header_size(element);
131     int len = 0;
132     switch (de_size){
133         case DE_SIZE_VAR_8:
134             len = element[1];
135             break;
136         case DE_SIZE_VAR_16:
137             len = big_endian_read_16(element, 1);
138             break;
139         default:
140             break;
141     }
142     char * str = (char*)malloc(len+1);
143     memcpy(str, &element[pos], len);
144     str[len] ='\0';
145     return str;
146 }
147 
148 
149 /* @section Handling SDP Client Query Result
150  *
151  * @text The SDP Client returns the result of the query in chunks. Each result
152  * packet contains the record ID, the Attribute ID, and a chunk of the Attribute
153  * value, see Listing HandleSDPQUeryResult. Here, we show how to parse the
154  * Service Class ID List and Protocol Descriptor List, as they contain
155  * the BNEP Protocol UUID and L2CAP PSM respectively.
156  */
157 
158 /* LISTING_START(HandleSDPQUeryResult): Extracting BNEP Protcol UUID and L2CAP PSM */
159 static void handle_sdp_client_query_result(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
160     UNUSED(packet_type);
161     UNUSED(channel);
162     UNUSED(size);
163 
164     /* LISTING_PAUSE */
165     des_iterator_t des_list_it;
166     des_iterator_t prot_it;
167     char *str;
168 
169     switch (hci_event_packet_get_type(packet)){
170         case SDP_EVENT_QUERY_ATTRIBUTE_VALUE:
171             // handle new record
172             if (sdp_event_query_attribute_byte_get_record_id(packet) != record_id){
173                 record_id = sdp_event_query_attribute_byte_get_record_id(packet);
174                 printf("\n---\nRecord nr. %u\n", record_id);
175             }
176 
177             assertBuffer(sdp_event_query_attribute_byte_get_attribute_length(packet));
178 
179             attribute_value[sdp_event_query_attribute_byte_get_data_offset(packet)] = sdp_event_query_attribute_byte_get_data(packet);
180             if ((uint16_t)(sdp_event_query_attribute_byte_get_data_offset(packet)+1) == sdp_event_query_attribute_byte_get_attribute_length(packet)){
181 
182                 /* LISTING_RESUME */
183                 /* @text The Service Class ID List is a Data Element Sequence (DES) of UUIDs.
184                  * The BNEP PAN protocol UUID is within this list.
185                  */
186 
187                 switch(sdp_event_query_attribute_byte_get_attribute_id(packet)){
188                     // 0x0001 "Service Class ID List"
189                     case BLUETOOTH_ATTRIBUTE_SERVICE_CLASS_ID_LIST:
190                         if (de_get_element_type(attribute_value) != DE_DES) break;
191                         for (des_iterator_init(&des_list_it, attribute_value); des_iterator_has_more(&des_list_it); des_iterator_next(&des_list_it)){
192                             uint8_t * element = des_iterator_get_element(&des_list_it);
193                             if (de_get_element_type(element) != DE_UUID) continue;
194                             uint32_t uuid = de_get_uuid32(element);
195                             switch (uuid){
196                                 case BLUETOOTH_SERVICE_CLASS_PANU:
197                                 case BLUETOOTH_SERVICE_CLASS_NAP:
198                                 case BLUETOOTH_SERVICE_CLASS_GN:
199                                     printf(" ** Attribute 0x%04x: BNEP PAN protocol UUID: %04x\n", sdp_event_query_attribute_byte_get_attribute_id(packet), uuid);
200                                     break;
201                                 default:
202                                     break;
203                             }
204                         }
205                         break;
206                     /* LISTING_PAUSE */
207                     // 0x0100 "Service Name"
208                     case 0x0100:
209                     // 0x0101 "Service Description"
210                     case 0x0101:
211                         str = get_string_from_data_element(attribute_value);
212                         printf(" ** Attribute 0x%04x: %s\n", sdp_event_query_attribute_byte_get_attribute_id(packet), str);
213                         free(str);
214                         break;
215 
216                     /* LISTING_RESUME */
217                     /* @text The Protocol Descriptor List is DES
218                      * which contains one DES for each protocol. For PAN serivces, it contains
219                      * a DES with the L2CAP Protocol UUID and a PSM,
220                      * and another DES with the BNEP UUID and the the BNEP version.
221                      */
222                     case BLUETOOTH_ATTRIBUTE_PROTOCOL_DESCRIPTOR_LIST:{
223                             printf(" ** Attribute 0x%04x: ", sdp_event_query_attribute_byte_get_attribute_id(packet));
224 
225                             uint16_t l2cap_psm = 0;
226                             uint16_t bnep_version = 0;
227                             for (des_iterator_init(&des_list_it, attribute_value); des_iterator_has_more(&des_list_it); des_iterator_next(&des_list_it)){
228                                 if (des_iterator_get_type(&des_list_it) != DE_DES) continue;
229                                 uint8_t * des_element = des_iterator_get_element(&des_list_it);
230                                 des_iterator_init(&prot_it, des_element);
231                                 uint8_t * element = des_iterator_get_element(&prot_it);
232 
233                                 if (de_get_element_type(element) != DE_UUID) continue;
234                                 uint32_t uuid = de_get_uuid32(element);
235                                 switch (uuid){
236                                     case BLUETOOTH_PROTOCOL_L2CAP:
237                                         if (!des_iterator_has_more(&prot_it)) continue;
238                                         des_iterator_next(&prot_it);
239                                         de_element_get_uint16(des_iterator_get_element(&prot_it), &l2cap_psm);
240                                         break;
241                                     case BLUETOOTH_PROTOCOL_BNEP:
242                                         if (!des_iterator_has_more(&prot_it)) continue;
243                                         des_iterator_next(&prot_it);
244                                         de_element_get_uint16(des_iterator_get_element(&prot_it), &bnep_version);
245                                         break;
246                                     default:
247                                         break;
248                                 }
249                             }
250                             printf("l2cap_psm 0x%04x, bnep_version 0x%04x\n", l2cap_psm, bnep_version);
251                         }
252                         break;
253                     /* LISTING_PAUSE */
254                     default:
255                         break;
256                 }
257             }
258             break;
259         case SDP_EVENT_QUERY_COMPLETE:
260             printf("General query done with status %d.\n\n", sdp_event_query_complete_get_status(packet));
261             break;
262     }
263     /* LISTING_RESUME */
264 }
265 /* LISTING_END */
266 
267 int btstack_main(int argc, const char * argv[]);
268 int btstack_main(int argc, const char * argv[]){
269     (void)argc;
270     (void)argv;
271 
272     printf("Client HCI init done\r\n");
273 
274     sdp_client_init();
275 
276     // turn on!
277     hci_power_control(HCI_POWER_ON);
278 
279     return 0;
280 }
281 
282 /* EXAMPLE_END */