xref: /btstack/src/hci.c (revision 3c4d4b90936f38aa13d51053b9797fdaf42b1967)
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 
313     // cancel all l2cap connections
314     hci_emit_disconnection_complete(conn->con_handle, 0x16);    // terminated by local host
315 
316     run_loop_remove_timer(&conn->timeout);
317     linked_list_remove(&hci_stack.connections, (linked_item_t *) conn);
318     free( conn );
319 
320     // now it's gone
321     hci_emit_nr_connections_changed();
322 }
323 
324 // avoid huge local variables
325 static device_name_t device_name;
326 static void event_handler(uint8_t *packet, int size){
327     bd_addr_t addr;
328     hci_con_handle_t handle;
329     hci_connection_t * conn;
330     int i;
331     link_key_t link_key;
332 
333     switch (packet[0]) {
334 
335         case HCI_EVENT_COMMAND_COMPLETE:
336             // get num cmd packets
337             // log_dbg("HCI_EVENT_COMMAND_COMPLETE cmds old %u - new %u\n", hci_stack.num_cmd_packets, packet[2]);
338             hci_stack.num_cmd_packets = packet[2];
339 
340             if (COMMAND_COMPLETE_EVENT(packet, hci_read_buffer_size)){
341                 // from offset 5
342                 // status
343                 hci_stack.acl_data_packet_length = READ_BT_16(packet, 6);
344                 // ignore: SCO data packet len (8)
345                 hci_stack.total_num_acl_packets  = packet[9];
346                 // ignore: total num SCO packets
347                 if (hci_stack.state == HCI_STATE_INITIALIZING){
348                     log_dbg("hci_read_buffer_size: size %u, count %u\n", hci_stack.acl_data_packet_length, hci_stack.total_num_acl_packets);
349                 }
350             }
351             if (COMMAND_COMPLETE_EVENT(packet, hci_write_scan_enable)){
352                 hci_emit_discoverable_enabled(hci_stack.discoverable);
353             }
354             break;
355 
356         case HCI_EVENT_COMMAND_STATUS:
357             // get num cmd packets
358             // log_dbg("HCI_EVENT_COMMAND_STATUS cmds - old %u - new %u\n", hci_stack.num_cmd_packets, packet[3]);
359             hci_stack.num_cmd_packets = packet[3];
360             break;
361 
362         case HCI_EVENT_NUMBER_OF_COMPLETED_PACKETS:
363             for (i=0; i<packet[2];i++){
364                 handle = READ_BT_16(packet, 3 + 2*i);
365                 uint16_t num_packets = READ_BT_16(packet, 3 + packet[2]*2 + 2*i);
366                 conn = connection_for_handle(handle);
367                 if (!conn){
368                     log_err("hci_number_completed_packet lists unused con handle %u\n", handle);
369                     continue;
370                 }
371                 conn->num_acl_packets_sent -= num_packets;
372                 // log_dbg("hci_number_completed_packet %u processed for handle %u, outstanding %u\n", num_packets, handle, conn->num_acl_packets_sent);
373             }
374             break;
375 
376         case HCI_EVENT_CONNECTION_REQUEST:
377             bt_flip_addr(addr, &packet[2]);
378             // TODO: eval COD 8-10
379             uint8_t link_type = packet[11];
380             log_dbg("Connection_incoming: "); print_bd_addr(addr); log_dbg(", type %u\n", link_type);
381             if (link_type == 1) { // ACL
382                 conn = connection_for_address(addr);
383                 if (!conn) {
384                     conn = create_connection_for_addr(addr);
385                 }
386                 // TODO: check for malloc failure
387                 conn->state = ACCEPTED_CONNECTION_REQUEST;
388                 hci_send_cmd(&hci_accept_connection_request, addr, 1);
389             } else {
390                 // TODO: decline request
391             }
392             break;
393 
394         case HCI_EVENT_CONNECTION_COMPLETE:
395             // Connection management
396             bt_flip_addr(addr, &packet[5]);
397             log_dbg("Connection_complete (status=%u)", packet[2]); print_bd_addr(addr); log_dbg("\n");
398             conn = connection_for_address(addr);
399             if (conn) {
400                 if (!packet[2]){
401                     conn->state = OPEN;
402                     conn->con_handle = READ_BT_16(packet, 3);
403 
404                     gettimeofday(&conn->timestamp, NULL);
405                     run_loop_set_timer(&conn->timeout, HCI_CONNECTION_TIMEOUT_MS);
406                     run_loop_add_timer(&conn->timeout);
407 
408                     log_dbg("New connection: handle %u, ", conn->con_handle);
409                     print_bd_addr( conn->address );
410                     log_dbg("\n");
411 
412                     hci_emit_nr_connections_changed();
413                 } else {
414                     // connection failed, remove entry
415                     linked_list_remove(&hci_stack.connections, (linked_item_t *) conn);
416                     free( conn );
417 
418                     // if authentication error, also delete link key
419                     if (packet[2] == 0x05) {
420                         hci_drop_link_key_for_bd_addr(&addr);
421                     }
422                 }
423             }
424             break;
425 
426         case HCI_EVENT_LINK_KEY_REQUEST:
427             hci_add_connection_flags_for_flipped_bd_addr(&packet[2], RECV_LINK_KEY_REQUEST);
428             if (!hci_stack.remote_device_db) break;
429             bt_flip_addr(addr, &packet[2]);
430             if ( hci_stack.remote_device_db->get_link_key( &addr, &link_key)){
431                 hci_send_cmd(&hci_link_key_request_reply, &addr, &link_key);
432             } else {
433                 hci_send_cmd(&hci_link_key_request_negative_reply, &addr);
434             }
435             // request already answered
436             return;
437 
438         case HCI_EVENT_LINK_KEY_NOTIFICATION:
439             hci_add_connection_flags_for_flipped_bd_addr(&packet[2], RECV_LINK_KEY_NOTIFICATION);
440             if (!hci_stack.remote_device_db) break;
441             bt_flip_addr(addr, &packet[2]);
442             hci_stack.remote_device_db->put_link_key(&addr, (link_key_t *) &packet[8]);
443             // still forward event to allow dismiss of pairing dialog
444             break;
445 
446         case HCI_EVENT_PIN_CODE_REQUEST:
447             hci_add_connection_flags_for_flipped_bd_addr(&packet[2], RECV_PIN_CODE_REQUEST);
448             break;
449 
450         case HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE:
451             if (!hci_stack.remote_device_db) break;
452             if (packet[2]) break; // status not ok
453             bt_flip_addr(addr, &packet[3]);
454             bzero(&device_name, sizeof(device_name_t));
455             strncpy((char*) device_name, (char*) &packet[9], 248);
456             hci_stack.remote_device_db->put_name(&addr, &device_name);
457             break;
458 
459         case HCI_EVENT_INQUIRY_RESULT:
460         case HCI_EVENT_INQUIRY_RESULT_WITH_RSSI:
461             if (!hci_stack.remote_device_db) break;
462             // first send inq result packet
463             hci_stack.packet_handler(HCI_EVENT_PACKET, packet, size);
464             // then send cached remote names
465             for (i=0; i<packet[2];i++){
466                 bt_flip_addr(addr, &packet[3+i*6]);
467                 if (hci_stack.remote_device_db->get_name(&addr, &device_name)){
468                     hci_emit_remote_name_cached(&addr, &device_name);
469                 }
470             }
471             return;
472 
473         case HCI_EVENT_DISCONNECTION_COMPLETE:
474             if (!packet[2]){
475                 handle = READ_BT_16(packet, 3);
476                 hci_connection_t * conn = connection_for_handle(handle);
477                 if (conn) {
478                     hci_shutdown_connection(conn);
479                 }
480             }
481             break;
482 
483         default:
484             break;
485     }
486 
487     // handle BT initialization
488     if (hci_stack.state == HCI_STATE_INITIALIZING){
489         // handle H4 synchronization loss on restart
490         // if (hci_stack.substate == 1 && packet[0] == HCI_EVENT_HARDWARE_ERROR){
491         //    hci_stack.substate = 0;
492         // }
493         // handle normal init sequence
494         if (hci_stack.substate % 2){
495             // odd: waiting for event
496             if (packet[0] == HCI_EVENT_COMMAND_COMPLETE){
497                 hci_stack.substate++;
498             }
499         }
500     }
501 
502     // help with BT sleep
503     if (hci_stack.state == HCI_STATE_FALLING_ASLEEP
504         && hci_stack.substate == 1
505         && COMMAND_COMPLETE_EVENT(packet, hci_write_scan_enable)){
506         hci_stack.substate++;
507     }
508 
509     hci_stack.packet_handler(HCI_EVENT_PACKET, packet, size);
510 
511 	// execute main loop
512 	hci_run();
513 }
514 
515 void packet_handler(uint8_t packet_type, uint8_t *packet, uint16_t size){
516     switch (packet_type) {
517         case HCI_EVENT_PACKET:
518             event_handler(packet, size);
519             break;
520         case HCI_ACL_DATA_PACKET:
521             acl_handler(packet, size);
522             break;
523         default:
524             break;
525     }
526 }
527 
528 /** Register HCI packet handlers */
529 void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)){
530     hci_stack.packet_handler = handler;
531 }
532 
533 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t * remote_device_db){
534 
535     // reference to use transport layer implementation
536     hci_stack.hci_transport = transport;
537 
538     // references to used control implementation
539     hci_stack.control = control;
540 
541     // reference to used config
542     hci_stack.config = config;
543 
544     // no connections yet
545     hci_stack.connections = NULL;
546     hci_stack.discoverable = 0;
547 
548     // empty cmd buffer
549     hci_stack.hci_cmd_buffer = malloc(3+255);
550 
551     // higher level handler
552     hci_stack.packet_handler = dummy_handler;
553 
554     // store and open remote device db
555     hci_stack.remote_device_db = remote_device_db;
556     if (hci_stack.remote_device_db) {
557         hci_stack.remote_device_db->open();
558     }
559 
560     // register packet handlers with transport
561     transport->register_packet_handler(&packet_handler);
562 }
563 
564 void hci_close(){
565     // close remote device db
566     if (hci_stack.remote_device_db) {
567         hci_stack.remote_device_db->close();
568     }
569 }
570 
571 // State-Module-Driver overview
572 // state                    module  low-level
573 // HCI_STATE_OFF             off      close
574 // HCI_STATE_INITIALIZING,   on       open
575 // HCI_STATE_WORKING,        on       open
576 // HCI_STATE_HALTING,        on       open
577 // HCI_STATE_SLEEPING,    off/sleep   close
578 // HCI_STATE_FALLING_ASLEEP  on       open
579 
580 static int hci_power_control_on(){
581 
582     // power on
583     int err = 0;
584     if (hci_stack.control && hci_stack.control->on){
585         err = (*hci_stack.control->on)(hci_stack.config);
586     }
587     if (err){
588         log_err( "POWER_ON failed\n");
589         hci_emit_hci_open_failed();
590         return err;
591     }
592 
593     // open low-level device
594     err = hci_stack.hci_transport->open(hci_stack.config);
595     if (err){
596         log_err( "HCI_INIT failed, turning Bluetooth off again\n");
597         if (hci_stack.control && hci_stack.control->off){
598             (*hci_stack.control->off)(hci_stack.config);
599         }
600         hci_emit_hci_open_failed();
601         return err;
602     }
603     return 0;
604 }
605 
606 static void hci_power_control_off(){
607 
608     // close low-level device
609     hci_stack.hci_transport->close(hci_stack.config);
610 
611     // power off
612     if (hci_stack.control && hci_stack.control->off){
613         (*hci_stack.control->off)(hci_stack.config);
614     }
615     hci_stack.state = HCI_STATE_OFF;
616 }
617 
618 static void hci_power_control_sleep(){
619 
620     log_dbg("hci_power_control_sleep");
621 
622 #if 0
623     // don't close serial port during sleep
624 
625     // close low-level device
626     hci_stack.hci_transport->close(hci_stack.config);
627 #endif
628 
629     // sleep mode
630     if (hci_stack.control && hci_stack.control->sleep){
631         (*hci_stack.control->sleep)(hci_stack.config);
632     }
633 
634     hci_stack.state = HCI_STATE_SLEEPING;
635 }
636 
637 static int hci_power_control_wake(){
638 
639     log_dbg("hci_power_control_wake");
640 
641     // wake on
642     if (hci_stack.control && hci_stack.control->wake){
643         (*hci_stack.control->wake)(hci_stack.config);
644     }
645 
646 #if 0
647     // open low-level device
648     int err = hci_stack.hci_transport->open(hci_stack.config);
649     if (err){
650         log_err( "HCI_INIT failed, turning Bluetooth off again\n");
651         if (hci_stack.control && hci_stack.control->off){
652             (*hci_stack.control->off)(hci_stack.config);
653         }
654         hci_emit_hci_open_failed();
655         return err;
656     }
657 #endif
658 
659     return 0;
660 }
661 
662 
663 int hci_power_control(HCI_POWER_MODE power_mode){
664 
665     log_dbg("hci_power_control: %u, current mode %u\n", power_mode, hci_stack.state);
666 
667     int err = 0;
668     switch (hci_stack.state){
669 
670         case HCI_STATE_OFF:
671             switch (power_mode){
672                 case HCI_POWER_ON:
673                     err = hci_power_control_on();
674                     if (err) return err;
675                     // set up state machine
676                     hci_stack.num_cmd_packets = 1; // assume that one cmd can be sent
677                     hci_stack.state = HCI_STATE_INITIALIZING;
678                     hci_stack.substate = 0;
679                     break;
680                 case HCI_POWER_OFF:
681                     // do nothing
682                     break;
683                 case HCI_POWER_SLEEP:
684                     // do nothing (with SLEEP == OFF)
685                     break;
686             }
687             break;
688 
689         case HCI_STATE_INITIALIZING:
690             switch (power_mode){
691                 case HCI_POWER_ON:
692                     // do nothing
693                     break;
694                 case HCI_POWER_OFF:
695                     // no connections yet, just turn it off
696                     hci_power_control_off();
697                     break;
698                 case HCI_POWER_SLEEP:
699                     // no connections yet, just turn it off
700                     hci_power_control_sleep();
701                     break;
702             }
703             break;
704 
705         case HCI_STATE_WORKING:
706             switch (power_mode){
707                 case HCI_POWER_ON:
708                     // do nothing
709                     break;
710                 case HCI_POWER_OFF:
711                     // see hci_run
712                     hci_stack.state = HCI_STATE_HALTING;
713                     break;
714                 case HCI_POWER_SLEEP:
715                     // see hci_run
716                     hci_stack.state = HCI_STATE_FALLING_ASLEEP;
717                     hci_stack.substate = 0;
718                     break;
719             }
720             break;
721 
722         case HCI_STATE_HALTING:
723             switch (power_mode){
724                 case HCI_POWER_ON:
725                     // set up state machine
726                     hci_stack.state = HCI_STATE_INITIALIZING;
727                     hci_stack.substate = 0;
728                     break;
729                 case HCI_POWER_OFF:
730                     // do nothing
731                     break;
732                 case HCI_POWER_SLEEP:
733                     // see hci_run
734                     hci_stack.state = HCI_STATE_FALLING_ASLEEP;
735                     hci_stack.substate = 0;
736                     break;
737             }
738             break;
739 
740         case HCI_STATE_FALLING_ASLEEP:
741             switch (power_mode){
742                 case HCI_POWER_ON:
743                     // set up state machine
744                     hci_stack.num_cmd_packets = 1; // assume that one cmd can be sent
745                     hci_stack.state = HCI_STATE_INITIALIZING;
746                     hci_stack.substate = 0;
747                     break;
748                 case HCI_POWER_OFF:
749                     // see hci_run
750                     hci_stack.state = HCI_STATE_HALTING;
751                     break;
752                 case HCI_POWER_SLEEP:
753                     // do nothing
754                     break;
755             }
756             break;
757 
758         case HCI_STATE_SLEEPING:
759             switch (power_mode){
760                 case HCI_POWER_ON:
761                     err = hci_power_control_wake();
762                     if (err) return err;
763                     // set up state machine
764                     hci_stack.num_cmd_packets = 1; // assume that one cmd can be sent
765                     hci_stack.state = HCI_STATE_INITIALIZING;
766                     hci_stack.substate = 0;
767                     break;
768                 case HCI_POWER_OFF:
769                     hci_stack.state = HCI_STATE_HALTING;
770                     break;
771                 case HCI_POWER_SLEEP:
772                     // do nothing
773                     break;
774             }
775             break;
776     }
777 
778     // create internal event
779 	hci_emit_state();
780 
781 	// trigger next/first action
782 	hci_run();
783 
784     return 0;
785 }
786 
787 void hci_discoverable_control(uint8_t enable){
788     if (enable) enable = 1; // normalize argument
789 
790     if (hci_stack.discoverable == enable){
791         hci_emit_discoverable_enabled(hci_stack.discoverable);
792         return;
793     }
794 
795     hci_send_cmd(&hci_write_scan_enable, 2 | enable); // 1 = inq scan, 2 = page scan
796     hci_stack.discoverable = enable;
797 }
798 
799 void hci_run(){
800 
801     if (hci_stack.num_cmd_packets == 0) {
802         // cannot send command yet
803         return;
804     }
805 
806     hci_connection_t * connection;
807 
808     switch (hci_stack.state){
809         case HCI_STATE_INITIALIZING:
810             if (hci_stack.substate % 2) {
811                 // odd: waiting for command completion
812                 return;
813             }
814             switch (hci_stack.substate >> 1){
815                 case 0:
816                     hci_send_cmd(&hci_reset);
817                     break;
818                 case 1:
819                     // custom initialization
820                     if (hci_stack.control && hci_stack.control->next_command){
821                         uint8_t * cmd = (*hci_stack.control->next_command)(hci_stack.config);
822                         if (cmd) {
823                             int size = 3 + cmd[2];
824                             hci_stack.hci_transport->send_packet(HCI_COMMAND_DATA_PACKET, cmd, size);
825                             hci_stack.substate = 0; // more init commands
826                             break;
827                         }
828                     }
829                     // otherwise continue
830 					hci_send_cmd(&hci_read_bd_addr);
831 					break;
832 				case 2:
833 					hci_send_cmd(&hci_read_buffer_size);
834 					break;
835                 case 3:
836                     // ca. 15 sec
837                     hci_send_cmd(&hci_write_page_timeout, 0x6000);
838                     break;
839 				case 4:
840 					hci_send_cmd(&hci_write_scan_enable, 2 | hci_stack.discoverable); // page scan
841 					break;
842                 case 5:
843 #ifndef EMBEDDED
844                 {
845                     char hostname[30];
846                     gethostname(hostname, 30);
847                     hostname[29] = '\0';
848                     hci_send_cmd(&hci_write_local_name, hostname);
849                     break;
850                 }
851                 case 6:
852 #ifdef USE_BLUETOOL
853                     hci_send_cmd(&hci_write_class_of_device, 0x007a020c); // Smartphone
854                     break;
855 
856                 case 7:
857 #endif
858 #endif
859                     // done.
860                     hci_stack.state = HCI_STATE_WORKING;
861                     hci_emit_state();
862                     break;
863                 default:
864                     break;
865             }
866             hci_stack.substate++;
867             break;
868 
869         case HCI_STATE_HALTING:
870 
871             log_dbg("HCI_STATE_HALTING\n");
872             // close all open connections
873             connection =  (hci_connection_t *) hci_stack.connections;
874             if (connection){
875                 log_dbg("HCI_STATE_HALTING, connection %u, handle %u\n", (int) connection, connection->con_handle);
876                 // send disconnect
877                 hci_send_cmd(&hci_disconnect, connection->con_handle, 0x13);  // remote closed connection
878 
879                 // send disconnected event right away - causes higher layer connections to get closed, too.
880                 hci_shutdown_connection(connection);
881                 return;
882             }
883             log_dbg("HCI_STATE_HALTING, calling off\n");
884 
885             // switch mode
886             hci_power_control_off();
887             hci_emit_state();
888             log_dbg("HCI_STATE_HALTING, done\n");
889             break;
890 
891         case HCI_STATE_FALLING_ASLEEP:
892             switch(hci_stack.substate) {
893                 case 0:
894                     log_dbg("HCI_STATE_FALLING_ASLEEP\n");
895                     // close all open connections
896                     connection =  (hci_connection_t *) hci_stack.connections;
897                     if (connection){
898                         log_dbg("HCI_STATE_FALLING_ASLEEP, connection %u, handle %u\n", (int) connection, connection->con_handle);
899                         // send disconnect
900                         hci_send_cmd(&hci_disconnect, connection->con_handle, 0x13);  // remote closed connection
901 
902                         // send disconnected event right away - causes higher layer connections to get closed, too.
903                         hci_shutdown_connection(connection);
904                         return;
905                     }
906 
907                     log_dbg("HCI_STATE_HALTING, disabling inq & page scans\n");
908 
909                     // disable page and inquiry scan
910                     hci_send_cmd(&hci_write_scan_enable, 0); // none
911 
912                     // continue in next sub state
913                     hci_stack.substate++;
914                     break;
915                 case 1:
916                     // wait for command complete "hci_write_scan_enable" in event_handler();
917                     break;
918                 case 2:
919                     log_dbg("HCI_STATE_HALTING, calling sleep\n");
920                     // switch mode
921                     hci_power_control_sleep();  // changes hci_stack.state to SLEEP
922                     hci_emit_state();
923                 default:
924                     break;
925             }
926             break;
927 
928         default:
929             break;
930     }
931 }
932 
933 int hci_send_cmd_packet(uint8_t *packet, int size){
934     bd_addr_t addr;
935     hci_connection_t * conn;
936     // house-keeping
937 
938     // create_connection?
939     if (IS_COMMAND(packet, hci_create_connection)){
940         bt_flip_addr(addr, &packet[3]);
941         log_dbg("Create_connection to "); print_bd_addr(addr); log_dbg("\n");
942         conn = connection_for_address(addr);
943         if (conn) {
944             // if connection exists
945             if (conn->state == OPEN) {
946                 // if OPEN, emit connection complete command
947                 hci_emit_connection_complete(conn);
948             }
949             //    otherwise, just ignore
950             return 0; // don't sent packet to controller
951 
952         } else{
953             conn = create_connection_for_addr(addr);
954             if (conn){
955                 //    create connection struct and register, state = SENT_CREATE_CONNECTION
956                 conn->state = SENT_CREATE_CONNECTION;
957             }
958         }
959     }
960 
961     if (IS_COMMAND(packet, hci_link_key_request_reply)){
962         hci_add_connection_flags_for_flipped_bd_addr(&packet[3], SENT_LINK_KEY_REPLY);
963     }
964     if (IS_COMMAND(packet, hci_link_key_request_negative_reply)){
965         hci_add_connection_flags_for_flipped_bd_addr(&packet[3], SENT_LINK_KEY_NEGATIVE_REQUEST);
966     }
967     if (IS_COMMAND(packet, hci_pin_code_request_reply)){
968         hci_add_connection_flags_for_flipped_bd_addr(&packet[3], SENT_PIN_CODE_REPLY);
969     }
970     if (IS_COMMAND(packet, hci_pin_code_request_negative_reply)){
971         hci_add_connection_flags_for_flipped_bd_addr(&packet[3], SENT_PIN_CODE_NEGATIVE_REPLY);
972     }
973 
974     if (IS_COMMAND(packet, hci_delete_stored_link_key)){
975         if (hci_stack.remote_device_db){
976             bt_flip_addr(addr, &packet[3]);
977             hci_stack.remote_device_db->delete_link_key(&addr);
978         }
979     }
980 
981     hci_stack.num_cmd_packets--;
982     return hci_stack.hci_transport->send_packet(HCI_COMMAND_DATA_PACKET, packet, size);
983 }
984 
985 /**
986  * pre: numcmds >= 0 - it's allowed to send a command to the controller
987  */
988 int hci_send_cmd(const hci_cmd_t *cmd, ...){
989     va_list argptr;
990     va_start(argptr, cmd);
991     uint8_t * hci_cmd_buffer = hci_stack.hci_cmd_buffer;
992     uint16_t size = hci_create_cmd_internal(hci_stack.hci_cmd_buffer, cmd, argptr);
993     va_end(argptr);
994     return hci_send_cmd_packet(hci_cmd_buffer, size);
995 }
996 
997 // Create various non-HCI events.
998 // TODO: generalize, use table similar to hci_create_command
999 
1000 void hci_emit_state(){
1001     uint8_t len = 3;
1002     uint8_t event[len];
1003     event[0] = BTSTACK_EVENT_STATE;
1004     event[1] = len - 3;
1005     event[2] = hci_stack.state;
1006     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1007     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1008 }
1009 
1010 void hci_emit_connection_complete(hci_connection_t *conn){
1011     uint8_t len = 13;
1012     uint8_t event[len];
1013     event[0] = HCI_EVENT_CONNECTION_COMPLETE;
1014     event[1] = len - 3;
1015     event[2] = 0; // status = OK
1016     bt_store_16(event, 3, conn->con_handle);
1017     bt_flip_addr(&event[5], conn->address);
1018     event[11] = 1; // ACL connection
1019     event[12] = 0; // encryption disabled
1020     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1021     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1022 }
1023 
1024 void hci_emit_disconnection_complete(uint16_t handle, uint8_t reason){
1025     uint8_t len = 6;
1026     uint8_t event[len];
1027     event[0] = HCI_EVENT_DISCONNECTION_COMPLETE;
1028     event[1] = len - 3;
1029     event[2] = 0; // status = OK
1030     bt_store_16(event, 3, handle);
1031     event[5] = reason;
1032     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1033     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1034 }
1035 
1036 void hci_emit_l2cap_check_timeout(hci_connection_t *conn){
1037     uint8_t len = 4;
1038     uint8_t event[len];
1039     event[0] = L2CAP_EVENT_TIMEOUT_CHECK;
1040     event[1] = len - 2;
1041     bt_store_16(event, 2, conn->con_handle);
1042     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1043     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1044 }
1045 
1046 void hci_emit_nr_connections_changed(){
1047     uint8_t len = 3;
1048     uint8_t event[len];
1049     event[0] = BTSTACK_EVENT_NR_CONNECTIONS_CHANGED;
1050     event[1] = len - 2;
1051     event[2] = nr_hci_connections();
1052     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1053     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1054 }
1055 
1056 void hci_emit_hci_open_failed(){
1057     uint8_t len = 2;
1058     uint8_t event[len];
1059     event[0] = BTSTACK_EVENT_POWERON_FAILED;
1060     event[1] = len - 2;
1061     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1062     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1063 }
1064 
1065 
1066 void hci_emit_btstack_version() {
1067     uint8_t len = 6;
1068     uint8_t event[len];
1069     event[0] = BTSTACK_EVENT_VERSION;
1070     event[1] = len - 2;
1071     event[len++] = BTSTACK_MAJOR;
1072     event[len++] = BTSTACK_MINOR;
1073     bt_store_16(event, len, BTSTACK_REVISION);
1074     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1075     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1076 }
1077 
1078 void hci_emit_system_bluetooth_enabled(uint8_t enabled){
1079     uint8_t len = 3;
1080     uint8_t event[len];
1081     event[0] = BTSTACK_EVENT_SYSTEM_BLUETOOTH_ENABLED;
1082     event[1] = len - 2;
1083     event[2] = enabled;
1084     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1085     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1086 }
1087 
1088 void hci_emit_remote_name_cached(bd_addr_t *addr, device_name_t *name){
1089     uint16_t len = 2+1+6+248;
1090     uint8_t event[len];
1091     event[0] = BTSTACK_EVENT_REMOTE_NAME_CACHED;
1092     event[1] = len - 2;
1093     event[2] = 0;   // just to be compatible with HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE
1094     bt_flip_addr(&event[3], *addr);
1095     memcpy(&event[9], name, 248);
1096     hci_dump_packet(HCI_EVENT_PACKET, 0, event, len);
1097     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1098 }
1099 
1100 void hci_emit_discoverable_enabled(uint8_t enabled){
1101     uint8_t len = 3;
1102     uint8_t event[len];
1103     event[0] = BTSTACK_EVENT_DISCOVERABLE_ENABLED;
1104     event[1] = len - 2;
1105     event[2] = enabled;
1106     hci_dump_packet( HCI_EVENT_PACKET, 0, event, len);
1107     hci_stack.packet_handler(HCI_EVENT_PACKET, event, len);
1108 }
1109