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