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