xref: /btstack/src/hci.c (revision 7ec5eeaa74e5874c26df0156c1837cf8181fce4e)
1 /*
2  * Copyright (C) 2009 by Matthias Ringwald
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  *
17  * THIS SOFTWARE IS PROVIDED BY MATTHIAS RINGWALD AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
21  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
24  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
27  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  */
31 
32 /*
33  *  hci.c
34  *
35  *  Created by Matthias Ringwald on 4/29/09.
36  *
37  */
38 
39 #include "hci.h"
40 
41 #include <unistd.h>
42 #include <stdarg.h>
43 #include <string.h>
44 #include <stdio.h>
45 
46 #include "debug.h"
47 #include "hci_dump.h"
48 
49 #include "../include/btstack/hci_cmds.h"
50 #include "../include/btstack/version.h"
51 
52 // temp
53 #include "l2cap.h"
54 
55 #define HCI_CONNECTION_TIMEOUT_MS 10000
56 
57 // the STACK is here
58 static hci_stack_t       hci_stack;
59 
60 /**
61  * get connection for a given handle
62  *
63  * @return connection OR NULL, if not found
64  */
65 hci_connection_t * connection_for_handle(hci_con_handle_t con_handle){
66     linked_item_t *it;
67     for (it = (linked_item_t *) hci_stack.connections; it ; it = it->next){
68         if ( ((hci_connection_t *) it)->con_handle == con_handle){
69             return (hci_connection_t *) it;
70         }
71     }
72     return NULL;
73 }
74 
75 static void hci_connection_timeout_handler(timer_source_t *timer){
76     hci_connection_t * connection = linked_item_get_user(&timer->item);
77     struct timeval tv;
78     gettimeofday(&tv, NULL);
79     if (tv.tv_sec >= connection->timestamp.tv_sec + HCI_CONNECTION_TIMEOUT_MS/1000) {
80         // connections might be timed out
81         hci_emit_l2cap_check_timeout(connection);
82         run_loop_set_timer(timer, HCI_CONNECTION_TIMEOUT_MS);
83     } else {
84         // next timeout check at
85         timer->timeout.tv_sec = connection->timestamp.tv_sec + HCI_CONNECTION_TIMEOUT_MS/1000;
86     }
87     run_loop_add_timer(timer);
88 }
89 
90 static void hci_connection_timestamp(hci_connection_t *connection){
91     gettimeofday(&connection->timestamp, NULL);
92 }
93 
94 /**
95  * create connection for given address
96  *
97  * @return connection OR NULL, if not found
98  */
99 static hci_connection_t * create_connection_for_addr(bd_addr_t addr){
100     hci_connection_t * conn = malloc( sizeof(hci_connection_t) );
101     if (!conn) return NULL;
102     BD_ADDR_COPY(conn->address, addr);
103     conn->con_handle = 0xffff;
104     conn->authentication_flags = 0;
105     linked_item_set_user(&conn->timeout.item, conn);
106     conn->timeout.process = hci_connection_timeout_handler;
107     hci_connection_timestamp(conn);
108     conn->acl_recombination_length = 0;
109     conn->acl_recombination_pos = 0;
110     conn->num_acl_packets_sent = 0;
111     linked_list_add(&hci_stack.connections, (linked_item_t *) conn);
112     return conn;
113 }
114 
115 /**
116  * get connection for given address
117  *
118  * @return connection OR NULL, if not found
119  */
120 static hci_connection_t * connection_for_address(bd_addr_t address){
121     linked_item_t *it;
122     for (it = (linked_item_t *) hci_stack.connections; it ; it = it->next){
123         if ( ! BD_ADDR_CMP( ((hci_connection_t *) it)->address, address) ){
124             return (hci_connection_t *) it;
125         }
126     }
127     return NULL;
128 }
129 
130 /**
131  * add authentication flags and reset timer
132  */
133 static void hci_add_connection_flags_for_flipped_bd_addr(uint8_t *bd_addr, hci_authentication_flags_t flags){
134     bd_addr_t addr;
135     bt_flip_addr(addr, *(bd_addr_t *) bd_addr);
136     hci_connection_t * conn = connection_for_address(addr);
137     if (conn) {
138         conn->authentication_flags |= flags;
139         hci_connection_timestamp(conn);
140     }
141 }
142 
143 int  hci_authentication_active_for_handle(hci_con_handle_t handle){
144     hci_connection_t * conn = connection_for_handle(handle);
145     if (!conn) return 0;
146     if (!conn->authentication_flags) return 0;
147     if (conn->authentication_flags & SENT_LINK_KEY_REPLY) return 0;
148     if (conn->authentication_flags & RECV_LINK_KEY_NOTIFICATION) return 0;
149     return 1;
150 }
151 
152 void hci_drop_link_key_for_bd_addr(bd_addr_t *addr){
153     if (hci_stack.remote_device_db) {
154         hci_stack.remote_device_db->delete_link_key(addr);
155     }
156 }
157 
158 
159 /**
160  * count connections
161  */
162 static int nr_hci_connections(){
163     int count = 0;
164     linked_item_t *it;
165     for (it = (linked_item_t *) hci_stack.connections; it ; it = it->next, count++);
166     return count;
167 }
168 
169 /**
170  * Dummy handler called by HCI
171  */
172 static void dummy_handler(uint8_t packet_type, uint8_t *packet, uint16_t size){
173 }
174 
175 uint8_t hci_number_outgoing_packets(hci_con_handle_t handle){
176     hci_connection_t * connection = connection_for_handle(handle);
177     if (!connection) {
178         log_err("hci_number_outgoing_packets connectino for handle %u does not exist!\n", handle);
179         return 0;
180     }
181     return connection->num_acl_packets_sent;
182 }
183 
184 uint8_t hci_number_free_acl_slots(){
185     uint8_t free_slots = hci_stack.total_num_acl_packets;
186     linked_item_t *it;
187     for (it = (linked_item_t *) hci_stack.connections; it ; it = it->next){
188         hci_connection_t * connection = (hci_connection_t *) it;
189         if (free_slots < connection->num_acl_packets_sent) {
190             log_err("hci_number_free_acl_slots: sum of outgoing packets > total acl packets!\n");
191             return 0;
192         }
193         free_slots -= connection->num_acl_packets_sent;
194     }
195     return free_slots;
196 }
197 
198 uint16_t hci_max_acl_data_packet_length(){
199     return hci_stack.acl_data_packet_length;
200 }
201 
202 int hci_ready_to_send(hci_con_handle_t handle){
203     return hci_number_free_acl_slots() && hci_number_outgoing_packets(handle) < 2;
204 }
205 
206 int hci_send_acl_packet(uint8_t *packet, int size){
207 
208     // check for free places on BT module
209     if (!hci_number_free_acl_slots()) return -1;
210 
211     hci_con_handle_t con_handle = READ_ACL_CONNECTION_HANDLE(packet);
212     hci_connection_t *connection = connection_for_handle( con_handle);
213     if (!connection) return 0;
214     hci_connection_timestamp(connection);
215 
216     // count packet
217     connection->num_acl_packets_sent++;
218     // log_dbg("hci_send_acl_packet - handle %u, sent %u\n", connection->con_handle, connection->num_acl_packets_sent);
219 
220     // send packet - ignore errors
221     hci_stack.hci_transport->send_packet(HCI_ACL_DATA_PACKET, packet, size);
222 
223     return 0;
224 }
225 
226 static void acl_handler(uint8_t *packet, int size){
227 
228     // get info
229     hci_con_handle_t con_handle = READ_ACL_CONNECTION_HANDLE(packet);
230     hci_connection_t *conn      = connection_for_handle(con_handle);
231     uint8_t  acl_flags          = READ_ACL_FLAGS(packet);
232     uint16_t acl_length         = READ_ACL_LENGTH(packet);
233 
234     // ignore non-registered handle
235     if (!conn){
236         log_err( "hci.c: acl_handler called with non-registered handle %u!\n" , con_handle);
237         return;
238     }
239 
240     // update idle timestamp
241     hci_connection_timestamp(conn);
242 
243     // handle different packet types
244     switch (acl_flags & 0x03) {
245 
246         case 0x01: // continuation fragment
247 
248             // sanity check
249             if (conn->acl_recombination_pos == 0) {
250                 log_err( "ACL Cont Fragment but no first fragment for handle 0x%02x\n", con_handle);
251                 return;
252             }
253 
254             // append fragment payload (header already stored)
255             memcpy(&conn->acl_recombination_buffer[conn->acl_recombination_pos], &packet[4], acl_length );
256             conn->acl_recombination_pos += acl_length;
257 
258             // log_err( "ACL Cont Fragment: acl_len %u, combined_len %u, l2cap_len %u\n",
259             //        acl_length, connection->acl_recombination_pos, connection->acl_recombination_length);
260 
261             // forward complete L2CAP packet if complete.
262             if (conn->acl_recombination_pos >= conn->acl_recombination_length + 4 + 4){ // pos already incl. ACL header
263 
264                 hci_stack.packet_handler(HCI_ACL_DATA_PACKET, conn->acl_recombination_buffer, conn->acl_recombination_pos);
265                 // reset recombination buffer
266                 conn->acl_recombination_length = 0;
267                 conn->acl_recombination_pos = 0;
268             }
269             break;
270 
271         case 0x02: { // first fragment
272 
273             // sanity check
274             if (conn->acl_recombination_pos) {
275                 log_err( "ACL First Fragment but data in buffer for handle 0x%02x\n", con_handle);
276                 return;
277             }
278 
279             // peek into L2CAP packet!
280             uint16_t l2cap_length = READ_L2CAP_LENGTH( packet );
281 
282             // compare fragment size to L2CAP packet size
283             if (acl_length >= l2cap_length + 4){
284 
285                 // forward fragment as L2CAP packet
286                 hci_stack.packet_handler(HCI_ACL_DATA_PACKET, packet, acl_length + 4);
287 
288             } else {
289                 // store first fragment and tweak acl length for complete package
290                 memcpy(conn->acl_recombination_buffer, packet, acl_length + 4);
291                 conn->acl_recombination_pos    = acl_length + 4;
292                 conn->acl_recombination_length = l2cap_length;
293                 bt_store_16(conn->acl_recombination_buffer, 2, acl_length +4);
294                 // log_err( "ACL First Fragment: acl_len %u, l2cap_len %u\n", acl_length, l2cap_length);
295             }
296             break;
297 
298         }
299         default:
300             log_err( "hci.c: acl_handler called with invalid packet boundary flags %u\n", acl_flags & 0x03);
301             return;
302     }
303 
304     // execute main loop
305     hci_run();
306 }
307 
308 static void hci_shutdown_connection(hci_connection_t *conn){
309     log_dbg("Connection closed: handle %u, ", conn->con_handle);
310     print_bd_addr( conn->address );
311     log_dbg("\n");
312     run_loop_remove_timer(&conn->timeout);
313     linked_list_remove(&hci_stack.connections, (linked_item_t *) conn);
314     free( conn );
315     hci_emit_nr_connections_changed();
316 }
317 
318 // avoid huge local variables
319 static device_name_t device_name;
320 static void event_handler(uint8_t *packet, int size){
321     bd_addr_t addr;
322     hci_con_handle_t handle;
323     hci_connection_t * conn;
324     int i;
325     link_key_t link_key;
326 
327     switch (packet[0]) {
328 
329         case HCI_EVENT_COMMAND_COMPLETE:
330             // get num cmd packets
331             // log_dbg("HCI_EVENT_COMMAND_COMPLETE cmds old %u - new %u\n", hci_stack.num_cmd_packets, packet[2]);
332             hci_stack.num_cmd_packets = packet[2];
333 
334             if (COMMAND_COMPLETE_EVENT(packet, hci_read_buffer_size)){
335                 // from offset 5
336                 // status
337                 hci_stack.acl_data_packet_length = READ_BT_16(packet, 6);
338                 // ignore: SCO data packet len (8)
339                 hci_stack.total_num_acl_packets  = packet[9];
340                 // ignore: total num SCO packets
341                 if (hci_stack.state == HCI_STATE_INITIALIZING){
342                     log_dbg("hci_read_buffer_size: size %u, count %u\n", hci_stack.acl_data_packet_length, hci_stack.total_num_acl_packets);
343                 }
344             }
345             if (COMMAND_COMPLETE_EVENT(packet, hci_write_scan_enable)){
346                 hci_emit_discoverable_enabled(hci_stack.discoverable);
347             }
348             break;
349 
350         case HCI_EVENT_COMMAND_STATUS:
351             // get num cmd packets
352             // log_dbg("HCI_EVENT_COMMAND_STATUS cmds - old %u - new %u\n", hci_stack.num_cmd_packets, packet[3]);
353             hci_stack.num_cmd_packets = packet[3];
354             break;
355 
356         case HCI_EVENT_NUMBER_OF_COMPLETED_PACKETS:
357             for (i=0; i<packet[2];i++){
358                 handle = READ_BT_16(packet, 3 + 2*i);
359                 uint16_t num_packets = READ_BT_16(packet, 3 + packet[2]*2 + 2*i);
360                 conn = connection_for_handle(handle);
361                 if (!conn){
362                     log_err("hci_number_completed_packet lists unused con handle %u\n", handle);
363                     continue;
364                 }
365                 conn->num_acl_packets_sent -= num_packets;
366                 // log_dbg("hci_number_completed_packet %u processed for handle %u, outstanding %u\n", num_packets, handle, conn->num_acl_packets_sent);
367             }
368             break;
369 
370         case HCI_EVENT_CONNECTION_REQUEST:
371             bt_flip_addr(addr, &packet[2]);
372             // TODO: eval COD 8-10
373             uint8_t link_type = packet[11];
374             log_dbg("Connection_incoming: "); print_bd_addr(addr); log_dbg(", type %u\n", link_type);
375             if (link_type == 1) { // ACL
376                 conn = connection_for_address(addr);
377                 if (!conn) {
378                     conn = create_connection_for_addr(addr);
379                 }
380                 // TODO: check for malloc failure
381                 conn->state = ACCEPTED_CONNECTION_REQUEST;
382                 hci_send_cmd(&hci_accept_connection_request, addr, 1);
383             } else {
384                 // TODO: decline request
385             }
386             break;
387 
388         case HCI_EVENT_CONNECTION_COMPLETE:
389             // Connection management
390             bt_flip_addr(addr, &packet[5]);
391             log_dbg("Connection_complete (status=%u)", packet[2]); print_bd_addr(addr); log_dbg("\n");
392             conn = connection_for_address(addr);
393             if (conn) {
394                 if (!packet[2]){
395                     conn->state = OPEN;
396                     conn->con_handle = READ_BT_16(packet, 3);
397 
398                     gettimeofday(&conn->timestamp, NULL);
399                     run_loop_set_timer(&conn->timeout, HCI_CONNECTION_TIMEOUT_MS);
400                     run_loop_add_timer(&conn->timeout);
401 
402                     log_dbg("New connection: handle %u, ", conn->con_handle);
403                     print_bd_addr( conn->address );
404                     log_dbg("\n");
405 
406                     hci_emit_nr_connections_changed();
407                 } else {
408                     // connection failed, remove entry
409                     linked_list_remove(&hci_stack.connections, (linked_item_t *) conn);
410                     free( conn );
411 
412                     // if authentication error, also delete link key
413                     if (packet[2] == 0x05) {
414                         hci_drop_link_key_for_bd_addr(&addr);
415                     }
416                 }
417             }
418             break;
419 
420         case HCI_EVENT_LINK_KEY_REQUEST:
421             hci_add_connection_flags_for_flipped_bd_addr(&packet[2], RECV_LINK_KEY_REQUEST);
422             if (!hci_stack.remote_device_db) break;
423             bt_flip_addr(addr, &packet[2]);
424             if ( hci_stack.remote_device_db->get_link_key( &addr, &link_key)){
425                 hci_send_cmd(&hci_link_key_request_reply, &addr, &link_key);
426             } else {
427                 hci_send_cmd(&hci_link_key_request_negative_reply, &addr);
428             }
429             // request already answered
430             return;
431 
432         case HCI_EVENT_LINK_KEY_NOTIFICATION:
433             hci_add_connection_flags_for_flipped_bd_addr(&packet[2], RECV_LINK_KEY_NOTIFICATION);
434             if (!hci_stack.remote_device_db) break;
435             bt_flip_addr(addr, &packet[2]);
436             hci_stack.remote_device_db->put_link_key(&addr, (link_key_t *) &packet[8]);
437             // still forward event to allow dismiss of pairing dialog
438             break;
439 
440         case HCI_EVENT_PIN_CODE_REQUEST:
441             hci_add_connection_flags_for_flipped_bd_addr(&packet[2], RECV_PIN_CODE_REQUEST);
442             break;
443 
444         case HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE:
445             if (!hci_stack.remote_device_db) break;
446             if (packet[2]) break; // status not ok
447             bt_flip_addr(addr, &packet[3]);
448             bzero(&device_name, sizeof(device_name_t));
449             strncpy((char*) device_name, (char*) &packet[9], 248);
450             hci_stack.remote_device_db->put_name(&addr, &device_name);
451             break;
452 
453         case HCI_EVENT_INQUIRY_RESULT:
454         case HCI_EVENT_INQUIRY_RESULT_WITH_RSSI:
455             if (!hci_stack.remote_device_db) break;
456             // first send inq result packet
457             hci_stack.packet_handler(HCI_EVENT_PACKET, packet, size);
458             // then send cached remote names
459             for (i=0; i<packet[2];i++){
460                 bt_flip_addr(addr, &packet[3+i*6]);
461                 if (hci_stack.remote_device_db->get_name(&addr, &device_name)){
462                     hci_emit_remote_name_cached(&addr, &device_name);
463                 }
464             }
465             return;
466 
467         case HCI_EVENT_DISCONNECTION_COMPLETE:
468             if (!packet[2]){
469                 handle = READ_BT_16(packet, 3);
470                 hci_connection_t * conn = connection_for_handle(handle);
471                 if (conn) {
472                     hci_shutdown_connection(conn);
473                 }
474             }
475             break;
476 
477         default:
478             break;
479     }
480 
481     // handle BT initialization
482     if (hci_stack.state == HCI_STATE_INITIALIZING){
483         // handle H4 synchronization loss on restart
484         // if (hci_stack.substate == 1 && packet[0] == HCI_EVENT_HARDWARE_ERROR){
485         //    hci_stack.substate = 0;
486         // }
487         // handle normal init sequence
488         if (hci_stack.substate % 2){
489             // odd: waiting for event
490             if (packet[0] == HCI_EVENT_COMMAND_COMPLETE){
491                 hci_stack.substate++;
492             }
493         }
494     }
495 
496     // help with BT sleep
497     if (hci_stack.state == HCI_STATE_FALLING_ASLEEP
498         && hci_stack.substate == 1
499         && COMMAND_COMPLETE_EVENT(packet, hci_write_scan_enable)){
500         hci_stack.substate++;
501     }
502 
503     hci_stack.packet_handler(HCI_EVENT_PACKET, packet, size);
504 
505 	// execute main loop
506 	hci_run();
507 }
508 
509 void packet_handler(uint8_t packet_type, uint8_t *packet, uint16_t size){
510     switch (packet_type) {
511         case HCI_EVENT_PACKET:
512             event_handler(packet, size);
513             break;
514         case HCI_ACL_DATA_PACKET:
515             acl_handler(packet, size);
516             break;
517         default:
518             break;
519     }
520 }
521 
522 /** Register HCI packet handlers */
523 void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)){
524     hci_stack.packet_handler = handler;
525 }
526 
527 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t * remote_device_db){
528 
529     // reference to use transport layer implementation
530     hci_stack.hci_transport = transport;
531 
532     // references to used control implementation
533     hci_stack.control = control;
534 
535     // reference to used config
536     hci_stack.config = config;
537 
538     // no connections yet
539     hci_stack.connections = NULL;
540 
541     // empty cmd buffer
542     hci_stack.hci_cmd_buffer = malloc(3+255);
543 
544     // higher level handler
545     hci_stack.packet_handler = dummy_handler;
546 
547     // store and open remote device db
548     hci_stack.remote_device_db = remote_device_db;
549     if (hci_stack.remote_device_db) {
550         hci_stack.remote_device_db->open();
551     }
552 
553     // register packet handlers with transport
554     transport->register_packet_handler(&packet_handler);
555 }
556 
557 void hci_close(){
558     // close remote device db
559     if (hci_stack.remote_device_db) {
560         hci_stack.remote_device_db->close();
561     }
562 }
563 
564 // State-Module-Driver overview
565 // state                    module  low-level
566 // HCI_STATE_OFF             off      close
567 // HCI_STATE_INITIALIZING,   on       open
568 // HCI_STATE_WORKING,        on       open
569 // HCI_STATE_HALTING,        on       open
570 // HCI_STATE_SLEEPING,    off/sleep   close
571 // HCI_STATE_FALLING_ASLEEP  on       open
572 
573 static int hci_power_control_on(){
574 
575     // power on
576     int err = 0;
577     if (hci_stack.control && hci_stack.control->on){
578         err = (*hci_stack.control->on)(hci_stack.config);
579     }
580     if (err){
581         log_err( "POWER_ON failed\n");
582         hci_emit_hci_open_failed();
583         return err;
584     }
585 
586     // open low-level device
587     err = hci_stack.hci_transport->open(hci_stack.config);
588     if (err){
589         log_err( "HCI_INIT failed, turning Bluetooth off again\n");
590         if (hci_stack.control && hci_stack.control->off){
591             (*hci_stack.control->off)(hci_stack.config);
592         }
593         hci_emit_hci_open_failed();
594         return err;
595     }
596     return 0;
597 }
598 
599 static void hci_power_control_off(){
600 
601     // close low-level device
602     hci_stack.hci_transport->close(hci_stack.config);
603 
604     // power off
605     if (hci_stack.control && hci_stack.control->off){
606         (*hci_stack.control->off)(hci_stack.config);
607     }
608     hci_stack.state = HCI_STATE_OFF;
609 }
610 
611 static void hci_power_control_sleep(){
612 
613     log_dbg("hci_power_control_sleep");
614 
615 #if 0
616     // don't close serial port during sleep
617 
618     // close low-level device
619     hci_stack.hci_transport->close(hci_stack.config);
620 #endif
621 
622     // sleep mode
623     if (hci_stack.control && hci_stack.control->sleep){
624         (*hci_stack.control->sleep)(hci_stack.config);
625     }
626 
627     hci_stack.state = HCI_STATE_SLEEPING;
628 }
629 
630 static int hci_power_control_wake(){
631 
632     log_dbg("hci_power_control_wake");
633 
634     // wake on
635     if (hci_stack.control && hci_stack.control->wake){
636         (*hci_stack.control->wake)(hci_stack.config);
637     }
638 
639 #if 0
640     // open low-level device
641     int err = hci_stack.hci_transport->open(hci_stack.config);
642     if (err){
643         log_err( "HCI_INIT failed, turning Bluetooth off again\n");
644         if (hci_stack.control && hci_stack.control->off){
645             (*hci_stack.control->off)(hci_stack.config);
646         }
647         hci_emit_hci_open_failed();
648         return err;
649     }
650 #endif
651 
652     return 0;
653 }
654 
655 
656 int hci_power_control(HCI_POWER_MODE power_mode){
657 
658     log_dbg("hci_power_control: %u, current mode %u\n", power_mode, hci_stack.state);
659 
660     int err = 0;
661     switch (hci_stack.state){
662 
663         case HCI_STATE_OFF:
664             switch (power_mode){
665                 case HCI_POWER_ON:
666                     err = hci_power_control_on();
667                     if (err) return err;
668                     // set up state machine
669                     hci_stack.num_cmd_packets = 1; // assume that one cmd can be sent
670                     hci_stack.state = HCI_STATE_INITIALIZING;
671                     hci_stack.substate = 0;
672                     break;
673                 case HCI_POWER_OFF:
674                     // do nothing
675                     break;
676                 case HCI_POWER_SLEEP:
677                     // do nothing (with SLEEP == OFF)
678                     break;
679             }
680             break;
681 
682         case HCI_STATE_INITIALIZING:
683             switch (power_mode){
684                 case HCI_POWER_ON:
685                     // do nothing
686                     break;
687                 case HCI_POWER_OFF:
688                     // no connections yet, just turn it off
689                     hci_power_control_off();
690                     break;
691                 case HCI_POWER_SLEEP:
692                     // no connections yet, just turn it off
693                     hci_power_control_sleep();
694                     break;
695             }
696             break;
697 
698         case HCI_STATE_WORKING:
699             switch (power_mode){
700                 case HCI_POWER_ON:
701                     // do nothing
702                     break;
703                 case HCI_POWER_OFF:
704                     // see hci_run
705                     hci_stack.state = HCI_STATE_HALTING;
706                     break;
707                 case HCI_POWER_SLEEP:
708                     // see hci_run
709                     hci_stack.state = HCI_STATE_FALLING_ASLEEP;
710                     hci_stack.substate = 0;
711                     break;
712             }
713             break;
714 
715         case HCI_STATE_HALTING:
716             switch (power_mode){
717                 case HCI_POWER_ON:
718                     // set up state machine
719                     hci_stack.state = HCI_STATE_INITIALIZING;
720                     hci_stack.substate = 0;
721                     break;
722                 case HCI_POWER_OFF:
723                     // do nothing
724                     break;
725                 case HCI_POWER_SLEEP:
726                     // see hci_run
727                     hci_stack.state = HCI_STATE_FALLING_ASLEEP;
728                     hci_stack.substate = 0;
729                     break;
730             }
731             break;
732 
733         case HCI_STATE_FALLING_ASLEEP:
734             switch (power_mode){
735                 case HCI_POWER_ON:
736                     // set up state machine
737                     hci_stack.num_cmd_packets = 1; // assume that one cmd can be sent
738                     hci_stack.state = HCI_STATE_INITIALIZING;
739                     hci_stack.substate = 0;
740                     break;
741                 case HCI_POWER_OFF:
742                     // see hci_run
743                     hci_stack.state = HCI_STATE_HALTING;
744                     break;
745                 case HCI_POWER_SLEEP:
746                     // do nothing
747                     break;
748             }
749             break;
750 
751         case HCI_STATE_SLEEPING:
752             switch (power_mode){
753                 case HCI_POWER_ON:
754                     err = hci_power_control_wake();
755                     if (err) return err;
756                     // set up state machine
757                     hci_stack.num_cmd_packets = 1; // assume that one cmd can be sent
758                     hci_stack.state = HCI_STATE_INITIALIZING;
759                     hci_stack.substate = 0;
760                     break;
761                 case HCI_POWER_OFF:
762                     hci_stack.state = HCI_STATE_OFF;
763                     break;
764                 case HCI_POWER_SLEEP:
765                     // do nothing
766                     break;
767             }
768             break;
769     }
770 
771     // create internal event
772 	hci_emit_state();
773 
774 	// trigger next/first action
775 	hci_run();
776 
777     return 0;
778 }
779 
780 void hci_discoverable_control(uint8_t enable){
781     if (enable) enable = 1; // normalize argument
782 
783     if (hci_stack.discoverable == enable){
784         hci_emit_discoverable_enabled(hci_stack.discoverable);
785         return;
786     }
787 
788     hci_send_cmd(&hci_write_scan_enable, 2 | enable); // 1 = inq scan, 2 = page scan
789     hci_stack.discoverable = enable;
790 }
791 
792 void hci_run(){
793 
794     if (hci_stack.num_cmd_packets == 0) {
795         // cannot send command yet
796         return;
797     }
798 
799     hci_connection_t * connection;
800 
801     switch (hci_stack.state){
802         case HCI_STATE_INITIALIZING:
803             if (hci_stack.substate % 2) {
804                 // odd: waiting for command completion
805                 return;
806             }
807             switch (hci_stack.substate >> 1){
808                 case 0:
809                     hci_send_cmd(&hci_reset);
810                     break;
811                 case 1:
812                     // custom initialization
813                     if (hci_stack.control && hci_stack.control->next_command){
814                         uint8_t * cmd = (*hci_stack.control->next_command)(hci_stack.config);
815                         if (cmd) {
816                             int size = 3 + cmd[2];
817                             hci_stack.hci_transport->send_packet(HCI_COMMAND_DATA_PACKET, cmd, size);
818                             hci_stack.substate = 0; // more init commands
819                             break;
820                         }
821                     }
822                     // otherwise continue
823 					hci_send_cmd(&hci_read_bd_addr);
824 					break;
825 				case 2:
826 					hci_send_cmd(&hci_read_buffer_size);
827 					break;
828                 case 3:
829                     // ca. 15 sec
830                     hci_send_cmd(&hci_write_page_timeout, 0x6000);
831                     break;
832 				case 4:
833 					hci_send_cmd(&hci_write_scan_enable, 2); // page scan
834 					break;
835                 case 5:
836 #ifndef EMBEDDED
837                 {
838                     char hostname[30];
839                     gethostname(hostname, 30);
840                     hostname[29] = '\0';
841                     hci_send_cmd(&hci_write_local_name, hostname);
842                     break;
843                 }
844                 case 6:
845 #endif
846                     // done.
847                     hci_stack.state = HCI_STATE_WORKING;
848                     hci_emit_state();
849                     break;
850                 default:
851                     break;
852             }
853             hci_stack.substate++;
854             break;
855 
856         case HCI_STATE_HALTING:
857 
858             log_dbg("HCI_STATE_HALTING\n");
859             // close all open connections
860             connection =  (hci_connection_t *) hci_stack.connections;
861             if (connection){
862                 log_dbg("HCI_STATE_HALTING, connection %u, handle %u\n", (int) connection, connection->con_handle);
863                 // send disconnect
864                 hci_send_cmd(&hci_disconnect, connection->con_handle, 0x13);  // remote closed connection
865 
866                 // send disconnected event right away - causes higher layer connections to get closed, too.
867                 hci_shutdown_connection(connection);
868 
869                 // remove from table
870                 hci_stack.connections = connection->item.next;
871                 return;
872             }
873             log_dbg("HCI_STATE_HALTING, calling off\n");
874 
875             // switch mode
876             hci_power_control_off();
877             hci_emit_state();
878             log_dbg("HCI_STATE_HALTING, done\n");
879             break;
880 
881         case HCI_STATE_FALLING_ASLEEP:
882             switch(hci_stack.substate) {
883                 case 0:
884                     log_dbg("HCI_STATE_FALLING_ASLEEP\n");
885                     // close all open connections
886                     connection =  (hci_connection_t *) hci_stack.connections;
887                     if (connection){
888                         log_dbg("HCI_STATE_FALLING_ASLEEP, connection %u, handle %u\n", (int) connection, connection->con_handle);
889                         // send disconnect
890                         hci_send_cmd(&hci_disconnect, connection->con_handle, 0x13);  // remote closed connection
891 
892                         // send disconnected event right away - causes higher layer connections to get closed, too.
893                         hci_shutdown_connection(connection);
894 
895                         // remove from table
896                         hci_stack.connections = connection->item.next;
897                         return;
898                     }
899 
900                     log_dbg("HCI_STATE_HALTING, disabling inq & page scans\n");
901 
902                     // disable page and inquiry scan
903                     hci_send_cmd(&hci_write_scan_enable, 0); // none
904 
905                     // continue in next sub state
906                     hci_stack.substate++;
907                     break;
908                 case 1:
909                     // wait for command complete "hci_write_scan_enable" in event_handler();
910                     break;
911                 case 2:
912                     log_dbg("HCI_STATE_HALTING, calling sleep\n");
913                     // switch mode
914                     hci_power_control_sleep();  // changes hci_stack.state to SLEEP
915                     hci_emit_state();
916                 default:
917                     break;
918             }
919             break;
920 
921         default:
922             break;
923     }
924 }
925 
926 int hci_send_cmd_packet(uint8_t *packet, int size){
927     bd_addr_t addr;
928     hci_connection_t * conn;
929     // house-keeping
930 
931     // create_connection?
932     if (IS_COMMAND(packet, hci_create_connection)){
933         bt_flip_addr(addr, &packet[3]);
934         log_dbg("Create_connection to "); print_bd_addr(addr); log_dbg("\n");
935         conn = connection_for_address(addr);
936         if (conn) {
937             // if connection exists
938             if (conn->state == OPEN) {
939                 // if OPEN, emit connection complete command
940                 hci_emit_connection_complete(conn);
941             }
942             //    otherwise, just ignore
943             return 0; // don't sent packet to controller
944 
945         } else{
946             conn = create_connection_for_addr(addr);
947             if (conn){
948                 //    create connection struct and register, state = SENT_CREATE_CONNECTION
949                 conn->state = SENT_CREATE_CONNECTION;
950             }
951         }
952     }
953 
954     if (IS_COMMAND(packet, hci_link_key_request_reply)){
955         hci_add_connection_flags_for_flipped_bd_addr(&packet[3], SENT_LINK_KEY_REPLY);
956     }
957     if (IS_COMMAND(packet, hci_link_key_request_negative_reply)){
958         hci_add_connection_flags_for_flipped_bd_addr(&packet[3], SENT_LINK_KEY_NEGATIVE_REQUEST);
959     }
960     if (IS_COMMAND(packet, hci_pin_code_request_reply)){
961         hci_add_connection_flags_for_flipped_bd_addr(&packet[3], SENT_PIN_CODE_REPLY);
962     }
963     if (IS_COMMAND(packet, hci_pin_code_request_negative_reply)){
964         hci_add_connection_flags_for_flipped_bd_addr(&packet[3], SENT_PIN_CODE_NEGATIVE_REPLY);
965     }
966 
967     if (IS_COMMAND(packet, hci_delete_stored_link_key)){
968         if (hci_stack.remote_device_db){
969             bt_flip_addr(addr, &packet[3]);
970             hci_stack.remote_device_db->delete_link_key(&addr);
971         }
972     }
973 
974     hci_stack.num_cmd_packets--;
975     return hci_stack.hci_transport->send_packet(HCI_COMMAND_DATA_PACKET, packet, size);
976 }
977 
978 /**
979  * pre: numcmds >= 0 - it's allowed to send a command to the controller
980  */
981 int hci_send_cmd(const hci_cmd_t *cmd, ...){
982     va_list argptr;
983     va_start(argptr, cmd);
984     uint8_t * hci_cmd_buffer = hci_stack.hci_cmd_buffer;
985     uint16_t size = hci_create_cmd_internal(hci_stack.hci_cmd_buffer, cmd, argptr);
986     va_end(argptr);
987     return hci_send_cmd_packet(hci_cmd_buffer, size);
988 }
989 
990 // Create various non-HCI events.
991 // TODO: generalize, use table similar to hci_create_command
992 
993 void hci_emit_state(){
994     uint8_t len = 3;
995     uint8_t event[len];
996     event[0] = BTSTACK_EVENT_STATE;
997     event[1] = len - 3;
998     event[2] = hci_stack.state;
999     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1000     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1001 }
1002 
1003 void hci_emit_connection_complete(hci_connection_t *conn){
1004     uint8_t len = 13;
1005     uint8_t event[len];
1006     event[0] = HCI_EVENT_CONNECTION_COMPLETE;
1007     event[1] = len - 3;
1008     event[2] = 0; // status = OK
1009     bt_store_16(event, 3, conn->con_handle);
1010     bt_flip_addr(&event[5], conn->address);
1011     event[11] = 1; // ACL connection
1012     event[12] = 0; // encryption disabled
1013     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1014     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1015 }
1016 
1017 void hci_emit_l2cap_check_timeout(hci_connection_t *conn){
1018     uint8_t len = 4;
1019     uint8_t event[len];
1020     event[0] = L2CAP_EVENT_TIMEOUT_CHECK;
1021     event[1] = len - 2;
1022     bt_store_16(event, 2, conn->con_handle);
1023     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1024     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1025 }
1026 
1027 void hci_emit_nr_connections_changed(){
1028     uint8_t len = 3;
1029     uint8_t event[len];
1030     event[0] = BTSTACK_EVENT_NR_CONNECTIONS_CHANGED;
1031     event[1] = len - 2;
1032     event[2] = nr_hci_connections();
1033     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1034     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1035 }
1036 
1037 void hci_emit_hci_open_failed(){
1038     uint8_t len = 2;
1039     uint8_t event[len];
1040     event[0] = BTSTACK_EVENT_POWERON_FAILED;
1041     event[1] = len - 2;
1042     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1043     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1044 }
1045 
1046 
1047 void hci_emit_btstack_version() {
1048     uint8_t len = 6;
1049     uint8_t event[len];
1050     event[0] = BTSTACK_EVENT_VERSION;
1051     event[1] = len - 2;
1052     event[len++] = BTSTACK_MAJOR;
1053     event[len++] = BTSTACK_MINOR;
1054     bt_store_16(event, len, BTSTACK_REVISION);
1055     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1056     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1057 }
1058 
1059 void hci_emit_system_bluetooth_enabled(uint8_t enabled){
1060     uint8_t len = 3;
1061     uint8_t event[len];
1062     event[0] = BTSTACK_EVENT_SYSTEM_BLUETOOTH_ENABLED;
1063     event[1] = len - 2;
1064     event[2] = enabled;
1065     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1066     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1067 }
1068 
1069 void hci_emit_remote_name_cached(bd_addr_t *addr, device_name_t *name){
1070     uint16_t len = 2+1+6+248;
1071     uint8_t event[len];
1072     event[0] = BTSTACK_EVENT_REMOTE_NAME_CACHED;
1073     event[1] = len - 2;
1074     event[2] = 0;   // just to be compatible with HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE
1075     bt_flip_addr(&event[3], *addr);
1076     memcpy(&event[9], name, 248);
1077     hci_dump_packet(HCI_EVENT_PACKET, 0, event, len);
1078     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1079 }
1080 
1081 void hci_emit_discoverable_enabled(uint8_t enabled){
1082     uint8_t len = 3;
1083     uint8_t event[len];
1084     event[0] = BTSTACK_EVENT_DISCOVERABLE_ENABLED;
1085     event[1] = len - 2;
1086     event[2] = enabled;
1087     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1088     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1089 }
1090