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