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