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