zephyr/doc/releases/release-notes-2.3.rst
Joakim Andersson aae0f52509 doc: 2.3 relnotes: Update release notes for directed advertising
Update release notes for deprecation of the bt_conn_create_slave_le
API call, which has now been deprecated in favour of bt_le_adv_start
with peer address in advertising parameters instead.
Fix previously mistake about BT_LE_ADV_* deprecated macros,
application should use GAP defines, and not HCI defines.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2020-04-15 10:57:38 +03:00

317 lines
4.3 KiB
ReStructuredText

:orphan:
.. _zephyr_2.3:
Zephyr 2.3.0 (Working Draft)
############################
We are pleased to announce the release of Zephyr RTOS version 2.3.0.
Major enhancements with this release include:
* <TBD>
The following sections provide detailed lists of changes by component.
Security Vulnerability Related
******************************
No security vulnerabilities received.
API Changes
***********
* HWINFO
* The identifier data structure for hwinfo drivers is clarified. Drivers are
responsible for ensuring that the identifier data structure is a sequence
of bytes. The returned ID value is not supposed to be interpreted based on
vendor-specific assumptions of byte order and should express the identifier
as a raw byte sequence.
The changes have an impact on users that use the hwinfo API to identify
their devices.
The sam0 driver byte swaps each 32 bit word of the 128 bit identifier to
big endian.
The nordic driver byte swaps the entire 64 bit word to big endian.
Deprecated in this release
==========================
* Kernel
* k_uptime_delta_32(), use k_uptime_delta()
* Timeout values
* All timeout values are now encapsulated k_timeout_t opaque structure when
passing them to the kernel. If you want to revert to the previous s32_t
type for the timeout parameter pleae enable the
CONFIG_LEGACY_TIMEOUT_API Kconfig option
* Bluetooth
* BT_LE_SCAN_FILTER_DUPLICATE, use BT_LE_SCAN_OPT_FILTER_DUPLICATE instead
* BT_LE_SCAN_FILTER_WHITELIST, use BT_LE_SCAN_OPT_FILTER_WHITELIST instead
* bt_le_scan_param::filter_dup, use bt_le_scan_param::options instead
* bt_conn_create_le(), use bt_conn_le_create() instead
* bt_conn_create_auto_le(), use bt_conn_le_create_auto() instead
* bt_conn_create_slave_le(), use bt_le_adv_start() instead with
bt_le_adv_param::peer set to the remote peers address.
* BT_LE_ADV_* macros, use BT_GAP_ADV_* enums instead
Removed APIs in this release
============================
Stable API changes in this release
==================================
Kernel
******
* <TBD>
Architectures
*************
* ARC:
* <TBD>
* ARM:
* <TBD>
* POSIX:
* <TBD>
* RISC-V:
* <TBD>
* x86:
* <TBD>
Boards & SoC Support
********************
* Added support for these SoC series:
.. rst-class:: rst-columns
* <TBD>
* Added support for these ARM boards:
.. rst-class:: rst-columns
* <TBD>
* Added support for these following shields:
.. rst-class:: rst-columns
* <TBD>
Drivers and Sensors
*******************
* ADC
* <TBD>
* Bluetooth
* <TBD>
* CAN
* <TBD>
* Clock Control
* <TBD>
* Console
* <TBD>
* Counter
* <TBD>
* Display
* <TBD>
* DMA
* <TBD>
* EEPROM
* <TBD>
* Entropy
* <TBD>
* Ethernet
* <TBD>
* Flash
* <TBD>
* GPIO
* <TBD>
* Hardware Info
* <TBD>
* I2C
* <TBD>
* I2S
* <TBD>
* IEEE 802.15.4
* <TBD>
* Interrupt Controller
* <TBD>
* IPM
* <TBD>
* Keyboard Scan
* <TBD>
* LED
* <TBD>
* Modem
* <TBD>
* Pinmux
* <TBD>
* PS/2
* <TBD>
* PWM
* <TBD>
* Sensor
* <TBD>
* Serial
* <TBD>
* SPI
* <TBD>
* Timer
* <TBD>
* USB
* <TBD>
* Video
* <TBD>
* Watchdog
* <TBD>
* WiFi
* <TBD>
Networking
**********
* <TBD>
Bluetooth
*********
* Host:
* <TBD>
* BLE split software Controller:
* <TBD>
* BLE legacy software Controller:
* <TBD>
Build and Infrastructure
************************
* <TBD>
* Devicetree
* A new :ref:`devicetree_api` was added. This API is not generated, but is
still included via ``<devicetree.h>``. The :ref:`dt-legacy-macros` are now
deprecated; users should replace the generated macros with new API. The
:ref:`dt-howtos` page has been extended for the new API, and a new
:ref:`dt-from-c` API usage guide was also added.
Libraries / Subsystems
**********************
* Random
* <TBD>
HALs
****
* HALs are now moved out of the main tree as external modules and reside in
their own standalone repositories.
Documentation
*************
* <TBD>
Tests and Samples
*****************
* <TBD>
Issue Related Items
*******************
These GitHub issues were addressed since the previous 2.2.0 tagged
release:
.. comment List derived from GitHub Issue query: ...
* :github:`issuenumber` - issue title