summaryrefslogtreecommitdiffstats
path: root/docs/components/fconf/fconf_properties.rst
blob: 3479576c97eaaf79eb6e695e1bc03225db0f49b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
DTB binding for FCONF properties
================================

This document describes the device tree format of |FCONF| properties. These
properties are not related to a specific platform and can be queried from
common code.

Dynamic configuration
~~~~~~~~~~~~~~~~~~~~~

The |FCONF| framework expects a *dtb-registry* node with the following field:

- compatible [mandatory]
   - value type: <string>
   - Must be the string "fconf,dyn_cfg-dtb_registry".

Then a list of subnodes representing a configuration |DTB|, which can be used
by |FCONF|. Each subnode should be named according to the information it
contains, and must be formed with the following fields:

- load-address [mandatory]
    - value type: <u64>
    - Physical loading base address of the configuration. 
      If secondary-load-address is also provided (see below), then this is the
      primary load address.

- max-size [mandatory]
    - value type: <u32>
    - Maximum size of the configuration.

- id [mandatory]
    - value type: <u32>
    - Image ID of the configuration.

- secondary-load-address [optional]
    - value type: <u64>
    - A platform uses this physical address to copy the configuration to
      another location during the boot-flow.

--------------

*Copyright (c) 2023, Arm Limited and Contributors. All rights reserved.*