diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-05-04 19:29:23 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-05-06 09:38:58 +0100 |
commit | ce7a814b3b915f865ef9c616300315b55e374938 (patch) | |
tree | e57acedbd4b7e7599d507050e6d2000c11a6bc4a /documentation | |
parent | 23471213814097f3420083c04ccfbabe963b8a8e (diff) | |
download | poky-ce7a814b3b915f865ef9c616300315b55e374938.tar.gz |
ref-manual: document FIT_ADDRESS_CELLS
(From yocto-docs rev: 81ee2e82a5bd0b7f1cb910bf266ceb808c05bba9)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Jamin Lin <jamin_lin@aspeedtech.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/migration-guides/release-notes-4.3.rst | 5 | ||||
-rw-r--r-- | documentation/ref-manual/classes.rst | 3 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 26 |
3 files changed, 33 insertions, 1 deletions
diff --git a/documentation/migration-guides/release-notes-4.3.rst b/documentation/migration-guides/release-notes-4.3.rst index a91bbcba24..ede3dc41aa 100644 --- a/documentation/migration-guides/release-notes-4.3.rst +++ b/documentation/migration-guides/release-notes-4.3.rst | |||
@@ -26,6 +26,11 @@ New Features / Enhancements in 4.3 | |||
26 | 26 | ||
27 | - wic Image Creator enhancements: | 27 | - wic Image Creator enhancements: |
28 | 28 | ||
29 | - FIT image related improvements: | ||
30 | |||
31 | - New :term:`FIT_ADDRESS_CELLS` variable allowing | ||
32 | to specify 64 bit addresses. | ||
33 | |||
29 | - SDK-related improvements: | 34 | - SDK-related improvements: |
30 | 35 | ||
31 | - Testing: | 36 | - Testing: |
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index a78368b380..96d7c0d414 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -1590,7 +1590,8 @@ Only a single kernel can be added to the FIT image created by | |||
1590 | :ref:`ref-classes-kernel-fitimage` and the kernel image in FIT is mandatory. The | 1590 | :ref:`ref-classes-kernel-fitimage` and the kernel image in FIT is mandatory. The |
1591 | address where the kernel image is to be loaded by U-Boot is | 1591 | address where the kernel image is to be loaded by U-Boot is |
1592 | specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by | 1592 | specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by |
1593 | :term:`UBOOT_ENTRYPOINT`. | 1593 | :term:`UBOOT_ENTRYPOINT`. Setting :term:`FIT_ADDRESS_CELLS` to "2" |
1594 | is necessary if such addresses are 64 bit ones. | ||
1594 | 1595 | ||
1595 | Multiple device trees can be added to the FIT image created by | 1596 | Multiple device trees can be added to the FIT image created by |
1596 | :ref:`ref-classes-kernel-fitimage` and the device tree is optional. | 1597 | :ref:`ref-classes-kernel-fitimage` and the device tree is optional. |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 574af2c2f9..6ee65e1788 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -2898,6 +2898,26 @@ system and gives an overview of their function and contents. | |||
2898 | For guidance on how to create your own file permissions settings | 2898 | For guidance on how to create your own file permissions settings |
2899 | table file, examine the existing ``fs-perms.txt``. | 2899 | table file, examine the existing ``fs-perms.txt``. |
2900 | 2900 | ||
2901 | :term:`FIT_ADDRESS_CELLS` | ||
2902 | |||
2903 | Specifies the value of the ``#address-cells`` value for the | ||
2904 | description of the kernel FIT image. | ||
2905 | |||
2906 | The default value is set to "1" by the :ref:`ref-classes-kernel-fitimage` | ||
2907 | class, which corresponds to 32 bit addresses. | ||
2908 | |||
2909 | For platforms who need to set 64 bit addresses in | ||
2910 | :term:`UBOOT_LOADADDRESS` and :term:`UBOOT_ENTRYPOINT`, you need to | ||
2911 | set this value to "2", as two 32 bit values (cells) will be needed | ||
2912 | to represent such addresses. | ||
2913 | |||
2914 | Here is an example setting "0x400000000" as a load address:: | ||
2915 | |||
2916 | FIT_ADDRESS_CELLS = "2" | ||
2917 | UBOOT_LOADADDRESS= "0x04 0x00000000" | ||
2918 | |||
2919 | See `more details about #address-cells <https://elinux.org/Device_Tree_Usage#How_Addressing_Works>`__. | ||
2920 | |||
2901 | :term:`FIT_CONF_DEFAULT_DTB` | 2921 | :term:`FIT_CONF_DEFAULT_DTB` |
2902 | Specifies the default device tree binary (dtb) file for a fitImage when | 2922 | Specifies the default device tree binary (dtb) file for a fitImage when |
2903 | multiple are provided. | 2923 | multiple are provided. |
@@ -9041,11 +9061,17 @@ system and gives an overview of their function and contents. | |||
9041 | creation, the :term:`UBOOT_ENTRYPOINT` variable is passed as a | 9061 | creation, the :term:`UBOOT_ENTRYPOINT` variable is passed as a |
9042 | command-line parameter to the ``uboot-mkimage`` utility. | 9062 | command-line parameter to the ``uboot-mkimage`` utility. |
9043 | 9063 | ||
9064 | To pass a 64 bit address for FIT image creation, you will need to set | ||
9065 | the :term:`FIT_ADDRESS_CELLS` variable too. | ||
9066 | |||
9044 | :term:`UBOOT_LOADADDRESS` | 9067 | :term:`UBOOT_LOADADDRESS` |
9045 | Specifies the load address for the U-Boot image. During U-Boot image | 9068 | Specifies the load address for the U-Boot image. During U-Boot image |
9046 | creation, the :term:`UBOOT_LOADADDRESS` variable is passed as a | 9069 | creation, the :term:`UBOOT_LOADADDRESS` variable is passed as a |
9047 | command-line parameter to the ``uboot-mkimage`` utility. | 9070 | command-line parameter to the ``uboot-mkimage`` utility. |
9048 | 9071 | ||
9072 | To pass a 64 bit address for FIT image creation, you will need to set | ||
9073 | the :term:`FIT_ADDRESS_CELLS` variable too. | ||
9074 | |||
9049 | :term:`UBOOT_LOCALVERSION` | 9075 | :term:`UBOOT_LOCALVERSION` |
9050 | Appends a string to the name of the local version of the U-Boot | 9076 | Appends a string to the name of the local version of the U-Boot |
9051 | image. For example, assuming the version of the U-Boot image built | 9077 | image. For example, assuming the version of the U-Boot image built |