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