Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/connectivity/bluetooth/api/mesh/provisioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ sequence should be repeated after a delay of three seconds or more.
When an Input OOB action is selected, the user should be prompted when the
application receives the :c:member:`bt_mesh_prov.input` callback. The user
response should be fed back to the Provisioning API through
:c:func:`bt_mesh_input_string` or :c:func:`bt_mesh_input_number`. If
:c:func:`bt_mesh_input_string` or :c:func:`bt_mesh_input_numeric`. If
no user response is recorded within 60 seconds, the Provisioning process is
aborted.

Expand Down
48 changes: 48 additions & 0 deletions doc/releases/migration-guide-4.4.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
:orphan:

..
See
https://docs.zephyrproject.org/latest/releases/index.html#migration-guides
for details of what is supposed to go into this document.

.. _migration_4.4:

Migration guide to Zephyr v4.4.0 (Working Draft)
################################################

This document describes the changes required when migrating your application from Zephyr v4.3.0 to
Zephyr v4.4.0.

Any other changes (not directly related to migrating applications) can be found in
the :ref:`release notes<zephyr_4.4>`.

.. contents::
:local:
:depth: 2

Build System
************

Kernel
******

Boards
******

Device Drivers and Devicetree
*****************************

Bluetooth
*********

Networking
**********

Other subsystems
****************

Modules
*******

Architectures
*************
135 changes: 135 additions & 0 deletions doc/releases/release-notes-4.4.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
:orphan:

..
What goes here: removed/deprecated apis, new boards, new drivers, notable
features. If you feel like something new can be useful to a user, put it
under "Other Enhancements" in the first paragraph, if you feel like something
is worth mentioning in the project media (release blog post, release
livestream) put it under "Major enhancement".
..
If you are describing a feature or functionality, consider adding it to the
actual project documentation rather than the release notes, so that the
information does not get lost in time.
..
No list of bugfixes, minor changes, those are already in the git log, this is
not a changelog.
..
Does the entry have a link that contains the details? Just add the link, if
you think it needs more details, put them in the content that shows up on the
link.
..
Are you thinking about generating this? Don't put anything at all.
..
Does the thing require the user to change their application? Put it on the
migration guide instead. (TODO: move the removed APIs section in the
migration guide)

.. _zephyr_4.4:

Zephyr 4.4.0 (Working Draft)
############################

We are pleased to announce the release of Zephyr version 4.4.0.

Major enhancements with this release include:

An overview of the changes required or recommended when migrating your application from Zephyr
v4.3.0 to Zephyr v4.4.0 can be found in the separate :ref:`migration guide<migration_4.4>`.

The following sections provide detailed lists of changes by component.

Security Vulnerability Related
******************************

API Changes
***********

..
Only removed, deprecated and new APIs. Changes go in migration guide.

Removed APIs and options
========================

Deprecated APIs and options
===========================

* Bluetooth

* Mesh

* The function :c:func:`bt_mesh_input_number` was deprecated. Applications should use
:c:func:`bt_mesh_input_numeric` instead.
* The callback :c:member:`output_number` in :c:struct:`bt_mesh_prov` structure was deprecated.
Applications should use :c:member:`output_numeric` callback instead.

New APIs and options
====================

..
Link to new APIs here, in a group if you think it's necessary, no need to get
fancy just list the link, that should contain the documentation. If you feel
like you need to add more details, add them in the API documentation code
instead.

.. zephyr-keep-sorted-start re(^\* \w)

* Bluetooth

* Mesh

* :c:func:`bt_mesh_input_numeric` to provide provisioning numeric input OOB value.
* :c:member:`output_numeric` callback in :c:struct:`bt_mesh_prov` structure to
output numeric values during provisioning.

* Services

* Introduced Alert Notification Service (ANS) :kconfig:option:`CONFIG_BT_ANS`

* Flash

* :dtcompatible:`jedec,mspi-nor` now allows MSPI configuration of read, write and
control commands separately via devicetree.

.. zephyr-keep-sorted-stop

New Boards
**********

..
You may update this list as you contribute a new board during the release cycle, in order to make
it visible to people who might be looking at the working draft of the release notes. However, note
that this list will be recomputed at the time of the release, so you don't *have* to update it.
In any case, just link the board, further details go in the board description.

New Shields
***********

..
Same as above, this will also be recomputed at the time of the release.

New Drivers
***********

..
Same as above, this will also be recomputed at the time of the release.
Just link the driver, further details go in the binding description

New Samples
***********

* :zephyr:code-sample:`ble_peripheral_ans`

..
Same as above, this will also be recomputed at the time of the release.
Just link the sample, further details go in the sample documentation itself.


Libraries / Subsystems
**********************

Other notable changes
*********************

..
Any more descriptive subsystem or driver changes. Do you really want to write
a paragraph or is it enough to link to the api/driver/Kconfig/board page above?
45 changes: 37 additions & 8 deletions include/zephyr/bluetooth/mesh/main.h
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@
*/
void (*capabilities)(const struct bt_mesh_dev_capabilities *cap);

