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