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