xref: /btstack/CHANGELOG.md (revision 30264fa654b9df510baf490f3fa41e684528a4f8)
190e1375eSMatthias Ringwald# Change Log
290e1375eSMatthias RingwaldAll notable changes to this project will be documented in this file.
390e1375eSMatthias Ringwald
490e1375eSMatthias RingwaldThe format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
590e1375eSMatthias Ringwaldand this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
690e1375eSMatthias Ringwald
76d27add1SMatthias Ringwald---
86d27add1SMatthias Ringwald
990e1375eSMatthias Ringwald## [Unreleased]
1090e1375eSMatthias Ringwald
118b3ffec5SMatthias Ringwald### Fixed
12*30264fa6SMatthias Ringwald### Added
13*30264fa6SMatthias Ringwald### Changed
14*30264fa6SMatthias Ringwald
15*30264fa6SMatthias Ringwald
16*30264fa6SMatthias Ringwald## Changes July 2020
17*30264fa6SMatthias Ringwald
18*30264fa6SMatthias Ringwald### Fixed
19*30264fa6SMatthias Ringwald- AVDTP: fix invalid response for Get Capabilities request if Delay Reporting was supported
20*30264fa6SMatthias Ringwald- AVDTP: handle concurrent signaling establishment with reject and retry
21*30264fa6SMatthias Ringwald
22*30264fa6SMatthias Ringwald### Added
23*30264fa6SMatthias Ringwald- example/hid_host_demo: support reconnect from HID device
24*30264fa6SMatthias Ringwald- Crypto: support software AES128 for AES-CCM operations
25*30264fa6SMatthias Ringwald- AVRCP: introduced AVRCP_FEATURE_MASK_* as alternative to avrcp_controller_supported_feature_t and avrcp_target_supported_feature_t enums
26*30264fa6SMatthias Ringwald- btstack_audio: add set_volume() to sink and set_gain() to source interfaces, minimal volume control for portaudio playback
27*30264fa6SMatthias Ringwald- 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
28*30264fa6SMatthias Ringwald- GAP: Provide gap_get_role to query master/slave role for HCI connection handle
29*30264fa6SMatthias Ringwald- GAP: Provide gap_pin_code_response_binary to use binary data as PIN, e.g. for pairing with Nintendo Wii Remote
30*30264fa6SMatthias Ringwald
31*30264fa6SMatthias Ringwald### Changed
32*30264fa6SMatthias Ringwald- GAP: set minimum required encryption key size for Classic connections back from 16 to 7, matching the Core spec
33*30264fa6SMatthias Ringwald
34*30264fa6SMatthias Ringwald
35*30264fa6SMatthias Ringwald## Changes June 2020
36*30264fa6SMatthias Ringwald
37*30264fa6SMatthias Ringwald### Fixed
386bb7b6c6SMatthias Ringwald- HFP: Fix parsing of empty fields, e.g. phone number in +CLCC and other AT commands
39d686b2d0SMatthias Ringwald- sm: Fix validation of confirm value for secure connection Passkey entry
40*30264fa6SMatthias Ringwald- AVRCP: handle concurrent signaling establishment with reject and retry
41545c5248SMatthias Ringwald
42545c5248SMatthias Ringwald### Added
43699292e6SMatthias Ringwald- GAP: Detect Secure Connection -> Legacy Connection Downgrade Attack by remote features and actual encryption type (BIAS)
44699292e6SMatthias Ringwald- GAP: Mutual authentication: request authentication after Classic connection got encrypted (BIAS)
453c214e8aSMatthias Ringwald- Windows port for Dialog DA14585 connected via serial port
46545c5248SMatthias Ringwald
47*30264fa6SMatthias Ringwald## Changes
48*30264fa6SMatthias Ringwald- CVSD PLC: treat zero frames as good and allow to mark data as bad, e.g. if reported by Controller as erroneous
49545c5248SMatthias Ringwald
50545c5248SMatthias Ringwald## Changes May 2020
51545c5248SMatthias Ringwald
52545c5248SMatthias Ringwald### Fixed
53c169df2fSMatthias Ringwald- hfp_hf, hsp_hs: use eSCO params in accept sco connection only for incoming eSCO connections
54a0506975SMatthias Ringwald- pbap_client: fix PBAP UUID len on connect message
55d08147dfSMatthias Ringwald- sm: fix secure connection pairing as peripheral when local user confirmation happens after remote one
5686a5a721SMatthias Ringwald- A2DP Source: only connect to remote sink stream endpoints
573f054530SMatthias Ringwald- btstack_hal_flash_memory: fix write of 0xff bytes to simulated flash
5808ecd8bdSMatthias Ringwald- hsp_hs: fix disconnect if audio not connected
59effbff2cSMatthias Ringwald- hsp_ag: fix accept incoming connection
60656e09c9SMatthias Ringwald
61656e09c9SMatthias Ringwald### Added
6207f151d6SMatthias Ringwald- example/le_mitm: MITM implementation that forwards ATT PDUs and allows for pairing
6378315a58SMatthias Ringwald- GAP: gap_set_security_level sets required security level for incoming and outgoing connections
6463efc2edSMatthias Ringwald- cc256x: allow to specify power vector for each modulation type
659dc32eb4SMatthias Ringwald- FreeRTOS: btstack_run_loop_freertos_trigger_exit allows to request run loop exit
663cdbe9dbSMatthias Ringwald- sm: support LE Secure Connections Only mode with sm_set_secure_connections_only_mode
675d23aae8SMatthias Ringwald- GAP: enable BR/EDR Secure Connections if supported, add gap_secure_connections_enable
68656e09c9SMatthias Ringwald
69656e09c9SMatthias Ringwald### Changed
7076981ac4SMatthias Ringwald- L2CAP ERTM: send extended features request only once per HCI connection
7176981ac4SMatthias Ringwald
72656e09c9SMatthias Ringwald
73b4eb4420SMatthias Ringwald## Changes April 2020
74b4eb4420SMatthias Ringwald
75b4eb4420SMatthias Ringwald### Fixed
7650304921SMatthias Ringwald- hog_mouse_demo/hog_keyboard_demo: handle set protocol mode = boot protocol mode
77be05aae3SMatthias Ringwald- HCI: only update BD_ADDR placeholder in shortened and complete name in EIR data, limit device name to 240/248 bytes
78b4eb4420SMatthias Ringwald
79b4eb4420SMatthias Ringwald### Added
80b4eb4420SMatthias Ringwald- GAP: gap_set_allow_role_switch allows to prevent role switch in outgoing classic ACL connections
8176981ac4SMatthias Ringwald- example: hog_boot_host_demo implements an HID-over-GATT Boot Host that supports keyboard and mouse
82be05aae3SMatthias Ringwald- HCI: add ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS that forces fragmentation of ACL-LE packets to fit into over-the-air packet
83b4eb4420SMatthias Ringwald
84b4eb4420SMatthias Ringwald### Changed
85d0edd69aSMatthias Ringwald- Broadcom/Cypress: wait 300 ms after PatchRAM update in hci.c to assert Controller is ready
86bd8e4ef6SMatthias Ringwald- esp32: provide esp-idf/component/btstack/btstack_port_esp32.c and only minimal app_main in template/main/main.c
87af1b7cdcSMatthias Ringwald- att_db: skip att_read_callback for ATT Read Blob Request if offset == value_len
88b4eb4420SMatthias Ringwald
8976981ac4SMatthias Ringwald
90b3f03c84SMatthias Ringwald## Changes March 2020
91b3f03c84SMatthias Ringwald
923251a108SMatthias Ringwald### Fixed
933251a108SMatthias Ringwald- GAP: fixed gap_set_scan_parameters() if issued right before gap_start_scan()
946e058d3fSMatthias Ringwald- HCI: only send HCI Read Local Encryption Key Size if supported by Controller
953251a108SMatthias Ringwald
96b3f03c84SMatthias Ringwald### Added
976e058d3fSMatthias Ringwald- GATT Client: allow to register for any notification/indication and/or any connection
98be05aae3SMatthias Ringwald- HCI: added hci_read_inquiry_scan_activity and hci_write_inquiry_scan_activity commands
996e058d3fSMatthias Ringwald- chipset: assert hci packet buffers are suitable for firmware upload or patches (atwilc3000,bcm,cc256x,intel)
100be05aae3SMatthias Ringwald- btstack_util: added btstack_replace_bd_addr_placeholder
101b3f03c84SMatthias Ringwald
1023e5c3c5bSMatthias Ringwald### Changed
1033e5c3c5bSMatthias Ringwald- AVRCP Target: volume in avrcp_target_volume_changed is reported as current value in interim response to register for volume change notifications
1040d6cebf8SMatthias Ringwald- SDP Client: query attributes 0x0000..0xffff instead of 0x0001..0xffff to match other stacks / improve compatibility with bad sdp server implementations
1053e5c3c5bSMatthias Ringwald
10676981ac4SMatthias Ringwald
107656e09c9SMatthias Ringwald## Changes Februar 2020
108656e09c9SMatthias Ringwald
109656e09c9SMatthias Ringwald### Fixed
110656e09c9SMatthias Ringwald- AVRCP Target: fix reporting of PLAYBACK_STATUS_CHANGED
111f4aa13dfSMatthias Ringwald- HCI: handle reconnect request for Classic and LE connections triggered by packet handler for Disconnection Complete Event
112656e09c9SMatthias Ringwald
113656e09c9SMatthias Ringwald### Changed
114656e09c9SMatthias Ringwald- hid_host_mode: allow sniff mode
115656e09c9SMatthias Ringwald
116985f3405SMatthias Ringwald### Added
117*30264fa6SMatthias Ringwald- 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
118985f3405SMatthias Ringwald
119985f3405SMatthias Ringwald
120656e09c9SMatthias Ringwald## Changes January 2020
121656e09c9SMatthias Ringwald
122656e09c9SMatthias Ringwald### Fixed
12375e67d8aSMatthias Ringwald- L2CAP ERTM: avoid read-after-free on decline of incoming connection
124c839c6f9SMatthias Ringwald- GATT Client: set uuid16 to zero when deserializing uuid128 services, characteristics, and descriptors
1255c0b28efSMatthias Ringwald- att_db_util: fix realloc of att db buffer for large attributes
12639f043d5SMatthias Ringwald- btstack_tlv_posix: only keep last value in memory, fix delete operation
1272a9f55d6SMatthias Ringwald- l2cap_signaling: use packet boundary flags 0x00 for LE signaling packets (ignoring hci_non_flushable_packet_boundary_flag_supported())
12883905472SMatthias Ringwald
12983905472SMatthias Ringwald### Added
13083905472SMatthias Ringwald- att_db_util: provide GATT Database Hash via att_db_util_hash_calc
13144b583f5SMatthias Ringwald- GATT Compiler: provide GATT Database Hash via GATT_DATABASE_HASH Characteristic
1329b49c4f4SMatthias Ringwald- ATT Server: validate request pdu length
13383905472SMatthias Ringwald
13483905472SMatthias Ringwald### Changed
135*30264fa6SMatthias Ringwald- Crypto: update AES-CMAC implementation to access all message bytes sequentially
13683905472SMatthias Ringwald
13776981ac4SMatthias Ringwald
13883905472SMatthias Ringwald## Changes December 2019
13983905472SMatthias Ringwald
14083905472SMatthias Ringwald### Fixed
14143d70f1dSMatthias Ringwald- example/pan_lwip_http_server: use Network Access Point, CoD
1421dca9d8aSMatthias Ringwald- sm: emit pairing complete in master role when no keys are distributed / bonding disabled
14343d70f1dSMatthias Ringwald
14443d70f1dSMatthias Ringwald### Added
14543d70f1dSMatthias Ringwald
14643d70f1dSMatthias Ringwald### Changed
14743d70f1dSMatthias Ringwald- Updated CC256x initscript: CC256xC v1.3
148a7649d03SMatthias Ringwald- ESP32: add CMake project files
14943d70f1dSMatthias Ringwald
15076981ac4SMatthias Ringwald
15143d70f1dSMatthias Ringwald## Changes November 2019
15243d70f1dSMatthias Ringwald
15343d70f1dSMatthias Ringwald### Fixed
15443d70f1dSMatthias Ringwald- AVDTP Source: return correct `avdtp_cid` and `local_seid` in `AVDTP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW`
15543d70f1dSMatthias Ringwald- L2CAP: send LE Data Channel SDUs round robin with other data
15643d70f1dSMatthias Ringwald- L2CAP ERTM: send ERTM I-frames round robin with other data
15743d70f1dSMatthias Ringwald
15843d70f1dSMatthias Ringwald### Added
15943d70f1dSMatthias Ringwald- ATT Server: return error if request to send now for Notification or Indication already registered
16043d70f1dSMatthias Ringwald- Linked List: return if item was added for `btstack_linked_list_add[_tail]`
16143d70f1dSMatthias Ringwald- btstack_run_loop_remove: return bool true if timer/data source was removed
16243d70f1dSMatthias Ringwald- segger-rtt: allow to configure with `SEGGER_RTT_PACKETLOG_*` directives, update to v6.54
16343d70f1dSMatthias Ringwald- GAP: support setting Link Supervision Timetout for outgoing Classic connections using `gap_set_link_supervision_timeout`
16443d70f1dSMatthias Ringwald- lwip: add download test files to http server demo
16543d70f1dSMatthias Ringwald
16643d70f1dSMatthias Ringwald### Changed
16743d70f1dSMatthias Ringwald- Linked List: return bool true if item was removed
16843d70f1dSMatthias Ringwald
16943d70f1dSMatthias Ringwald
17043d70f1dSMatthias Ringwald## Changes October 2019
17143d70f1dSMatthias Ringwald
17243d70f1dSMatthias Ringwald### Fixed
17343d70f1dSMatthias Ringwald
17443d70f1dSMatthias Ringwald### Added
17543d70f1dSMatthias Ringwald- `btstack_bool.h`: provide boolean type 'bool' via `<stdbool.h>` or as backport
17643d70f1dSMatthias Ringwald- provide `btstack_assert(condition)`
17743d70f1dSMatthias Ringwald- H4 Transport: avoid calling `hci_transport_h4_trigger_next_read` when transport is closed
17843d70f1dSMatthias Ringwald
17943d70f1dSMatthias Ringwald### Changed
18043d70f1dSMatthias Ringwald- libusb and posix ports: store bonding information in TLV
18143d70f1dSMatthias Ringwald
18243d70f1dSMatthias Ringwald
18343d70f1dSMatthias Ringwald## Changes September 2019
18443d70f1dSMatthias Ringwald
18543d70f1dSMatthias Ringwald### Fixed
1862e4c1850SMatthias Ringwald- L2CAP ERTM: assert that packet can be stored in fragment buffers in ertm
187836ae835SMatthias Ringwald- L2CAP ERTM: reject incoming connection if ERTM is configured as mandatory but not supported by remote
188695e959aSMatthias Ringwald- GATT Client: allow Write Without Response independent of other requests
1894536712cSMilanka Ringwald
1904536712cSMilanka Ringwald### Added
191891b9fc2SMatthias Ringwald- GAP: allow to reject GAP classic connection via gap_register_classic_connection_filter
19243d70f1dSMatthias Ringwald- GAP: support reading RSSI for Classic+LE using gap_read_rssi. Emits `GAP_EVENT_RSSI_MEASUREMENT`
1934536712cSMilanka Ringwald
19443d70f1dSMatthias Ringwald### Changed
19583e8a8b4SMilanka Ringwald- Bluetooth and BTstack Error Codes and Events: collect status codes in bluetooth.h and events in btstack_defines.h
196daec7f90SMatthias Ringwald- bluetooth.h: extract internal defintitions to respective protocol layers
19743d70f1dSMatthias Ringwald- Updated CC256x initscripts (CC256xB v1.8, CC256xC v1.2, CC256xC v1.2)
19843d70f1dSMatthias Ringwald
1994536712cSMilanka Ringwald
2004536712cSMilanka Ringwald## Changes August 2019
2014536712cSMilanka Ringwald
2024536712cSMilanka Ringwald### Fixed
203e1f022c2SMatthias Ringwald- POSIX, WICED, Windows, FreeRTOS run loops: handle time_ms overrun after 49 days
20426244be4SMatthias Ringwald- RFCOMM: accept incoming L2CAP connection in Basic mode if ERTM is enabled but not requested for this connection
205e1f022c2SMatthias Ringwald- RFCOMM: limit RFCOMM MTU by local L2CAP MTU for outgoing connections (only revelvant for ERTM)
2068f4dd6c1SMatthias Ringwald- L2CAP ERTM: stop timers on disconnect
207b90eac91SMatthias Ringwald- L2CAP ERTM: fix sending of segmented SDUs
2080defadfbSMatthias Ringwald- L2CAP ERTM: handle unsupported Information Response
209ae7be282SMatthias Ringwald- SM: generate local nonce for confirm value in JW+NC+PK in Secure Connections Responder role
21026244be4SMatthias Ringwald
21198a6a078SMatthias Ringwald### Added
212*30264fa6SMatthias Ringwald- `btstack_run_loop_base`: portable implementation of timer and data source management as base for platform specific implementations
21398a6a078SMatthias Ringwald
214d798a8dcSMatthias Ringwald## Changed
2150defadfbSMatthias Ringwald- FreeRTOS: use xQueueCreateStatic (static variant of xQueueCreate) if available for static memory-only setups
2160defadfbSMatthias Ringwald- L2CAP ERTM: handle invalid Information Response (assume no extended features supported)
21792b78dd7SMatthias Ringwald- POSIX: use monotonic clock as timebase if available
218e1f022c2SMatthias Ringwald- HCI Transport H4/H5/EM9304 SPI: ignore block read/sent from UART driver when closed
219170fafaeSMatthias Ringwald- HCI: Read Encryption Key Size after encryption was enabled
220170fafaeSMatthias Ringwald- Errata 11838:
221170fafaeSMatthias Ringwald  - GAP: gap_set_required_encryption_key_size allows to set the required key size, default = 16 (max)
222170fafaeSMatthias Ringwald  - GAP: validate encryption key size to emit GAP Security Levels
22326244be4SMatthias Ringwald
22426244be4SMatthias Ringwald## Changes July 2019
22526244be4SMatthias Ringwald
22626244be4SMatthias Ringwald### Fixed
2278b3ffec5SMatthias Ringwald- SM: Fixed regression introduced in f3582630
228e1f022c2SMatthias Ringwald- L2CAP: avoid reading l2cap signaling command len out of bounds
229e1f022c2SMatthias Ringwald- HCI Transport H4/H5/EM9304 SPI: fix payload size checks (also for 8/16-bit platforms)
2308b3ffec5SMatthias Ringwald
231e061bbd4SMatthias Ringwald### Changed
232e061bbd4SMatthias Ringwald- SM: Start encryption upon receiving slave securiy request if bonded
233e1f022c2SMatthias Ringwald- hci: use 2 as HCI_INCOMING_PRE_BUFFER_SIZE in LE-only configuration for GATT Client
234e061bbd4SMatthias Ringwald
23526244be4SMatthias Ringwald---
23626244be4SMatthias Ringwald
2378b3ffec5SMatthias Ringwald## Changes June 2019
2388b3ffec5SMatthias Ringwald
23900e06a13SMatthias Ringwald### Changed
2406d23ba05SMatthias Ringwald- FreeRTOS: use freertos/.. prefix to include FreeRTOS headers if HAVE_FREERTOS_INCLUDE_PREFIX is defined
241d1a9b16cSMatthias Ringwald- BNEP: add Connection Handle to BNEP_EVENT_CHANNEL_OPENED
242bdc352b1SMatthias Ringwald- Examples: renamed le_counter to gatt_counter and le_streamer to le_streamer_server to indicate suppport for GATT over BR/EDR
2437e656a40SMatthias Ringwald
2440c23bea1SMatthias Ringwald### Fixed
245fb389631SMatthias Ringwald- BNEP: Bluetooth address is stored in little-endian format for all BNEP_EVENT_*
246e1f022c2SMatthias Ringwald- libusb: avoid use-after-free for SCO packets on disconnect
2476d27add1SMatthias Ringwald
2486d27add1SMatthias Ringwald### Added
24997dc5e69SMatthias Ringwald- example: pan_lwip_http_server using lwIP as network stack to implement PAN NAP service
25097dc5e69SMatthias Ringwald- platform/lwip/bnep_lwip.c: BNEP lwIP adapter that forwards packets between BNEP service and lwIP
2515aea4d8eSMatthias Ringwald- ENABLE_GATT_OVER_CLASSIC enables support for GATT over BR/EDR in att_server
2526d27add1SMatthias Ringwald
2536d27add1SMatthias Ringwald---
2546d27add1SMatthias Ringwald
2556d27add1SMatthias Ringwald## Changes May 2019
2566d27add1SMatthias Ringwald
2576d27add1SMatthias Ringwald### Changed
2586d27add1SMatthias Ringwald- ESP32: Configure SCO over HCI after power up
2596d27add1SMatthias Ringwald- btstack_tlv_flash_bank: support targets where a value cannot be overwritten with zero. When ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
2606d27add1SMatthias Ringwald  is defined, an explicit delete field is used to indicate an invalid entry.
2618b3ffec5SMatthias Ringwald
2626d27add1SMatthias Ringwald### Fixed
2636d27add1SMatthias Ringwald- SM: Avoid potential use-after-free on immediate disconnect (lookup connection via con handle instead of storing pointer)
2648b3ffec5SMatthias Ringwald
2656d27add1SMatthias Ringwald### Added
2666d27add1SMatthias Ringwald- gatt_client: emit query complete event for signed write operation
2676d27add1SMatthias Ringwald- hci_transport_h4: add workaround for flow control bug in CYW2070x, enable with ENABLE_CYPRESS_BAUDRATE_CHANGE_FLOWCONTROL_BUG_WORKAROUND
2686d27add1SMatthias Ringwald
2696d27add1SMatthias Ringwald---
2706d27add1SMatthias Ringwald
2716d27add1SMatthias Ringwald## Changes April 2019
2726d27add1SMatthias Ringwald
2736d27add1SMatthias Ringwald### Changed
2747e656a40SMatthias Ringwald- ESP32: use micro-ecc from 3rd-party as esp-idf removed it in their 3.3 release
2756d27add1SMatthias Ringwald
2766d27add1SMatthias Ringwald### Fixed
2776d27add1SMatthias Ringwald- hci: pad LE Scan response with zeroes
27815406929SMatthias Ringwald- SM: store local CSRK
27915406929SMatthias Ringwald- ATT DB: call write callback for validated signed writes
280e0463bdcSMatthias Ringwald- ATT Server: abort signed write validation on incoming new request
28128166e71SMatthias Ringwald- Bluetooth SIG web scraping tools updated
282f4c3a11cSMatthias Ringwald- libusb: compiles for FreeBSD
2830c23bea1SMatthias Ringwald
28400e06a13SMatthias Ringwald### Added
2856d27add1SMatthias Ringwald
2866d27add1SMatthias Ringwald---
2876d27add1SMatthias Ringwald
2886d27add1SMatthias Ringwald## Changes March 2019
2896d27add1SMatthias Ringwald
2906d27add1SMatthias Ringwald### Changed
2916d27add1SMatthias Ringwald- use Makefile for stm32-f4discovery-cc256x port
2926d27add1SMatthias Ringwald- le_device_db: add secure_connection argument to le_device_db_encryption_set and le_device_db_encryption_get
2936d27add1SMatthias Ringwald
2946d27add1SMatthias Ringwald### Fixed
2956d27add1SMatthias Ringwald- SM: Use provided authentication requirements in slave security request
2966d27add1SMatthias Ringwald
2976d27add1SMatthias Ringwald### Added
2986d27add1SMatthias Ringwald- port/stm32-f4discovery-cc256x: add support for built-in MEMS microphone
29900e06a13SMatthias Ringwald- SM: Track if connection encryption is based on LE Secure Connection pairing
30000e06a13SMatthias Ringwald- ATT DB: Validate if connection encrypted is based on SC if requested
30100e06a13SMatthias Ringwald- att_db_util: support ATT_SECURITY_AUTHENTICATED_SC permission flag
302ce711664SMatthias Ringwald- GATT Compiler: support READ_AUTHENTICATED and WRITE_AUTHENTICATED permsission flags
3036d27add1SMatthias Ringwald- ESP32: erase nvs flash is newer nvs version found
304df503ac6SMatthias Ringwald- libusb: add support for nRF52840-PCA10056 running Zephyr hci_usb example
3056d27add1SMatthias Ringwald- port/stm32-l073rz-nucleo-em9304 for Nucleo L073RZ with EM9304 DVK, replaces port/stm32-l053r8-nucleo-em9304
306d2e78cccSMatthias Ringwald
307ce711664SMatthias Ringwald## Changes February 2019
308ce711664SMatthias Ringwald
309ce711664SMatthias Ringwald### Changed
310ce711664SMatthias Ringwald- example/a2dp_sink_demo: use linear resampling to fix sample rate drift
311ce711664SMatthias Ringwald- btstack_audio: split interface into sink and source
312ce711664SMatthias Ringwald
313ce711664SMatthias Ringwald### Fixed
314ce711664SMatthias Ringwald- Crypto: fix lockup when stack is shutdown while waiting for result of HCI Command, e.g. LE Read Local P256 Public Key
315ce711664SMatthias Ringwald- SM: Avoid SM_EVENT_PAIRING_COMPLETE with ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION after successful pairing in responder role
316ce711664SMatthias Ringwald
317ce711664SMatthias Ringwald### Added
318ce711664SMatthias Ringwald- example/a2dp_sink_demo: add target role, support volume control on both devices
319ce711664SMatthias Ringwald- example/audio_duplex: playback audio audio source on audio sink (test audio path)
320ce711664SMatthias Ringwald- btstack_audio_embedded: implement audio source path
32100e06a13SMatthias Ringwald
3226d27add1SMatthias Ringwald---
3236d27add1SMatthias Ringwald
324740eb56eSMatthias Ringwald## Changes January 2019
3250c23bea1SMatthias Ringwald
3267f1690cfSMatthias Ringwald### Changed
3277f1690cfSMatthias Ringwald- L2CAP: provide channel mode (basic/ertm) and fcs option in L2CAP_EVENT_CHANNEL_OPENED
328a7a98a14SMatthias Ringwald- RFCOMM: support L2CAP ERTM. Callbacks passed to rfcomm_enable_l2cap_ertm() are used to manage ERTM buffers
3297f1690cfSMatthias Ringwald
33066a72640SMatthias Ringwald### Added
33166a72640SMatthias Ringwald- L2CAP: emit L2CAP_EVENT_ERTM_BUFFER_RELEASED if ERTM buffer not needed/used anymore
332c425ea4aSMatthias Ringwald- L2CAP: add fcs_option to ERTM config l2cap_ertm_config_t
33333e6948bSMatthias Ringwald- HCI: validate advertisement data length field when generating GAP_EVENT_ADVERTISING_REPORT
33488949f84SMatthias Ringwald- ad_parser: validate data element length fields in ad_iterator_has_more
335740eb56eSMatthias Ringwald- Raspberry Pi 3 A+/B+ port in port/raspi, starts without power cycle
33666a72640SMatthias Ringwald
33781d2bdb2SMatthias Ringwald### Fixed
33881d2bdb2SMatthias Ringwald- HCI: release outgoing buffer on disconnect if waiting to send another ACL fragment
339d14da541SMatthias Ringwald- POSIX: use correct baudrate enums for baud rates higher than 921600 (Linux)
3405db50aaaSMatthias Ringwald- Crypto: directly process queued crypto operation on HCI result
34181d2bdb2SMatthias Ringwald
3426d27add1SMatthias Ringwald---
3436d27add1SMatthias Ringwald
3447f1690cfSMatthias Ringwald## Changes December 2018
3457f1690cfSMatthias Ringwald
3462b6d34f4SMatthias Ringwald### Added
347472a1e5fSMilanka Ringwald- SM: generate and store ER / IR keys in TLV, unless manually set by application
3485fa31a99SMatthias Ringwald- hci_dump: support PacketLogger or BlueZ format output via SEGGER RTT Channel 1 Up
349472a1e5fSMilanka Ringwald
350472a1e5fSMilanka Ringwald### Fixed
351472a1e5fSMilanka Ringwald- SM: fix internal buffer overrun during random address generation
352472a1e5fSMilanka Ringwald
353472a1e5fSMilanka Ringwald## Changes November 2018
354472a1e5fSMilanka Ringwald
355472a1e5fSMilanka Ringwald### Added
356ba156408SMatthias Ringwald- GAP: gap_le_connection_interval provides connection interval for conn handle
357ba156408SMatthias Ringwald- Nordic SPP Service Server: GATT service that emulates a serial port over BLE based on Nordic Semiconductor documentation.
358ba156408SMatthias Ringwald- uBlox  SPP Service Server: GATT service that emulates a serial port over BLE based on uBlox documentation.
359c949105aSMatthias Ringwald- SM: ENABLE_LE_CENTRAL_AUTO_ENCRYPTION triggers automatic encryption on connect to bonded devices
360899e6e02SMatthias Ringwald- SM: generate and store ER / IR keys in TLV, unless manually set by application
361ba156408SMatthias Ringwald
362ba156408SMatthias Ringwald### Fixed
363ba156408SMatthias Ringwald- SM: prevent random address updates if gap_random_address_set was used
364ba156408SMatthias Ringwald- SM: fix internal buffer overrun that can cause storing of bonding information to fail
365aacfafc3SMatthias Ringwald- SM: ignore Slave Security Request after sending own Pairing Request
36664cb054cSMatthias Ringwald- L2CAP: fix use after free on disconnect if ERTM is enabled
367472a1e5fSMilanka Ringwald- HFP: Handle multiple commands/responses in single RFCOMM packet
368a2673d88SMatthias Ringwald- Memory Pools: clear all buffers before use
369ba156408SMatthias Ringwald
3706d27add1SMatthias Ringwald---
3716d27add1SMatthias Ringwald
372ba156408SMatthias Ringwald## Changes October 2018
373ba156408SMatthias Ringwald
374ba156408SMatthias Ringwald### Added
3752b6d34f4SMatthias Ringwald- SDP Server: queue incoming connections when already connected instead of rejecting them
376f8ee3071SMatthias Ringwald- 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.
377b8d0d014SMilanka Ringwald- HIDS Device: GATT service that exposes HID reports intended for HID Devices, like keyboard and mouse.
3782b6d34f4SMatthias Ringwald
379ef07b2dcSMatthias Ringwald### Fixed
3802c123282SMatthias Ringwald- HCI: fix bug in gap_inquiry_stop that triggered additional GAP_EVENT_INQUIRY_COMPLETE instead of stopping the inquiry
381ef07b2dcSMatthias Ringwald- L2CAP: fix issue with outgoing connection before read remote supported complete when other channels exist
382826c39d0SMatthias Ringwald- L2CAP ERTM: allow SDU of szie MPS in first packet that contains L2CAP SDU Length
3833b81f0d3SMatthias Ringwald- L2CAP ERTM: fix memory corruption triggered if local_mtu > mps
384a8409e80SMatthias Ringwald- L2CAP ERTM: fix outgoing fragment management
3854960f9e7SMatthias Ringwald- HFP: decline incoming RFCOMM connection after outgoing connection was started
38636680482SMatthias Ringwald- AVRCP: fix crash on disconnect of connection established by remote
387ece97caeSMatthias Ringwald
3886d27add1SMatthias Ringwald---
3896d27add1SMatthias Ringwald
390ece97caeSMatthias Ringwald## Changes September 2018
391ece97caeSMatthias Ringwald
392ece97caeSMatthias Ringwald### Fixed
393b402b8bdSMatthias Ringwald- HCI: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled
394b402b8bdSMatthias Ringwald- L2CAP: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled
395cce308d6SMatthias Ringwald- L2CAP: Evaluate 'can send now' on HCI Disconnect as ACL buffers in Bluetooth Controller have been used for the closed connection are freed implicitly
39693d791b2SMatthias Ringwald- L2CAP: Check can send now before sending extended information requeste needed for ERTM mode
397fe8aebe6SMatthias Ringwald- L2CAP: Use valid signaling identifier for L2CAP Connection Parameter Update Request
398b402b8bdSMatthias Ringwald- 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
399b402b8bdSMatthias Ringwald- RFCOMM: Avoid use-after-free on channel finalize
400b402b8bdSMatthias Ringwald- GATT Client: stop timer on disconnect - fixes use after free / crash
401eea99214SMatthias Ringwald
402cfd2437eSMatthias Ringwald### Added
403cfd2437eSMatthias Ringwald- A2DP Source: Support stream reconfiguration (a2dp_source_reconfigure_stream_sampling_frequency)
404b402b8bdSMatthias Ringwald- 3rd-party: yxml is used for PBAP vCard list parsing
405b402b8bdSMatthias Ringwald- cc256xC: new v1.1 init scripts
406cfd2437eSMatthias Ringwald
4076d27add1SMatthias Ringwald---
4086d27add1SMatthias Ringwald
409eea99214SMatthias Ringwald## Changes August 2018
410ece97caeSMatthias Ringwald
4113a7447a3SMatthias Ringwald### Added
4123a7447a3SMatthias Ringwald- PBAP: added pbap_get_phonebook_size() to get phonebook entry count
4133a7447a3SMatthias Ringwald
4149be4aecfSMatthias Ringwald### Fixed
4159be4aecfSMatthias Ringwald- GATT Server: Allow enable Notifications/Indication with Write Command. Fixes issue with some Android devices.
416f55bd529SMatthias Ringwald- SM: fix pairing for Secure Connections with Bonding if remote sends additional keys
417f55bd529SMatthias Ringwald- SM: drop LTK flag from Pairing Response for Secure Connections
418f299206dSMatthias Ringwald- L2CAP: fix emitted L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_REQUEST
4199be4aecfSMatthias Ringwald
4209be4aecfSMatthias Ringwald## Changes June 2018
4219be4aecfSMatthias Ringwald
42284dcd8f6SMatthias Ringwald### Added
42384dcd8f6SMatthias Ringwald- btstack_audio.h: application level API for audio playback and recording
42484dcd8f6SMatthias Ringwald- embedded/hal_audio.h: low-level API for audio playback and recording
42584dcd8f6SMatthias Ringwald- HID Device: hid_device_connect(..) function
42684dcd8f6SMatthias Ringwald- ESP32: implement hal_audio
42784dcd8f6SMatthias Ringwald- DA14585: support for Dialog Semiconductor DA14585 LE-only controller
428740eb56eSMatthias Ringwald- Raspberry Pi 3 + Raspberry Pi Zero W port in port/raspi
42984dcd8f6SMatthias Ringwald
430c085d9ffSMatthias Ringwald### Changed
431d2ac4310SMatthias Ringwald- Errata 10734:
432c085d9ffSMatthias Ringwald  - SM: Generate new EC Public Keypair after each pairing
433d2ac4310SMatthias Ringwald  - SM: Abort failure with DHKEY_CHECK_FAILED if received public key is invalid (instead of unspecified error)
43484dcd8f6SMatthias Ringwald- btstack.h: only include classic headers if ENABLE_CLASSIC is defined
43584dcd8f6SMatthias Ringwald- windows: ignore virtual Bluetooth adapter provided by VMware
436fc6cde64SMatthias Ringwald- Replaced HCI_PACKET_BUFFER_SIZE with HCI_INCOMING_PACKET_BUFFER_SIZE and HCI_OUTGOING_PACKET_BUFFER_SIZE
437c085d9ffSMatthias Ringwald
4386d27add1SMatthias Ringwald---
4396d27add1SMatthias Ringwald
440c085d9ffSMatthias Ringwald## Changes June 2018
441c085d9ffSMatthias Ringwald
442c085d9ffSMatthias Ringwald### Fixed
44342bafa11SMatthias Ringwald- HFP: Fix Wide Band Speech bit in SDP record for both HF/AG. Missing bit prevents macOS from using mSBC
444bce48a26SMatthias Ringwald- ATT Server: send ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE with status ATT_HANDLE_VALUE_INDICATION_DISCONNECT on disconnect
4451c7ac872SMatthias Ringwald- AVRCP Controller: fix parsing of now playing info
44642bafa11SMatthias Ringwald
447c085d9ffSMatthias Ringwald### Changed
4485d07396bSMatthias Ringwald- ATT Server: ATT_HANDLE_VALUE_INDICATION_DISCONNECT is delivered to service handler if registered
4495d07396bSMatthias Ringwald
450c085d9ffSMatthias Ringwald### Added
4515d07396bSMatthias Ringwald- ATT Server: packet handler field added to att_service_handler_t to receive: connect/disconnect, atu exchange, indication complete
4525d07396bSMatthias Ringwald
4536d27add1SMatthias Ringwald---
4546d27add1SMatthias Ringwald
45542bafa11SMatthias Ringwald## Changes May 2018
45642bafa11SMatthias Ringwald
45790e1375eSMatthias Ringwald### Added
458895588b9SMatthias Ringwald- GAP: re-encrypt outgoing connection if bonded
459895588b9SMatthias Ringwald- ATT Server: wait until re-encryption is complete
460895588b9SMatthias Ringwald- GATT Client: wait until re-encryption is complete
461cbbb12d9SMatthias Ringwald- ATT Server: added att_server_request_to_send_notification and att_server_request_to_send_indication
462f4b33574SMatthias Ringwald- GATT Client: if ENABLE_GATT_CLIENT_PAIRING, GATT Client starts pairing and retry operation on security error
463eddc894fSMatthias Ringwald
464eddc894fSMatthias Ringwald### Changed
465cbbb12d9SMatthias Ringwald- ATT Server: att_server_register_can_send_now_callback is deprecated, use att_server_request_to_send_notification/indication instead
466eddc894fSMatthias Ringwald
467eddc894fSMatthias Ringwald### Fixed
468eddc894fSMatthias Ringwald- SM: Fix LE Secure Connection pairing in Central role
4699650eb2fSMatthias Ringwald- le_device_db_tlv: fix seq nr management
470c7e2c1a5SMatthias Ringwald- SM: improve le_device_db lookup and storing of IRK
471b58c6eb9SMilanka Ringwald- GATT Server: fix lookup for Client Characteristic Configuration in services with multiple Characteristics
47223646753SMatthias Ringwald- RFCOMM: emit channel closed on HCI/L2CAP disconnect after sending DISC while expecting UA
473eddc894fSMatthias Ringwald
4746d27add1SMatthias Ringwald---
4756d27add1SMatthias Ringwald
476eddc894fSMatthias Ringwald## Changes April 2018
477eddc894fSMatthias Ringwald
478eddc894fSMatthias Ringwald### Added
479e85c3cceSMatthias Ringwald- Crypto: btstack_crypo.h provides cryptographic functions for random data generation, AES128, EEC, CBC-MAC (Mesh)
4802b0d89b5SMatthias Ringwald- SM: support pairing using Out-of-Band (OOB) data with LE Secure Connections
481ad2a4692SMatthias Ringwald- Embedded: support btstack_stdin via SEGGER RTT
4822b0d89b5SMatthias Ringwald
4832b0d89b5SMatthias Ringwald### Changed
484ff04bac7SMatthias Ringwald- att_db_util: added security requirement arguments to characteristic creators
485e85c3cceSMatthias Ringwald- SM: use btstack_crypto for cryptographpic functions
48645a58b30SMatthias Ringwald- GAP: security level for Classic protocols (asides SDP) raised to 2 (encryption)
4872b0d89b5SMatthias Ringwald
4882b0d89b5SMatthias Ringwald### Fixed
48984e7d3b9SMatthias Ringwald- HFP: fix answer call command
49084e7d3b9SMatthias Ringwald- HCI: fix buffer overrun in gap_inquiry_explode
49184e7d3b9SMatthias Ringwald- SDP: free service record item on sdp_unregister_service
4922b0d89b5SMatthias Ringwald
4932b0d89b5SMatthias Ringwald## Changes March 2018
4942b0d89b5SMatthias Ringwald
4952b0d89b5SMatthias Ringwald### Added
496acaa7cdaSMatthias Ringwald- GAP: allow to limit number of connections in LE Peripheral role with gap_set_max_number_peripheral_connections
497acaa7cdaSMatthias Ringwald- ATT Server: support for delayed ATT read response, see example/att_delayed_read_response.c
498acaa7cdaSMatthias Ringwald- ATT Server: allow to specify security requirements seperately for read/writes. .h files need to be regenerated
4992b6ab3e6SMatthias Ringwald
5002b6ab3e6SMatthias Ringwald### Fixed
50185847a9dSMatthias Ringwald- RFCOMM: fix infinite loop on L2CAP connection error (regression from 4c3eeed1)
5028c900791SMilanka Ringwald- HSP HS: accept incomming SCO connection
50386099d93SMatthias Ringwald- SM: fix iteration over LE Device DB entries for bonding and address resolving
50427ef8bc8SMatthias Ringwald- SM: store pairing information only if both devices have requested bonding
5052b6ab3e6SMatthias Ringwald
5066d27add1SMatthias Ringwald---
5076d27add1SMatthias Ringwald
5082b6ab3e6SMatthias Ringwald## Changes February 2018
5092b6ab3e6SMatthias Ringwald
5102b6ab3e6SMatthias Ringwald### Added
51158dff967SMatthias Ringwald- GATT Client: gatt_client_request_can_write_without_response_event() causes GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE
51258dff967SMatthias Ringwald- SM: new event SM_EVENT_PAIRING_COMPLETE
51358dff967SMatthias Ringwald- GAP: support iteration over stored Classic link keys: gap_link_key_iterator_init, gap_link_key_iterator_get_next, gap_link_key_iterator_done
51458dff967SMatthias Ringwald- GAP: add gap_delete_all_link_keys
515bf00e4aaSMatthias Ringwald
516bf00e4aaSMatthias Ringwald### Changed
51758dff967SMatthias Ringwald- GATT Client: round robin for multiple connections
51858dff967SMatthias Ringwald- ATT Dispatch: round robin for ATT Server & GATT Client
51958dff967SMatthias Ringwald- L2CAP: round robin for all L2CAP channels (fixed and dynamic)
52058dff967SMatthias Ringwald- btstack_link_key_db: addition functions for link key iteration
5216fab74dbSMatthias Ringwald- GAP: LE scanning enabled not reset on HCI Reset -> can be enabled before HCI Power Up
5228c41f31fSMatthias Ringwald- CSR: set all keys in psram instead of default
523bf00e4aaSMatthias Ringwald
524bf00e4aaSMatthias Ringwald### Fixed
52558dff967SMatthias Ringwald- tc3556x: fix startup after baud rate change
52658dff967SMatthias Ringwald
5276d27add1SMatthias Ringwald---
52858dff967SMatthias Ringwald
52958dff967SMatthias Ringwald## Changes January 2018
53058dff967SMatthias Ringwald
53158dff967SMatthias Ringwald### Added
53258dff967SMatthias Ringwald- Port for Windows with Zephyr HCI Firmware connected via serial port
53358dff967SMatthias Ringwald- em9304: upload patch containers during HCI bootup
53458dff967SMatthias Ringwald- Makefile for STM32-F4Discovery port
53558dff967SMatthias Ringwald- support for console out via SEGGER RTT
536c9748298SMatthias Ringwald- LE Data Channels example in BTstack and [iOS example on GitHub](https://github.com/bluekitchen/CBL2CAPChannel-Demo)
53758dff967SMatthias Ringwald- LE Streamer Client can send as fast as possbile as well
53858dff967SMatthias Ringwald- L2CAP: option to limit ATT MTU via l2cap_set_max_le_mtu
53958dff967SMatthias Ringwald
54058dff967SMatthias Ringwald### Changed
54158dff967SMatthias Ringwald- HCI: allow to set hci_set_master_slave_policy (0: try to become master, 1: accept slave)
54258dff967SMatthias Ringwald- GAP: gap_set_connection_parameters includes scan interval and window params
54358dff967SMatthias Ringwald- GATT Client: GATT_EVENT_MTU indicates max MTU
54458dff967SMatthias Ringwald- ATT DB Util: attribute handle is returned for new Services and Characteristics
54558dff967SMatthias Ringwald
54658dff967SMatthias Ringwald### Fixed
54758dff967SMatthias Ringwald- Windows: retry serial port operations if not all bytes have been read/written
54858dff967SMatthias Ringwald- HFP: avoid buffer overflows setting up messages
54958dff967SMatthias Ringwald- SBC Decoder: improved error handling for invalid SBC audio data
55058dff967SMatthias Ringwald- GAP: fix Connection Parameter Response in Central role
55158dff967SMatthias Ringwald- ATT DB Util: update pointer to database in case of realloc
55258dff967SMatthias Ringwald- GATT Client: set UUID16 field if 16-bit UUID is stored as UUID128
55358dff967SMatthias Ringwald- GAP: release HCI Connnection after gap_le_conne
55458dff967SMatthias Ringwald- ATT: Exchanged MTU is propagate to ATT Server and GATT Client
55558dff967SMatthias Ringwald
5566d27add1SMatthias Ringwald---
557bf00e4aaSMatthias Ringwald
558bf00e4aaSMatthias Ringwald## Changes December 2017
559bf00e4aaSMatthias Ringwald
560bf00e4aaSMatthias Ringwald### Added
56190e1375eSMatthias Ringwald- Introduced btstack_network.h network interface abstraction
56290e1375eSMatthias Ringwald- btstack_network_posix implementation using Linux tun/tap interface
563012f145fSMatthias Ringwald- WICED: support for btstack_stdin (HAVE_STDIN)
564bb07b204SMatthias Ringwald- 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.
565744e5470SMatthias Ringwald- TLV: global TLV instance available via btstack_tlv_get_instance() (src/btstack_tlv.h)
566b379648aSMatthias Ringwald- TLV: POSIX implementation that appends to a file on disk (platform/posix/btstack_tlv_posix.c
567b379648aSMatthias Ringwald- LE Device DB TLV: overwrite oldest entry if no free entries available
5684b8c611fSMatthias Ringwald- SM: allow to set fixed passkey in display role using sm_use_fixed_passkey_in_display_role
569b379648aSMatthias Ringwald- Example/hid_host_demo with HID parser and support for basic US keyboard layout
570b379648aSMatthias Ringwald- 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
571b379648aSMatthias Ringwald- Port for Apollo2 MCU with EM9304 (ports/apollo2-em9304)
57290e1375eSMatthias Ringwald
57390e1375eSMatthias Ringwald### Changed
57490e1375eSMatthias Ringwald- panu_demo: uses btstack_network.h now
575012f145fSMatthias Ringwald- WICED: configure printf to replace Linefeed with CRLF
576b379648aSMatthias Ringwald- SBC: split btstack_sbc_bludroid.c into seperate encoder and decoder implementations
577c385947dSMatthias Ringwald
578bf00e4aaSMatthias Ringwald### Fixed
579c385947dSMatthias Ringwald- RFCOMM: support connection requests during connection failure
580c385947dSMatthias Ringwald- L2CAP: support connection requests during connection failure
581b379648aSMatthias Ringwald- L2CAP: fix default remote MTU as 672 instead of 48 (Minimal MTU)
582c385947dSMatthias Ringwald- HCI: avoid double free during halting
583b379648aSMatthias Ringwald- SM: fixed reconnect using legacy pairing in slave role
584b379648aSMatthias Ringwald
585c385947dSMatthias Ringwald
586