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