leandrof/u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

efi_loader: function descriptions efi_watchdog.c

Browse Source 
Correct function descriptions in efi_watchdog.c.
Add the descriptions to the generated HTML documentation.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
This commit is contained in:
Heinrich Schuchardt 2020-04-10 17:51:56 +02:00
parent 55976b7fae
commit 540faca8a1
2 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/efi.rst
View File

@ -78,6 +78,12 @@ Memory services
.. kernel-doc:: lib/efi_loader/efi_memory.c
:internal:
SetWatchdogTimer service
~~~~~~~~~~~~~~~~~~~~~~~~
.. kernel-doc:: lib/efi_loader/efi_watchdog.c
:internal:
Runtime services
----------------

18
lib/efi_loader/efi_watchdog.c
View File

@ -13,7 +13,9 @@
static struct efi_event *watchdog_timer_event;
/*
/**
* efi_watchdog_timer_notify() - resets system upon watchdog event
*
* Reset the system when the watchdog event is notified.
*
* @event: the watchdog event
@ -31,13 +33,13 @@ static void EFIAPI efi_watchdog_timer_notify(struct efi_event *event,
EFI_EXIT(EFI_UNSUPPORTED);
}
/*
* Reset the watchdog timer.
/**
* efi_set_watchdog() - resets the watchdog timer
*
* This function is used by the SetWatchdogTimer service.
*
* @timeout: seconds before reset by watchdog
* @return: status code
* Return: status code
*/
efi_status_t efi_set_watchdog(unsigned long timeout)
{
@ -53,10 +55,12 @@ efi_status_t efi_set_watchdog(unsigned long timeout)
return r;
}
/*
* Initialize the EFI watchdog.
/**
* efi_watchdog_register() - initializes the EFI watchdog
*
* This function is called by efi_init_obj_list()
* This function is called by efi_init_obj_list().
*
* Return: status code
*/
efi_status_t efi_watchdog_register(void)
{