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