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