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