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