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