mirror of
https://github.com/CloverHackyColor/CloverBootloader.git
synced 2024-11-28 12:25:19 +01:00
103 lines
4.1 KiB
C
103 lines
4.1 KiB
C
|
/** @file
|
||
|
|
The internal include file for WatchDogTimer module.
|
||
|
|
|
||
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
||
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||
|
|
|
||
|
|
**/
|
||
|
|
|
||
|
|
#ifndef _WATCHDOG_TIMER_H_
|
||
|
|
#define _WATCHDOG_TIMER_H_
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
#include <Uefi.h>
|
||
|
|
#include <Library/DebugLib.h>
|
||
|
|
#include <Library/UefiDriverEntryPoint.h>
|
||
|
|
#include <Library/ReportStatusCodeLib.h>
|
||
|
|
#include <Library/UefiBootServicesTableLib.h>
|
||
|
|
#include <Library/UefiRuntimeServicesTableLib.h>
|
||
|
|
#include <Protocol/WatchdogTimer.h>
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
Registers a handler that is to be invoked when the watchdog timer fires.
|
||
|
|
|
||
|
|
This function registers a handler that is to be invoked when the watchdog
|
||
|
|
timer fires. By default, the EFI_WATCHDOG_TIMER protocol will call the
|
||
|
|
Runtime Service ResetSystem() when the watchdog timer fires. If a
|
||
|
|
NotifyFunction is registered, then the NotifyFunction will be called before
|
||
|
|
the Runtime Service ResetSystem() is called. If NotifyFunction is NULL, then
|
||
|
|
the watchdog handler is unregistered. If a watchdog handler is registered,
|
||
|
|
then EFI_SUCCESS is returned. If an attempt is made to register a handler
|
||
|
|
when a handler is already registered, then EFI_ALREADY_STARTED is returned.
|
||
|
|
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.
|
||
|
|
|
||
|
|
@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.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
WatchdogTimerDriverRegisterHandler (
|
||
|
|
IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This,
|
||
|
|
IN EFI_WATCHDOG_TIMER_NOTIFY NotifyFunction
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Sets the amount of time in the future to fire the watchdog timer.
|
||
|
|
|
||
|
|
This function sets the amount of time to wait before firing the watchdog
|
||
|
|
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.
|
||
|
|
|
||
|
|
@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.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
WatchdogTimerDriverSetTimerPeriod (
|
||
|
|
IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This,
|
||
|
|
IN UINT64 TimerPeriod
|
||
|
|
);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Retrieves the amount of time in 100 ns units that the system will wait before firing the watchdog timer.
|
||
|
|
|
||
|
|
This function retrieves the amount of time the system will wait before firing
|
||
|
|
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.
|
||
|
|
|
||
|
|
@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.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
EFIAPI
|
||
|
|
WatchdogTimerDriverGetTimerPeriod (
|
||
|
|
IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *This,
|
||
|
|
IN UINT64 *TimerPeriod
|
||
|
|
);
|
||
|
|
|
||
|
|
#endif
|