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