xref: /btstack/src/bluetooth.h (revision 1bf28f67a5f7e94bb05e16aae80e8013e969eac0)
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  * bluetooth.h
40  *
41  * Numbers defined or derived from the official Bluetooth specification
42  */
43 
44 #ifndef __BLUETOOTH_H
45 #define __BLUETOOTH_H
46 
47 #include <stdint.h>
48 
49 /**
50  * @brief hci connection handle type
51  */
52 typedef uint16_t hci_con_handle_t;
53 
54 /**
55  * @brief Length of a bluetooth device address.
56  */
57 #define BD_ADDR_LEN 6
58 
59 /**
60  * @brief Bluetooth address
61  */
62 typedef uint8_t bd_addr_t[BD_ADDR_LEN];
63 
64 /**
65  * Address types
66  * @note: BTstack uses a custom addr type to refer to classic ACL and SCO devices
67  */
68  typedef enum {
69     BD_ADDR_TYPE_LE_PUBLIC = 0,
70     BD_ADDR_TYPE_LE_RANDOM = 1,
71     BD_ADDR_TYPE_SCO       = 0xfe,
72     BD_ADDR_TYPE_CLASSIC   = 0xff,
73     BD_ADDR_TYPE_UNKNOWN   = 0xfe
74 } bd_addr_type_t;
75 
76 /**
77  * @brief link key
78  */
79 #define LINK_KEY_LEN 16
80 #define LINK_KEY_STR_LEN (LINK_KEY_LEN*2)
81 typedef uint8_t link_key_t[LINK_KEY_LEN];
82 
83 /**
84  * @brief link key type
85  */
86 typedef enum {
87   COMBINATION_KEY = 0,  // standard pairing
88   LOCAL_UNIT_KEY,     // ?
89   REMOTE_UNIT_KEY,    // ?
90   DEBUG_COMBINATION_KEY,  // SSP with debug
91   UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192, // SSP Simple Pairing
92   AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192,   // SSP Passkey, Number confirm, OOB
93   CHANGED_COMBINATION_KEY,               // Link key changed using Change Connection Lnk Key
94   UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256, // SSP Simpe Pairing
95   AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256,   // SSP Passkey, Number confirm, OOB
96 } link_key_type_t;
97 
98 /**
99  * HCI Transport
100  */
101 
102 /**
103  * packet types - used in BTstack and over the H4 UART interface
104  */
105 #define HCI_COMMAND_DATA_PACKET 0x01
106 #define HCI_ACL_DATA_PACKET     0x02
107 #define HCI_SCO_DATA_PACKET     0x03
108 #define HCI_EVENT_PACKET        0x04
109 
110 // packet header sizes
111 #define HCI_CMD_HEADER_SIZE          3
112 #define HCI_ACL_HEADER_SIZE          4
113 #define HCI_SCO_HEADER_SIZE          3
114 #define HCI_EVENT_HEADER_SIZE        2
115 
116 /**
117  * HCI Layer
118  */
119 
120 //
121 // Error Codes
122 //
123 
124 // from Bluetooth Core Specification
125 #define ERROR_CODE_SUCCESS                                 0x00
126 #define ERROR_CODE_UNKNOWN_HCI_COMMAND                     0x01
127 #define ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER           0x02
128 #define ERROR_CODE_HARDWARE_FAILURE                        0x03
129 #define ERROR_CODE_PAGE_TIMEOUT                            0x04
130 #define ERROR_CODE_AUTHENTICATION_FAILURE                  0x05
131 #define ERROR_CODE_PIN_OR_KEY_MISSING                      0x06
132 #define ERROR_CODE_MEMORY_CAPACITY_EXCEEDED                0x07
133 #define ERROR_CODE_CONNECTION_TIMEOUT                      0x08
134 #define ERROR_CODE_CONNECTION_LIMIT_EXCEEDED               0x09
135 #define ERROR_CODE_SYNCHRONOUS_CONNECTION_LIMIT_TO_A_DEVICE_EXCEEDED  0x0A
136 #define ERROR_CODE_ACL_CONNECTION_ALREADY_EXISTS           0x0B
137 #define ERROR_CODE_COMMAND_DISALLOWED                      0x0C
138 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_LIMITED_RESOURCES 0x0D
139 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_SECURITY_REASONS  0x0E
140 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_UNACCEPTABLE_BD_ADDR 0x0F
141 #define ERROR_CODE_CONNECTION_ACCEPT_TIMEOUT_EXCEEDED      0x10
142 #define ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE  0x11
143 #define ERROR_CODE_INVALID_HCI_COMMAND_PARAMETERS          0x12
144 #define ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION       0x13
145 #define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_LOW_RESOURCES 0x14
146 #define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_POWER_OFF     0x15
147 #define ERROR_CODE_CONNECTION_TERMINATED_BY_LOCAL_HOST     0x16
148 #define ERROR_CODE_REPEATED_ATTEMPTS                       0x17
149 #define ERROR_CODE_PAIRING_NOT_ALLOWED                     0x18
150 #define ERROR_CODE_UNKNOWN_LMP_PDU                         0x19
151 #define ERROR_CODE_UNSUPPORTED_REMOTE_FEATURE_UNSUPPORTED_LMP_FEATURE 0x1A
152 #define ERROR_CODE_SCO_OFFSET_REJECTED                     0x1B
153 #define ERROR_CODE_SCO_INTERVAL_REJECTED                   0x1C
154 #define ERROR_CODE_SCO_AIR_MODE_REJECTED                   0x1D
155 #define ERROR_CODE_INVALID_LMP_PARAMETERS_INVALID_LL_PARAMETERS 0x1E
156 #define ERROR_CODE_UNSPECIFIED_ERROR                       0x1F
157 #define ERROR_CODE_UNSUPPORTED_LMP_PARAMETER_VALUE_UNSUPPORTED_LL_PARAMETER_VALUE 0x20
158 #define ERROR_CODE_ROLE_CHANGE_NOT_ALLOWED                 0x21
159 #define ERROR_CODE_LMP_RESPONSE_TIMEOUT_LL_RESPONSE_TIMEOUT 0x22
160 #define ERROR_CODE_LMP_ERROR_TRANSACTION_COLLISION         0x23
161 #define ERROR_CODE_LMP_PDU_NOT_ALLOWED                     0x24
162 #define ERROR_CODE_ENCRYPTION_MODE_NOT_ACCEPTABLE          0x25
163 #define ERROR_CODE_LINK_KEY_CANNOT_BE_CHANGED              0x26
164 #define ERROR_CODE_REQUESTED_QOS_NOT_SUPPORTED             0x27
165 #define ERROR_CODE_INSTANT_PASSED                          0x28
166 #define ERROR_CODE_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED     0x29
167 #define ERROR_CODE_DIFFERENT_TRANSACTION_COLLISION         0x2A
168 #define ERROR_CODE_RESERVED                                0x2B
169 #define ERROR_CODE_QOS_UNACCEPTABLE_PARAMETER              0x2C
170 #define ERROR_CODE_QOS_REJECTED                            0x2D
171 #define ERROR_CODE_CHANNEL_CLASSIFICATION_NOT_SUPPORTED    0x2E
172 #define ERROR_CODE_INSUFFICIENT_SECURITY                   0x2F
173 #define ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE        0x30
174 // #define ERROR_CODE_RESERVED
175 #define ERROR_CODE_ROLE_SWITCH_PENDING                     0x32
176 // #define ERROR_CODE_RESERVED
177 #define ERROR_CODE_RESERVED_SLOT_VIOLATION                 0x34
178 #define ERROR_CODE_ROLE_SWITCH_FAILED                      0x35
179 #define ERROR_CODE_EXTENDED_INQUIRY_RESPONSE_TOO_LARGE     0x36
180 #define ERROR_CODE_SECURE_SIMPLE_PAIRING_NOT_SUPPORTED_BY_HOST 0x37
181 #define ERROR_CODE_HOST_BUSY_PAIRING                       0x38
182 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_NO_SUITABLE_CHANNEL_FOUND 0x39
183 #define ERROR_CODE_CONTROLLER_BUSY                         0x3A
184 #define ERROR_CODE_UNACCEPTABLE_CONNECTION_PARAMETERS      0x3B
185 #define ERROR_CODE_DIRECTED_ADVERTISING_TIMEOUT            0x3C
186 #define ERROR_CODE_CONNECTION_TERMINATED_DUE_TO_MIC_FAILURE 0x3D
187 #define ERROR_CODE_CONNECTION_FAILED_TO_BE_ESTABLISHED     0x3E
188 #define ERROR_CODE_MAC_CONNECTION_FAILED                   0x3F
189 #define ERROR_CODE_COARSE_CLOCK_ADJUSTMENT_REJECTED_BUT_WILL_TRY_TO_ADJUST_USING_CLOCK_DRAGGING 0x40
190 
191 // HCI roles
192 #define HCI_ROLE_MASTER 0
193 #define HCI_ROLE_SLAVE  1
194 
195 // packet sizes (max payload)
196 #define HCI_ACL_DM1_SIZE            17
197 #define HCI_ACL_DH1_SIZE            27
198 #define HCI_ACL_2DH1_SIZE           54
199 #define HCI_ACL_3DH1_SIZE           83
200 #define HCI_ACL_DM3_SIZE           121
201 #define HCI_ACL_DH3_SIZE           183
202 #define HCI_ACL_DM5_SIZE           224
203 #define HCI_ACL_DH5_SIZE           339
204 #define HCI_ACL_2DH3_SIZE          367
205 #define HCI_ACL_3DH3_SIZE          552
206 #define HCI_ACL_2DH5_SIZE          679
207 #define HCI_ACL_3DH5_SIZE         1021
208 
209 #define HCI_EVENT_PAYLOAD_SIZE     255
210 #define HCI_CMD_PAYLOAD_SIZE       255
211 
212 #define LE_ADVERTISING_DATA_SIZE    31
213 
214 /**
215  * Default INQ Mode
216  */
217 #define HCI_INQUIRY_LAP 0x9E8B33L  // 0x9E8B33: General/Unlimited Inquiry Access Code (GIAC)
218 
219 /**
220  * SSP IO Capabilities
221  */
222 #define SSP_IO_CAPABILITY_DISPLAY_ONLY   0
223 #define SSP_IO_CAPABILITY_DISPLAY_YES_NO 1
224 #define SSP_IO_CAPABILITY_KEYBOARD_ONLY  2
225 #define SSP_IO_CAPABILITY_NO_INPUT_NO_OUTPUT 3
226 #define SSP_IO_CAPABILITY_UNKNOWN 0xff
227 
228 
229 /**
230  * SSP Authentication Requirements, see IO Capability Request Reply Commmand
231  */
232 
233 // Numeric comparison with automatic accept allowed.
234 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_NO_BONDING 0x00
235 
236 // Use IO Capabilities to deter- mine authentication procedure
237 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_NO_BONDING 0x01
238 
239 // Numeric compar- ison with automatic accept allowed.
240 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_DEDICATED_BONDING 0x02
241 
242 // Use IO Capabilities to determine authentication procedure
243 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_DEDICATED_BONDING 0x03
244 
245 // Numeric Compari- son with automatic accept allowed.
246 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_GENERAL_BONDING 0x04
247 
248 // Use IO capabilities to determine authentication procedure.
249 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_GENERAL_BONDING 0x05
250 
251 
252 // OGFs
253 #define OGF_LINK_CONTROL          0x01
254 #define OGF_LINK_POLICY           0x02
255 #define OGF_CONTROLLER_BASEBAND   0x03
256 #define OGF_INFORMATIONAL_PARAMETERS 0x04
257 #define OGF_STATUS_PARAMETERS     0x05
258 #define OGF_TESTING               0x06
259 #define OGF_LE_CONTROLLER 0x08
260 #define OGF_VENDOR  0x3f
261 
262 
263 // Events from host controller to host
264 
265 /**
266  * @format 1
267  * @param status
268  */
269 #define HCI_EVENT_INQUIRY_COMPLETE                         0x01
270 // no format yet, can contain multiple results
271 
272 /**
273  * @format 1B11132
274  * @param num_responses
275  * @param bd_addr
276  * @param page_scan_repetition_mode
277  * @param reserved1
278  * @param reserved2
279  * @param class_of_device
280  * @param clock_offset
281  */
282 #define HCI_EVENT_INQUIRY_RESULT                           0x02
283 
284 /**
285  * @format 12B11
286  * @param status
287  * @param connection_handle
288  * @param bd_addr
289  * @param link_type
290  * @param encryption_enabled
291  */
292 #define HCI_EVENT_CONNECTION_COMPLETE                      0x03
293 /**
294  * @format B31
295  * @param bd_addr
296  * @param class_of_device
297  * @param link_type
298  */
299 #define HCI_EVENT_CONNECTION_REQUEST                       0x04
300 /**
301  * @format 121
302  * @param status
303  * @param connection_handle
304  * @param reason
305  */
306 #define HCI_EVENT_DISCONNECTION_COMPLETE                   0x05
307 /**
308  * @format 12
309  * @param status
310  * @param connection_handle
311  */
312 #define HCI_EVENT_AUTHENTICATION_COMPLETE_EVENT            0x06
313 /**
314  * @format 1BN
315  * @param status
316  * @param bd_addr
317  * @param remote_name
318  */
319 #define HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE             0x07
320 /**
321  * @format 121
322  * @param status
323  * @param connection_handle
324  * @param encryption_enabled
325  */
326 #define HCI_EVENT_ENCRYPTION_CHANGE                        0x08
327 /**
328  * @format 12
329  * @param status
330  * @param connection_handle
331  */
332 #define HCI_EVENT_CHANGE_CONNECTION_LINK_KEY_COMPLETE      0x09
333 /**
334  * @format 121
335  * @param status
336  * @param connection_handle
337  * @param key_flag
338  */
339 #define HCI_EVENT_MASTER_LINK_KEY_COMPLETE                 0x0A
340 #define HCI_EVENT_READ_REMOTE_SUPPORTED_FEATURES_COMPLETE  0x0B
341 #define HCI_EVENT_READ_REMOTE_VERSION_INFORMATION_COMPLETE 0x0C
342 #define HCI_EVENT_QOS_SETUP_COMPLETE                       0x0D
343 
344 /**
345  * @format 12R
346  * @param num_hci_command_packets
347  * @param command_opcode
348  * @param return_parameters
349  */
350 #define HCI_EVENT_COMMAND_COMPLETE                         0x0E
351 /**
352  * @format 112
353  * @param status
354  * @param num_hci_command_packets
355  * @param command_opcode
356  */
357 #define HCI_EVENT_COMMAND_STATUS                           0x0F
358 
359 /**
360  * @format 121
361  * @param hardware_code
362  */
363 #define HCI_EVENT_HARDWARE_ERROR                           0x10
364 
365 #define HCI_EVENT_FLUSH_OCCURED                            0x11
366 
367 /**
368  * @format 1B1
369  * @param status
370  * @param bd_addr
371  * @param role
372  */
373 #define HCI_EVENT_ROLE_CHANGE                              0x12
374 
375 // TODO: number_of_handles 1, connection_handle[H*i], hc_num_of_completed_packets[2*i]
376 #define HCI_EVENT_NUMBER_OF_COMPLETED_PACKETS              0x13
377 
378 /**
379  * @format 1H12
380  * @param status
381  * @param handle
382  * @param mode
383  * @param interval
384  */
385 #define HCI_EVENT_MODE_CHANGE_EVENT                        0x14
386 
387 // TODO: num_keys, bd_addr[B*i], link_key[16 octets * i]
388 #define HCI_EVENT_RETURN_LINK_KEYS                         0x15
389 
390 /**
391  * @format B
392  * @param bd_addr
393  */
394 #define HCI_EVENT_PIN_CODE_REQUEST                         0x16
395 
396 /**
397  * @format B
398  * @param bd_addr
399  */
400 #define HCI_EVENT_LINK_KEY_REQUEST                         0x17
401 
402 // TODO: bd_addr B, link_key 16octets, key_type 1
403 #define HCI_EVENT_LINK_KEY_NOTIFICATION                    0x18
404 
405 /**
406  * @format 1
407  * @param link_type
408  */
409 #define HCI_EVENT_DATA_BUFFER_OVERFLOW                     0x1A
410 
411 /**
412  * @format H1
413  * @param handle
414  * @param lmp_max_slots
415  */
416 #define HCI_EVENT_MAX_SLOTS_CHANGED                        0x1B
417 
418 /**
419  * @format 1H2
420  * @param status
421  * @param handle
422  * @param clock_offset
423  */
424 #define HCI_EVENT_READ_CLOCK_OFFSET_COMPLETE               0x1C
425 
426 /**
427  * @format 1H2
428  * @param status
429  * @param handle
430  * @param packet_types
431  * @pnote packet_type is in plural to avoid clash with Java binding Packet.getPacketType()
432  */
433 #define HCI_EVENT_CONNECTION_PACKET_TYPE_CHANGED           0x1D
434 
435 /**
436  * @format 1B11321
437  * @param num_responses
438  * @param bd_addr
439  * @param page_scan_repetition_mode
440  * @param reserved
441  * @param class_of_device
442  * @param clock_offset
443  * @param rssi
444  */
445 #define HCI_EVENT_INQUIRY_RESULT_WITH_RSSI                 0x22
446 
447 /**
448  * @format 1HB111221
449  * @param status
450  * @param handle
451  * @param bd_addr
452  * @param link_type
453  * @param transmission_interval
454  * @param retransmission_interval
455  * @param rx_packet_length
456  * @param tx_packet_length
457  * @param air_mode
458  */
459 #define HCI_EVENT_SYNCHRONOUS_CONNECTION_COMPLETE          0x2C
460 
461 // TODO: serialize extended_inquiry_response and provide parser
462 /**
463  * @format 1B11321
464  * @param num_responses
465  * @param bd_addr
466  * @param page_scan_repetition_mode
467  * @param reserved
468  * @param class_of_device
469  * @param clock_offset
470  * @param rssi
471  */
472 #define HCI_EVENT_EXTENDED_INQUIRY_RESPONSE                0x2F
473 
474  /**
475   * @format 1H
476   * @param status
477   * @param handle
478   */
479 #define HCI_EVENT_ENCRYPTION_KEY_REFRESH_COMPLETE          0x30
480 
481 #define HCI_EVENT_IO_CAPABILITY_REQUEST                    0x31
482 #define HCI_EVENT_IO_CAPABILITY_RESPONSE                   0x32
483 #define HCI_EVENT_USER_CONFIRMATION_REQUEST                0x33
484 #define HCI_EVENT_USER_PASSKEY_REQUEST                     0x34
485 #define HCI_EVENT_REMOTE_OOB_DATA_REQUEST                  0x35
486 #define HCI_EVENT_SIMPLE_PAIRING_COMPLETE                  0x36
487 
488 #define HCI_EVENT_LE_META                                  0x3E
489 
490 #define HCI_EVENT_VENDOR_SPECIFIC                          0xFF
491 
492 /**
493  * @format 11H11B2221
494  * @param subevent_code
495  * @param status
496  * @param connection_handle
497  * @param role
498  * @param peer_address_type
499  * @param peer_address
500  * @param conn_interval
501  * @param conn_latency
502  * @param supervision_timeout
503  * @param master_clock_accuracy
504  */
505 #define HCI_SUBEVENT_LE_CONNECTION_COMPLETE                0x01
506 #define HCI_SUBEVENT_LE_ADVERTISING_REPORT                 0x02
507 #define HCI_SUBEVENT_LE_CONNECTION_UPDATE_COMPLETE         0x03
508 #define HCI_SUBEVENT_LE_READ_REMOTE_USED_FEATURES_COMPLETE 0x04
509 #define HCI_SUBEVENT_LE_LONG_TERM_KEY_REQUEST              0x05
510 
511 // last used HCI_EVENT in 2.1 is 0x3d
512 // last used HCI_EVENT in 4.1 is 0x57
513 
514 /**
515  * L2CAP Layer
516  */
517 
518 #define L2CAP_HEADER_SIZE 4
519 
520 #define L2CAP_SIG_ID_INVALID 0
521 
522 // size of HCI ACL + L2CAP Header for regular data packets (8)
523 #define COMPLETE_L2CAP_HEADER (HCI_ACL_HEADER_SIZE + L2CAP_HEADER_SIZE)
524 
525 // minimum signaling MTU
526 #define L2CAP_MINIMAL_MTU 48
527 #define L2CAP_DEFAULT_MTU 672
528 
529 // Minimum/default MTU
530 #define L2CAP_LE_DEFAULT_MTU  23
531 
532 // L2CAP Fixed Channel IDs
533 #define L2CAP_CID_SIGNALING                 0x0001
534 #define L2CAP_CID_CONNECTIONLESS_CHANNEL    0x0002
535 #define L2CAP_CID_ATTRIBUTE_PROTOCOL        0x0004
536 #define L2CAP_CID_SIGNALING_LE              0x0005
537 #define L2CAP_CID_SECURITY_MANAGER_PROTOCOL 0x0006
538 
539 // L2CAP Configuration Result Codes
540 #define L2CAP_CONF_RESULT_UNKNOWN_OPTIONS   0x0003
541 
542 // L2CAP Reject Result Codes
543 #define L2CAP_REJ_CMD_UNKNOWN               0x0000
544 
545 // Response Timeout eXpired
546 #define L2CAP_RTX_TIMEOUT_MS   10000
547 
548 // Extended Response Timeout eXpired
549 #define L2CAP_ERTX_TIMEOUT_MS 120000
550 
551 // Fixed PSM numbers
552 #define PSM_SDP           0x01
553 #define PSM_RFCOMM        0x03
554 #define PSM_BNEP          0x0F
555 #define PSM_HID_CONTROL   0x11
556 #define PSM_HID_INTERRUPT 0x13
557 
558 /**
559  * SDP Protocl
560  */
561 
562  // PDU Types
563 typedef enum {
564     SDP_Invalid = 0,
565     SDP_ErrorResponse = 1,
566     SDP_ServiceSearchRequest,
567     SDP_ServiceSearchResponse,
568     SDP_ServiceAttributeRequest,
569     SDP_ServiceAttributeResponse,
570     SDP_ServiceSearchAttributeRequest,
571     SDP_ServiceSearchAttributeResponse
572 } SDP_PDU_ID_t;
573 
574 // UNIVERSAL ATTRIBUTE DEFINITIONS
575 #define SDP_ServiceRecordHandle     0x0000
576 #define SDP_ServiceClassIDList      0x0001
577 #define SDP_ServiceRecordState      0x0002
578 #define SDP_ServiceID               0x0003
579 #define SDP_ProtocolDescriptorList  0x0004
580 #define SDP_BrowseGroupList         0x0005
581 #define SDP_LanguageBaseAttributeIDList 0x0006
582 #define SDP_ServiceInfoTimeToLive   0x0007
583 #define SDP_ServiceAvailability     0x0008
584 #define SDP_BluetoothProfileDescriptorList 0x0009
585 #define SDP_DocumentationURL        0x000a
586 #define SDP_ClientExecutableURL     0x000b
587 #define SDP_IconURL                 0x000c
588 #define SDP_AdditionalProtocolDescriptorList 0x000d
589 #define SDP_SupportedFormatsList    0x0303
590 
591 // SERVICE CLASSES
592 #define SDP_OBEXObjectPush          0x1105
593 #define SDP_OBEXFileTransfer        0x1106
594 #define SDP_PublicBrowseGroup       0x1002
595 #define SDP_HSP                     0x1108
596 #define SDP_Headset_AG              0x1112
597 #define SDP_PANU                    0x1115
598 #define SDP_NAP                     0x1116
599 #define SDP_GN                      0x1117
600 #define SDP_Handsfree               0x111E
601 #define SDP_HandsfreeAudioGateway   0x111F
602 #define SDP_Headset_HS              0x1131
603 #define SDP_GenericAudio            0x1203
604 
605 
606 // PROTOCOLS
607 #define SDP_SDPProtocol       0x0001
608 #define SDP_UDPProtocol       0x0002
609 #define SDP_RFCOMMProtocol    0x0003
610 #define SDP_OBEXProtocol      0x0008
611 #define SDP_L2CAPProtocol     0x0100
612 #define SDP_BNEPProtocol      0x000F
613 #define SDP_AVDTPProtocol     0x0019
614 
615 // OFFSETS FOR LOCALIZED ATTRIBUTES - SDP_LanguageBaseAttributeIDList
616 #define SDP_Offest_ServiceName      0x0000
617 #define SDP_Offest_ServiceDescription 0x0001
618 #define SDP_Offest_ProviderName     0x0002
619 
620 // OBEX
621 #define SDP_vCard_2_1       0x01
622 #define SDP_vCard_3_0       0x02
623 #define SDP_vCal_1_0        0x03
624 #define SDP_iCal_2_0        0x04
625 #define SDP_vNote           0x05
626 #define SDP_vMessage        0x06
627 #define SDP_OBEXFileTypeAny 0xFF
628 
629 /**
630  * RFCOMM Protocol
631  */
632 
633 // Control field values      bit no.       1 2 3 4 PF 6 7 8
634 #define BT_RFCOMM_SABM       0x3F       // 1 1 1 1  1 1 0 0
635 #define BT_RFCOMM_UA         0x73       // 1 1 0 0  1 1 1 0
636 #define BT_RFCOMM_DM         0x0F       // 1 1 1 1  0 0 0 0
637 #define BT_RFCOMM_DM_PF      0x1F       // 1 1 1 1  1 0 0 0
638 #define BT_RFCOMM_DISC       0x53       // 1 1 0 0  1 0 1 0
639 #define BT_RFCOMM_UIH        0xEF       // 1 1 1 1  0 1 1 1
640 #define BT_RFCOMM_UIH_PF     0xFF       // 1 1 1 1  0 1 1 1
641 
642 // Multiplexer message types
643 #define BT_RFCOMM_CLD_CMD    0xC3
644 #define BT_RFCOMM_FCON_CMD   0xA3
645 #define BT_RFCOMM_FCON_RSP   0xA1
646 #define BT_RFCOMM_FCOFF_CMD  0x63
647 #define BT_RFCOMM_FCOFF_RSP  0x61
648 #define BT_RFCOMM_MSC_CMD    0xE3
649 #define BT_RFCOMM_MSC_RSP    0xE1
650 #define BT_RFCOMM_NSC_RSP    0x11
651 #define BT_RFCOMM_PN_CMD     0x83
652 #define BT_RFCOMM_PN_RSP     0x81
653 #define BT_RFCOMM_RLS_CMD    0x53
654 #define BT_RFCOMM_RLS_RSP    0x51
655 #define BT_RFCOMM_RPN_CMD    0x93
656 #define BT_RFCOMM_RPN_RSP    0x91
657 #define BT_RFCOMM_TEST_CMD   0x23
658 #define BT_RFCOMM_TEST_RSP   0x21
659 
660 // Line Status
661 #define LINE_STATUS_NO_ERROR       0x00
662 #define LINE_STATUS_OVERRUN_ERROR  0x03
663 #define LINE_STATUS_PARITY_ERORR   0x05
664 #define LINE_STATUS_FRAMING_ERROR  0x09
665 
666 // Modem Status Flags
667 #define MODEM_STATUS_FC   0x02
668 #define MODEM_STATUS_RTC  0x04
669 #define MODEM_STATUS_RTR  0x08
670 #define MODEM_STATUS_IC   0x40
671 #define MODEM_STATUS_DV   0x80
672 
673 typedef enum rpn_baud {
674     RPN_BAUD_2400 = 0,
675     RPN_BAUD_4800,
676     RPN_BAUD_7200,
677     RPN_BAUD_9600,
678     RPN_BAUD_19200,
679     RPN_BAUD_38400,
680     RPN_BAUD_57600,
681     RPN_BAUD_115200,
682     RPN_BAUD_230400
683 } rpn_baud_t;
684 
685 typedef enum rpn_data_bits {
686     RPN_DATA_BITS_5 = 0,
687     RPN_DATA_BITS_6 = 0,
688     RPN_DATA_BITS_7 = 0,
689     RPN_DATA_BITS_8 = 0
690 } rpn_data_bits_t;
691 
692 typedef enum rpn_stop_bits {
693     RPN_STOP_BITS_1_0 = 0,
694     RPN_STOP_BITS_1_5
695 } rpn_stop_bits_t;
696 
697 typedef enum rpn_parity {
698     RPN_PARITY_NONE  = 0,
699     RPN_PARITY_ODD   = 1,
700     RPN_PARITY_EVEN  = 3,
701     RPN_PARITY_MARK  = 5,
702     RPN_PARITY_SPACE = 7,
703 } rpn_parity_t;
704 
705 typedef enum rpn_flow_control {
706     RPN_FLOW_CONTROL_XONXOFF_ON_INPUT  = 1 << 0,
707     RPN_FLOW_CONTROL_XONXOFF_ON_OUTPUT = 1 << 1,
708     RPN_FLOW_CONTROL_RTR_ON_INPUT  = 1 << 2,
709     RPN_FLOW_CONTROL_RTR_ON_OUTPUT = 1 << 3,
710     RPN_FLOW_CONTROL_RTC_ON_INPUT  = 1 << 4,
711     RPN_FLOW_CONTROL_RTC_ON_OUTPUT = 1 << 5,
712 } rpn_flow_control_t;
713 
714 #define RPN_PARAM_MASK_0_BAUD             0x01
715 #define RPN_PARAM_MASK_0_DATA_BITS        0x02
716 #define RPN_PARAM_MASK_0_STOP_BITS        0x04
717 #define RPN_PARAM_MASK_0_PARITY           0x08
718 #define RPN_PARAM_MASK_0_PARITY_TYPE      0x10
719 #define RPN_PARAM_MASK_0_XON_CHAR         0x20
720 #define RPN_PARAM_MASK_0_XOFF_CHAR        0x40
721 #define RPN_PARAM_MASK_0_RESERVED         0x80
722 
723 // @note: values are identical to rpn_flow_control_t
724 #define RPN_PARAM_MASK_1_XONOFF_ON_INPUT  0x01
725 #define RPN_PARAM_MASK_1_XONOFF_ON_OUTPUT 0x02
726 #define RPN_PARAM_MASK_1_RTR_ON_INPUT     0x04
727 #define RPN_PARAM_MASK_1_RTR_ON_OUTPUT    0x08
728 #define RPN_PARAM_MASK_1_RTC_ON_INPUT     0x10
729 #define RPN_PARAM_MASK_1_RTC_ON_OUTPUT    0x20
730 #define RPN_PARAM_MASK_1_RESERVED_0       0x40
731 #define RPN_PARAM_MASK_1_RESERVED_1       0x80
732 
733 /**
734  * BNEP Protocol
735  */
736 
737 #ifndef ETHER_ADDR_LEN
738 #define ETHER_ADDR_LEN 6
739 #endif
740 
741 #ifndef ETHERTYPE_VLAN
742 #define ETHERTYPE_VLAN                                  0x8100 /* IEEE 802.1Q VLAN tag */
743 #endif
744 
745 #define BNEP_MTU_MIN                                    1691
746 
747 #define BNEP_EXT_FLAG                                   0x80
748 #define BNEP_TYPE_MASK                                  0x7F
749 #define BNEP_TYPE(header)                               ((header) & BNEP_TYPE_MASK)
750 #define BNEP_HEADER_HAS_EXT(x)                          (((x) & BNEP_EXT_FLAG) == BNEP_EXT_FLAG)
751 
752 /* BNEP packet types */
753 #define BNEP_PKT_TYPE_GENERAL_ETHERNET                  0x00
754 #define BNEP_PKT_TYPE_CONTROL                           0x01
755 #define BNEP_PKT_TYPE_COMPRESSED_ETHERNET               0x02
756 #define BNEP_PKT_TYPE_COMPRESSED_ETHERNET_SOURCE_ONLY   0x03
757 #define BNEP_PKT_TYPE_COMPRESSED_ETHERNET_DEST_ONLY     0x04
758 
759 /* BNEP control types */
760 #define BNEP_CONTROL_TYPE_COMMAND_NOT_UNDERSTOOD        0x00
761 #define BNEP_CONTROL_TYPE_SETUP_CONNECTION_REQUEST      0x01
762 #define BNEP_CONTROL_TYPE_SETUP_CONNECTION_RESPONSE     0x02
763 #define BNEP_CONTROL_TYPE_FILTER_NET_TYPE_SET           0x03
764 #define BNEP_CONTROL_TYPE_FILTER_NET_TYPE_RESPONSE      0x04
765 #define BNEP_CONTROL_TYPE_FILTER_MULTI_ADDR_SET         0x05
766 #define BNEP_CONTROL_TYPE_FILTER_MULTI_ADDR_RESPONSE    0x06
767 
768 /* BNEP extension header types */
769 #define BNEP_EXT_HEADER_TYPE_EXTENSION_CONTROL          0x00
770 
771 /* BNEP setup response codes */
772 #define BNEP_RESP_SETUP_SUCCESS                         0x0000
773 #define BNEP_RESP_SETUP_INVALID_DEST_UUID               0x0001
774 #define BNEP_RESP_SETUP_INVALID_SOURCE_UUID             0x0002
775 #define BNEP_RESP_SETUP_INVALID_SERVICE_UUID_SIZE       0x0003
776 #define BNEP_RESP_SETUP_CONNECTION_NOT_ALLOWED          0x0004
777 
778 /* BNEP filter response codes */
779 #define BNEP_RESP_FILTER_SUCCESS                        0x0000
780 #define BNEP_RESP_FILTER_UNSUPPORTED_REQUEST            0x0001
781 #define BNEP_RESP_FILTER_ERR_INVALID_RANGE              0x0002
782 #define BNEP_RESP_FILTER_ERR_TOO_MANY_FILTERS           0x0003
783 #define BNEP_RESP_FILTER_ERR_SECURITY                   0x0004
784 
785 /**
786  * PAN Profile
787  */
788 
789 typedef enum {
790     PANU_UUID = 0x1115,
791     NAP_UUID = 0x1116,
792     GN_UUID = 0x1117
793 } bnep_service_uuid_t;
794 
795 typedef enum {
796     BNEP_SECURITY_NONE = 0x0000,
797     BNEP_SECURITY_SERVICE_LEVEL_ENFORCED,
798     BNEP_SECURITY_802_1X
799 } security_description_t;
800 
801 typedef enum {
802     PAN_NET_ACCESS_TYPE_PSTN = 0x0000,
803     PAN_NET_ACCESS_TYPE_ISDN,
804     PAN_NET_ACCESS_TYPE_DSL,
805     PAN_NET_ACCESS_TYPE_CABLE_MODEM,
806     PAN_NET_ACCESS_TYPE_10MB_ETHERNET,
807     PAN_NET_ACCESS_TYPE_100MB_ETHERNET,
808     PAN_NET_ACCESS_TYPE_4MB_TOKEN_RING,
809     PAN_NET_ACCESS_TYPE_16MB_TOKEN_RING,
810     PAN_NET_ACCESS_TYPE_100MB_TOKEN_RING,
811     PAN_NET_ACCESS_TYPE_FDDI,
812     PAN_NET_ACCESS_TYPE_GSM,
813     PAN_NET_ACCESS_TYPE_CDMA,
814     PAN_NET_ACCESS_TYPE_GPRS,
815     PAN_NET_ACCESS_TYPE_3G,
816     PAN_NET_ACCESS_TYPE_CELULAR,
817     PAN_NET_ACCESS_TYPE_OTHER = 0xFFFE,
818     PAN_NET_ACCESS_TYPE_NONE
819 } net_access_type_t;
820 
821 /**
822  * ATT
823  */
824 
825 // Minimum/default MTU
826 #define ATT_DEFAULT_MTU               23
827 
828 // MARK: Attribute PDU Opcodes
829 #define ATT_ERROR_RESPONSE              0x01
830 
831 #define ATT_EXCHANGE_MTU_REQUEST        0x02
832 #define ATT_EXCHANGE_MTU_RESPONSE       0x03
833 
834 #define ATT_FIND_INFORMATION_REQUEST    0x04
835 #define ATT_FIND_INFORMATION_REPLY      0x05
836 #define ATT_FIND_BY_TYPE_VALUE_REQUEST  0x06
837 #define ATT_FIND_BY_TYPE_VALUE_RESPONSE 0x07
838 
839 #define ATT_READ_BY_TYPE_REQUEST        0x08
840 #define ATT_READ_BY_TYPE_RESPONSE       0x09
841 #define ATT_READ_REQUEST                0x0a
842 #define ATT_READ_RESPONSE               0x0b
843 #define ATT_READ_BLOB_REQUEST           0x0c
844 #define ATT_READ_BLOB_RESPONSE          0x0d
845 #define ATT_READ_MULTIPLE_REQUEST       0x0e
846 #define ATT_READ_MULTIPLE_RESPONSE      0x0f
847 #define ATT_READ_BY_GROUP_TYPE_REQUEST  0x10
848 #define ATT_READ_BY_GROUP_TYPE_RESPONSE 0x11
849 
850 #define ATT_WRITE_REQUEST               0x12
851 #define ATT_WRITE_RESPONSE              0x13
852 
853 #define ATT_PREPARE_WRITE_REQUEST       0x16
854 #define ATT_PREPARE_WRITE_RESPONSE      0x17
855 #define ATT_EXECUTE_WRITE_REQUEST       0x18
856 #define ATT_EXECUTE_WRITE_RESPONSE      0x19
857 
858 #define ATT_HANDLE_VALUE_NOTIFICATION   0x1b
859 #define ATT_HANDLE_VALUE_INDICATION     0x1d
860 #define ATT_HANDLE_VALUE_CONFIRMATION   0x1e
861 
862 
863 #define ATT_WRITE_COMMAND                0x52
864 #define ATT_SIGNED_WRITE_COMMAND         0xD2
865 
866 // MARK: ATT Error Codes
867 #define ATT_ERROR_INVALID_HANDLE                   0x01
868 #define ATT_ERROR_READ_NOT_PERMITTED               0x02
869 #define ATT_ERROR_WRITE_NOT_PERMITTED              0x03
870 #define ATT_ERROR_INVALID_PDU                      0x04
871 #define ATT_ERROR_INSUFFICIENT_AUTHENTICATION      0x05
872 #define ATT_ERROR_REQUEST_NOT_SUPPORTED            0x06
873 #define ATT_ERROR_INVALID_OFFSET                   0x07
874 #define ATT_ERROR_INSUFFICIENT_AUTHORIZATION       0x08
875 #define ATT_ERROR_PREPARE_QUEUE_FULL               0x09
876 #define ATT_ERROR_ATTRIBUTE_NOT_FOUND              0x0a
877 #define ATT_ERROR_ATTRIBUTE_NOT_LONG               0x0b
878 #define ATT_ERROR_INSUFFICIENT_ENCRYPTION_KEY_SIZE 0x0c
879 #define ATT_ERROR_INVALID_ATTRIBUTE_VALUE_LENGTH   0x0d
880 #define ATT_ERROR_UNLIKELY_ERROR                   0x0e
881 #define ATT_ERROR_INSUFFICIENT_ENCRYPTION          0x0f
882 #define ATT_ERROR_UNSUPPORTED_GROUP_TYPE           0x10
883 #define ATT_ERROR_INSUFFICIENT_RESOURCES           0x11
884 
885 // MARK: Attribute Property Flags
886 #define ATT_PROPERTY_BROADCAST           0x01
887 #define ATT_PROPERTY_READ                0x02
888 #define ATT_PROPERTY_WRITE_WITHOUT_RESPONSE 0x04
889 #define ATT_PROPERTY_WRITE               0x08
890 #define ATT_PROPERTY_NOTIFY              0x10
891 #define ATT_PROPERTY_INDICATE            0x20
892 #define ATT_PROPERTY_AUTHENTICATED_SIGNED_WRITE 0x40
893 #define ATT_PROPERTY_EXTENDED_PROPERTIES 0x80
894 
895 // MARK: Attribute Property Flag, BTstack extension
896 // value is asked from client
897 #define ATT_PROPERTY_DYNAMIC             0x100
898 // 128 bit UUID used
899 #define ATT_PROPERTY_UUID128             0x200
900 // Authentication required
901 #define ATT_PROPERTY_AUTHENTICATION_REQUIRED 0x400
902 // Authorization from user required
903 #define ATT_PROPERTY_AUTHORIZATION_REQUIRED  0x800
904 // Encryption key size stored in upper 4 bits, 0 == no encryption, encryption key size - 1 otherwise
905 
906 // ATT Transaction Timeout of 30 seconds for Command/Response or Incidationc/Confirmation
907 #define ATT_TRANSACTION_TIMEOUT_MS     30000
908 
909 #define ATT_TRANSACTION_MODE_NONE      0x0
910 #define ATT_TRANSACTION_MODE_ACTIVE    0x1
911 #define ATT_TRANSACTION_MODE_EXECUTE   0x2
912 #define ATT_TRANSACTION_MODE_CANCEL    0x3
913 
914 // MARK: GATT UUIDs
915 #define GATT_PRIMARY_SERVICE_UUID                   0x2800
916 #define GATT_SECONDARY_SERVICE_UUID                 0x2801
917 #define GATT_INCLUDE_SERVICE_UUID                   0x2802
918 #define GATT_CHARACTERISTICS_UUID                   0x2803
919 #define GATT_CHARACTERISTIC_EXTENDED_PROPERTIES     0x2900
920 #define GATT_CHARACTERISTIC_USER_DESCRIPTION        0x2901
921 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION   0x2902
922 #define GATT_SERVER_CHARACTERISTICS_CONFIGURATION   0x2903
923 #define GATT_CHARACTERISTIC_PRESENTATION_FORMAT     0x2904
924 #define GATT_CHARACTERISTIC_AGGREGATE_FORMAT        0x2905
925 
926 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NONE          0
927 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION  1
928 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION    2
929 
930 // GAP Service and Characteristics
931 #define GAP_SERVICE_UUID               0x1800
932 #define GAP_DEVICE_NAME_UUID           0x2a00
933 #define GAP_APPEARANCE_UUID            0x2a01
934 #define GAP_PERIPHERAL_PRIVACY_FLAG    0x2a02
935 #define GAP_RECONNECTION_ADDRESS_UUID  0x2a03
936 #define GAP_PERIPHERAL_PREFERRED_CONNECTION_PARAMETERS_UUID 0x2a04
937 #define GAP_SERVICE_CHANGED            0x2a05
938 
939 /**
940  * SM - LE Security Manager
941  */
942 // Bluetooth Spec definitions
943 typedef enum {
944     SM_CODE_PAIRING_REQUEST = 0X01,
945     SM_CODE_PAIRING_RESPONSE,
946     SM_CODE_PAIRING_CONFIRM,
947     SM_CODE_PAIRING_RANDOM,
948     SM_CODE_PAIRING_FAILED,
949     SM_CODE_ENCRYPTION_INFORMATION,
950     SM_CODE_MASTER_IDENTIFICATION,
951     SM_CODE_IDENTITY_INFORMATION,
952     SM_CODE_IDENTITY_ADDRESS_INFORMATION,
953     SM_CODE_SIGNING_INFORMATION,
954     SM_CODE_SECURITY_REQUEST,
955     SM_CODE_PAIRING_PUBLIC_KEY,
956     SM_CODE_PAIRING_DHKEY_CHECK,
957     SM_CODE_KEYPRESS_NOTIFICATION,
958 } SECURITY_MANAGER_COMMANDS;
959 
960 // IO Capability Values
961 typedef enum {
962     IO_CAPABILITY_DISPLAY_ONLY = 0,
963     IO_CAPABILITY_DISPLAY_YES_NO,
964     IO_CAPABILITY_KEYBOARD_ONLY,
965     IO_CAPABILITY_NO_INPUT_NO_OUTPUT,
966     IO_CAPABILITY_KEYBOARD_DISPLAY, // not used by secure simple pairing
967 } io_capability_t;
968 
969 // Authentication requirement flags
970 #define SM_AUTHREQ_NO_BONDING        0x00
971 #define SM_AUTHREQ_BONDING           0x01
972 #define SM_AUTHREQ_MITM_PROTECTION   0x04
973 #define SM_AUTHREQ_SECURE_CONNECTION 0x08
974 #define SM_AUTHREQ_KEYPRESS          0x10
975 
976 // Key distribution flags used by spec
977 #define SM_KEYDIST_ENC_KEY  0x01
978 #define SM_KEYDIST_ID_KEY   0x02
979 #define SM_KEYDIST_SIGN     0x04
980 #define SM_KEYDIST_LINK_KEY 0x08
981 
982 // Key distribution flags used internally
983 #define SM_KEYDIST_FLAG_ENCRYPTION_INFORMATION       0x01
984 #define SM_KEYDIST_FLAG_MASTER_IDENTIFICATION        0x02
985 #define SM_KEYDIST_FLAG_IDENTITY_INFORMATION         0x04
986 #define SM_KEYDIST_FLAG_IDENTITY_ADDRESS_INFORMATION 0x08
987 #define SM_KEYDIST_FLAG_SIGNING_IDENTIFICATION       0x10
988 
989 // STK Generation Methods
990 #define SM_STK_GENERATION_METHOD_JUST_WORKS          0x01
991 #define SM_STK_GENERATION_METHOD_OOB                 0x02
992 #define SM_STK_GENERATION_METHOD_PASSKEY             0x04
993 #define SM_STK_GENERATION_METHOD_NUMERIC_COMPARISON  0x08
994 
995 // Pairing Failed Reasons
996 #define SM_REASON_RESERVED                     0x00
997 #define SM_REASON_PASSKEYT_ENTRY_FAILED        0x01
998 #define SM_REASON_OOB_NOT_AVAILABLE            0x02
999 #define SM_REASON_AUTHENTHICATION_REQUIREMENTS 0x03
1000 #define SM_REASON_CONFIRM_VALUE_FAILED         0x04
1001 #define SM_REASON_PAIRING_NOT_SUPPORTED        0x05
1002 #define SM_REASON_ENCRYPTION_KEY_SIZE          0x06
1003 #define SM_REASON_COMMAND_NOT_SUPPORTED        0x07
1004 #define SM_REASON_UNSPECIFIED_REASON           0x08
1005 #define SM_REASON_REPEATED_ATTEMPTS            0x09
1006 #define SM_REASON_INVALID_PARAMETERS           0x0a
1007 #define SM_REASON_DHKEY_CHECK_FAILED           0x0b
1008 #define SM_REASON_NUMERIC_COMPARISON_FAILED    0x0c
1009 
1010 // also, invalid parameters
1011 // and reserved
1012 
1013 // Keypress Notifications
1014 #define SM_KEYPRESS_PASSKEY_ENTRY_STARTED      0x00
1015 #define SM_KEYPRESS_PASSKEY_DIGIT_ENTERED      0x01
1016 #define SM_KEYPRESS_PASSKEY_DIGIT_ERASED       0x02
1017 #define SM_KEYPRESS_PASSKEY_CLEARED            0x03
1018 #define SM_KEYPRESS_PASSKEY_ENTRY_COMPLETED    0x04
1019 
1020 
1021 // Company identifiers / manufacturers
1022 #define COMPANY_ID_CAMBRIDGE_SILICON_RADIO     0x000A
1023 #define COMPANY_ID_TEXAS_INSTRUMENTS_INC       0x000D
1024 #define COMPANY_ID_BROADCOM_CORPORATION        0x000F
1025 #define COMPANY_ID_ST_MICROELECTRONICS         0x0030
1026 #define COMPANY_ID_EM_MICROELECTRONICS_MARIN   0x005A
1027 
1028 
1029 #endif