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