diff options
author | Heinrich Schuchardt | 2023-08-14 08:44:26 +0200 |
---|---|---|
committer | Heinrich Schuchardt | 2023-08-15 18:21:17 +0200 |
commit | 289bd72ea41fd45237a34593065ff107afc2a9a9 (patch) | |
tree | ad0e78fd5ab4fca865287cc90c4846f5d8417849 /include/init.h | |
parent | 78246baa8d82a8d01feeefbcf8d97f23a9d5c728 (diff) |
doc: description of board_get_usable_ram_top()
Improve the description of function board_get_usable_ram_top().
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'include/init.h')
-rw-r--r-- | include/init.h | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/include/init.h b/include/init.h index 88730816851..dc3c1f220c3 100644 --- a/include/init.h +++ b/include/init.h @@ -296,13 +296,18 @@ int checkboard(void); int show_board_info(void); /** - * Get the uppermost pointer that is valid to access + * board_get_usable_ram_top() - get uppermost address for U-Boot relocation * - * Some systems may not map all of their address space. This function allows - * boards to indicate what their highest support pointer value is for DRAM - * access. + * Some systems have reserved memory areas in high memory. By implementing this + * function boards can indicate the highest address value to be used when + * relocating U-Boot. The returned address is exclusive (i.e. 1 byte above the + * last usable address). * - * @param total_size Size of U-Boot (unused?) + * Due to overflow on systems with 32bit phys_addr_t a value 0 is used instead + * of 4GiB. + * + * @total_size: monitor length in bytes (size of U-Boot code) + * Return: uppermost address for U-Boot relocation */ phys_size_t board_get_usable_ram_top(phys_size_t total_size); |