#ifndef __ARCH_PROTOCOL_WATCHDOG_TIMER_H__\r
#define __ARCH_PROTOCOL_WATCHDOG_TIMER_H__\r
\r
-//\r
-// Global ID for the Watchdog Timer Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Watchdog Timer Architectural Protocol\r
+///\r
#define EFI_WATCHDOG_TIMER_ARCH_PROTOCOL_GUID \\r
{ 0x665E3FF5, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } }\r
\r
-//\r
-// Declare forward reference for the Timer Architectural Protocol\r
-//\r
+///\r
+/// Declare forward reference for the Timer Architectural Protocol\r
+///\r
typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL EFI_WATCHDOG_TIMER_ARCH_PROTOCOL;\r
\r
/**\r
);\r
\r
\r
-/**\r
- Interface stucture for the Watchdog Timer Architectural Protocol.\r
-\r
- @par Protocol Description:\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
- @param RegisterHandler Registers a handler that is invoked when the watchdog\r
- timer fires.\r
-\r
- @param SetTimerPeriod Sets the amount of time in 100 ns units to wait before the\r
- watchdog timer is fired. If this function is supported,\r
- then the watchdog timer period will be rounded up to the\r
- nearest supported watchdog timer period.\r
-\r
- @param GetTimerPeriod Retrieves the amount of time in 100 ns units that the\r
- system will wait before the watchdog timer is fired.\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
+/// reset by calling the Runtime Service ResetSystem().\r
+///\r
struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL {\r
EFI_WATCHDOG_TIMER_REGISTER_HANDLER RegisterHandler;\r
EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD SetTimerPeriod;\r