X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FDxe%2FArchProtocol%2FWatchdogTimer.h;fp=MdePkg%2FInclude%2FDxe%2FArchProtocol%2FWatchdogTimer.h;h=8e31a36bc5ec4d2db51be9265d94bd731c7cb268;hb=0647c9adf92c6a8712091607a73b2768327a865d;hp=a8d84b18da922491e6dd2996c819899de40ea898;hpb=151c1ccdcd6960c550fa491bd0ed467416bb2b74;p=mirror_edk2.git diff --git a/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h b/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h index a8d84b18da..8e31a36bc5 100644 --- a/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h +++ b/MdePkg/Include/Dxe/ArchProtocol/WatchdogTimer.h @@ -37,9 +37,9 @@ typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL EFI_WATCHDOG_TIMER_ARCH_PROTOC A function of this type is called when the watchdog timer fires if a handler has been registered. - @param Time The time in 100 ns units that has passed since the watchdog - timer was armed. For the notify function to be called, this - must be greater than TimerPeriod. + @param Time The time in 100 ns units that has passed since the watchdog + timer was armed. For the notify function to be called, this + must be greater than TimerPeriod. @return None. @@ -62,19 +62,16 @@ VOID If an attempt is made to uninstall a handler when a handler is not installed, then return EFI_INVALID_PARAMETER. - @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance. - - @param NotifyFunction The function to call when the watchdog timer fires. If this - is NULL, then the handler will be unregistered. + @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance. + @param NotifyFunction The function to call when the watchdog timer fires. If this + is NULL, then the handler will be unregistered. - @retval EFI_SUCCESS The watchdog timer handler was registered or - unregistered. - - @retval EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already - registered. - - @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not - previously registered. + @retval EFI_SUCCESS The watchdog timer handler was registered or + unregistered. + @retval EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already + registered. + @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not + previously registered. **/ typedef @@ -89,17 +86,15 @@ EFI_STATUS timer to TimerPeriod 100 nS units. If TimerPeriod is 0, then the watchdog timer is disabled. - @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance. - - @param TimerPeriod The amount of time in 100 nS units to wait before the watchdog - timer is fired. If TimerPeriod is zero, then the watchdog - timer is disabled. + @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance. + @param TimerPeriod The amount of time in 100 nS units to wait before the watchdog + timer is fired. If TimerPeriod is zero, then the watchdog + timer is disabled. - @retval EFI_SUCCESS The watchdog timer has been programmed to fire in Time - 100 nS units. - - @retval EFI_DEVICE_ERROR A watchdog timer could not be programmed due to a device - error. + @retval EFI_SUCCESS The watchdog timer has been programmed to fire in Time + 100 nS units. + @retval EFI_DEVICE_ERROR A watchdog timer could not be programmed due to a device + error. **/ typedef @@ -114,16 +109,14 @@ EFI_STATUS the watchdog timer. This period is returned in TimerPeriod, and EFI_SUCCESS is returned. If TimerPeriod is NULL, then EFI_INVALID_PARAMETER is returned. - @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance. - - @param TimerPeriod A pointer to the amount of time in 100 nS units that the system - will wait before the watchdog timer is fired. If TimerPeriod of - zero is returned, then the watchdog timer is disabled. + @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance. + @param TimerPeriod A pointer to the amount of time in 100 nS units that the system + will wait before the watchdog timer is fired. If TimerPeriod of + zero is returned, then the watchdog timer is disabled. - @retval EFI_SUCCESS The amount of time that the system will wait before - firing the watchdog timer was returned in TimerPeriod. - - @retval EFI_INVALID_PARAMETER TimerPeriod is NULL. + @retval EFI_SUCCESS The amount of time that the system will wait before + firing the watchdog timer was returned in TimerPeriod. + @retval EFI_INVALID_PARAMETER TimerPeriod is NULL. **/ typedef @@ -148,16 +141,16 @@ EFI_STATUS been registered, or the registered handler returns, then the system will be reset by calling the Runtime Service ResetSystem(). - @param RegisterHandler - Registers a handler that is invoked when the watchdog - timer fires. + @param RegisterHandler Registers a handler that is invoked when the watchdog + timer fires. - @param SetTimerPeriod - Sets the amount of time in 100 ns units to wait before the - watchdog timer is fired. If this function is supported, - then the watchdog timer period will be rounded up to the - nearest supported watchdog timer period. + @param SetTimerPeriod Sets the amount of time in 100 ns units to wait before the + watchdog timer is fired. If this function is supported, + then the watchdog timer period will be rounded up to the + nearest supported watchdog timer period. - @param GetTimerPeriod - Retrieves the amount of time in 100 ns units that the - system will wait before the watchdog timer is fired. + @param GetTimerPeriod Retrieves the amount of time in 100 ns units that the + system will wait before the watchdog timer is fired. **/ struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL {