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