Commit eaa6fc67 authored by Heinrich Schuchardt's avatar Heinrich Schuchardt Committed by Ard Biesheuvel
Browse files

efi/libstub: Add function description of efi_allocate_pages()



Provide a Sphinx style function description for efi_allocate_pages().

Signed-off-by: default avatarHeinrich Schuchardt <xypron.glpk@gmx.de>
Link: https://lore.kernel.org/r/20200216171340.6070-1-xypron.glpk@gmx.de


Signed-off-by: default avatarArd Biesheuvel <ardb@kernel.org>
parent 2931d526
Loading
Loading
Loading
Loading
+14 −2
Original line number Diff line number Diff line
@@ -65,8 +65,20 @@ fail:
	return status;
}

/*
 * Allocate at the highest possible address that is not above 'max'.
/**
 * efi_allocate_pages() - Allocate memory pages
 * @size:	minimum number of bytes to allocate
 * @addr:	On return the address of the first allocated page. The first
 *		allocated page has alignment EFI_ALLOC_ALIGN which is an
 *		architecture dependent multiple of the page size.
 * @max:	the address that the last allocated memory page shall not
 *		exceed
 *
 * Allocate pages as EFI_LOADER_DATA. The allocated pages are aligned according
 * to EFI_ALLOC_ALIGN. The last allocated page will not exceed the address
 * given by @max.
 *
 * Return:	status code
 */
efi_status_t efi_allocate_pages(unsigned long size, unsigned long *addr,
				unsigned long max)