Mirrors/u-boot
2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2025-02-26 04:17:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

efi_loader: documentation of image loader

Browse source 
- Add missing function descriptions.
- Update existing function descriptions to match Sphinx style.
- Add lib/efi_loader/efi_image_loader.c to the input files for Sphinx
  generated documentation.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
This commit is contained in:
Heinrich Schuchardt 2019-02-16 15:22:13 +01:00
parent 1504bb0d96
commit 1db561e11f
2 changed files with 25 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
Documentation/efi.rst
View file

@ -9,6 +9,12 @@ Boot services
.. kernel-doc:: lib/efi_loader/efi_boottime.c .. kernel-doc:: lib/efi_loader/efi_boottime.c
:internal: :internal:
Image relocation
~~~~~~~~~~~~~~~~
.. kernel-doc:: lib/efi_loader/efi_image_loader.c
:internal:
Runtime services Runtime services
---------------- ----------------

28
lib/efi_loader/efi_image_loader.c
View file

@ -42,8 +42,8 @@ static int machines[] = {
#endif #endif
0 }; 0 };
/* /**
* Print information about a loaded image. * efi_print_image_info() - print information about a loaded image
* *
* If the program counter is located within the image the offset to the base * If the program counter is located within the image the offset to the base
* address is shown. * address is shown.
@ -51,7 +51,7 @@ static int machines[] = {
* @obj: EFI object * @obj: EFI object
* @image: loaded image * @image: loaded image
* @pc: program counter (use NULL to suppress offset output) * @pc: program counter (use NULL to suppress offset output)
* @return: status code * Return: status code
*/ */
static efi_status_t efi_print_image_info(struct efi_loaded_image_obj *obj, static efi_status_t efi_print_image_info(struct efi_loaded_image_obj *obj,
struct efi_loaded_image *image, struct efi_loaded_image *image,
@ -69,8 +69,8 @@ static efi_status_t efi_print_image_info(struct efi_loaded_image_obj *obj,
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/* /**
* Print information about all loaded images. * efi_print_image_infos() - print information about all loaded images
* *
* @pc: program counter (use NULL to suppress offset output) * @pc: program counter (use NULL to suppress offset output)
*/ */
@ -90,6 +90,15 @@ void efi_print_image_infos(void *pc)
} }
} }
/**
* efi_loader_relocate() - relocate UEFI binary
*
* @rel: pointer to the relocation table
* @rel_size: size of the relocation table in bytes
* @efi_reloc: actual load address of the image
* @pref_address: preferred load address of the image
* Return: status code
*/
static efi_status_t efi_loader_relocate(const IMAGE_BASE_RELOCATION *rel, static efi_status_t efi_loader_relocate(const IMAGE_BASE_RELOCATION *rel,
unsigned long rel_size, void *efi_reloc, unsigned long rel_size, void *efi_reloc,
unsigned long pref_address) unsigned long pref_address)
@ -159,11 +168,12 @@ void __weak invalidate_icache_all(void)
/* If the system doesn't support icache_all flush, cross our fingers */ /* If the system doesn't support icache_all flush, cross our fingers */
} }
/* /**
* Determine the memory types to be used for code and data. * efi_set_code_and_data_type() - determine the memory types to be used for code
* and data.
* *
* @loaded_image_info image descriptor * @loaded_image_info: image descriptor
* @image_type field Subsystem of the optional header for * @image_type: field Subsystem of the optional header for
* Windows specific field * Windows specific field
*/ */
static void efi_set_code_and_data_type( static void efi_set_code_and_data_type(