xref: /btstack/CHANGELOG.md (revision 0c4cc577b21c11709db67ba73e95e3716dea3bcf)
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## [Unreleased]
8
9### Added
10- GAP: gap_le_connection_interval provides connection interval for conn handle
11- Nordic SPP Service Server: GATT service that emulates a serial port over BLE based on Nordic Semiconductor documentation.
12- uBlox  SPP Service Server: GATT service that emulates a serial port over BLE based on uBlox documentation.
13- SM: ENABLE_LE_CENTRAL_AUTO_ENCRYPTION triggers automatic encryption on connect to bonded devices
14
15### Fixed
16- SM: prevent random address updates if gap_random_address_set was used
17- SM: fix internal buffer overrun that can cause storing of bonding information to fail
18- SM: ignore Slave Security Request after sending own Pairing Request
19- L2CAP: fix use after free on disconnect if ERTM is enabled
20- Memory Pools: clear all buffers before use
21
22## Changes October 2018
23
24### Added
25- SDP Server: queue incoming connections when already connected instead of rejecting them
26- 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.
27- HIDS Device: GATT service that exposes HID reports intended for HID Devices, like keyboard and mouse.
28
29### Fixed
30- HCI: fix bug in gap_inquiry_stop that triggered additional GAP_EVENT_INQUIRY_COMPLETE instead of stopping the inquiry
31- L2CAP: fix issue with outgoing connection before read remote supported complete when other channels exist
32- L2CAP ERTM: allow SDU of szie MPS in first packet that contains L2CAP SDU Length
33- L2CAP ERTM: fix memory corruption triggered if local_mtu > mps
34- L2CAP ERTM: fix outgoing fragment management
35- HFP: decline incoming RFCOMM connection after outgoing connection was started
36- AVRCP: fix crash on disconnect of connection established by remote
37
38## Changes September 2018
39
40### Fixed
41- HCI: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled
42- L2CAP: Error creating outgoing connection (e.g. Connection Limit Exceeded) now handled
43- L2CAP: Evaluate 'can send now' on HCI Disconnect as ACL buffers in Bluetooth Controller have been used for the closed connection are freed implicitly
44- L2CAP: Check can send now before sending extended information requeste needed for ERTM mode
45- L2CAP: Use valid signaling identifier for L2CAP Connection Parameter Update Request
46- 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
47- RFCOMM: Avoid use-after-free on channel finalize
48- GATT Client: stop timer on disconnect - fixes use after free / crash
49
50### Added
51- A2DP Source: Support stream reconfiguration (a2dp_source_reconfigure_stream_sampling_frequency)
52- 3rd-party: yxml is used for PBAP vCard list parsing
53- cc256xC: new v1.1 init scripts
54
55## Changes August 2018
56
57### Added
58- PBAP: added pbap_get_phonebook_size() to get phonebook entry count
59
60### Fixed
61- GATT Server: Allow enable Notifications/Indication with Write Command. Fixes issue with some Android devices.
62- SM: fix pairing for Secure Connections with Bonding if remote sends additional keys
63- SM: drop LTK flag from Pairing Response for Secure Connections
64- L2CAP: fix emitted L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_REQUEST
65
66## Changes June 2018
67
68### Added
69- btstack_audio.h: application level API for audio playback and recording
70- embedded/hal_audio.h: low-level API for audio playback and recording
71- HID Device: hid_device_connect(..) function
72- ESP32: implement hal_audio
73- DA14585: support for Dialog Semiconductor DA14585 LE-only controller
74- Rasperry Pi 3 + Raspberry Pi Zero W port in port/raspi
75
76### Changed
77- Errata 10734:
78  - SM: Generate new EC Public Keypair after each pairing
79  - SM: Abort failure with DHKEY_CHECK_FAILED if received public key is invalid (instead of unspecified error)
80- btstack.h: only include classic headers if ENABLE_CLASSIC is defined
81- windows: ignore virtual Bluetooth adapter provided by VMware
82- Replaced HCI_PACKET_BUFFER_SIZE with HCI_INCOMING_PACKET_BUFFER_SIZE and HCI_OUTGOING_PACKET_BUFFER_SIZE
83
84## Changes June 2018
85
86### Fixed
87- HFP: Fix Wide Band Speech bit in SDP record for both HF/AG. Missing bit prevents macOS from using mSBC
88- ATT Server: send ATT_EVENT_HANDLE_VALUE_INDICATION_COMPLETE with status ATT_HANDLE_VALUE_INDICATION_DISCONNECT on disconnect
89- AVRCP Controller: fix parsing of now playing info
90
91### Changed
92- ATT Server: ATT_HANDLE_VALUE_INDICATION_DISCONNECT is delivered to service handler if registered
93
94### Added
95- ATT Server: packet handler field added to att_service_handler_t to receive: connect/disconnect, atu exchange, indication complete
96
97## Changes May 2018
98
99### Added
100- GAP: re-encrypt outgoing connection if bonded
101- ATT Server: wait until re-encryption is complete
102- GATT Client: wait until re-encryption is complete
103- ATT Server: added att_server_request_to_send_notification and att_server_request_to_send_indication
104- GATT Client: if ENABLE_GATT_CLIENT_PAIRING, GATT Client starts pairing and retry operation on security error
105
106### Changed
107- ATT Server: att_server_register_can_send_now_callback is deprecated, use att_server_request_to_send_notification/indication instead
108
109### Fixed
110- SM: Fix LE Secure Connection pairing in Central role
111- le_device_db_tlv: fix seq nr management
112- SM: improve le_device_db lookup and storing of IRK
113- GATT Server: fix lookup for Client Characteristic Configuration in services with multiple Characteristics
114- RFCOMM: emit channel closed on HCI/L2CAP disconnect after sending DISC while expecting UA
115
116## Changes April 2018
117
118### Added
119- Crypto: btstack_crypo.h provides cryptographic functions for random data generation, AES128, EEC, CBC-MAC (Mesh)
120- SM: support pairing using Out-of-Band (OOB) data with LE Secure Connections
121- Embedded: support btstack_stdin via SEGGER RTT
122
123### Changed
124- att_db_util: added security requirement arguments to characteristic creators
125- SM: use btstack_crypto for cryptographpic functions
126- GAP: security level for Classic protocols (asides SDP) raised to 2 (encryption)
127
128### Fixed
129- HFP: fix answer call command
130- HCI: fix buffer overrun in gap_inquiry_explode
131- SDP: free service record item on sdp_unregister_service
132
133## Changes March 2018
134
135### Added
136- GAP: allow to limit number of connections in LE Peripheral role with gap_set_max_number_peripheral_connections
137- ATT Server: support for delayed ATT read response, see example/att_delayed_read_response.c
138- ATT Server: allow to specify security requirements seperately for read/writes. .h files need to be regenerated
139
140### Fixed
141- RFCOMM: fix infinite loop on L2CAP connection error (regression from 4c3eeed1)
142- HSP HS: accept incomming SCO connection
143- SM: fix iteration over LE Device DB entries for bonding and address resolving
144- SM: store pairing information only if both devices have requested bonding
145
146## Changes February 2018
147
148### Added
149- GATT Client: gatt_client_request_can_write_without_response_event() causes GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE
150- SM: new event SM_EVENT_PAIRING_COMPLETE
151- GAP: support iteration over stored Classic link keys: gap_link_key_iterator_init, gap_link_key_iterator_get_next, gap_link_key_iterator_done
152- GAP: add gap_delete_all_link_keys
153
154### Changed
155- GATT Client: round robin for multiple connections
156- ATT Dispatch: round robin for ATT Server & GATT Client
157- L2CAP: round robin for all L2CAP channels (fixed and dynamic)
158- btstack_link_key_db: addition functions for link key iteration
159- GAP: LE scanning enabled not reset on HCI Reset -> can be enabled before HCI Power Up
160- CSR: set all keys in psram instead of default
161
162### Fixed
163- tc3556x: fix startup after baud rate change
164
165
166## Changes January 2018
167
168### Added
169- Port for Windows with Zephyr HCI Firmware connected via serial port
170- em9304: upload patch containers during HCI bootup
171- Makefile for STM32-F4Discovery port
172- support for console out via SEGGER RTT
173- LE Data Channels example in BTstack and [https://github.com/bluekitchen/CBL2CAPChannel-Demo](iOS example on GitHub)
174- LE Streamer Client can send as fast as possbile as well
175- L2CAP: option to limit ATT MTU via l2cap_set_max_le_mtu
176
177### Changed
178- HCI: allow to set hci_set_master_slave_policy (0: try to become master, 1: accept slave)
179- GAP: gap_set_connection_parameters includes scan interval and window params
180- GATT Client: GATT_EVENT_MTU indicates max MTU
181- ATT DB Util: attribute handle is returned for new Services and Characteristics
182
183### Fixed
184- Windows: retry serial port operations if not all bytes have been read/written
185- HFP: avoid buffer overflows setting up messages
186- SBC Decoder: improved error handling for invalid SBC audio data
187- GAP: fix Connection Parameter Response in Central role
188- ATT DB Util: update pointer to database in case of realloc
189- GATT Client: set UUID16 field if 16-bit UUID is stored as UUID128
190- GAP: release HCI Connnection after gap_le_conne
191- ATT: Exchanged MTU is propagate to ATT Server and GATT Client
192
193
194## Changes December 2017
195
196### Added
197- Introduced btstack_network.h network interface abstraction
198- btstack_network_posix implementation using Linux tun/tap interface
199- WICED: support for btstack_stdin (HAVE_STDIN)
200- 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.
201- TLV: global TLV instance available via btstack_tlv_get_instance() (src/btstack_tlv.h)
202- TLV: POSIX implementation that appends to a file on disk (platform/posix/btstack_tlv_posix.c
203- LE Device DB TLV: overwrite oldest entry if no free entries available
204- SM: allow to set fixed passkey in display role using sm_use_fixed_passkey_in_display_role
205- Example/hid_host_demo with HID parser and support for basic US keyboard layout
206- 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
207- Port for Apollo2 MCU with EM9304 (ports/apollo2-em9304)
208
209### Changed
210- panu_demo: uses btstack_network.h now
211- WICED: configure printf to replace Linefeed with CRLF
212- SBC: split btstack_sbc_bludroid.c into seperate encoder and decoder implementations
213
214### Fixed
215- RFCOMM: support connection requests during connection failure
216- L2CAP: support connection requests during connection failure
217- L2CAP: fix default remote MTU as 672 instead of 48 (Minimal MTU)
218- HCI: avoid double free during halting
219- SM: fixed reconnect using legacy pairing in slave role
220
221
222