xref: /btstack/CHANGELOG.md (revision 98451c7b102094e15e0a72ca2f7098d91aed2017)
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
12HCI: `btstack_transport_sco.h` allows to support SCO over physical PCM/I2S interface (`HAVE_SCO_TRANSPORT`)
13POSIX: `btstack_transport_sco_i2s_test_bridge.c` implements SCO transport interface for UART-to-I2S test bridge
14btstack_uart: `btstack_uart_t` interface extends `btstack_uart_block_t`:
15  - supports sending and receiving SLIP frames for HCI H5
16  - suppports odd parity as well
17  - `hci_transport_h4` and chipset drivers have new functions to pass provide `btstack_uart_t`
18
19btstack_uart_slip_wrapper: wrapper that implements SLIP functionality for existing `btstack_uart_block` drivers.
20hci_transport: add parity field and pass on to `btstack_uart_t` in h4 and h5
21GATT Client: Battery Service Client
22GATT Client: Device Information Service Client
23GATT Client: Scan Parameters Service Client
24GAP: add gap_set_page_scan_activity and gap_set_page_scan_type
25
26### Fixed
27HCI: handle start inquiry failure
28
29### Changed
30HCI: config I2S for BCM Controllers if `ENABLE_SCO_OVER_PCM`, reduce bit clock to 256/512 kHz
31btstack_uart_posix: supports SLIP frames and replaces `btstack_uart_block_posix`
32hci_transport_h5: new more performant H5 implementation that requires `btstack_uart_t` driver with SLIP support.
33POSIX Ports: use new `btstack_uart_posix` implementation
34posix-h5/posix-h5-bcm: use even parity for UART
35Port Archive: moved ports that are not recommended for new designs to port/archive folder:
36  - MSP430: the ports used the older community GCC version without 20-bit support needed for code size > 64kB
37  - Broadcom/Cypress H5: uploading PatchRAM is only possible in H4 mode. It's better to also use H4 in general
38  - PIC32-Harmony: the port used Harmony v1 while Harmony v3 has been out since a while.
39Run Loop Base: functionality used in most platform run loop implementations
40  - code from `btstack_run_loop_base.c` moved into `btstack_run_loop.c` to minimize changes to build systems
41  - `btstack_run_loop_base.c` is a placeholder and can be removed from build
42
43## Release v1.3.2
44
45### Added
46GAP: support for Classic Out-of-Band (OOB) pairing via `gap_ssp_remote_oob_data` with `ENABLE_CLASSIC_OOB_PAIRING`
47GAP: read local OOB data on start and on call to `gap_ssp_generate_oob_data`, provided via `GAP_EVENT_LOCAL_OOB_DATA`
48HID Host: add profile, update `hid_host_demo.c` example
49
50### Fixed
51L2CAP: make handling of HCI disconnect more robust
52AVDTP: emit stream release for active stream if signaling connection is closed first, e.g. caused by HCI disconnect
53AVRCP: fix issue when Controller and Target send at the same time
54
55### Changed
56A2DP, AVDTP: use `a2dp_source_set_config_{TYPE}` and `avdtp_config{TYPE}_store` to avoid large number of parameters
57
58
59## Release v1.3
60
61### Added
62CC256x: with ENABLE_CC256X_ASSISTED_HFP, HFP enables WBS codec on demand and configures PCM/I2S interface for 8kH/16kHz
63BCM: with ENABLE_BCM_PCM_WBS, HFP enables WBS codec on demand and configures PCM/I2S interface for 8kH/16kHz
64SDP Client RFCOMM: add `sdp_client_query_rfcomm_channel_and_name_for_service_class_uuid`
65HFP: `ENABLE_HFP_AT_MESSAGES` lets HFP emit  `HFP_SUBEVENT_AT_MESSAGE_SENT` and `HFP_SUBEVENT_AT_MESSAGE_RECEIVED`
66A2DP, AVDTP: provide capabilities and configuration events for A2DP codecs: SBC, MPEG Audio, MPEG AAC, ATRAC
67A2DP + AVDTP Source: allow to send media packet with `avdtp_source_stream_send_media_packet` and `a2dp_source_stream_send_media_packet`
68A2DP + AVDTP Source: add `avdtp_source_stream_send_media_payload_rtp` and `a2dp_source_stream_send_media_payload_rtp`
69A2DP Source: emit `A2DP_SUBEVENT_SIGNALING_CAPABILITIES_COMPLETE`
70A2DP Source: allow to configure endpoints by calling `a2dp_source_set_config_{TYPE}` during SEP discovery with SBC fallback
71
72### Fixed
73HCI: keep `le connecting request` on connection complete active, fixes gap_auto_connection_stop() + gap_auto_connection_start()
74L2CAP: fix packet size check for incoming classic basic channels (regression introduced in v1.2.1)
75HFP AG/HSP AG: avoid connecting to remote service with same role
76A2DP Source: support multiple Stream Endpoints with different Media Codec types
77A2DP Source: emit codec configure event with reconfigure flag set on reconfigure
78GATT Compiler: support multiple instances of the same service
79
80### Changed
81GAP: provide Link Type parameter to incoming connection filter for `gap_register_classic_connection_filter`
82HFP/GOEP Client/AVDTP/A2DP: return `SDP_SERVICE_NOT_FOUND` if no suitable SDP record is found
83AVDTP Source: `avdtp_source_stream_send_media_payload` includes SBC Header and was deprecated
84AVDTP/A2DP: use `avdtp_channel_mode_t` in `A2DP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION`
85A2DP: fix events and use `a2dp_cid`, `local_seid,` `remote_seid` field names in A2DP sub-events
86GATT Client: Skip MTU exchange after MTU exchange on ATT Server
87Ports: STM32-F103RB Nucleo + CC256x port removed
88ESP32: enabled HFP Wide-Band Speech, disable classic secure connections in HSP/HFP demos
89
90
91## Release v1.2.1
92
93### Fixed
94- L2CAP: use connection handle for channel lookups
95- L2CAP: forward data only in open state
96
97### Changed
98- L2CAP: check packet size against local mtu for classic basic channels
99
100
101## Release v1.2
102
103### Fixed
104- L2CAP: trigger pairing for outgoing LE Data Channels if security level insufficient
105- SM: fix update of sc flag for re-encrypted connection in peripheral role
106- SM: send security request on re-connect if bonded and `ENABLE_LE_PROACTIVE_AUTHENTICATION` is defined
107- ESP32: fix audio sink driver
108
109### Added
110- GAP: `gap_delete_bonding` removes device from LE Resolving List and from discards LE bonding information
111- GATT Client: delete bonding information if re-encryption fails and `ENABLE_LE_PROACTIVE_AUTHENTICATION` is not defined
112- GATT Client: gatt_client_set_required_security_level() allows to set required minimum security level for all GATT requests
113- SM: emit events for re-encryption started/complete when bonding information is available
114
115### Changed
116- AVRCP Controller: allow to send multiple absolute volume commands without waiting for response.
117- GAP: replaced `ENABLE_LE_CENTRAL_AUTO_ENCRYPION` with `ENABLE_LE_PROACTIVE_AUTHENTICATION`
118
119
120## Changes October 2020
121
122### Fixed
123- AVDTP Initiator: avoid use of remote seid for stream endpoint lookup, fixes issue with two connected devices
124- AVDTP Source: buffer for SBC media codec information got discarded, leading to invalid Set Configuration command in second connection
125- SM: only trigger Cross-Transport Key Derivation (CTKD) when bonding is enabled
126- SM: set LinkKey flag to request CTKD if enabled
127- SM: store CTKD key with Public Identity Address
128- SM: only allow CTKD to overwrite existing link key if derived key has same or higher authentication
129- SM: start SMP Timeout when sending Security Request
130- HFP HF: fix response to AG Codec Selection while waiting for OK of parallel command
131- HCI: fix reject of LE remote connection param request via HCI
132
133### Added
134- GAP: add `gap_get_link_key_for_bd_addr`
135- GAP: add `gap_bonded` to check if bonding information is available for active connection
136- SM: support h7 for CTKD
137
138### Changed
139- SM: Cross-Transport Key Derivation requires `ENABLE_CROSS_TRANSPORT_KEY_DERIVATION` now
140- SM: block connection if encryption fails for bonded devices as Central
141- SM: support pairing as Central after failed re-ecnryption
142
143
144## Release v1.1
145
146### Fixed
147- AVRCP/AVCTP: report AVRCP 1.6 and AVCTP 1.4 in SDP record
148
149### Added
150
151### Changed
152
153
154## Changes September 2020
155
156### Fixed
157- HFP: fix parsing of ranges e.g. in +CIND responses
158- AVDTP, AVRCP: fix bugs due to transaction id overrun
159- A2DP Source: fix issues with stream configuration by sink
160- hci_dump: fix tv_us calculation for non-posix / embedded systems with binary output
161
162### Added
163- `btstack_ring_buffer`: add `btstack_ring_buffer_reset` to reset it to initial state/empty
164- GAP: Support for address resolution of resolvable private addresses by Controller with `ENABLE_LE_PRIVACY_ADDRESS_RESOLUTION`
165
166### Changed
167- AVDTP, AVRCP, HSP: schedule SDP query, avoids avoids 'command disallowed' if SDP client is busy
168- HSP, HFP: allow to configure usable SCO packet types
169- cc256x: update CC256xC init script to v1.4
170- A2DP Source: use Get All Capabilities if supported by remote get Delay Reporting capability
171
172## Changes August 2020
173
174### Fixed
175- ESP32: fix authentication for incoming Secure Connections
176- AVDTP: Fix forwarding of Delay reports
177- STM32-F4Discovery: fix pan_lwip_http_server by increasing HCI_ACL_PAYLOAD_SIZE
178- tool/create_packet_log: basic support for 16-bit Unicode log files from Windows
179
180### Added
181- `btstack_run_loop_base`: added `btstack_run_loop_base_dump_timer`
182- GAP: request role change for classic connection via `gap_request_role`
183- GAP: LE Whitelist API with `gap_le_whitelist_x` with x = add, remove, clear and new `gap_connect_with_whitelist`
184- SDP Client: add sdp_client_register_query_callback() allows to register query request instead of polling sdp_client_ready()
185- BNEP lwIP: add `bnep_lwip_connect` to establish BNEP connection and manage lwIP network interface
186- New `btstack_linked_queue` utility, a linked list-based queue with first-in-first-out semantics and constant time enqueue/dequeue operations
187- btstack_tlv_posix: add `btstack_tlv_posix_deinit`
188- New `btpclient` for use with [auto-pts project](https://github.com/intel/auto-pts)
189
190### Changed
191- GAP: treat AES-CCM encrypted connection as mutually authenticated (BIAS)
192- GAP: 'gap_auto_connect_x' API deprecated. Please direclty manage LE Whitelist with `gap_le_whitelist_*` functions and call `gap_connect_with_whitelist` instead
193- example/hid_host_demo: try to become master for incoming connections
194- btstack_run_loop: use btstack_assert instead of local while(true)
195- att_db_util: allow to reset att_db via `att_db_util_init`
196
197## Changes July 2020
198
199### Fixed
200- AVDTP: fix invalid response for Get Capabilities request if Delay Reporting was supported
201- AVDTP: handle concurrent signaling establishment with reject and retry
202
203### Added
204- example/hid_host_demo: support reconnect from HID device
205- Crypto: support software AES128 for AES-CCM operations
206- AVRCP: introduced AVRCP_FEATURE_MASK_* as alternative to avrcp_controller_supported_feature_t and avrcp_target_supported_feature_t enums
207- btstack_audio: add set_volume() to sink and set_gain() to source interfaces, minimal volume control for portaudio playback
208- 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
209- GAP: Provide gap_get_role to query master/slave role for HCI connection handle
210- GAP: Provide gap_pin_code_response_binary to use binary data as PIN, e.g. for pairing with Nintendo Wii Remote
211
212### Changed
213- GAP: set minimum required encryption key size for Classic connections back from 16 to 7, matching the Core spec
214
215
216## Changes June 2020
217
218### Fixed
219- HFP: Fix parsing of empty fields, e.g. phone number in +CLCC and other AT commands
220- SM: Fix validation of confirm value for secure connection Passkey entry
221- AVRCP: handle concurrent signaling establishment with reject and retry
222
223### Added
224- GAP: Detect Secure Connection -> Legacy Connection Downgrade Attack by remote features and actual encryption type (BIAS)
225- GAP: Mutual authentication: request authentication after Classic connection got encrypted (BIAS)
226- Windows port for Dialog DA14585 connected via serial port
227
228## Changes
229- CVSD PLC: treat zero frames as good and allow to mark data as bad, e.g. if reported by Controller as erroneous
230
231## Changes May 2020
232
233### Fixed
234- hfp_hf, hsp_hs: use eSCO params in accept sco connection only for incoming eSCO connections
235- pbap_client: fix PBAP UUID len on connect message
236- SM: fix secure connection pairing as peripheral when local user confirmation happens after remote one
237- A2DP Source: only connect to remote sink stream endpoints
238- btstack_hal_flash_memory: fix write of 0xff bytes to simulated flash
239- hsp_hs: fix disconnect if audio not connected
240- hsp_ag: fix accept incoming connection
241
242### Added
243- example/le_mitm: MITM implementation that forwards ATT PDUs and allows for pairing
244- GAP: gap_set_security_level sets required security level for incoming and outgoing connections
245- cc256x: allow to specify power vector for each modulation type
246- FreeRTOS: btstack_run_loop_freertos_trigger_exit allows to request run loop exit
247- SM: support LE Secure Connections Only mode with sm_set_secure_connections_only_mode
248- GAP: enable BR/EDR Secure Connections if supported, add gap_secure_connections_enable
249
250### Changed
251- L2CAP ERTM: send extended features request only once per HCI connection
252
253
254## Changes April 2020
255
256### Fixed
257- hog_mouse_demo/hog_keyboard_demo: handle set protocol mode = boot protocol mode
258- HCI: only update BD_ADDR placeholder in shortened and complete name in EIR data, limit device name to 240/248 bytes
259
260### Added
261- GAP: gap_set_allow_role_switch allows to prevent role switch in outgoing classic ACL connections
262- example: hog_boot_host_demo implements an HID-over-GATT Boot Host that supports keyboard and mouse
263- HCI: add ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS that forces fragmentation of ACL-LE packets to fit into over-the-air packet
264
265### Changed
266- Broadcom/Cypress: wait 300 ms after PatchRAM update in hci.c to assert Controller is ready
267- esp32: provide esp-idf/component/btstack/btstack_port_esp32.c and only minimal app_main in template/main/main.c
268- att_db: skip att_read_callback for ATT Read Blob Request if offset == value_len
269
270
271## Changes March 2020
272
273### Fixed
274- GAP: fixed gap_set_scan_parameters() if issued right before gap_start_scan()
275- HCI: only send HCI Read Local Encryption Key Size if supported by Controller
276
277### Added
278- GATT Client: allow to register for any notification/indication and/or any connection
279- HCI: added hci_read_inquiry_scan_activity and hci_write_inquiry_scan_activity commands
280- chipset: assert hci packet buffers are suitable for firmware upload or patches (atwilc3000,bcm,cc256x,intel)
281- btstack_util: added btstack_replace_bd_addr_placeholder
282
283### Changed
284- AVRCP Target: volume in avrcp_target_volume_changed is reported as current value in interim response to register for volume change notifications
285- SDP Client: query attributes 0x0000..0xffff instead of 0x0001..0xffff to match other stacks / improve compatibility with bad sdp server implementations
286
287
288## Changes Februar 2020
289
290### Fixed
291- AVRCP Target: fix reporting of PLAYBACK_STATUS_CHANGED
292- HCI: handle reconnect request for Classic and LE connections triggered by packet handler for Disconnection Complete Event
293
294### Changed
295- hid_host_mode: allow sniff mode
296
297### Added
298- 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
299
300
301## Changes January 2020
302
303### Fixed
304- L2CAP ERTM: avoid read-after-free on decline of incoming connection
305- GATT Client: set uuid16 to zero when deserializing uuid128 services, characteristics, and descriptors
306- att_db_util: fix realloc of att db buffer for large attributes
307- btstack_tlv_posix: only keep last value in memory, fix delete operation
308- l2cap_signaling: use packet boundary flags 0x00 for LE signaling packets (ignoring hci_non_flushable_packet_boundary_flag_supported())
309
310### Added
311- att_db_util: provide GATT Database Hash via att_db_util_hash_calc
312- GATT Compiler: provide GATT Database Hash via GATT_DATABASE_HASH Characteristic
313- ATT Server: validate request pdu length
314
315### Changed
316- Crypto: update AES-CMAC implementation to access all message bytes sequentially
317
318
319## Changes December 2019
320
321### Fixed
322- example/pan_lwip_http_server: use Network Access Point, CoD
323- sm: emit pairing complete in master role when no keys are distributed / bonding disabled
324
325### Added
326
327### Changed
328- Updated CC256x initscript: CC256xC v1.3
329- ESP32: add CMake project files
330
331
332## Changes November 2019
333
334### Fixed
335- AVDTP Source: return correct `avdtp_cid` and `local_seid` in `AVDTP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW`
336- L2CAP: send LE Data Channel SDUs round robin with other data
337- L2CAP ERTM: send ERTM I-frames round robin with other data
338
339### Added
340- ATT Server: return error if request to send now for Notification or Indication already registered
341- Linked List: return if item was added for `btstack_linked_list_add[_tail]`
342- btstack_run_loop_remove: return bool true if timer/data source was removed
343- segger-rtt: allow to configure with `SEGGER_RTT_PACKETLOG_*` directives, update to v6.54
344- GAP: support setting Link Supervision Timetout for outgoing Classic connections using `gap_set_link_supervision_timeout`
345- lwip: add download test files to http server demo
346
347### Changed
348- Linked List: return bool true if item was removed
349
350
351## Changes October 2019
352
353### Fixed
354
355### Added
356- `btstack_bool.h`: provide boolean type 'bool' via `<stdbool.h>` or as backport
357- provide `btstack_assert(condition)`
358- H4 Transport: avoid calling `hci_transport_h4_trigger_next_read` when transport is closed
359
360### Changed
361- libusb and posix ports: store bonding information in TLV
362
363
364## Changes September 2019
365
366### Fixed
367- L2CAP ERTM: assert that packet can be stored in fragment buffers in ertm
368- L2CAP ERTM: reject incoming connection if ERTM is configured as mandatory but not supported by remote
369- GATT Client: allow Write Without Response independent of other requests
370
371### Added
372- GAP: allow to reject GAP classic connection via gap_register_classic_connection_filter
373- GAP: support reading RSSI for Classic+LE using gap_read_rssi. Emits `GAP_EVENT_RSSI_MEASUREMENT`
374
375### Changed
376- Bluetooth and BTstack Error Codes and Events: collect status codes in bluetooth.h and events in btstack_defines.h
377- bluetooth.h: extract internal defintitions to respective protocol layers
378- Updated CC256x initscripts (CC256xB v1.8, CC256xC v1.2, CC256xC v1.2)
379
380
381## Changes August 2019
382
383### Fixed
384- POSIX, WICED, Windows, FreeRTOS run loops: handle time_ms overrun after 49 days
385- RFCOMM: accept incoming L2CAP connection in Basic mode if ERTM is enabled but not requested for this connection
386- RFCOMM: limit RFCOMM MTU by local L2CAP MTU for outgoing connections (only revelvant for ERTM)
387- L2CAP ERTM: stop timers on disconnect
388- L2CAP ERTM: fix sending of segmented SDUs
389- L2CAP ERTM: handle unsupported Information Response
390- SM: generate local nonce for confirm value in JW+NC+PK in Secure Connections Responder role
391
392### Added
393- `btstack_run_loop_base`: portable implementation of timer and data source management as base for platform specific implementations
394
395## Changed
396- FreeRTOS: use xQueueCreateStatic (static variant of xQueueCreate) if available for static memory-only setups
397- L2CAP ERTM: handle invalid Information Response (assume no extended features supported)
398- POSIX: use monotonic clock as timebase if available
399- HCI Transport H4/H5/EM9304 SPI: ignore block read/sent from UART driver when closed
400- HCI: Read Encryption Key Size after encryption was enabled
401- Errata 11838:
402  - GAP: gap_set_required_encryption_key_size allows to set the required key size, default = 16 (max)
403  - GAP: validate encryption key size to emit GAP Security Levels
404
405## Changes July 2019
406
407### Fixed
408- SM: Fixed regression introduced in f3582630
409- L2CAP: avoid reading l2cap signaling command len out of bounds
410- HCI Transport H4/H5/EM9304 SPI: fix payload size checks (also for 8/16-bit platforms)
411
412### Changed
413- SM: Start encryption upon receiving slave securiy request if bonded
414- hci: use 2 as HCI_INCOMING_PRE_BUFFER_SIZE in LE-only configuration for GATT Client
415
416---
417
418## Changes June 2019
419
420### Changed
421- FreeRTOS: use freertos/.. prefix to include FreeRTOS headers if HAVE_FREERTOS_INCLUDE_PREFIX is defined
422- BNEP: add Connection Handle to BNEP_EVENT_CHANNEL_OPENED
423- Examples: renamed le_counter to gatt_counter and le_streamer to le_streamer_server to indicate suppport for GATT over BR/EDR
424
425### Fixed
426- BNEP: Bluetooth address is stored in little-endian format for all BNEP_EVENT_*
427- libusb: avoid use-after-free for SCO packets on disconnect
428
429### Added
430- example: pan_lwip_http_server using lwIP as network stack to implement PAN NAP service
431- platform/lwip/bnep_lwip.c: BNEP lwIP adapter that forwards packets between BNEP service and lwIP
432- ENABLE_GATT_OVER_CLASSIC enables support for GATT over BR/EDR in att_server
433
434---
435
436## Changes May 2019
437
438### Changed
439- ESP32: Configure SCO over HCI after power up
440- btstack_tlv_flash_bank: support targets where a value cannot be overwritten with zero. When ENABLE_TLV_FLASH_EXPLICIT_DELETE_FIELD
441  is defined, an explicit delete field is used to indicate an invalid entry.
442
443### Fixed
444- SM: Avoid potential use-after-free on immediate disconnect (lookup connection via con handle instead of storing pointer)
445
446### Added
447- gatt_client: emit query complete event for signed write operation
448- hci_transport_h4: add workaround for flow control bug in CYW2070x, enable with ENABLE_CYPRESS_BAUDRATE_CHANGE_FLOWCONTROL_BUG_WORKAROUND
449
450---
451
452## Changes April 2019
453
454### Changed
455- ESP32: use micro-ecc from 3rd-party as esp-idf removed it in their 3.3 release
456
457### Fixed
458- hci: pad LE Scan response with zeroes
459- SM: store local CSRK
460- ATT DB: call write callback for validated signed writes
461- ATT Server: abort signed write validation on incoming new request
462- Bluetooth SIG web scraping tools updated
463- libusb: compiles for FreeBSD
464
465### Added
466
467---
468
469## Changes March 2019
470
471### Changed
472- use Makefile for stm32-f4discovery-cc256x port
473- le_device_db: add secure_connection argument to le_device_db_encryption_set and le_device_db_encryption_get
474
475### Fixed
476- SM: Use provided authentication requirements in slave security request
477
478### Added
479- port/stm32-f4discovery-cc256x: add support for built-in MEMS microphone
480- SM: Track if connection encryption is based on LE Secure Connection pairing
481- ATT DB: Validate if connection encrypted is based on SC if requested
482- att_db_util: support ATT_SECURITY_AUTHENTICATED_SC permission flag
483- GATT Compiler: support READ_AUTHENTICATED and WRITE_AUTHENTICATED permsission flags
484- ESP32: erase nvs flash is newer nvs version found
485- libusb: add support for nRF52840-PCA10056 running Zephyr hci_usb example
486- port/stm32-l073rz-nucleo-em9304 for Nucleo L073RZ with EM9304 DVK, replaces port/stm32-l053r8-nucleo-em9304
487
488## Changes February 2019
489
490### Changed
491- example/a2dp_sink_demo: use linear resampling to fix sample rate drift
492- btstack_audio: split interface into sink and source
493
494### Fixed
495- Crypto: fix lockup when stack is shutdown while waiting for result of HCI Command, e.g. LE Read Local P256 Public Key
496- SM: Avoid SM_EVENT_PAIRING_COMPLETE with ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION after successful pairing in responder role
497
498### Added
499- example/a2dp_sink_demo: add target role, support volume control on both devices
500- example/audio_duplex: playback audio audio source on audio sink (test audio path)
501- btstack_audio_embedded: implement audio source path
502
503---
504
505## Changes January 2019
506
507### Changed
508- L2CAP: provide channel mode (basic/ertm) and fcs option in L2CAP_EVENT_CHANNEL_OPENED
509- RFCOMM: support L2CAP ERTM. Callbacks passed to rfcomm_enable_l2cap_ertm() are used to manage ERTM buffers
510
511### Added
512- L2CAP: emit L2CAP_EVENT_ERTM_BUFFER_RELEASED if ERTM buffer not needed/used anymore
513- L2CAP: add fcs_option to ERTM config l2cap_ertm_config_t
514- HCI: validate advertisement data length field when generating GAP_EVENT_ADVERTISING_REPORT
515- ad_parser: validate data element length fields in ad_iterator_has_more
516- Raspberry Pi 3 A+/B+ port in port/raspi, starts without power cycle
517
518### Fixed
519- HCI: release outgoing buffer on disconnect if waiting to send another ACL fragment
520- POSIX: use correct baudrate enums for baud rates higher than 921600 (Linux)
521- Crypto: directly process queued crypto operation on HCI result
522
523---
524
525## Changes December 2018
526
527### Added
528- SM: generate and store ER / IR keys in TLV, unless manually set by application
529- hci_dump: support PacketLogger or BlueZ format output via SEGGER RTT Channel 1 Up
530
531### Fixed
532- SM: fix internal buffer overrun during random address generation
533
534## Changes November 2018
535
536### Added
537- GAP: gap_le_connection_interval provides connection interval for conn handle
538- Nordic SPP Service Server: GATT service that emulates a serial port over BLE based on Nordic Semiconductor documentation.
539- uBlox  SPP Service Server: GATT service that emulates a serial port over BLE based on uBlox documentation.
540- SM: ENABLE_LE_CENTRAL_AUTO_ENCRYPTION triggers automatic encryption on connect to bonded devices
541- SM: generate and store ER / IR keys in TLV, unless manually set by application
542
543### Fixed
544- SM: prevent random address updates if gap_random_address_set was used
545- SM: fix internal buffer overrun that can cause storing of bonding information to fail
546- SM: ignore Slave Security Request after sending own Pairing Request
547- L2CAP: fix use after free on disconnect if ERTM is enabled
548- HFP: Handle multiple commands/responses in single RFCOMM packet
549- Memory Pools: clear all buffers before use
550
551---
552
553## Changes October 2018
554
555### Added
556- SDP Server: queue incoming connections when already connected instead of rejecting them
557- 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.
558- HIDS Device: GATT service that exposes HID reports intended for HID Devices, like keyboard and mouse.
559
560### Fixed
561- HCI: fix bug in gap_inquiry_stop that triggered additional GAP_EVENT_INQUIRY_COMPLETE instead of stopping the inquiry
562- L2CAP: fix issue with outgoing connection before read remote supported complete when other channels exist
563- L2CAP ERTM: allow SDU of szie MPS in first packet that contains L2CAP SDU Length
564- L2CAP ERTM: fix memory corruption triggered if local_mtu > mps
565- L2CAP ERTM: fix outgoing fragment management
566- HFP: decline incoming RFCOMM connection after outgoing connection was started
567- AVRCP: fix crash on disconnect of connection established by remote
568
569---
570
571## Changes September 2018
572
573### Fixed
574- HCI: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled
575- L2CAP: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled
576- L2CAP: Evaluate 'can send now' on HCI Disconnect as ACL buffers in Bluetooth Controller have been used for the closed connection are freed implicitly
577- L2CAP: Check can send now before sending extended information requeste needed for ERTM mode
578- L2CAP: Use valid signaling identifier for L2CAP Connection Parameter Update Request
579- 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
580- RFCOMM: Avoid use-after-free on channel finalize
581- GATT Client: stop timer on disconnect - fixes use after free / crash
582
583### Added
584- A2DP Source: Support stream reconfiguration (a2dp_source_reconfigure_stream_sampling_frequency)
585- 3rd-party: yxml is used for PBAP vCard list parsing
586- cc256xC: new v1.1 init scripts
587
588---
589
590## Changes August 2018
591
592### Added
593- PBAP: added pbap_get_phonebook_size() to get phonebook entry count
594
595### Fixed
596- GATT Server: Allow enable Notifications/Indication with Write Command. Fixes issue with some Android devices.
597- SM: fix pairing for Secure Connections with Bonding if remote sends additional keys
598- SM: drop LTK flag from Pairing Response for Secure Connections
599- L2CAP: fix emitted L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_REQUEST
600
601## Changes June 2018
602
603### Added
604- btstack_audio.h: application level API for audio playback and recording
605- embedded/hal_audio.h: low-level API for audio playback and recording
606- HID Device: hid_device_connect(..) function
607- ESP32: implement hal_audio
608- DA14585: support for Dialog Semiconductor DA14585 LE-only controller
609- Raspberry Pi 3 + Raspberry Pi Zero W port in port/raspi
610
611### Changed
612- Errata 10734:
613  - SM: Generate new EC Public Keypair after each pairing
614  - SM: Abort failure with DHKEY_CHECK_FAILED if received public key is invalid (instead of unspecified error)
615- btstack.h: only include classic headers if ENABLE_CLASSIC is defined
616- windows: ignore virtual Bluetooth adapter provided by VMware
617- Replaced HCI_PACKET_BUFFER_SIZE with HCI_INCOMING_PACKET_BUFFER_SIZE and HCI_OUTGOING_PACKET_BUFFER_SIZE
618
619---
620
621## Changes June 2018
622
623### Fixed
624- HFP: Fix Wide Band Speech bit in SDP record for both HF/AG. Missing bit prevents macOS from using mSBC
625- ATT Server: send ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE with status ATT_HANDLE_VALUE_INDICATION_DISCONNECT on disconnect
626- AVRCP Controller: fix parsing of now playing info
627
628### Changed
629- ATT Server: ATT_HANDLE_VALUE_INDICATION_DISCONNECT is delivered to service handler if registered
630
631### Added
632- ATT Server: packet handler field added to att_service_handler_t to receive: connect/disconnect, atu exchange, indication complete
633
634---
635
636## Changes May 2018
637
638### Added
639- GAP: re-encrypt outgoing connection if bonded
640- ATT Server: wait until re-encryption is complete
641- GATT Client: wait until re-encryption is complete
642- ATT Server: added att_server_request_to_send_notification and att_server_request_to_send_indication
643- GATT Client: if ENABLE_GATT_CLIENT_PAIRING, GATT Client starts pairing and retry operation on security error
644
645### Changed
646- ATT Server: att_server_register_can_send_now_callback is deprecated, use att_server_request_to_send_notification/indication instead
647
648### Fixed
649- SM: Fix LE Secure Connection pairing in Central role
650- le_device_db_tlv: fix seq nr management
651- SM: improve le_device_db lookup and storing of IRK
652- GATT Server: fix lookup for Client Characteristic Configuration in services with multiple Characteristics
653- RFCOMM: emit channel closed on HCI/L2CAP disconnect after sending DISC while expecting UA
654
655---
656
657## Changes April 2018
658
659### Added
660- Crypto: btstack_crypo.h provides cryptographic functions for random data generation, AES128, EEC, CBC-MAC (Mesh)
661- SM: support pairing using Out-of-Band (OOB) data with LE Secure Connections
662- Embedded: support btstack_stdin via SEGGER RTT
663
664### Changed
665- att_db_util: added security requirement arguments to characteristic creators
666- SM: use btstack_crypto for cryptographpic functions
667- GAP: security level for Classic protocols (asides SDP) raised to 2 (encryption)
668
669### Fixed
670- HFP: fix answer call command
671- HCI: fix buffer overrun in gap_inquiry_explode
672- SDP: free service record item on sdp_unregister_service
673
674## Changes March 2018
675
676### Added
677- GAP: allow to limit number of connections in LE Peripheral role with gap_set_max_number_peripheral_connections
678- ATT Server: support for delayed ATT read response, see example/att_delayed_read_response.c
679- ATT Server: allow to specify security requirements seperately for read/writes. .h files need to be regenerated
680
681### Fixed
682- RFCOMM: fix infinite loop on L2CAP connection error (regression from 4c3eeed1)
683- HSP HS: accept incomming SCO connection
684- SM: fix iteration over LE Device DB entries for bonding and address resolving
685- SM: store pairing information only if both devices have requested bonding
686
687---
688
689## Changes February 2018
690
691### Added
692- GATT Client: gatt_client_request_can_write_without_response_event() causes GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE
693- SM: new event SM_EVENT_PAIRING_COMPLETE
694- GAP: support iteration over stored Classic link keys: gap_link_key_iterator_init, gap_link_key_iterator_get_next, gap_link_key_iterator_done
695- GAP: add gap_delete_all_link_keys
696
697### Changed
698- GATT Client: round robin for multiple connections
699- ATT Dispatch: round robin for ATT Server & GATT Client
700- L2CAP: round robin for all L2CAP channels (fixed and dynamic)
701- btstack_link_key_db: addition functions for link key iteration
702- GAP: LE scanning enabled not reset on HCI Reset -> can be enabled before HCI Power Up
703- CSR: set all keys in psram instead of default
704
705### Fixed
706- tc3556x: fix startup after baud rate change
707
708---
709
710## Changes January 2018
711
712### Added
713- Port for Windows with Zephyr HCI Firmware connected via serial port
714- em9304: upload patch containers during HCI bootup
715- Makefile for STM32-F4Discovery port
716- support for console out via SEGGER RTT
717- LE Data Channels example in BTstack and [iOS example on GitHub](https://github.com/bluekitchen/CBL2CAPChannel-Demo)
718- LE Streamer Client can send as fast as possbile as well
719- L2CAP: option to limit ATT MTU via l2cap_set_max_le_mtu
720
721### Changed
722- HCI: allow to set hci_set_master_slave_policy (0: try to become master, 1: accept slave)
723- GAP: gap_set_connection_parameters includes scan interval and window params
724- GATT Client: GATT_EVENT_MTU indicates max MTU
725- ATT DB Util: attribute handle is returned for new Services and Characteristics
726
727### Fixed
728- Windows: retry serial port operations if not all bytes have been read/written
729- HFP: avoid buffer overflows setting up messages
730- SBC Decoder: improved error handling for invalid SBC audio data
731- GAP: fix Connection Parameter Response in Central role
732- ATT DB Util: update pointer to database in case of realloc
733- GATT Client: set UUID16 field if 16-bit UUID is stored as UUID128
734- GAP: release HCI Connnection after gap_le_conne
735- ATT: Exchanged MTU is propagate to ATT Server and GATT Client
736
737---
738
739## Changes December 2017
740
741### Added
742- Introduced btstack_network.h network interface abstraction
743- btstack_network_posix implementation using Linux tun/tap interface
744- WICED: support for btstack_stdin (HAVE_STDIN)
745- 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.
746- TLV: global TLV instance available via btstack_tlv_get_instance() (src/btstack_tlv.h)
747- TLV: POSIX implementation that appends to a file on disk (platform/posix/btstack_tlv_posix.c
748- LE Device DB TLV: overwrite oldest entry if no free entries available
749- SM: allow to set fixed passkey in display role using sm_use_fixed_passkey_in_display_role
750- Example/hid_host_demo with HID parser and support for basic US keyboard layout
751- 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
752- Port for Apollo2 MCU with EM9304 (ports/apollo2-em9304)
753
754### Changed
755- panu_demo: uses btstack_network.h now
756- WICED: configure printf to replace Linefeed with CRLF
757- SBC: split btstack_sbc_bludroid.c into seperate encoder and decoder implementations
758
759### Fixed
760- RFCOMM: support connection requests during connection failure
761- L2CAP: support connection requests during connection failure
762- L2CAP: fix default remote MTU as 672 instead of 48 (Minimal MTU)
763- HCI: avoid double free during halting
764- SM: fixed reconnect using legacy pairing in slave role
765
766
767