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- HCI Dump: Support BTSnoop format in hci_dump_posix_fs.c for format = HCI_DUMP_BTSNOOP 13- HCI Dump RTT STDOUT: drop messages if RTT buffer is full and RTT is configured for non-blocking 14- hci_cmd: support variable length fields and arrayed parameters 15- POSIX: btstack_signal allows to register for callback on signal, e.g. ctrl-c 16- Windows: btstack_stdin_window_register_ctrl_c_callback allows to register for ctrl-c 17- A2DP: allow to register media codec validator for sink and source with: 18 - `a2dp_sink_register_media_config_validator` 19 - `a2dp_source_register_media_config_validator` 20 21### Fixed 22- A2DP Source: fix reconfigure 23- PBAP Client: handle chunked vCard Listing 24- SM: Work around for unexpected Windows 10 disconnect for BR Secure Connections (SMP over BR timeout) 25 26### Changed 27- HFP: API functions return status code if appropriate 28- HFP: removed one parameter from hfp_ag/hf_activate_voice_recognition function, instead introduced hfp_ag/hf_deactivate_voice_recognition 29- HFP: event HFP_SUBEVENT_VOICE_RECOGNITION_STATUS emitted on (enhanced) voice recognition status change. Field "activated" replaced with "state". Added additional "status" field that indicates if the command was successful. 30- HFP: streamlined enhanced voice recognition function names 31- AVDTP: media config validator is called with preview of media codec configuration event and configured separately for sink/source 32- AVRCP: use PANEL as default unit + subunit info 33- Run Loop: new functionality for HCI transport drivers and inter-process communication 34 - *btstack_run_loop_poll_data_sources_from_irq*: used to transfer control from IRQ handler to main thread/run loop 35 - *btstack_run_loop_execute_on_main_thread*: schedule code execution on main thread from other thread 36 - *btstack_run_loop_trigger_exit*: trigger run loop exit 37- POSIX / Windows / Raspi / Qt: use updated ctrl-c handling 38 39 40## Release v1.4.1 41 42### Added 43- GAP: emit GAP_EVENT_PAIRING_STARTED and GAP_EVENT_PAIRING_COMPLETE 44 45### Fixed 46- GAP: store link key in hci connection struct to allow authenticate after pairing without bonding 47- GAP: avoid requesting authentication twice 48- GAP: cache own address on start advertising and connecting, provide getters 49- GAP: stop LE connecting if create connection fails (e.g. connectable adv active and multiple roles not supported) 50- SM: fix race condition between local address changes and pairing procedure 51- ATT DB: fix spelling `gatt_server_get_handle_range_for_service_with_uuid128`, `gatt_server_get_handle_range_for_service_with_uuid16` 52 53### Changed 54- HCI: update advertising data without stopping advertising first 55- GAP: Drop local bonding flag in IO Capability Reply if remote does not indicate bonding 56- GAP: return status for `gap_set_security_mode` 57- GAP: abort legacy pairing if Level 4 is required 58- GAP: abort SSP on IO Capabilities Request event if Level 4 is required but SC not supported by remote 59- GAP: abort SSP on User Confirmation Request event if Level 3 is required but MITM protection not possible 60- GAP: validate minimal service security level can be reached during pairing in responder role 61- L2CAP: don't trigger hci disconnect if l2cap security requirements are insufficient 62- CVE-2020-26555: reject connections to and from devices with same BD ADDR 63- CVE-2020-26555: ignore NULL link key 64- CVE-2020-26558: abort LE Secure Connection pairing if remote uses the same public key 65 66## Release v1.4 67 68### Added 69- HCI: `btstack_transport_sco.h` supports SCO over physical PCM/I2S interface (`HAVE_SCO_TRANSPORT`) 70- POSIX: `btstack_transport_sco_i2s_test_bridge.c` implements SCO transport interface for UART-to-I2S test bridge 71- btstack_uart: `btstack_uart_t` interface extends `btstack_uart_block_t`: 72 - support sending and receiving SLIP frames for HCI H5 73 - support odd parity 74 - `hci_transport_h4` and chipset drivers have new functions to provide `btstack_uart_t` 75- btstack_uart_slip_wrapper: wrapper that implements SLIP functionality for existing `btstack_uart_block` drivers. 76- hci_transport: add parity field and pass on to `btstack_uart_t` in h4 and h5 77- GATT Client: Battery Service Client 78- GATT Client: Device Information Service Client 79- GATT Client: HID-over-GATT (HOG) Client, Report and Boot Host 80- GATT Client: Scan Parameters Service Client 81- GATT Server: Scan Parameters Service Server 82- GAP: support scan page configuration with `gap_set_page_scan_activity` and `gap_set_page_scan_type` 83- GAP: support sniff subrating with `gap_sniff_subrating_configure` 84- GAP: support QoS setup with `gap_qos_set` 85- AVRCP: new field `button_pressed` in `AVRCP_SUBEVENT_OPERATION` 86- AVRCP: `AVRCP_SUBEVENT_OPERATION` emitted for button release 87- AVRCP Controller: `avrcp_controller_start_press_and_hold_cmd` supports arbitrary device buttons 88- AVRCP Controller: reassemble fragmented AVCTP packets 89- AVDTP: `avdtp_register_media_config_validator` allows to validate media codec configuration 90- A2DP Source: `ENABLE_A2DP_SOURCE_EXPLICIT_CONFIG` disables auto config. requires call to `a2dp_source_set_config_{CODEC}` 91 92### Fixed 93- GAP: calculate IO Cap AuthReq Bondable Mode based on `gap_ssp_set_authentication_requirement` and `gap_set_bondable_mode` 94- GAP: only store link key for SSP if remote side has set bondable in io cap auth requirements 95- GAP: allow to disable link supervision timeout 96- GAP: fix `gap_connect` after `gap_connect_cancel` 97- GAP: re-configure advertisements after power cycle 98- HCI: handle start inquiry failure 99- L2CAP: fix create outgoing connection triggered from packet handler on hci disconnect event 100- L2CAP: return unknown mandatory option in config response 101- AVDTP: fix spelling `avdtp_set_preferred_sampling_frequency` 102- AVRCP Target: fix notification changed event 103- HFP: Emit audio connection released on SLC Release, e.g. on remote power off 104- HFP HF: fix audio connection setup if codec negotiation is supported 105- HFP HF: only emit single event for RING and AG Status updates 106- HFP AG: fix audio connection setup for in-band ringtone on incoming connection 107 108### Changed 109- Port Archive: moved ports that are not recommended for new designs to port/archive folder: 110 - MSP430: the ports used the older community GCC version without 20-bit support needed for code size > 64kB 111 - Broadcom/Cypress H5: uploading PatchRAM is only possible in H4 mode. It's better to also use H4 in general 112 - PIC32-Harmony: the port used Harmony v1 while Harmony v3 has been out since a while 113 - iOS: not supported 114- Run Loop Base: functionality used in most platform run loop implementations 115 - code from `btstack_run_loop_base.c` moved into `btstack_run_loop.c` to minimize changes to build systems 116 - `btstack_run_loop_base.c` is a placeholder and can be removed from build 117- HCI Dump: replace monolithic `hci_dump.c` (with many #ifdefs) into dispatcher with platform-specific implementations: 118 - `posix/hci_dump_posix_fs` - writes binary log file 119 - `posix/hci_dump_stdout` - log to console using printf with local system time 120 - `embedded/hci_dump_embedded_stdout` - log to console using printf 121 - `embedded/hci_dump_segger_stdout` - log to RTT console using `SEGGER_printf` 122 - `embedded/hci_dump_segger_binary` - writes binary log over RTT to host 123- HCI: config I2S for BCM Controllers if `ENABLE_SCO_OVER_PCM`, reduce bit clock to 256/512 kHz 124- btstack_uart_posix: supports SLIP frames and replaces `btstack_uart_block_posix` 125- hci_transport_h5: more performant H5 implementation that requires `btstack_uart_t` driver with SLIP support 126- POSIX Ports: use new `btstack_uart_posix` implementation 127- posix-h5/posix-h5-bcm: use even parity for UART 128- HCI Transport: extract convenience function declaration for h4, h5, em9304_spi, and usb into separate hci_transport_{type}.h 129- GAP: provide Device ID from EIR in GAP_EVENT_INQUIRY_RESULT 130- GAP: only store link key if it allows requested security level 131- GAP: abort SSP pairing if MITM protection required but not possible 132- SM: start pairing as Central for already encrypted connection on Slave Security Request 133- GATT Client: Use ATT_READ_REQUEST for first blob of Read Long Characteristic and Read Long Characteristic Descriptor 134- GATT Server: Allow ATT Read Callback to return custom ATT Error Code 135- Nordic SPP Service Server: use `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` and `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` 136 events instead of callback, and `RFCOMM_DATA_PACKET` for received data 137- u-blox SPP Service Server: use `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` and `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` 138 events instead of callback, and `RFCOMM_DATA_PACKET` for received data 139- HID: Move `src/classic/hid.h` into `src` and prefix with `btstack_` to use it with BLE and avoid name clashes 140- HFP: provide acl_handle in events to identify connection 141- HSP AG: emit HSP_SUBEVENT_BUTTON_PRESSED instead of audio connection setup/release 142- Example: use `btstack_event.h` getters instead of direct array access, use enum to compare status codes 143 144 145## Release v1.3.2 146 147### Added 148- GAP: support for Classic Out-of-Band (OOB) pairing via `gap_ssp_remote_oob_data` with `ENABLE_CLASSIC_OOB_PAIRING` 149- GAP: read local OOB data on start and on call to `gap_ssp_generate_oob_data`, provided via `GAP_EVENT_LOCAL_OOB_DATA` 150- HID Host: add profile, update `hid_host_demo.c` example 151 152### Fixed 153- L2CAP: make handling of HCI disconnect more robust 154- AVDTP: emit stream release for active stream if signaling connection is closed first, e.g. caused by HCI disconnect 155- AVRCP: fix issue when Controller and Target send at the same time 156 157### Changed 158- A2DP, AVDTP: use `a2dp_source_set_config_{TYPE}` and `avdtp_config{TYPE}_store` to avoid large number of parameters 159 160 161## Release v1.3 162 163### Added 164- CC256x: with ENABLE_CC256X_ASSISTED_HFP, HFP enables WBS codec on demand and configures PCM/I2S interface for 8kH/16kHz 165- BCM: with ENABLE_BCM_PCM_WBS, HFP enables WBS codec on demand and configures PCM/I2S interface for 8kH/16kHz 166- SDP Client RFCOMM: add `sdp_client_query_rfcomm_channel_and_name_for_service_class_uuid` 167- HFP: `ENABLE_HFP_AT_MESSAGES` lets HFP emit `HFP_SUBEVENT_AT_MESSAGE_SENT` and `HFP_SUBEVENT_AT_MESSAGE_RECEIVED` 168- A2DP, AVDTP: provide capabilities and configuration events for A2DP codecs: SBC, MPEG Audio, MPEG AAC, ATRAC 169- A2DP + AVDTP Source: allow to send media packet with `avdtp_source_stream_send_media_packet` and `a2dp_source_stream_send_media_packet` 170- A2DP + AVDTP Source: add `avdtp_source_stream_send_media_payload_rtp` and `a2dp_source_stream_send_media_payload_rtp` 171- A2DP Source: emit `A2DP_SUBEVENT_SIGNALING_CAPABILITIES_COMPLETE` 172- A2DP Source: allow to configure endpoints by calling `a2dp_source_set_config_{TYPE}` during SEP discovery with SBC fallback 173 174### Fixed 175- HCI: keep `le connecting request` on connection complete active, fixes gap_auto_connection_stop() + gap_auto_connection_start() 176- L2CAP: fix packet size check for incoming classic basic channels (regression introduced in v1.2.1) 177- HFP AG/HSP AG: avoid connecting to remote service with same role 178- A2DP Source: support multiple Stream Endpoints with different Media Codec types 179- A2DP Source: emit codec configure event with reconfigure flag set on reconfigure 180- GATT Compiler: support multiple instances of the same service 181 182### Changed 183- GAP: provide Link Type parameter to incoming connection filter for `gap_register_classic_connection_filter` 184- HFP/GOEP Client/AVDTP/A2DP: return `SDP_SERVICE_NOT_FOUND` if no suitable SDP record is found 185- AVDTP Source: `avdtp_source_stream_send_media_payload` includes SBC Header and was deprecated 186- AVDTP/A2DP: use `avdtp_channel_mode_t` in `A2DP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION` 187- A2DP: fix events and use `a2dp_cid`, `local_seid,` `remote_seid` field names in A2DP sub-events 188- GATT Client: Skip MTU exchange after MTU exchange on ATT Server 189- Ports: STM32-F103RB Nucleo + CC256x port removed 190- ESP32: enabled HFP Wide-Band Speech, disable classic secure connections in HSP/HFP demos 191 192 193## Release v1.2.1 194 195### Fixed 196- L2CAP: use connection handle for channel lookups 197- L2CAP: forward data only in open state 198 199### Changed 200- L2CAP: check packet size against local mtu for classic basic channels 201 202 203## Release v1.2 204 205### Fixed 206- L2CAP: trigger pairing for outgoing LE Data Channels if security level insufficient 207- SM: fix update of sc flag for re-encrypted connection in peripheral role 208- SM: send security request on re-connect if bonded and `ENABLE_LE_PROACTIVE_AUTHENTICATION` is defined 209- ESP32: fix audio sink driver 210 211### Added 212- GAP: `gap_delete_bonding` removes device from LE Resolving List and from discards LE bonding information 213- GATT Client: delete bonding information if re-encryption fails and `ENABLE_LE_PROACTIVE_AUTHENTICATION` is not defined 214- GATT Client: gatt_client_set_required_security_level() allows to set required minimum security level for all GATT requests 215- SM: emit events for re-encryption started/complete when bonding information is available 216 217### Changed 218- AVRCP Controller: allow to send multiple absolute volume commands without waiting for response. 219- GAP: replaced `ENABLE_LE_CENTRAL_AUTO_ENCRYPION` with `ENABLE_LE_PROACTIVE_AUTHENTICATION` 220 221 222## Changes October 2020 223 224### Fixed 225- AVDTP Initiator: avoid use of remote seid for stream endpoint lookup, fixes issue with two connected devices 226- AVDTP Source: buffer for SBC media codec information got discarded, leading to invalid Set Configuration command in second connection 227- SM: only trigger Cross-Transport Key Derivation (CTKD) when bonding is enabled 228- SM: set LinkKey flag to request CTKD if enabled 229- SM: store CTKD key with Public Identity Address 230- SM: only allow CTKD to overwrite existing link key if derived key has same or higher authentication 231- SM: start SMP Timeout when sending Security Request 232- HFP HF: fix response to AG Codec Selection while waiting for OK of parallel command 233- HCI: fix reject of LE remote connection param request via HCI 234 235### Added 236- GAP: add `gap_get_link_key_for_bd_addr` 237- GAP: add `gap_bonded` to check if bonding information is available for active connection 238- SM: support h7 for CTKD 239 240### Changed 241- SM: Cross-Transport Key Derivation requires `ENABLE_CROSS_TRANSPORT_KEY_DERIVATION` now 242- SM: block connection if encryption fails for bonded devices as Central 243- SM: support pairing as Central after failed re-encryption 244 245 246## Release v1.1 247 248### Fixed 249- AVRCP/AVCTP: report AVRCP 1.6 and AVCTP 1.4 in SDP record 250 251### Added 252 253### Changed 254 255 256## Changes September 2020 257 258### Fixed 259- HFP: fix parsing of ranges e.g. in +CIND responses 260- AVDTP, AVRCP: fix bugs due to transaction id overrun 261- A2DP Source: fix issues with stream configuration by sink 262- hci_dump: fix tv_us calculation for non-posix / embedded systems with binary output 263 264### Added 265- `btstack_ring_buffer`: add `btstack_ring_buffer_reset` to reset it to initial state/empty 266- GAP: Support for address resolution of resolvable private addresses by Controller with `ENABLE_LE_PRIVACY_ADDRESS_RESOLUTION` 267 268### Changed 269- AVDTP, AVRCP, HSP: schedule SDP query, avoids avoids 'command disallowed' if SDP client is busy 270- HSP, HFP: allow to configure usable SCO packet types 271- cc256x: update CC256xC init script to v1.4 272- A2DP Source: use Get All Capabilities if supported by remote get Delay Reporting capability 273 274## Changes August 2020 275 276### Fixed 277- ESP32: fix authentication for incoming Secure Connections 278- AVDTP: Fix forwarding of Delay reports 279- STM32-F4Discovery: fix pan_lwip_http_server by increasing HCI_ACL_PAYLOAD_SIZE 280- tool/create_packet_log: basic support for 16-bit Unicode log files from Windows 281 282### Added 283- `btstack_run_loop_base`: added `btstack_run_loop_base_dump_timer` 284- GAP: request role change for classic connection via `gap_request_role` 285- GAP: LE Whitelist API with `gap_le_whitelist_x` with x = add, remove, clear and new `gap_connect_with_whitelist` 286- SDP Client: add sdp_client_register_query_callback() allows to register query request instead of polling sdp_client_ready() 287- BNEP lwIP: add `bnep_lwip_connect` to establish BNEP connection and manage lwIP network interface 288- New `btstack_linked_queue` utility, a linked list-based queue with first-in-first-out semantics and constant time enqueue/dequeue operations 289- btstack_tlv_posix: add `btstack_tlv_posix_deinit` 290- New `btpclient` for use with [auto-pts project](https://github.com/intel/auto-pts) 291 292### Changed 293- GAP: treat AES-CCM encrypted connection as mutually authenticated (BIAS) 294- GAP: 'gap_auto_connect_x' API deprecated. Please directly manage LE Whitelist with `gap_le_whitelist_*` functions and call `gap_connect_with_whitelist` instead 295- example/hid_host_demo: try to become master for incoming connections 296- btstack_run_loop: use btstack_assert instead of local while(true) 297- att_db_util: allow to reset att_db via `att_db_util_init` 298 299## Changes July 2020 300 301### Fixed 302- AVDTP: fix invalid response for Get Capabilities request if Delay Reporting was supported 303- AVDTP: handle concurrent signaling establishment with reject and retry 304 305### Added 306- example/hid_host_demo: support reconnect from HID device 307- Crypto: support software AES128 for AES-CCM operations 308- AVRCP: introduced AVRCP_FEATURE_MASK_* as alternative to avrcp_controller_supported_feature_t and avrcp_target_supported_feature_t enums 309- btstack_audio: add set_volume() to sink and set_gain() to source interfaces, minimal volume control for portaudio playback 310- 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 311- GAP: Provide gap_get_role to query master/slave role for HCI connection handle 312- GAP: Provide gap_pin_code_response_binary to use binary data as PIN, e.g. for pairing with Nintendo Wii Remote 313 314### Changed 315- GAP: set minimum required encryption key size for Classic connections back from 16 to 7, matching the Core spec 316 317 318## Changes June 2020 319 320### Fixed 321- HFP: Fix parsing of empty fields, e.g. phone number in +CLCC and other AT commands 322- SM: Fix validation of confirm value for secure connection Passkey entry 323- AVRCP: handle concurrent signaling establishment with reject and retry 324 325### Added 326- GAP: Detect Secure Connection -> Legacy Connection Downgrade Attack by remote features and actual encryption type (BIAS) 327- GAP: Mutual authentication: request authentication after Classic connection got encrypted (BIAS) 328- Windows port for Dialog DA14585 connected via serial port 329 330## Changes 331- CVSD PLC: treat zero frames as good and allow to mark data as bad, e.g. if reported by Controller as erroneous 332 333## Changes May 2020 334 335### Fixed 336- hfp_hf, hsp_hs: use eSCO params in accept sco connection only for incoming eSCO connections 337- pbap_client: fix PBAP UUID len on connect message 338- SM: fix secure connection pairing as peripheral when local user confirmation happens after remote one 339- A2DP Source: only connect to remote sink stream endpoints 340- btstack_hal_flash_memory: fix write of 0xff bytes to simulated flash 341- hsp_hs: fix disconnect if audio not connected 342- hsp_ag: fix accept incoming connection 343 344### Added 345- example/le_mitm: MITM implementation that forwards ATT PDUs and allows for pairing 346- GAP: gap_set_security_level sets required security level for incoming and outgoing connections 347- cc256x: allow to specify power vector for each modulation type 348- FreeRTOS: btstack_run_loop_freertos_trigger_exit allows to request run loop exit 349- SM: support LE Secure Connections Only mode with sm_set_secure_connections_only_mode 350- GAP: enable BR/EDR Secure Connections if supported, add gap_secure_connections_enable 351 352### Changed 353- L2CAP ERTM: send extended features request only once per HCI connection 354 355 356## Changes April 2020 357 358### Fixed 359- hog_mouse_demo/hog_keyboard_demo: handle set protocol mode = boot protocol mode 360- HCI: only update BD_ADDR placeholder in shortened and complete name in EIR data, limit device name to 240/248 bytes 361 362### Added 363- GAP: gap_set_allow_role_switch allows to prevent role switch in outgoing classic ACL connections 364- example: hog_boot_host_demo implements an HID-over-GATT Boot Host that supports keyboard and mouse 365- HCI: add ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS that forces fragmentation of ACL-LE packets to fit into over-the-air packet 366 367### Changed 368- Broadcom/Cypress: wait 300 ms after PatchRAM update in hci.c to assert Controller is ready 369- esp32: provide esp-idf/component/btstack/btstack_port_esp32.c and only minimal app_main in template/main/main.c 370- att_db: skip att_read_callback for ATT Read Blob Request if offset == value_len 371 372 373## Changes March 2020 374 375### Fixed 376- GAP: fixed gap_set_scan_parameters() if issued right before gap_start_scan() 377- HCI: only send HCI Read Local Encryption Key Size if supported by Controller 378 379### Added 380- GATT Client: allow to register for any notification/indication and/or any connection 381- HCI: added hci_read_inquiry_scan_activity and hci_write_inquiry_scan_activity commands 382- chipset: assert hci packet buffers are suitable for firmware upload or patches (atwilc3000,bcm,cc256x,intel) 383- btstack_util: added btstack_replace_bd_addr_placeholder 384 385### Changed 386- AVRCP Target: volume in avrcp_target_volume_changed is reported as current value in interim response to register for volume change notifications 387- SDP Client: query attributes 0x0000..0xffff instead of 0x0001..0xffff to match other stacks / improve compatibility with bad sdp server implementations 388 389 390## Changes Februar 2020 391 392### Fixed 393- AVRCP Target: fix reporting of PLAYBACK_STATUS_CHANGED 394- HCI: handle reconnect request for Classic and LE connections triggered by packet handler for Disconnection Complete Event 395 396### Changed 397- hid_host_mode: allow sniff mode 398 399### Added 400- 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 401 402 403## Changes January 2020 404 405### Fixed 406- L2CAP ERTM: avoid read-after-free on decline of incoming connection 407- GATT Client: set uuid16 to zero when deserializing uuid128 services, characteristics, and descriptors 408- att_db_util: fix realloc of att db buffer for large attributes 409- btstack_tlv_posix: only keep last value in memory, fix delete operation 410- l2cap_signaling: use packet boundary flags 0x00 for LE signaling packets (ignoring hci_non_flushable_packet_boundary_flag_supported()) 411 412### Added 413- att_db_util: provide GATT Database Hash via att_db_util_hash_calc 414- GATT Compiler: provide GATT Database Hash via GATT_DATABASE_HASH Characteristic 415- ATT Server: validate request pdu length 416 417### Changed 418- Crypto: update AES-CMAC implementation to access all message bytes sequentially 419 420 421## Changes December 2019 422 423### Fixed 424- example/pan_lwip_http_server: use Network Access Point, CoD 425- sm: emit pairing complete in master role when no keys are distributed / bonding disabled 426 427### Added 428 429### Changed 430- Updated CC256x initscript: CC256xC v1.3 431- ESP32: add CMake project files 432 433 434## Changes November 2019 435 436### Fixed 437- AVDTP Source: return correct `avdtp_cid` and `local_seid` in `AVDTP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW` 438- L2CAP: send LE Data Channel SDUs round robin with other data 439- L2CAP ERTM: send ERTM I-frames round robin with other data 440 441### Added 442- ATT Server: return error if request to send now for Notification or Indication already registered 443- Linked List: return if item was added for `btstack_linked_list_add[_tail]` 444- btstack_run_loop_remove: return bool true if timer/data source was removed 445- segger-rtt: allow to configure with `SEGGER_RTT_PACKETLOG_*` directives, update to v6.54 446- GAP: support setting Link Supervision Timetout for outgoing Classic connections using `gap_set_link_supervision_timeout` 447- lwip: add download test files to http server demo 448 449### Changed 450- Linked List: return bool true if item was removed 451 452 453## Changes October 2019 454 455### Fixed 456 457### Added 458- `btstack_bool.h`: provide boolean type 'bool' via `<stdbool.h>` or as backport 459- provide `btstack_assert(condition)` 460- H4 Transport: avoid calling `hci_transport_h4_trigger_next_read` when transport is closed 461 462### Changed 463- libusb and posix ports: store bonding information in TLV 464 465 466## Changes September 2019 467 468### Fixed 469- L2CAP ERTM: assert that packet can be stored in fragment buffers in ertm 470- L2CAP ERTM: reject incoming connection if ERTM is configured as mandatory but not supported by remote 471- GATT Client: allow Write Without Response independent of other requests 472 473### Added 474- GAP: allow to reject GAP classic connection via gap_register_classic_connection_filter 475- GAP: support reading RSSI for Classic+LE using gap_read_rssi. Emits `GAP_EVENT_RSSI_MEASUREMENT` 476 477### Changed 478- Bluetooth and BTstack Error Codes and Events: collect status codes in bluetooth.h and events in btstack_defines.h 479- bluetooth.h: extract internal defintitions to respective protocol layers 480- Updated CC256x initscripts (CC256xB v1.8, CC256xC v1.2, CC256xC v1.2) 481 482 483## Changes August 2019 484 485### Fixed 486- POSIX, WICED, Windows, FreeRTOS run loops: handle time_ms overrun after 49 days 487- RFCOMM: accept incoming L2CAP connection in Basic mode if ERTM is enabled but not requested for this connection 488- RFCOMM: limit RFCOMM MTU by local L2CAP MTU for outgoing connections (only revelvant for ERTM) 489- L2CAP ERTM: stop timers on disconnect 490- L2CAP ERTM: fix sending of segmented SDUs 491- L2CAP ERTM: handle unsupported Information Response 492- SM: generate local nonce for confirm value in JW+NC+PK in Secure Connections Responder role 493 494### Added 495- `btstack_run_loop_base`: portable implementation of timer and data source management as base for platform specific implementations 496 497## Changed 498- FreeRTOS: use xQueueCreateStatic (static variant of xQueueCreate) if available for static memory-only setups 499- L2CAP ERTM: handle invalid Information Response (assume no extended features supported) 500- POSIX: use monotonic clock as timebase if available 501- HCI Transport H4/H5/EM9304 SPI: ignore block read/sent from UART driver when closed 502- HCI: Read Encryption Key Size after encryption was enabled 503- Errata 11838: 504 - GAP: gap_set_required_encryption_key_size allows to set the required key size, default = 16 (max) 505 - GAP: validate encryption key size to emit GAP Security Levels 506 507## Changes July 2019 508 509### Fixed 510- SM: Fixed regression introduced in f3582630 511- L2CAP: avoid reading l2cap signaling command len out of bounds 512- HCI Transport H4/H5/EM9304 SPI: fix payload size checks (also for 8/16-bit platforms) 513 514### Changed 515- SM: Start encryption upon receiving slave securiy request if bonded 516- hci: use 2 as HCI_INCOMING_PRE_BUFFER_SIZE in LE-only configuration for GATT Client 517 518--- 519 520## Changes June 2019 521 522### Changed 523- FreeRTOS: use freertos/.. prefix to include FreeRTOS headers if HAVE_FREERTOS_INCLUDE_PREFIX is defined 524- BNEP: add Connection Handle to BNEP_EVENT_CHANNEL_OPENED 525- Examples: renamed le_counter to gatt_counter and le_streamer to le_streamer_server to indicate suppport for GATT over BR/EDR 526 527### Fixed 528- BNEP: Bluetooth address is stored in little-endian format for all BNEP_EVENT_* 529- libusb: avoid use-after-free for SCO packets on disconnect 530 531### Added 532- example: pan_lwip_http_server using lwIP as network stack to implement PAN NAP service 533- platform/lwip/bnep_lwip.c: BNEP lwIP adapter that forwards packets between BNEP service and lwIP 534- ENABLE_GATT_OVER_CLASSIC enables support for GATT over BR/EDR in att_server 535 536--- 537 538## Changes May 2019 539 540### Changed 541- ESP32: Configure SCO over HCI after power up 542- btstack_tlv_flash_bank: support targets where a value cannot be overwritten with zero. When ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 543 is defined, an explicit delete field is used to indicate an invalid entry. 544 545### Fixed 546- SM: Avoid potential use-after-free on immediate disconnect (lookup connection via con handle instead of storing pointer) 547 548### Added 549- gatt_client: emit query complete event for signed write operation 550- hci_transport_h4: add workaround for flow control bug in CYW2070x, enable with ENABLE_CYPRESS_BAUDRATE_CHANGE_FLOWCONTROL_BUG_WORKAROUND 551 552--- 553 554## Changes April 2019 555 556### Changed 557- ESP32: use micro-ecc from 3rd-party as esp-idf removed it in their 3.3 release 558 559### Fixed 560- hci: pad LE Scan response with zeroes 561- SM: store local CSRK 562- ATT DB: call write callback for validated signed writes 563- ATT Server: abort signed write validation on incoming new request 564- Bluetooth SIG web scraping tools updated 565- libusb: compiles for FreeBSD 566 567### Added 568 569--- 570 571## Changes March 2019 572 573### Changed 574- use Makefile for stm32-f4discovery-cc256x port 575- le_device_db: add secure_connection argument to le_device_db_encryption_set and le_device_db_encryption_get 576 577### Fixed 578- SM: Use provided authentication requirements in slave security request 579 580### Added 581- port/stm32-f4discovery-cc256x: add support for built-in MEMS microphone 582- SM: Track if connection encryption is based on LE Secure Connection pairing 583- ATT DB: Validate if connection encrypted is based on SC if requested 584- att_db_util: support ATT_SECURITY_AUTHENTICATED_SC permission flag 585- GATT Compiler: support READ_AUTHENTICATED and WRITE_AUTHENTICATED permsission flags 586- ESP32: erase nvs flash is newer nvs version found 587- libusb: add support for nRF52840-PCA10056 running Zephyr hci_usb example 588- port/stm32-l073rz-nucleo-em9304 for Nucleo L073RZ with EM9304 DVK, replaces port/stm32-l053r8-nucleo-em9304 589 590## Changes February 2019 591 592### Changed 593- example/a2dp_sink_demo: use linear resampling to fix sample rate drift 594- btstack_audio: split interface into sink and source 595 596### Fixed 597- Crypto: fix lockup when stack is shutdown while waiting for result of HCI Command, e.g. LE Read Local P256 Public Key 598- SM: Avoid SM_EVENT_PAIRING_COMPLETE with ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION after successful pairing in responder role 599 600### Added 601- example/a2dp_sink_demo: add target role, support volume control on both devices 602- example/audio_duplex: playback audio audio source on audio sink (test audio path) 603- btstack_audio_embedded: implement audio source path 604 605--- 606 607## Changes January 2019 608 609### Changed 610- L2CAP: provide channel mode (basic/ertm) and fcs option in L2CAP_EVENT_CHANNEL_OPENED 611- RFCOMM: support L2CAP ERTM. Callbacks passed to rfcomm_enable_l2cap_ertm() are used to manage ERTM buffers 612 613### Added 614- L2CAP: emit L2CAP_EVENT_ERTM_BUFFER_RELEASED if ERTM buffer not needed/used anymore 615- L2CAP: add fcs_option to ERTM config l2cap_ertm_config_t 616- HCI: validate advertisement data length field when generating GAP_EVENT_ADVERTISING_REPORT 617- ad_parser: validate data element length fields in ad_iterator_has_more 618- Raspberry Pi 3 A+/B+ port in port/raspi, starts without power cycle 619 620### Fixed 621- HCI: release outgoing buffer on disconnect if waiting to send another ACL fragment 622- POSIX: use correct baudrate enums for baud rates higher than 921600 (Linux) 623- Crypto: directly process queued crypto operation on HCI result 624 625--- 626 627## Changes December 2018 628 629### Added 630- SM: generate and store ER / IR keys in TLV, unless manually set by application 631- hci_dump: support PacketLogger or BlueZ format output via SEGGER RTT Channel 1 Up 632 633### Fixed 634- SM: fix internal buffer overrun during random address generation 635 636## Changes November 2018 637 638### Added 639- GAP: gap_le_connection_interval provides connection interval for conn handle 640- Nordic SPP Service Server: GATT service that emulates a serial port over BLE based on Nordic Semiconductor documentation. 641- uBlox SPP Service Server: GATT service that emulates a serial port over BLE based on uBlox documentation. 642- SM: ENABLE_LE_CENTRAL_AUTO_ENCRYPTION triggers automatic encryption on connect to bonded devices 643- SM: generate and store ER / IR keys in TLV, unless manually set by application 644 645### Fixed 646- SM: prevent random address updates if gap_random_address_set was used 647- SM: fix internal buffer overrun that can cause storing of bonding information to fail 648- SM: ignore Slave Security Request after sending own Pairing Request 649- L2CAP: fix use after free on disconnect if ERTM is enabled 650- HFP: Handle multiple commands/responses in single RFCOMM packet 651- Memory Pools: clear all buffers before use 652 653--- 654 655## Changes October 2018 656 657### Added 658- SDP Server: queue incoming connections when already connected instead of rejecting them 659- 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. 660- HIDS Device: GATT service that exposes HID reports intended for HID Devices, like keyboard and mouse. 661 662### Fixed 663- HCI: fix bug in gap_inquiry_stop that triggered additional GAP_EVENT_INQUIRY_COMPLETE instead of stopping the inquiry 664- L2CAP: fix issue with outgoing connection before read remote supported complete when other channels exist 665- L2CAP ERTM: allow SDU of szie MPS in first packet that contains L2CAP SDU Length 666- L2CAP ERTM: fix memory corruption triggered if local_mtu > mps 667- L2CAP ERTM: fix outgoing fragment management 668- HFP: decline incoming RFCOMM connection after outgoing connection was started 669- AVRCP: fix crash on disconnect of connection established by remote 670 671--- 672 673## Changes September 2018 674 675### Fixed 676- HCI: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled 677- L2CAP: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled 678- L2CAP: Evaluate 'can send now' on HCI Disconnect as ACL buffers in Bluetooth Controller have been used for the closed connection are freed implicitly 679- L2CAP: Check can send now before sending extended information requeste needed for ERTM mode 680- L2CAP: Use valid signaling identifier for L2CAP Connection Parameter Update Request 681- 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 682- RFCOMM: Avoid use-after-free on channel finalize 683- GATT Client: stop timer on disconnect - fixes use after free / crash 684 685### Added 686- A2DP Source: Support stream reconfiguration (a2dp_source_reconfigure_stream_sampling_frequency) 687- 3rd-party: yxml is used for PBAP vCard list parsing 688- cc256xC: new v1.1 init scripts 689 690--- 691 692## Changes August 2018 693 694### Added 695- PBAP: added pbap_get_phonebook_size() to get phonebook entry count 696 697### Fixed 698- GATT Server: Allow enable Notifications/Indication with Write Command. Fixes issue with some Android devices. 699- SM: fix pairing for Secure Connections with Bonding if remote sends additional keys 700- SM: drop LTK flag from Pairing Response for Secure Connections 701- L2CAP: fix emitted L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_REQUEST 702 703## Changes June 2018 704 705### Added 706- btstack_audio.h: application level API for audio playback and recording 707- embedded/hal_audio.h: low-level API for audio playback and recording 708- HID Device: hid_device_connect(..) function 709- ESP32: implement hal_audio 710- DA14585: support for Dialog Semiconductor DA14585 LE-only controller 711- Raspberry Pi 3 + Raspberry Pi Zero W port in port/raspi 712 713### Changed 714- Errata 10734: 715 - SM: Generate new EC Public Keypair after each pairing 716 - SM: Abort failure with DHKEY_CHECK_FAILED if received public key is invalid (instead of unspecified error) 717- btstack.h: only include classic headers if ENABLE_CLASSIC is defined 718- windows: ignore virtual Bluetooth adapter provided by VMware 719- Replaced HCI_PACKET_BUFFER_SIZE with HCI_INCOMING_PACKET_BUFFER_SIZE and HCI_OUTGOING_PACKET_BUFFER_SIZE 720 721--- 722 723## Changes June 2018 724 725### Fixed 726- HFP: Fix Wide Band Speech bit in SDP record for both HF/AG. Missing bit prevents macOS from using mSBC 727- ATT Server: send ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE with status ATT_HANDLE_VALUE_INDICATION_DISCONNECT on disconnect 728- AVRCP Controller: fix parsing of now playing info 729 730### Changed 731- ATT Server: ATT_HANDLE_VALUE_INDICATION_DISCONNECT is delivered to service handler if registered 732 733### Added 734- ATT Server: packet handler field added to att_service_handler_t to receive: connect/disconnect, atu exchange, indication complete 735 736--- 737 738## Changes May 2018 739 740### Added 741- GAP: re-encrypt outgoing connection if bonded 742- ATT Server: wait until re-encryption is complete 743- GATT Client: wait until re-encryption is complete 744- ATT Server: added att_server_request_to_send_notification and att_server_request_to_send_indication 745- GATT Client: if ENABLE_GATT_CLIENT_PAIRING, GATT Client starts pairing and retry operation on security error 746 747### Changed 748- ATT Server: att_server_register_can_send_now_callback is deprecated, use att_server_request_to_send_notification/indication instead 749 750### Fixed 751- SM: Fix LE Secure Connection pairing in Central role 752- le_device_db_tlv: fix seq nr management 753- SM: improve le_device_db lookup and storing of IRK 754- GATT Server: fix lookup for Client Characteristic Configuration in services with multiple Characteristics 755- RFCOMM: emit channel closed on HCI/L2CAP disconnect after sending DISC while expecting UA 756 757--- 758 759## Changes April 2018 760 761### Added 762- Crypto: btstack_crypo.h provides cryptographic functions for random data generation, AES128, EEC, CBC-MAC (Mesh) 763- SM: support pairing using Out-of-Band (OOB) data with LE Secure Connections 764- Embedded: support btstack_stdin via SEGGER RTT 765 766### Changed 767- att_db_util: added security requirement arguments to characteristic creators 768- SM: use btstack_crypto for cryptographpic functions 769- GAP: security level for Classic protocols (asides SDP) raised to 2 (encryption) 770 771### Fixed 772- HFP: fix answer call command 773- HCI: fix buffer overrun in gap_inquiry_explode 774- SDP: free service record item on sdp_unregister_service 775 776## Changes March 2018 777 778### Added 779- GAP: allow to limit number of connections in LE Peripheral role with gap_set_max_number_peripheral_connections 780- ATT Server: support for delayed ATT read response, see example/att_delayed_read_response.c 781- ATT Server: allow to specify security requirements seperately for read/writes. .h files need to be regenerated 782 783### Fixed 784- RFCOMM: fix infinite loop on L2CAP connection error (regression from 4c3eeed1) 785- HSP HS: accept incomming SCO connection 786- SM: fix iteration over LE Device DB entries for bonding and address resolving 787- SM: store pairing information only if both devices have requested bonding 788 789--- 790 791## Changes February 2018 792 793### Added 794- GATT Client: gatt_client_request_can_write_without_response_event() causes GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE 795- SM: new event SM_EVENT_PAIRING_COMPLETE 796- GAP: support iteration over stored Classic link keys: gap_link_key_iterator_init, gap_link_key_iterator_get_next, gap_link_key_iterator_done 797- GAP: add gap_delete_all_link_keys 798 799### Changed 800- GATT Client: round robin for multiple connections 801- ATT Dispatch: round robin for ATT Server & GATT Client 802- L2CAP: round robin for all L2CAP channels (fixed and dynamic) 803- btstack_link_key_db: addition functions for link key iteration 804- GAP: LE scanning enabled not reset on HCI Reset -> can be enabled before HCI Power Up 805- CSR: set all keys in psram instead of default 806 807### Fixed 808- tc3556x: fix startup after baud rate change 809 810--- 811 812## Changes January 2018 813 814### Added 815- Port for Windows with Zephyr HCI Firmware connected via serial port 816- em9304: upload patch containers during HCI bootup 817- Makefile for STM32-F4Discovery port 818- support for console out via SEGGER RTT 819- LE Data Channels example in BTstack and [iOS example on GitHub](https://github.com/bluekitchen/CBL2CAPChannel-Demo) 820- LE Streamer Client can send as fast as possbile as well 821- L2CAP: option to limit ATT MTU via l2cap_set_max_le_mtu 822 823### Changed 824- HCI: allow to set hci_set_master_slave_policy (0: try to become master, 1: accept slave) 825- GAP: gap_set_connection_parameters includes scan interval and window params 826- GATT Client: GATT_EVENT_MTU indicates max MTU 827- ATT DB Util: attribute handle is returned for new Services and Characteristics 828 829### Fixed 830- Windows: retry serial port operations if not all bytes have been read/written 831- HFP: avoid buffer overflows setting up messages 832- SBC Decoder: improved error handling for invalid SBC audio data 833- GAP: fix Connection Parameter Response in Central role 834- ATT DB Util: update pointer to database in case of realloc 835- GATT Client: set UUID16 field if 16-bit UUID is stored as UUID128 836- GAP: release HCI Connnection after gap_le_conne 837- ATT: Exchanged MTU is propagate to ATT Server and GATT Client 838 839--- 840 841## Changes December 2017 842 843### Added 844- Introduced btstack_network.h network interface abstraction 845- btstack_network_posix implementation using Linux tun/tap interface 846- WICED: support for btstack_stdin (HAVE_STDIN) 847- 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. 848- TLV: global TLV instance available via btstack_tlv_get_instance() (src/btstack_tlv.h) 849- TLV: POSIX implementation that appends to a file on disk (platform/posix/btstack_tlv_posix.c 850- LE Device DB TLV: overwrite oldest entry if no free entries available 851- SM: allow to set fixed passkey in display role using sm_use_fixed_passkey_in_display_role 852- Example/hid_host_demo with HID parser and support for basic US keyboard layout 853- 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 854- Port for Apollo2 MCU with EM9304 (ports/apollo2-em9304) 855 856### Changed 857- panu_demo: uses btstack_network.h now 858- WICED: configure printf to replace Linefeed with CRLF 859- SBC: split btstack_sbc_bludroid.c into seperate encoder and decoder implementations 860 861### Fixed 862- RFCOMM: support connection requests during connection failure 863- L2CAP: support connection requests during connection failure 864- L2CAP: fix default remote MTU as 672 instead of 48 (Minimal MTU) 865- HCI: avoid double free during halting 866- SM: fixed reconnect using legacy pairing in slave role 867 868 869