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### Fixed 12 13### Added 14 15### Changed 16 17## Changes Februar 2020 18 19### Fixed 20- AVRCP Target: fix reporting of PLAYBACK_STATUS_CHANGED 21 22### Changed 23- hid_host_mode: allow sniff mode 24 25## Changes January 2020 26 27### Fixed 28- L2CAP ERTM: avoid read-after-free on decline of incoming connection 29- GATT Client: set uuid16 to zero when deserializing uuid128 services, characteristics, and descriptors 30- att_db_util: fix realloc of att db buffer for large attributes 31- btstack_tlv_posix: only keep last value in memory, fix delete operation 32- l2cap_signaling: use packet boundary flags 0x00 for LE signaling packets (ignoring hci_non_flushable_packet_boundary_flag_supported()) 33 34### Added 35- att_db_util: provide GATT Database Hash via att_db_util_hash_calc 36- GATT Compiler: provide GATT Database Hash via GATT_DATABASE_HASH Characteristic 37- ATT Server: validate request pdu length 38 39### Changed 40- btstack_crypto: update AES-CMAC implementation to access all message bytes sequentially 41 42## Changes December 2019 43 44### Fixed 45- example/pan_lwip_http_server: use Network Access Point, CoD 46- sm: emit pairing complete in master role when no keys are distributed / bonding disabled 47 48### Added 49 50### Changed 51- Updated CC256x initscript: CC256xC v1.3 52- ESP32: add CMake project files 53 54## Changes November 2019 55 56### Fixed 57- AVDTP Source: return correct `avdtp_cid` and `local_seid` in `AVDTP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW` 58- L2CAP: send LE Data Channel SDUs round robin with other data 59- L2CAP ERTM: send ERTM I-frames round robin with other data 60 61### Added 62- ATT Server: return error if request to send now for Notification or Indication already registered 63- Linked List: return if item was added for `btstack_linked_list_add[_tail]` 64- btstack_run_loop_remove: return bool true if timer/data source was removed 65- segger-rtt: allow to configure with `SEGGER_RTT_PACKETLOG_*` directives, update to v6.54 66- GAP: support setting Link Supervision Timetout for outgoing Classic connections using `gap_set_link_supervision_timeout` 67- lwip: add download test files to http server demo 68 69### Changed 70- Linked List: return bool true if item was removed 71 72 73## Changes October 2019 74 75### Fixed 76 77### Added 78- `btstack_bool.h`: provide boolean type 'bool' via `<stdbool.h>` or as backport 79- provide `btstack_assert(condition)` 80- H4 Transport: avoid calling `hci_transport_h4_trigger_next_read` when transport is closed 81 82### Changed 83- libusb and posix ports: store bonding information in TLV 84 85 86## Changes September 2019 87 88### Fixed 89- L2CAP ERTM: assert that packet can be stored in fragment buffers in ertm 90- L2CAP ERTM: reject incoming connection if ERTM is configured as mandatory but not supported by remote 91- GATT Client: allow Write Without Response independent of other requests 92 93### Added 94- GAP: allow to reject GAP classic connection via gap_register_classic_connection_filter 95- GAP: support reading RSSI for Classic+LE using gap_read_rssi. Emits `GAP_EVENT_RSSI_MEASUREMENT` 96 97### Changed 98- Bluetooth and BTstack Error Codes and Events: collect status codes in bluetooth.h and events in btstack_defines.h 99- bluetooth.h: extract internal defintitions to respective protocol layers 100- Updated CC256x initscripts (CC256xB v1.8, CC256xC v1.2, CC256xC v1.2) 101 102 103## Changes August 2019 104 105### Fixed 106- POSIX, WICED, Windows, FreeRTOS run loops: handle time_ms overrun after 49 days 107- RFCOMM: accept incoming L2CAP connection in Basic mode if ERTM is enabled but not requested for this connection 108- RFCOMM: limit RFCOMM MTU by local L2CAP MTU for outgoing connections (only revelvant for ERTM) 109- L2CAP ERTM: stop timers on disconnect 110- L2CAP ERTM: fix sending of segmented SDUs 111- L2CAP ERTM: handle unsupported Information Response 112- SM: generate local nonce for confirm value in JW+NC+PK in Secure Connections Responder role 113 114### Added 115- `btstack_run_loop_base`: portable implementation of timer and data source managment as base for platform specific implementations 116 117## Changed 118- FreeRTOS: use xQueueCreateStatic (static variant of xQueueCreate) if available for static memory-only setups 119- L2CAP ERTM: handle invalid Information Response (assume no extended features supported) 120- POSIX: use monotonic clock as timebase if available 121- HCI Transport H4/H5/EM9304 SPI: ignore block read/sent from UART driver when closed 122- HCI: Read Encryption Key Size after encryption was enabled 123- Errata 11838: 124 - GAP: gap_set_required_encryption_key_size allows to set the required key size, default = 16 (max) 125 - GAP: validate encryption key size to emit GAP Security Levels 126 127## Changes July 2019 128 129### Fixed 130- SM: Fixed regression introduced in f3582630 131- L2CAP: avoid reading l2cap signaling command len out of bounds 132- HCI Transport H4/H5/EM9304 SPI: fix payload size checks (also for 8/16-bit platforms) 133 134### Changed 135- SM: Start encryption upon receiving slave securiy request if bonded 136- hci: use 2 as HCI_INCOMING_PRE_BUFFER_SIZE in LE-only configuration for GATT Client 137 138--- 139 140## Changes June 2019 141 142### Changed 143- FreeRTOS: use freertos/.. prefix to include FreeRTOS headers if HAVE_FREERTOS_INCLUDE_PREFIX is defined 144- BNEP: add Connection Handle to BNEP_EVENT_CHANNEL_OPENED 145- Examples: renamed le_counter to gatt_counter and le_streamer to le_streamer_server to indicate suppport for GATT over BR/EDR 146 147### Fixed 148- BNEP: Bluetooth address is stored in little-endian format for all BNEP_EVENT_* 149- libusb: avoid use-after-free for SCO packets on disconnect 150 151### Added 152- example: pan_lwip_http_server using lwIP as network stack to implement PAN NAP service 153- platform/lwip/bnep_lwip.c: BNEP lwIP adapter that forwards packets between BNEP service and lwIP 154- ENABLE_GATT_OVER_CLASSIC enables support for GATT over BR/EDR in att_server 155 156--- 157 158## Changes May 2019 159 160### Changed 161- ESP32: Configure SCO over HCI after power up 162- btstack_tlv_flash_bank: support targets where a value cannot be overwritten with zero. When ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 163 is defined, an explicit delete field is used to indicate an invalid entry. 164 165### Fixed 166- SM: Avoid potential use-after-free on immediate disconnect (lookup connection via con handle instead of storing pointer) 167 168### Added 169- gatt_client: emit query complete event for signed write operation 170- hci_transport_h4: add workaround for flow control bug in CYW2070x, enable with ENABLE_CYPRESS_BAUDRATE_CHANGE_FLOWCONTROL_BUG_WORKAROUND 171 172--- 173 174## Changes April 2019 175 176### Changed 177- ESP32: use micro-ecc from 3rd-party as esp-idf removed it in their 3.3 release 178 179### Fixed 180- hci: pad LE Scan response with zeroes 181- SM: store local CSRK 182- ATT DB: call write callback for validated signed writes 183- ATT Server: abort signed write validation on incoming new request 184- Bluetooth SIG web scraping tools updated 185- libusb: compiles for FreeBSD 186 187### Added 188 189--- 190 191## Changes March 2019 192 193### Changed 194- use Makefile for stm32-f4discovery-cc256x port 195- le_device_db: add secure_connection argument to le_device_db_encryption_set and le_device_db_encryption_get 196 197### Fixed 198- SM: Use provided authentication requirements in slave security request 199 200### Added 201- port/stm32-f4discovery-cc256x: add support for built-in MEMS microphone 202- SM: Track if connection encryption is based on LE Secure Connection pairing 203- ATT DB: Validate if connection encrypted is based on SC if requested 204- att_db_util: support ATT_SECURITY_AUTHENTICATED_SC permission flag 205- GATT Compiler: support READ_AUTHENTICATED and WRITE_AUTHENTICATED permsission flags 206- ESP32: erase nvs flash is newer nvs version found 207- libusb: add support for nRF52840-PCA10056 running Zephyr hci_usb example 208- port/stm32-l073rz-nucleo-em9304 for Nucleo L073RZ with EM9304 DVK, replaces port/stm32-l053r8-nucleo-em9304 209 210## Changes February 2019 211 212### Changed 213- example/a2dp_sink_demo: use linear resampling to fix sample rate drift 214- btstack_audio: split interface into sink and source 215 216### Fixed 217- Crypto: fix lockup when stack is shutdown while waiting for result of HCI Command, e.g. LE Read Local P256 Public Key 218- SM: Avoid SM_EVENT_PAIRING_COMPLETE with ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION after successful pairing in responder role 219 220### Added 221- example/a2dp_sink_demo: add target role, support volume control on both devices 222- example/audio_duplex: playback audio audio source on audio sink (test audio path) 223- btstack_audio_embedded: implement audio source path 224 225--- 226 227## Changes January 2019 228 229### Changed 230- L2CAP: provide channel mode (basic/ertm) and fcs option in L2CAP_EVENT_CHANNEL_OPENED 231- RFCOMM: support L2CAP ERTM. Callbacks passed to rfcomm_enable_l2cap_ertm() are used to manage ERTM buffers 232 233### Added 234- L2CAP: emit L2CAP_EVENT_ERTM_BUFFER_RELEASED if ERTM buffer not needed/used anymore 235- L2CAP: add fcs_option to ERTM config l2cap_ertm_config_t 236- HCI: validate advertisement data length field when generating GAP_EVENT_ADVERTISING_REPORT 237- ad_parser: validate data element length fields in ad_iterator_has_more 238- Raspberry Pi 3 A+/B+ port in port/raspi, starts without power cycle 239 240### Fixed 241- HCI: release outgoing buffer on disconnect if waiting to send another ACL fragment 242- POSIX: use correct baudrate enums for baud rates higher than 921600 (Linux) 243- Crypto: directly process queued crypto operation on HCI result 244 245--- 246 247## Changes December 2018 248 249### Added 250- SM: generate and store ER / IR keys in TLV, unless manually set by application 251- hci_dump: support PacketLogger or BlueZ format output via SEGGER RTT Channel 1 Up 252 253### Fixed 254- SM: fix internal buffer overrun during random address generation 255 256## Changes November 2018 257 258### Added 259- GAP: gap_le_connection_interval provides connection interval for conn handle 260- Nordic SPP Service Server: GATT service that emulates a serial port over BLE based on Nordic Semiconductor documentation. 261- uBlox SPP Service Server: GATT service that emulates a serial port over BLE based on uBlox documentation. 262- SM: ENABLE_LE_CENTRAL_AUTO_ENCRYPTION triggers automatic encryption on connect to bonded devices 263- SM: generate and store ER / IR keys in TLV, unless manually set by application 264 265### Fixed 266- SM: prevent random address updates if gap_random_address_set was used 267- SM: fix internal buffer overrun that can cause storing of bonding information to fail 268- SM: ignore Slave Security Request after sending own Pairing Request 269- L2CAP: fix use after free on disconnect if ERTM is enabled 270- HFP: Handle multiple commands/responses in single RFCOMM packet 271- Memory Pools: clear all buffers before use 272 273--- 274 275## Changes October 2018 276 277### Added 278- SDP Server: queue incoming connections when already connected instead of rejecting them 279- 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. 280- HIDS Device: GATT service that exposes HID reports intended for HID Devices, like keyboard and mouse. 281 282### Fixed 283- HCI: fix bug in gap_inquiry_stop that triggered additional GAP_EVENT_INQUIRY_COMPLETE instead of stopping the inquiry 284- L2CAP: fix issue with outgoing connection before read remote supported complete when other channels exist 285- L2CAP ERTM: allow SDU of szie MPS in first packet that contains L2CAP SDU Length 286- L2CAP ERTM: fix memory corruption triggered if local_mtu > mps 287- L2CAP ERTM: fix outgoing fragment management 288- HFP: decline incoming RFCOMM connection after outgoing connection was started 289- AVRCP: fix crash on disconnect of connection established by remote 290 291--- 292 293## Changes September 2018 294 295### Fixed 296- HCI: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled 297- L2CAP: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled 298- L2CAP: Evaluate 'can send now' on HCI Disconnect as ACL buffers in Bluetooth Controller have been used for the closed connection are freed implicitly 299- L2CAP: Check can send now before sending extended information requeste needed for ERTM mode 300- L2CAP: Use valid signaling identifier for L2CAP Connection Parameter Update Request 301- 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 302- RFCOMM: Avoid use-after-free on channel finalize 303- GATT Client: stop timer on disconnect - fixes use after free / crash 304 305### Added 306- A2DP Source: Support stream reconfiguration (a2dp_source_reconfigure_stream_sampling_frequency) 307- 3rd-party: yxml is used for PBAP vCard list parsing 308- cc256xC: new v1.1 init scripts 309 310--- 311 312## Changes August 2018 313 314### Added 315- PBAP: added pbap_get_phonebook_size() to get phonebook entry count 316 317### Fixed 318- GATT Server: Allow enable Notifications/Indication with Write Command. Fixes issue with some Android devices. 319- SM: fix pairing for Secure Connections with Bonding if remote sends additional keys 320- SM: drop LTK flag from Pairing Response for Secure Connections 321- L2CAP: fix emitted L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_REQUEST 322 323## Changes June 2018 324 325### Added 326- btstack_audio.h: application level API for audio playback and recording 327- embedded/hal_audio.h: low-level API for audio playback and recording 328- HID Device: hid_device_connect(..) function 329- ESP32: implement hal_audio 330- DA14585: support for Dialog Semiconductor DA14585 LE-only controller 331- Raspberry Pi 3 + Raspberry Pi Zero W port in port/raspi 332 333### Changed 334- Errata 10734: 335 - SM: Generate new EC Public Keypair after each pairing 336 - SM: Abort failure with DHKEY_CHECK_FAILED if received public key is invalid (instead of unspecified error) 337- btstack.h: only include classic headers if ENABLE_CLASSIC is defined 338- windows: ignore virtual Bluetooth adapter provided by VMware 339- Replaced HCI_PACKET_BUFFER_SIZE with HCI_INCOMING_PACKET_BUFFER_SIZE and HCI_OUTGOING_PACKET_BUFFER_SIZE 340 341--- 342 343## Changes June 2018 344 345### Fixed 346- HFP: Fix Wide Band Speech bit in SDP record for both HF/AG. Missing bit prevents macOS from using mSBC 347- ATT Server: send ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE with status ATT_HANDLE_VALUE_INDICATION_DISCONNECT on disconnect 348- AVRCP Controller: fix parsing of now playing info 349 350### Changed 351- ATT Server: ATT_HANDLE_VALUE_INDICATION_DISCONNECT is delivered to service handler if registered 352 353### Added 354- ATT Server: packet handler field added to att_service_handler_t to receive: connect/disconnect, atu exchange, indication complete 355 356--- 357 358## Changes May 2018 359 360### Added 361- GAP: re-encrypt outgoing connection if bonded 362- ATT Server: wait until re-encryption is complete 363- GATT Client: wait until re-encryption is complete 364- ATT Server: added att_server_request_to_send_notification and att_server_request_to_send_indication 365- GATT Client: if ENABLE_GATT_CLIENT_PAIRING, GATT Client starts pairing and retry operation on security error 366 367### Changed 368- ATT Server: att_server_register_can_send_now_callback is deprecated, use att_server_request_to_send_notification/indication instead 369 370### Fixed 371- SM: Fix LE Secure Connection pairing in Central role 372- le_device_db_tlv: fix seq nr management 373- SM: improve le_device_db lookup and storing of IRK 374- GATT Server: fix lookup for Client Characteristic Configuration in services with multiple Characteristics 375- RFCOMM: emit channel closed on HCI/L2CAP disconnect after sending DISC while expecting UA 376 377--- 378 379## Changes April 2018 380 381### Added 382- Crypto: btstack_crypo.h provides cryptographic functions for random data generation, AES128, EEC, CBC-MAC (Mesh) 383- SM: support pairing using Out-of-Band (OOB) data with LE Secure Connections 384- Embedded: support btstack_stdin via SEGGER RTT 385 386### Changed 387- att_db_util: added security requirement arguments to characteristic creators 388- SM: use btstack_crypto for cryptographpic functions 389- GAP: security level for Classic protocols (asides SDP) raised to 2 (encryption) 390 391### Fixed 392- HFP: fix answer call command 393- HCI: fix buffer overrun in gap_inquiry_explode 394- SDP: free service record item on sdp_unregister_service 395 396## Changes March 2018 397 398### Added 399- GAP: allow to limit number of connections in LE Peripheral role with gap_set_max_number_peripheral_connections 400- ATT Server: support for delayed ATT read response, see example/att_delayed_read_response.c 401- ATT Server: allow to specify security requirements seperately for read/writes. .h files need to be regenerated 402 403### Fixed 404- RFCOMM: fix infinite loop on L2CAP connection error (regression from 4c3eeed1) 405- HSP HS: accept incomming SCO connection 406- SM: fix iteration over LE Device DB entries for bonding and address resolving 407- SM: store pairing information only if both devices have requested bonding 408 409--- 410 411## Changes February 2018 412 413### Added 414- GATT Client: gatt_client_request_can_write_without_response_event() causes GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE 415- SM: new event SM_EVENT_PAIRING_COMPLETE 416- GAP: support iteration over stored Classic link keys: gap_link_key_iterator_init, gap_link_key_iterator_get_next, gap_link_key_iterator_done 417- GAP: add gap_delete_all_link_keys 418 419### Changed 420- GATT Client: round robin for multiple connections 421- ATT Dispatch: round robin for ATT Server & GATT Client 422- L2CAP: round robin for all L2CAP channels (fixed and dynamic) 423- btstack_link_key_db: addition functions for link key iteration 424- GAP: LE scanning enabled not reset on HCI Reset -> can be enabled before HCI Power Up 425- CSR: set all keys in psram instead of default 426 427### Fixed 428- tc3556x: fix startup after baud rate change 429 430--- 431 432## Changes January 2018 433 434### Added 435- Port for Windows with Zephyr HCI Firmware connected via serial port 436- em9304: upload patch containers during HCI bootup 437- Makefile for STM32-F4Discovery port 438- support for console out via SEGGER RTT 439- LE Data Channels example in BTstack and [iOS example on GitHub](https://github.com/bluekitchen/CBL2CAPChannel-Demo) 440- LE Streamer Client can send as fast as possbile as well 441- L2CAP: option to limit ATT MTU via l2cap_set_max_le_mtu 442 443### Changed 444- HCI: allow to set hci_set_master_slave_policy (0: try to become master, 1: accept slave) 445- GAP: gap_set_connection_parameters includes scan interval and window params 446- GATT Client: GATT_EVENT_MTU indicates max MTU 447- ATT DB Util: attribute handle is returned for new Services and Characteristics 448 449### Fixed 450- Windows: retry serial port operations if not all bytes have been read/written 451- HFP: avoid buffer overflows setting up messages 452- SBC Decoder: improved error handling for invalid SBC audio data 453- GAP: fix Connection Parameter Response in Central role 454- ATT DB Util: update pointer to database in case of realloc 455- GATT Client: set UUID16 field if 16-bit UUID is stored as UUID128 456- GAP: release HCI Connnection after gap_le_conne 457- ATT: Exchanged MTU is propagate to ATT Server and GATT Client 458 459--- 460 461## Changes December 2017 462 463### Added 464- Introduced btstack_network.h network interface abstraction 465- btstack_network_posix implementation using Linux tun/tap interface 466- WICED: support for btstack_stdin (HAVE_STDIN) 467- 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. 468- TLV: global TLV instance available via btstack_tlv_get_instance() (src/btstack_tlv.h) 469- TLV: POSIX implementation that appends to a file on disk (platform/posix/btstack_tlv_posix.c 470- LE Device DB TLV: overwrite oldest entry if no free entries available 471- SM: allow to set fixed passkey in display role using sm_use_fixed_passkey_in_display_role 472- Example/hid_host_demo with HID parser and support for basic US keyboard layout 473- 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 474- Port for Apollo2 MCU with EM9304 (ports/apollo2-em9304) 475 476### Changed 477- panu_demo: uses btstack_network.h now 478- WICED: configure printf to replace Linefeed with CRLF 479- SBC: split btstack_sbc_bludroid.c into seperate encoder and decoder implementations 480 481### Fixed 482- RFCOMM: support connection requests during connection failure 483- L2CAP: support connection requests during connection failure 484- L2CAP: fix default remote MTU as 672 instead of 48 (Minimal MTU) 485- HCI: avoid double free during halting 486- SM: fixed reconnect using legacy pairing in slave role 487 488 489