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