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