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