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