summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorSimon Glass <[email protected]>2023-11-18 14:04:59 -0700
committerTom Rini <[email protected]>2023-12-13 11:51:24 -0500
commit429acb38dbf359a84666bdc00043e1f24df4df9d (patch)
tree80dbc004fae639947206f6db912a3dfdf9810356 /include
parent820110c4532ae45133a338c3c0b103494acba4c4 (diff)
image: Document error codes from fit_image_load()
Put a list of these in the function documentation so it is easier to decode what went wrong. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Tom Rini <[email protected]>
Diffstat (limited to 'include')
-rw-r--r--include/image.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/include/image.h b/include/image.h
index 798c5f9c16e..d37e4472167 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,