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