\r
Used to provide system watchdog timer services\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
- This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#ifndef __ARCH_PROTOCOL_WATCHDOG_TIMER_H__\r
typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL EFI_WATCHDOG_TIMER_ARCH_PROTOCOL;\r
\r
/**\r
- A function of this type is called when the watchdog timer fires if a \r
+ A function of this type is called when the watchdog timer fires if a\r
handler has been registered.\r
\r
@param Time The time in 100 ns units that has passed since the watchdog\r
);\r
\r
/**\r
- This function registers a handler that is to be invoked when the watchdog \r
- timer fires. By default, the EFI_WATCHDOG_TIMER protocol will call the \r
- Runtime Service ResetSystem() when the watchdog timer fires. If a \r
- NotifyFunction is registered, then the NotifyFunction will be called before \r
- the Runtime Service ResetSystem() is called. If NotifyFunction is NULL, then \r
- the watchdog handler is unregistered. If a watchdog handler is registered, \r
- then EFI_SUCCESS is returned. If an attempt is made to register a handler \r
- when a handler is already registered, then EFI_ALREADY_STARTED is returned. \r
- If an attempt is made to uninstall a handler when a handler is not installed, \r
+ This function registers a handler that is to be invoked when the watchdog\r
+ timer fires. By default, the EFI_WATCHDOG_TIMER protocol will call the\r
+ Runtime Service ResetSystem() when the watchdog timer fires. If a\r
+ NotifyFunction is registered, then the NotifyFunction will be called before\r
+ the Runtime Service ResetSystem() is called. If NotifyFunction is NULL, then\r
+ the watchdog handler is unregistered. If a watchdog handler is registered,\r
+ then EFI_SUCCESS is returned. If an attempt is made to register a handler\r
+ when a handler is already registered, then EFI_ALREADY_STARTED is returned.\r
+ If an attempt is made to uninstall a handler when a handler is not installed,\r
then return EFI_INVALID_PARAMETER.\r
\r
@param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
previously registered.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
(EFIAPI *EFI_WATCHDOG_TIMER_REGISTER_HANDLER)(\r
IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This,\r
);\r
\r
/**\r
- This function sets the amount of time to wait before firing the watchdog \r
- timer to TimerPeriod 100 nS units. If TimerPeriod is 0, then the watchdog \r
+ This function sets the amount of time to wait before firing the watchdog\r
+ timer to TimerPeriod 100 nS units. If TimerPeriod is 0, then the watchdog\r
timer is disabled.\r
\r
@param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
error.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
(EFIAPI *EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD)(\r
IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This,\r
);\r
\r
/**\r
- This function retrieves the amount of time the system will wait before firing \r
- the watchdog timer. This period is returned in TimerPeriod, and EFI_SUCCESS \r
+ This function retrieves the amount of time the system will wait before firing\r
+ the watchdog timer. This period is returned in TimerPeriod, and EFI_SUCCESS\r
is returned. If TimerPeriod is NULL, then EFI_INVALID_PARAMETER is returned.\r
\r
@param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.\r
@retval EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
(EFIAPI *EFI_WATCHDOG_TIMER_GET_TIMER_PERIOD)(\r
IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This,\r
\r
\r
///\r
-/// This protocol provides the services required to implement the Boot Service \r
-/// SetWatchdogTimer(). It provides a service to set the amount of time to wait \r
-/// before firing the watchdog timer, and it also provides a service to register \r
-/// a handler that is invoked when the watchdog timer fires. This protocol can \r
-/// implement the watchdog timer by using the event and timer Boot Services, or \r
-/// it can make use of custom hardware. When the watchdog timer fires, control \r
-/// will be passed to a handler if one has been registered. If no handler has \r
-/// been registered, or the registered handler returns, then the system will be \r
+/// This protocol provides the services required to implement the Boot Service\r
+/// SetWatchdogTimer(). It provides a service to set the amount of time to wait\r
+/// before firing the watchdog timer, and it also provides a service to register\r
+/// a handler that is invoked when the watchdog timer fires. This protocol can\r
+/// implement the watchdog timer by using the event and timer Boot Services, or\r
+/// it can make use of custom hardware. When the watchdog timer fires, control\r
+/// will be passed to a handler if one has been registered. If no handler has\r
+/// been registered, or the registered handler returns, then the system will be\r
/// reset by calling the Runtime Service ResetSystem().\r
///\r
struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL {\r
projects / mirror_edk2.git / blobdiff