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