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--- 8 9## [Unreleased] 10 11### Fixed 12- L2CAP ERTM: assert that packet can be stored in fragment buffers in ertm 13- L2CAP ERTM: reject incoming connection if ERTM is configured as mandatory but not supported by remote 14- L2CAP ERTM: send ERTM I-frames round robin with other data 15- L2CAP: send le data channel sdus round robin with other data 16- GATT Client: allow Write Without Response independent of other requests 17 18### Added 19- GAP: allow to reject GAP classic connection via gap_register_classic_connection_filter 20- GAP: support reading RSSI for Classic+LE using gap_read_rssi. Emits GAP_EVENT_RSSI_MEASUREMENT 21- GAP: support setting Link Supervision Timetout for outgoing Classic connections using gap_set_link_supervision_timeout 22- Linked List: return if item was added for `btstack_linked_list_add[_tail]` 23 24## Changed 25- Bluetooth and BTstack Error Codes and Events: collect status codes in bluetooth.h and events in btstack_defines.h 26- bluetooth.h: extract internal defintitions to respective protocol layers 27- Updated CC256x initscripts (CC256xB v1.8, CC256xC v1.2) 28- libusb and posix ports: store bonding information in TLV 29- Linked List: return bool true if item was removed 30- btstack_run_loop_remove: return bool true if timer/data source was removed 31 32## Changes August 2019 33 34### Fixed 35- POSIX, WICED, Windows, FreeRTOS run loops: handle time_ms overrun after 49 days 36- RFCOMM: accept incoming L2CAP connection in Basic mode if ERTM is enabled but not requested for this connection 37- RFCOMM: limit RFCOMM MTU by local L2CAP MTU for outgoing connections (only revelvant for ERTM) 38- L2CAP ERTM: stop timers on disconnect 39- L2CAP ERTM: fix sending of segmented SDUs 40- L2CAP ERTM: handle unsupported Information Response 41- SM: generate local nonce for confirm value in JW+NC+PK in Secure Connections Responder role 42 43### Added 44- btstack_run_loop_base: portable implementation of timer and data source managment as base for platform specific implementations 45 46## Changed 47- FreeRTOS: use xQueueCreateStatic (static variant of xQueueCreate) if available for static memory-only setups 48- L2CAP ERTM: handle invalid Information Response (assume no extended features supported) 49- POSIX: use monotonic clock as timebase if available 50- HCI Transport H4/H5/EM9304 SPI: ignore block read/sent from UART driver when closed 51- HCI: Read Encryption Key Size after encryption was enabled 52- Errata 11838: 53 - GAP: gap_set_required_encryption_key_size allows to set the required key size, default = 16 (max) 54 - GAP: validate encryption key size to emit GAP Security Levels 55 56## Changes July 2019 57 58### Fixed 59- SM: Fixed regression introduced in f3582630 60- L2CAP: avoid reading l2cap signaling command len out of bounds 61- HCI Transport H4/H5/EM9304 SPI: fix payload size checks (also for 8/16-bit platforms) 62 63### Changed 64- SM: Start encryption upon receiving slave securiy request if bonded 65- hci: use 2 as HCI_INCOMING_PRE_BUFFER_SIZE in LE-only configuration for GATT Client 66 67--- 68 69## Changes June 2019 70 71### Changed 72- FreeRTOS: use freertos/.. prefix to include FreeRTOS headers if HAVE_FREERTOS_INCLUDE_PREFIX is defined 73- BNEP: add Connection Handle to BNEP_EVENT_CHANNEL_OPENED 74- Examples: renamed le_counter to gatt_counter and le_streamer to le_streamer_server to indicate suppport for GATT over BR/EDR 75 76### Fixed 77- BNEP: Bluetooth address is stored in little-endian format for all BNEP_EVENT_* 78- libusb: avoid use-after-free for SCO packets on disconnect 79 80### Added 81- example: pan_lwip_http_server using lwIP as network stack to implement PAN NAP service 82- platform/lwip/bnep_lwip.c: BNEP lwIP adapter that forwards packets between BNEP service and lwIP 83- ENABLE_GATT_OVER_CLASSIC enables support for GATT over BR/EDR in att_server 84 85--- 86 87## Changes May 2019 88 89### Changed 90- ESP32: Configure SCO over HCI after power up 91- btstack_tlv_flash_bank: support targets where a value cannot be overwritten with zero. When ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 92 is defined, an explicit delete field is used to indicate an invalid entry. 93 94### Fixed 95- SM: Avoid potential use-after-free on immediate disconnect (lookup connection via con handle instead of storing pointer) 96 97### Added 98- gatt_client: emit query complete event for signed write operation 99- hci_transport_h4: add workaround for flow control bug in CYW2070x, enable with ENABLE_CYPRESS_BAUDRATE_CHANGE_FLOWCONTROL_BUG_WORKAROUND 100 101--- 102 103## Changes April 2019 104 105### Changed 106- ESP32: use micro-ecc from 3rd-party as esp-idf removed it in their 3.3 release 107 108### Fixed 109- hci: pad LE Scan response with zeroes 110- SM: store local CSRK 111- ATT DB: call write callback for validated signed writes 112- ATT Server: abort signed write validation on incoming new request 113- Bluetooth SIG web scraping tools updated 114- libusb: compiles for FreeBSD 115 116### Added 117 118--- 119 120## Changes March 2019 121 122### Changed 123- use Makefile for stm32-f4discovery-cc256x port 124- le_device_db: add secure_connection argument to le_device_db_encryption_set and le_device_db_encryption_get 125 126### Fixed 127- SM: Use provided authentication requirements in slave security request 128 129### Added 130- port/stm32-f4discovery-cc256x: add support for built-in MEMS microphone 131- SM: Track if connection encryption is based on LE Secure Connection pairing 132- ATT DB: Validate if connection encrypted is based on SC if requested 133- att_db_util: support ATT_SECURITY_AUTHENTICATED_SC permission flag 134- GATT Compiler: support READ_AUTHENTICATED and WRITE_AUTHENTICATED permsission flags 135- ESP32: erase nvs flash is newer nvs version found 136- libusb: add support for nRF52840-PCA10056 running Zephyr hci_usb example 137- port/stm32-l073rz-nucleo-em9304 for Nucleo L073RZ with EM9304 DVK, replaces port/stm32-l053r8-nucleo-em9304 138 139## Changes February 2019 140 141### Changed 142- example/a2dp_sink_demo: use linear resampling to fix sample rate drift 143- btstack_audio: split interface into sink and source 144 145### Fixed 146- Crypto: fix lockup when stack is shutdown while waiting for result of HCI Command, e.g. LE Read Local P256 Public Key 147- SM: Avoid SM_EVENT_PAIRING_COMPLETE with ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION after successful pairing in responder role 148 149### Added 150- example/a2dp_sink_demo: add target role, support volume control on both devices 151- example/audio_duplex: playback audio audio source on audio sink (test audio path) 152- btstack_audio_embedded: implement audio source path 153 154--- 155 156## Changes January 2019 157 158### Changed 159- L2CAP: provide channel mode (basic/ertm) and fcs option in L2CAP_EVENT_CHANNEL_OPENED 160- RFCOMM: support L2CAP ERTM. Callbacks passed to rfcomm_enable_l2cap_ertm() are used to manage ERTM buffers 161 162### Added 163- L2CAP: emit L2CAP_EVENT_ERTM_BUFFER_RELEASED if ERTM buffer not needed/used anymore 164- L2CAP: add fcs_option to ERTM config l2cap_ertm_config_t 165- HCI: validate advertisement data length field when generating GAP_EVENT_ADVERTISING_REPORT 166- ad_parser: validate data element length fields in ad_iterator_has_more 167- Raspberry Pi 3 A+/B+ port in port/raspi, starts without power cycle 168 169### Fixed 170- HCI: release outgoing buffer on disconnect if waiting to send another ACL fragment 171- POSIX: use correct baudrate enums for baud rates higher than 921600 (Linux) 172- Crypto: directly process queued crypto operation on HCI result 173 174--- 175 176## Changes December 2018 177 178### Added 179- SM: generate and store ER / IR keys in TLV, unless manually set by application 180- hci_dump: support PacketLogger or BlueZ format output via SEGGER RTT Channel 1 Up 181 182### Fixed 183- SM: fix internal buffer overrun during random address generation 184 185## Changes November 2018 186 187### Added 188- GAP: gap_le_connection_interval provides connection interval for conn handle 189- Nordic SPP Service Server: GATT service that emulates a serial port over BLE based on Nordic Semiconductor documentation. 190- uBlox SPP Service Server: GATT service that emulates a serial port over BLE based on uBlox documentation. 191- SM: ENABLE_LE_CENTRAL_AUTO_ENCRYPTION triggers automatic encryption on connect to bonded devices 192- SM: generate and store ER / IR keys in TLV, unless manually set by application 193 194### Fixed 195- SM: prevent random address updates if gap_random_address_set was used 196- SM: fix internal buffer overrun that can cause storing of bonding information to fail 197- SM: ignore Slave Security Request after sending own Pairing Request 198- L2CAP: fix use after free on disconnect if ERTM is enabled 199- HFP: Handle multiple commands/responses in single RFCOMM packet 200- Memory Pools: clear all buffers before use 201 202--- 203 204## Changes October 2018 205 206### Added 207- SDP Server: queue incoming connections when already connected instead of rejecting them 208- 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. 209- HIDS Device: GATT service that exposes HID reports intended for HID Devices, like keyboard and mouse. 210 211### Fixed 212- HCI: fix bug in gap_inquiry_stop that triggered additional GAP_EVENT_INQUIRY_COMPLETE instead of stopping the inquiry 213- L2CAP: fix issue with outgoing connection before read remote supported complete when other channels exist 214- L2CAP ERTM: allow SDU of szie MPS in first packet that contains L2CAP SDU Length 215- L2CAP ERTM: fix memory corruption triggered if local_mtu > mps 216- L2CAP ERTM: fix outgoing fragment management 217- HFP: decline incoming RFCOMM connection after outgoing connection was started 218- AVRCP: fix crash on disconnect of connection established by remote 219 220--- 221 222## Changes September 2018 223 224### Fixed 225- HCI: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled 226- L2CAP: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled 227- L2CAP: Evaluate 'can send now' on HCI Disconnect as ACL buffers in Bluetooth Controller have been used for the closed connection are freed implicitly 228- L2CAP: Check can send now before sending extended information requeste needed for ERTM mode 229- L2CAP: Use valid signaling identifier for L2CAP Connection Parameter Update Request 230- 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 231- RFCOMM: Avoid use-after-free on channel finalize 232- GATT Client: stop timer on disconnect - fixes use after free / crash 233 234### Added 235- A2DP Source: Support stream reconfiguration (a2dp_source_reconfigure_stream_sampling_frequency) 236- 3rd-party: yxml is used for PBAP vCard list parsing 237- cc256xC: new v1.1 init scripts 238 239--- 240 241## Changes August 2018 242 243### Added 244- PBAP: added pbap_get_phonebook_size() to get phonebook entry count 245 246### Fixed 247- GATT Server: Allow enable Notifications/Indication with Write Command. Fixes issue with some Android devices. 248- SM: fix pairing for Secure Connections with Bonding if remote sends additional keys 249- SM: drop LTK flag from Pairing Response for Secure Connections 250- L2CAP: fix emitted L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_REQUEST 251 252## Changes June 2018 253 254### Added 255- btstack_audio.h: application level API for audio playback and recording 256- embedded/hal_audio.h: low-level API for audio playback and recording 257- HID Device: hid_device_connect(..) function 258- ESP32: implement hal_audio 259- DA14585: support for Dialog Semiconductor DA14585 LE-only controller 260- Raspberry Pi 3 + Raspberry Pi Zero W port in port/raspi 261 262### Changed 263- Errata 10734: 264 - SM: Generate new EC Public Keypair after each pairing 265 - SM: Abort failure with DHKEY_CHECK_FAILED if received public key is invalid (instead of unspecified error) 266- btstack.h: only include classic headers if ENABLE_CLASSIC is defined 267- windows: ignore virtual Bluetooth adapter provided by VMware 268- Replaced HCI_PACKET_BUFFER_SIZE with HCI_INCOMING_PACKET_BUFFER_SIZE and HCI_OUTGOING_PACKET_BUFFER_SIZE 269 270--- 271 272## Changes June 2018 273 274### Fixed 275- HFP: Fix Wide Band Speech bit in SDP record for both HF/AG. Missing bit prevents macOS from using mSBC 276- ATT Server: send ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE with status ATT_HANDLE_VALUE_INDICATION_DISCONNECT on disconnect 277- AVRCP Controller: fix parsing of now playing info 278 279### Changed 280- ATT Server: ATT_HANDLE_VALUE_INDICATION_DISCONNECT is delivered to service handler if registered 281 282### Added 283- ATT Server: packet handler field added to att_service_handler_t to receive: connect/disconnect, atu exchange, indication complete 284 285--- 286 287## Changes May 2018 288 289### Added 290- GAP: re-encrypt outgoing connection if bonded 291- ATT Server: wait until re-encryption is complete 292- GATT Client: wait until re-encryption is complete 293- ATT Server: added att_server_request_to_send_notification and att_server_request_to_send_indication 294- GATT Client: if ENABLE_GATT_CLIENT_PAIRING, GATT Client starts pairing and retry operation on security error 295 296### Changed 297- ATT Server: att_server_register_can_send_now_callback is deprecated, use att_server_request_to_send_notification/indication instead 298 299### Fixed 300- SM: Fix LE Secure Connection pairing in Central role 301- le_device_db_tlv: fix seq nr management 302- SM: improve le_device_db lookup and storing of IRK 303- GATT Server: fix lookup for Client Characteristic Configuration in services with multiple Characteristics 304- RFCOMM: emit channel closed on HCI/L2CAP disconnect after sending DISC while expecting UA 305 306--- 307 308## Changes April 2018 309 310### Added 311- Crypto: btstack_crypo.h provides cryptographic functions for random data generation, AES128, EEC, CBC-MAC (Mesh) 312- SM: support pairing using Out-of-Band (OOB) data with LE Secure Connections 313- Embedded: support btstack_stdin via SEGGER RTT 314 315### Changed 316- att_db_util: added security requirement arguments to characteristic creators 317- SM: use btstack_crypto for cryptographpic functions 318- GAP: security level for Classic protocols (asides SDP) raised to 2 (encryption) 319 320### Fixed 321- HFP: fix answer call command 322- HCI: fix buffer overrun in gap_inquiry_explode 323- SDP: free service record item on sdp_unregister_service 324 325## Changes March 2018 326 327### Added 328- GAP: allow to limit number of connections in LE Peripheral role with gap_set_max_number_peripheral_connections 329- ATT Server: support for delayed ATT read response, see example/att_delayed_read_response.c 330- ATT Server: allow to specify security requirements seperately for read/writes. .h files need to be regenerated 331 332### Fixed 333- RFCOMM: fix infinite loop on L2CAP connection error (regression from 4c3eeed1) 334- HSP HS: accept incomming SCO connection 335- SM: fix iteration over LE Device DB entries for bonding and address resolving 336- SM: store pairing information only if both devices have requested bonding 337 338--- 339 340## Changes February 2018 341 342### Added 343- GATT Client: gatt_client_request_can_write_without_response_event() causes GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE 344- SM: new event SM_EVENT_PAIRING_COMPLETE 345- GAP: support iteration over stored Classic link keys: gap_link_key_iterator_init, gap_link_key_iterator_get_next, gap_link_key_iterator_done 346- GAP: add gap_delete_all_link_keys 347 348### Changed 349- GATT Client: round robin for multiple connections 350- ATT Dispatch: round robin for ATT Server & GATT Client 351- L2CAP: round robin for all L2CAP channels (fixed and dynamic) 352- btstack_link_key_db: addition functions for link key iteration 353- GAP: LE scanning enabled not reset on HCI Reset -> can be enabled before HCI Power Up 354- CSR: set all keys in psram instead of default 355 356### Fixed 357- tc3556x: fix startup after baud rate change 358 359--- 360 361## Changes January 2018 362 363### Added 364- Port for Windows with Zephyr HCI Firmware connected via serial port 365- em9304: upload patch containers during HCI bootup 366- Makefile for STM32-F4Discovery port 367- support for console out via SEGGER RTT 368- LE Data Channels example in BTstack and [iOS example on GitHub](https://github.com/bluekitchen/CBL2CAPChannel-Demo) 369- LE Streamer Client can send as fast as possbile as well 370- L2CAP: option to limit ATT MTU via l2cap_set_max_le_mtu 371 372### Changed 373- HCI: allow to set hci_set_master_slave_policy (0: try to become master, 1: accept slave) 374- GAP: gap_set_connection_parameters includes scan interval and window params 375- GATT Client: GATT_EVENT_MTU indicates max MTU 376- ATT DB Util: attribute handle is returned for new Services and Characteristics 377 378### Fixed 379- Windows: retry serial port operations if not all bytes have been read/written 380- HFP: avoid buffer overflows setting up messages 381- SBC Decoder: improved error handling for invalid SBC audio data 382- GAP: fix Connection Parameter Response in Central role 383- ATT DB Util: update pointer to database in case of realloc 384- GATT Client: set UUID16 field if 16-bit UUID is stored as UUID128 385- GAP: release HCI Connnection after gap_le_conne 386- ATT: Exchanged MTU is propagate to ATT Server and GATT Client 387 388--- 389 390## Changes December 2017 391 392### Added 393- Introduced btstack_network.h network interface abstraction 394- btstack_network_posix implementation using Linux tun/tap interface 395- WICED: support for btstack_stdin (HAVE_STDIN) 396- 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. 397- TLV: global TLV instance available via btstack_tlv_get_instance() (src/btstack_tlv.h) 398- TLV: POSIX implementation that appends to a file on disk (platform/posix/btstack_tlv_posix.c 399- LE Device DB TLV: overwrite oldest entry if no free entries available 400- SM: allow to set fixed passkey in display role using sm_use_fixed_passkey_in_display_role 401- Example/hid_host_demo with HID parser and support for basic US keyboard layout 402- 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 403- Port for Apollo2 MCU with EM9304 (ports/apollo2-em9304) 404 405### Changed 406- panu_demo: uses btstack_network.h now 407- WICED: configure printf to replace Linefeed with CRLF 408- SBC: split btstack_sbc_bludroid.c into seperate encoder and decoder implementations 409 410### Fixed 411- RFCOMM: support connection requests during connection failure 412- L2CAP: support connection requests during connection failure 413- L2CAP: fix default remote MTU as 672 instead of 48 (Minimal MTU) 414- HCI: avoid double free during halting 415- SM: fixed reconnect using legacy pairing in slave role 416 417 418