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