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