efi/libstub: Describe efi_relocate_kernel()

Update the description of of efi_relocate_kernel() to match Sphinx style.

Update parameter references in the description of other memory functions
to use @param style.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20200220065317.9096-1-xypron.glpk@gmx.de
Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
This commit is contained in:
Heinrich Schuchardt 2020-02-20 07:53:17 +01:00 committed by Ard Biesheuvel
parent 1d9b176835
commit 0255973bd6
1 changed files with 20 additions and 9 deletions

View File

@ -230,15 +230,26 @@ void efi_free(unsigned long size, unsigned long addr)
efi_bs_call(free_pages, addr, nr_pages); efi_bs_call(free_pages, addr, nr_pages);
} }
/* /**
* Relocate a kernel image, either compressed or uncompressed. * efi_relocate_kernel() - copy memory area
* In the ARM64 case, all kernel images are currently * @image_addr: pointer to address of memory area to copy
* uncompressed, and as such when we relocate it we need to * @image_size: size of memory area to copy
* allocate additional space for the BSS segment. Any low * @alloc_size: minimum size of memory to allocate, must be greater or
* memory that this function should avoid needs to be * equal to image_size
* unavailable in the EFI memory map, as if the preferred * @preferred_addr: preferred target address
* address is not available the lowest available address will * @alignment: minimum alignment of the allocated memory area. It
* be used. * should be a power of two.
* @min_addr: minimum target address
*
* Copy a memory area to a newly allocated memory area aligned according
* to @alignment but at least EFI_ALLOC_ALIGN. If the preferred address
* is not available, the allocated address will not be below @min_addr.
* On exit, @image_addr is updated to the target copy address that was used.
*
* This function is used to copy the Linux kernel verbatim. It does not apply
* any relocation changes.
*
* Return: status code
*/ */
efi_status_t efi_relocate_kernel(unsigned long *image_addr, efi_status_t efi_relocate_kernel(unsigned long *image_addr,
unsigned long image_size, unsigned long image_size,