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