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