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