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### Added 12HCI: `btstack_transport_sco.h` allows to support SCO over physical PCM/I2S interface (`HAVE_SCO_TRANSPORT`) 13POSIX: `btstack_transport_sco_i2s_test_bridge.c` implements SCO transport interface for UART-to-I2S test bridge 14btstack_uart: `btstack_uart_t` interface extends `btstack_uart_block_t`: 15 - supports sending and receiving SLIP frames for HCI H5 16 - suppports odd parity as well 17 - `hci_transport_h4` and chipset drivers have new functions to pass provide `btstack_uart_t` 18 19btstack_uart_slip_wrapper: wrapper that implements SLIP functionality for existing `btstack_uart_block` drivers. 20hci_transport: add parity field and pass on to `btstack_uart_t` in h4 and h5 21GATT Client: Battery Service Client 22GATT Client: Device Information Service Client 23GATT Client: Scan Parameters Service Client 24GAP: add `gap_set_page_scan_activity` and `gap_set_page_scan_type` 25AVRCP: new field `button_pressed` in `AVRCP_SUBEVENT_OPERATION` 26AVRCP: `AVRCP_SUBEVENT_OPERATION` emitted for button release 27AVRCP Controller: avrcp_controller_start_press_and_hold_cmd helps to support device buttons 28AVDTP: `avdtp_register_media_config_validator` allows to validate media codec configuration 29A2DP Source: `ENABLE_A2DP_SOURCE_EXPLICIT_CONFIG` disables auto config. Requires call to `a2dp_source_set_config_{CODEC}' 30 31### Fixed 32HCI: handle start inquiry failure 33AVRCP Target: fix notification changed event 34HFP: Emit Audio Connection Released on SLC Release, e.g. remote power off 35GAP: calculate IO Cap AuthReq Bondable Mode based on `gap_ssp_set_authentication_requirement` and `gap_set_bondable_mode` 36GAP: only store link key for ssp if remote side has set bondable in io cap auth requirements as well 37 38### Changed 39HCI: config I2S for BCM Controllers if `ENABLE_SCO_OVER_PCM`, reduce bit clock to 256/512 kHz 40btstack_uart_posix: supports SLIP frames and replaces `btstack_uart_block_posix` 41hci_transport_h5: new more performant H5 implementation that requires `btstack_uart_t` driver with SLIP support. 42POSIX Ports: use new `btstack_uart_posix` implementation 43posix-h5/posix-h5-bcm: use even parity for UART 44Port Archive: moved ports that are not recommended for new designs to port/archive folder: 45 - MSP430: the ports used the older community GCC version without 20-bit support needed for code size > 64kB 46 - Broadcom/Cypress H5: uploading PatchRAM is only possible in H4 mode. It's better to also use H4 in general 47 - PIC32-Harmony: the port used Harmony v1 while Harmony v3 has been out since a while. 48Run Loop Base: functionality used in most platform run loop implementations 49 - code from `btstack_run_loop_base.c` moved into `btstack_run_loop.c` to minimize changes to build systems 50 - `btstack_run_loop_base.c` is a placeholder and can be removed from build 51HCI Dump: replace monolithic `hci_dump.c` (with many #ifdefs) into dispatcher with platform-specific implementations: 52 - `posix/hci_dump_posix_fs` - writes binary log file 53 - `posix/hci_dump_stdout` - log to console using printf with local system time 54 - `embedded/hci_dump_embedded_stdout` - log to console using printf 55 - `embedded/hci_dump_segger_stdout` - log to RTT console using `SEGGER_printf` 56 - `embedded/hci_dump_segger_binary` - writes binary log over RTT to host 57Nordic SPP Service Server: use `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` and `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` 58 events instead of callback, and `RFCOMM_DATA_PACKET` for received data 59u-blox SPP Service Server: use `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` and `GATTSERVICE_SUBEVENT_SPP_SERVICE_CONNECTED` 60 events instead of callback, and `RFCOMM_DATA_PACKET` for received data 61HSP AG: emit HSP_SUBEVENT_BUTTON_PRESSED instead of audio connection setup/release 62Examples: use `btstack_event.h` getters instead of direct array access, use enum to compare status codes 63 64## Release v1.3.2 65 66### Added 67GAP: support for Classic Out-of-Band (OOB) pairing via `gap_ssp_remote_oob_data` with `ENABLE_CLASSIC_OOB_PAIRING` 68GAP: read local OOB data on start and on call to `gap_ssp_generate_oob_data`, provided via `GAP_EVENT_LOCAL_OOB_DATA` 69HID Host: add profile, update `hid_host_demo.c` example 70 71### Fixed 72L2CAP: make handling of HCI disconnect more robust 73AVDTP: emit stream release for active stream if signaling connection is closed first, e.g. caused by HCI disconnect 74AVRCP: fix issue when Controller and Target send at the same time 75 76### Changed 77A2DP, AVDTP: use `a2dp_source_set_config_{TYPE}` and `avdtp_config{TYPE}_store` to avoid large number of parameters 78 79 80## Release v1.3 81 82### Added 83CC256x: with ENABLE_CC256X_ASSISTED_HFP, HFP enables WBS codec on demand and configures PCM/I2S interface for 8kH/16kHz 84BCM: with ENABLE_BCM_PCM_WBS, HFP enables WBS codec on demand and configures PCM/I2S interface for 8kH/16kHz 85SDP Client RFCOMM: add `sdp_client_query_rfcomm_channel_and_name_for_service_class_uuid` 86HFP: `ENABLE_HFP_AT_MESSAGES` lets HFP emit `HFP_SUBEVENT_AT_MESSAGE_SENT` and `HFP_SUBEVENT_AT_MESSAGE_RECEIVED` 87A2DP, AVDTP: provide capabilities and configuration events for A2DP codecs: SBC, MPEG Audio, MPEG AAC, ATRAC 88A2DP + AVDTP Source: allow to send media packet with `avdtp_source_stream_send_media_packet` and `a2dp_source_stream_send_media_packet` 89A2DP + AVDTP Source: add `avdtp_source_stream_send_media_payload_rtp` and `a2dp_source_stream_send_media_payload_rtp` 90A2DP Source: emit `A2DP_SUBEVENT_SIGNALING_CAPABILITIES_COMPLETE` 91A2DP Source: allow to configure endpoints by calling `a2dp_source_set_config_{TYPE}` during SEP discovery with SBC fallback 92 93### Fixed 94HCI: keep `le connecting request` on connection complete active, fixes gap_auto_connection_stop() + gap_auto_connection_start() 95L2CAP: fix packet size check for incoming classic basic channels (regression introduced in v1.2.1) 96HFP AG/HSP AG: avoid connecting to remote service with same role 97A2DP Source: support multiple Stream Endpoints with different Media Codec types 98A2DP Source: emit codec configure event with reconfigure flag set on reconfigure 99GATT Compiler: support multiple instances of the same service 100 101### Changed 102GAP: provide Link Type parameter to incoming connection filter for `gap_register_classic_connection_filter` 103HFP/GOEP Client/AVDTP/A2DP: return `SDP_SERVICE_NOT_FOUND` if no suitable SDP record is found 104AVDTP Source: `avdtp_source_stream_send_media_payload` includes SBC Header and was deprecated 105AVDTP/A2DP: use `avdtp_channel_mode_t` in `A2DP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION` 106A2DP: fix events and use `a2dp_cid`, `local_seid,` `remote_seid` field names in A2DP sub-events 107GATT Client: Skip MTU exchange after MTU exchange on ATT Server 108Ports: STM32-F103RB Nucleo + CC256x port removed 109ESP32: enabled HFP Wide-Band Speech, disable classic secure connections in HSP/HFP demos 110 111 112## Release v1.2.1 113 114### Fixed 115- L2CAP: use connection handle for channel lookups 116- L2CAP: forward data only in open state 117 118### Changed 119- L2CAP: check packet size against local mtu for classic basic channels 120 121 122## Release v1.2 123 124### Fixed 125- L2CAP: trigger pairing for outgoing LE Data Channels if security level insufficient 126- SM: fix update of sc flag for re-encrypted connection in peripheral role 127- SM: send security request on re-connect if bonded and `ENABLE_LE_PROACTIVE_AUTHENTICATION` is defined 128- ESP32: fix audio sink driver 129 130### Added 131- GAP: `gap_delete_bonding` removes device from LE Resolving List and from discards LE bonding information 132- GATT Client: delete bonding information if re-encryption fails and `ENABLE_LE_PROACTIVE_AUTHENTICATION` is not defined 133- GATT Client: gatt_client_set_required_security_level() allows to set required minimum security level for all GATT requests 134- SM: emit events for re-encryption started/complete when bonding information is available 135 136### Changed 137- AVRCP Controller: allow to send multiple absolute volume commands without waiting for response. 138- GAP: replaced `ENABLE_LE_CENTRAL_AUTO_ENCRYPION` with `ENABLE_LE_PROACTIVE_AUTHENTICATION` 139 140 141## Changes October 2020 142 143### Fixed 144- AVDTP Initiator: avoid use of remote seid for stream endpoint lookup, fixes issue with two connected devices 145- AVDTP Source: buffer for SBC media codec information got discarded, leading to invalid Set Configuration command in second connection 146- SM: only trigger Cross-Transport Key Derivation (CTKD) when bonding is enabled 147- SM: set LinkKey flag to request CTKD if enabled 148- SM: store CTKD key with Public Identity Address 149- SM: only allow CTKD to overwrite existing link key if derived key has same or higher authentication 150- SM: start SMP Timeout when sending Security Request 151- HFP HF: fix response to AG Codec Selection while waiting for OK of parallel command 152- HCI: fix reject of LE remote connection param request via HCI 153 154### Added 155- GAP: add `gap_get_link_key_for_bd_addr` 156- GAP: add `gap_bonded` to check if bonding information is available for active connection 157- SM: support h7 for CTKD 158 159### Changed 160- SM: Cross-Transport Key Derivation requires `ENABLE_CROSS_TRANSPORT_KEY_DERIVATION` now 161- SM: block connection if encryption fails for bonded devices as Central 162- SM: support pairing as Central after failed re-ecnryption 163 164 165## Release v1.1 166 167### Fixed 168- AVRCP/AVCTP: report AVRCP 1.6 and AVCTP 1.4 in SDP record 169 170### Added 171 172### Changed 173 174 175## Changes September 2020 176 177### Fixed 178- HFP: fix parsing of ranges e.g. in +CIND responses 179- AVDTP, AVRCP: fix bugs due to transaction id overrun 180- A2DP Source: fix issues with stream configuration by sink 181- hci_dump: fix tv_us calculation for non-posix / embedded systems with binary output 182 183### Added 184- `btstack_ring_buffer`: add `btstack_ring_buffer_reset` to reset it to initial state/empty 185- GAP: Support for address resolution of resolvable private addresses by Controller with `ENABLE_LE_PRIVACY_ADDRESS_RESOLUTION` 186 187### Changed 188- AVDTP, AVRCP, HSP: schedule SDP query, avoids avoids 'command disallowed' if SDP client is busy 189- HSP, HFP: allow to configure usable SCO packet types 190- cc256x: update CC256xC init script to v1.4 191- A2DP Source: use Get All Capabilities if supported by remote get Delay Reporting capability 192 193## Changes August 2020 194 195### Fixed 196- ESP32: fix authentication for incoming Secure Connections 197- AVDTP: Fix forwarding of Delay reports 198- STM32-F4Discovery: fix pan_lwip_http_server by increasing HCI_ACL_PAYLOAD_SIZE 199- tool/create_packet_log: basic support for 16-bit Unicode log files from Windows 200 201### Added 202- `btstack_run_loop_base`: added `btstack_run_loop_base_dump_timer` 203- GAP: request role change for classic connection via `gap_request_role` 204- GAP: LE Whitelist API with `gap_le_whitelist_x` with x = add, remove, clear and new `gap_connect_with_whitelist` 205- SDP Client: add sdp_client_register_query_callback() allows to register query request instead of polling sdp_client_ready() 206- BNEP lwIP: add `bnep_lwip_connect` to establish BNEP connection and manage lwIP network interface 207- New `btstack_linked_queue` utility, a linked list-based queue with first-in-first-out semantics and constant time enqueue/dequeue operations 208- btstack_tlv_posix: add `btstack_tlv_posix_deinit` 209- New `btpclient` for use with [auto-pts project](https://github.com/intel/auto-pts) 210 211### Changed 212- GAP: treat AES-CCM encrypted connection as mutually authenticated (BIAS) 213- GAP: 'gap_auto_connect_x' API deprecated. Please direclty manage LE Whitelist with `gap_le_whitelist_*` functions and call `gap_connect_with_whitelist` instead 214- example/hid_host_demo: try to become master for incoming connections 215- btstack_run_loop: use btstack_assert instead of local while(true) 216- att_db_util: allow to reset att_db via `att_db_util_init` 217 218## Changes July 2020 219 220### Fixed 221- AVDTP: fix invalid response for Get Capabilities request if Delay Reporting was supported 222- AVDTP: handle concurrent signaling establishment with reject and retry 223 224### Added 225- example/hid_host_demo: support reconnect from HID device 226- Crypto: support software AES128 for AES-CCM operations 227- AVRCP: introduced AVRCP_FEATURE_MASK_* as alternative to avrcp_controller_supported_feature_t and avrcp_target_supported_feature_t enums 228- btstack_audio: add set_volume() to sink and set_gain() to source interfaces, minimal volume control for portaudio playback 229- AVDTP: renamed definition of supported features from AVDTP_SOURCE_SF_ and AVDTP_SINK_SF_ to AVDTP_SOURCE_FEATURE_MASK_ and AVDTP_SINK_FEATURE_MASK_ respectively 230- GAP: Provide gap_get_role to query master/slave role for HCI connection handle 231- GAP: Provide gap_pin_code_response_binary to use binary data as PIN, e.g. for pairing with Nintendo Wii Remote 232 233### Changed 234- GAP: set minimum required encryption key size for Classic connections back from 16 to 7, matching the Core spec 235 236 237## Changes June 2020 238 239### Fixed 240- HFP: Fix parsing of empty fields, e.g. phone number in +CLCC and other AT commands 241- SM: Fix validation of confirm value for secure connection Passkey entry 242- AVRCP: handle concurrent signaling establishment with reject and retry 243 244### Added 245- GAP: Detect Secure Connection -> Legacy Connection Downgrade Attack by remote features and actual encryption type (BIAS) 246- GAP: Mutual authentication: request authentication after Classic connection got encrypted (BIAS) 247- Windows port for Dialog DA14585 connected via serial port 248 249## Changes 250- CVSD PLC: treat zero frames as good and allow to mark data as bad, e.g. if reported by Controller as erroneous 251 252## Changes May 2020 253 254### Fixed 255- hfp_hf, hsp_hs: use eSCO params in accept sco connection only for incoming eSCO connections 256- pbap_client: fix PBAP UUID len on connect message 257- SM: fix secure connection pairing as peripheral when local user confirmation happens after remote one 258- A2DP Source: only connect to remote sink stream endpoints 259- btstack_hal_flash_memory: fix write of 0xff bytes to simulated flash 260- hsp_hs: fix disconnect if audio not connected 261- hsp_ag: fix accept incoming connection 262 263### Added 264- example/le_mitm: MITM implementation that forwards ATT PDUs and allows for pairing 265- GAP: gap_set_security_level sets required security level for incoming and outgoing connections 266- cc256x: allow to specify power vector for each modulation type 267- FreeRTOS: btstack_run_loop_freertos_trigger_exit allows to request run loop exit 268- SM: support LE Secure Connections Only mode with sm_set_secure_connections_only_mode 269- GAP: enable BR/EDR Secure Connections if supported, add gap_secure_connections_enable 270 271### Changed 272- L2CAP ERTM: send extended features request only once per HCI connection 273 274 275## Changes April 2020 276 277### Fixed 278- hog_mouse_demo/hog_keyboard_demo: handle set protocol mode = boot protocol mode 279- HCI: only update BD_ADDR placeholder in shortened and complete name in EIR data, limit device name to 240/248 bytes 280 281### Added 282- GAP: gap_set_allow_role_switch allows to prevent role switch in outgoing classic ACL connections 283- example: hog_boot_host_demo implements an HID-over-GATT Boot Host that supports keyboard and mouse 284- HCI: add ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS that forces fragmentation of ACL-LE packets to fit into over-the-air packet 285 286### Changed 287- Broadcom/Cypress: wait 300 ms after PatchRAM update in hci.c to assert Controller is ready 288- esp32: provide esp-idf/component/btstack/btstack_port_esp32.c and only minimal app_main in template/main/main.c 289- att_db: skip att_read_callback for ATT Read Blob Request if offset == value_len 290 291 292## Changes March 2020 293 294### Fixed 295- GAP: fixed gap_set_scan_parameters() if issued right before gap_start_scan() 296- HCI: only send HCI Read Local Encryption Key Size if supported by Controller 297 298### Added 299- GATT Client: allow to register for any notification/indication and/or any connection 300- HCI: added hci_read_inquiry_scan_activity and hci_write_inquiry_scan_activity commands 301- chipset: assert hci packet buffers are suitable for firmware upload or patches (atwilc3000,bcm,cc256x,intel) 302- btstack_util: added btstack_replace_bd_addr_placeholder 303 304### Changed 305- AVRCP Target: volume in avrcp_target_volume_changed is reported as current value in interim response to register for volume change notifications 306- SDP Client: query attributes 0x0000..0xffff instead of 0x0001..0xffff to match other stacks / improve compatibility with bad sdp server implementations 307 308 309## Changes Februar 2020 310 311### Fixed 312- AVRCP Target: fix reporting of PLAYBACK_STATUS_CHANGED 313- HCI: handle reconnect request for Classic and LE connections triggered by packet handler for Disconnection Complete Event 314 315### Changed 316- hid_host_mode: allow sniff mode 317 318### Added 319- port/qt-usb and port/qt-h4: integrate BTstack Qt run loop for Unix- and Win32-based Qt application connected to Bluetooth module via H4 over serial port or USB 320 321 322## Changes January 2020 323 324### Fixed 325- L2CAP ERTM: avoid read-after-free on decline of incoming connection 326- GATT Client: set uuid16 to zero when deserializing uuid128 services, characteristics, and descriptors 327- att_db_util: fix realloc of att db buffer for large attributes 328- btstack_tlv_posix: only keep last value in memory, fix delete operation 329- l2cap_signaling: use packet boundary flags 0x00 for LE signaling packets (ignoring hci_non_flushable_packet_boundary_flag_supported()) 330 331### Added 332- att_db_util: provide GATT Database Hash via att_db_util_hash_calc 333- GATT Compiler: provide GATT Database Hash via GATT_DATABASE_HASH Characteristic 334- ATT Server: validate request pdu length 335 336### Changed 337- Crypto: update AES-CMAC implementation to access all message bytes sequentially 338 339 340## Changes December 2019 341 342### Fixed 343- example/pan_lwip_http_server: use Network Access Point, CoD 344- sm: emit pairing complete in master role when no keys are distributed / bonding disabled 345 346### Added 347 348### Changed 349- Updated CC256x initscript: CC256xC v1.3 350- ESP32: add CMake project files 351 352 353## Changes November 2019 354 355### Fixed 356- AVDTP Source: return correct `avdtp_cid` and `local_seid` in `AVDTP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW` 357- L2CAP: send LE Data Channel SDUs round robin with other data 358- L2CAP ERTM: send ERTM I-frames round robin with other data 359 360### Added 361- ATT Server: return error if request to send now for Notification or Indication already registered 362- Linked List: return if item was added for `btstack_linked_list_add[_tail]` 363- btstack_run_loop_remove: return bool true if timer/data source was removed 364- segger-rtt: allow to configure with `SEGGER_RTT_PACKETLOG_*` directives, update to v6.54 365- GAP: support setting Link Supervision Timetout for outgoing Classic connections using `gap_set_link_supervision_timeout` 366- lwip: add download test files to http server demo 367 368### Changed 369- Linked List: return bool true if item was removed 370 371 372## Changes October 2019 373 374### Fixed 375 376### Added 377- `btstack_bool.h`: provide boolean type 'bool' via `<stdbool.h>` or as backport 378- provide `btstack_assert(condition)` 379- H4 Transport: avoid calling `hci_transport_h4_trigger_next_read` when transport is closed 380 381### Changed 382- libusb and posix ports: store bonding information in TLV 383 384 385## Changes September 2019 386 387### Fixed 388- L2CAP ERTM: assert that packet can be stored in fragment buffers in ertm 389- L2CAP ERTM: reject incoming connection if ERTM is configured as mandatory but not supported by remote 390- GATT Client: allow Write Without Response independent of other requests 391 392### Added 393- GAP: allow to reject GAP classic connection via gap_register_classic_connection_filter 394- GAP: support reading RSSI for Classic+LE using gap_read_rssi. Emits `GAP_EVENT_RSSI_MEASUREMENT` 395 396### Changed 397- Bluetooth and BTstack Error Codes and Events: collect status codes in bluetooth.h and events in btstack_defines.h 398- bluetooth.h: extract internal defintitions to respective protocol layers 399- Updated CC256x initscripts (CC256xB v1.8, CC256xC v1.2, CC256xC v1.2) 400 401 402## Changes August 2019 403 404### Fixed 405- POSIX, WICED, Windows, FreeRTOS run loops: handle time_ms overrun after 49 days 406- RFCOMM: accept incoming L2CAP connection in Basic mode if ERTM is enabled but not requested for this connection 407- RFCOMM: limit RFCOMM MTU by local L2CAP MTU for outgoing connections (only revelvant for ERTM) 408- L2CAP ERTM: stop timers on disconnect 409- L2CAP ERTM: fix sending of segmented SDUs 410- L2CAP ERTM: handle unsupported Information Response 411- SM: generate local nonce for confirm value in JW+NC+PK in Secure Connections Responder role 412 413### Added 414- `btstack_run_loop_base`: portable implementation of timer and data source management as base for platform specific implementations 415 416## Changed 417- FreeRTOS: use xQueueCreateStatic (static variant of xQueueCreate) if available for static memory-only setups 418- L2CAP ERTM: handle invalid Information Response (assume no extended features supported) 419- POSIX: use monotonic clock as timebase if available 420- HCI Transport H4/H5/EM9304 SPI: ignore block read/sent from UART driver when closed 421- HCI: Read Encryption Key Size after encryption was enabled 422- Errata 11838: 423 - GAP: gap_set_required_encryption_key_size allows to set the required key size, default = 16 (max) 424 - GAP: validate encryption key size to emit GAP Security Levels 425 426## Changes July 2019 427 428### Fixed 429- SM: Fixed regression introduced in f3582630 430- L2CAP: avoid reading l2cap signaling command len out of bounds 431- HCI Transport H4/H5/EM9304 SPI: fix payload size checks (also for 8/16-bit platforms) 432 433### Changed 434- SM: Start encryption upon receiving slave securiy request if bonded 435- hci: use 2 as HCI_INCOMING_PRE_BUFFER_SIZE in LE-only configuration for GATT Client 436 437--- 438 439## Changes June 2019 440 441### Changed 442- FreeRTOS: use freertos/.. prefix to include FreeRTOS headers if HAVE_FREERTOS_INCLUDE_PREFIX is defined 443- BNEP: add Connection Handle to BNEP_EVENT_CHANNEL_OPENED 444- Examples: renamed le_counter to gatt_counter and le_streamer to le_streamer_server to indicate suppport for GATT over BR/EDR 445 446### Fixed 447- BNEP: Bluetooth address is stored in little-endian format for all BNEP_EVENT_* 448- libusb: avoid use-after-free for SCO packets on disconnect 449 450### Added 451- example: pan_lwip_http_server using lwIP as network stack to implement PAN NAP service 452- platform/lwip/bnep_lwip.c: BNEP lwIP adapter that forwards packets between BNEP service and lwIP 453- ENABLE_GATT_OVER_CLASSIC enables support for GATT over BR/EDR in att_server 454 455--- 456 457## Changes May 2019 458 459### Changed 460- ESP32: Configure SCO over HCI after power up 461- btstack_tlv_flash_bank: support targets where a value cannot be overwritten with zero. When ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD 462 is defined, an explicit delete field is used to indicate an invalid entry. 463 464### Fixed 465- SM: Avoid potential use-after-free on immediate disconnect (lookup connection via con handle instead of storing pointer) 466 467### Added 468- gatt_client: emit query complete event for signed write operation 469- hci_transport_h4: add workaround for flow control bug in CYW2070x, enable with ENABLE_CYPRESS_BAUDRATE_CHANGE_FLOWCONTROL_BUG_WORKAROUND 470 471--- 472 473## Changes April 2019 474 475### Changed 476- ESP32: use micro-ecc from 3rd-party as esp-idf removed it in their 3.3 release 477 478### Fixed 479- hci: pad LE Scan response with zeroes 480- SM: store local CSRK 481- ATT DB: call write callback for validated signed writes 482- ATT Server: abort signed write validation on incoming new request 483- Bluetooth SIG web scraping tools updated 484- libusb: compiles for FreeBSD 485 486### Added 487 488--- 489 490## Changes March 2019 491 492### Changed 493- use Makefile for stm32-f4discovery-cc256x port 494- le_device_db: add secure_connection argument to le_device_db_encryption_set and le_device_db_encryption_get 495 496### Fixed 497- SM: Use provided authentication requirements in slave security request 498 499### Added 500- port/stm32-f4discovery-cc256x: add support for built-in MEMS microphone 501- SM: Track if connection encryption is based on LE Secure Connection pairing 502- ATT DB: Validate if connection encrypted is based on SC if requested 503- att_db_util: support ATT_SECURITY_AUTHENTICATED_SC permission flag 504- GATT Compiler: support READ_AUTHENTICATED and WRITE_AUTHENTICATED permsission flags 505- ESP32: erase nvs flash is newer nvs version found 506- libusb: add support for nRF52840-PCA10056 running Zephyr hci_usb example 507- port/stm32-l073rz-nucleo-em9304 for Nucleo L073RZ with EM9304 DVK, replaces port/stm32-l053r8-nucleo-em9304 508 509## Changes February 2019 510 511### Changed 512- example/a2dp_sink_demo: use linear resampling to fix sample rate drift 513- btstack_audio: split interface into sink and source 514 515### Fixed 516- Crypto: fix lockup when stack is shutdown while waiting for result of HCI Command, e.g. LE Read Local P256 Public Key 517- SM: Avoid SM_EVENT_PAIRING_COMPLETE with ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION after successful pairing in responder role 518 519### Added 520- example/a2dp_sink_demo: add target role, support volume control on both devices 521- example/audio_duplex: playback audio audio source on audio sink (test audio path) 522- btstack_audio_embedded: implement audio source path 523 524--- 525 526## Changes January 2019 527 528### Changed 529- L2CAP: provide channel mode (basic/ertm) and fcs option in L2CAP_EVENT_CHANNEL_OPENED 530- RFCOMM: support L2CAP ERTM. Callbacks passed to rfcomm_enable_l2cap_ertm() are used to manage ERTM buffers 531 532### Added 533- L2CAP: emit L2CAP_EVENT_ERTM_BUFFER_RELEASED if ERTM buffer not needed/used anymore 534- L2CAP: add fcs_option to ERTM config l2cap_ertm_config_t 535- HCI: validate advertisement data length field when generating GAP_EVENT_ADVERTISING_REPORT 536- ad_parser: validate data element length fields in ad_iterator_has_more 537- Raspberry Pi 3 A+/B+ port in port/raspi, starts without power cycle 538 539### Fixed 540- HCI: release outgoing buffer on disconnect if waiting to send another ACL fragment 541- POSIX: use correct baudrate enums for baud rates higher than 921600 (Linux) 542- Crypto: directly process queued crypto operation on HCI result 543 544--- 545 546## Changes December 2018 547 548### Added 549- SM: generate and store ER / IR keys in TLV, unless manually set by application 550- hci_dump: support PacketLogger or BlueZ format output via SEGGER RTT Channel 1 Up 551 552### Fixed 553- SM: fix internal buffer overrun during random address generation 554 555## Changes November 2018 556 557### Added 558- GAP: gap_le_connection_interval provides connection interval for conn handle 559- Nordic SPP Service Server: GATT service that emulates a serial port over BLE based on Nordic Semiconductor documentation. 560- uBlox SPP Service Server: GATT service that emulates a serial port over BLE based on uBlox documentation. 561- SM: ENABLE_LE_CENTRAL_AUTO_ENCRYPTION triggers automatic encryption on connect to bonded devices 562- SM: generate and store ER / IR keys in TLV, unless manually set by application 563 564### Fixed 565- SM: prevent random address updates if gap_random_address_set was used 566- SM: fix internal buffer overrun that can cause storing of bonding information to fail 567- SM: ignore Slave Security Request after sending own Pairing Request 568- L2CAP: fix use after free on disconnect if ERTM is enabled 569- HFP: Handle multiple commands/responses in single RFCOMM packet 570- Memory Pools: clear all buffers before use 571 572--- 573 574## Changes October 2018 575 576### Added 577- SDP Server: queue incoming connections when already connected instead of rejecting them 578- 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. 579- HIDS Device: GATT service that exposes HID reports intended for HID Devices, like keyboard and mouse. 580 581### Fixed 582- HCI: fix bug in gap_inquiry_stop that triggered additional GAP_EVENT_INQUIRY_COMPLETE instead of stopping the inquiry 583- L2CAP: fix issue with outgoing connection before read remote supported complete when other channels exist 584- L2CAP ERTM: allow SDU of szie MPS in first packet that contains L2CAP SDU Length 585- L2CAP ERTM: fix memory corruption triggered if local_mtu > mps 586- L2CAP ERTM: fix outgoing fragment management 587- HFP: decline incoming RFCOMM connection after outgoing connection was started 588- AVRCP: fix crash on disconnect of connection established by remote 589 590--- 591 592## Changes September 2018 593 594### Fixed 595- HCI: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled 596- L2CAP: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled 597- L2CAP: Evaluate 'can send now' on HCI Disconnect as ACL buffers in Bluetooth Controller have been used for the closed connection are freed implicitly 598- L2CAP: Check can send now before sending extended information requeste needed for ERTM mode 599- L2CAP: Use valid signaling identifier for L2CAP Connection Parameter Update Request 600- 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 601- RFCOMM: Avoid use-after-free on channel finalize 602- GATT Client: stop timer on disconnect - fixes use after free / crash 603 604### Added 605- A2DP Source: Support stream reconfiguration (a2dp_source_reconfigure_stream_sampling_frequency) 606- 3rd-party: yxml is used for PBAP vCard list parsing 607- cc256xC: new v1.1 init scripts 608 609--- 610 611## Changes August 2018 612 613### Added 614- PBAP: added pbap_get_phonebook_size() to get phonebook entry count 615 616### Fixed 617- GATT Server: Allow enable Notifications/Indication with Write Command. Fixes issue with some Android devices. 618- SM: fix pairing for Secure Connections with Bonding if remote sends additional keys 619- SM: drop LTK flag from Pairing Response for Secure Connections 620- L2CAP: fix emitted L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_REQUEST 621 622## Changes June 2018 623 624### Added 625- btstack_audio.h: application level API for audio playback and recording 626- embedded/hal_audio.h: low-level API for audio playback and recording 627- HID Device: hid_device_connect(..) function 628- ESP32: implement hal_audio 629- DA14585: support for Dialog Semiconductor DA14585 LE-only controller 630- Raspberry Pi 3 + Raspberry Pi Zero W port in port/raspi 631 632### Changed 633- Errata 10734: 634 - SM: Generate new EC Public Keypair after each pairing 635 - SM: Abort failure with DHKEY_CHECK_FAILED if received public key is invalid (instead of unspecified error) 636- btstack.h: only include classic headers if ENABLE_CLASSIC is defined 637- windows: ignore virtual Bluetooth adapter provided by VMware 638- Replaced HCI_PACKET_BUFFER_SIZE with HCI_INCOMING_PACKET_BUFFER_SIZE and HCI_OUTGOING_PACKET_BUFFER_SIZE 639 640--- 641 642## Changes June 2018 643 644### Fixed 645- HFP: Fix Wide Band Speech bit in SDP record for both HF/AG. Missing bit prevents macOS from using mSBC 646- ATT Server: send ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE with status ATT_HANDLE_VALUE_INDICATION_DISCONNECT on disconnect 647- AVRCP Controller: fix parsing of now playing info 648 649### Changed 650- ATT Server: ATT_HANDLE_VALUE_INDICATION_DISCONNECT is delivered to service handler if registered 651 652### Added 653- ATT Server: packet handler field added to att_service_handler_t to receive: connect/disconnect, atu exchange, indication complete 654 655--- 656 657## Changes May 2018 658 659### Added 660- GAP: re-encrypt outgoing connection if bonded 661- ATT Server: wait until re-encryption is complete 662- GATT Client: wait until re-encryption is complete 663- ATT Server: added att_server_request_to_send_notification and att_server_request_to_send_indication 664- GATT Client: if ENABLE_GATT_CLIENT_PAIRING, GATT Client starts pairing and retry operation on security error 665 666### Changed 667- ATT Server: att_server_register_can_send_now_callback is deprecated, use att_server_request_to_send_notification/indication instead 668 669### Fixed 670- SM: Fix LE Secure Connection pairing in Central role 671- le_device_db_tlv: fix seq nr management 672- SM: improve le_device_db lookup and storing of IRK 673- GATT Server: fix lookup for Client Characteristic Configuration in services with multiple Characteristics 674- RFCOMM: emit channel closed on HCI/L2CAP disconnect after sending DISC while expecting UA 675 676--- 677 678## Changes April 2018 679 680### Added 681- Crypto: btstack_crypo.h provides cryptographic functions for random data generation, AES128, EEC, CBC-MAC (Mesh) 682- SM: support pairing using Out-of-Band (OOB) data with LE Secure Connections 683- Embedded: support btstack_stdin via SEGGER RTT 684 685### Changed 686- att_db_util: added security requirement arguments to characteristic creators 687- SM: use btstack_crypto for cryptographpic functions 688- GAP: security level for Classic protocols (asides SDP) raised to 2 (encryption) 689 690### Fixed 691- HFP: fix answer call command 692- HCI: fix buffer overrun in gap_inquiry_explode 693- SDP: free service record item on sdp_unregister_service 694 695## Changes March 2018 696 697### Added 698- GAP: allow to limit number of connections in LE Peripheral role with gap_set_max_number_peripheral_connections 699- ATT Server: support for delayed ATT read response, see example/att_delayed_read_response.c 700- ATT Server: allow to specify security requirements seperately for read/writes. .h files need to be regenerated 701 702### Fixed 703- RFCOMM: fix infinite loop on L2CAP connection error (regression from 4c3eeed1) 704- HSP HS: accept incomming SCO connection 705- SM: fix iteration over LE Device DB entries for bonding and address resolving 706- SM: store pairing information only if both devices have requested bonding 707 708--- 709 710## Changes February 2018 711 712### Added 713- GATT Client: gatt_client_request_can_write_without_response_event() causes GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE 714- SM: new event SM_EVENT_PAIRING_COMPLETE 715- GAP: support iteration over stored Classic link keys: gap_link_key_iterator_init, gap_link_key_iterator_get_next, gap_link_key_iterator_done 716- GAP: add gap_delete_all_link_keys 717 718### Changed 719- GATT Client: round robin for multiple connections 720- ATT Dispatch: round robin for ATT Server & GATT Client 721- L2CAP: round robin for all L2CAP channels (fixed and dynamic) 722- btstack_link_key_db: addition functions for link key iteration 723- GAP: LE scanning enabled not reset on HCI Reset -> can be enabled before HCI Power Up 724- CSR: set all keys in psram instead of default 725 726### Fixed 727- tc3556x: fix startup after baud rate change 728 729--- 730 731## Changes January 2018 732 733### Added 734- Port for Windows with Zephyr HCI Firmware connected via serial port 735- em9304: upload patch containers during HCI bootup 736- Makefile for STM32-F4Discovery port 737- support for console out via SEGGER RTT 738- LE Data Channels example in BTstack and [iOS example on GitHub](https://github.com/bluekitchen/CBL2CAPChannel-Demo) 739- LE Streamer Client can send as fast as possbile as well 740- L2CAP: option to limit ATT MTU via l2cap_set_max_le_mtu 741 742### Changed 743- HCI: allow to set hci_set_master_slave_policy (0: try to become master, 1: accept slave) 744- GAP: gap_set_connection_parameters includes scan interval and window params 745- GATT Client: GATT_EVENT_MTU indicates max MTU 746- ATT DB Util: attribute handle is returned for new Services and Characteristics 747 748### Fixed 749- Windows: retry serial port operations if not all bytes have been read/written 750- HFP: avoid buffer overflows setting up messages 751- SBC Decoder: improved error handling for invalid SBC audio data 752- GAP: fix Connection Parameter Response in Central role 753- ATT DB Util: update pointer to database in case of realloc 754- GATT Client: set UUID16 field if 16-bit UUID is stored as UUID128 755- GAP: release HCI Connnection after gap_le_conne 756- ATT: Exchanged MTU is propagate to ATT Server and GATT Client 757 758--- 759 760## Changes December 2017 761 762### Added 763- Introduced btstack_network.h network interface abstraction 764- btstack_network_posix implementation using Linux tun/tap interface 765- WICED: support for btstack_stdin (HAVE_STDIN) 766- 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. 767- TLV: global TLV instance available via btstack_tlv_get_instance() (src/btstack_tlv.h) 768- TLV: POSIX implementation that appends to a file on disk (platform/posix/btstack_tlv_posix.c 769- LE Device DB TLV: overwrite oldest entry if no free entries available 770- SM: allow to set fixed passkey in display role using sm_use_fixed_passkey_in_display_role 771- Example/hid_host_demo with HID parser and support for basic US keyboard layout 772- 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 773- Port for Apollo2 MCU with EM9304 (ports/apollo2-em9304) 774 775### Changed 776- panu_demo: uses btstack_network.h now 777- WICED: configure printf to replace Linefeed with CRLF 778- SBC: split btstack_sbc_bludroid.c into seperate encoder and decoder implementations 779 780### Fixed 781- RFCOMM: support connection requests during connection failure 782- L2CAP: support connection requests during connection failure 783- L2CAP: fix default remote MTU as 672 instead of 48 (Minimal MTU) 784- HCI: avoid double free during halting 785- SM: fixed reconnect using legacy pairing in slave role 786 787 788