xref: /btstack/src/bluetooth.h (revision d8c69877dd983d65f38445d0427b8bc5f1dc5678)
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 BLUEKITCHEN
24  * GMBH 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_LE_PRIVAT_FALLBACK_PUBLIC = 2,
72     BD_ADDR_TYPE_LE_PRIVAT_FALLBACK_RANDOM = 3,
73     BD_ADDR_TYPE_SCO       = 0xfc,
74     BD_ADDR_TYPE_ACL       = 0xfd,
75     BD_ADDR_TYPE_UNKNOWN   = 0xfe,  // also used as 'invalid'
76 } bd_addr_type_t;
77 
78 /**
79  * Link types for BR/EDR Connections
80  */
81 typedef enum {
82     HCI_LINK_TYPE_SCO  = 0,
83     HCI_LINK_TYPE_ACL  = 1,
84     HCI_LINK_TYPE_ESCO = 2,
85 } hci_link_type_t;
86 
87 
88 /**
89  * @brief link key
90  */
91 #define LINK_KEY_LEN 16
92 #define LINK_KEY_STR_LEN (LINK_KEY_LEN*2)
93 typedef uint8_t link_key_t[LINK_KEY_LEN];
94 
95 /**
96  * @brief link key type
97  */
98 typedef enum {
99   INVALID_LINK_KEY = 0xffff,
100   COMBINATION_KEY = 0,  // standard pairing
101   LOCAL_UNIT_KEY,     // ?
102   REMOTE_UNIT_KEY,    // ?
103   DEBUG_COMBINATION_KEY,  // SSP with debug
104   UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192, // SSP Simple Pairing
105   AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192,   // SSP Passkey, Number confirm, OOB
106   CHANGED_COMBINATION_KEY,               // Link key changed using Change Connection Lnk Key
107   UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256, // SSP Simpe Pairing
108   AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256,   // SSP Passkey, Number confirm, OOB
109 } link_key_type_t;
110 
111 /**
112  * @brief Extended Inquiry Response
113  */
114 #define EXTENDED_INQUIRY_RESPONSE_DATA_LEN 240
115 
116 /**
117  * @brief Inquiry modes
118  */
119 typedef enum {
120   INQUIRY_MODE_STANDARD = 0,
121   INQUIRY_MODE_RSSI,
122   INQUIRY_MODE_RSSI_AND_EIR,
123 } inquiry_mode_t;
124 
125 /**
126  * @brief Page Scan Types
127  */
128 typedef enum {
129     PAGE_SCAN_MODE_STANDARD = 0,
130     PAGE_SCAN_MODE_INTERLACED,
131 } page_scan_type_t;
132 
133 /**
134  * @brief Inquiry Scan Types
135  */
136 typedef enum {
137     INQUIRY_SCAN_MODE_STANDARD = 0,
138     INQUIRY_SCAN_MODE_INTERLACED,
139 } inquiry_scan_type_t;
140 
141 /**
142  * Link Supervision Timeout Default, 0x7d00 * 0.625ms = 20s
143  */
144 #define HCI_LINK_SUPERVISION_TIMEOUT_DEFAULT 0x7D00
145 
146 /**
147  * Service Type used for QoS Setup and Flow Specification
148  */
149 typedef enum {
150     HCI_SERVICE_TYPE_NO_TRAFFIC = 0,
151     HCI_SERVICE_TYPE_BEST_EFFORT,
152     HCI_SERVICE_TYPE_GUARANTEED,
153     HCI_SERVICE_TYPE_INVALID,
154 } hci_service_type_t;
155 
156 /**
157  * HCI Transport
158  */
159 
160 /**
161  * packet types - used in BTstack and over the H4 UART interface
162  */
163 #define HCI_COMMAND_DATA_PACKET 0x01
164 #define HCI_ACL_DATA_PACKET     0x02
165 #define HCI_SCO_DATA_PACKET     0x03
166 #define HCI_EVENT_PACKET        0x04
167 
168 /**
169  * HCI Layer
170  */
171 
172 //
173 // Error Codes rfom Bluetooth Core Specification
174 //
175 
176 /* ENUM_START: BLUETOOTH_ERROR_CODE */
177 #define ERROR_CODE_SUCCESS                                 0x00
178 #define ERROR_CODE_UNKNOWN_HCI_COMMAND                     0x01
179 #define ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER           0x02
180 #define ERROR_CODE_HARDWARE_FAILURE                        0x03
181 #define ERROR_CODE_PAGE_TIMEOUT                            0x04
182 #define ERROR_CODE_AUTHENTICATION_FAILURE                  0x05
183 #define ERROR_CODE_PIN_OR_KEY_MISSING                      0x06
184 #define ERROR_CODE_MEMORY_CAPACITY_EXCEEDED                0x07
185 #define ERROR_CODE_CONNECTION_TIMEOUT                      0x08
186 #define ERROR_CODE_CONNECTION_LIMIT_EXCEEDED               0x09
187 #define ERROR_CODE_SYNCHRONOUS_CONNECTION_LIMIT_TO_A_DEVICE_EXCEEDED  0x0A
188 #define ERROR_CODE_ACL_CONNECTION_ALREADY_EXISTS           0x0B
189 #define ERROR_CODE_COMMAND_DISALLOWED                      0x0C
190 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_LIMITED_RESOURCES 0x0D
191 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_SECURITY_REASONS  0x0E
192 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_UNACCEPTABLE_BD_ADDR 0x0F
193 #define ERROR_CODE_CONNECTION_ACCEPT_TIMEOUT_EXCEEDED      0x10
194 #define ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE  0x11
195 #define ERROR_CODE_INVALID_HCI_COMMAND_PARAMETERS          0x12
196 #define ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION       0x13
197 #define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_LOW_RESOURCES 0x14
198 #define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_POWER_OFF     0x15
199 #define ERROR_CODE_CONNECTION_TERMINATED_BY_LOCAL_HOST     0x16
200 #define ERROR_CODE_REPEATED_ATTEMPTS                       0x17
201 #define ERROR_CODE_PAIRING_NOT_ALLOWED                     0x18
202 #define ERROR_CODE_UNKNOWN_LMP_PDU                         0x19
203 #define ERROR_CODE_UNSUPPORTED_REMOTE_FEATURE_UNSUPPORTED_LMP_FEATURE 0x1A
204 #define ERROR_CODE_SCO_OFFSET_REJECTED                     0x1B
205 #define ERROR_CODE_SCO_INTERVAL_REJECTED                   0x1C
206 #define ERROR_CODE_SCO_AIR_MODE_REJECTED                   0x1D
207 #define ERROR_CODE_INVALID_LMP_PARAMETERS_INVALID_LL_PARAMETERS 0x1E
208 #define ERROR_CODE_UNSPECIFIED_ERROR                       0x1F
209 #define ERROR_CODE_UNSUPPORTED_LMP_PARAMETER_VALUE_UNSUPPORTED_LL_PARAMETER_VALUE 0x20
210 #define ERROR_CODE_ROLE_CHANGE_NOT_ALLOWED                 0x21
211 #define ERROR_CODE_LMP_RESPONSE_TIMEOUT_LL_RESPONSE_TIMEOUT 0x22
212 #define ERROR_CODE_LMP_ERROR_TRANSACTION_COLLISION         0x23
213 #define ERROR_CODE_LMP_PDU_NOT_ALLOWED                     0x24
214 #define ERROR_CODE_ENCRYPTION_MODE_NOT_ACCEPTABLE          0x25
215 #define ERROR_CODE_LINK_KEY_CANNOT_BE_CHANGED              0x26
216 #define ERROR_CODE_REQUESTED_QOS_NOT_SUPPORTED             0x27
217 #define ERROR_CODE_INSTANT_PASSED                          0x28
218 #define ERROR_CODE_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED     0x29
219 #define ERROR_CODE_DIFFERENT_TRANSACTION_COLLISION         0x2A
220 #define ERROR_CODE_RESERVED                                0x2B
221 #define ERROR_CODE_QOS_UNACCEPTABLE_PARAMETER              0x2C
222 #define ERROR_CODE_QOS_REJECTED                            0x2D
223 #define ERROR_CODE_CHANNEL_CLASSIFICATION_NOT_SUPPORTED    0x2E
224 #define ERROR_CODE_INSUFFICIENT_SECURITY                   0x2F
225 #define ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE        0x30
226 // #define ERROR_CODE_RESERVED
227 #define ERROR_CODE_ROLE_SWITCH_PENDING                     0x32
228 // #define ERROR_CODE_RESERVED
229 #define ERROR_CODE_RESERVED_SLOT_VIOLATION                 0x34
230 #define ERROR_CODE_ROLE_SWITCH_FAILED                      0x35
231 #define ERROR_CODE_EXTENDED_INQUIRY_RESPONSE_TOO_LARGE     0x36
232 #define ERROR_CODE_SECURE_SIMPLE_PAIRING_NOT_SUPPORTED_BY_HOST 0x37
233 #define ERROR_CODE_HOST_BUSY_PAIRING                       0x38
234 #define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_NO_SUITABLE_CHANNEL_FOUND 0x39
235 #define ERROR_CODE_CONTROLLER_BUSY                         0x3A
236 #define ERROR_CODE_UNACCEPTABLE_CONNECTION_PARAMETERS      0x3B
237 #define ERROR_CODE_DIRECTED_ADVERTISING_TIMEOUT            0x3C
238 #define ERROR_CODE_CONNECTION_TERMINATED_DUE_TO_MIC_FAILURE 0x3D
239 #define ERROR_CODE_CONNECTION_FAILED_TO_BE_ESTABLISHED     0x3E
240 #define ERROR_CODE_MAC_CONNECTION_FAILED                   0x3F
241 #define ERROR_CODE_COARSE_CLOCK_ADJUSTMENT_REJECTED_BUT_WILL_TRY_TO_ADJUST_USING_CLOCK_DRAGGING 0x40
242 
243 // BTstack defined ERRORS, mapped into BLuetooth status code range
244 
245 #define BTSTACK_CONNECTION_TO_BTDAEMON_FAILED              0x50
246 #define BTSTACK_ACTIVATION_FAILED_SYSTEM_BLUETOOTH         0x51
247 #define BTSTACK_ACTIVATION_POWERON_FAILED                  0x52
248 #define BTSTACK_ACTIVATION_FAILED_UNKNOWN                  0x53
249 #define BTSTACK_NOT_ACTIVATED                              0x54
250 #define BTSTACK_BUSY                                       0x55
251 #define BTSTACK_MEMORY_ALLOC_FAILED                        0x56
252 #define BTSTACK_ACL_BUFFERS_FULL                           0x57
253 
254 // l2cap errors - enumeration by the command that created them
255 #define L2CAP_COMMAND_REJECT_REASON_COMMAND_NOT_UNDERSTOOD 0x60
256 #define L2CAP_COMMAND_REJECT_REASON_SIGNALING_MTU_EXCEEDED 0x61
257 #define L2CAP_COMMAND_REJECT_REASON_INVALID_CID_IN_REQUEST 0x62
258 
259 #define L2CAP_CONNECTION_RESPONSE_RESULT_SUCCESSFUL        0x63
260 #define L2CAP_CONNECTION_RESPONSE_RESULT_PENDING           0x64
261 #define L2CAP_CONNECTION_RESPONSE_RESULT_REFUSED_PSM       0x65
262 #define L2CAP_CONNECTION_RESPONSE_RESULT_REFUSED_SECURITY  0x66
263 #define L2CAP_CONNECTION_RESPONSE_RESULT_REFUSED_RESOURCES 0x67
264 #define L2CAP_CONNECTION_RESPONSE_RESULT_ERTM_NOT_SUPPORTED 0x68
265 
266 // should be L2CAP_CONNECTION_RTX_TIMEOUT
267 #define L2CAP_CONNECTION_RESPONSE_RESULT_RTX_TIMEOUT       0x69
268 #define L2CAP_CONNECTION_BASEBAND_DISCONNECT               0x6A
269 #define L2CAP_SERVICE_ALREADY_REGISTERED                   0x6B
270 #define L2CAP_DATA_LEN_EXCEEDS_REMOTE_MTU                  0x6C
271 #define L2CAP_SERVICE_DOES_NOT_EXIST                       0x6D
272 #define L2CAP_LOCAL_CID_DOES_NOT_EXIST                     0x6E
273 #define L2CAP_CONNECTION_RESPONSE_UNKNOWN_ERROR            0x6F
274 
275 #define RFCOMM_MULTIPLEXER_STOPPED                         0x70
276 #define RFCOMM_CHANNEL_ALREADY_REGISTERED                  0x71
277 #define RFCOMM_NO_OUTGOING_CREDITS                         0x72
278 #define RFCOMM_AGGREGATE_FLOW_OFF                          0x73
279 #define RFCOMM_DATA_LEN_EXCEEDS_MTU                        0x74
280 
281 #define HFP_REMOTE_REJECTS_AUDIO_CONNECTION                0x7F
282 
283 #define SDP_HANDLE_ALREADY_REGISTERED                      0x80
284 #define SDP_QUERY_INCOMPLETE                               0x81
285 #define SDP_SERVICE_NOT_FOUND                              0x82
286 #define SDP_HANDLE_INVALID                                 0x83
287 #define SDP_QUERY_BUSY                                     0x84
288 
289 #define ATT_HANDLE_VALUE_INDICATION_IN_PROGRESS            0x90
290 #define ATT_HANDLE_VALUE_INDICATION_TIMEOUT                0x91
291 #define ATT_HANDLE_VALUE_INDICATION_DISCONNECT             0x92
292 
293 #define GATT_CLIENT_NOT_CONNECTED                          0x93
294 #define GATT_CLIENT_BUSY                                   0x94
295 #define GATT_CLIENT_IN_WRONG_STATE                         0x95
296 #define GATT_CLIENT_DIFFERENT_CONTEXT_FOR_ADDRESS_ALREADY_EXISTS 0x96
297 #define GATT_CLIENT_VALUE_TOO_LONG                         0x97
298 #define GATT_CLIENT_CHARACTERISTIC_NOTIFICATION_NOT_SUPPORTED 0x98
299 #define GATT_CLIENT_CHARACTERISTIC_INDICATION_NOT_SUPPORTED   0x99
300 
301 #define BNEP_SERVICE_ALREADY_REGISTERED                    0xA0
302 #define BNEP_CHANNEL_NOT_CONNECTED                         0xA1
303 #define BNEP_DATA_LEN_EXCEEDS_MTU                          0xA2
304 
305 // OBEX ERRORS
306 #define OBEX_UNKNOWN_ERROR                                 0xB0
307 #define OBEX_CONNECT_FAILED                                0xB1
308 #define OBEX_DISCONNECTED                                  0xB2
309 #define OBEX_NOT_FOUND                                     0xB3
310 #define OBEX_NOT_ACCEPTABLE                                0xB4
311 
312 #define MESH_ERROR_APPKEY_INDEX_INVALID                    0xD0
313 /* ENUM_END */
314 
315 
316 /* ENUM_START: AVRCP_BROWSING_ERROR_CODE */
317 #define AVRCP_BROWSING_ERROR_CODE_INVALID_COMMAND                     0x00  // Sent if TG received a PDU that it did not understand. Valid for All.
318 #define AVRCP_BROWSING_ERROR_CODE_INVALID_PARAMETER                   0x01  // Sent if the TG received a PDU with a parameter ID that it did not understand. Sent if there is only one parameter ID in the PDU. Valid for All.
319 #define AVRCP_BROWSING_ERROR_CODE_SPECIFIED_PARAMETER_NOT_FOUND       0x02  // Sent if the parameter ID is understood, but content is wrong or corrupted. Valid for All.
320 #define AVRCP_BROWSING_ERROR_CODE_INTERNAL_ERROR                      0x03  // Sent if there are error conditions not covered by a more specific error code. Valid for All.
321 #define AVRCP_BROWSING_ERROR_CODE_SUCCESS                             0x04  // This is the status that should be returned if the operation was successful. Valid for All except where the response CType is AV/C REJECTED.
322 #define AVRCP_BROWSING_ERROR_CODE_UID_CHANGED                         0x05  // The UIDs on the device have changed. Valid for All.
323 #define AVRCP_BROWSING_ERROR_CODE_RESERVED_06                         0x06  // Valid for All.
324 #define AVRCP_BROWSING_ERROR_CODE_INVALID_DIRECTION                   0x07  // The Direction parameter is invalid. Valid for Change Path.
325 #define AVRCP_BROWSING_ERROR_CODE_NOT_A_DIRECTORY                     0x08  // The UID provided does not refer to a folder item. Valid for Change Path.
326 #define AVRCP_BROWSING_ERROR_CODE_DOES_NOT_EXIST                      0x09  // The UID provided does not refer to any currently valid. Valid for Change Path, PlayItem, AddToNowPlaying, GetItemAttributes.
327 #define AVRCP_BROWSING_ERROR_CODE_INVALID_SCOPE                       0x0a  // The scope parameter is invalid. Valid for GetFolderItems, PlayItem, AddToNowPlayer, GetItemAttributes,.
328 #define AVRCP_BROWSING_ERROR_CODE_RANGE_OUT_OF_BOUNDS                 0x0b  // The start of range provided is not valid. Valid for GetFolderItems.
329 #define AVRCP_BROWSING_ERROR_CODE_UID_IS_A_DIRECTORY                  0x0c  // The UID provided refers to a directory, which cannot be handled by this media player. Valid for PlayItem, AddToNowPlaying.
330 #define AVRCP_BROWSING_ERROR_CODE_MEDIA_IN_USES                       0x0d  // The media is not able to be used for this operation at this time. Valid for PlayItem, AddToNowPlaying.
331 #define AVRCP_BROWSING_ERROR_CODE_NOW_PLAYING_LIST_FULL               0x0e  // No more items can be added to the Now Playing List. Valid for AddToNowPlaying.
332 #define AVRCP_BROWSING_ERROR_CODE_SEARCH_NOT_SUPPORTED                0x0f  // The Browsed Media Player does not support search. Valid for Search.
333 #define AVRCP_BROWSING_ERROR_CODE_SEARCH_IN_PROGRESS                  0x10  // A search operation is already in progress. Valid for Search.
334 #define AVRCP_BROWSING_ERROR_CODE_INVALID_PLAYER_ID                   0x11  // The specified Player Id does not refer to a valid player. Valid for SetAddressedPlayer, SetBrowsedPlayer.
335 #define AVRCP_BROWSING_ERROR_CODE_PLAYER_NOT_BROWSABLE                0x12  // The Player Id supplied refers to a Media Player which does not support browsing. Valid for SetBrowsedPlayer.
336 #define AVRCP_BROWSING_ERROR_CODE_PLAYER_NOT_ADDRESSED                0x13  // The Player Id supplied refers to a player which is not currently addressed, and the command is not able to be performed if the player is not set as addressed. Valid for Search SetBrowsedPlayer.
337 #define AVRCP_BROWSING_ERROR_CODE_NO_VALID_SEARCH_RESULTS             0x14  // The Search result list does not contain valid entries, e.g. after being invalidated due to change of browsed player. Valid for GetFolderItems.
338 #define AVRCP_BROWSING_ERROR_CODE_NO_AVAILABLE_PLAYERS                0x15  // Valid for All.
339 #define AVRCP_BROWSING_ERROR_CODE_ADDRESSED_PLAYER_CHANGED            0x16  // Valid for Register Notification.
340 // 0x17-0xff Reserved
341 /* ENUM_END */
342 
343 // HCI roles
344 typedef enum {
345     HCI_ROLE_MASTER = 0,
346     HCI_ROLE_SLAVE  = 1,
347     HCI_ROLE_INVALID = 0xff,
348 } hci_role_t;
349 
350 // packet sizes (max payload)
351 #define HCI_ACL_DM1_SIZE            17
352 #define HCI_ACL_DH1_SIZE            27
353 #define HCI_ACL_2DH1_SIZE           54
354 #define HCI_ACL_3DH1_SIZE           83
355 #define HCI_ACL_DM3_SIZE           121
356 #define HCI_ACL_DH3_SIZE           183
357 #define HCI_ACL_DM5_SIZE           224
358 #define HCI_ACL_DH5_SIZE           339
359 #define HCI_ACL_2DH3_SIZE          367
360 #define HCI_ACL_3DH3_SIZE          552
361 #define HCI_ACL_2DH5_SIZE          679
362 #define HCI_ACL_3DH5_SIZE         1021
363 
364 #define LE_ADVERTISING_DATA_SIZE    31
365 
366 // SCO Packet Types
367 #define SCO_PACKET_TYPES_NONE  0x0000
368 #define SCO_PACKET_TYPES_HV1   0x0001
369 #define SCO_PACKET_TYPES_HV3   0x0004
370 #define SCO_PACKET_TYPES_EV3   0x0008
371 #define SCO_PACKET_TYPES_2EV3  0x0040
372 #define SCO_PACKET_TYPES_ALL   0x03FF
373 
374 // Link Policy Settings
375 #define LM_LINK_POLICY_DISABLE_ALL_LM_MODES  0
376 #define LM_LINK_POLICY_ENABLE_ROLE_SWITCH    1
377 #define LM_LINK_POLICY_ENABLE_HOLD_MODE      2
378 #define LM_LINK_POLICY_ENABLE_SNIFF_MODE     4
379 
380 // ACL Connection Modes
381 #define ACL_CONNECTION_MODE_ACTIVE 0
382 #define ACL_CONNECTION_MODE_HOLD   1
383 #define ACL_CONNECTION_MODE_SNIFF  2
384 
385 /**
386  * Default INQ Mode
387  */
388 #define GAP_IAC_GENERAL_INQUIRY 0x9E8B33L // General/Unlimited Inquiry Access Code (GIAC)
389 #define GAP_IAC_LIMITED_INQUIRY 0x9E8B00L // Limited Dedicated Inquiry Access Code (LIAC)
390 
391 /**
392  * SSP IO Capabilities
393  */
394 #define SSP_IO_CAPABILITY_DISPLAY_ONLY   0
395 #define SSP_IO_CAPABILITY_DISPLAY_YES_NO 1
396 #define SSP_IO_CAPABILITY_KEYBOARD_ONLY  2
397 #define SSP_IO_CAPABILITY_NO_INPUT_NO_OUTPUT 3
398 #define SSP_IO_CAPABILITY_UNKNOWN 0xff
399 
400 
401 /**
402  * SSP Authentication Requirements, see IO Capability Request Reply Commmand
403  */
404 
405 // Numeric comparison with automatic accept allowed.
406 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_NO_BONDING 0x00
407 
408 // Use IO Capabilities to deter- mine authentication procedure
409 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_NO_BONDING 0x01
410 
411 // Numeric compar- ison with automatic accept allowed.
412 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_DEDICATED_BONDING 0x02
413 
414 // Use IO Capabilities to determine authentication procedure
415 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_DEDICATED_BONDING 0x03
416 
417 // Numeric Compari- son with automatic accept allowed.
418 #define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_GENERAL_BONDING 0x04
419 
420 // Use IO capabilities to determine authentication procedure.
421 #define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_GENERAL_BONDING 0x05
422 
423 
424 // OGFs
425 #define OGF_LINK_CONTROL          0x01
426 #define OGF_LINK_POLICY           0x02
427 #define OGF_CONTROLLER_BASEBAND   0x03
428 #define OGF_INFORMATIONAL_PARAMETERS 0x04
429 #define OGF_STATUS_PARAMETERS     0x05
430 #define OGF_TESTING               0x06
431 #define OGF_LE_CONTROLLER 0x08
432 #define OGF_VENDOR  0x3f
433 
434 
435 
436 
437 /**
438  * L2CAP Layer
439  */
440 
441 #define L2CAP_HEADER_SIZE 4
442 
443 // minimum signaling MTU
444 #define L2CAP_MINIMAL_MTU 48
445 #define L2CAP_DEFAULT_MTU 672
446 
447 // Minimum/default MTU
448 #define L2CAP_LE_DEFAULT_MTU  23
449 
450 // L2CAP Fixed Channel IDs
451 #define L2CAP_CID_SIGNALING                        0x0001
452 #define L2CAP_CID_CONNECTIONLESS_CHANNEL           0x0002
453 #define L2CAP_CID_ATTRIBUTE_PROTOCOL               0x0004
454 #define L2CAP_CID_SIGNALING_LE                     0x0005
455 #define L2CAP_CID_SECURITY_MANAGER_PROTOCOL        0x0006
456 #define L2CAP_CID_BR_EDR_SECURITY_MANAGER          0x0007
457 
458 // L2CAP Channels in Basic and Enhanced Retransmission Mode
459 
460 // connection response result
461 #define L2CAP_CONNECTION_RESULT_SUCCESS                         0x0000
462 #define L2CAP_CONNECTION_RESULT_PENDING                         0x0001
463 #define L2CAP_CONNECTION_RESULT_PSM_NOT_SUPPORTED               0x0002
464 #define L2CAP_CONNECTION_RESULT_SECURITY_BLOCK                  0x0003
465 #define L2CAP_CONNECTION_RESULT_NO_RESOURCES_AVAILABLE          0x0004
466 #define L2CAP_CONNECTION_RESULT_INVALID_SOURCE_CID              0x0006
467 #define L2CAP_CONNECTION_RESULT_SOURCE_CID_ALREADY_ALLOCATED    0x0007
468 
469 // L2CAP Channels in LE Credit-Based Flow-Control Mode
470 
471 // connection response result
472 #define L2CAP_CBM_CONNECTION_RESULT_SUCCESS                         0x0000
473 #define L2CAP_CBM_CONNECTION_RESULT_SPSM_NOT_SUPPORTED              0x0002
474 #define L2CAP_CBM_CONNECTION_RESULT_NO_RESOURCES_AVAILABLE          0x0004
475 #define L2CAP_CBM_CONNECTION_RESULT_INSUFFICIENT_AUTHENTICATION     0x0005
476 #define L2CAP_CBM_CONNECTION_RESULT_INSUFFICIENT_AUTHORIZATION      0x0006
477 #define L2CAP_CBM_CONNECTION_RESULT_ENCYRPTION_KEY_SIZE_TOO_SHORT   0x0007
478 #define L2CAP_CBM_CONNECTION_RESULT_INSUFFICIENT_ENCRYPTION         0x0008
479 #define L2CAP_CBM_CONNECTION_RESULT_INVALID_SOURCE_CID              0x0009
480 #define L2CAP_CBM_CONNECTION_RESULT_SOURCE_CID_ALREADY_ALLOCATED    0x000A
481 #define L2CAP_CBM_CONNECTION_RESULT_UNACCEPTABLE_PARAMETERS         0x000B
482 
483 
484 // L2CAP Channels in Enhanced Credit-Based Flow-Control Mode
485 
486 // number of CIDs in single connection+reconfiguration request/response
487 #define L2CAP_ECBM_MAX_CID_ARRAY_SIZE        5
488 
489 // connection response result
490 #define L2CAP_ECBM_CONNECTION_RESULT_ALL_SUCCESS                                    0x0000
491 #define L2CAP_ECBM_CONNECTION_RESULT_ALL_REFUSED_SPSM_NOT_SUPPORTED                 0x0002
492 #define L2CAP_ECBM_CONNECTION_RESULT_SOME_REFUSED_INSUFFICIENT_RESOURCES_AVAILABLE  0x0004
493 #define L2CAP_ECBM_CONNECTION_RESULT_ALL_REFUSED_INSUFFICIENT_AUTHENTICATION        0x0005
494 #define L2CAP_ECBM_CONNECTION_RESULT_ALL_REFUSED_INSUFFICIENT_AUTHORIZATION         0x0006
495 #define L2CAP_ECBM_CONNECTION_RESULT_ALL_REFUSED_ENCYRPTION_KEY_SIZE_TOO_SHORT      0x0007
496 #define L2CAP_ECBM_CONNECTION_RESULT_ALL_REFUSED_INSUFFICIENT_ENCRYPTION            0x0008
497 #define L2CAP_ECBM_CONNECTION_RESULT_SOME_REFUSED_INVALID_SOURCE_CID                0x0009
498 #define L2CAP_ECBM_CONNECTION_RESULT_SOME_REFUSED_SOURCE_CID_ALREADY_ALOCATED       0x000A
499 #define L2CAP_ECBM_CONNECTION_RESULT_ALL_REFUSED_UNACCEPTABLE_PARAMETERS            0x000B
500 #define L2CAP_ECBM_CONNECTION_RESULT_ALL_REFUSED_INVALID_PARAMETERS                 0x000C
501 #define L2CAP_ECBM_CONNECTION_RESULT_ALL_PENDING_NO_FURTHER_INFORMATION             0x000D
502 #define L2CAP_ECBM_CONNECTION_RESULT_ALL_PENDING_AUTHENTICATION                     0x000E
503 #define L2CAP_ECBM_CONNECTION_RESULT_ALL_PENDING_AUTHORIZATION                      0x000F
504 
505 
506 // Result for Reconfigure Request
507 #define L2CAP_ECBM_RECONFIGURE_SUCCESS                                 0
508 #define L2CAP_ECBM_RECONFIGURE_FAILED_MTU_REDUCTION_NOT_ALLOWED        1
509 #define L2CAP_ECBM_RECONFIGURE_FAILED_MPS_REDUCTION_MULTIPLE_CHANNELS  2
510 #define L2CAP_ECBM_RECONFIGURE_FAILED_DESTINATION_CID_INVALID          3
511 #define L2CAP_ECBM_RECONFIGURE_FAILED_UNACCEPTABLE_PARAMETERS          4
512 
513 /**
514  * SDP Protocol
515  */
516 
517 // Device Vendor ID Sources
518 #define DEVICE_ID_VENDOR_ID_SOURCE_BLUETOOTH 0x0001
519 #define DEVICE_ID_VENDOR_ID_SOURCE_USB       0x0002
520 
521 // OBEX
522 #define SDP_vCard_2_1       0x01
523 #define SDP_vCard_3_0       0x02
524 #define SDP_vCal_1_0        0x03
525 #define SDP_iCal_2_0        0x04
526 #define SDP_vNote           0x05
527 #define SDP_vMessage        0x06
528 #define SDP_OBEXFileTypeAny 0xFF
529 
530 /**
531  * RFCOMM Protocol
532  */
533 
534 // Line Status
535 #define LINE_STATUS_NO_ERROR       0x00
536 #define LINE_STATUS_OVERRUN_ERROR  0x03
537 #define LINE_STATUS_PARITY_ERORR   0x05
538 #define LINE_STATUS_FRAMING_ERROR  0x09
539 
540 // Modem Status Flags
541 #define MODEM_STATUS_FC   0x02
542 #define MODEM_STATUS_RTC  0x04
543 #define MODEM_STATUS_RTR  0x08
544 #define MODEM_STATUS_IC   0x40
545 #define MODEM_STATUS_DV   0x80
546 
547 typedef enum rpn_baud {
548     RPN_BAUD_2400 = 0,
549     RPN_BAUD_4800,
550     RPN_BAUD_7200,
551     RPN_BAUD_9600,
552     RPN_BAUD_19200,
553     RPN_BAUD_38400,
554     RPN_BAUD_57600,
555     RPN_BAUD_115200,
556     RPN_BAUD_230400
557 } rpn_baud_t;
558 
559 typedef enum rpn_data_bits {
560     RPN_DATA_BITS_5 = 0,
561     RPN_DATA_BITS_6 = 0,
562     RPN_DATA_BITS_7 = 0,
563     RPN_DATA_BITS_8 = 0
564 } rpn_data_bits_t;
565 
566 typedef enum rpn_stop_bits {
567     RPN_STOP_BITS_1_0 = 0,
568     RPN_STOP_BITS_1_5
569 } rpn_stop_bits_t;
570 
571 typedef enum rpn_parity {
572     RPN_PARITY_NONE  = 0,
573     RPN_PARITY_ODD   = 1,
574     RPN_PARITY_EVEN  = 3,
575     RPN_PARITY_MARK  = 5,
576     RPN_PARITY_SPACE = 7,
577 } rpn_parity_t;
578 
579 #define RPN_FLOW_CONTROL_XONXOFF_ON_INPUT  0x01
580 #define RPN_FLOW_CONTROL_XONXOFF_ON_OUTPUT 0x02
581 #define RPN_FLOW_CONTROL_RTR_ON_INPUT      0x04
582 #define RPN_FLOW_CONTROL_RTR_ON_OUTPUT     0x08
583 #define RPN_FLOW_CONTROL_RTC_ON_INPUT      0x10
584 #define RPN_FLOW_CONTROL_RTC_ON_OUTPUT     0x20
585 
586 #define RPN_PARAM_MASK_0_BAUD             0x01
587 #define RPN_PARAM_MASK_0_DATA_BITS        0x02
588 #define RPN_PARAM_MASK_0_STOP_BITS        0x04
589 #define RPN_PARAM_MASK_0_PARITY           0x08
590 #define RPN_PARAM_MASK_0_PARITY_TYPE      0x10
591 #define RPN_PARAM_MASK_0_XON_CHAR         0x20
592 #define RPN_PARAM_MASK_0_XOFF_CHAR        0x40
593 #define RPN_PARAM_MASK_0_RESERVED         0x80
594 
595 // @note: values are identical to rpn_flow_control_t
596 #define RPN_PARAM_MASK_1_XONOFF_ON_INPUT  0x01
597 #define RPN_PARAM_MASK_1_XONOFF_ON_OUTPUT 0x02
598 #define RPN_PARAM_MASK_1_RTR_ON_INPUT     0x04
599 #define RPN_PARAM_MASK_1_RTR_ON_OUTPUT    0x08
600 #define RPN_PARAM_MASK_1_RTC_ON_INPUT     0x10
601 #define RPN_PARAM_MASK_1_RTC_ON_OUTPUT    0x20
602 #define RPN_PARAM_MASK_1_RESERVED_0       0x40
603 #define RPN_PARAM_MASK_1_RESERVED_1       0x80
604 
605 /**
606  * BNEP Protocol
607  */
608 
609 #ifndef ETHER_ADDR_LEN
610 #define ETHER_ADDR_LEN 6
611 #endif
612 
613 #ifndef ETHERTYPE_VLAN
614 #define ETHERTYPE_VLAN                                  0x8100 /* IEEE 802.1Q VLAN tag */
615 #endif
616 
617 #define BNEP_MTU_MIN                                    1691
618 
619 
620 /**
621  * PAN Profile
622  */
623 
624 typedef enum {
625     BNEP_SECURITY_NONE = 0x0000,
626     BNEP_SECURITY_SERVICE_LEVEL_ENFORCED,
627     BNEP_SECURITY_802_1X
628 } security_description_t;
629 
630 typedef enum {
631     PAN_NET_ACCESS_TYPE_PSTN = 0x0000,
632     PAN_NET_ACCESS_TYPE_ISDN,
633     PAN_NET_ACCESS_TYPE_DSL,
634     PAN_NET_ACCESS_TYPE_CABLE_MODEM,
635     PAN_NET_ACCESS_TYPE_10MB_ETHERNET,
636     PAN_NET_ACCESS_TYPE_100MB_ETHERNET,
637     PAN_NET_ACCESS_TYPE_4MB_TOKEN_RING,
638     PAN_NET_ACCESS_TYPE_16MB_TOKEN_RING,
639     PAN_NET_ACCESS_TYPE_100MB_TOKEN_RING,
640     PAN_NET_ACCESS_TYPE_FDDI,
641     PAN_NET_ACCESS_TYPE_GSM,
642     PAN_NET_ACCESS_TYPE_CDMA,
643     PAN_NET_ACCESS_TYPE_GPRS,
644     PAN_NET_ACCESS_TYPE_3G,
645     PAN_NET_ACCESS_TYPE_CELULAR,
646     PAN_NET_ACCESS_TYPE_OTHER = 0xFFFE,
647     PAN_NET_ACCESS_TYPE_NONE
648 } net_access_type_t;
649 
650 /**
651  * ATT
652  */
653 
654 // Minimum/default MTU
655 #define ATT_DEFAULT_MTU               23
656 
657 // MARK: ATT Error Codes
658 #define ATT_ERROR_SUCCESS                          0x00
659 #define ATT_ERROR_INVALID_HANDLE                   0x01
660 #define ATT_ERROR_READ_NOT_PERMITTED               0x02
661 #define ATT_ERROR_WRITE_NOT_PERMITTED              0x03
662 #define ATT_ERROR_INVALID_PDU                      0x04
663 #define ATT_ERROR_INSUFFICIENT_AUTHENTICATION      0x05
664 #define ATT_ERROR_REQUEST_NOT_SUPPORTED            0x06
665 #define ATT_ERROR_INVALID_OFFSET                   0x07
666 #define ATT_ERROR_INSUFFICIENT_AUTHORIZATION       0x08
667 #define ATT_ERROR_PREPARE_QUEUE_FULL               0x09
668 #define ATT_ERROR_ATTRIBUTE_NOT_FOUND              0x0a
669 #define ATT_ERROR_ATTRIBUTE_NOT_LONG               0x0b
670 #define ATT_ERROR_INSUFFICIENT_ENCRYPTION_KEY_SIZE 0x0c
671 #define ATT_ERROR_INVALID_ATTRIBUTE_VALUE_LENGTH   0x0d
672 #define ATT_ERROR_UNLIKELY_ERROR                   0x0e
673 #define ATT_ERROR_INSUFFICIENT_ENCRYPTION          0x0f
674 #define ATT_ERROR_UNSUPPORTED_GROUP_TYPE           0x10
675 #define ATT_ERROR_INSUFFICIENT_RESOURCES           0x11
676 #define ATT_ERROR_VALUE_NOT_ALLOWED                0x13
677 
678 // MARK: ATT Error Codes defined by BTstack
679 #define ATT_ERROR_HCI_DISCONNECT_RECEIVED          0x1f
680 #define ATT_ERROR_BONDING_INFORMATION_MISSING      0x70
681 #define ATT_ERROR_DATA_MISMATCH                    0x7e
682 #define ATT_ERROR_TIMEOUT                          0x7F
683 #define ATT_ERROR_WRITE_RESPONSE_PENDING           0x100
684 
685 // MARK: ATT Error Codes from Cycling Power Service spec
686 #define CYCLING_POWER_ERROR_CODE_INAPPROPRIATE_CONNECTION_PARAMETERS                          0x80
687 #define CYCLING_POWER_ERROR_CODE_PROCEDURE_ALREADY_IN_PROGRESS                                0xFE
688 #define CYCLING_POWER_ERROR_CODE_CCC_DESCRIPTOR_IMPROPERLY_CONFIGURED                         0xFD
689 
690 // MARK: ATT Error Codes from Cycling Speed and Cadence Service spec
691 #define CYCLING_SPEED_AND_CADENCE_ERROR_CODE_PROCEDURE_ALREADY_IN_PROGRESS                    0x80
692 #define CYCLING_SPEED_AND_CADENCE_ERROR_CODE_CCC_DESCRIPTOR_IMPROPERLY_CONFIGURED             0x81
693 
694 
695 // MARK: Attribute Property Flags
696 #define ATT_PROPERTY_BROADCAST           0x01
697 #define ATT_PROPERTY_READ                0x02
698 #define ATT_PROPERTY_WRITE_WITHOUT_RESPONSE 0x04
699 #define ATT_PROPERTY_WRITE               0x08
700 #define ATT_PROPERTY_NOTIFY              0x10
701 #define ATT_PROPERTY_INDICATE            0x20
702 #define ATT_PROPERTY_AUTHENTICATED_SIGNED_WRITE 0x40
703 #define ATT_PROPERTY_EXTENDED_PROPERTIES 0x80
704 
705 // MARK: Attribute Property Flag, BTstack extension
706 // value is asked from client
707 #define ATT_PROPERTY_DYNAMIC             0x100
708 
709 // Security levels
710 #define ATT_SECURITY_NONE 0
711 #define ATT_SECURITY_ENCRYPTED 1
712 #define ATT_SECURITY_AUTHENTICATED 2
713 #define ATT_SECURITY_AUTHORIZED 3
714 #define ATT_SECURITY_AUTHENTICATED_SC 4
715 
716 // ATT Transaction Timeout of 30 seconds for Command/Response or Indication/Confirmation
717 #define ATT_TRANSACTION_TIMEOUT_MS     30000
718 
719 #define ATT_TRANSACTION_MODE_NONE      0x0
720 #define ATT_TRANSACTION_MODE_ACTIVE    0x1
721 #define ATT_TRANSACTION_MODE_EXECUTE   0x2
722 #define ATT_TRANSACTION_MODE_CANCEL    0x3
723 #define ATT_TRANSACTION_MODE_VALIDATE  0x4
724 
725 // MARK: GATT UUIDs
726 #define GATT_PRIMARY_SERVICE_UUID                   0x2800
727 #define GATT_SECONDARY_SERVICE_UUID                 0x2801
728 #define GATT_INCLUDE_SERVICE_UUID                   0x2802
729 #define GATT_CHARACTERISTICS_UUID                   0x2803
730 #define GATT_CHARACTERISTIC_EXTENDED_PROPERTIES     0x2900
731 #define GATT_CHARACTERISTIC_USER_DESCRIPTION        0x2901
732 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION   0x2902
733 #define GATT_SERVER_CHARACTERISTICS_CONFIGURATION   0x2903
734 #define GATT_CHARACTERISTIC_PRESENTATION_FORMAT     0x2904
735 #define GATT_CHARACTERISTIC_AGGREGATE_FORMAT        0x2905
736 
737 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NONE          0
738 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION  1
739 #define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION    2
740 
741 #define GATT_CLIENT_ANY_CONNECTION      0xffff
742 #define GATT_CLIENT_ANY_VALUE_HANDLE    0x0000
743 
744 // GAP Service and Characteristics
745 #define GAP_SERVICE_UUID               0x1800
746 #define GAP_DEVICE_NAME_UUID           0x2a00
747 #define GAP_APPEARANCE_UUID            0x2a01
748 #define GAP_PERIPHERAL_PRIVACY_FLAG    0x2a02
749 #define GAP_RECONNECTION_ADDRESS_UUID  0x2a03
750 #define GAP_PERIPHERAL_PREFERRED_CONNECTION_PARAMETERS_UUID 0x2a04
751 #define GAP_SERVICE_CHANGED            0x2a05
752 
753 // Bluetooth GATT types
754 
755 typedef struct {
756     uint16_t year;      // 0 - year  is not known; or [1582,9999]
757     uint8_t  month;     // 0 - month is not known; or [1,12]
758     uint8_t  day;       // 0 - day   is not known; or [1,31]
759     uint8_t  hours;     // [0,23]
760     uint8_t  minutes;   // [0,59]
761     uint8_t  seconds;   // [0,59]
762 } gatt_date_time_t;
763 
764 typedef enum {
765     GATT_MICROPHONE_CONTROL_MUTE_OFF = 0x00,
766     GATT_MICROPHONE_CONTROL_MUTE_ON,
767     GATT_MICROPHONE_CONTROL_MUTE_DISABLED
768 } gatt_microphone_control_mute_t;
769 
770 /**
771  * SM - LE Security Manager
772  */
773 // Bluetooth Spec definitions
774 typedef enum {
775     SM_CODE_PAIRING_REQUEST = 0X01,
776     SM_CODE_PAIRING_RESPONSE,
777     SM_CODE_PAIRING_CONFIRM,
778     SM_CODE_PAIRING_RANDOM,
779     SM_CODE_PAIRING_FAILED,
780     SM_CODE_ENCRYPTION_INFORMATION,
781     SM_CODE_MASTER_IDENTIFICATION,
782     SM_CODE_IDENTITY_INFORMATION,
783     SM_CODE_IDENTITY_ADDRESS_INFORMATION,
784     SM_CODE_SIGNING_INFORMATION,
785     SM_CODE_SECURITY_REQUEST,
786     SM_CODE_PAIRING_PUBLIC_KEY,
787     SM_CODE_PAIRING_DHKEY_CHECK,
788     SM_CODE_KEYPRESS_NOTIFICATION,
789 } SECURITY_MANAGER_COMMANDS;
790 
791 // IO Capability Values
792 typedef enum {
793     IO_CAPABILITY_DISPLAY_ONLY = 0,
794     IO_CAPABILITY_DISPLAY_YES_NO,
795     IO_CAPABILITY_KEYBOARD_ONLY,
796     IO_CAPABILITY_NO_INPUT_NO_OUTPUT,
797     IO_CAPABILITY_KEYBOARD_DISPLAY, // not used by secure simple pairing
798 } io_capability_t;
799 
800 // Authentication requirement flags
801 #define SM_AUTHREQ_NO_BONDING        0x00
802 #define SM_AUTHREQ_BONDING           0x01
803 #define SM_AUTHREQ_MITM_PROTECTION   0x04
804 #define SM_AUTHREQ_SECURE_CONNECTION 0x08
805 #define SM_AUTHREQ_KEYPRESS          0x10
806 #define SM_AUTHREQ_CT2               0x20
807 
808 // Key distribution flags used by spec
809 #define SM_KEYDIST_ENC_KEY  0x01
810 #define SM_KEYDIST_ID_KEY   0x02
811 #define SM_KEYDIST_SIGN     0x04
812 #define SM_KEYDIST_LINK_KEY 0x08
813 
814 // Key distribution flags used internally
815 #define SM_KEYDIST_FLAG_ENCRYPTION_INFORMATION       0x01
816 #define SM_KEYDIST_FLAG_MASTER_IDENTIFICATION        0x02
817 #define SM_KEYDIST_FLAG_IDENTITY_INFORMATION         0x04
818 #define SM_KEYDIST_FLAG_IDENTITY_ADDRESS_INFORMATION 0x08
819 #define SM_KEYDIST_FLAG_SIGNING_IDENTIFICATION       0x10
820 
821 // STK Generation Methods
822 #define SM_STK_GENERATION_METHOD_JUST_WORKS          0x01
823 #define SM_STK_GENERATION_METHOD_OOB                 0x02
824 #define SM_STK_GENERATION_METHOD_PASSKEY             0x04
825 #define SM_STK_GENERATION_METHOD_NUMERIC_COMPARISON  0x08
826 
827 // Pairing Failed Reasons
828 #define SM_REASON_RESERVED                     0x00
829 #define SM_REASON_PASSKEY_ENTRY_FAILED         0x01
830 #define SM_REASON_OOB_NOT_AVAILABLE            0x02
831 #define SM_REASON_AUTHENTHICATION_REQUIREMENTS 0x03
832 #define SM_REASON_CONFIRM_VALUE_FAILED         0x04
833 #define SM_REASON_PAIRING_NOT_SUPPORTED        0x05
834 #define SM_REASON_ENCRYPTION_KEY_SIZE          0x06
835 #define SM_REASON_COMMAND_NOT_SUPPORTED        0x07
836 #define SM_REASON_UNSPECIFIED_REASON           0x08
837 #define SM_REASON_REPEATED_ATTEMPTS            0x09
838 #define SM_REASON_INVALID_PARAMETERS           0x0a
839 #define SM_REASON_DHKEY_CHECK_FAILED           0x0b
840 #define SM_REASON_NUMERIC_COMPARISON_FAILED    0x0c
841 #define SM_REASON_BR_EDR_PAIRING_IN_PROGRESS   0x0d
842 #define SM_REASON_CROSS_TRANSPORT_KEY_DERIVATION_NOT_ALLOWED 0x0e
843 #define SM_REASON_KEY_REJECTED                 0x0f
844 
845 // also, invalid parameters
846 // and reserved
847 
848 // Keypress Notifications
849 #define SM_KEYPRESS_PASSKEY_ENTRY_STARTED      0x00
850 #define SM_KEYPRESS_PASSKEY_DIGIT_ENTERED      0x01
851 #define SM_KEYPRESS_PASSKEY_DIGIT_ERASED       0x02
852 #define SM_KEYPRESS_PASSKEY_CLEARED            0x03
853 #define SM_KEYPRESS_PASSKEY_ENTRY_COMPLETED    0x04
854 
855 
856 #endif
857