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