#if defined CONFIG_BT_MESH_PROV_OOB_API_LEGACY
/** @brief Output of a number is requested.
*
* This callback notifies the application that it should
Expand All @@ -183,7 +184,21 @@
*
* @return Zero on success or negative error code otherwise
*/
int (*output_number)(bt_mesh_output_action_t act, uint32_t num);
int (*output_number)(bt_mesh_output_action_t act, uint32_t num) __deprecated;
#else

Check notice on line 188 in include/zephyr/bluetooth/mesh/main.h

View workflow job for this annotation

GitHub Actions / Run compliance checks on patch series (PR)

You may want to run clang-format on this change

include/zephyr/bluetooth/mesh/main.h:188 - int (*output_number)(bt_mesh_output_action_t act, uint32_t num) __deprecated; + int (*output_number)(bt_mesh_output_action_t act, uint32_t num) __deprecated;
/** @brief Output of a numeric value is requested.
*
* This callback notifies the application that it should
* output the given numeric value using the given action.
*
* @param act Action for outputting the numeric value.
* @param numeric memory with numeric value in the little endian format to be outputted.
* @param size size of the numeric value in bytes.
*
* @return Zero on success or negative error code otherwise
*/
int (*output_numeric)(bt_mesh_output_action_t act, uint8_t *numeric, size_t size);
#endif

Check notice on line 201 in include/zephyr/bluetooth/mesh/main.h

View workflow job for this annotation

GitHub Actions / Run compliance checks on patch series (PR)

You may want to run clang-format on this change

include/zephyr/bluetooth/mesh/main.h:201 - int (*output_numeric)(bt_mesh_output_action_t act, uint8_t *numeric, size_t size); + int (*output_numeric)(bt_mesh_output_action_t act, uint8_t *numeric, size_t size);

/** @brief Output of a string is requested.
*
Expand All @@ -202,7 +217,7 @@
* request input from the user using the given action. The
* requested input will either be a string or a number, and
* the application needs to consequently call the
* bt_mesh_input_string() or bt_mesh_input_number() functions
* bt_mesh_input_string() or bt_mesh_input_numeric() functions
* once the data has been acquired from the user.
*
* @param act Action for inputting data.
Expand Down Expand Up @@ -313,7 +328,7 @@

/** @brief Provide provisioning input OOB string.
*
* This is intended to be called after the bt_mesh_prov input callback
* This is intended to be called after the @ref bt_mesh_prov::input callback
* has been called with BT_MESH_ENTER_STRING as the action.
*
* @param str String.
Expand All @@ -322,16 +337,30 @@
*/
int bt_mesh_input_string(const char *str);

#if defined CONFIG_BT_MESH_PROV_OOB_API_LEGACY
/** @brief Provide provisioning input OOB number.
*
* This is intended to be called after the bt_mesh_prov input callback
* has been called with BT_MESH_ENTER_NUMBER as the action.
* This is intended to be called after the @ref bt_mesh_prov::input callback
* has been called with @ref BT_MESH_ENTER_NUMBER as the action.
*
* @param num Number.
*
* @return Zero on success or (negative) error code otherwise.
*/
int bt_mesh_input_number(uint32_t num);
__deprecated int bt_mesh_input_number(uint32_t num);
#endif

/** @brief Provide provisioning input OOB numeric value.
*
* This is intended to be called after the @ref bt_mesh_prov::input callback
* has been called with @ref BT_MESH_ENTER_NUMBER as the action.
*
* @param numeric Pointer to the numeric value in little endian.
* @param size Size of the numeric value in bytes (this is not OOB size).
*
* @return Zero on success or (negative) error code otherwise.
*/
int bt_mesh_input_numeric(uint8_t *numeric, size_t size);

/** @brief Provide Device public key.
*
Expand All @@ -347,7 +376,7 @@
*
* Instruct the unprovisioned device to use the specified Input OOB
* authentication action. When using @ref BT_MESH_PUSH, @ref BT_MESH_TWIST or
* @ref BT_MESH_ENTER_NUMBER, the @ref bt_mesh_prov::output_number callback is
* @ref BT_MESH_ENTER_NUMBER, the @ref bt_mesh_prov::output_numeric callback is
* called with a random number that has to be entered on the unprovisioned
* device.
*
Expand All @@ -372,7 +401,7 @@
*
* When using @ref BT_MESH_BLINK, @ref BT_MESH_BEEP, @ref BT_MESH_VIBRATE
* or @ref BT_MESH_DISPLAY_NUMBER, and the application has to call
* @ref bt_mesh_input_number with the random number indicated by
* @ref bt_mesh_input_numeric with the random number indicated by
* the unprovisioned device.
*
* When using @ref BT_MESH_DISPLAY_STRING, the application has to call
Expand Down
Loading
Loading