Skip to content

Commit

Permalink
doc: migration-guide-4.1: Add device driver details
Browse files Browse the repository at this point in the history
Add a migration entry for the device driver API change, and start listing
driver classes that have been updated in-tree.

Signed-off-by: Pieter De Gendt <[email protected]>
  • Loading branch information
pdgendt committed Nov 28, 2024
1 parent 64b762f commit add5ec0
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/kernel/drivers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ High-level calls accessed through device-specific APIs, such as
:file:`i2c.h` or :file:`spi.h`, are usually intended as synchronous. Thus,
these calls should be blocking.

.. _device_driver_api:

Driver APIs
***********

Expand Down
7 changes: 7 additions & 0 deletions doc/releases/migration-guide-4.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,13 @@ LVGL
Device Drivers and Devicetree
*****************************

* Device driver APIs are placed into iterable sections (:github:`71773`) to allow for runtime
checking. See :ref:`device_driver_api` for more details.
The :c:macro:`DEVICE_API()` macro should be used by out-of-tree driver implementations for
the following driver classes:

* :c:struct:`adc_driver_api`

Controller Area Network (CAN)
=============================

Expand Down

0 comments on commit add5ec0

Please sign in to comment.