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