brain-hackers_pepepper-mirror/u-boot-brain
1
0
Fork 0
mirror of https://github.com/brain-hackers/u-boot-brain synced 2024-09-27 23:20:26 +09:00
Code Issues Projects Releases Wiki Activity

efi_loader: add Sphinx doc for __efi_runtime and __efi_runtime_data

Browse Source 
Document the macros __efi_runtime and __efi_runtime_data in Sphinx
style.

Signed-off-by: Marek Behún <marek.behun@nic.cz>
Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
This commit is contained in:
Marek Behún 2021-05-20 13:23:57 +02:00 committed by Tom Rini
parent 2bdc6f579b
commit 8283697311
1 changed files with 26 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
include/efi_loader.h
View File

@ -678,11 +678,34 @@ ssize_t efi_dp_check_length(const struct efi_device_path *dp,
(((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
/*
* Use these to indicate that your code / data should go into the EFI runtime
* section and thus still be available when the OS is running
/**
* __efi_runtime_data - declares a non-const variable for EFI runtime section
*
* This macro indicates that a variable is non-const and should go into the
* EFI runtime section, and thus still be available when the OS is running.
*
* Only use on variables not declared const.
*
* Example:
*
* ::
*
* static __efi_runtime_data my_computed_table[256];
*/
#define __efi_runtime_data __section(".data.efi_runtime")
/**
* __efi_runtime - declares a function for EFI runtime section
*
* This macro indicates that a function should go into the EFI runtime section,
* and thus still be available when the OS is running.
*
* Example:
*
* ::
*
* static __efi_runtime compute_my_table(void);
*/
#define __efi_runtime __section(".text.efi_runtime")
/* Indicate supported runtime services */