Commit bde86849 authored by Dominik Ermel's avatar Dominik Ermel Committed by Mahesh Mahadevan
Browse files

doc/release: Add note on deprecated FLASH_MAP_ macros 



Note on replacement of FLASH_MAP_ macros with FIXED_PARTITION_
macros.

Signed-off-by: default avatarDominik Ermel <dominik.ermel@nordicsemi.no>
parent 54db76b4

doc/releases/release-notes-3.2.rst

+31 −0
Original line number Diff line number Diff line
@@ -154,6 +154,31 @@ Deprecated in this release 
  Its removal is scheduled for the 3.4 release. Refer to :ref:`pinctrl-guide`

  for more details on pin control.



* Flash Map API macros :c:macro:`FLASH_MAP_`, which have been using DTS node label

  property to reference partitions, have been deprecated and replaced with

  :c:macro:`FIXED_PARTITION_` whch use DTS node label instead.

  Replacement list:



  .. table::

     :align: center



     +-----------------------------------+------------------------------------+

     | Deprecated, takes label property  | Replacement, takes DTS node label  |

     +===================================+====================================+

     | :c:macro:`FLASH_AREA_ID`          | :c:macro:`FIXED_PARTITION_ID`      |

     +-----------------------------------+------------------------------------+

     | :c:macro:`FLASH_AREA_OFFSET`      | :c:macro:`FIXED_PARTITION_OFFSET`  |

     +-----------------------------------+------------------------------------+

     | :c:macro:`FLASH_AREA_SIZE`        | :c:macro:`FIXED_PARTITION_SIZE`    |

     +-----------------------------------+------------------------------------+

     | :c:macro:`FLASH_AREA_LABEL_EXISTS`| :c:macro:`FIXED_PARTITION_EXISTS`  |

     +-----------------------------------+------------------------------------+

     | :c:macro:`FLASH_AREA_DEVICE`      | :c:macro:`FIXED_PARTITION_DEVICE`  |

     +-----------------------------------+------------------------------------+



  :c:macro:`FLASH_AREA_LABEL_STR` is deprecated with no replacement as its sole

  purpose was to obtain the DTS node property label.



Stable API changes in this release

==================================
@@ -1517,6 +1542,12 @@ Libraries / Subsystems 


* Tracing



* Storage



  * Flash Map API deprecates usage of :c:macro:`FLASH_AREA_` macros and replaces

    them with :c:macro:`FIXED_PARTITION_` macros. This follows removal of ``label``

    property from DTS nodes.



HALs

****

CRA Git | Maintained and supported by SUSTech CRA and CCSE