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