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