Eric Lee / smarc-uboot

Download as
Browse Code ยป

Commit 1db561e11f2b6b6cd8f64035cc12b067dd6c1f91

Authored by Heinrich Schuchardt
1 parent 1504bb0d96
Exists in smarc_8mq_lf_v2020.04 and in 11 other branches 8qm-imx_v2020.04_5.4.70_2.3.0, emb_lf_v2022.04, pitx_8mp_lf_v2020.04, smarc-8m-android-10.0.0_2.6.0, smarc-8m-android-11.0.0_2.0.0, smarc-8mp-android-11.0.0_2.0.0, smarc_8m-imx_v2019.04_4.19.35_1.1.0, smarc_8mm-imx_v2019.04_4.19.35_1.1.0, smarc_8mm-imx_v2020.04_5.4.24_2.1.0, smarc_8mp_lf_v2020.04, smarc_8mq-imx_v2020.04_5.4.24_2.1.0

efi_loader: documentation of image loader 

- 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>

Showing 2 changed files with 25 additions and 9 deletions Side-by-side Diff

Documentation/efi.rst
Diff comments   View file @ 1db561e
... ... @@ -9,6 +9,12 @@
9 9 .. kernel-doc:: lib/efi_loader/efi_boottime.c
10 10 :internal:
11 11  
  12 +Image relocation
  13 +~~~~~~~~~~~~~~~~
  14 +
  15 +.. kernel-doc:: lib/efi_loader/efi_image_loader.c
  16 + :internal:
  17 +
12 18 Runtime services
13 19 ----------------
14 20  
lib/efi_loader/efi_image_loader.c
Diff comments   View file @ 1db561e
... ... @@ -42,8 +42,8 @@
42 42 #endif
43 43 0 };
44 44  
45   -/*
46   - * Print information about a loaded image.
  45 +/**
  46 + * efi_print_image_info() - print information about a loaded image
47 47 *
48 48 * If the program counter is located within the image the offset to the base
49 49 * address is shown.
... ... @@ -51,7 +51,7 @@
51 51 * @obj: EFI object
52 52 * @image: loaded image
53 53 * @pc: program counter (use NULL to suppress offset output)
54   - * @return: status code
  54 + * Return: status code
55 55 */
56 56 static efi_status_t efi_print_image_info(struct efi_loaded_image_obj *obj,
57 57 struct efi_loaded_image *image,
... ... @@ -69,8 +69,8 @@
69 69 return EFI_SUCCESS;
70 70 }
71 71  
72   -/*
73   - * Print information about all loaded images.
  72 +/**
  73 + * efi_print_image_infos() - print information about all loaded images
74 74 *
75 75 * @pc: program counter (use NULL to suppress offset output)
76 76 */
... ... @@ -90,6 +90,15 @@
90 90 }
91 91 }
92 92  
  93 +/**
  94 + * efi_loader_relocate() - relocate UEFI binary
  95 + *
  96 + * @rel: pointer to the relocation table
  97 + * @rel_size: size of the relocation table in bytes
  98 + * @efi_reloc: actual load address of the image
  99 + * @pref_address: preferred load address of the image
  100 + * Return: status code
  101 + */
93 102 static efi_status_t efi_loader_relocate(const IMAGE_BASE_RELOCATION *rel,
94 103 unsigned long rel_size, void *efi_reloc,
95 104 unsigned long pref_address)
96 105  
... ... @@ -159,11 +168,12 @@
159 168 /* If the system doesn't support icache_all flush, cross our fingers */
160 169 }
161 170  
162   -/*
163   - * Determine the memory types to be used for code and data.
  171 +/**
  172 + * efi_set_code_and_data_type() - determine the memory types to be used for code
  173 + * and data.
164 174 *
165   - * @loaded_image_info image descriptor
166   - * @image_type field Subsystem of the optional header for
  175 + * @loaded_image_info: image descriptor
  176 + * @image_type: field Subsystem of the optional header for
167 177 * Windows specific field
168 178 */
169 179 static void efi_set_code_and_data_type(