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