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