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