4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Watchdog Timer Architectural Protocol as defined in PI Specification VOLUME 2 DXE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Used to provide system watchdog timer services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Global ID for the Watchdog Timer Architectural Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x665E3FF5, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Declare forward reference for the Timer Architectural Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL EFI_WATCHDOG_TIMER_ARCH_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A function of this type is called when the watchdog timer fires if a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handler has been registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Time The time in 100 ns units that has passed since the watchdog
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync timer was armed. For the notify function to be called, this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must be greater than TimerPeriod.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return None.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function registers a handler that is to be invoked when the watchdog
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync timer fires. By default, the EFI_WATCHDOG_TIMER protocol will call the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Runtime Service ResetSystem() when the watchdog timer fires. If a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NotifyFunction is registered, then the NotifyFunction will be called before
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Runtime Service ResetSystem() is called. If NotifyFunction is NULL, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the watchdog handler is unregistered. If a watchdog handler is registered,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then EFI_SUCCESS is returned. If an attempt is made to register a handler
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when a handler is already registered, then EFI_ALREADY_STARTED is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If an attempt is made to uninstall a handler when a handler is not installed,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then return EFI_INVALID_PARAMETER.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotifyFunction The function to call when the watchdog timer fires. If this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is NULL, then the handler will be unregistered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The watchdog timer handler was registered or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unregistered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED NotifyFunction is not NULL, and a handler is already
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync previously registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function sets the amount of time to wait before firing the watchdog
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync timer to TimerPeriod 100 nS units. If TimerPeriod is 0, then the watchdog
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync timer is disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TimerPeriod The amount of time in 100 nS units to wait before the watchdog
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync timer is fired. If TimerPeriod is zero, then the watchdog
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync timer is disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The watchdog timer has been programmed to fire in Time
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 100 nS units.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A watchdog timer could not be programmed due to a device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function retrieves the amount of time the system will wait before firing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the watchdog timer. This period is returned in TimerPeriod, and EFI_SUCCESS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned. If TimerPeriod is NULL, then EFI_INVALID_PARAMETER is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The EFI_WATCHDOG_TIMER_ARCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TimerPeriod A pointer to the amount of time in 100 nS units that the system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will wait before the watchdog timer is fired. If TimerPeriod of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync zero is returned, then the watchdog timer is disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The amount of time that the system will wait before
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync firing the watchdog timer was returned in TimerPeriod.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This protocol provides the services required to implement the Boot Service
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// SetWatchdogTimer(). It provides a service to set the amount of time to wait
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// before firing the watchdog timer, and it also provides a service to register
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// a handler that is invoked when the watchdog timer fires. This protocol can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// implement the watchdog timer by using the event and timer Boot Services, or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// it can make use of custom hardware. When the watchdog timer fires, control
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// will be passed to a handler if one has been registered. If no handler has
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// been registered, or the registered handler returns, then the system will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// reset by calling the Runtime Service ResetSystem().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_WATCHDOG_TIMER_REGISTER_HANDLER RegisterHandler;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD SetTimerPeriod;