xref: /btstack/example/panu_demo.c (revision a8d51f092f1b660d0f6921369ad2bc3f9368296c)
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__ "panu_demo.c"
39 
40 /*
41  * panu_demo.c
42  * Author: Ole Reinhardt <[email protected]>
43  */
44 
45 /* EXAMPLE_START(panu_demo): BNEP/PANU (Linux only)
46  *
47  * @text This example implements both a PANU client and a server. In server mode, it
48  * sets up a BNEP server and registers a PANU SDP record and waits for incoming connections.
49  * In client mode, it connects to a remote device, does an SDP Query to identify the PANU
50  * service and initiates a BNEP connection.
51  *
52  * Note: currently supported only on Linux and provides a TAP network interface which you
53  *       can configure yourself.
54  *
55  * To enable client mode, uncomment ENABLE_PANU_CLIENT below.
56  */
57 
58 #include <stdio.h>
59 
60 #include "btstack_config.h"
61 #include "btstack.h"
62 
63 // #define ENABLE_PANU_CLIENT
64 
65 // network types
66 #define NETWORK_TYPE_IPv4       0x0800
67 #define NETWORK_TYPE_ARP        0x0806
68 #define NETWORK_TYPE_IPv6       0x86DD
69 
70 static int record_id = -1;
71 static uint16_t bnep_l2cap_psm      = 0;
72 static uint32_t bnep_remote_uuid    = 0;
73 static uint16_t bnep_version        = 0;
74 static uint16_t bnep_cid            = 0;
75 
76 static uint16_t sdp_bnep_l2cap_psm      = 0;
77 static uint16_t sdp_bnep_version        = 0;
78 static uint32_t sdp_bnep_remote_uuid    = 0;
79 
80 static uint8_t   attribute_value[1000];
81 static const unsigned int attribute_value_buffer_size = sizeof(attribute_value);
82 
83 // MBP 2016
84 static const char * remote_addr_string = "78:4F:43:8C:B2:5D";
85 // Wiko Sunny static const char * remote_addr_string = "A0:4C:5B:0F:B2:42";
86 
87 static bd_addr_t remote_addr;
88 
89 static btstack_packet_callback_registration_t hci_event_callback_registration;
90 
91 // outgoing network packet
92 static const uint8_t * network_buffer;
93 static uint16_t network_buffer_len;
94 
95 static uint8_t panu_sdp_record[220];
96 
97 /* @section Main application configuration
98  *
99  * @text In the application configuration, L2CAP and BNEP are initialized and a BNEP service, for server mode,
100  * is registered, before the Bluetooth stack gets started, as shown in Listing PanuSetup.
101  */
102 
103 /* LISTING_START(PanuSetup): Panu setup */
104 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
105 static void handle_sdp_client_query_result(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
106 static void network_send_packet_callback(const uint8_t * packet, uint16_t size);
107 
108 static void panu_setup(void){
109 
110     // Initialize L2CAP
111     l2cap_init();
112 
113 
114     // init SDP, create record for PANU and register with SDP
115     sdp_init();
116     memset(panu_sdp_record, 0, sizeof(panu_sdp_record));
117     uint16_t network_packet_types[] = { NETWORK_TYPE_IPv4, NETWORK_TYPE_ARP, 0};    // 0 as end of list
118 
119     // Initialise BNEP
120     bnep_init();
121     // Minimum L2CAP MTU for bnep is 1691 bytes
122 #ifdef ENABLE_PANU_CLIENT
123     bnep_register_service(packet_handler, BLUETOOTH_SERVICE_CLASS_PANU, 1691);
124     // PANU
125     pan_create_panu_sdp_record(panu_sdp_record, sdp_create_service_record_handle(), network_packet_types, NULL, NULL, BNEP_SECURITY_NONE);
126 #else
127     bnep_register_service(packet_handler, BLUETOOTH_SERVICE_CLASS_NAP, 1691);
128     // NAP Network Access Type: Other, 1 MB/s
129     pan_create_nap_sdp_record(panu_sdp_record, sdp_create_service_record_handle(), network_packet_types, NULL, NULL, BNEP_SECURITY_NONE, PAN_NET_ACCESS_TYPE_OTHER, 1000000, NULL, NULL);
130 #endif
131     sdp_register_service(panu_sdp_record);
132     printf("SDP service record size: %u\n", de_get_len((uint8_t*) panu_sdp_record));
133 
134     // Initialize network interface
135     btstack_network_init(&network_send_packet_callback);
136 
137     // register for HCI events
138     hci_event_callback_registration.callback = &packet_handler;
139     hci_add_event_handler(&hci_event_callback_registration);
140 }
141 /* LISTING_END */
142 
143 #ifdef ENABLE_PANU_CLIENT
144 
145 // PANU client routines
146 static void get_string_from_data_element(uint8_t * element, uint16_t buffer_size, char * buffer_data){
147     de_size_t de_size = de_get_size_type(element);
148     int pos     = de_get_header_size(element);
149     int len = 0;
150     switch (de_size){
151         case DE_SIZE_VAR_8:
152             len = element[1];
153             break;
154         case DE_SIZE_VAR_16:
155             len = big_endian_read_16(element, 1);
156             break;
157         default:
158             break;
159     }
160     uint16_t bytes_to_copy = btstack_min(buffer_size-1,len);
161     memcpy(buffer_data, &element[pos], bytes_to_copy);
162     buffer_data[bytes_to_copy] ='\0';
163 }
164 
165 
166 /* @section SDP parser callback
167  *
168  * @text The SDP parsers retrieves the BNEP PAN UUID as explained in
169  * Section [on SDP BNEP Query example](#sec:sdpbnepqueryExample}.
170  */
171 static void handle_sdp_client_record_complete(void){
172 
173     printf("SDP BNEP Record complete\n");
174 
175     // accept first entry or if we foudn a NAP and only have a PANU yet
176     if ((bnep_remote_uuid == 0) || (sdp_bnep_remote_uuid == BLUETOOTH_SERVICE_CLASS_NAP && bnep_remote_uuid == BLUETOOTH_SERVICE_CLASS_PANU)){
177         bnep_l2cap_psm   = sdp_bnep_l2cap_psm;
178         bnep_remote_uuid = sdp_bnep_remote_uuid;
179         bnep_version     = sdp_bnep_version;
180     }
181 }
182 
183 static void handle_sdp_client_query_result(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size) {
184 
185     UNUSED(packet_type);
186     UNUSED(channel);
187     UNUSED(size);
188 
189     des_iterator_t des_list_it;
190     des_iterator_t prot_it;
191     char str[20];
192 
193     switch (hci_event_packet_get_type(packet)){
194         case SDP_EVENT_QUERY_ATTRIBUTE_VALUE:
195             // Handle new SDP record
196             if (sdp_event_query_attribute_byte_get_record_id(packet) != record_id) {
197                 handle_sdp_client_record_complete();
198                 // next record started
199                 record_id = sdp_event_query_attribute_byte_get_record_id(packet);
200                 printf("SDP Record: Nr: %d\n", record_id);
201             }
202 
203             if (sdp_event_query_attribute_byte_get_attribute_length(packet) <= attribute_value_buffer_size) {
204                 attribute_value[sdp_event_query_attribute_byte_get_data_offset(packet)] = sdp_event_query_attribute_byte_get_data(packet);
205 
206                 if ((uint16_t)(sdp_event_query_attribute_byte_get_data_offset(packet)+1) == sdp_event_query_attribute_byte_get_attribute_length(packet)) {
207 
208                     switch(sdp_event_query_attribute_byte_get_attribute_id(packet)) {
209                         case BLUETOOTH_ATTRIBUTE_SERVICE_CLASS_ID_LIST:
210                             if (de_get_element_type(attribute_value) != DE_DES) break;
211                             for (des_iterator_init(&des_list_it, attribute_value); des_iterator_has_more(&des_list_it); des_iterator_next(&des_list_it)) {
212                                 uint8_t * element = des_iterator_get_element(&des_list_it);
213                                 if (de_get_element_type(element) != DE_UUID) continue;
214                                 uint32_t uuid = de_get_uuid32(element);
215                                 switch (uuid){
216                                     case BLUETOOTH_SERVICE_CLASS_PANU:
217                                     case BLUETOOTH_SERVICE_CLASS_NAP:
218                                     case BLUETOOTH_SERVICE_CLASS_GN:
219                                         printf("SDP Attribute 0x%04x: BNEP PAN protocol UUID: %04x\n", sdp_event_query_attribute_byte_get_attribute_id(packet), uuid);
220                                         sdp_bnep_remote_uuid = uuid;
221                                         break;
222                                     default:
223                                         break;
224                                 }
225                             }
226                             break;
227                         case 0x0100:
228                         case 0x0101:
229                             get_string_from_data_element(attribute_value, sizeof(str), str);
230                             printf("SDP Attribute: 0x%04x: %s\n", sdp_event_query_attribute_byte_get_attribute_id(packet), str);
231                             break;
232                         case BLUETOOTH_ATTRIBUTE_PROTOCOL_DESCRIPTOR_LIST: {
233                                 printf("SDP Attribute: 0x%04x\n", sdp_event_query_attribute_byte_get_attribute_id(packet));
234 
235                                 for (des_iterator_init(&des_list_it, attribute_value); des_iterator_has_more(&des_list_it); des_iterator_next(&des_list_it)) {
236                                     uint8_t       *des_element;
237                                     uint8_t       *element;
238                                     uint32_t       uuid;
239 
240                                     if (des_iterator_get_type(&des_list_it) != DE_DES) continue;
241 
242                                     des_element = des_iterator_get_element(&des_list_it);
243                                     des_iterator_init(&prot_it, des_element);
244                                     element = des_iterator_get_element(&prot_it);
245 
246                                     if (!element) continue;
247                                     if (de_get_element_type(element) != DE_UUID) continue;
248 
249                                     uuid = de_get_uuid32(element);
250                                     des_iterator_next(&prot_it);
251                                     switch (uuid){
252                                         case BLUETOOTH_PROTOCOL_L2CAP:
253                                             if (!des_iterator_has_more(&prot_it)) continue;
254                                             de_element_get_uint16(des_iterator_get_element(&prot_it), &sdp_bnep_l2cap_psm);
255                                             break;
256                                         case BLUETOOTH_PROTOCOL_BNEP:
257                                             if (!des_iterator_has_more(&prot_it)) continue;
258                                             de_element_get_uint16(des_iterator_get_element(&prot_it), &sdp_bnep_version);
259                                             break;
260                                         default:
261                                             break;
262                                     }
263                                 }
264                                 printf("Summary: uuid 0x%04x, l2cap_psm 0x%04x, bnep_version 0x%04x\n", sdp_bnep_remote_uuid, sdp_bnep_l2cap_psm, sdp_bnep_version);
265 
266                             }
267                             break;
268                         default:
269                             break;
270                     }
271                 }
272             } else {
273                 fprintf(stderr, "SDP attribute value buffer size exceeded: available %d, required %d\n", attribute_value_buffer_size, sdp_event_query_attribute_byte_get_attribute_length(packet));
274             }
275             break;
276 
277         case SDP_EVENT_QUERY_COMPLETE:
278             handle_sdp_client_record_complete();
279             fprintf(stderr, "General query done with status %d, bnep psm %04x.\n", sdp_event_query_complete_get_status(packet), bnep_l2cap_psm);
280             if (bnep_l2cap_psm){
281                 /* Create BNEP connection */
282                 bnep_connect(packet_handler, remote_addr, bnep_l2cap_psm, BLUETOOTH_SERVICE_CLASS_PANU, bnep_remote_uuid);
283             } else {
284                 fprintf(stderr, "No BNEP service found\n");
285             }
286 
287             break;
288     }
289 }
290 #endif
291 
292 /*
293  * @section Packet Handler
294  *
295  * @text The packet handler responds to various HCI Events.
296  */
297 
298 /* LISTING_START(packetHandler): Packet Handler */
299 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size)
300 {
301 /* LISTING_PAUSE */
302     UNUSED(channel);
303 
304     uint8_t   event;
305     bd_addr_t event_addr;
306     bd_addr_t local_addr;
307     uint16_t  uuid_source;
308     uint16_t  uuid_dest;
309     uint16_t  mtu;
310 
311     /* LISTING_RESUME */
312     switch (packet_type) {
313 		case HCI_EVENT_PACKET:
314             event = hci_event_packet_get_type(packet);
315             switch (event) {
316 #ifdef ENABLE_PANU_CLIENT
317                 /* @text When BTSTACK_EVENT_STATE with state HCI_STATE_WORKING
318                  * is received and the example is started in client mode, the remote SDP BNEP query is started.
319                  */
320                 case BTSTACK_EVENT_STATE:
321                     if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){
322                         printf("Start SDP BNEP query for remote PAN Network Access Point (NAP).\n");
323                         sdp_client_query_uuid16(&handle_sdp_client_query_result, remote_addr, BLUETOOTH_SERVICE_CLASS_NAP);
324                     }
325                     break;
326 #endif
327                 /* LISTING_PAUSE */
328                 case HCI_EVENT_PIN_CODE_REQUEST:
329 					// inform about pin code request
330                     printf("Pin code request - using '0000'\n");
331                     hci_event_pin_code_request_get_bd_addr(packet, event_addr);
332                     gap_pin_code_response(event_addr, "0000");
333 					break;
334 
335                 case HCI_EVENT_USER_CONFIRMATION_REQUEST:
336                     // inform about user confirmation request
337                     printf("SSP User Confirmation Request with numeric value '%06u'\n", little_endian_read_32(packet, 8));
338                     printf("SSP User Confirmation Auto accept\n");
339                     break;
340 
341                 /* LISTING_RESUME */
342 
343                 /* @text BNEP_EVENT_CHANNEL_OPENED is received after a BNEP connection was established or
344                  * or when the connection fails. The status field returns the error code.
345                  *
346                  * The TAP network interface is then configured. A data source is set up and registered with the
347                  * run loop to receive Ethernet packets from the TAP interface.
348                  *
349                  * The event contains both the source and destination UUIDs, as well as the MTU for this connection and
350                  * the BNEP Channel ID, which is used for sending Ethernet packets over BNEP.
351                  */
352 				case BNEP_EVENT_CHANNEL_OPENED:
353                     if (bnep_event_channel_opened_get_status(packet)) {
354                         printf("BNEP channel open failed, status %02x\n", bnep_event_channel_opened_get_status(packet));
355                     } else {
356                         bnep_cid    = bnep_event_channel_opened_get_bnep_cid(packet);
357                         uuid_source = bnep_event_channel_opened_get_source_uuid(packet);
358                         uuid_dest   = bnep_event_channel_opened_get_destination_uuid(packet);
359                         mtu         = bnep_event_channel_opened_get_mtu(packet);
360                         bnep_event_channel_opened_get_remote_address(packet, event_addr);
361                         printf("BNEP connection open succeeded to %s source UUID 0x%04x dest UUID: 0x%04x, max frame size %u\n", bd_addr_to_str(event_addr), uuid_source, uuid_dest, mtu);
362 
363                         /* Setup network interface */
364                         gap_local_bd_addr(local_addr);
365                         btstack_network_up(local_addr);
366                         printf("Network Interface %s activated\n", btstack_network_get_name());
367                     }
368 					break;
369 
370                 /* @text If there is a timeout during the connection setup, BNEP_EVENT_CHANNEL_TIMEOUT will be received
371                  * and the BNEP connection  will be closed
372                  */
373                 case BNEP_EVENT_CHANNEL_TIMEOUT:
374                     printf("BNEP channel timeout! Channel will be closed\n");
375                     break;
376 
377                 /* @text BNEP_EVENT_CHANNEL_CLOSED is received when the connection gets closed.
378                  */
379                 case BNEP_EVENT_CHANNEL_CLOSED:
380                     printf("BNEP channel closed\n");
381                     btstack_network_down();
382                     break;
383 
384                 /* @text BNEP_EVENT_CAN_SEND_NOW indicates that a new packet can be send. This triggers the send of a
385                  * stored network packet. The tap datas source can be enabled again
386                  */
387                 case BNEP_EVENT_CAN_SEND_NOW:
388                     if (network_buffer_len > 0) {
389                         bnep_send(bnep_cid, (uint8_t*) network_buffer, network_buffer_len);
390                         network_buffer_len = 0;
391                         btstack_network_packet_sent();
392                     }
393                     break;
394 
395                 default:
396                     break;
397             }
398             break;
399 
400         /* @text Ethernet packets from the remote device are received in the packet handler with type BNEP_DATA_PACKET.
401          * It is forwarded to the TAP interface.
402          */
403         case BNEP_DATA_PACKET:
404             // Write out the ethernet frame to the network interface
405             btstack_network_process_packet(packet, size);
406             break;
407 
408         default:
409             break;
410     }
411 }
412 /* LISTING_END */
413 
414 /*
415  * @section Network packet handler
416  *
417  * @text A pointer to the network packet is stored and a BNEP_EVENT_CAN_SEND_NOW requested
418  */
419 
420 /* LISTING_START(networkPacketHandler): Network Packet Handler */
421 static void network_send_packet_callback(const uint8_t * packet, uint16_t size){
422     network_buffer = packet;
423     network_buffer_len = size;
424     bnep_request_can_send_now_event(bnep_cid);
425 }
426 /* LISTING_END */
427 
428 int btstack_main(int argc, const char * argv[]);
429 int btstack_main(int argc, const char * argv[]){
430 
431     (void)argc;
432     (void)argv;
433 
434     panu_setup();
435 
436     // parse human readable Bluetooth address
437     sscanf_bd_addr(remote_addr_string, remote_addr);
438 
439     gap_discoverable_control(1);
440     gap_ssp_set_io_capability(SSP_IO_CAPABILITY_DISPLAY_YES_NO);
441 #ifdef ENABLE_PANU_CLIENT
442     gap_set_local_name("PANU Client 00:00:00:00:00:00");
443 #else
444     gap_set_local_name("NAP Server 00:00:00:00:00:00");
445 #endif
446     gap_set_class_of_device(0x020300); // Service Class "Networking", Major Device Class "LAN / NAT"
447 
448     // Turn on the device
449     hci_power_control(HCI_POWER_ON);
450     return 0;
451 }
452 
453 /* EXAMPLE_END */
454 /* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4; tab-width: 4 -*-  */
455 
456