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