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