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