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