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