1# Change Log 2All notable changes to this project will be documented in this file. 3 4The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) 5and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). 6 7--- 8 9## Unreleased 10### Added 11### Fixed 12### Changed 13 14 15## Release v1.6.2 16 17### Added 18- btstack_util: safe wrappers for snprintf 19- btstack_version: provides BTstack major, minor, patch versions 20- HCI Dump: support ISO packets in PacketLogger format 21- HCI Dump Dispatch: allow to chain multiple HCI Dump implementations 22- GAP: support LE Connection Subrating with gap_request_connection_subrating 23- GATT Client: gatt_client_add_service_changed_handler to receive Service Changed and Database Hash events 24- GATT Client: various _with_context functions that provide a service + connection id to GATT query events 25- GATT Service Client: generic client discovers characteristics and enables notifications/indications 26- L2CAP: provide access to number of available credits in CBM/ECBM 27- AVDTP, A2DP: MPEG AAC capability and configuration events provide DRC field 28- AVRCP: support Browsing in Target role 29- HFP HF: support Apple Accessory information with: 30 - hfp_hf_apple_set_identification 31 - hfp_hf_apple_set_battery_level 32 - hfp_hf_apple_set_docked_state 33- HFP AG: report Apple Accessory information, battery level and docked state 34- HID Parser: introduce HID Descriptor and HID Descriptor Usage iterators 35- PBAP Client: allow to set start offset and max list count for pull phonebook operation 36- PBAP Client: create SDP record with pbap_client_create_sdp_record 37- PBAP Client: support multiple parallel connections 38- Battery Service v1.1 Server 39- Immediate Alert Service Server and Client: added 40- Link Loss Service Server and Client: added 41- TX Power Service Client: added 42- Chipset: support PatchRAM download on CYW5551x and CYW5557x 43 44### Fixed 45- btstack_util: skip whitespace in btstack_atoi 46- L2CAP: Fix ERTM Tx buffer reconfiguration 47- RFCOMM: shut down multiplexer after closing last channel instead of multiplexer idle timer 48- RFCOMM: fix multiple outgoing channel setup 49- SDP Server: skip empty attribute lists in Service Search Attribute Response 50- HID Host: return complete HID report 51- SM: fix CTKD key distribution over BR/EDR 52- SM: fix CTKD after BR/EDR Role Change 53- A2DP: emit stream established if peer set-up configuration 54- AVDTP: fix SDP Client registration bug that could block other SDP queries 55- HFP HF: send HF Indicator update only if enabled by AG 56- HID Host: omit Report ID in Set/Get Report and send report for report id == HID_REPORT_ID_UNDEFINED 57- PBAP Client: fix PBAP_SUBEVENT_OPERATION_COMPLETED with OBEX_DISCONNECTED for pbap_disconnect 58- HIDS Client: emit disconnected event on HCI disconnect and free connection struct 59- Scan Parameter Service Client: emit disconnected event on HCI disconnect and free connection struct 60- POSIX: clear run loop exit flag 61- esp32: use synchronous VHCI API with newer ESP32 variants (esp32, -c3, and -s3 use asynchronous API) 62- 3rd-party: update hxcmod-player to fix GCC 11 warnings 63 64### Changed 65- HCI Dump: only log internal BTstack events if ENABLE_LOG_BTSTACK_EVENTS is defined 66- GAP: return command disallowed if disconnect already requested 67- GAP: improve handling of incorrectly resolved addresses in HCI_SUBEVENT_LE_CONNECTION_COMPLETE 68- GAP: only store link key if at least one side requests bonding during the IO Capabilities exchange. 69- GATT Client: use Find by Information Request to lookup CCCD for Notifications/Indications 70- SDP Client: trigger next SDP query callback, if registered callback does not start SDP query 71- BNEP Client: provide setup connection response in BNEP_EVENT_CHANNEL_OPENED 72- GOEP Client: remove goep_client_create_connection. Use goep_client_connect instead. 73- HID Parser: cleanup of function names and signatures 74- HIDS Client: use error code instead of ATT status in connected event 75- Device Information Service Server: update for v1.2 76- Device Information Service Client: update for v1.2 77- esp32: enable audio driver by default on esp32, esp32c3 and esp32c6 78- test: removed auto-pts support 79 80 81## Release v1.6.1 82 83### Added 84- GAP: support coordinated private random address updates 85- libusb: support send/receive of HCI ISO packets 86 87### Fixed 88- GAP: allow use of own address type different from gap_random_set_mode() incl. RPA in LE Extended Advertising 89- GAP: emit GAP_SUBEVENT_LE_CONNECTION_COMPLETE for failed outgoing connections 90- HCI: improved BIG setup/termination 91- L2CAP: set extended flow control bit in information response if enabled 92- SM: abort pairing with invalid parameter error for encryption key size > 16 93- SM: ignore Security Request after re-encryption has started 94- SM: respond to Pairing Request after Identity Resolution failed 95- SM: fix CTKD from Classic in Peripheral role 96- ATT Server: support delayed read responses for registered services 97- ATT Server: allow to start crypto operation from delayed att read/write request 98- HFP: use round robin for outgoing connections 99- HFP HF: send HF Indicator update only if enabled by AG 100- HFP AG: send OK after SLC for HF that does not support 3-way-calling or HF Indicators 101- HSP HS: use EV3 and 2EV3 packets for 7.5 ms voice interval 102- AVDTP: use round robin for outgoing connections 103- AVDTP: allow call to avdtp_disconnect before connection was established 104- A2DP: allow call to avdtp_disconnect before connection was established 105- AVRCP: use round robin for outgoing connections 106- GOEP Client: use round robin for outgoing connections 107- HID Host: use round robin for outgoing connections 108- HOG Host: emit GATTSERVICE_SUBEVENT_HID_REPORT for hids_client_send_write_report 109 110### Changed 111- HCI: hci_reserved_packet_buffer and higher layer functions asserts if packet buffer is free instead of return value 112- GAP: suppress GAP_SUBEVENT_LE_CONNECTION_COMPLETE for intermediate connection pause due to filterlist update 113- GAP: mutual authentication for legacy secure connections to prevent BIAS attacks was made optional with 114 ENABLE_MUTUAL_AUTHENTICATION_FOR_LEGACY_SECURE_CONNECTIONS. Not needed for default encryption key size of 16 115- HCI Dump: only log internal/BTstack events for ENABLE_LOG_BTSTACK_EVENTS 116 117## Release v1.6 118 119### Added 120- HCI: allow to configure Classic ACL packet types with hci_enable_acl_packet_types 121- GAP: emit generic GAP_SUBEVENT_LE_CONNECTION_COMPLETE for any LE Connection Complete 122- SM: support LE Secure Connection debug keys for testing 123- L2CAP: additional authorization_required param in l2cap_ecbm_register_service 124- GATT Client: support GATT over Enhanced LE Bearer 125- GATT Server: support GATT over Enhanced LE Bearer 126- A2DP: support SDP record without service name and/or provider 127- AVRCP: support SDP record without service name and/or provider 128- HFP: hfp_hf_create_sdp_record_with_codecs and hfp_hf_create_sdp_record_with_codecs 129- HFP: support for LC3-SWB 130- HFP: support SDP record without service name 131- PABP Server: support SDP record without service name 132- SPP Server: support SDP record without service name 133- HOG Device: emit HIDS_SUBEVENT_SET_REPORT 134- HOG Device: provide report for GET REPORT operation via callback 135- SBC Codec: new interface allows for multiple instances 136- LE Device DB: le_device_db_dump dumps LTK 137- Port for Zephyr 3.x 138- Port for FreeBSD that uses kernel netgraph HCI node 139 140### Fixed 141- HCI: fix remove le device from whitelist and periodic advertiser list 142- HCI: fix restart connect with whitelist after whitelist modification 143- GAP: store classic link keys independent from peer bonding request 144- SM: directly detect invalid Public key when Controller ECC is used 145- SM: sm: only set LinkKey flag in Pairing Request/Response if BR/EDR supported locally 146- L2CAP: make l2cap_get_remote_mtu_for_local_cid available to LE-only builds 147- L2CAP: handle all signaling requests and responses in closed state 148- HFP: use 'don't care' to accept SCO connections, fixes issue on ESP32 149- HFP: fix LC3-WB init 150- HFP AG: fix setup of audio connection in service level established event 151- HFP AG: fix BCM WBS setup 152- HFP AG: allow use of mSBC in subsequent audio connections after CSVD downgrade 153- HFP AG: fix terminate held call 154- HFP HF: send 'deactivate EC/NR' if supported in AG 155- HID Device: set Report Mode as default 156- HID Host: support large HID Descriptors 157- AVDTP: limit L2CAP MTU to largest BR/EDR packet, fixes A2DP Sink role for some Samsung TV 158- AVDTP: fix Get Stream Configuration 159- AVDTP: reject suspend in state endpoint open 160- AVDTP: return error in avdtp_suspend_stream if state is not streaming 161- AVRCP: reject incoming second l2cap connection 162- AVRCP: generate command for avrcp_controller_get_element_attributes dynamically 163- SPP Server: fix SPP version in SDP record 164- GATT Client: ignore notifications/indications until re-encrypted for bonded device without ENABLE_LE_PROACTIVE_AUTHENTICATION 165- btstack_flash_bank: support alignment larger than 4 166- windows: fix timestamps in packet logs 167 168### Changed 169- HCI: simplified implicit SCO flow control 170- HCI: return ERROR_CODE_COMMAND_DISALLOWED for outgoing connections in gap_connect 171- GAP: only return status code for errors in gap_connect 172- AVRCP: shorten default SDP Service and Provider Names 173- GATT Client: emit query complete event for gatt_client_discover_characteristic_descriptors in next run loop iteration 174- HFP: report HFP Version 1.9 in SDP record 175- HID Parser: ignore Report Items without Usage 176- btstack_crypto: allow MBEDTLS config via MBEDTLS_CONFIG_FILE 177- remove old Zephyr 1.9 port 178- ports: require CMake 3.12 for CMake projects 179 180## Release v1.5.6 181 182### Added 183- HCI: HCI_ACL_CHUNK_SIZE_ALIGNMENT allows to keep HCI transport writes aligned 184- GAP: support additional LE PHYs for scanning and outgoing connections 185- GATT Client: allow to queue requests with gatt_client_request_to_send_gatt_query and gatt_client_request_to_write_without_response 186- GATT Client: support GATT over BR/EDR transport via gatt_client_classic_connect 187- HFP: provide SCO packet types and rx/tx packet lengths in HFP_SUBEVENT_AUDIO_CONNECTION_ESTABLISHED 188- HFP: allow to register custom at commands with hfp_hf_register_custom_at_command 189- HFP: experimental support for LC3-SWB from HFP SWB draft with ENABLE_HFP_SUPER_WIDE_BAND_SPEECH 190- AVRCP: support Cover Art via avrcp_cover_art_client 191- example: gatt_streamer_server and le_streamer_client report DLE and PHY changes 192- NXP: support for NXP Controller with bootloader versions v1, e.g. NXP 88W8997, and v3, e.g. NXP IW416 or IW61x 193- esp32: support esp-idf v5.x audio driver 194- esp32: warn about sdkconfig issues 195- esp32: add BTstack component config options via menuconfig 196- esp32: allow to disable default audio i2s driver via component config 197- esp32: btstack_stdio_init configures buffered output, required for stdin support 198- Port for Renesas RA6M4 with DA14531 199- Port for NXP Controller on POSIX (posix-h4-nxp) 200- Port for newer Infineon Controller on POSIX (posix-h4-bcm) that requires autobaud-mode 201 202### Fixed 203- HCI: fix set extended scan response 204- HCI: fix report of extended advertisements with data len > 31 205- HCI: fix CTKD in Initiator role over BR/EDR SC when using dedicated bonding 206- SM: fix value in SM_EVENT_NUMERIC_COMPARISON_REQUEST 207- SM: ignore Security Request during re-encryption 208- GATT Client: return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER for invalid connection handle 209- A2DP: emit A2DP_SUBEVENT_STREAM_ESTABLISHED with if connection fails, e.g. because of Page Timeout 210- A2DP Source: a2dp_source_stream_send_media_payload was removed, use a2dp_source_stream_send_media_payload_rtp instead 211- A2DP: use samples as timestamp, fixes issue with Apple Airpods Pro 2nd Gen 212- AVDTP Source: avdtp_source_stream_send_media_payload was removed, use avdtp_source_stream_send_media_payload_rtp instead 213- AVRCP: re-register for notification 214- BNEP: validate UUID32 and UUID128 service in connect request 215- HFP: fix setup/accept of synchronous connection 216- HFP: use mandatory safe settings considering BR/EDR Secure Connections to accept synchronous connections 217- HFP: avoid SCO packet types not supported either locally or remotely 218- HFP: remove trailing newline/carriage return in custom command event 219- PBAP Client: make pbap_set_property_selector work for Pull Phonebook 220- btstack_stdin_embedded: use timer to poll RTT input, fix for tickless RTOS 221- esp32: fix audio power amplifier control on Lyra T v4.3 board 222- tool/convert_gatt_service: removed as GATT Service descriptions not available on Bluetooth SIG web site 223 224### Changed 225- GAP: add gap_set_peer_privacy_mode with default LE_PRIVACY_MODE_DEVICE 226- GAP: use stack defaults for LE Connection Parameter Updates 227- GAP: set minimum and maximum CE length to 0 228- GAP: ENABLE_EXPLICIT_DEDICATED_BONDING_DISCONNECT disables disconnect after dedicated bonding 229- GOEP Client: support multiple instances 230- A2DP Sink: drop unused local seid argument in a2dp_sink_establish_stream 231- HFP: emit HFP_SUBEVENT_CUSTOM_AT_MESSAGE_SENT after sending custom command / unsolicited response code 232- sco_demo_util: replace hfp_msbc by hfp_codec 233- BCM: look for PatchRAM file with prefix DEVICE_NAME and extension '.hcd' 234- bluetooth: indicated identity address in resolved address type enums name 235- btstack_audio: added get_samplerate function to help with audio sample rate synchronization 236- btstack_flash_bank: write empty tag instead of overwriting existing tag with ENABLE_TLV_FLASH_WRITE_ONCE 237- esp32: drop support for Makefile projects from esp-idf 3.x 238- esp32: avoid deprecated btstack_run_loop_freertos API calls 239- esp32: use sample rate compensation in a2dp_sink_demo 240- stm32-f4discovery-cc256x: use external oscillator for better I2S clock 241- stm32-f4discovery: use sample rate compensation in a2dp_sink_demo 242 243 244## Release v1.5.5 245 246### Added 247- hci_dump_stdout: allow to truncate ACL, SCO and ISO packets with HCI_DUMP_STDOUT_MAX_SIZE_* 248- GATT Service: Broadcast Audio Scan Service Server and Client (BASS 1.0) 249- example/a2dp_source_demo: add command to scan and connect to Bluetooth speaker by class of device 250- OPP Server profile and OPP Server demo 251 252### Fixed 253- GAP: reload LE Resolving List after power-cycle 254- GAP: fix setting of LE Scan Response for data that needs to be fragmented 255- SM: fix pairing process with active ATT communication 256- ESP32: fix init for BR/EDR Only mode 257- ESP32: fix audio driver for sink + source mode 258- ESP32: fixes for ESP-IDF v5.x 259- ESP32: fix compile of non-BTstack examples after adding components/btstack 260 261### Changed 262- GAP: reload LE Filterlist and Periodic Advertiser List after power-cycle 263- SM: delete bonding information for existing device with BD_ADDR on new pairing with different IRK 264- Mesh: move GATT Services into src/mesh/gatt-service 265- LE Audio: move GATT Services into src/le-audio/gatt-service 266- libusb: improve implementation 267 268## Known Issues 269- ESP32: audio driver for ES8388/LyraT v4.3 not updated for esp-idf 5.x 270 271 272## Release v1.5.4 273 274### Added 275- HFP HF: send custom AT command with hfp_hf_send_at_command 276- HFP HF: terminate held calls with hfp_hf_terminate_held_calls 277- HFP HF: provide Call Waiting information alpha field 278- HFP HF: add hfp_hf_set_default_microphone_gain and hfp_hf_set_set_default_speaker_gain for SLC 279- HFP AG: support handling of custom AT commands with hfp_ag_register_custom_at_command 280- HFP AG: send custom unsolicited result code with hfp_ag_send_unsolicited_result_code 281- GAP: allow to enable duplicate filter for LE scanning with gap_set_scan_duplicate_filter 282- GAP: support BIG with gap_big_create and gap_big_terminate 283- GAP: support BIG Sync gap_big_sync_create and gap_big_sync_terminate 284- GAP: support Periodic Advertisement Sync Transfer 285- PBAP Server profile and PBAP Server demo 286- OPP Client profile and OPP Client demo 287- port: CMake build files in all windows-* ports allow to use Visual Studio 2022 288- embedded audio: mono audio is played on both channels if HAVE_HAL_AUDIO_SINK_STEREO_ONLY is defined 289- Support for ESP32-C3 and ESP32-S3 290 291### Fixed 292- HCI: only add paired LE devices with IRK to resolving list 293- HCI: send HCI LE Create Connection Cancel only once for outgoing LE connections without whitelist 294- GAP: use static random address after power up 295- L2CAP: fix L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_REQUEST 296- SM: avoid potential loop during CTKD 297 298### Changed 299- HCI Dump: provide log level to log_message implementation 300- GAP: replace BTSTACK_EVENT_DISCOVERABLE_ENABLED with BTSTACK_EVENT_SCAN_MODE_CHANGED 301 302 303## Release v1.5.3 304 305### Added 306- GAP: support periodic advertising with ENABLE_LE_PERIODIC_ADVERTISING 307- GAP: support periodic inquiry mode with gap_inquiry_periodic_start 308- HFP HF: provide Calling Line Identification alpha field 309- HFP HF: emit HFP_SUBEVENT_TRANSMIT_DTMF_CODES after sending DTMF command 310- GOEP Server 311- Chipset: support for firmware download and configuration of Realtek Controllers 312- PBAP Server and pbap_server_demo 313 314### Fixed 315- GAP: fix gap_connect_cancel for gap_connect_with_whitelist 316- GAP: fix race condition that causes duplicate authenticate request 317- SM: address update for non-resolvable private addresses 318- SM: reset state on power off transition 319- L2CAP: Fix accept incoming ERTM connection when Information Request already complete 320- A2DP Sink: fix config API for AAC, ATRAC, and other codecs 321- HFP: try next link setting for SCO connection failure after SCO reject errors 322- HFP AG: activate all AG indicators upon service level connection establishment 323- HFP AG: handle call termination in alerting call state 324- HFP HF: fix parsing of phone number for voice tag 325- HFP HF: report HFP_SUBEVENT_NETWORK_OPERATOR_CHANGED event 326 327### Changed 328- HCI: use ERROR_CODE_CONNECTION_REJECTED_DUE_TO_SECURITY_REASONS to rejected classic connections 329- SM: pairing events indicate if LE Secure Connection will be used 330- A2DP: new a2dp.c contains shared code of Sink and Source roles 331- A2DP Sink: automatically configure stream endpoint for outgoing connections 332- HFP AG: drop unused number parameter from hfp_ag_outgoing_call_initiated 333- libusb: command line options to delete TLV and specify log file path 334- Windows: native implementations of btstack_tlv_window, hci_dump_windows_fs, hci_dump_window_stdout 335 336## Release v1.5.2 337 338### Added 339- GAP: ENABLE_HCI_SERIALIZED_CONTROLLER_OPERATIONS serializes Inquiry, Remote Name Request and Create Connection operations 340- GAP: support extended advertising with ENABLE_LE_EXTENDED_ADVERTISING 341- GAP: gap_enable_link_watchdog() uses automatic flush timeout to disconnect if data cannot be sent 342- GAP: gap_secure_connections_active() to query if BR/EDR Secure Connecions are possible 343- ATT DB: provide gatt_server_get_handle_range_for_service_with_uuid16 to find included service within handle range 344- GATT Service: Audio Input Control Service Server (AICS 1.0) 345- GATT Service: Microphone Control Service Server (MCS 1.0) 346- GATT Service: Published Audio Capabilities Service Server (PACS 1.0) 347- GATT Service: Volume Control Service Server (VCS 1.0) 348- GATT Service: Volume Offset Control Service Server (VOCS 1.0) 349 350### Fixed 351- POSIX: fix RTS/CTS configuration by keeping local termios copy in btstack_uart_posix 352- HCI: fix handling of HCI Connection Complete with error (regression introduced in v1.5.1) 353- GAP: disable scanning, advertising, connection before updating random address 354- GAP: fix LE Scan with whitelist 355- HFP_AG: fix tracking for call dropped during outgoing ringing 356- HFP: Free HFP Connection object on SDP error / Service not found 357- PBAP Client: emit operation complete with status OBEX_ABORTED 358 359### Changed 360- Chipset: use da145xx in folder/file/function names for Dialog Semiconductor SoCs 361- GAP: set min encryption key size during init, if supported 362- AVDTP: use BLUETOOTH_SERVICE_CLASS_AUDIO_SINK / SOURCE instead of BLUETOOTH_PROTOCOL_AVDTP in SDP queries 363- ATT Server: use uint8_t for status returns 364- libusb, POSIX and Windows ports: use '-' instead of ':' in btstack_BD_ADDR.tlv filename 365 366 367## Release v1.5.1 368 369### Added 370- GOEP Client: add goep_client_version_20_or_higher 371- ESP32: implement audio source 372 373### Fixed 374- PBAP Client: support disconnect while operation is ongoing 375- PBAP Client: use SRM only if GOEP v2.0 or higher connection 376- PBAP Client: emit vCard entry data as PBAP_DATA_PACKET 377- L2CAP: limit remote MTU by local tx configuration in ERTM 378 379### Changed 380- Example: init SM if LE supported to avoid issue with Android Cross-Transport Key-Derivation 381- ESP32: update sdkconfig for esp-idf v4.3, disable Bluedroid host stack 382- ESP32: use I2S configuration from ESP32 LyraT V4.3 383 384 385## Release v1.5.0 386 387### Added 388- HCI Dump: Support BTSnoop format in hci_dump_posix_fs.c for format = HCI_DUMP_BTSNOOP 389- HCI Dump RTT STDOUT: drop messages if RTT buffer is full and RTT is configured for non-blocking 390- HCI: hci_remove_event_handler to remove packet handler 391- hci_cmd: support variable length fields and arrayed parameters 392- GAP: ENABLE_EXPLICIT_LINK_KEY_REPLY allows for asynchronous link key lookup by application 393- GAP: gap_set_page_timeout to set Page Timeout 394- GAP: gap_inquiry_set_scan_activity to set Inquiry Scan Activity 395- L2CAP: emit L2CAP_EVENT_INFORMATION_RESPONSE event with extended features and fixed channels supported 396- L2CAP: support Enhanced Credit-based Flow-Control Mode for connection-oriented channels over BR/EDR/LE 397- A2DP: allow to register media codec validator for sink and source with: 398 - `a2dp_sink_register_media_config_validator` 399 - `a2dp_source_register_media_config_validator` 400- A2DP Sink: allow accept or reject of stream start on A2DP_SUBEVENT_START_STREAM_REQUESTED when ENABLE_AVDTP_ACCEPTOR_EXPLICIT_START_STREAM_CONFIRMATION is defined 401- OBEX: new obex_parser for chunked OBEX data 402- SM: Support Cross-Transport Key-Derivation (CTKD) of LE LTK from BR/EDR SC Link Key in Responder role 403- SM: sm_remove_event_handler to remove packet handler 404- GATT Service: Bond Management Service (BMS 1.0) Server 405- GATT Service: Microphone Control Service (MICS 1.0) Server 406- GATT Service: TX Power Service (TPS 1.0) Server 407- POSIX: btstack_signal allows to register for callback on signal, e.g. ctrl-c 408- Windows: btstack_stdin_window_register_ctrl_c_callback allows to register for ctrl-c 409 410### Fixed 411- A2DP Source: fix reconfigure 412- AVRCP Controller: prevent registering of notifications for unsupported events 413- RFCOMM: fixed handling of remote port configuration command 414- HFP AG: fix accept incoming connection while audio connection is established 415- PBAP Client: handle chunked vCard Listing 416- PBAP Client: use new streaming obex_parser to handle chunked OBEX data 417- SM: Work around for unexpected Windows 10 disconnect for BR Secure Connections (SMP over BR timeout) 418- SM: support storing bonding information for devices with identical IRK but different public addresses 419- GAP: restart advertising when private address changes 420- le_device_db_tlv: keep number of devices reported by le_device_db_count if old entry is replaced 421 422### Changed 423- Drop iOS support 424- HCI: provide status instead of undocumented int error code and bool for API functions 425- HCI: use 1000 ms watchdog to force power off for hci_power_control(HCI_POWER_OFF) 426- GAP: local name, EIR data, class of device and default link policy can be updated at any time 427- L2CAP: provide status instead of undocumented int error code and bool for API functions 428- L2CAP: remote features not required for SDP connections 429- L2CAP: replaced l2cap_register_packet_handler with l2cap_add_event_handler to register multiple handlers 430- L2CAP: drop reason parameter in l2cap_disconnect 431- L2CAP: use official terminology for L2CAP channel modes - ENABLE_L2CAP_LE_CREDIT_BASED_FLOW_CONTROL_MODE replaces ENABLE_LE_DATA_CHANNELS 432- L2CAP: unify API for can send now, request to send, and send packet and disconnect channel 433- L2CAP: unify events for can send now, packet sent, channel closed (CbM/ECBM using existing events) 434- RFCOMM: `RFCOMM_EVENT_PORT_CONFIGURATION` contains rfcomm_cid and remote flag, emitted for query config 435- RFCOMM: provide status instead of undocumented int error code and bool for API functions 436- RFCOMM: remote port configuration, line status, and modem status are sent by channel state machine 437- HSP: add ACL Connection to all events and BD ADDR to HSP_SUBEVENT_RFCOMM_CONNECTION_COMPLETE 438- HFP: API functions return status code if appropriate 439- HFP: removed one parameter from hfp_ag/hf_activate_voice_recognition function, introduce hfp_ag/hf_deactivate_voice_recognition instead 440- HFP: merged legacy and enhanced Voice Recognition Activation (VRA) API. If available enhanced mode will be preferred. 441- HFP: separate events for activation (HFP_SUBEVENT_VOICE_RECOGNITION_ACTIVATED) and deactivation (HFP_SUBEVENT_VOICE_RECOGNITION_DEACTIVATED) instead of combined HFP_SUBEVENT_VOICE_RECOGNITION_STATUS with status field. HFP_SUBEVENT_VOICE_RECOGNITION_ACTIVATED contains field "enhanced" to indicate if enhanced mode is used. 442- HFP: enhanced VRA: HFP_SUBEVENT_VOICE_RECOGNITION_ACTIVATED is emitted after VRA is ready and the the audio connection is established. This simplifies HFP HF client logic, i.e. client can call `hfp_hf_enhanced_voice_recognition_report_ready_for_audio directly` upon reception of HFP_SUBEVENT_VOICE_RECOGNITION_ACTIVATED event. 443- AVDTP: media config validator is called with preview of media codec configuration event and configured separately for sink/source 444- AVRCP: use PANEL as default unit + subunit info 445- AVRCP Controller: automatically query supported events when registering for notifications 446- AVRCP Target: cache companies and events in library and remove need to answer query in application callback. Use Bluetooth SIG as default company. 447- Run Loop: new functionality for HCI transport drivers and inter-process communication: 448 - *btstack_run_loop_poll_data_sources_from_irq*: used to transfer control from IRQ handler to main thread/run loop 449 - *btstack_run_loop_execute_on_main_thread*: schedule code execution on main thread from other thread 450 - *btstack_run_loop_trigger_exit*: trigger run loop exit 451- POSIX / Windows / Raspi / Qt: use updated ctrl-c handling 452- POSIX TLV: use max value size of 2048, assert in store function if value size is larger 453 454 455## Release v1.4.1 456 457### Added 458- GAP: emit GAP_EVENT_PAIRING_STARTED and GAP_EVENT_PAIRING_COMPLETE 459 460### Fixed 461- GAP: store link key in hci connection struct to allow authenticate after pairing without bonding 462- GAP: avoid requesting authentication twice 463- GAP: cache own address on start advertising and connecting, provide getters 464- GAP: stop LE connecting if create connection fails (e.g. connectable adv active and multiple roles not supported) 465- SM: fix race condition between local address changes and pairing procedure 466- ATT DB: fix spelling `gatt_server_get_handle_range_for_service_with_uuid128`, `gatt_server_get_handle_range_for_service_with_uuid16` 467 468### Changed 469- HCI: update advertising data without stopping advertising first 470- GAP: Drop local bonding flag in IO Capability Reply if remote does not indicate bonding 471- GAP: return status for `gap_set_security_mode` 472- GAP: abort legacy pairing if Level 4 is required 473- GAP: abort SSP on IO Capabilities Request event if Level 4 is required but SC not supported by remote 474- GAP: abort SSP on User Confirmation Request event if Level 3 is required but MITM protection not possible 475- GAP: validate minimal service security level can be reached during pairing in responder role 476- L2CAP: don't trigger hci disconnect if l2cap security requirements are insufficient 477- CVE-2020-26555: reject connections to and from devices with same BD ADDR 478- CVE-2020-26555: ignore NULL link key 479- CVE-2020-26558: abort LE Secure Connection pairing if remote uses the same public key 480 481## Release v1.4 482 483### Added 484- HCI: `btstack_transport_sco.h` supports SCO over physical PCM/I2S interface (`HAVE_SCO_TRANSPORT`) 485- POSIX: `btstack_transport_sco_i2s_test_bridge.c` implements SCO transport interface for UART-to-I2S test bridge 486- btstack_uart: `btstack_uart_t` interface extends `btstack_uart_block_t`: 487 - support sending and receiving SLIP frames for HCI H5 488 - support odd parity 489 - `hci_transport_h4` and chipset drivers have new functions to provide `btstack_uart_t` 490- btstack_uart_slip_wrapper: wrapper that implements SLIP functionality for existing `btstack_uart_block` drivers. 491- hci_transport: add parity field and pass on to `btstack_uart_t` in h4 and h5 492- GATT Client: Battery Service Client 493- GATT Client: Device Information Service Client 494- GATT Client: HID-over-GATT (HOG) Client, Report and Boot Host 495- GATT Client: Scan Parameters Service Client 496- GATT Server: Scan Parameters Service Server 497- GAP: support scan page configuration with `gap_set_page_scan_activity` and `gap_set_page_scan_type` 498- GAP: support sniff subrating with `gap_sniff_subrating_configure` 499- GAP: support QoS setup with `gap_qos_set` 500- AVRCP: new field `button_pressed` in `AVRCP_SUBEVENT_OPERATION` 501- AVRCP: `AVRCP_SUBEVENT_OPERATION` emitted for button release 502- AVRCP Controller: `avrcp_controller_start_press_and_hold_cmd` supports arbitrary device buttons 503- AVRCP Controller: reassemble fragmented AVCTP packets 504- AVDTP: `avdtp_register_media_config_validator` allows to validate media codec configuration 505- A2DP Source: `ENABLE_A2DP_SOURCE_EXPLICIT_CONFIG` disables auto config. requires call to `a2dp_source_set_config_{CODEC}` 506 507### Fixed 508- GAP: calculate IO Cap AuthReq Bondable Mode based on `gap_ssp_set_authentication_requirement` and `gap_set_bondable_mode` 509- GAP: only store link key for SSP if remote side has set bondable in io cap auth requirements 510- GAP: allow to disable link supervision timeout 511- GAP: fix `gap_connect` after `gap_connect_cancel` 512- GAP: re-configure advertisements after power cycle 513- HCI: handle start inquiry failure 514- L2CAP: fix create outgoing connection triggered from packet handler on hci disconnect event 515- L2CAP: return unknown mandatory option in config response 516- AVDTP: fix spelling `avdtp_set_preferred_sampling_frequency` 517- AVRCP Target: fix notification changed event 518- HFP: Emit audio connection released on SLC Release, e.g. on remote power off 519- HFP HF: fix audio connection setup if codec negotiation is supported 520- HFP HF: only emit single event for RING and AG Status updates 521- HFP AG: fix audio connection setup for in-band ringtone on incoming connection 522 523### Changed 524- Port Archive: moved ports that are not recommended for new designs to port/archive folder: 525 - MSP430: the ports used the older community GCC version without 20-bit support needed for code size > 64kB 526 - Broadcom/Cypress H5: uploading PatchRAM is only possible in H4 mode. It's better to also use H4 in general 527 - PIC32-Harmony: the port used Harmony v1 while Harmony v3 has been out since a while 528 - iOS: not supported 529- Run Loop Base: functionality used in most platform run loop implementations 530 - code from `btstack_run_loop_base.c` moved into `btstack_run_loop.c` to minimize changes to build systems 531 - `btstack_run_loop_base.c` is a placeholder and can be removed from build 532- HCI Dump: replace monolithic `hci_dump.c` (with many #ifdefs) into dispatcher with platform-specific implementations: 533 - `posix/hci_dump_posix_fs` - writes binary log file 534 - `posix/hci_dump_stdout` - log to console using printf with local system time 535 - `embedded/hci_dump_embedded_stdout` - log to console using printf 536 - `embedded/hci_dump_segger_stdout` - log to RTT console using `SEGGER_printf` 537 - `embedded/hci_dump_segger_binary` - writes binary log over RTT to host 538- HCI: config I2S for BCM Controllers if `ENABLE_SCO_OVER_PCM`, reduce bit clock to 256/512 kHz 539- btstack_uart_posix: supports SLIP frames and replaces `btstack_uart_block_posix` 540- hci_transport_h5: more performant H5 implementation that requires `btstack_uart_t` driver with SLIP support 541- POSIX Ports: use new `btstack_uart_posix` implementation 542- posix-h5/posix-h5-bcm: use even parity for UART 543- HCI Transport: extract convenience function declaration for h4, h5, em9304_spi, and usb into separate hci_transport_{type}.h 544- GAP: provide Device ID from EIR in GAP_EVENT_INQUIRY_RESULT 545- GAP: only store link key if it allows requested security level 546- GAP: abort SSP pairing if MITM protection required but not possible 547- SM: start pairing as Central for already encrypted connection on Slave Security Request 548- GATT Client: Use ATT_READ_REQUEST for first blob of Read Long Characteristic and Read Long Characteristic Descriptor 549- GATT Server: Allow ATT Read Callback to return custom ATT Error Code 550- Nordic SPP Service Server: use `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` and `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` 551 events instead of callback, and `RFCOMM_DATA_PACKET` for received data 552- u-blox SPP Service Server: use `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` and `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` 553 events instead of callback, and `RFCOMM_DATA_PACKET` for received data 554- HID: Move `src/classic/hid.h` into `src` and prefix with `btstack_` to use it with BLE and avoid name clashes 555- HFP: provide acl_handle in events to identify connection 556- HSP AG: emit HSP_SUBEVENT_BUTTON_PRESSED instead of audio connection setup/release 557- Example: use `btstack_event.h` getters instead of direct array access, use enum to compare status codes 558 559 560## Release v1.3.2 561 562### Added 563- GAP: support for Classic Out-of-Band (OOB) pairing via `gap_ssp_remote_oob_data` with `ENABLE_CLASSIC_OOB_PAIRING` 564- GAP: read local OOB data on start and on call to `gap_ssp_generate_oob_data`, provided via `GAP_EVENT_LOCAL_OOB_DATA` 565- HID Host: add profile, update `hid_host_demo.c` example 566 567### Fixed 568- L2CAP: make handling of HCI disconnect more robust 569- AVDTP: emit stream release for active stream if signaling connection is closed first, e.g. caused by HCI disconnect 570- AVRCP: fix issue when Controller and Target send at the same time 571 572### Changed 573- A2DP, AVDTP: use `a2dp_source_set_config_{TYPE}` and `avdtp_config{TYPE}_store` to avoid large number of parameters 574 575 576## Release v1.3 577 578### Added 579- CC256x: with ENABLE_CC256X_ASSISTED_HFP, HFP enables WBS codec on demand and configures PCM/I2S interface for 8kH/16kHz 580- BCM: with ENABLE_BCM_PCM_WBS, HFP enables WBS codec on demand and configures PCM/I2S interface for 8kH/16kHz 581- SDP Client RFCOMM: add `sdp_client_query_rfcomm_channel_and_name_for_service_class_uuid` 582- HFP: `ENABLE_HFP_AT_MESSAGES` lets HFP emit `HFP_SUBEVENT_AT_MESSAGE_SENT` and `HFP_SUBEVENT_AT_MESSAGE_RECEIVED` 583- A2DP, AVDTP: provide capabilities and configuration events for A2DP codecs: SBC, MPEG Audio, MPEG AAC, ATRAC 584- A2DP + AVDTP Source: allow to send media packet with `avdtp_source_stream_send_media_packet` and `a2dp_source_stream_send_media_packet` 585- A2DP + AVDTP Source: add `avdtp_source_stream_send_media_payload_rtp` and `a2dp_source_stream_send_media_payload_rtp` 586- A2DP Source: emit `A2DP_SUBEVENT_SIGNALING_CAPABILITIES_COMPLETE` 587- A2DP Source: allow to configure endpoints by calling `a2dp_source_set_config_{TYPE}` during SEP discovery with SBC fallback 588 589### Fixed 590- HCI: keep `le connecting request` on connection complete active, fixes gap_auto_connection_stop() + gap_auto_connection_start() 591- L2CAP: fix packet size check for incoming classic basic channels (regression introduced in v1.2.1) 592- HFP AG/HSP AG: avoid connecting to remote service with same role 593- A2DP Source: support multiple Stream Endpoints with different Media Codec types 594- A2DP Source: emit codec configure event with reconfigure flag set on reconfigure 595- GATT Compiler: support multiple instances of the same service 596 597### Changed 598- GAP: provide Link Type parameter to incoming connection filter for `gap_register_classic_connection_filter` 599- HFP/GOEP Client/AVDTP/A2DP: return `SDP_SERVICE_NOT_FOUND` if no suitable SDP record is found 600- AVDTP Source: `avdtp_source_stream_send_media_payload` includes SBC Header and was deprecated 601- AVDTP/A2DP: use `avdtp_channel_mode_t` in `A2DP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION` 602- A2DP: fix events and use `a2dp_cid`, `local_seid,` `remote_seid` field names in A2DP sub-events 603- GATT Client: Skip MTU exchange after MTU exchange on ATT Server 604- Ports: STM32-F103RB Nucleo + CC256x port removed 605- ESP32: enabled HFP Wide-Band Speech, disable classic secure connections in HSP/HFP demos 606 607 608## Release v1.2.1 609 610### Fixed 611- L2CAP: use connection handle for channel lookups 612- L2CAP: forward data only in open state 613 614### Changed 615- L2CAP: check packet size against local mtu for classic basic channels 616 617 618## Release v1.2 619 620### Fixed 621- L2CAP: trigger pairing for outgoing LE Data Channels if security level insufficient 622- SM: fix update of sc flag for re-encrypted connection in peripheral role 623- SM: send security request on re-connect if bonded and `ENABLE_LE_PROACTIVE_AUTHENTICATION` is defined 624- ESP32: fix audio sink driver 625 626### Added 627- GAP: `gap_delete_bonding` removes device from LE Resolving List and from discards LE bonding information 628- GATT Client: delete bonding information if re-encryption fails and `ENABLE_LE_PROACTIVE_AUTHENTICATION` is not defined 629- GATT Client: gatt_client_set_required_security_level() allows to set required minimum security level for all GATT requests 630- SM: emit events for re-encryption started/complete when bonding information is available 631 632### Changed 633- AVRCP Controller: allow to send multiple absolute volume commands without waiting for response. 634- GAP: replaced `ENABLE_LE_CENTRAL_AUTO_ENCRYPION` with `ENABLE_LE_PROACTIVE_AUTHENTICATION` 635 636 637## Changes October 2020 638 639### Fixed 640- AVDTP Initiator: avoid use of remote seid for stream endpoint lookup, fixes issue with two connected devices 641- AVDTP Source: buffer for SBC media codec information got discarded, leading to invalid Set Configuration command in second connection 642- SM: only trigger Cross-Transport Key Derivation (CTKD) when bonding is enabled 643- SM: set LinkKey flag to request CTKD if enabled 644- SM: store CTKD key with Public Identity Address 645- SM: only allow CTKD to overwrite existing link key if derived key has same or higher authentication 646- SM: start SMP Timeout when sending Security Request 647- HFP HF: fix response to AG Codec Selection while waiting for OK of parallel command 648- HCI: fix reject of LE remote connection param request via HCI 649 650### Added 651- GAP: add `gap_get_link_key_for_bd_addr` 652- GAP: add `gap_bonded` to check if bonding information is available for active connection 653- SM: support h7 for CTKD 654 655### Changed 656- SM: Cross-Transport Key Derivation requires `ENABLE_CROSS_TRANSPORT_KEY_DERIVATION` now 657- SM: block connection if encryption fails for bonded devices as Central 658- SM: support pairing as Central after failed re-encryption 659 660 661## Release v1.1 662 663### Fixed 664- AVRCP/AVCTP: report AVRCP 1.6 and AVCTP 1.4 in SDP record 665 666### Added 667 668### Changed 669 670 671## Changes September 2020 672 673### Fixed 674- HFP: fix parsing of ranges e.g. in +CIND responses 675- AVDTP, AVRCP: fix bugs due to transaction id overrun 676- A2DP Source: fix issues with stream configuration by sink 677- hci_dump: fix tv_us calculation for non-posix / embedded systems with binary output 678 679### Added 680- `btstack_ring_buffer`: add `btstack_ring_buffer_reset` to reset it to initial state/empty 681- GAP: Support for address resolution of resolvable private addresses by Controller with `ENABLE_LE_PRIVACY_ADDRESS_RESOLUTION` 682 683### Changed 684- AVDTP, AVRCP, HSP: schedule SDP query, avoids avoids 'command disallowed' if SDP client is busy 685- HSP, HFP: allow to configure usable SCO packet types 686- cc256x: update CC256xC init script to v1.4 687- A2DP Source: use Get All Capabilities if supported by remote get Delay Reporting capability 688 689## Changes August 2020 690 691### Fixed 692- ESP32: fix authentication for incoming Secure Connections 693- AVDTP: Fix forwarding of Delay reports 694- STM32-F4Discovery: fix pan_lwip_http_server by increasing HCI_ACL_PAYLOAD_SIZE 695- tool/create_packet_log: basic support for 16-bit Unicode log files from Windows 696 697### Added 698- `btstack_run_loop_base`: added `btstack_run_loop_base_dump_timer` 699- GAP: request role change for classic connection via `gap_request_role` 700- GAP: LE Whitelist API with `gap_le_whitelist_x` with x = add, remove, clear and new `gap_connect_with_whitelist` 701- SDP Client: add sdp_client_register_query_callback() allows to register query request instead of polling sdp_client_ready() 702- BNEP lwIP: add `bnep_lwip_connect` to establish BNEP connection and manage lwIP network interface 703- New `btstack_linked_queue` utility, a linked list-based queue with first-in-first-out semantics and constant time enqueue/dequeue operations 704- btstack_tlv_posix: add `btstack_tlv_posix_deinit` 705- New `btpclient` for use with [auto-pts project](https://github.com/intel/auto-pts) 706 707### Changed 708- GAP: treat AES-CCM encrypted connection as mutually authenticated (BIAS) 709- GAP: 'gap_auto_connect_x' API deprecated. Please directly manage LE Whitelist with `gap_le_whitelist_*` functions and call `gap_connect_with_whitelist` instead 710- example/hid_host_demo: try to become master for incoming connections 711- btstack_run_loop: use btstack_assert instead of local while(true) 712- att_db_util: allow to reset att_db via `att_db_util_init` 713 714## Changes July 2020 715 716### Fixed 717- AVDTP: fix invalid response for Get Capabilities request if Delay Reporting was supported 718- AVDTP: handle concurrent signaling establishment with reject and retry 719 720### Added 721- example/hid_host_demo: support reconnect from HID device 722- Crypto: support software AES128 for AES-CCM operations 723- AVRCP: introduced AVRCP_FEATURE_MASK_* as alternative to avrcp_controller_supported_feature_t and avrcp_target_supported_feature_t enums 724- btstack_audio: add set_volume() to sink and set_gain() to source interfaces, minimal volume control for portaudio playback 725- AVDTP: renamed definition of supported features from AVDTP_SOURCE_SF_ and AVDTP_SINK_SF_ to AVDTP_SOURCE_FEATURE_MASK_ and AVDTP_SINK_FEATURE_MASK_ respectively 726- GAP: Provide gap_get_role to query master/slave role for HCI connection handle 727- GAP: Provide gap_pin_code_response_binary to use binary data as PIN, e.g. for pairing with Nintendo Wii Remote 728 729### Changed 730- GAP: set minimum required encryption key size for Classic connections back from 16 to 7, matching the Core spec 731 732 733## Changes June 2020 734 735### Fixed 736- HFP: Fix parsing of empty fields, e.g. phone number in +CLCC and other AT commands 737- SM: Fix validation of confirm value for secure connection Passkey entry 738- AVRCP: handle concurrent signaling establishment with reject and retry 739 740### Added 741- GAP: Detect Secure Connection -> Legacy Connection Downgrade Attack by remote features and actual encryption type (BIAS) 742- GAP: Mutual authentication: request authentication after Classic connection got encrypted (BIAS) 743- Windows port for Dialog DA14585 connected via serial port 744 745## Changes 746- CVSD PLC: treat zero frames as good and allow to mark data as bad, e.g. if reported by Controller as erroneous 747 748## Changes May 2020 749 750### Fixed 751- hfp_hf, hsp_hs: use eSCO params in accept sco connection only for incoming eSCO connections 752- pbap_client: fix PBAP UUID len on connect message 753- SM: fix secure connection pairing as peripheral when local user confirmation happens after remote one 754- A2DP Source: only connect to remote sink stream endpoints 755- btstack_hal_flash_memory: fix write of 0xff bytes to simulated flash 756- hsp_hs: fix disconnect if audio not connected 757- hsp_ag: fix accept incoming connection 758 759### Added 760- example/le_mitm: MITM implementation that forwards ATT PDUs and allows for pairing 761- GAP: gap_set_security_level sets required security level for incoming and outgoing connections 762- cc256x: allow to specify power vector for each modulation type 763- FreeRTOS: btstack_run_loop_freertos_trigger_exit allows to request run loop exit 764- SM: support LE Secure Connections Only mode with sm_set_secure_connections_only_mode 765- GAP: enable BR/EDR Secure Connections if supported, add gap_secure_connections_enable 766 767### Changed 768- L2CAP ERTM: send extended features request only once per HCI connection 769 770 771## Changes April 2020 772 773### Fixed 774- hog_mouse_demo/hog_keyboard_demo: handle set protocol mode = boot protocol mode 775- HCI: only update BD_ADDR placeholder in shortened and complete name in EIR data, limit device name to 240/248 bytes 776 777### Added 778- GAP: gap_set_allow_role_switch allows to prevent role switch in outgoing classic ACL connections 779- example: hog_boot_host_demo implements an HID-over-GATT Boot Host that supports keyboard and mouse 780- HCI: add ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS that forces fragmentation of ACL-LE packets to fit into over-the-air packet 781 782### Changed 783- Broadcom/Cypress: wait 300 ms after PatchRAM update in hci.c to assert Controller is ready 784- esp32: provide esp-idf/component/btstack/btstack_port_esp32.c and only minimal app_main in template/main/main.c 785- att_db: skip att_read_callback for ATT Read Blob Request if offset == value_len 786 787 788## Changes March 2020 789 790### Fixed 791- GAP: fixed gap_set_scan_parameters() if issued right before gap_start_scan() 792- HCI: only send HCI Read Local Encryption Key Size if supported by Controller 793 794### Added 795- GATT Client: allow to register for any notification/indication and/or any connection 796- HCI: added hci_read_inquiry_scan_activity and hci_write_inquiry_scan_activity commands 797- chipset: assert hci packet buffers are suitable for firmware upload or patches (atwilc3000,bcm,cc256x,intel) 798- btstack_util: added btstack_replace_bd_addr_placeholder 799 800### Changed 801- AVRCP Target: volume in avrcp_target_volume_changed is reported as current value in interim response to register for volume change notifications 802- SDP Client: query attributes 0x0000..0xffff instead of 0x0001..0xffff to match other stacks / improve compatibility with bad sdp server implementations 803 804 805## Changes Februar 2020 806 807### Fixed 808- AVRCP Target: fix reporting of PLAYBACK_STATUS_CHANGED 809- HCI: handle reconnect request for Classic and LE connections triggered by packet handler for Disconnection Complete Event 810 811### Changed 812- hid_host_mode: allow sniff mode 813 814### Added 815- port/qt-usb and port/qt-h4: integrate BTstack Qt run loop for Unix- and Win32-based Qt application connected to Bluetooth module via H4 over serial port or USB 816 817 818## Changes January 2020 819 820### Fixed 821- L2CAP ERTM: avoid read-after-free on decline of incoming connection 822- GATT Client: set uuid16 to zero when deserializing uuid128 services, characteristics, and descriptors 823- att_db_util: fix realloc of att db buffer for large attributes 824- btstack_tlv_posix: only keep last value in memory, fix delete operation 825- l2cap_signaling: use packet boundary flags 0x00 for LE signaling packets (ignoring hci_non_flushable_packet_boundary_flag_supported()) 826 827### Added 828- att_db_util: provide GATT Database Hash via att_db_util_hash_calc 829- GATT Compiler: provide GATT Database Hash via GATT_DATABASE_HASH Characteristic 830- ATT Server: validate request pdu length 831 832### Changed 833- Crypto: update AES-CMAC implementation to access all message bytes sequentially 834 835 836## Changes December 2019 837 838### Fixed 839- example/pan_lwip_http_server: use Network Access Point, CoD 840- sm: emit pairing complete in master role when no keys are distributed / bonding disabled 841 842### Added 843 844### Changed 845- Updated CC256x initscript: CC256xC v1.3 846- ESP32: add CMake project files 847 848 849## Changes November 2019 850 851### Fixed 852- AVDTP Source: return correct `avdtp_cid` and `local_seid` in `AVDTP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW` 853- L2CAP: send LE Data Channel SDUs round robin with other data 854- L2CAP ERTM: send ERTM I-frames round robin with other data 855 856### Added 857- ATT Server: return error if request to send now for Notification or Indication already registered 858- Linked List: return if item was added for `btstack_linked_list_add[_tail]` 859- btstack_run_loop_remove: return bool true if timer/data source was removed 860- segger-rtt: allow to configure with `SEGGER_RTT_PACKETLOG_*` directives, update to v6.54 861- GAP: support setting Link Supervision Timetout for outgoing Classic connections using `gap_set_link_supervision_timeout` 862- lwip: add download test files to http server demo 863 864### Changed 865- Linked List: return bool true if item was removed 866 867 868## Changes October 2019 869 870### Fixed 871 872### Added 873- `btstack_bool.h`: provide boolean type 'bool' via `<stdbool.h>` or as backport 874- provide `btstack_assert(condition)` 875- H4 Transport: avoid calling `hci_transport_h4_trigger_next_read` when transport is closed 876 877### Changed 878- libusb and posix ports: store bonding information in TLV 879 880 881## Changes September 2019 882 883### Fixed 884- L2CAP ERTM: assert that packet can be stored in fragment buffers in ertm 885- L2CAP ERTM: reject incoming connection if ERTM is configured as mandatory but not supported by remote 886- GATT Client: allow Write Without Response independent of other requests 887 888### Added 889- GAP: allow to reject GAP classic connection via gap_register_classic_connection_filter 890- GAP: support reading RSSI for Classic+LE using gap_read_rssi. Emits `GAP_EVENT_RSSI_MEASUREMENT` 891 892### Changed 893- Bluetooth and BTstack Error Codes and Events: collect status codes in bluetooth.h and events in btstack_defines.h 894- bluetooth.h: extract internal defintitions to respective protocol layers 895- Updated CC256x initscripts (CC256xB v1.8, CC256xC v1.2, CC256xC v1.2) 896 897 898## Changes August 2019 899 900### Fixed 901- POSIX, WICED, Windows, FreeRTOS run loops: handle time_ms overrun after 49 days 902- RFCOMM: accept incoming L2CAP connection in Basic mode if ERTM is enabled but not requested for this connection 903- RFCOMM: limit RFCOMM MTU by local L2CAP MTU for outgoing connections (only revelvant for ERTM) 904- L2CAP ERTM: stop timers on disconnect 905- L2CAP ERTM: fix sending of segmented SDUs 906- L2CAP ERTM: handle unsupported Information Response 907- SM: generate local nonce for confirm value in JW+NC+PK in Secure Connections Responder role 908 909### Added 910- `btstack_run_loop_base`: portable implementation of timer and data source management as base for platform specific implementations 911 912## Changed 913- FreeRTOS: use xQueueCreateStatic (static variant of xQueueCreate) if available for static memory-only setups 914- L2CAP ERTM: handle invalid Information Response (assume no extended features supported) 915- POSIX: use monotonic clock as timebase if available 916- HCI Transport H4/H5/EM9304 SPI: ignore block read/sent from UART driver when closed 917- HCI: Read Encryption Key Size after encryption was enabled 918- Errata 11838: 919 - GAP: gap_set_required_encryption_key_size allows to set the required key size, default = 16 (max) 920 - GAP: validate encryption key size to emit GAP Security Levels 921 922## Changes July 2019 923 924### Fixed 925- SM: Fixed regression introduced in f3582630 926- L2CAP: avoid reading l2cap signaling command len out of bounds 927- HCI Transport H4/H5/EM9304 SPI: fix payload size checks (also for 8/16-bit platforms) 928 929### Changed 930- SM: Start encryption upon receiving slave securiy request if bonded 931- hci: use 2 as HCI_INCOMING_PRE_BUFFER_SIZE in LE-only configuration for GATT Client 932 933--- 934 935## Changes June 2019 936 937### Changed 938- FreeRTOS: use freertos/.. prefix to include FreeRTOS headers if HAVE_FREERTOS_INCLUDE_PREFIX is defined 939- BNEP: add Connection Handle to BNEP_EVENT_CHANNEL_OPENED 940- Examples: renamed le_counter to gatt_counter and le_streamer to le_streamer_server to indicate support for GATT over BR/EDR 941 942### Fixed 943- BNEP: Bluetooth address is stored in little-endian format for all BNEP_EVENT_* 944- libusb: avoid use-after-free for SCO packets on disconnect 945 946### Added 947- example: pan_lwip_http_server using lwIP as network stack to implement PAN NAP service 948- platform/lwip/bnep_lwip.c: BNEP lwIP adapter that forwards packets between BNEP service and lwIP 949- ENABLE_GATT_OVER_CLASSIC enables support for GATT over BR/EDR in att_server 950 951--- 952 953## Changes May 2019 954 955### Changed 956- ESP32: Configure SCO over HCI after power up 957- btstack_tlv_flash_bank: support targets where a value cannot be overwritten with zero. When ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 958 is defined, an explicit delete field is used to indicate an invalid entry. 959 960### Fixed 961- SM: Avoid potential use-after-free on immediate disconnect (lookup connection via con handle instead of storing pointer) 962 963### Added 964- gatt_client: emit query complete event for signed write operation 965- hci_transport_h4: add workaround for flow control bug in CYW2070x, enable with ENABLE_CYPRESS_BAUDRATE_CHANGE_FLOWCONTROL_BUG_WORKAROUND 966 967--- 968 969## Changes April 2019 970 971### Changed 972- ESP32: use micro-ecc from 3rd-party as esp-idf removed it in their 3.3 release 973 974### Fixed 975- hci: pad LE Scan response with zeroes 976- SM: store local CSRK 977- ATT DB: call write callback for validated signed writes 978- ATT Server: abort signed write validation on incoming new request 979- Bluetooth SIG web scraping tools updated 980- libusb: compiles for FreeBSD 981 982### Added 983 984--- 985 986## Changes March 2019 987 988### Changed 989- use Makefile for stm32-f4discovery-cc256x port 990- le_device_db: add secure_connection argument to le_device_db_encryption_set and le_device_db_encryption_get 991 992### Fixed 993- SM: Use provided authentication requirements in slave security request 994 995### Added 996- port/stm32-f4discovery-cc256x: add support for built-in MEMS microphone 997- SM: Track if connection encryption is based on LE Secure Connection pairing 998- ATT DB: Validate if connection encrypted is based on SC if requested 999- att_db_util: support ATT_SECURITY_AUTHENTICATED_SC permission flag 1000- GATT Compiler: support READ_AUTHENTICATED and WRITE_AUTHENTICATED permsission flags 1001- ESP32: erase nvs flash is newer nvs version found 1002- libusb: add support for nRF52840-PCA10056 running Zephyr hci_usb example 1003- port/stm32-l073rz-nucleo-em9304 for Nucleo L073RZ with EM9304 DVK, replaces port/stm32-l053r8-nucleo-em9304 1004 1005## Changes February 2019 1006 1007### Changed 1008- example/a2dp_sink_demo: use linear resampling to fix sample rate drift 1009- btstack_audio: split interface into sink and source 1010 1011### Fixed 1012- Crypto: fix lockup when stack is shutdown while waiting for result of HCI Command, e.g. LE Read Local P256 Public Key 1013- SM: Avoid SM_EVENT_PAIRING_COMPLETE with ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION after successful pairing in responder role 1014 1015### Added 1016- example/a2dp_sink_demo: add target role, support volume control on both devices 1017- example/audio_duplex: playback audio audio source on audio sink (test audio path) 1018- btstack_audio_embedded: implement audio source path 1019 1020--- 1021 1022## Changes January 2019 1023 1024### Changed 1025- L2CAP: provide channel mode (basic/ertm) and fcs option in L2CAP_EVENT_CHANNEL_OPENED 1026- RFCOMM: support L2CAP ERTM. Callbacks passed to rfcomm_enable_l2cap_ertm() are used to manage ERTM buffers 1027 1028### Added 1029- L2CAP: emit L2CAP_EVENT_ERTM_BUFFER_RELEASED if ERTM buffer not needed/used anymore 1030- L2CAP: add fcs_option to ERTM config l2cap_ertm_config_t 1031- HCI: validate advertisement data length field when generating GAP_EVENT_ADVERTISING_REPORT 1032- ad_parser: validate data element length fields in ad_iterator_has_more 1033- Raspberry Pi 3 A+/B+ port in port/raspi, starts without power cycle 1034 1035### Fixed 1036- HCI: release outgoing buffer on disconnect if waiting to send another ACL fragment 1037- POSIX: use correct baudrate enums for baud rates higher than 921600 (Linux) 1038- Crypto: directly process queued crypto operation on HCI result 1039 1040--- 1041 1042## Changes December 2018 1043 1044### Added 1045- SM: generate and store ER / IR keys in TLV, unless manually set by application 1046- hci_dump: support PacketLogger or BlueZ format output via SEGGER RTT Channel 1 Up 1047 1048### Fixed 1049- SM: fix internal buffer overrun during random address generation 1050 1051## Changes November 2018 1052 1053### Added 1054- GAP: gap_le_connection_interval provides connection interval for conn handle 1055- Nordic SPP Service Server: GATT service that emulates a serial port over BLE based on Nordic Semiconductor documentation. 1056- uBlox SPP Service Server: GATT service that emulates a serial port over BLE based on uBlox documentation. 1057- SM: ENABLE_LE_CENTRAL_AUTO_ENCRYPTION triggers automatic encryption on connect to bonded devices 1058- SM: generate and store ER / IR keys in TLV, unless manually set by application 1059 1060### Fixed 1061- SM: prevent random address updates if gap_random_address_set was used 1062- SM: fix internal buffer overrun that can cause storing of bonding information to fail 1063- SM: ignore Slave Security Request after sending own Pairing Request 1064- L2CAP: fix use after free on disconnect if ERTM is enabled 1065- HFP: Handle multiple commands/responses in single RFCOMM packet 1066- Memory Pools: clear all buffers before use 1067 1068--- 1069 1070## Changes October 2018 1071 1072### Added 1073- SDP Server: queue incoming connections when already connected instead of rejecting them 1074- GAP: Support enter/exit sniff mode via gap_sniff_mode_enter/exit. gap_set_default_link_policy_settings is needed to enable sniff mode in general. 1075- HIDS Device: GATT service that exposes HID reports intended for HID Devices, like keyboard and mouse. 1076 1077### Fixed 1078- HCI: fix bug in gap_inquiry_stop that triggered additional GAP_EVENT_INQUIRY_COMPLETE instead of stopping the inquiry 1079- L2CAP: fix issue with outgoing connection before read remote supported complete when other channels exist 1080- L2CAP ERTM: allow SDU of szie MPS in first packet that contains L2CAP SDU Length 1081- L2CAP ERTM: fix memory corruption triggered if local_mtu > mps 1082- L2CAP ERTM: fix outgoing fragment management 1083- HFP: decline incoming RFCOMM connection after outgoing connection was started 1084- AVRCP: fix crash on disconnect of connection established by remote 1085 1086--- 1087 1088## Changes September 2018 1089 1090### Fixed 1091- HCI: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled 1092- L2CAP: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled 1093- L2CAP: Evaluate 'can send now' on HCI Disconnect as ACL buffers in Bluetooth Controller have been used for the closed connection are freed implicitly 1094- L2CAP: Check can send now before sending extended information requeste needed for ERTM mode 1095- L2CAP: Use valid signaling identifier for L2CAP Connection Parameter Update Request 1096- RFCOMM: Trigger l2cap request to send on rfcomm credits when client is waiting to sendtrigger l2cap request to send on rfcomm credits when client is waiting to send 1097- RFCOMM: Avoid use-after-free on channel finalize 1098- GATT Client: stop timer on disconnect - fixes use after free / crash 1099 1100### Added 1101- A2DP Source: Support stream reconfiguration (a2dp_source_reconfigure_stream_sampling_frequency) 1102- 3rd-party: yxml is used for PBAP vCard list parsing 1103- cc256xC: new v1.1 init scripts 1104 1105--- 1106 1107## Changes August 2018 1108 1109### Added 1110- PBAP: added pbap_get_phonebook_size() to get phonebook entry count 1111 1112### Fixed 1113- GATT Server: Allow enable Notifications/Indication with Write Command. Fixes issue with some Android devices. 1114- SM: fix pairing for Secure Connections with Bonding if remote sends additional keys 1115- SM: drop LTK flag from Pairing Response for Secure Connections 1116- L2CAP: fix emitted L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_REQUEST 1117 1118## Changes June 2018 1119 1120### Added 1121- btstack_audio.h: application level API for audio playback and recording 1122- embedded/hal_audio.h: low-level API for audio playback and recording 1123- HID Device: hid_device_connect(..) function 1124- ESP32: implement hal_audio 1125- DA14585: support for Dialog Semiconductor DA14585 LE-only controller 1126- Raspberry Pi 3 + Raspberry Pi Zero W port in port/raspi 1127 1128### Changed 1129- Errata 10734: 1130 - SM: Generate new EC Public Keypair after each pairing 1131 - SM: Abort failure with DHKEY_CHECK_FAILED if received public key is invalid (instead of unspecified error) 1132- btstack.h: only include classic headers if ENABLE_CLASSIC is defined 1133- windows: ignore virtual Bluetooth adapter provided by VMware 1134- Replaced HCI_PACKET_BUFFER_SIZE with HCI_INCOMING_PACKET_BUFFER_SIZE and HCI_OUTGOING_PACKET_BUFFER_SIZE 1135 1136--- 1137 1138## Changes June 2018 1139 1140### Fixed 1141- HFP: Fix Wide Band Speech bit in SDP record for both HF/AG. Missing bit prevents macOS from using mSBC 1142- ATT Server: send ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE with status ATT_HANDLE_VALUE_INDICATION_DISCONNECT on disconnect 1143- AVRCP Controller: fix parsing of now playing info 1144 1145### Changed 1146- ATT Server: ATT_HANDLE_VALUE_INDICATION_DISCONNECT is delivered to service handler if registered 1147 1148### Added 1149- ATT Server: packet handler field added to att_service_handler_t to receive: connect/disconnect, atu exchange, indication complete 1150 1151--- 1152 1153## Changes May 2018 1154 1155### Added 1156- GAP: re-encrypt outgoing connection if bonded 1157- ATT Server: wait until re-encryption is complete 1158- GATT Client: wait until re-encryption is complete 1159- ATT Server: added att_server_request_to_send_notification and att_server_request_to_send_indication 1160- GATT Client: if ENABLE_GATT_CLIENT_PAIRING, GATT Client starts pairing and retry operation on security error 1161 1162### Changed 1163- ATT Server: att_server_register_can_send_now_callback is deprecated, use att_server_request_to_send_notification/indication instead 1164 1165### Fixed 1166- SM: Fix LE Secure Connection pairing in Central role 1167- le_device_db_tlv: fix seq nr management 1168- SM: improve le_device_db lookup and storing of IRK 1169- GATT Server: fix lookup for Client Characteristic Configuration in services with multiple Characteristics 1170- RFCOMM: emit channel closed on HCI/L2CAP disconnect after sending DISC while expecting UA 1171 1172--- 1173 1174## Changes April 2018 1175 1176### Added 1177- Crypto: btstack_crypo.h provides cryptographic functions for random data generation, AES128, EEC, CBC-MAC (Mesh) 1178- SM: support pairing using Out-of-Band (OOB) data with LE Secure Connections 1179- Embedded: support btstack_stdin via SEGGER RTT 1180 1181### Changed 1182- att_db_util: added security requirement arguments to characteristic creators 1183- SM: use btstack_crypto for cryptographpic functions 1184- GAP: security level for Classic protocols (asides SDP) raised to 2 (encryption) 1185 1186### Fixed 1187- HFP: fix answer call command 1188- HCI: fix buffer overrun in gap_inquiry_explode 1189- SDP: free service record item on sdp_unregister_service 1190 1191## Changes March 2018 1192 1193### Added 1194- GAP: allow to limit number of connections in LE Peripheral role with gap_set_max_number_peripheral_connections 1195- ATT Server: support for delayed ATT read response, see example/att_delayed_read_response.c 1196- ATT Server: allow to specify security requirements seperately for read/writes. .h files need to be regenerated 1197 1198### Fixed 1199- RFCOMM: fix infinite loop on L2CAP connection error (regression from 4c3eeed1) 1200- HSP HS: accept incomming SCO connection 1201- SM: fix iteration over LE Device DB entries for bonding and address resolving 1202- SM: store pairing information only if both devices have requested bonding 1203 1204--- 1205 1206## Changes February 2018 1207 1208### Added 1209- GATT Client: gatt_client_request_can_write_without_response_event() causes GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE 1210- SM: new event SM_EVENT_PAIRING_COMPLETE 1211- GAP: support iteration over stored Classic link keys: gap_link_key_iterator_init, gap_link_key_iterator_get_next, gap_link_key_iterator_done 1212- GAP: add gap_delete_all_link_keys 1213 1214### Changed 1215- GATT Client: round robin for multiple connections 1216- ATT Dispatch: round robin for ATT Server & GATT Client 1217- L2CAP: round robin for all L2CAP channels (fixed and dynamic) 1218- btstack_link_key_db: addition functions for link key iteration 1219- GAP: LE scanning enabled not reset on HCI Reset -> can be enabled before HCI Power Up 1220- CSR: set all keys in psram instead of default 1221 1222### Fixed 1223- tc3556x: fix startup after baud rate change 1224 1225--- 1226 1227## Changes January 2018 1228 1229### Added 1230- Port for Windows with Zephyr HCI Firmware connected via serial port 1231- em9304: upload patch containers during HCI bootup 1232- Makefile for STM32-F4Discovery port 1233- support for console out via SEGGER RTT 1234- LE Data Channels example in BTstack and [iOS example on GitHub](https://github.com/bluekitchen/CBL2CAPChannel-Demo) 1235- LE Streamer Client can send as fast as possbile as well 1236- L2CAP: option to limit ATT MTU via l2cap_set_max_le_mtu 1237 1238### Changed 1239- HCI: allow to set hci_set_master_slave_policy (0: try to become master, 1: accept slave) 1240- GAP: gap_set_connection_parameters includes scan interval and window params 1241- GATT Client: GATT_EVENT_MTU indicates max MTU 1242- ATT DB Util: attribute handle is returned for new Services and Characteristics 1243 1244### Fixed 1245- Windows: retry serial port operations if not all bytes have been read/written 1246- HFP: avoid buffer overflows setting up messages 1247- SBC Decoder: improved error handling for invalid SBC audio data 1248- GAP: fix Connection Parameter Response in Central role 1249- ATT DB Util: update pointer to database in case of realloc 1250- GATT Client: set UUID16 field if 16-bit UUID is stored as UUID128 1251- GAP: release HCI Connnection after gap_le_conne 1252- ATT: Exchanged MTU is propagate to ATT Server and GATT Client 1253 1254--- 1255 1256## Changes December 2017 1257 1258### Added 1259- Introduced btstack_network.h network interface abstraction 1260- btstack_network_posix implementation using Linux tun/tap interface 1261- WICED: support for btstack_stdin (HAVE_STDIN) 1262- GATT Server: Writes to GATT Client Characteristic Configuration are stored in TLV and restored on reconnect. The db.h file generated from db.gatt needs to be re-created. 1263- TLV: global TLV instance available via btstack_tlv_get_instance() (src/btstack_tlv.h) 1264- TLV: POSIX implementation that appends to a file on disk (platform/posix/btstack_tlv_posix.c 1265- LE Device DB TLV: overwrite oldest entry if no free entries available 1266- SM: allow to set fixed passkey in display role using sm_use_fixed_passkey_in_display_role 1267- Example/hid_host_demo with HID parser and support for basic US keyboard layout 1268- EM9304: custom HCI Transport implementation for EM9304 on top of btstack_em9304_spi.h platform abstraction only requires hal_em9304_spi.h to be implemented for new ports 1269- Port for Apollo2 MCU with EM9304 (ports/apollo2-em9304) 1270 1271### Changed 1272- panu_demo: uses btstack_network.h now 1273- WICED: configure printf to replace Linefeed with CRLF 1274- SBC: split btstack_sbc_bludroid.c into seperate encoder and decoder implementations 1275 1276### Fixed 1277- RFCOMM: support connection requests during connection failure 1278- L2CAP: support connection requests during connection failure 1279- L2CAP: fix default remote MTU as 672 instead of 48 (Minimal MTU) 1280- HCI: avoid double free during halting 1281- SM: fixed reconnect using legacy pairing in slave role 1282 1283 1284