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