2015-11-15 21:23:43 +01:00
/*
* Copyright ( C ) 2015 BlueKitchen GmbH
*
* Redistribution and use in source and binary forms , with or without
* modification , are permitted provided that the following conditions
* are met :
*
* 1. Redistributions of source code must retain the above copyright
* notice , this list of conditions and the following disclaimer .
* 2. Redistributions in binary form must reproduce the above copyright
* notice , this list of conditions and the following disclaimer in the
* documentation and / or other materials provided with the distribution .
* 3. Neither the name of the copyright holders nor the names of
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission .
* 4. Any redistribution , use , or modification is done solely for
* personal benefit and not for any commercial purpose or for
* monetary gain .
*
* THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
* ` ` AS IS ' ' AND ANY EXPRESS OR IMPLIED WARRANTIES , INCLUDING , BUT NOT
* LIMITED TO , THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED . IN NO EVENT SHALL MATTHIAS
* RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT , INDIRECT ,
* INCIDENTAL , SPECIAL , EXEMPLARY , OR CONSEQUENTIAL DAMAGES ( INCLUDING ,
* BUT NOT LIMITED TO , PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES ; LOSS
* OF USE , DATA , OR PROFITS ; OR BUSINESS INTERRUPTION ) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY , WHETHER IN CONTRACT , STRICT LIABILITY ,
* OR TORT ( INCLUDING NEGLIGENCE OR OTHERWISE ) ARISING IN ANY WAY OUT OF
* THE USE OF THIS SOFTWARE , EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE .
*
* Please inquire about commercial licensing options at
* contact @ bluekitchen - gmbh . com
*
*/
/*
* bluetooth . h
*
* Numbers defined or derived from the official Bluetooth specification
*/
# ifndef __BLUETOOTH_H
# define __BLUETOOTH_H
# include <stdint.h>
2016-02-10 11:35:31 +01:00
/**
* @ brief hci connection handle type
*/
typedef uint16_t hci_con_handle_t ;
/**
* @ brief Length of a bluetooth device address .
*/
# define BD_ADDR_LEN 6
/**
* @ brief Bluetooth address
*/
typedef uint8_t bd_addr_t [ BD_ADDR_LEN ] ;
/**
* Address types
* @ note : BTstack uses a custom addr type to refer to classic ACL and SCO devices
*/
typedef enum {
BD_ADDR_TYPE_LE_PUBLIC = 0 ,
BD_ADDR_TYPE_LE_RANDOM = 1 ,
2017-01-18 11:50:45 +01:00
BD_ADDR_TYPE_LE_PRIVAT_FALLBACK_PUBLIC = 2 ,
BD_ADDR_TYPE_LE_PRIVAT_FALLBACK_RANDOM = 3 ,
2016-02-10 11:35:31 +01:00
BD_ADDR_TYPE_SCO = 0xfe ,
BD_ADDR_TYPE_CLASSIC = 0xff ,
BD_ADDR_TYPE_UNKNOWN = 0xfe
} bd_addr_type_t ;
2017-01-18 11:50:45 +01:00
2016-02-10 11:35:31 +01:00
/**
* @ brief link key
*/
# define LINK_KEY_LEN 16
# define LINK_KEY_STR_LEN (LINK_KEY_LEN*2)
typedef uint8_t link_key_t [ LINK_KEY_LEN ] ;
/**
* @ brief link key type
*/
typedef enum {
COMBINATION_KEY = 0 , // standard pairing
LOCAL_UNIT_KEY , // ?
REMOTE_UNIT_KEY , // ?
DEBUG_COMBINATION_KEY , // SSP with debug
UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192 , // SSP Simple Pairing
AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P192 , // SSP Passkey, Number confirm, OOB
CHANGED_COMBINATION_KEY , // Link key changed using Change Connection Lnk Key
UNAUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256 , // SSP Simpe Pairing
AUTHENTICATED_COMBINATION_KEY_GENERATED_FROM_P256 , // SSP Passkey, Number confirm, OOB
} link_key_type_t ;
2016-09-29 15:52:13 +02:00
/**
* @ brief Inquiry modes
*/
typedef enum {
INQUIRY_MODE_STANDARD = 0 ,
INQUIRY_MODE_RSSI ,
INQUIRY_MODE_RSSI_AND_EIR ,
} inquiry_mode_t ;
2017-07-12 17:24:42 +02:00
/*
* @ brief L2CAP Segmentation And Reassembly packet type in I - Frames
*/
typedef enum {
L2CAP_SEGMENTATION_AND_REASSEMBLY_UNSEGMENTED_L2CAP_SDU = 0 ,
L2CAP_SEGMENTATION_AND_REASSEMBLY_START_OF_L2CAP_SDU ,
L2CAP_SEGMENTATION_AND_REASSEMBLY_END_OF_L2CAP_SDU ,
L2CAP_SEGMENTATION_AND_REASSEMBLY_CONTINUATION_OF_L2CAP_SDU
} l2cap_segmentation_and_reassembly_t ;
/*
* @ brief L2CAP Supervisory function in S - Frames
*/
typedef enum {
L2CAP_SUPERVISORY_FUNCTION_RR_RECEIVER_READY = 0 ,
L2CAP_SUPERVISORY_FUNCTION_REJ_REJECT ,
L2CAP_SUPERVISORY_FUNCTION_RNR_RECEIVER_NOT_READY ,
L2CAP_SUPERVISORY_FUNCTION_SREJ_SELECTIVE_REJECT
} l2cap_supervisory_function_t ;
2017-07-25 14:22:40 +02:00
/**
* @ brief L2CAP Information Types used in Information Request & Response
*/
typedef enum {
L2CAP_INFO_TYPE_CONNECTIONLESS_MTU = 1 ,
L2CAP_INFO_TYPE_EXTENDED_FEATURES_SUPPORTED ,
L2CAP_INFO_TYPE_FIXED_CHANNELS_SUPPORTED ,
} l2cap_info_type_t ;
/**
* @ brief L2CAP Configuration Option Types used in Configurateion Request & Response
*/
typedef enum {
L2CAP_CONFIG_OPTION_TYPE_MAX_TRANSMISSION_UNIT = 1 ,
L2CAP_CONFIG_OPTION_TYPE_FLUSH_TIMEOUT ,
L2CAP_CONFIG_OPTION_TYPE_QUALITY_OF_SERVICE ,
L2CAP_CONFIG_OPTION_TYPE_RETRANSMISSION_AND_FLOW_CONTROL ,
L2CAP_CONFIG_OPTION_TYPE_FRAME_CHECK_SEQUENCE ,
L2CAP_CONFIG_OPTION_TYPE_EXTENDED_FLOW_SPECIFICATION ,
L2CAP_CONFIG_OPTION_TYPE_EXTENDED_WINDOW_SIZE ,
} l2cap_config_option_type_t ;
2015-11-15 21:23:43 +01:00
/**
* HCI Transport
*/
/**
* packet types - used in BTstack and over the H4 UART interface
*/
# define HCI_COMMAND_DATA_PACKET 0x01
# define HCI_ACL_DATA_PACKET 0x02
# define HCI_SCO_DATA_PACKET 0x03
# define HCI_EVENT_PACKET 0x04
2015-11-15 21:28:35 +01:00
// packet header sizes
# define HCI_CMD_HEADER_SIZE 3
2015-11-16 22:46:17 +01:00
# define HCI_ACL_HEADER_SIZE 4
# define HCI_SCO_HEADER_SIZE 3
2015-11-15 21:28:35 +01:00
# define HCI_EVENT_HEADER_SIZE 2
2015-11-15 21:23:43 +01:00
/**
* HCI Layer
*/
//
2017-06-07 14:41:34 +02:00
// Error Codes rfom Bluetooth Core Specification
2015-11-15 21:23:43 +01:00
//
2017-06-07 14:41:34 +02:00
/* ENUM_START: BLUETOOTH_ERROR_CODE */
2015-11-16 22:46:17 +01:00
# define ERROR_CODE_SUCCESS 0x00
2015-11-15 21:23:43 +01:00
# define ERROR_CODE_UNKNOWN_HCI_COMMAND 0x01
# define ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER 0x02
# define ERROR_CODE_HARDWARE_FAILURE 0x03
# define ERROR_CODE_PAGE_TIMEOUT 0x04
2015-11-16 22:46:17 +01:00
# define ERROR_CODE_AUTHENTICATION_FAILURE 0x05
2015-11-15 21:23:43 +01:00
# define ERROR_CODE_PIN_OR_KEY_MISSING 0x06
2015-11-16 22:46:17 +01:00
# define ERROR_CODE_MEMORY_CAPACITY_EXCEEDED 0x07
2015-11-15 21:23:43 +01:00
# define ERROR_CODE_CONNECTION_TIMEOUT 0x08
# define ERROR_CODE_CONNECTION_LIMIT_EXCEEDED 0x09
# define ERROR_CODE_SYNCHRONOUS_CONNECTION_LIMIT_TO_A_DEVICE_EXCEEDED 0x0A
# define ERROR_CODE_ACL_CONNECTION_ALREADY_EXISTS 0x0B
# define ERROR_CODE_COMMAND_DISALLOWED 0x0C
# define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_LIMITED_RESOURCES 0x0D
# define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_SECURITY_REASONS 0x0E
# define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_UNACCEPTABLE_BD_ADDR 0x0F
# define ERROR_CODE_CONNECTION_ACCEPT_TIMEOUT_EXCEEDED 0x10
# define ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE 0x11
# define ERROR_CODE_INVALID_HCI_COMMAND_PARAMETERS 0x12
# define ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION 0x13
# define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_LOW_RESOURCES 0x14
# define ERROR_CODE_REMOTE_DEVICE_TERMINATED_CONNECTION_DUE_TO_POWER_OFF 0x15
# define ERROR_CODE_CONNECTION_TERMINATED_BY_LOCAL_HOST 0x16
# define ERROR_CODE_REPEATED_ATTEMPTS 0x17
# define ERROR_CODE_PAIRING_NOT_ALLOWED 0x18
# define ERROR_CODE_UNKNOWN_LMP_PDU 0x19
# define ERROR_CODE_UNSUPPORTED_REMOTE_FEATURE_UNSUPPORTED_LMP_FEATURE 0x1A
# define ERROR_CODE_SCO_OFFSET_REJECTED 0x1B
# define ERROR_CODE_SCO_INTERVAL_REJECTED 0x1C
# define ERROR_CODE_SCO_AIR_MODE_REJECTED 0x1D
# define ERROR_CODE_INVALID_LMP_PARAMETERS_INVALID_LL_PARAMETERS 0x1E
# define ERROR_CODE_UNSPECIFIED_ERROR 0x1F
# define ERROR_CODE_UNSUPPORTED_LMP_PARAMETER_VALUE_UNSUPPORTED_LL_PARAMETER_VALUE 0x20
# define ERROR_CODE_ROLE_CHANGE_NOT_ALLOWED 0x21
# define ERROR_CODE_LMP_RESPONSE_TIMEOUT_LL_RESPONSE_TIMEOUT 0x22
# define ERROR_CODE_LMP_ERROR_TRANSACTION_COLLISION 0x23
# define ERROR_CODE_LMP_PDU_NOT_ALLOWED 0x24
# define ERROR_CODE_ENCRYPTION_MODE_NOT_ACCEPTABLE 0x25
# define ERROR_CODE_LINK_KEY_CANNOT_BE_CHANGED 0x26
# define ERROR_CODE_REQUESTED_QOS_NOT_SUPPORTED 0x27
# define ERROR_CODE_INSTANT_PASSED 0x28
# define ERROR_CODE_PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED 0x29
# define ERROR_CODE_DIFFERENT_TRANSACTION_COLLISION 0x2A
# define ERROR_CODE_RESERVED 0x2B
# define ERROR_CODE_QOS_UNACCEPTABLE_PARAMETER 0x2C
# define ERROR_CODE_QOS_REJECTED 0x2D
# define ERROR_CODE_CHANNEL_CLASSIFICATION_NOT_SUPPORTED 0x2E
# define ERROR_CODE_INSUFFICIENT_SECURITY 0x2F
# define ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE 0x30
// #define ERROR_CODE_RESERVED
# define ERROR_CODE_ROLE_SWITCH_PENDING 0x32
// #define ERROR_CODE_RESERVED
# define ERROR_CODE_RESERVED_SLOT_VIOLATION 0x34
# define ERROR_CODE_ROLE_SWITCH_FAILED 0x35
# define ERROR_CODE_EXTENDED_INQUIRY_RESPONSE_TOO_LARGE 0x36
# define ERROR_CODE_SECURE_SIMPLE_PAIRING_NOT_SUPPORTED_BY_HOST 0x37
# define ERROR_CODE_HOST_BUSY_PAIRING 0x38
# define ERROR_CODE_CONNECTION_REJECTED_DUE_TO_NO_SUITABLE_CHANNEL_FOUND 0x39
# define ERROR_CODE_CONTROLLER_BUSY 0x3A
# define ERROR_CODE_UNACCEPTABLE_CONNECTION_PARAMETERS 0x3B
# define ERROR_CODE_DIRECTED_ADVERTISING_TIMEOUT 0x3C
# define ERROR_CODE_CONNECTION_TERMINATED_DUE_TO_MIC_FAILURE 0x3D
# define ERROR_CODE_CONNECTION_FAILED_TO_BE_ESTABLISHED 0x3E
# define ERROR_CODE_MAC_CONNECTION_FAILED 0x3F
# define ERROR_CODE_COARSE_CLOCK_ADJUSTMENT_REJECTED_BUT_WILL_TRY_TO_ADJUST_USING_CLOCK_DRAGGING 0x40
2017-06-07 14:41:34 +02:00
/* ENUM_END */
2015-11-15 21:23:43 +01:00
2017-11-17 14:54:38 +01:00
/* ENUM_START: AVRCP_BROWSING_ERROR_CODE */
# define AVRCP_BROWSING_ERROR_CODE_INVALID_COMMAND 0x00 // Sent if TG received a PDU that it did not understand. Valid for All.
# 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.
# 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.
# 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.
# 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.
# define AVRCP_BROWSING_ERROR_CODE_UID_CHANGED 0x05 // The UIDs on the device have changed. Valid for All.
# define AVRCP_BROWSING_ERROR_CODE_RESERVED_06 0x06 // Valid for All.
# define AVRCP_BROWSING_ERROR_CODE_INVALID_DIRECTION 0x07 // The Direction parameter is invalid. Valid for Change Path.
# define AVRCP_BROWSING_ERROR_CODE_NOT_A_DIRECTORY 0x08 // The UID provided does not refer to a folder item. Valid for Change Path.
# 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.
# define AVRCP_BROWSING_ERROR_CODE_INVALID_SCOPE 0x0a // The scope parameter is invalid. Valid for GetFolderItems, PlayItem, AddToNowPlayer, GetItemAttributes,.
# define AVRCP_BROWSING_ERROR_CODE_RANGE_OUT_OF_BOUNDS 0x0b // The start of range provided is not valid. Valid for GetFolderItems.
# 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.
# 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.
# define AVRCP_BROWSING_ERROR_CODE_NOW_PLAYING_LIST_FULL 0x0e // No more items can be added to the Now Playing List. Valid for AddToNowPlaying.
# define AVRCP_BROWSING_ERROR_CODE_SEARCH_NOT_SUPPORTED 0x0f // The Browsed Media Player does not support search. Valid for Search.
# define AVRCP_BROWSING_ERROR_CODE_SEARCH_IN_PROGRESS 0x10 // A search operation is already in progress. Valid for Search.
# define AVRCP_BROWSING_ERROR_CODE_INVALID_PLAYER_ID 0x11 // The specified Player Id does not refer to a valid player. Valid for SetAddressedPlayer, SetBrowsedPlayer.
# 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.
# 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.
# 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.
# define AVRCP_BROWSING_ERROR_CODE_NO_AVAILABLE_PLAYERS 0x15 // Valid for All.
# define AVRCP_BROWSING_ERROR_CODE_ADDRESSED_PLAYER_CHANGED 0x16 // Valid for Register Notification.
// 0x17-0xff Reserved
/* ENUM_END */
2015-11-15 21:28:35 +01:00
// HCI roles
# define HCI_ROLE_MASTER 0
# define HCI_ROLE_SLAVE 1
// packet sizes (max payload)
# define HCI_ACL_DM1_SIZE 17
# define HCI_ACL_DH1_SIZE 27
# define HCI_ACL_2DH1_SIZE 54
# define HCI_ACL_3DH1_SIZE 83
# define HCI_ACL_DM3_SIZE 121
# define HCI_ACL_DH3_SIZE 183
# define HCI_ACL_DM5_SIZE 224
# define HCI_ACL_DH5_SIZE 339
# define HCI_ACL_2DH3_SIZE 367
# define HCI_ACL_3DH3_SIZE 552
# define HCI_ACL_2DH5_SIZE 679
# define HCI_ACL_3DH5_SIZE 1021
# define HCI_EVENT_PAYLOAD_SIZE 255
# define HCI_CMD_PAYLOAD_SIZE 255
# define LE_ADVERTISING_DATA_SIZE 31
2015-11-15 21:23:43 +01:00
/**
* Default INQ Mode
*/
# define HCI_INQUIRY_LAP 0x9E8B33L // 0x9E8B33: General/Unlimited Inquiry Access Code (GIAC)
/**
* SSP IO Capabilities
*/
# define SSP_IO_CAPABILITY_DISPLAY_ONLY 0
# define SSP_IO_CAPABILITY_DISPLAY_YES_NO 1
# define SSP_IO_CAPABILITY_KEYBOARD_ONLY 2
# define SSP_IO_CAPABILITY_NO_INPUT_NO_OUTPUT 3
# define SSP_IO_CAPABILITY_UNKNOWN 0xff
/**
* SSP Authentication Requirements , see IO Capability Request Reply Commmand
*/
// Numeric comparison with automatic accept allowed.
# define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_NO_BONDING 0x00
// Use IO Capabilities to deter- mine authentication procedure
# define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_NO_BONDING 0x01
// Numeric compar- ison with automatic accept allowed.
# define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_DEDICATED_BONDING 0x02
// Use IO Capabilities to determine authentication procedure
# define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_DEDICATED_BONDING 0x03
// Numeric Compari- son with automatic accept allowed.
# define SSP_IO_AUTHREQ_MITM_PROTECTION_NOT_REQUIRED_GENERAL_BONDING 0x04
2015-11-15 21:28:35 +01:00
// Use IO capabilities to determine authentication procedure.
2015-11-15 21:23:43 +01:00
# define SSP_IO_AUTHREQ_MITM_PROTECTION_REQUIRED_GENERAL_BONDING 0x05
2015-11-15 21:28:35 +01:00
// OGFs
# define OGF_LINK_CONTROL 0x01
# define OGF_LINK_POLICY 0x02
# define OGF_CONTROLLER_BASEBAND 0x03
# define OGF_INFORMATIONAL_PARAMETERS 0x04
# define OGF_STATUS_PARAMETERS 0x05
# define OGF_TESTING 0x06
# define OGF_LE_CONTROLLER 0x08
# define OGF_VENDOR 0x3f
2015-11-15 21:23:43 +01:00
// Events from host controller to host
/**
* @ format 1
* @ param status
*/
# define HCI_EVENT_INQUIRY_COMPLETE 0x01
/**
* @ format 1 B11132
* @ param num_responses
* @ param bd_addr
* @ param page_scan_repetition_mode
* @ param reserved1
* @ param reserved2
* @ param class_of_device
* @ param clock_offset
*/
# define HCI_EVENT_INQUIRY_RESULT 0x02
/**
* @ format 12 B11
* @ param status
* @ param connection_handle
* @ param bd_addr
* @ param link_type
* @ param encryption_enabled
*/
# define HCI_EVENT_CONNECTION_COMPLETE 0x03
/**
* @ format B31
* @ param bd_addr
* @ param class_of_device
* @ param link_type
*/
# define HCI_EVENT_CONNECTION_REQUEST 0x04
/**
* @ format 121
* @ param status
* @ param connection_handle
* @ param reason
*/
# define HCI_EVENT_DISCONNECTION_COMPLETE 0x05
/**
* @ format 12
* @ param status
* @ param connection_handle
*/
# define HCI_EVENT_AUTHENTICATION_COMPLETE_EVENT 0x06
/**
* @ format 1 BN
* @ param status
* @ param bd_addr
* @ param remote_name
*/
# define HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE 0x07
/**
* @ format 121
* @ param status
* @ param connection_handle
* @ param encryption_enabled
*/
# define HCI_EVENT_ENCRYPTION_CHANGE 0x08
/**
* @ format 12
* @ param status
* @ param connection_handle
*/
# define HCI_EVENT_CHANGE_CONNECTION_LINK_KEY_COMPLETE 0x09
/**
* @ format 121
* @ param status
* @ param connection_handle
* @ param key_flag
*/
# define HCI_EVENT_MASTER_LINK_KEY_COMPLETE 0x0A
2016-10-03 17:08:17 +02:00
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_READ_REMOTE_SUPPORTED_FEATURES_COMPLETE 0x0B
2016-10-03 17:08:17 +02:00
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_READ_REMOTE_VERSION_INFORMATION_COMPLETE 0x0C
2016-10-03 17:08:17 +02:00
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_QOS_SETUP_COMPLETE 0x0D
/**
* @ format 12 R
* @ param num_hci_command_packets
* @ param command_opcode
* @ param return_parameters
*/
# define HCI_EVENT_COMMAND_COMPLETE 0x0E
/**
* @ format 112
* @ param status
* @ param num_hci_command_packets
* @ param command_opcode
*/
# define HCI_EVENT_COMMAND_STATUS 0x0F
/**
2017-02-20 12:41:57 +01:00
* @ format 1
2015-11-15 21:23:43 +01:00
* @ param hardware_code
*/
# define HCI_EVENT_HARDWARE_ERROR 0x10
2016-10-03 17:08:17 +02:00
# define HCI_EVENT_FLUSH_OCCURRED 0x11
2015-11-15 21:23:43 +01:00
/**
* @ format 1 B1
* @ param status
* @ param bd_addr
* @ param role
*/
# define HCI_EVENT_ROLE_CHANGE 0x12
2016-04-01 13:39:07 +02:00
// TODO: number_of_handles 1, connection_handle[H*i], hc_num_of_completed_packets[2*i]
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_NUMBER_OF_COMPLETED_PACKETS 0x13
2016-04-01 13:39:07 +02:00
/**
* @ format 1 H12
* @ param status
* @ param handle
* @ param mode
* @ param interval
*/
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_MODE_CHANGE_EVENT 0x14
2016-04-01 13:39:07 +02:00
// TODO: num_keys, bd_addr[B*i], link_key[16 octets * i]
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_RETURN_LINK_KEYS 0x15
2016-04-01 13:39:07 +02:00
/**
* @ format B
* @ param bd_addr
*/
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_PIN_CODE_REQUEST 0x16
2016-04-01 13:39:07 +02:00
/**
* @ format B
* @ param bd_addr
*/
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_LINK_KEY_REQUEST 0x17
2016-04-01 13:39:07 +02:00
// TODO: bd_addr B, link_key 16octets, key_type 1
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_LINK_KEY_NOTIFICATION 0x18
2016-04-01 13:39:07 +02:00
/**
* @ format 1
* @ param link_type
*/
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_DATA_BUFFER_OVERFLOW 0x1A
2016-04-01 13:39:07 +02:00
/**
* @ format H1
* @ param handle
* @ param lmp_max_slots
*/
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_MAX_SLOTS_CHANGED 0x1B
2016-04-01 13:39:07 +02:00
/**
* @ format 1 H2
* @ param status
* @ param handle
* @ param clock_offset
*/
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_READ_CLOCK_OFFSET_COMPLETE 0x1C
2016-04-01 13:39:07 +02:00
/**
* @ format 1 H2
* @ param status
* @ param handle
2016-04-01 15:54:37 +02:00
* @ param packet_types
* @ pnote packet_type is in plural to avoid clash with Java binding Packet . getPacketType ( )
2016-04-01 13:39:07 +02:00
*/
2016-04-01 15:54:37 +02:00
# define HCI_EVENT_CONNECTION_PACKET_TYPE_CHANGED 0x1D
2015-11-15 21:23:43 +01:00
/**
* @ format 1 B11321
* @ param num_responses
* @ param bd_addr
* @ param page_scan_repetition_mode
* @ param reserved
* @ param class_of_device
* @ param clock_offset
* @ param rssi
*/
# define HCI_EVENT_INQUIRY_RESULT_WITH_RSSI 0x22
/**
* @ format 1 HB111221
* @ param status
* @ param handle
* @ param bd_addr
* @ param link_type
* @ param transmission_interval
* @ param retransmission_interval
* @ param rx_packet_length
* @ param tx_packet_length
* @ param air_mode
*/
# define HCI_EVENT_SYNCHRONOUS_CONNECTION_COMPLETE 0x2C
// TODO: serialize extended_inquiry_response and provide parser
/**
* @ format 1 B11321
* @ param num_responses
* @ param bd_addr
* @ param page_scan_repetition_mode
* @ param reserved
* @ param class_of_device
* @ param clock_offset
* @ param rssi
*/
# define HCI_EVENT_EXTENDED_INQUIRY_RESPONSE 0x2F
/**
* @ format 1 H
* @ param status
* @ param handle
*/
# define HCI_EVENT_ENCRYPTION_KEY_REFRESH_COMPLETE 0x30
# define HCI_EVENT_IO_CAPABILITY_REQUEST 0x31
# define HCI_EVENT_IO_CAPABILITY_RESPONSE 0x32
2016-10-03 17:08:17 +02:00
/**
* @ format B4
* @ param bd_addr
* @ param numeric_value
*/
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_USER_CONFIRMATION_REQUEST 0x33
2016-10-03 17:08:17 +02:00
/**
* @ format B
* @ param bd_addr
*/
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_USER_PASSKEY_REQUEST 0x34
2016-10-03 17:08:17 +02:00
/**
* @ format B
* @ param bd_addr
*/
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_REMOTE_OOB_DATA_REQUEST 0x35
2016-10-03 17:08:17 +02:00
/**
* @ format 1 B
* @ param status
* @ param bd_addr
*/
2015-11-15 21:23:43 +01:00
# define HCI_EVENT_SIMPLE_PAIRING_COMPLETE 0x36
# define HCI_EVENT_LE_META 0x3E
2016-11-07 15:15:48 +01:00
// last used HCI_EVENT in 2.1 is 0x3d
// last used HCI_EVENT in 4.1 is 0x57
2015-11-15 22:44:52 +01:00
# define HCI_EVENT_VENDOR_SPECIFIC 0xFF
2015-11-15 21:23:43 +01:00
/**
2016-02-19 11:11:17 +01:00
* @ format 11 H11B2221
2015-11-15 21:23:43 +01:00
* @ param subevent_code
* @ param status
* @ param connection_handle
* @ param role
* @ param peer_address_type
* @ param peer_address
* @ param conn_interval
* @ param conn_latency
* @ param supervision_timeout
* @ param master_clock_accuracy
*/
# define HCI_SUBEVENT_LE_CONNECTION_COMPLETE 0x01
2016-11-07 15:15:48 +01:00
// array of advertisements, not handled by event accessor generator
2015-11-15 21:23:43 +01:00
# define HCI_SUBEVENT_LE_ADVERTISING_REPORT 0x02
2016-11-07 15:15:48 +01:00
/**
* @ format 11 H222
* @ param subevent_code
* @ param status
* @ param connection_handle
* @ param conn_interval
* @ param conn_latency
2017-02-20 12:41:57 +01:00
* @ param supervision_timeout
2016-11-07 15:15:48 +01:00
*/
# define HCI_SUBEVENT_LE_CONNECTION_UPDATE_COMPLETE 0x03
/**
* @ format 1 HD2
* @ param subevent_code
* @ param connection_handle
* @ param random_number
* @ param encryption_diversifier
*/
2015-11-15 21:23:43 +01:00
# define HCI_SUBEVENT_LE_READ_REMOTE_USED_FEATURES_COMPLETE 0x04
2016-11-07 15:15:48 +01:00
/**
* @ format 1 HD2
* @ param subevent_code
* @ param connection_handle
* @ param random_number
* @ param encryption_diversifier
*/
2015-11-15 21:23:43 +01:00
# define HCI_SUBEVENT_LE_LONG_TERM_KEY_REQUEST 0x05
2016-11-07 15:15:48 +01:00
/**
* @ format 1 H2222
* @ param subevent_code
* @ param connection_handle
* @ param interval_min
* @ param interval_max
* @ param latency
* @ param timeout
*/
# define HCI_SUBEVENT_LE_REMOTE_CONNECTION_PARAMETER_REQUEST 0x06
/**
* @ format 1 H2222
* @ param subevent_code
* @ param connection_handle
* @ param max_tx_octets
* @ param max_tx_time
* @ param max_rx_octets
* @ param max_rx_time
*/
# define HCI_SUBEVENT_LE_DATA_LENGTH_CHANGE 0x07
/**
* @ format 11 QQ
* @ param subevent_code
* @ param status
* @ param dhkey_x x coordinate of P256 public key
* @ param dhkey_y y coordinate of P256 public key
*/
# define HCI_SUBEVENT_LE_READ_LOCAL_P256_PUBLIC_KEY_COMPLETE 0x08
/**
2017-08-28 18:05:37 +02:00
* @ format 11 Q
2016-11-07 15:15:48 +01:00
* @ param subevent_code
* @ param status
2017-08-28 18:05:37 +02:00
* @ param dhkey Diffie - Hellman key
2016-11-07 15:15:48 +01:00
*/
# define HCI_SUBEVENT_LE_GENERATE_DHKEY_COMPLETE 0x09
/**
* @ format 11 H11BBB2221
* @ param subevent_code
* @ param status
* @ param connection_handle
* @ param role
* @ param peer_address_type
* @ param perr_addresss
* @ param local_resolvable_private_addres
* @ param peer_resolvable_private_addres
* @ param conn_interval
* @ param conn_latency
* @ param supervision_timeout
* @ param master_clock_accuracy
*/
# define HCI_SUBEVENT_LE_ENHANCED_CONNECTION_COMPLETE 0x0A
// array of advertisements, not handled by event accessor generator
# define HCI_SUBEVENT_LE_DIRECT_ADVERTISING_REPORT 0x0B
2015-11-15 21:23:43 +01:00
/**
* L2CAP Layer
*/
2015-11-15 21:34:05 +01:00
# define L2CAP_HEADER_SIZE 4
# define L2CAP_SIG_ID_INVALID 0
// size of HCI ACL + L2CAP Header for regular data packets (8)
# define COMPLETE_L2CAP_HEADER (HCI_ACL_HEADER_SIZE + L2CAP_HEADER_SIZE)
// minimum signaling MTU
# define L2CAP_MINIMAL_MTU 48
# define L2CAP_DEFAULT_MTU 672
// Minimum/default MTU
# define L2CAP_LE_DEFAULT_MTU 23
// L2CAP Fixed Channel IDs
# define L2CAP_CID_SIGNALING 0x0001
# define L2CAP_CID_CONNECTIONLESS_CHANNEL 0x0002
# define L2CAP_CID_ATTRIBUTE_PROTOCOL 0x0004
# define L2CAP_CID_SIGNALING_LE 0x0005
# define L2CAP_CID_SECURITY_MANAGER_PROTOCOL 0x0006
// L2CAP Configuration Result Codes
2017-07-12 21:51:28 +02:00
# define L2CAP_CONF_RESULT_SUCCESS 0x0000
# define L2CAP_CONF_RESULT_UNACCEPTABLE_PARAMETERS 0x0001
# define L2CAP_CONF_RESULT_REJECT 0x0002
# define L2CAP_CONF_RESULT_UNKNOWN_OPTIONS 0x0003
# define L2CAP_CONF_RESULT_PENDING 0x0004
# define L2CAP_CONF_RESULT_FLOW_SPEC_REJECTED 0x0005
2015-11-15 21:34:05 +01:00
// L2CAP Reject Result Codes
# define L2CAP_REJ_CMD_UNKNOWN 0x0000
// Response Timeout eXpired
# define L2CAP_RTX_TIMEOUT_MS 10000
// Extended Response Timeout eXpired
# define L2CAP_ERTX_TIMEOUT_MS 120000
2017-05-30 11:20:23 +02:00
//
// Fixed PSM numbers from https://www.bluetooth.com/specifications/assigned-numbers/logical-link-control
//
// @TODO: replace with BLUETOOTH_PROTOCOL_xxx in rest of code
2017-03-26 22:19:18 +02:00
# define PSM_SDP BLUETOOTH_PROTOCOL_SDP
# define PSM_RFCOMM BLUETOOTH_PROTOCOL_RFCOMM
# define PSM_BNEP BLUETOOTH_PROTOCOL_BNEP
2017-05-30 11:20:23 +02:00
// @TODO: scrape PSMs Bluetooth SIG site and put in bluetooth_psm.h or bluetooth_l2cap.h
2015-11-15 21:23:43 +01:00
# define PSM_HID_CONTROL 0x11
# define PSM_HID_INTERRUPT 0x13
2017-05-30 11:20:23 +02:00
# define PSM_IPSP 0x23
2015-11-15 21:23:43 +01:00
2015-11-15 21:45:53 +01:00
/**
2017-03-26 22:19:18 +02:00
* SDP Protocol
2015-11-15 21:45:53 +01:00
*/
// PDU Types
typedef enum {
SDP_Invalid = 0 ,
2015-11-16 22:46:17 +01:00
SDP_ErrorResponse = 1 ,
SDP_ServiceSearchRequest ,
SDP_ServiceSearchResponse ,
SDP_ServiceAttributeRequest ,
SDP_ServiceAttributeResponse ,
SDP_ServiceSearchAttributeRequest ,
SDP_ServiceSearchAttributeResponse
2015-11-15 21:45:53 +01:00
} SDP_PDU_ID_t ;
2017-03-26 22:19:18 +02:00
/* Please use assigned numbers from bluetooth_sdp.h instead for thsese ...*/
2015-11-15 21:45:53 +01:00
// UNIVERSAL ATTRIBUTE DEFINITIONS
2017-03-26 22:19:18 +02:00
# define SDP_ServiceRecordHandle BLUETOOTH_ATTRIBUTE_SERVICE_RECORD_HANDLE
# define SDP_ServiceClassIDList BLUETOOTH_ATTRIBUTE_SERVICE_CLASS_ID_LIST
# define SDP_ServiceRecordState BLUETOOTH_ATTRIBUTE_SERVICE_RECORD_STATE
# define SDP_ServiceID BLUETOOTH_ATTRIBUTE_SERVICE_ID
# define SDP_ProtocolDescriptorList BLUETOOTH_ATTRIBUTE_PROTOCOL_DESCRIPTOR_LIST
# define SDP_BrowseGroupList BLUETOOTH_ATTRIBUTE_BROWSE_GROUP_LIST
# define SDP_LanguageBaseAttributeIDList BLUETOOTH_ATTRIBUTE_LANGUAGE_BASE_ATTRIBUTE_ID_LIST
# define SDP_ServiceInfoTimeToLive BLUETOOTH_ATTRIBUTE_SERVICE_INFO_TIME_TO_LIVE
# define SDP_ServiceAvailability BLUETOOTH_ATTRIBUTE_SERVICE_AVAILABILITY
# define SDP_BluetoothProfileDescriptorList BLUETOOTH_ATTRIBUTE_BLUETOOTH_PROFILE_DESCRIPTOR_LIST
# define SDP_DocumentationURL BLUETOOTH_ATTRIBUTE_DOCUMENTATION_URL
# define SDP_ClientExecutableURL BLUETOOTH_ATTRIBUTE_CLIENT_EXECUTABLE_URL
# define SDP_IconURL BLUETOOTH_ATTRIBUTE_ICON_URL
# define SDP_AdditionalProtocolDescriptorList BLUETOOTH_ATTRIBUTE_ADDITIONAL_PROTOCOL_DESCRIPTOR_LISTS
# define SDP_SupportedFormatsList BLUETOOTH_ATTRIBUTE_SUPPORTED_FORMATS_LIST
2015-11-15 21:45:53 +01:00
// SERVICE CLASSES
2017-03-26 22:19:18 +02:00
# define SDP_OBEXObjectPush BLUETOOTH_SERVICE_CLASS_OBEX_OBJECT_PUSH
# define SDP_OBEXFileTransfer BLUETOOTH_SERVICE_CLASS_OBEX_FILE_TRANSFER
# define SDP_PublicBrowseGroup BLUETOOTH_ATTRIBUTE_PUBLIC_BROWSE_ROOT
# define SDP_HSP BLUETOOTH_SERVICE_CLASS_HEADSET
# define SDP_Headset_AG BLUETOOTH_SERVICE_CLASS_HEADSET_AUDIO_GATEWAY_AG
# define SDP_PANU BLUETOOTH_SERVICE_CLASS_PANU
# define SDP_NAP BLUETOOTH_SERVICE_CLASS_NAP
# define SDP_GN BLUETOOTH_SERVICE_CLASS_GN
# define SDP_Handsfree BLUETOOTH_SERVICE_CLASS_HANDSFREE
# define SDP_HandsfreeAudioGateway BLUETOOTH_SERVICE_CLASS_HANDSFREE_AUDIO_GATEWAY
# define SDP_Headset_HS BLUETOOTH_SERVICE_CLASS_HEADSET_HS
# define SDP_GenericAudio BLUETOOTH_SERVICE_CLASS_GENERIC_AUDIO
2015-11-15 21:45:53 +01:00
// PROTOCOLS
2017-03-26 22:19:18 +02:00
# define SDP_SDPProtocol BLUETOOTH_PROTOCOL_SDP
# define SDP_UDPProtocol BLUETOOTH_PROTOCOL_UDP
# define SDP_RFCOMMProtocol BLUETOOTH_PROTOCOL_RFCOMM
# define SDP_OBEXProtocol BLUETOOTH_PROTOCOL_OBEX
# define SDP_L2CAPProtocol BLUETOOTH_PROTOCOL_L2CAP
# define SDP_BNEPProtocol BLUETOOTH_PROTOCOL_BNEP
# define SDP_AVDTPProtocol BLUETOOTH_PROTOCOL_AVDTP
/** .. until here ..*/
2015-11-15 21:45:53 +01:00
// OFFSETS FOR LOCALIZED ATTRIBUTES - SDP_LanguageBaseAttributeIDList
# define SDP_Offest_ServiceName 0x0000
# define SDP_Offest_ServiceDescription 0x0001
# define SDP_Offest_ProviderName 0x0002
2017-02-22 17:28:57 +01:00
// Device Vendor ID Sources
# define DEVICE_ID_VENDOR_ID_SOURCE_BLUETOOTH 0x0001
# define DEVICE_ID_VENDOR_ID_SOURCE_USB 0x0002
2015-11-15 21:45:53 +01:00
// OBEX
# define SDP_vCard_2_1 0x01
# define SDP_vCard_3_0 0x02
# define SDP_vCal_1_0 0x03
# define SDP_iCal_2_0 0x04
# define SDP_vNote 0x05
# define SDP_vMessage 0x06
# define SDP_OBEXFileTypeAny 0xFF
2015-11-15 21:42:40 +01:00
/**
* RFCOMM Protocol
*/
// Control field values bit no. 1 2 3 4 PF 6 7 8
# define BT_RFCOMM_SABM 0x3F // 1 1 1 1 1 1 0 0
# define BT_RFCOMM_UA 0x73 // 1 1 0 0 1 1 1 0
# define BT_RFCOMM_DM 0x0F // 1 1 1 1 0 0 0 0
2015-11-16 22:46:17 +01:00
# define BT_RFCOMM_DM_PF 0x1F // 1 1 1 1 1 0 0 0
2015-11-15 21:42:40 +01:00
# define BT_RFCOMM_DISC 0x53 // 1 1 0 0 1 0 1 0
# define BT_RFCOMM_UIH 0xEF // 1 1 1 1 0 1 1 1
# define BT_RFCOMM_UIH_PF 0xFF // 1 1 1 1 0 1 1 1
// Multiplexer message types
# define BT_RFCOMM_CLD_CMD 0xC3
# define BT_RFCOMM_FCON_CMD 0xA3
# define BT_RFCOMM_FCON_RSP 0xA1
# define BT_RFCOMM_FCOFF_CMD 0x63
# define BT_RFCOMM_FCOFF_RSP 0x61
# define BT_RFCOMM_MSC_CMD 0xE3
# define BT_RFCOMM_MSC_RSP 0xE1
# define BT_RFCOMM_NSC_RSP 0x11
# define BT_RFCOMM_PN_CMD 0x83
# define BT_RFCOMM_PN_RSP 0x81
# define BT_RFCOMM_RLS_CMD 0x53
# define BT_RFCOMM_RLS_RSP 0x51
# define BT_RFCOMM_RPN_CMD 0x93
# define BT_RFCOMM_RPN_RSP 0x91
# define BT_RFCOMM_TEST_CMD 0x23
# define BT_RFCOMM_TEST_RSP 0x21
// Line Status
# define LINE_STATUS_NO_ERROR 0x00
# define LINE_STATUS_OVERRUN_ERROR 0x03
# define LINE_STATUS_PARITY_ERORR 0x05
# define LINE_STATUS_FRAMING_ERROR 0x09
// Modem Status Flags
# define MODEM_STATUS_FC 0x02
# define MODEM_STATUS_RTC 0x04
# define MODEM_STATUS_RTR 0x08
# define MODEM_STATUS_IC 0x40
# define MODEM_STATUS_DV 0x80
typedef enum rpn_baud {
RPN_BAUD_2400 = 0 ,
RPN_BAUD_4800 ,
RPN_BAUD_7200 ,
RPN_BAUD_9600 ,
RPN_BAUD_19200 ,
RPN_BAUD_38400 ,
RPN_BAUD_57600 ,
RPN_BAUD_115200 ,
RPN_BAUD_230400
} rpn_baud_t ;
typedef enum rpn_data_bits {
RPN_DATA_BITS_5 = 0 ,
RPN_DATA_BITS_6 = 0 ,
RPN_DATA_BITS_7 = 0 ,
RPN_DATA_BITS_8 = 0
} rpn_data_bits_t ;
typedef enum rpn_stop_bits {
RPN_STOP_BITS_1_0 = 0 ,
RPN_STOP_BITS_1_5
} rpn_stop_bits_t ;
typedef enum rpn_parity {
RPN_PARITY_NONE = 0 ,
RPN_PARITY_ODD = 1 ,
RPN_PARITY_EVEN = 3 ,
RPN_PARITY_MARK = 5 ,
RPN_PARITY_SPACE = 7 ,
} rpn_parity_t ;
typedef enum rpn_flow_control {
RPN_FLOW_CONTROL_XONXOFF_ON_INPUT = 1 < < 0 ,
RPN_FLOW_CONTROL_XONXOFF_ON_OUTPUT = 1 < < 1 ,
RPN_FLOW_CONTROL_RTR_ON_INPUT = 1 < < 2 ,
RPN_FLOW_CONTROL_RTR_ON_OUTPUT = 1 < < 3 ,
RPN_FLOW_CONTROL_RTC_ON_INPUT = 1 < < 4 ,
RPN_FLOW_CONTROL_RTC_ON_OUTPUT = 1 < < 5 ,
} rpn_flow_control_t ;
# define RPN_PARAM_MASK_0_BAUD 0x01
# define RPN_PARAM_MASK_0_DATA_BITS 0x02
# define RPN_PARAM_MASK_0_STOP_BITS 0x04
# define RPN_PARAM_MASK_0_PARITY 0x08
# define RPN_PARAM_MASK_0_PARITY_TYPE 0x10
# define RPN_PARAM_MASK_0_XON_CHAR 0x20
# define RPN_PARAM_MASK_0_XOFF_CHAR 0x40
# define RPN_PARAM_MASK_0_RESERVED 0x80
// @note: values are identical to rpn_flow_control_t
# define RPN_PARAM_MASK_1_XONOFF_ON_INPUT 0x01
# define RPN_PARAM_MASK_1_XONOFF_ON_OUTPUT 0x02
# define RPN_PARAM_MASK_1_RTR_ON_INPUT 0x04
# define RPN_PARAM_MASK_1_RTR_ON_OUTPUT 0x08
# define RPN_PARAM_MASK_1_RTC_ON_INPUT 0x10
# define RPN_PARAM_MASK_1_RTC_ON_OUTPUT 0x20
# define RPN_PARAM_MASK_1_RESERVED_0 0x40
# define RPN_PARAM_MASK_1_RESERVED_1 0x80
2015-11-15 21:39:57 +01:00
/**
* BNEP Protocol
*/
# ifndef ETHER_ADDR_LEN
2016-01-04 16:45:25 +01:00
# define ETHER_ADDR_LEN 6
2015-11-15 21:39:57 +01:00
# endif
# ifndef ETHERTYPE_VLAN
2015-11-16 22:46:17 +01:00
# define ETHERTYPE_VLAN 0x8100 /* IEEE 802.1Q VLAN tag */
2015-11-15 21:39:57 +01:00
# endif
# define BNEP_MTU_MIN 1691
2015-11-15 21:23:43 +01:00
2015-11-15 21:39:57 +01:00
# define BNEP_EXT_FLAG 0x80
# define BNEP_TYPE_MASK 0x7F
2015-11-16 22:46:17 +01:00
# define BNEP_TYPE(header) ((header) & BNEP_TYPE_MASK)
# define BNEP_HEADER_HAS_EXT(x) (((x) & BNEP_EXT_FLAG) == BNEP_EXT_FLAG)
2015-11-15 21:39:57 +01:00
/* BNEP packet types */
2015-11-16 22:46:17 +01:00
# define BNEP_PKT_TYPE_GENERAL_ETHERNET 0x00
# define BNEP_PKT_TYPE_CONTROL 0x01
# define BNEP_PKT_TYPE_COMPRESSED_ETHERNET 0x02
# define BNEP_PKT_TYPE_COMPRESSED_ETHERNET_SOURCE_ONLY 0x03
# define BNEP_PKT_TYPE_COMPRESSED_ETHERNET_DEST_ONLY 0x04
2015-11-15 21:39:57 +01:00
/* BNEP control types */
2015-11-16 22:46:17 +01:00
# define BNEP_CONTROL_TYPE_COMMAND_NOT_UNDERSTOOD 0x00
# define BNEP_CONTROL_TYPE_SETUP_CONNECTION_REQUEST 0x01
# define BNEP_CONTROL_TYPE_SETUP_CONNECTION_RESPONSE 0x02
# define BNEP_CONTROL_TYPE_FILTER_NET_TYPE_SET 0x03
# define BNEP_CONTROL_TYPE_FILTER_NET_TYPE_RESPONSE 0x04
# define BNEP_CONTROL_TYPE_FILTER_MULTI_ADDR_SET 0x05
# define BNEP_CONTROL_TYPE_FILTER_MULTI_ADDR_RESPONSE 0x06
2015-11-15 21:39:57 +01:00
/* BNEP extension header types */
2015-11-16 22:46:17 +01:00
# define BNEP_EXT_HEADER_TYPE_EXTENSION_CONTROL 0x00
2015-11-15 21:39:57 +01:00
/* BNEP setup response codes */
2015-11-16 22:46:17 +01:00
# define BNEP_RESP_SETUP_SUCCESS 0x0000
# define BNEP_RESP_SETUP_INVALID_DEST_UUID 0x0001
# define BNEP_RESP_SETUP_INVALID_SOURCE_UUID 0x0002
# define BNEP_RESP_SETUP_INVALID_SERVICE_UUID_SIZE 0x0003
# define BNEP_RESP_SETUP_CONNECTION_NOT_ALLOWED 0x0004
2015-11-15 21:39:57 +01:00
/* BNEP filter response codes */
2015-11-16 22:46:17 +01:00
# define BNEP_RESP_FILTER_SUCCESS 0x0000
# define BNEP_RESP_FILTER_UNSUPPORTED_REQUEST 0x0001
# define BNEP_RESP_FILTER_ERR_INVALID_RANGE 0x0002
# define BNEP_RESP_FILTER_ERR_TOO_MANY_FILTERS 0x0003
# define BNEP_RESP_FILTER_ERR_SECURITY 0x0004
2015-11-15 21:39:57 +01:00
/**
* PAN Profile
*/
2015-11-15 21:23:43 +01:00
2015-11-15 21:39:57 +01:00
typedef enum {
2015-11-16 22:46:17 +01:00
BNEP_SECURITY_NONE = 0x0000 ,
BNEP_SECURITY_SERVICE_LEVEL_ENFORCED ,
BNEP_SECURITY_802_1X
2015-11-15 21:39:57 +01:00
} security_description_t ;
typedef enum {
2015-11-16 22:46:17 +01:00
PAN_NET_ACCESS_TYPE_PSTN = 0x0000 ,
PAN_NET_ACCESS_TYPE_ISDN ,
PAN_NET_ACCESS_TYPE_DSL ,
PAN_NET_ACCESS_TYPE_CABLE_MODEM ,
PAN_NET_ACCESS_TYPE_10MB_ETHERNET ,
PAN_NET_ACCESS_TYPE_100MB_ETHERNET ,
PAN_NET_ACCESS_TYPE_4MB_TOKEN_RING ,
PAN_NET_ACCESS_TYPE_16MB_TOKEN_RING ,
PAN_NET_ACCESS_TYPE_100MB_TOKEN_RING ,
PAN_NET_ACCESS_TYPE_FDDI ,
PAN_NET_ACCESS_TYPE_GSM ,
PAN_NET_ACCESS_TYPE_CDMA ,
PAN_NET_ACCESS_TYPE_GPRS ,
PAN_NET_ACCESS_TYPE_3G ,
PAN_NET_ACCESS_TYPE_CELULAR ,
PAN_NET_ACCESS_TYPE_OTHER = 0xFFFE ,
PAN_NET_ACCESS_TYPE_NONE
2015-11-15 21:39:57 +01:00
} net_access_type_t ;
2015-11-15 21:23:43 +01:00
2015-11-15 21:51:01 +01:00
/**
* ATT
*/
// Minimum/default MTU
# define ATT_DEFAULT_MTU 23
// MARK: Attribute PDU Opcodes
# define ATT_ERROR_RESPONSE 0x01
# define ATT_EXCHANGE_MTU_REQUEST 0x02
# define ATT_EXCHANGE_MTU_RESPONSE 0x03
# define ATT_FIND_INFORMATION_REQUEST 0x04
# define ATT_FIND_INFORMATION_REPLY 0x05
# define ATT_FIND_BY_TYPE_VALUE_REQUEST 0x06
# define ATT_FIND_BY_TYPE_VALUE_RESPONSE 0x07
# define ATT_READ_BY_TYPE_REQUEST 0x08
# define ATT_READ_BY_TYPE_RESPONSE 0x09
# define ATT_READ_REQUEST 0x0a
# define ATT_READ_RESPONSE 0x0b
# define ATT_READ_BLOB_REQUEST 0x0c
# define ATT_READ_BLOB_RESPONSE 0x0d
# define ATT_READ_MULTIPLE_REQUEST 0x0e
# define ATT_READ_MULTIPLE_RESPONSE 0x0f
# define ATT_READ_BY_GROUP_TYPE_REQUEST 0x10
# define ATT_READ_BY_GROUP_TYPE_RESPONSE 0x11
# define ATT_WRITE_REQUEST 0x12
# define ATT_WRITE_RESPONSE 0x13
# define ATT_PREPARE_WRITE_REQUEST 0x16
# define ATT_PREPARE_WRITE_RESPONSE 0x17
# define ATT_EXECUTE_WRITE_REQUEST 0x18
# define ATT_EXECUTE_WRITE_RESPONSE 0x19
# define ATT_HANDLE_VALUE_NOTIFICATION 0x1b
# define ATT_HANDLE_VALUE_INDICATION 0x1d
# define ATT_HANDLE_VALUE_CONFIRMATION 0x1e
# define ATT_WRITE_COMMAND 0x52
# define ATT_SIGNED_WRITE_COMMAND 0xD2
// MARK: ATT Error Codes
# define ATT_ERROR_INVALID_HANDLE 0x01
# define ATT_ERROR_READ_NOT_PERMITTED 0x02
# define ATT_ERROR_WRITE_NOT_PERMITTED 0x03
# define ATT_ERROR_INVALID_PDU 0x04
# define ATT_ERROR_INSUFFICIENT_AUTHENTICATION 0x05
# define ATT_ERROR_REQUEST_NOT_SUPPORTED 0x06
# define ATT_ERROR_INVALID_OFFSET 0x07
# define ATT_ERROR_INSUFFICIENT_AUTHORIZATION 0x08
# define ATT_ERROR_PREPARE_QUEUE_FULL 0x09
# define ATT_ERROR_ATTRIBUTE_NOT_FOUND 0x0a
# define ATT_ERROR_ATTRIBUTE_NOT_LONG 0x0b
# define ATT_ERROR_INSUFFICIENT_ENCRYPTION_KEY_SIZE 0x0c
# define ATT_ERROR_INVALID_ATTRIBUTE_VALUE_LENGTH 0x0d
# define ATT_ERROR_UNLIKELY_ERROR 0x0e
# define ATT_ERROR_INSUFFICIENT_ENCRYPTION 0x0f
# define ATT_ERROR_UNSUPPORTED_GROUP_TYPE 0x10
# define ATT_ERROR_INSUFFICIENT_RESOURCES 0x11
// MARK: Attribute Property Flags
# define ATT_PROPERTY_BROADCAST 0x01
# define ATT_PROPERTY_READ 0x02
# define ATT_PROPERTY_WRITE_WITHOUT_RESPONSE 0x04
# define ATT_PROPERTY_WRITE 0x08
# define ATT_PROPERTY_NOTIFY 0x10
# define ATT_PROPERTY_INDICATE 0x20
# define ATT_PROPERTY_AUTHENTICATED_SIGNED_WRITE 0x40
# define ATT_PROPERTY_EXTENDED_PROPERTIES 0x80
// MARK: Attribute Property Flag, BTstack extension
// value is asked from client
# define ATT_PROPERTY_DYNAMIC 0x100
2018-04-05 12:36:48 +02:00
// Security levels
# define ATT_SECURITY_NONE 0
# define ATT_SECURITY_ENCRYPTED 1
# define ATT_SECURITY_AUTHENTICATED 2
# define ATT_SECURITY_AUTHORIZED 3
// internal additions
2015-11-15 21:51:01 +01:00
// 128 bit UUID used
# define ATT_PROPERTY_UUID128 0x200
2018-03-03 23:12:07 +01:00
// Read/Write Permission bits
# define ATT_PROPERTY_READ_PERMISSION_BIT_0 0x0400
# define ATT_PROPERTY_READ_PERMISSION_BIT_1 0x0800
# define ATT_PROPERTY_WRITE_PERMISSION_BIT_0 0x0001
# define ATT_PROPERTY_WRITE_PERMISSION_BIT_1 0x0010
2018-04-05 12:36:48 +02:00
2015-11-15 21:51:01 +01:00
2017-09-19 11:33:38 +02:00
// ATT Transaction Timeout of 30 seconds for Command/Response or Indication/Confirmation
2015-11-15 21:51:01 +01:00
# define ATT_TRANSACTION_TIMEOUT_MS 30000
# define ATT_TRANSACTION_MODE_NONE 0x0
# define ATT_TRANSACTION_MODE_ACTIVE 0x1
# define ATT_TRANSACTION_MODE_EXECUTE 0x2
# define ATT_TRANSACTION_MODE_CANCEL 0x3
2017-09-19 11:33:38 +02:00
# define ATT_TRANSACTION_MODE_VALIDATE 0x4
2015-11-15 21:51:01 +01:00
// MARK: GATT UUIDs
# define GATT_PRIMARY_SERVICE_UUID 0x2800
# define GATT_SECONDARY_SERVICE_UUID 0x2801
# define GATT_INCLUDE_SERVICE_UUID 0x2802
# define GATT_CHARACTERISTICS_UUID 0x2803
# define GATT_CHARACTERISTIC_EXTENDED_PROPERTIES 0x2900
# define GATT_CHARACTERISTIC_USER_DESCRIPTION 0x2901
# define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION 0x2902
# define GATT_SERVER_CHARACTERISTICS_CONFIGURATION 0x2903
# define GATT_CHARACTERISTIC_PRESENTATION_FORMAT 0x2904
# define GATT_CHARACTERISTIC_AGGREGATE_FORMAT 0x2905
# define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NONE 0
# define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION 1
# define GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION 2
// GAP Service and Characteristics
# define GAP_SERVICE_UUID 0x1800
# define GAP_DEVICE_NAME_UUID 0x2a00
# define GAP_APPEARANCE_UUID 0x2a01
# define GAP_PERIPHERAL_PRIVACY_FLAG 0x2a02
# define GAP_RECONNECTION_ADDRESS_UUID 0x2a03
# define GAP_PERIPHERAL_PREFERRED_CONNECTION_PARAMETERS_UUID 0x2a04
2016-02-18 10:10:28 +01:00
# define GAP_SERVICE_CHANGED 0x2a05
2015-11-15 21:51:01 +01:00
/**
* SM - LE Security Manager
*/
// Bluetooth Spec definitions
typedef enum {
SM_CODE_PAIRING_REQUEST = 0 X01 ,
SM_CODE_PAIRING_RESPONSE ,
SM_CODE_PAIRING_CONFIRM ,
SM_CODE_PAIRING_RANDOM ,
SM_CODE_PAIRING_FAILED ,
SM_CODE_ENCRYPTION_INFORMATION ,
SM_CODE_MASTER_IDENTIFICATION ,
SM_CODE_IDENTITY_INFORMATION ,
SM_CODE_IDENTITY_ADDRESS_INFORMATION ,
SM_CODE_SIGNING_INFORMATION ,
2016-05-09 18:17:31 +02:00
SM_CODE_SECURITY_REQUEST ,
SM_CODE_PAIRING_PUBLIC_KEY ,
SM_CODE_PAIRING_DHKEY_CHECK ,
2016-06-16 12:33:16 +02:00
SM_CODE_KEYPRESS_NOTIFICATION ,
2015-11-15 21:51:01 +01:00
} SECURITY_MANAGER_COMMANDS ;
// IO Capability Values
typedef enum {
IO_CAPABILITY_DISPLAY_ONLY = 0 ,
IO_CAPABILITY_DISPLAY_YES_NO ,
IO_CAPABILITY_KEYBOARD_ONLY ,
IO_CAPABILITY_NO_INPUT_NO_OUTPUT ,
IO_CAPABILITY_KEYBOARD_DISPLAY , // not used by secure simple pairing
} io_capability_t ;
// Authentication requirement flags
2016-05-09 18:17:31 +02:00
# define SM_AUTHREQ_NO_BONDING 0x00
# define SM_AUTHREQ_BONDING 0x01
# define SM_AUTHREQ_MITM_PROTECTION 0x04
# define SM_AUTHREQ_SECURE_CONNECTION 0x08
# define SM_AUTHREQ_KEYPRESS 0x10
2015-11-15 21:51:01 +01:00
// Key distribution flags used by spec
2016-05-13 11:53:21 +02:00
# define SM_KEYDIST_ENC_KEY 0x01
# define SM_KEYDIST_ID_KEY 0x02
# define SM_KEYDIST_SIGN 0x04
# define SM_KEYDIST_LINK_KEY 0x08
2015-11-15 21:51:01 +01:00
// Key distribution flags used internally
# define SM_KEYDIST_FLAG_ENCRYPTION_INFORMATION 0x01
# define SM_KEYDIST_FLAG_MASTER_IDENTIFICATION 0x02
# define SM_KEYDIST_FLAG_IDENTITY_INFORMATION 0x04
# define SM_KEYDIST_FLAG_IDENTITY_ADDRESS_INFORMATION 0x08
# define SM_KEYDIST_FLAG_SIGNING_IDENTIFICATION 0x10
// STK Generation Methods
2016-05-13 11:55:17 +02:00
# define SM_STK_GENERATION_METHOD_JUST_WORKS 0x01
# define SM_STK_GENERATION_METHOD_OOB 0x02
# define SM_STK_GENERATION_METHOD_PASSKEY 0x04
# define SM_STK_GENERATION_METHOD_NUMERIC_COMPARISON 0x08
2015-11-15 21:51:01 +01:00
// Pairing Failed Reasons
# define SM_REASON_RESERVED 0x00
2018-02-01 15:55:15 +01:00
# define SM_REASON_PASSKEY_ENTRY_FAILED 0x01
2015-11-15 21:51:01 +01:00
# define SM_REASON_OOB_NOT_AVAILABLE 0x02
# define SM_REASON_AUTHENTHICATION_REQUIREMENTS 0x03
# define SM_REASON_CONFIRM_VALUE_FAILED 0x04
# define SM_REASON_PAIRING_NOT_SUPPORTED 0x05
# define SM_REASON_ENCRYPTION_KEY_SIZE 0x06
# define SM_REASON_COMMAND_NOT_SUPPORTED 0x07
# define SM_REASON_UNSPECIFIED_REASON 0x08
# define SM_REASON_REPEATED_ATTEMPTS 0x09
2016-05-26 17:36:34 +02:00
# define SM_REASON_INVALID_PARAMETERS 0x0a
# define SM_REASON_DHKEY_CHECK_FAILED 0x0b
# define SM_REASON_NUMERIC_COMPARISON_FAILED 0x0c
2015-11-15 21:51:01 +01:00
// also, invalid parameters
// and reserved
2016-06-16 12:33:16 +02:00
// Keypress Notifications
# define SM_KEYPRESS_PASSKEY_ENTRY_STARTED 0x00
# define SM_KEYPRESS_PASSKEY_DIGIT_ENTERED 0x01
# define SM_KEYPRESS_PASSKEY_DIGIT_ERASED 0x02
# define SM_KEYPRESS_PASSKEY_CLEARED 0x03
# define SM_KEYPRESS_PASSKEY_ENTRY_COMPLETED 0x04
2018-02-01 15:55:15 +01:00
# endif
