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