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