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