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