xref: /btstack/src/btstack_defines.h (revision ed2540d4a98d3580c4414caf25307c965fdf3f9c)
1 /*
2  * Copyright (C) 2015 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 /*
39  * btstack-defines.h
40  *
41  * BTstack definitions, events, and error codes */
42 
43 #ifndef __BTSTACK_DEFINES_H
44 #define __BTSTACK_DEFINES_H
45 
46 #include <stdint.h>
47 #include "btstack_linked_list.h"
48 
49 // TYPES
50 
51 // packet handler
52 typedef void (*btstack_packet_handler_t) (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
53 
54 // packet callback supporting multiple registrations
55 typedef struct {
56     btstack_linked_item_t    item;
57     btstack_packet_handler_t callback;
58 } btstack_packet_callback_registration_t;
59 
60 /**
61  * @brief 128 bit key used with AES128 in Security Manager
62  */
63 typedef uint8_t sm_key_t[16];
64 
65 // DEFINES
66 
67 #define DAEMON_EVENT_PACKET     0x05
68 
69 // L2CAP data
70 #define L2CAP_DATA_PACKET       0x06
71 
72 // RFCOMM data
73 #define RFCOMM_DATA_PACKET      0x07
74 
75 // Attribute protocol data
76 #define ATT_DATA_PACKET         0x08
77 
78 // Security Manager protocol data
79 #define SM_DATA_PACKET          0x09
80 
81 // SDP query result
82 // format: type (8), record_id (16), attribute_id (16), attribute_length (16), attribute_value (max 1k)
83 #define SDP_CLIENT_PACKET       0x0a
84 
85 // BNEP data
86 #define BNEP_DATA_PACKET        0x0b
87 
88 // Unicast Connectionless Data
89 #define UCD_DATA_PACKET         0x0c
90 
91 // debug log messages
92 #define LOG_MESSAGE_PACKET      0xfc
93 
94 
95 // ERRORS
96 
97 // last error code in 2.1 is 0x38 - we start with 0x50 for BTstack errors
98 #define BTSTACK_CONNECTION_TO_BTDAEMON_FAILED              0x50
99 #define BTSTACK_ACTIVATION_FAILED_SYSTEM_BLUETOOTH         0x51
100 #define BTSTACK_ACTIVATION_POWERON_FAILED                  0x52
101 #define BTSTACK_ACTIVATION_FAILED_UNKNOWN                  0x53
102 #define BTSTACK_NOT_ACTIVATED                              0x54
103 #define BTSTACK_BUSY                                       0x55
104 #define BTSTACK_MEMORY_ALLOC_FAILED                        0x56
105 #define BTSTACK_ACL_BUFFERS_FULL                           0x57
106 
107 // l2cap errors - enumeration by the command that created them
108 #define L2CAP_COMMAND_REJECT_REASON_COMMAND_NOT_UNDERSTOOD 0x60
109 #define L2CAP_COMMAND_REJECT_REASON_SIGNALING_MTU_EXCEEDED 0x61
110 #define L2CAP_COMMAND_REJECT_REASON_INVALID_CID_IN_REQUEST 0x62
111 
112 #define L2CAP_CONNECTION_RESPONSE_RESULT_SUCCESSFUL        0x63
113 #define L2CAP_CONNECTION_RESPONSE_RESULT_PENDING           0x64
114 #define L2CAP_CONNECTION_RESPONSE_RESULT_REFUSED_PSM       0x65
115 #define L2CAP_CONNECTION_RESPONSE_RESULT_REFUSED_SECURITY  0x66
116 #define L2CAP_CONNECTION_RESPONSE_RESULT_REFUSED_RESOURCES 0x67
117 #define L2CAP_CONNECTION_RESPONSE_RESULT_RTX_TIMEOUT       0x68
118 
119 #define L2CAP_SERVICE_ALREADY_REGISTERED                   0x69
120 #define L2CAP_DATA_LEN_EXCEEDS_REMOTE_MTU                  0x6A
121 
122 #define RFCOMM_MULTIPLEXER_STOPPED                         0x70
123 #define RFCOMM_CHANNEL_ALREADY_REGISTERED                  0x71
124 #define RFCOMM_NO_OUTGOING_CREDITS                         0x72
125 #define RFCOMM_AGGREGATE_FLOW_OFF                          0x73
126 #define RFCOMM_DATA_LEN_EXCEEDS_MTU                        0x74
127 
128 #define SDP_HANDLE_ALREADY_REGISTERED                      0x80
129 #define SDP_QUERY_INCOMPLETE                               0x81
130 #define SDP_SERVICE_NOT_FOUND                              0x82
131 #define SDP_HANDLE_INVALID                                 0x83
132 #define SDP_QUERY_BUSY                                     0x84
133 
134 #define ATT_HANDLE_VALUE_INDICATION_IN_PORGRESS            0x90
135 #define ATT_HANDLE_VALUE_INDICATION_TIMEOUT                0x91
136 
137 #define GATT_CLIENT_NOT_CONNECTED                          0x93
138 #define GATT_CLIENT_BUSY                                   0x94
139 #define GATT_CLIENT_IN_WRONG_STATE                         0x95
140 #define GATT_CLIENT_DIFFERENT_CONTEXT_FOR_ADDRESS_ALREADY_EXISTS 0x96
141 #define GATT_CLIENT_VALUE_TOO_LONG                         0x97
142 #define GATT_CLIENT_CHARACTERISTIC_NOTIFICATION_NOT_SUPPORTED 0x98
143 #define GATT_CLIENT_CHARACTERISTIC_INDICATION_NOT_SUPPORTED   0x99
144 
145 #define BNEP_SERVICE_ALREADY_REGISTERED                    0xA0
146 #define BNEP_CHANNEL_NOT_CONNECTED                         0xA1
147 #define BNEP_DATA_LEN_EXCEEDS_MTU                          0xA2
148 
149 // COMMANDS
150 
151 #define OGF_BTSTACK 0x3d
152 
153 // cmds for BTstack
154 // get state: @returns HCI_STATE
155 #define BTSTACK_GET_STATE                                  0x01
156 
157 // set power mode: @param HCI_POWER_MODE
158 #define BTSTACK_SET_POWER_MODE                             0x02
159 
160 // set capture mode: @param on
161 #define BTSTACK_SET_ACL_CAPTURE_MODE                       0x03
162 
163 // get BTstack version
164 #define BTSTACK_GET_VERSION                                0x04
165 
166 // get system Bluetooth state
167 #define BTSTACK_GET_SYSTEM_BLUETOOTH_ENABLED               0x05
168 
169 // set system Bluetooth state
170 #define BTSTACK_SET_SYSTEM_BLUETOOTH_ENABLED               0x06
171 
172 // enable inquiry scan for this client
173 #define BTSTACK_SET_DISCOVERABLE                           0x07
174 
175 // set global Bluetooth state
176 #define BTSTACK_SET_BLUETOOTH_ENABLED                      0x08
177 
178 // create l2cap channel: @param bd_addr(48), psm (16)
179 #define L2CAP_CREATE_CHANNEL                               0x20
180 
181 // disconnect l2cap disconnect, @param channel(16), reason(8)
182 #define L2CAP_DISCONNECT                                   0x21
183 
184 // register l2cap service: @param psm(16), mtu (16)
185 #define L2CAP_REGISTER_SERVICE                             0x22
186 
187 // unregister l2cap disconnect, @param psm(16)
188 #define L2CAP_UNREGISTER_SERVICE                           0x23
189 
190 // accept connection @param bd_addr(48), dest cid (16)
191 #define L2CAP_ACCEPT_CONNECTION                            0x24
192 
193 // decline l2cap disconnect,@param bd_addr(48), dest cid (16), reason(8)
194 #define L2CAP_DECLINE_CONNECTION                           0x25
195 
196 // create l2cap channel: @param bd_addr(48), psm (16), mtu (16)
197 #define L2CAP_CREATE_CHANNEL_MTU                           0x26
198 
199 // register SDP Service Record: service record (size)
200 #define SDP_REGISTER_SERVICE_RECORD                        0x30
201 
202 // unregister SDP Service Record
203 #define SDP_UNREGISTER_SERVICE_RECORD                      0x31
204 
205 // Get remote RFCOMM services
206 #define SDP_CLIENT_QUERY_RFCOMM_SERVICES                   0x32
207 
208 // Get remote SDP services
209 #define SDP_CLIENT_QUERY_SERVICES                          0x33
210 
211 // RFCOMM "HCI" Commands
212 #define RFCOMM_CREATE_CHANNEL       0x40
213 #define RFCOMM_DISCONNECT     0x41
214 #define RFCOMM_REGISTER_SERVICE     0x42
215 #define RFCOMM_UNREGISTER_SERVICE   0x43
216 #define RFCOMM_ACCEPT_CONNECTION    0x44
217 #define RFCOMM_DECLINE_CONNECTION   0x45
218 #define RFCOMM_PERSISTENT_CHANNEL   0x46
219 #define RFCOMM_CREATE_CHANNEL_WITH_CREDITS   0x47
220 #define RFCOMM_REGISTER_SERVICE_WITH_CREDITS 0x48
221 #define RFCOMM_GRANT_CREDITS                 0x49
222 
223 // GAP Classic 0x50
224 #define GAP_DISCONNECT              0x50
225 
226 // GAP LE      0x60
227 #define GAP_LE_SCAN_START           0x60
228 #define GAP_LE_SCAN_STOP            0x61
229 #define GAP_LE_CONNECT              0x62
230 #define GAP_LE_CONNECT_CANCEL       0x63
231 #define GAP_LE_SET_SCAN_PARAMETERS  0x64
232 
233 // GATT (Client) 0x70
234 #define GATT_DISCOVER_ALL_PRIMARY_SERVICES                       0x70
235 #define GATT_DISCOVER_PRIMARY_SERVICES_BY_UUID16                 0x71
236 #define GATT_DISCOVER_PRIMARY_SERVICES_BY_UUID128                0x72
237 #define GATT_FIND_INCLUDED_SERVICES_FOR_SERVICE                  0x73
238 #define GATT_DISCOVER_CHARACTERISTICS_FOR_SERVICE                0x74
239 #define GATT_DISCOVER_CHARACTERISTICS_FOR_SERVICE_BY_UUID128     0x75
240 #define GATT_DISCOVER_CHARACTERISTIC_DESCRIPTORS                 0x76
241 #define GATT_READ_VALUE_OF_CHARACTERISTIC                        0x77
242 #define GATT_READ_LONG_VALUE_OF_CHARACTERISTIC                   0x78
243 #define GATT_WRITE_VALUE_OF_CHARACTERISTIC_WITHOUT_RESPONSE      0x79
244 #define GATT_WRITE_VALUE_OF_CHARACTERISTIC                       0x7A
245 #define GATT_WRITE_LONG_VALUE_OF_CHARACTERISTIC                  0x7B
246 #define GATT_RELIABLE_WRITE_LONG_VALUE_OF_CHARACTERISTIC         0x7C
247 #define GATT_READ_CHARACTERISTIC_DESCRIPTOR                      0X7D
248 #define GATT_READ_LONG_CHARACTERISTIC_DESCRIPTOR                 0X7E
249 #define GATT_WRITE_CHARACTERISTIC_DESCRIPTOR                     0X7F
250 #define GATT_WRITE_LONG_CHARACTERISTIC_DESCRIPTOR                0X80
251 #define GATT_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION           0X81
252 #define GATT_GET_MTU                                             0x82
253 
254 
255 // EVENTS
256 
257 /**
258  * @format 1
259  * @param state
260  */
261 #define BTSTACK_EVENT_STATE                                0x60
262 
263 // data: event(8), len(8), nr hci connections
264 #define BTSTACK_EVENT_NR_CONNECTIONS_CHANGED               0x61
265 
266 /**
267  * @format
268  */
269 #define BTSTACK_EVENT_POWERON_FAILED                       0x62
270 
271 /**
272  * @format 1
273  * @param discoverable
274  */
275 #define BTSTACK_EVENT_DISCOVERABLE_ENABLED                 0x66
276 
277 // Daemon Events
278 
279 /**
280  * @format 112
281  * @param major
282  * @param minor
283  @ @param revision
284  */
285 #define DAEMON_EVENT_VERSION                               0x63
286 
287 // data: system bluetooth on/off (bool)
288 /**
289  * @format 1
290  * param system_bluetooth_enabled
291  */
292 #define DAEMON_EVENT_SYSTEM_BLUETOOTH_ENABLED              0x64
293 
294 // data: event (8), len(8), status (8) == 0, address (48), name (1984 bits = 248 bytes)
295 
296 /*
297  * @format 1BT
298  * @param status == 0 to match read_remote_name_request
299  * @param address
300  * @param name
301  */
302 #define DAEMON_EVENT_REMOTE_NAME_CACHED                    0x65
303 
304 // internal daemon events
305 
306 // data: event(8)
307 #define DAEMON_EVENT_CONNECTION_OPENED                     0x67
308 
309 // data: event(8)
310 #define DAEMON_EVENT_CONNECTION_CLOSED                     0x68
311 
312 
313 // additional HCI events
314 
315 /**
316  * @brief Outgoing packet
317  */
318 #define HCI_EVENT_TRANSPORT_PACKET_SENT                    0x6E
319 
320 /**
321  * @format B
322  * @param handle
323  */
324 #define HCI_EVENT_SCO_CAN_SEND_NOW                         0x6F
325 
326 // L2CAP EVENTS
327 
328 /**
329  * @format 1BH222222
330  * @param status
331  * @param address
332  * @param handle
333  * @param psm
334  * @param local_cid
335  * @param remote_cid
336  * @param local_mtu
337  * @param remote_mtu
338  * @param flush_timeout
339  */
340 #define L2CAP_EVENT_CHANNEL_OPENED                         0x70
341 
342 /*
343  * @format 2
344  * @param local_cid
345  */
346 #define L2CAP_EVENT_CHANNEL_CLOSED                         0x71
347 
348 /**
349  * @format 1BH222
350  * @param status
351  * @param address
352  * @param handle
353  * @param psm
354  * @param local_cid
355  * @param remote_cid
356  */
357 #define L2CAP_EVENT_INCOMING_CONNECTION                    0x72
358 
359 // ??
360 // data: event(8), len(8), handle(16)
361 #define L2CAP_EVENT_TIMEOUT_CHECK                          0x73
362 
363 // ??
364 // data: event(8), len(8), local_cid(16), credits(8)
365 #define L2CAP_EVENT_CREDITS                                0x74
366 
367 /**
368  * @format 12
369  * @param status
370  * @param psm
371  */
372 #define L2CAP_EVENT_SERVICE_REGISTERED                     0x75
373 
374 /**
375  * @format H2222
376  * @param handle
377  * @param interval_min
378  * @param interval_max
379  * @param latencey
380  * @param timeout_multiplier
381  */
382 #define L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_REQUEST    0x76
383 
384 // data: event(8), len(8), handle(16), result (16) (0 == ok, 1 == fail)
385  /**
386   * @format H2
387   * @param handle
388   * @result
389   */
390 #define L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_RESPONSE   0x77
391 
392 /**
393  * @format 2
394  * @param local_cid
395  */
396 #define L2CAP_EVENT_CAN_SEND_NOW                           0x78
397 
398 // RFCOMM EVENTS
399 
400 /**
401  * @format 1B2122
402  * @param status
403  * @param bd_addr
404  * @param con_handle
405  * @param server_channel
406  * @param rfcomm_cid
407  * @param max_frame_size
408  */
409 #define RFCOMM_EVENT_OPEN_CHANNEL_COMPLETE                 0x80
410 
411 /**
412  * @format 2
413  * @param rfcomm_cid
414  */
415 #define RFCOMM_EVENT_CHANNEL_CLOSED                        0x81
416 
417 /**
418  * @format B12
419  * @param bd_addr
420  * @param server_channel
421  * @param rfcomm_cid
422  */
423 #define RFCOMM_EVENT_INCOMING_CONNECTION                   0x82
424 
425 /**
426  * @format 21
427  * @param rfcomm_cid
428  * @param line_status
429  */
430 #define RFCOMM_EVENT_REMOTE_LINE_STATUS                    0x83
431 
432 /**
433  * @format 21
434  * @param rfcomm_cid
435  * @param credits
436  */
437 #define RFCOMM_EVENT_CREDITS                               0x84
438 
439 /**
440  * @format 11
441  * @param status
442  * @param channel_id
443  */
444 #define RFCOMM_EVENT_SERVICE_REGISTERED                    0x85
445 
446 /**
447  * @format 11
448  * @param status
449  * @param server_channel_id
450  */
451 #define RFCOMM_EVENT_PERSISTENT_CHANNEL                    0x86
452 
453 /**
454  * @format 21
455  * @param rfcomm_cid
456  * @param modem_status
457  */
458 #define RFCOMM_EVENT_REMOTE_MODEM_STATUS                   0x87
459 
460  /**
461   * TODO: format for variable data 2?
462   * @param rfcomm_cid
463   * @param rpn_data
464   */
465 #define RFCOMM_EVENT_PORT_CONFIGURATION                    0x88
466 
467 /**
468  * @format 2
469  * @param local_cid
470  */
471 #define RFCOMM_EVENT_CAN_SEND_NOW                          0x89
472 
473 
474 /**
475   * @format 14
476   * @param status
477   * @param service_record_handle
478   */
479 #define SDP_EVENT_SERVICE_REGISTERED                             0x90
480 
481 /**
482  * @format 1
483  * @param status
484  */
485 #define SDP_EVENT_QUERY_COMPLETE                                 0x91
486 
487 /**
488  * @format 1T
489  * @param rfcomm_channel
490  * @param name
491  */
492 #define SDP_EVENT_QUERY_RFCOMM_SERVICE                           0x92
493 
494 /**
495  * @format 22221
496  * @param record_id
497  * @param attribute_id
498  * @param attribute_length
499  * @param data_offset
500  * @param data
501  */
502 #define SDP_EVENT_QUERY_ATTRIBUTE_BYTE                           0x93
503 
504 /**
505  * @format 22LV
506  * @param record_id
507  * @param attribute_id
508  * @param attribute_length
509  * @param attribute_value
510  */
511 #define SDP_EVENT_QUERY_ATTRIBUTE_VALUE                          0x94
512 
513 /**
514  * @format 224
515  * @param total_count
516  * @param record_index
517  * @param record_handle
518  * @note Not provided by daemon, only used for internal testing
519  */
520 #define SDP_EVENT_QUERY_SERVICE_RECORD_HANDLE                    0x95
521 
522 /**
523  * @format H1
524  * @param handle
525  * @param status
526  */
527 #define GATT_EVENT_QUERY_COMPLETE                                0xA0
528 
529 /**
530  * @format HX
531  * @param handle
532  * @param service
533  */
534 #define GATT_EVENT_SERVICE_QUERY_RESULT                          0xA1
535 
536 /**
537  * @format HY
538  * @param handle
539  * @param characteristic
540  */
541 #define GATT_EVENT_CHARACTERISTIC_QUERY_RESULT                   0xA2
542 
543 /**
544  * @format H2X
545  * @param handle
546  * @param include_handle
547  * @param service
548  */
549 #define GATT_EVENT_INCLUDED_SERVICE_QUERY_RESULT                 0xA3
550 
551 /**
552  * @format HZ
553  * @param handle
554  * @param characteristic_descriptor
555  */
556 #define GATT_EVENT_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY_RESULT   0xA4
557 
558 /**
559  * @format H2LV
560  * @param handle
561  * @param value_handle
562  * @param value_length
563  * @param value
564  */
565 #define GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT             0xA5
566 
567 /**
568  * @format H22LV
569  * @param handle
570  * @param value_handle
571  * @param value_offset
572  * @param value_length
573  * @param value
574  */
575 #define GATT_EVENT_LONG_CHARACTERISTIC_VALUE_QUERY_RESULT        0xA6
576 
577 /**
578  * @format H2LV
579  * @param handle
580  * @param value_handle
581  * @param value_length
582  * @param value
583  */
584 #define GATT_EVENT_NOTIFICATION                                  0xA7
585 
586 /**
587  * @format H2LV
588  * @param handle
589  * @param value_handle
590  * @param value_length
591  * @param value
592  */
593 #define GATT_EVENT_INDICATION                                    0xA8
594 
595 /**
596  * @format H2LV
597  * @param descriptor_handle
598  * @param descriptor_length
599  * @param descriptor
600  */
601 #define GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT        0xA9
602 
603 /**
604  * @format H2LV
605  * @param handle
606  * @param descriptor_offset
607  * @param descriptor_length
608  * @param descriptor
609  */
610 #define GATT_EVENT_LONG_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT   0xAA
611 
612 /**
613  * @format H2
614  * @param handle
615  * @param MTU
616  */
617 #define GATT_EVENT_MTU                                           0xAB
618 
619 /**
620  * @format H2
621  * @param handle
622  * @param MTU
623  */
624 #define ATT_EVENT_MTU_EXCHANGE_COMPLETE                          0xB5
625 
626 // data: event(8), len(8), status (8), hci_handle (16), attribute_handle (16)
627 #define ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE               0xB6
628 
629 
630 // data: event(8), len(8), status (8), bnep service uuid (16)
631 #define BNEP_EVENT_SERVICE_REGISTERED                      0xC0
632 
633 // data: event(8), len(8), status (8), bnep source uuid (16), bnep destination uuid (16), mtu (16), remote_address (48)
634 #define BNEP_EVENT_OPEN_CHANNEL_COMPLETE                   0xC1
635 
636 // data: event(8), len(8), bnep source uuid (16), bnep destination uuid (16), remote_address (48)
637 #define BNEP_EVENT_CHANNEL_CLOSED                          0xC2
638 
639 // data: event(8), len(8), bnep source uuid (16), bnep destination uuid (16), remote_address (48), channel state (8)
640 #define BNEP_EVENT_CHANNEL_TIMEOUT                         0xC3
641 
642 // data: event(8), len(8)
643 #define BNEP_EVENT_READY_TO_SEND                           0xC4
644 
645  /**
646   * @format H1B
647   * @param handle
648   * @param addr_type
649   * @param address
650   */
651 #define SM_EVENT_JUST_WORKS_REQUEST                              0xD0
652 
653  /**
654   * @format H1B
655   * @param handle
656   * @param addr_type
657   * @param address
658   */
659 #define SM_EVENT_JUST_WORKS_CANCEL                               0xD1
660 
661  /**
662   * @format H1B4
663   * @param handle
664   * @param addr_type
665   * @param address
666   * @param passkey
667   */
668 #define SM_EVENT_PASSKEY_DISPLAY_NUMBER                          0xD2
669 
670  /**
671   * @format H1B
672   * @param handle
673   * @param addr_type
674   * @param address
675   */
676 #define SM_EVENT_PASSKEY_DISPLAY_CANCEL                          0xD3
677 
678  /**
679   * @format H1B421
680   * @param handle
681   * @param addr_type
682   * @param address
683   */
684 #define SM_EVENT_PASSKEY_INPUT_NUMBER                            0xD4
685 
686  /**
687   * @format H1B
688   * @param handle
689   * @param addr_type
690   * @param address
691   */
692 #define SM_EVENT_PASSKEY_INPUT_CANCEL                            0xD5
693 
694  /**
695   * @format H1B
696   * @param handle
697   * @param addr_type
698   * @param address
699   */
700 #define SM_EVENT_IDENTITY_RESOLVING_STARTED                      0xD6
701 
702  /**
703   * @format H1B
704   * @param handle
705   * @param addr_type
706   * @param address
707   */
708 #define SM_EVENT_IDENTITY_RESOLVING_FAILED                       0xD7
709 
710  /**
711   * @format H1B2
712   * @param handle
713   * @param addr_type
714   * @param address
715   * @param le_device_db_index
716   */
717 #define SM_EVENT_IDENTITY_RESOLVING_SUCCEEDED                    0xD8
718 
719  /**
720   * @format H1B
721   * @param handle
722   * @param addr_type
723   * @param address
724   */
725 #define SM_EVENT_AUTHORIZATION_REQUEST                           0xD9
726 
727  /**
728   * @format H1B1
729   * @param handle
730   * @param addr_type
731   * @param address
732   * @param authorization_result
733   */
734 #define SM_EVENT_AUTHORIZATION_RESULT                            0xDA
735 
736 // GAP
737 
738 // data: event(8), len(8), hci_handle (16), security_level (8)
739 #define GAP_EVENT_SECURITY_LEVEL                                 0xE0
740 
741 // data: event(8), len(8), status (8), bd_addr(48)
742 #define GAP_EVENT_DEDICATED_BONDING_COMPLETED                    0xE1
743 
744 /**
745  * @format 11B1JV
746  * @param advertising_event_type
747  * @param address_type
748  * @param address
749  * @param rssi
750  * @param data_length
751  * @param data
752  */
753 #define GAP_LE_EVENT_ADVERTISING_REPORT                          0xE2
754 
755 
756 // Meta Events, see below for sub events
757 #define HCI_EVENT_HSP_META                                 0xE8
758 #define HCI_EVENT_HFP_META                                 0xE9
759 #define HCI_EVENT_ANCS_META                                0xEA
760 
761 // Potential other meta groups
762  // #define HCI_EVENT_BNEP_META                                0xxx
763 // #define HCI_EVENT_GAP_META                                 0xxx
764 // #define HCI_EVENT_GATT_META                                0xxx
765 // #define HCI_EVENT_PAN_META                                 0xxx
766 // #define HCI_EVENT_SDP_META                                 0xxx
767 // #define HCI_EVENT_SM_META                                  0xxx
768 
769 
770 /** HSP Subevent */
771 
772 /**
773  * @format 11
774  * @param subevent_code
775  * @param status 0 == OK
776  */
777 #define HSP_SUBEVENT_AUDIO_CONNECTION_COMPLETE             0x01
778 
779 /**
780  * @format 11
781  * @param subevent_code
782  * @param status 0 == OK
783  */
784 #define HSP_SUBEVENT_AUDIO_DISCONNECTION_COMPLETE          0x02
785 
786 /**
787  * @format 1
788  * @param subevent_code
789  */
790 #define HSP_SUBEVENT_RING                                  0x03
791 
792 /**
793  * @format 11
794  * @param subevent_code
795  * @param gain Valid range: [0,15]
796  */
797 #define HSP_SUBEVENT_MICROPHONE_GAIN_CHANGED               0x04
798 
799 /**
800  * @format 11
801  * @param subevent_code
802  * @param gain Valid range: [0,15]
803  */
804 #define HSP_SUBEVENT_SPEAKER_GAIN_CHANGED                  0x05
805 
806 /**
807  * @format 1JV
808  * @param subevent_code
809  * @param value_length
810  * @param value
811  */
812 #define HSP_SUBEVENT_HS_COMMAND                            0x06
813 
814 /**
815  * @format 1JV
816  * @param subevent_code
817  * @param value_length
818  * @param value
819  */
820 #define HSP_SUBEVENT_AG_INDICATION                         0x07
821 
822 
823 /** HFP Subevent */
824 
825 /**
826  * @format 11
827  * @param subevent_code
828  * @param status 0 == OK
829  */
830 #define HFP_SUBEVENT_SERVICE_LEVEL_CONNECTION_ESTABLISHED  0x01
831 
832 /**
833  * @format 1
834  * @param subevent_code
835  */
836 #define HFP_SUBEVENT_SERVICE_LEVEL_CONNECTION_RELEASED     0x02
837 
838 /**
839  * @format 11
840  * @param subevent_code
841  * @param status 0 == OK
842  */
843 #define HFP_SUBEVENT_AUDIO_CONNECTION_ESTABLISHED          0x03
844 
845 /**
846  * @format 1
847  * @param subevent_code
848  */
849 #define HFP_SUBEVENT_AUDIO_CONNECTION_RELEASED             0x04
850 
851 /**
852  * @format 11
853  * @param subevent_code
854  * @param status 0 == OK
855  */
856 #define HFP_SUBEVENT_COMPLETE                              0x05
857 
858 /**
859  * @format 111T
860  * @param subevent_code
861  * @param indicator_index
862  * @param indicator_status
863  * @param indicator_name
864  */
865 #define HFP_SUBEVENT_AG_INDICATOR_STATUS_CHANGED           0x06
866 
867 /**
868  * @format 1111T
869  * @param subevent_code
870  * @param network_operator_mode
871  * @param network_operator_format
872  * @param network_operator_name
873  */
874 #define HFP_SUBEVENT_NETWORK_OPERATOR_CHANGED              0x07
875 
876 /**
877  * @format 11
878  * @param subevent_code
879  * @param error
880  */
881 #define HFP_SUBEVENT_EXTENDED_AUDIO_GATEWAY_ERROR             0x08
882 
883 /**
884  * @format 11
885  * @param subevent_code
886  * @param status
887  */
888 #define HFP_SUBEVENT_CODECS_CONNECTION_COMPLETE               0x09
889 
890 /**
891  * @format 1
892  * @param subevent_code
893  */
894 #define HFP_SUBEVENT_START_RINGINIG                           0x0A
895 
896 /**
897  * @format 1
898  * @param subevent_code
899  */
900 #define HFP_SUBEVENT_STOP_RINGINIG                            0x0B
901 
902 /**
903  * @format 1
904  * @param subevent_code
905  */
906 #define HFP_SUBEVENT_CALL_TERMINATED                          0x0C
907 
908 /**
909  * @format 1T
910  * @param subevent_code
911  * @param number
912  */
913 #define HFP_SUBEVENT_PLACE_CALL_WITH_NUMBER                   0x0D
914 
915 /**
916  * @format 1
917  * @param subevent_code
918  */
919 #define HFP_SUBEVENT_ATTACH_NUMBER_TO_VOICE_TAG               0x0E
920 
921 /**
922  * @format 1T
923  * @param subevent_code
924  * @param number
925  */
926 #define HFP_SUBEVENT_NUMBER_FOR_VOICE_TAG                     0x0F
927 
928 /**
929  * @format 1T
930  * @param subevent_code
931  * @param dtmf code
932  */
933 #define HFP_SUBEVENT_TRANSMIT_DTMF_CODES                      0x10
934 
935 /**
936  * @format 1
937  * @param subevent_code
938  */
939  #define HFP_SUBEVENT_CALL_ANSWERED                            0x11
940 
941 /**
942  * @format 1
943  * @param subevent_code
944  */
945 #define HFP_SUBEVENT_CONFERENCE_CALL                          0x12
946 
947 /**
948  * @format 1
949  * @param subevent_code
950  */
951 #define HFP_SUBEVENT_RING                                     0x13
952 
953 /**
954  * @format 111
955  * @param subevent_code
956  * @param status
957  * @param gain
958  */
959  #define HFP_SUBEVENT_SPEAKER_VOLUME                           0x14
960 
961 /**
962  * @format 111
963  * @param subevent_code
964  * @param status
965  * @param gain
966  */
967 #define HFP_SUBEVENT_MICROPHONE_VOLUME                        0x15
968 
969 /**
970  * @format 11T
971  * @param subevent_code
972  * @param type
973  * @param number
974  */
975 #define HFP_SUBEVENT_CALL_WAITING_NOTIFICATION                0x16
976 
977 /**
978  * @format 11T
979  * @param subevent_code
980  * @param type
981  * @param number
982  */
983 #define HFP_SUBEVENT_CALLING_LINE_INDETIFICATION_NOTIFICATION 0x17
984 
985 /**
986  * @format 111111T
987  * @param subevent_code
988  * @param clcc_idx
989  * @param clcc_dir
990  * @param clcc_status
991  * @param clcc_mpty
992  * @param bnip_type
993  * @param bnip_number
994  */
995 #define HFP_SUBEVENT_ENHANCED_CALL_STATUS                     0x18
996 
997 /**
998  * @format 111T
999  * @param subevent_code
1000  * @param status
1001  * @param bnip_type
1002  * @param bnip_number
1003  */
1004  #define HFP_SUBEVENT_SUBSCRIBER_NUMBER_INFORMATION            0x19
1005 
1006 /**
1007  * @format 1T
1008  * @param subevent_code
1009  * @param value
1010  */
1011 #define HFP_SUBEVENT_RESPONSE_AND_HOLD_STATUS                 0x1A
1012 
1013 // ANCS Client
1014 
1015 /**
1016  * @format 1H
1017  * @param subevent_code
1018  * @param handle
1019  */
1020 #define ANCS_SUBEVENT_CLIENT_CONNECTED                              0xF0
1021 
1022 /**
1023  * @format 1H2T
1024  * @param subevent_code
1025  * @param handle
1026  * @param attribute_id
1027  * @param text
1028  */
1029 #define ANCS_SUBEVENT_CLIENT_NOTIFICATION                           0xF1
1030 
1031 /**
1032  * @format 1H
1033  * @param subevent_code
1034  * @param handle
1035  */
1036 #define ANCS_SUBEVENT_CLIENT_DISCONNECTED                           0xF2
1037 
1038 #endif
1039