[11/29] image: Document error codes from fit_image_load()

Message ID	20231112000923.73568-12-sjg@chromium.org
State	Superseded
Delegated to:	Tom Rini
Headers	show Return-Path: <u-boot-bounces@lists.denx.de> From: Simon Glass <sjg@chromium.org> To: U-Boot Mailing List <u-boot@lists.denx.de> Cc: Tom Rini <trini@konsulko.com>, Ilias Apalodimas <ilias.apalodimas@linaro.org>, Heinrich Schuchardt <xypron.glpk@gmx.de>, Simon Glass <sjg@chromium.org>, Joe Hershberger <joe.hershberger@ni.com>, Marek Vasut <marex@denx.de>, Mattijs Korpershoek <mkorpershoek@baylibre.com>, Safae Ouajih <souajih@baylibre.com>, Sean Anderson <sean.anderson@seco.com> Subject: [PATCH 11/29] image: Document error codes from fit_image_load() Date: Sat, 11 Nov 2023 17:08:56 -0700 Message-ID: <20231112000923.73568-12-sjg@chromium.org> In-Reply-To: <20231112000923.73568-1-sjg@chromium.org> References: <20231112000923.73568-1-sjg@chromium.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: list Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" <u-boot-bounces@lists.denx.de>
Series	bootm: Refactoring to reduce reliance on CMDLINE (part A) \| expand [00/29] bootm: Refactoring to reduce reliance on CMDLINE (part A) [01/29] arm: x86: Drop discarding of command linker-lists [02/29] mmc: env: Unify the U_BOOT_ENV_LOCATION conditions [03/29] treewide: Tidy up semicolon after command macros [04/29] bootstd: Add missing header file from bootdev.h [05/29] bootstd: Introduce programmable boot [06/29] bootm: Drop arguments from bootm_start() [07/29] bootm: Simplify arguments for bootm_pre_load() [08/29] bootm: Move boot_get_kernel() higher in the file [09/29] image: Tidy up genimg_get_kernel_addr_fit() [10/29] bootm: Reduce arguments to boot_get_kernel() [11/29] image: Document error codes from fit_image_load() [12/29] bootm: Adjust boot_get_kernel() to return an error [13/29] bootm: Use the error return from boot_get_kernel() [14/29] bootstage: Drop BOOTSTAGE_ID_FIT_KERNEL_INFO [15/29] bootm: Move error printing out of boot_get_kernel() [16/29] bootm: Reduce arguments to boot_find_os() [17/29] bootm: Reduce arguments to boot_get_ramdisk() [18/29] fdt: Allow use of fdt_support inside if() statements [19/29] bootm: Drop #ifdef in bootm_find_images() [20/29] bootm: Pass image buffer to boot_get_fdt() [21/29] bootm: Reduce arguments to boot_get_fdt() [22/29] bootm: Reduce arguments to boot_get_fpga() [23/29] bootm: Reduce arguments to boot_get_loadables() [24/29] bootm: Simplify Android ramdisk addr in bootm_find_images() [25/29] bootm: efi: Drop special call to bootm_find_other() [26/29] bootm: optee: Drop special call to bootm_find_other() [27/29] bootm: Adjust the parameters of bootm_find_images() [28/29] bootm: Add a function to check overlap [29/29] bootm: Reduce arguments to bootm_find_other()

Message ID

20231112000923.73568-12-sjg@chromium.org

State

Superseded

Delegated to:

Tom Rini

Headers

From: Simon Glass <sjg@chromium.org>
To: U-Boot Mailing List <u-boot@lists.denx.de>
Cc: Tom Rini <trini@konsulko.com>,
 Ilias Apalodimas <ilias.apalodimas@linaro.org>,
 Heinrich Schuchardt <xypron.glpk@gmx.de>, Simon Glass <sjg@chromium.org>,
 Joe Hershberger <joe.hershberger@ni.com>, Marek Vasut <marex@denx.de>,
 Mattijs Korpershoek <mkorpershoek@baylibre.com>,
 Safae Ouajih <souajih@baylibre.com>, Sean Anderson <sean.anderson@seco.com>
Subject: [PATCH 11/29] image: Document error codes from fit_image_load()
Date: Sat, 11 Nov 2023 17:08:56 -0700
Message-ID: <20231112000923.73568-12-sjg@chromium.org>
In-Reply-To: <20231112000923.73568-1-sjg@chromium.org>
References: <20231112000923.73568-1-sjg@chromium.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: list
Errors-To: u-boot-bounces@lists.denx.de
Sender: "U-Boot" <u-boot-bounces@lists.denx.de>

Series

bootm: Refactoring to reduce reliance on CMDLINE (part A) | expand

Put a list of these in the function documentation so it is easier to decode what went wrong. Signed-off-by: Simon Glass <sjg@chromium.org> --- include/image.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-)

Comments

Tom Rini Nov. 15, 2023, 10:36 p.m. UTC | #1

On Sat, Nov 11, 2023 at 05:08:56PM -0700, Simon Glass wrote:

> Put a list of these in the function documentation so it is easier to
> decode what went wrong.
> 
> Signed-off-by: Simon Glass <sjg@chromium.org>

Reviewed-by: Tom Rini <trini@konsulko.com>

diff --git a/include/image.h b/include/image.h
index 798c5f9c16e4..d37e44721672 100644
--- a/include/image.h
+++ b/include/image.h
@@ -728,7 +728,13 @@  int boot_get_fdt_fit(struct bootm_headers *images, ulong addr,
  * @param load_op	Decribes what to do with the load address
  * @param datap		Returns address of loaded image
  * @param lenp		Returns length of loaded image
- * Return: node offset of image, or -ve error code on error
+ * Return: node offset of image, or -ve error code on error:
+ *   -ENOEXEC - unsupported architecture
+ *   -ENOENT - could not find image / subimage
+ *   -EACCES - hash, signature or decryptions failure
+ *   -EBADF - invalid OS or image type, or cannot get image load-address
+ *   -EXDEV - memory overwritten / overlap
+ *   -NOEXEC - image decompression error, or invalid FDT
  */
 int fit_image_load(struct bootm_headers *images, ulong addr,
 		   const char **fit_unamep, const char **fit_uname_configp,

[11/29] image: Document error codes from fit_image_load()

Commit Message

Comments

Patch