From 23ab4e0054783e619fcf39a50faf9c08c2e18fa5 Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Sat, 7 Jan 2023 14:07:11 -0700 Subject: [PATCH] binman: Use a reference for binman symbols docs Several etypes have this reference in their documentation. Now that we are using rST, link to the section directly. Signed-off-by: Simon Glass Suggested-by: Quentin Schulz --- tools/binman/binman.rst | 1 + tools/binman/entries.rst | 32 ++++++-------------------- tools/binman/etype/u_boot.py | 6 +---- tools/binman/etype/u_boot_spl.py | 4 +--- tools/binman/etype/u_boot_spl_nodtb.py | 4 +--- tools/binman/etype/u_boot_tpl.py | 4 +--- tools/binman/etype/u_boot_tpl_nodtb.py | 4 +--- tools/binman/etype/u_boot_vpl.py | 4 +--- tools/binman/etype/u_boot_vpl_nodtb.py | 6 +---- 9 files changed, 15 insertions(+), 50 deletions(-) diff --git a/tools/binman/binman.rst b/tools/binman/binman.rst index 2899e1c783..ef3e5a6d19 100644 --- a/tools/binman/binman.rst +++ b/tools/binman/binman.rst @@ -487,6 +487,7 @@ For x86 devices (with the end-at-4gb property) this base address is not added since it is assumed that images are XIP and the offsets already include the address. +.. _binman_fdt: Access to binman entry offsets at run time (fdt) ------------------------------------------------ diff --git a/tools/binman/entries.rst b/tools/binman/entries.rst index b2ce7960d3..5b9eb8b82c 100644 --- a/tools/binman/entries.rst +++ b/tools/binman/entries.rst @@ -1578,11 +1578,7 @@ This is the U-Boot binary, containing relocation information to allow it to relocate itself at runtime. The binary typically includes a device tree blob at the end of it. -U-Boot can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (fdt)' - -in the binman README for more information. +U-Boot can access binman symbols at runtime. See :ref:`binman_fdt`. Note that this entry is automatically replaced with u-boot-expanded unless --no-expanded is used or the node has a 'no-expanded' property. @@ -1712,9 +1708,7 @@ not relocatable so must be loaded to the correct address in SRAM, or written to run from the correct address if direct flash execution is possible (e.g. on x86 devices). -SPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' +SPL can access binman symbols at runtime. See :ref:`binman_fdt`. in the binman README for more information. @@ -1817,9 +1811,7 @@ entry after this one, or use a u-boot-spl entry instead' which normally expands to a section containing u-boot-spl-dtb, u-boot-spl-bss-pad and u-boot-spl-dtb -SPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' +SPL can access binman symbols at runtime. See :ref:`binman_fdt`. in the binman README for more information. @@ -1855,9 +1847,7 @@ loader. Note that SPL is not relocatable so must be loaded to the correct address in SRAM, or written to run from the correct address if direct flash execution is possible (e.g. on x86 devices). -SPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' +SPL can access binman symbols at runtime. See :ref:`binman_fdt`. in the binman README for more information. @@ -1972,9 +1962,7 @@ entry after this one, or use a u-boot-tpl entry instead, which normally expands to a section containing u-boot-tpl-dtb, u-boot-tpl-bss-pad and u-boot-tpl-dtb -TPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' +TPL can access binman symbols at runtime. See :ref:`binman_fdt`. in the binman README for more information. @@ -2060,9 +2048,7 @@ loader. Note that VPL is not relocatable so must be loaded to the correct address in SRAM, or written to run from the correct address if direct flash execution is possible (e.g. on x86 devices). -SPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' +SPL can access binman symbols at runtime. See :ref:`binman_fdt`. in the binman README for more information. @@ -2162,11 +2148,7 @@ entry after this one, or use a u_boot_vpl entry instead, which normally expands to a section containing u-boot-vpl-dtb, u-boot-vpl-bss-pad and u-boot-vpl-dtb -VPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' - -in the binman README for more information. +VPL can access binman symbols at runtime. See :ref:`binman_fdt`. The ELF file 'vpl/u-boot-vpl' must also be available for this to work, since binman uses that to look up symbols to write into the VPL binary. diff --git a/tools/binman/etype/u_boot.py b/tools/binman/etype/u_boot.py index e8d180a46d..d5639eef2e 100644 --- a/tools/binman/etype/u_boot.py +++ b/tools/binman/etype/u_boot.py @@ -18,11 +18,7 @@ class Entry_u_boot(Entry_blob): to relocate itself at runtime. The binary typically includes a device tree blob at the end of it. - U-Boot can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (fdt)' - - in the binman README for more information. + U-Boot can access binman symbols at runtime. See :ref:`binman_fdt`. Note that this entry is automatically replaced with u-boot-expanded unless --no-expanded is used or the node has a 'no-expanded' property. diff --git a/tools/binman/etype/u_boot_spl.py b/tools/binman/etype/u_boot_spl.py index d1aa3b4fda..be1610569f 100644 --- a/tools/binman/etype/u_boot_spl.py +++ b/tools/binman/etype/u_boot_spl.py @@ -21,9 +21,7 @@ class Entry_u_boot_spl(Entry_blob): to run from the correct address if direct flash execution is possible (e.g. on x86 devices). - SPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' + SPL can access binman symbols at runtime. See :ref:`binman_fdt`. in the binman README for more information. diff --git a/tools/binman/etype/u_boot_spl_nodtb.py b/tools/binman/etype/u_boot_spl_nodtb.py index 50a126dc7e..e7ec329c90 100644 --- a/tools/binman/etype/u_boot_spl_nodtb.py +++ b/tools/binman/etype/u_boot_spl_nodtb.py @@ -21,9 +21,7 @@ class Entry_u_boot_spl_nodtb(Entry_blob): expands to a section containing u-boot-spl-dtb, u-boot-spl-bss-pad and u-boot-spl-dtb - SPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' + SPL can access binman symbols at runtime. See :ref:`binman_fdt`. in the binman README for more information. diff --git a/tools/binman/etype/u_boot_tpl.py b/tools/binman/etype/u_boot_tpl.py index 1883a2bd5f..397b9f8953 100644 --- a/tools/binman/etype/u_boot_tpl.py +++ b/tools/binman/etype/u_boot_tpl.py @@ -21,9 +21,7 @@ class Entry_u_boot_tpl(Entry_blob): address in SRAM, or written to run from the correct address if direct flash execution is possible (e.g. on x86 devices). - SPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' + SPL can access binman symbols at runtime. See :ref:`binman_fdt`. in the binman README for more information. diff --git a/tools/binman/etype/u_boot_tpl_nodtb.py b/tools/binman/etype/u_boot_tpl_nodtb.py index 7e08e58f1e..9bb2b5dda3 100644 --- a/tools/binman/etype/u_boot_tpl_nodtb.py +++ b/tools/binman/etype/u_boot_tpl_nodtb.py @@ -21,9 +21,7 @@ class Entry_u_boot_tpl_nodtb(Entry_blob): expands to a section containing u-boot-tpl-dtb, u-boot-tpl-bss-pad and u-boot-tpl-dtb - TPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' + TPL can access binman symbols at runtime. See :ref:`binman_fdt`. in the binman README for more information. diff --git a/tools/binman/etype/u_boot_vpl.py b/tools/binman/etype/u_boot_vpl.py index 62e5969c6e..31d7e8374e 100644 --- a/tools/binman/etype/u_boot_vpl.py +++ b/tools/binman/etype/u_boot_vpl.py @@ -21,9 +21,7 @@ class Entry_u_boot_vpl(Entry_blob): address in SRAM, or written to run from the correct address if direct flash execution is possible (e.g. on x86 devices). - SPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' + SPL can access binman symbols at runtime. See :ref:`binman_fdt`. in the binman README for more information. diff --git a/tools/binman/etype/u_boot_vpl_nodtb.py b/tools/binman/etype/u_boot_vpl_nodtb.py index db3d8a91c9..64c2767488 100644 --- a/tools/binman/etype/u_boot_vpl_nodtb.py +++ b/tools/binman/etype/u_boot_vpl_nodtb.py @@ -21,11 +21,7 @@ class Entry_u_boot_vpl_nodtb(Entry_blob): expands to a section containing u-boot-vpl-dtb, u-boot-vpl-bss-pad and u-boot-vpl-dtb - VPL can access binman symbols at runtime. See: - - 'Access to binman entry offsets at run time (symbols)' - - in the binman README for more information. + VPL can access binman symbols at runtime. See :ref:`binman_fdt`. The ELF file 'vpl/u-boot-vpl' must also be available for this to work, since binman uses that to look up symbols to write into the VPL binary. -- 2.39.5