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