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