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>
This commit is contained in:
Heinrich Schuchardt
2023-08-14 08:44:26 +02:00
parent 78246baa8d
commit 289bd72ea4

View File

@@ -296,13 +296,18 @@ int checkboard(void);
int show_board_info(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 * Some systems have reserved memory areas in high memory. By implementing this
* boards to indicate what their highest support pointer value is for DRAM * function boards can indicate the highest address value to be used when
* access. * 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); phys_size_t board_get_usable_ram_top(phys_size_t total_size);