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