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