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