xref: /btstack/example/panu_demo.c (revision 8257e5f9e1a9f15ac2fe1e69adc5d2eeeadf3fff)
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 /*
39  * panu_demo.c
40  * Author: Ole Reinhardt <[email protected]>
41  */
42 
43 /* EXAMPLE_START(panu_demo): PANU Demo
44  *
45  * @text This example implements both a PANU client and a server. In server mode, it
46  * sets up a BNEP server and registers a PANU SDP record and waits for incoming connections.
47  * In client mode, it connects to a remote device, does an SDP Query to identify the PANU
48  * service and initiates a BNEP connection.
49  */
50 
51 #include "btstack_config.h"
52 
53 #include <arpa/inet.h>
54 #include <errno.h>
55 #include <fcntl.h>
56 #include <ifaddrs.h>
57 #include <stdint.h>
58 #include <stdio.h>
59 #include <stdlib.h>
60 #include <string.h>
61 #include <unistd.h>
62 
63 #include <net/if_arp.h>
64 
65 #ifdef __APPLE__
66 #include <net/if.h>
67 #include <net/if_types.h>
68 
69 #include <netinet/if_ether.h>
70 #include <netinet/in.h>
71 #endif
72 
73 #include <sys/ioctl.h>
74 #include <sys/param.h>
75 #include <sys/socket.h>
76 #include <sys/stat.h>
77 #include <sys/types.h>
78 
79 #ifdef __linux
80 #include <linux/if.h>
81 #include <linux/if_tun.h>
82 #endif
83 
84 #include "btstack_memory.h"
85 #include "btstack_event.h"
86 #include "btstack_run_loop.h"
87 #include "classic/sdp_client.h"
88 #include "classic/sdp_util.h"
89 #include "hci.h"
90 #include "hci_cmd.h"
91 #include "hci_dump.h"
92 #include "l2cap.h"
93 #include "pan.h"
94 
95 static int record_id = -1;
96 static uint16_t bnep_l2cap_psm      = 0;
97 static uint32_t bnep_remote_uuid    = 0;
98 static uint16_t bnep_version        = 0;
99 static uint16_t bnep_cid            = 0;
100 
101 static uint8_t   attribute_value[1000];
102 static const unsigned int attribute_value_buffer_size = sizeof(attribute_value);
103 
104 //static bd_addr_t remote = {0x04,0x0C,0xCE,0xE4,0x85,0xD3};
105 // static bd_addr_t remote = {0xE0,0x06,0xE6,0xBB,0x95,0x79}; // Ole Thinkpad
106 static bd_addr_t remote = {0x84,0x38,0x35,0x65,0xD1,0x15};  // MacBook 2013
107 
108 static int  tap_fd = -1;
109 static uint8_t network_buffer[BNEP_MTU_MIN];
110 static size_t  network_buffer_len = 0;
111 
112 #ifdef __APPLE__
113 // tuntaposx provides fixed set of tapX devices
114 static const char * tap_dev = "/dev/tap0";
115 static char tap_dev_name[16] = "tap0";
116 #endif
117 
118 #ifdef __linux
119 // Linux uses single control device to bring up tunX or tapX interface
120 static const char * tap_dev = "/dev/net/tun";
121 static char tap_dev_name[16] = "bnep%d";
122 #endif
123 
124 
125 static btstack_data_source_t tap_dev_ds;
126 static btstack_packet_callback_registration_t hci_event_callback_registration;
127 
128 /* @section Main application configuration
129  *
130  * @text In the application configuration, L2CAP and BNEP are initialized and a BNEP service, for server mode,
131  * is registered, before the Bluetooth stack gets started, as shown in Listing PanuSetup.
132  */
133 
134 /* LISTING_START(PanuSetup): Panu setup */
135 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
136 static void handle_sdp_client_query_result(uint8_t packet_type, uint8_t *packet, uint16_t size);
137 
138 static void panu_setup(void){
139 
140     // register for HCI events
141     hci_event_callback_registration.callback = &packet_handler;
142     hci_add_event_handler(&hci_event_callback_registration);
143 
144     // Initialize L2CAP
145     l2cap_init();
146 
147     // Initialise BNEP
148     bnep_init();
149     bnep_register_packet_handler(packet_handler);
150     // Minimum L2CAP MTU for bnep is 1691 bytes
151     bnep_register_service(SDP_PANU, 1691);
152 }
153 /* LISTING_END */
154 
155 /* @section TUN / TAP interface routines
156  *
157  * @text This example requires a TUN/TAP interface to connect the Bluetooth network interface
158  * with the native system. It has been tested on Linux and OS X, but should work on any
159  * system that provides TUN/TAP with minor modifications.
160  *
161  * On Linux, TUN/TAP is available by default. On OS X, tuntaposx from
162  * http://tuntaposx.sourceforge.net needs to be installed.
163  *
164  * The *tap_alloc* function sets up a virtual network interface with the given Bluetooth Address.
165  * It is rather low-level as it sets up and configures a network interface.
166  */
167 
168 static int tap_alloc(char *dev, bd_addr_t bd_addr)
169 {
170     struct ifreq ifr;
171     int fd_dev;
172     int fd_socket;
173 
174     if( (fd_dev = open(tap_dev, O_RDWR)) < 0 ) {
175         fprintf(stderr, "TAP: Error opening %s: %s\n", tap_dev, strerror(errno));
176         return -1;
177     }
178 
179 #ifdef __linux
180     memset(&ifr, 0, sizeof(ifr));
181 
182     ifr.ifr_flags = IFF_TAP | IFF_NO_PI;
183     if( *dev ) {
184         strncpy(ifr.ifr_name, dev, IFNAMSIZ);
185     }
186 
187     int err;
188     if( (err = ioctl(fd_dev, TUNSETIFF, (void *) &ifr)) < 0 ) {
189         fprintf(stderr, "TAP: Error setting device name: %s\n", strerror(errno));
190         close(fd_dev);
191         return -1;
192     }
193     strcpy(dev, ifr.ifr_name);
194 #endif
195 #ifdef __APPLE__
196     dev = tap_dev_name;
197 #endif
198 
199     fd_socket = socket(PF_INET, SOCK_DGRAM, IPPROTO_IP);
200 	if (fd_socket < 0) {
201         close(fd_dev);
202 		fprintf(stderr, "TAP: Error opening netlink socket: %s\n", strerror(errno));
203 		return -1;
204 	}
205 
206     // Configure the MAC address of the newly created bnep(x)
207     // device to the local bd_address
208     memset (&ifr, 0, sizeof(struct ifreq));
209     strcpy(ifr.ifr_name, dev);
210 #ifdef __linux
211     ifr.ifr_hwaddr.sa_family = ARPHRD_ETHER;
212     memcpy(ifr.ifr_hwaddr.sa_data, bd_addr, sizeof(bd_addr_t));
213 	if (ioctl(fd_socket, SIOCSIFHWADDR, &ifr) == -1) {
214         close(fd_dev);
215         close(fd_socket);
216         fprintf(stderr, "TAP: Error setting hw addr: %s\n", strerror(errno));
217         exit(1);
218 		return -1;
219 	}
220 #endif
221 #ifdef __APPLE__
222     ifr.ifr_addr.sa_len = ETHER_ADDR_LEN;
223     ifr.ifr_addr.sa_family = AF_LINK;
224     (void)memcpy(ifr.ifr_addr.sa_data, bd_addr, ETHER_ADDR_LEN);
225     if (ioctl(fd_socket, SIOCSIFLLADDR, &ifr) == -1) {
226         close(fd_dev);
227         close(fd_socket);
228         fprintf(stderr, "TAP: Error setting hw addr: %s\n", strerror(errno));
229         exit(1);
230         return -1;
231 }
232 #endif
233 
234     // Bring the interface up
235 	if (ioctl(fd_socket, SIOCGIFFLAGS, &ifr) == -1) {
236         close(fd_dev);
237         close(fd_socket);
238 		fprintf(stderr, "TAP: Error reading interface flags: %s\n", strerror(errno));
239 		return -1;
240 	}
241 
242 	if ((ifr.ifr_flags & IFF_UP) == 0) {
243 		ifr.ifr_flags |= IFF_UP;
244 
245 		if (ioctl(fd_socket, SIOCSIFFLAGS, &ifr) == -1) {
246             close(fd_dev);
247             close(fd_socket);
248             fprintf(stderr, "TAP: Error set IFF_UP: %s\n", strerror(errno));
249             return -1;
250 		}
251 	}
252 
253 	close(fd_socket);
254 
255     return fd_dev;
256 }
257 
258 /*
259  * @text Listing processTapData shows how a packet is received from the TAP network interface
260  * and forwarded over the BNEP connection.
261  *
262  * After successfully reading a network packet, the call to
263  * the *bnep_can_send_packet_now* function checks, if BTstack can forward
264  * a network packet now. If that's not possible, the received data stays
265  * in the network buffer and the data source elements is removed from the
266  * run loop. The *process_tap_dev_data* function will not be called until
267  * the data source is registered again. This provides a basic flow control.
268  */
269 
270 /* LISTING_START(processTapData): Process incoming network packets */
271 static int process_tap_dev_data(struct btstack_data_source *ds)
272 {
273     ssize_t len;
274     len = read(ds->fd, network_buffer, sizeof(network_buffer));
275     if (len <= 0){
276         fprintf(stderr, "TAP: Error while reading: %s\n", strerror(errno));
277         return 0;
278     }
279 
280     network_buffer_len = len;
281     if (bnep_can_send_packet_now(bnep_cid)) {
282         bnep_send(bnep_cid, network_buffer, network_buffer_len);
283         network_buffer_len = 0;
284     } else {
285         // park the current network packet
286         btstack_run_loop_remove_data_source(&tap_dev_ds);
287     }
288     return 0;
289 }
290 /* LISTING_END */
291 
292 // PANU client routines
293 static char * get_string_from_data_element(uint8_t * element){
294     de_size_t de_size = de_get_size_type(element);
295     int pos     = de_get_header_size(element);
296     int len = 0;
297     switch (de_size){
298         case DE_SIZE_VAR_8:
299             len = element[1];
300             break;
301         case DE_SIZE_VAR_16:
302             len = big_endian_read_16(element, 1);
303             break;
304         default:
305             break;
306     }
307     char * str = (char*)malloc(len+1);
308     memcpy(str, &element[pos], len);
309     str[len] ='\0';
310     return str;
311 }
312 
313 
314 /* @section SDP parser callback
315  *
316  * @text The SDP parsers retrieves the BNEP PAN UUID as explained in
317  * Section [on SDP BNEP Query example](#sec:sdpbnepqueryExample}.
318  */
319 static void handle_sdp_client_query_result(uint8_t packet_type, uint8_t *packet, uint16_t size) {
320 
321     des_iterator_t des_list_it;
322     des_iterator_t prot_it;
323     char *str;
324 
325     switch (hci_event_packet_get_type(packet)){
326         case SDP_EVENT_QUERY_ATTRIBUTE_VALUE:
327             // Handle new SDP record
328             if (sdp_event_query_attribute_byte_get_record_id(packet) != record_id) {
329                 record_id = sdp_event_query_attribute_byte_get_record_id(packet);
330                 printf("SDP Record: Nr: %d\n", record_id);
331             }
332 
333             if (sdp_event_query_attribute_byte_get_attribute_length(packet) <= attribute_value_buffer_size) {
334                 attribute_value[sdp_event_query_attribute_byte_get_data_offset(packet)] = sdp_event_query_attribute_byte_get_data(packet);
335 
336                 if ((uint16_t)(sdp_event_query_attribute_byte_get_data_offset(packet)+1) == sdp_event_query_attribute_byte_get_attribute_length(packet)) {
337 
338                     switch(sdp_event_query_attribute_byte_get_attribute_id(packet)) {
339                         case SDP_ServiceClassIDList:
340                             if (de_get_element_type(attribute_value) != DE_DES) break;
341                             for (des_iterator_init(&des_list_it, attribute_value); des_iterator_has_more(&des_list_it); des_iterator_next(&des_list_it)) {
342                                 uint8_t * element = des_iterator_get_element(&des_list_it);
343                                 if (de_get_element_type(element) != DE_UUID) continue;
344                                 uint32_t uuid = de_get_uuid32(element);
345                                 switch (uuid){
346                                     case SDP_PANU:
347                                     case SDP_NAP:
348                                     case SDP_GN:
349                                         printf("SDP Attribute 0x%04x: BNEP PAN protocol UUID: %04x\n", sdp_event_query_attribute_byte_get_attribute_id(packet), uuid);
350                                         bnep_remote_uuid = uuid;
351                                         break;
352                                     default:
353                                         break;
354                                 }
355                             }
356                             break;
357                         case 0x0100:
358                         case 0x0101:
359                             str = get_string_from_data_element(attribute_value);
360                             printf("SDP Attribute: 0x%04x: %s\n", sdp_event_query_attribute_byte_get_attribute_id(packet), str);
361                             free(str);
362                             break;
363                         case 0x0004: {
364                                 printf("SDP Attribute: 0x%04x\n", sdp_event_query_attribute_byte_get_attribute_id(packet));
365 
366                                 for (des_iterator_init(&des_list_it, attribute_value); des_iterator_has_more(&des_list_it); des_iterator_next(&des_list_it)) {
367                                     uint8_t       *des_element;
368                                     uint8_t       *element;
369                                     uint32_t       uuid;
370 
371                                     if (des_iterator_get_type(&des_list_it) != DE_DES) continue;
372 
373                                     des_element = des_iterator_get_element(&des_list_it);
374                                     des_iterator_init(&prot_it, des_element);
375                                     element = des_iterator_get_element(&prot_it);
376 
377                                     if (de_get_element_type(element) != DE_UUID) continue;
378 
379                                     uuid = de_get_uuid32(element);
380                                     switch (uuid){
381                                         case SDP_L2CAPProtocol:
382                                             if (!des_iterator_has_more(&prot_it)) continue;
383                                             des_iterator_next(&prot_it);
384                                             de_element_get_uint16(des_iterator_get_element(&prot_it), &bnep_l2cap_psm);
385                                             break;
386                                         case SDP_BNEPProtocol:
387                                             if (!des_iterator_has_more(&prot_it)) continue;
388                                             des_iterator_next(&prot_it);
389                                             de_element_get_uint16(des_iterator_get_element(&prot_it), &bnep_version);
390                                             break;
391                                         default:
392                                             break;
393                                     }
394                                 }
395                                 printf("l2cap_psm 0x%04x, bnep_version 0x%04x\n", bnep_l2cap_psm, bnep_version);
396 
397                                 /* Create BNEP connection */
398                                 bnep_connect(remote, bnep_l2cap_psm, PANU_UUID, bnep_remote_uuid);
399                             }
400                             break;
401                         default:
402                             break;
403                     }
404                 }
405             } else {
406                 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));
407             }
408             break;
409 
410         case SDP_EVENT_QUERY_COMPLETE:
411             fprintf(stderr, "General query done with status %d.\n", sdp_event_query_complete_get_status(packet));
412 
413             break;
414     }
415 }
416 
417 /*
418  * @section Packet Handler
419  *
420  * @text The packet handler responds to various HCI Events.
421  */
422 
423 
424 /* LISTING_START(packetHandler): Packet Handler */
425 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size)
426 {
427 /* LISTING_PAUSE */
428     int       rc;
429     uint8_t   event;
430     bd_addr_t event_addr;
431     bd_addr_t local_addr;
432     uint16_t  uuid_source;
433     uint16_t  uuid_dest;
434     uint16_t  mtu;
435 
436     /* LISTING_RESUME */
437     switch (packet_type) {
438 		case HCI_EVENT_PACKET:
439             event = hci_event_packet_get_type(packet);
440             switch (event) {
441                 /* @text When BTSTACK_EVENT_STATE with state HCI_STATE_WORKING
442                  * is received and the example is started in client mode, the remote SDP BNEP query is started.
443                  */
444                 case BTSTACK_EVENT_STATE:
445                     if (packet[2] == HCI_STATE_WORKING) {
446                         printf("Start SDP BNEP query.\n");
447                         sdp_client_query_uuid16(remote, SDP_BNEPProtocol);
448                     }
449                     break;
450 
451                 /* LISTING_PAUSE */
452                 case HCI_EVENT_PIN_CODE_REQUEST:
453 					// inform about pin code request
454                     printf("Pin code request - using '0000'\n");
455                     reverse_bd_addr(&packet[2], event_addr);
456 					hci_send_cmd(&hci_pin_code_request_reply, &event_addr, 4, "0000");
457 					break;
458 
459                 case HCI_EVENT_USER_CONFIRMATION_REQUEST:
460                     // inform about user confirmation request
461                     printf("SSP User Confirmation Request with numeric value '%06u'\n", little_endian_read_32(packet, 8));
462                     printf("SSP User Confirmation Auto accept\n");
463                     break;
464 
465                 /* LISTING_RESUME */
466 
467                 /* @text BNEP_EVENT_OPEN_CHANNEL_COMPLETE is received after a BNEP connection was established or
468                  * or when the connection fails. The status field returns the error code.
469                  *
470                  * The TAP network interface is then configured. A data source is set up and registered with the
471                  * run loop to receive Ethernet packets from the TAP interface.
472                  *
473                  * The event contains both the source and destination UUIDs, as well as the MTU for this connection and
474                  * the BNEP Channel ID, which is used for sending Ethernet packets over BNEP.
475                  */
476 				case BNEP_EVENT_OPEN_CHANNEL_COMPLETE:
477                     if (packet[2]) {
478                         printf("BNEP channel open failed, status %02x\n", packet[2]);
479                     } else {
480                         // data: event(8), len(8), status (8), bnep source uuid (16), bnep destination uuid (16), remote_address (48)
481                         uuid_source = little_endian_read_16(packet, 3);
482                         uuid_dest   = little_endian_read_16(packet, 5);
483                         mtu         = little_endian_read_16(packet, 7);
484                         bnep_cid    = channel;
485                         //bt_flip_addr(event_addr, &packet[9]);
486                         memcpy(&event_addr, &packet[9], sizeof(bd_addr_t));
487                         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);
488                         /* Create the tap interface */
489                         gap_local_bd_addr(local_addr);
490                         tap_fd = tap_alloc(tap_dev_name, local_addr);
491                         if (tap_fd < 0) {
492                             printf("Creating BNEP tap device failed: %s\n", strerror(errno));
493                         } else {
494                             printf("BNEP device \"%s\" allocated.\n", tap_dev_name);
495                             /* Create and register a new runloop data source */
496                             tap_dev_ds.fd = tap_fd;
497                             tap_dev_ds.process = process_tap_dev_data;
498                             btstack_run_loop_add_data_source(&tap_dev_ds);
499                         }
500                     }
501 					break;
502 
503                 /* @text If there is a timeout during the connection setup, BNEP_EVENT_CHANNEL_TIMEOUT will be received
504                  * and the BNEP connection  will be closed
505                  */
506                 case BNEP_EVENT_CHANNEL_TIMEOUT:
507                     printf("BNEP channel timeout! Channel will be closed\n");
508                     break;
509 
510                 /* @text BNEP_EVENT_CHANNEL_CLOSED is received when the connection gets closed.
511                  */
512                 case BNEP_EVENT_CHANNEL_CLOSED:
513                     printf("BNEP channel closed\n");
514                     btstack_run_loop_remove_data_source(&tap_dev_ds);
515                     if (tap_fd > 0) {
516                         close(tap_fd);
517                         tap_fd = -1;
518                     }
519                     break;
520 
521                 /* @text BNEP_EVENT_READY_TO_SEND indicates that a new packet can be send. This triggers the retry of a
522                  * parked network packet. If this succeeds, the data source element is added to the run loop again.
523                  */
524                 case BNEP_EVENT_READY_TO_SEND:
525                     // Check for parked network packets and send it out now
526                     if (network_buffer_len > 0) {
527                         bnep_send(bnep_cid, network_buffer, network_buffer_len);
528                         network_buffer_len = 0;
529                         // Re-add the tap device data source
530                         btstack_run_loop_add_data_source(&tap_dev_ds);
531                     }
532 
533                     break;
534 
535                 default:
536                     break;
537             }
538             break;
539 
540         /* @text Ethernet packets from the remote device are received in the packet handler with type BNEP_DATA_PACKET.
541          * It is forwarded to the TAP interface.
542          */
543         case BNEP_DATA_PACKET:
544             // Write out the ethernet frame to the tap device
545             if (tap_fd > 0) {
546                 rc = write(tap_fd, packet, size);
547                 if (rc < 0) {
548                     fprintf(stderr, "TAP: Could not write to TAP device: %s\n", strerror(errno));
549                 } else
550                 if (rc != size) {
551                     fprintf(stderr, "TAP: Package written only partially %d of %d bytes\n", rc, size);
552                 }
553             }
554             break;
555 
556         default:
557             break;
558     }
559 }
560 /* LISTING_END */
561 
562 
563 int btstack_main(int argc, const char * argv[]);
564 int btstack_main(int argc, const char * argv[]){
565 
566     printf("Client HCI init done\n");
567 
568     panu_setup();
569     // Turn on the device
570     hci_power_control(HCI_POWER_ON);
571     return 0;
572 }
573 
574 /* EXAMPLE_END */
575 /* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4; tab-width: 4 -*-  */
576 
577