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