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