xref: /btstack/src/hci.c (revision 498571813b3f31d8e49be54f9189b22d326d8805)
1 /*
2  *  hci.c
3  *
4  *  Created by Matthias Ringwald on 4/29/09.
5  *
6  */
7 
8 #include <unistd.h>
9 #include <stdarg.h>
10 #include <string.h>
11 #include <stdio.h>
12 #include "hci.h"
13 
14 /**
15  *  Link Control Commands
16  */
17 hci_cmd_t hci_inquiry = {
18     OPCODE(OGF_LINK_CONTROL, 0x01), "311"
19     // LAP, Inquiry length, Num_responses
20 };
21 hci_cmd_t hci_inquiry_cancel = {
22 	OPCODE(OGF_LINK_CONTROL, 0x02), ""
23 	// no params
24 };
25 hci_cmd_t hci_create_connection = {
26 	OPCODE(OGF_LINK_CONTROL, 0x05), "B21121"
27 	// BD_ADDR, Packet_Type, Page_Scan_Repetition_Mode, Reserved, Clock_Offset, Allow_Role_Switch
28 };
29 
30 hci_cmd_t hci_accept_connection_request = {
31 	OPCODE(OGF_LINK_CONTROL, 0x09), "B1"
32 	// BD_ADDR, Role: become master, stay slave
33 };
34 hci_cmd_t hci_link_key_request_negative_reply = {
35     OPCODE(OGF_LINK_CONTROL, 0x0c), "B"
36 };
37 hci_cmd_t hci_pin_code_request_reply = {
38     OPCODE(OGF_LINK_CONTROL, 0x0d), "B1P"
39     // BD_ADDR, pin length, PIN: c-string
40 };
41 hci_cmd_t hci_remote_name_request = {
42 	OPCODE(OGF_LINK_CONTROL, 0x19), "B112"
43 	// BD_ADDR, Page_Scan_Repetition_Mode, Reserved, Clock_Offset
44 };
45 	hci_cmd_t hci_remote_name_request_cancel = {
46 	OPCODE(OGF_LINK_CONTROL, 0x1A), "B"
47 	// BD_ADDR
48 };
49 
50 /**
51  *  Controller & Baseband Commands
52  */
53 hci_cmd_t hci_set_event_mask = {
54     OPCODE(OGF_CONTROLLER_BASEBAND, 0x01), "44"
55     // event_mask lower 4 octets, higher 4 bytes
56 };
57 hci_cmd_t hci_reset = {
58     OPCODE(OGF_CONTROLLER_BASEBAND, 0x03), ""
59     // no params
60 };
61 hci_cmd_t hci_delete_stored_link_key = {
62     OPCODE(OGF_CONTROLLER_BASEBAND, 0x12), "B1"
63 	// BD_ADDR, Delete_All_Flag
64 };
65 hci_cmd_t hci_write_local_name = {
66     OPCODE(OGF_CONTROLLER_BASEBAND, 0x13), "N"
67     // Local name (UTF-8, Null Terminated, max 248 octets)
68 };
69 hci_cmd_t hci_write_page_timeout = {
70     OPCODE(OGF_CONTROLLER_BASEBAND, 0x18), "2"
71     // Page_Timeout * 0.625 ms
72 };
73 hci_cmd_t hci_write_scan_enable = {
74     OPCODE(OGF_CONTROLLER_BASEBAND, 0x1A), "1"
75     // Scan_enable: no, inq, page, inq+page
76 };
77 hci_cmd_t hci_write_authentication_enable = {
78     OPCODE(OGF_CONTROLLER_BASEBAND, 0x20), "1"
79     // Authentication_Enable
80 };
81 hci_cmd_t hci_write_class_of_device = {
82     OPCODE(OGF_CONTROLLER_BASEBAND, 0x24), "3"
83     // Class of Device
84 };
85 hci_cmd_t hci_host_buffer_size = {
86     OPCODE(OGF_CONTROLLER_BASEBAND, 0x33), "2122"
87     // Host_ACL_Data_Packet_Length:, Host_Synchronous_Data_Packet_Length:, Host_Total_Num_ACL_Data_Packets:, Host_Total_Num_Synchronous_Data_Packets:
88 };
89 
90 hci_cmd_t hci_write_inquiry_mode = {
91     OPCODE(OGF_CONTROLLER_BASEBAND, 0x45), "1"
92     // Inquiry mode: 0x00 = standard, 0x01 = with RSSI, 0x02 = extended
93 };
94 
95 hci_cmd_t hci_write_extended_inquiry_response = {
96     OPCODE(OGF_CONTROLLER_BASEBAND, 0x52), "1E"
97     // FEC_Required, Exstended Inquiry Response
98 };
99 
100 hci_cmd_t hci_write_simple_pairing_mode = {
101     OPCODE(OGF_CONTROLLER_BASEBAND, 0x56), "1"
102     // mode: 0 = off, 1 = on
103 };
104 
105 hci_cmd_t hci_read_bd_addr = {
106 	OPCODE(OGF_INFORMATIONAL_PARAMETERS, 0x09), ""
107 	// no params
108 };
109 
110 
111 // the stack is here
112 static hci_stack_t       hci_stack;
113 
114 
115 void bt_store_16(uint8_t *buffer, uint16_t pos, uint16_t value){
116     buffer[pos++] = value;
117     buffer[pos++] = value >> 8;
118 }
119 
120 void bt_store_32(uint8_t *buffer, uint16_t pos, uint32_t value){
121     buffer[pos++] = value;
122     buffer[pos++] = value >> 8;
123     buffer[pos++] = value >> 16;
124     buffer[pos++] = value >> 24;
125 }
126 
127 void bt_flip_addr(bd_addr_t dest, bd_addr_t src){
128     dest[0] = src[5];
129     dest[1] = src[4];
130     dest[2] = src[3];
131     dest[3] = src[2];
132     dest[4] = src[1];
133     dest[5] = src[0];
134 }
135 
136 void hexdump(void *data, int size){
137     int i;
138     for (i=0; i<size;i++){
139         printf("%02X ", ((uint8_t *)data)[i]);
140     }
141     printf("\n");
142 }
143 
144 /**
145  * Linked link list
146  */
147 
148 /**
149  * get link for given address
150  *
151  * @return connection OR NULL, if not found
152  */
153 #if 0
154 static hci_connection_t *link_for_addr(bd_addr_t addr){
155     return NULL;
156 }
157 #endif
158 
159 /**
160  * Handler called by HCI transport
161  */
162 static void dummy_handler(uint8_t *packet, int size){
163 }
164 
165 static void acl_handler(uint8_t *packet, int size){
166     hci_stack.acl_packet_handler(packet, size);
167 
168     // execute main loop
169     hci_run();
170 }
171 
172 static void event_handler(uint8_t *packet, int size){
173     bd_addr_t addr;
174 
175     // Get Num_HCI_Command_Packets
176     if (packet[0] == HCI_EVENT_COMMAND_COMPLETE ||
177         packet[0] == HCI_EVENT_COMMAND_STATUS){
178         hci_stack.num_cmd_packets = packet[2];
179     }
180 
181     // handle BT initialization
182     if (hci_stack.state == HCI_STATE_INITIALIZING){
183         // handle H4 synchronization loss on restart
184         // if (hci_stack.substate == 1 && packet[0] == HCI_EVENT_HARDWARE_ERROR){
185         //    hci_stack.substate = 0;
186         // }
187         // handle normal init sequence
188         if (hci_stack.substate % 2){
189             // odd: waiting for event
190             if (packet[0] == HCI_EVENT_COMMAND_COMPLETE){
191                 hci_stack.substate++;
192             }
193         }
194     }
195 
196     // link key request
197     if (packet[0] == HCI_EVENT_LINK_KEY_REQUEST){
198         bt_flip_addr(addr, &packet[2]);
199         hci_send_cmd(&hci_link_key_request_negative_reply, &addr);
200         return;
201     }
202 
203     // pin code request
204     if (packet[0] == HCI_EVENT_PIN_CODE_REQUEST){
205         bt_flip_addr(addr, &packet[2]);
206         hci_send_cmd(&hci_pin_code_request_reply, &addr, 4, "1234");
207     }
208 
209     hci_stack.event_packet_handler(packet, size);
210 
211 	// execute main loop
212 	hci_run();
213 }
214 
215 /** Register L2CAP handlers */
216 void hci_register_event_packet_handler(void (*handler)(uint8_t *packet, int size)){
217     hci_stack.event_packet_handler = handler;
218 }
219 void hci_register_acl_packet_handler  (void (*handler)(uint8_t *packet, int size)){
220     hci_stack.acl_packet_handler = handler;
221 }
222 
223 static int null_control_function(void *config){
224     return 0;
225 }
226 static const char * null_control_name(void *config){
227     return "Hardware unknown";
228 }
229 
230 static bt_control_t null_control = {
231     null_control_function,
232     null_control_function,
233     null_control_function,
234     null_control_name
235 };
236 
237 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control){
238 
239     // reference to use transport layer implementation
240     hci_stack.hci_transport = transport;
241 
242     // references to used control implementation
243     if (control) {
244         hci_stack.control = control;
245     } else {
246         hci_stack.control = &null_control;
247     }
248 
249     // reference to used config
250     hci_stack.config = config;
251 
252     // empty cmd buffer
253     hci_stack.hci_cmd_buffer = malloc(3+255);
254 
255     // higher level handler
256     hci_stack.event_packet_handler = dummy_handler;
257     hci_stack.acl_packet_handler = dummy_handler;
258 
259     // register packet handlers with transport
260     transport->register_event_packet_handler( event_handler);
261     transport->register_acl_packet_handler( acl_handler);
262 }
263 
264 int hci_power_control(HCI_POWER_MODE power_mode){
265     if (power_mode == HCI_POWER_ON) {
266 
267         // set up state machine
268         hci_stack.num_cmd_packets = 1; // assume that one cmd can be sent
269         hci_stack.state = HCI_STATE_INITIALIZING;
270         hci_stack.substate = 0;
271 
272         // power on
273         hci_stack.control->on(hci_stack.config);
274 
275         // open low-level device
276         hci_stack.hci_transport->open(hci_stack.config);
277 
278     } else if (power_mode == HCI_POWER_OFF){
279 
280         // close low-level device
281         hci_stack.hci_transport->close(hci_stack.config);
282 
283         // power off
284         hci_stack.control->off(hci_stack.config);
285     }
286 
287 	// trigger next/first action
288 	hci_run();
289 
290     return 0;
291 }
292 
293 uint32_t hci_run(){
294     uint8_t micro_packet;
295     switch (hci_stack.state){
296         case HCI_STATE_INITIALIZING:
297             if (hci_stack.substate % 2) {
298                 // odd: waiting for command completion
299                 return 0;
300             }
301             if (hci_stack.num_cmd_packets == 0) {
302                 // cannot send command yet
303                 return 0;
304             }
305             switch (hci_stack.substate/2){
306                 case 0:
307                     hci_send_cmd(&hci_reset);
308                     break;
309 				case 1:
310 					hci_send_cmd(&hci_read_bd_addr);
311 					break;
312                 case 2:
313                     // ca. 15 sec
314                     hci_send_cmd(&hci_write_page_timeout, 0x6000);
315                     break;
316 				case 3:
317 					hci_send_cmd(&hci_write_scan_enable, 3); // 3 inq scan + page scan
318 					break;
319                 case 4:
320                     // done.
321                     hci_stack.state = HCI_STATE_WORKING;
322                     micro_packet = BTSTACK_EVENT_HCI_WORKING;
323                     hci_stack.event_packet_handler(&micro_packet, 1);
324                     break;
325                 default:
326                     break;
327             }
328             hci_stack.substate++;
329             break;
330         default:
331             break;
332     }
333 
334     // don't check for timetous yet
335     return 0;
336 }
337 
338 
339 int hci_send_acl_packet(uint8_t *packet, int size){
340     return hci_stack.hci_transport->send_acl_packet(packet, size);
341 }
342 
343 int hci_send_cmd_packet(uint8_t *packet, int size){
344     hci_stack.num_cmd_packets--;
345     return hci_stack.hci_transport->send_cmd_packet(packet, size);
346 }
347 
348 /**
349  * pre: numcmds >= 0 - it's allowed to send a command to the controller
350  */
351 int hci_send_cmd(hci_cmd_t *cmd, ...){
352     uint8_t * hci_cmd_buffer = hci_stack.hci_cmd_buffer;
353     hci_cmd_buffer[0] = cmd->opcode & 0xff;
354     hci_cmd_buffer[1] = cmd->opcode >> 8;
355     int pos = 3;
356 
357     va_list argptr;
358     va_start(argptr, cmd);
359     const char *format = cmd->format;
360     uint16_t word;
361     uint32_t longword;
362     uint8_t * ptr;
363     while (*format) {
364         switch(*format) {
365             case '1': //  8 bit value
366             case '2': // 16 bit value
367             case 'H': // hci_handle
368                 word = va_arg(argptr, int);  // minimal va_arg is int: 2 bytes on 8+16 bit CPUs
369                 hci_cmd_buffer[pos++] = word & 0xff;
370                 if (*format == '2') {
371                     hci_cmd_buffer[pos++] = word >> 8;
372                 } else if (*format == 'H') {
373                     // TODO
374                 }
375                 break;
376             case '3':
377             case '4':
378                 longword = va_arg(argptr, uint32_t);
379                 // longword = va_arg(argptr, int);
380                 hci_cmd_buffer[pos++] = longword;
381                 hci_cmd_buffer[pos++] = longword >> 8;
382                 hci_cmd_buffer[pos++] = longword >> 16;
383                 if (*format == '4'){
384                     hci_cmd_buffer[pos++] = longword >> 24;
385                 }
386                 break;
387             case 'B': // bt-addr
388                 ptr = va_arg(argptr, uint8_t *);
389                 hci_cmd_buffer[pos++] = ptr[5];
390                 hci_cmd_buffer[pos++] = ptr[4];
391                 hci_cmd_buffer[pos++] = ptr[3];
392                 hci_cmd_buffer[pos++] = ptr[2];
393                 hci_cmd_buffer[pos++] = ptr[1];
394                 hci_cmd_buffer[pos++] = ptr[0];
395                 break;
396             case 'P': // c string passed as pascal string with leading 1-byte len
397                 ptr = va_arg(argptr, uint8_t *);
398                 memcpy(&hci_cmd_buffer[pos], ptr, 16);
399                 pos += 16;
400                 break;
401             case 'N': // UTF-8 string, null terminated
402                 ptr = va_arg(argptr, uint8_t *);
403                 memcpy(&hci_cmd_buffer[pos], ptr, 248);
404                 pos += 248;
405                 break;
406             case 'E': // Extended Inquiry Information 240 octets
407                 ptr = va_arg(argptr, uint8_t *);
408                 memcpy(&hci_cmd_buffer[pos], ptr, 240);
409                 pos += 240;
410                 break;
411             default:
412                 break;
413         }
414         format++;
415     };
416     va_end(argptr);
417     hci_cmd_buffer[2] = pos - 3;
418     return hci_send_cmd_packet(hci_cmd_buffer, pos);
419 }