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