xref: /rk3399_ARM-atf/docs/components/fconf/fconf_properties.rst (revision af4fee04b9e0fcbf7e5a1f9ff2e88278fc99f865)
14874793dSLouis MayencourtDTB binding for FCONF properties
24874793dSLouis Mayencourt================================
34874793dSLouis Mayencourt
44874793dSLouis MayencourtThis document describes the device tree format of |FCONF| properties. These
54874793dSLouis Mayencourtproperties are not related to a specific platform and can be queried from
64874793dSLouis Mayencourtcommon code.
74874793dSLouis Mayencourt
84874793dSLouis MayencourtDynamic configuration
94874793dSLouis Mayencourt~~~~~~~~~~~~~~~~~~~~~
104874793dSLouis Mayencourt
114874793dSLouis MayencourtThe |FCONF| framework expects a *dtb-registry* node with the following field:
124874793dSLouis Mayencourt
134874793dSLouis Mayencourt- compatible [mandatory]
144874793dSLouis Mayencourt   - value type: <string>
154874793dSLouis Mayencourt   - Must be the string "fconf,dyn_cfg-dtb_registry".
164874793dSLouis Mayencourt
174874793dSLouis MayencourtThen a list of subnodes representing a configuration |DTB|, which can be used
184874793dSLouis Mayencourtby |FCONF|. Each subnode should be named according to the information it
194874793dSLouis Mayencourtcontains, and must be formed with the following fields:
204874793dSLouis Mayencourt
214874793dSLouis Mayencourt- load-address [mandatory]
224874793dSLouis Mayencourt    - value type: <u64>
234874793dSLouis Mayencourt    - Physical loading base address of the configuration.
24*05e55030SManish V Badarkhe      If secondary-load-address is also provided (see below), then this is the
25*05e55030SManish V Badarkhe      primary load address.
264874793dSLouis Mayencourt
274874793dSLouis Mayencourt- max-size [mandatory]
284874793dSLouis Mayencourt    - value type: <u32>
294874793dSLouis Mayencourt    - Maximum size of the configuration.
304874793dSLouis Mayencourt
314874793dSLouis Mayencourt- id [mandatory]
324874793dSLouis Mayencourt    - value type: <u32>
334874793dSLouis Mayencourt    - Image ID of the configuration.
344874793dSLouis Mayencourt
35*05e55030SManish V Badarkhe- secondary-load-address [optional]
36b80e751dSManish V Badarkhe    - value type: <u64>
37*05e55030SManish V Badarkhe    - A platform uses this physical address to copy the configuration to
38*05e55030SManish V Badarkhe      another location during the boot-flow.
39*05e55030SManish V Badarkhe
40*05e55030SManish V Badarkhe--------------
41*05e55030SManish V Badarkhe
42*05e55030SManish V Badarkhe*Copyright (c) 2023, Arm Limited and Contributors. All rights reserved.*
43