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