Nt32Pkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / Nt32Pkg / TimerDxe / Timer.h

/**@file\r
\r
Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
Module Name:\r
\r
  Timer.h\r
\r
Abstract:\r
\r
  NT Emulation Architectural Protocol Driver as defined in Tiano.\r
  This Timer module uses an NT Thread to simulate the timer-tick driven\r
  timer service.\r
\r
**/\r
\r
#ifndef _TIMER_H_\r
#define _TIMER_H_\r
\r
\r
#include <Uefi.h>\r
#include <WinNtDxe.h>\r
#include <Protocol/Timer.h>\r
#include <Protocol/Cpu.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/WinNtLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
\r
//\r
// Legal timer value range in 100 ns units\r
//\r
#define TIMER_MINIMUM_VALUE 0\r
#define TIMER_MAXIMUM_VALUE (0x100000000 - 1)\r
\r
//\r
// Default timer value in 100 ns units (10 ms)\r
//\r
#define DEFAULT_TIMER_TICK_DURATION 100000\r
\r
//\r
// Function Prototypes\r
//\r
EFI_STATUS\r
EFIAPI\r
WinNtTimerDriverInitialize (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  ImageHandle - TODO: add argument description\r
  SystemTable - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtTimerDriverRegisterHandler (\r
  IN EFI_TIMER_ARCH_PROTOCOL  *This,\r
  IN EFI_TIMER_NOTIFY         NotifyFunction\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  This            - TODO: add argument description\r
  NotifyFunction  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtTimerDriverSetTimerPeriod (\r
  IN EFI_TIMER_ARCH_PROTOCOL  *This,\r
  IN UINT64                   TimerPeriod\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  This        - TODO: add argument description\r
  TimerPeriod - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtTimerDriverGetTimerPeriod (\r
  IN EFI_TIMER_ARCH_PROTOCOL   *This,\r
  OUT UINT64                   *TimerPeriod\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  This        - TODO: add argument description\r
  TimerPeriod - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtTimerDriverGenerateSoftInterrupt (\r
  IN EFI_TIMER_ARCH_PROTOCOL  *This\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  This  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
#endif\r