From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 3D1C4C54EBC for ; Sat, 7 Jan 2023 21:08:11 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 39E5A85558; Sat, 7 Jan 2023 22:07:50 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (1024-bit key; unprotected) header.d=chromium.org header.i=@chromium.org header.b="dys9VAJK"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 3850885565; Sat, 7 Jan 2023 22:07:42 +0100 (CET) Received: from mail-il1-x135.google.com (mail-il1-x135.google.com [IPv6:2607:f8b0:4864:20::135]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 77E0185355 for ; Sat, 7 Jan 2023 22:07:35 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=chromium.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=sjg@chromium.org Received: by mail-il1-x135.google.com with SMTP id u8so2790397ilq.13 for ; Sat, 07 Jan 2023 13:07:35 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=+JvqOihq1hNOREWkUFyo2N6kiEDUc7ufeQgU6Zpa/uI=; b=dys9VAJK+FH4BU8uxQa46pAYDlOSOyM3CwWb6MTIkqRDmgugXhlz3Fslc3rLR4DjAE fEJthcMm8WJbALP6YIW5M4/6KwCSeVg+ctbwXzFLWridC5gYPZL51qp6DloDeLuwvKMu bLbc7IgZjglgqaRDa0kcKWTZl0hm8U9/hAGzM= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=+JvqOihq1hNOREWkUFyo2N6kiEDUc7ufeQgU6Zpa/uI=; b=Na5Q9gtm9KuQfpMK0kEss4rJyrgttcrtG4Fd3avp/KYwoWSfRXeaV4ou54jW4K7oS/ lvY4eDYgdygCLkHUcATtE2W1fwfYI81DNE/jzvsZ/aisozdvc1PtUFOBxdEV88Qqi8FU T6fGfaLStAMSke4GaImI8II5C15llQ89UZlR7gWMPzHhpHmWY3xhWTMxKH8pRya1YCo4 BfJso/ZYxd7KT5U9oG/9BV1TWg5+OhzBRwjzygbfQlLCcbxQZpygT9EfaauhjPAPozXj 3UgBBSQ+qZDWGWfFSAl83RV/PO5Ix2Q9IQF8Fh759iJ0kJlRs1s+CrEADblBuit2ZXXu shUg== X-Gm-Message-State: AFqh2kr1ed/UKQ870/KTN781SRXyIRETrM9ADSUlf75HogGP7aP6IREX d7y5wBXUMZKy/1fLuwQA1unBwRFvm3hArQV7 X-Google-Smtp-Source: AMrXdXsV9SKNJJyPC5FTqmBlxLp6dcnOryqPgXFgbmGSnmMt/bNuslA5xeVU6U3L2AUvqY2gIS6rcw== X-Received: by 2002:a05:6e02:52c:b0:30c:28e4:c2f9 with SMTP id h12-20020a056e02052c00b0030c28e4c2f9mr22351849ils.4.1673125654818; Sat, 07 Jan 2023 13:07:34 -0800 (PST) Received: from sjg1.roam.corp.google.com (c-71-56-217-229.hsd1.co.comcast.net. [71.56.217.229]) by smtp.gmail.com with ESMTPSA id l10-20020a92d94a000000b0030c00897497sm1465825ilq.19.2023.01.07.13.07.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 07 Jan 2023 13:07:34 -0800 (PST) From: Simon Glass To: U-Boot Mailing List Cc: Roger Quadros , Tom Rini , Alper Nebi Yasak , Peter Geis , Jerome Forissier , huang lin , Jeffy Chen , Simon Glass , Kever Yang , Philipp Tomsich , Ivan Mikhaylov , Quentin Schulz , Philippe Reynes Subject: [PATCH v9 04/14] binman: Use a reference for binman symbols docs Date: Sat, 7 Jan 2023 14:07:11 -0700 Message-Id: <20230107210721.478062-5-sjg@chromium.org> X-Mailer: git-send-email 2.39.0.314.g84b9a713c41-goog In-Reply-To: <20230107210721.478062-1-sjg@chromium.org> References: <20230107210721.478062-1-sjg@chromium.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.6 at phobos.denx.de X-Virus-Status: Clean 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 --- Changes in v9: - Add new patch to use a reference for binman symbols docs 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 2899e1c7833..ef3e5a6d19b 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 b2ce7960d3b..5b9eb8b82c7 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 e8d180a46dd..d5639eef2e4 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 d1aa3b4fdad..be1610569fc 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 50a126dc7ef..e7ec329c902 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 1883a2bd5f1..397b9f89531 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 7e08e58f1e5..9bb2b5dda30 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 62e5969c6ec..31d7e8374e2 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 db3d8a91c9b..64c2767488d 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.0.314.g84b9a713c41-goog