Nt32Pkg/TimerDxe/Timer.h

   1 /**@file
   2
   3 Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>
   4 SPDX-License-Identifier: BSD-2-Clause-Patent
   5
   6 Module Name:
   7
   8   Timer.h
   9
  10 Abstract:
  11
  12   NT Emulation Architectural Protocol Driver as defined in Tiano.
  13   This Timer module uses an NT Thread to simulate the timer-tick driven
  14   timer service.
  15
  16 **/
  17
  18 #ifndef _TIMER_H_
  19 #define _TIMER_H_
  20
  21
  22 #include <Uefi.h>
  23 #include <WinNtDxe.h>
  24 #include <Protocol/Timer.h>
  25 #include <Protocol/Cpu.h>
  26 #include <Library/DebugLib.h>
  27 #include <Library/UefiDriverEntryPoint.h>
  28 #include <Library/WinNtLib.h>
  29 #include <Library/UefiBootServicesTableLib.h>
  30
  31
  32 //
  33 // Legal timer value range in 100 ns units
  34 //
  35 #define TIMER_MINIMUM_VALUE 0
  36 #define TIMER_MAXIMUM_VALUE (0x100000000 - 1)
  37
  38 //
  39 // Default timer value in 100 ns units (10 ms)
  40 //
  41 #define DEFAULT_TIMER_TICK_DURATION 100000
  42
  43 //
  44 // Function Prototypes
  45 //
  46 EFI_STATUS
  47 EFIAPI
  48 WinNtTimerDriverInitialize (
  49   IN EFI_HANDLE        ImageHandle,
  50   IN EFI_SYSTEM_TABLE  *SystemTable
  51   )
  52 /*++
  53
  54 Routine Description:
  55
  56   TODO: Add function description
  57
  58 Arguments:
  59
  60   ImageHandle - TODO: add argument description
  61   SystemTable - TODO: add argument description
  62
  63 Returns:
  64
  65   TODO: add return values
  66
  67 --*/
  68 ;
  69
  70 EFI_STATUS
  71 EFIAPI
  72 WinNtTimerDriverRegisterHandler (
  73   IN EFI_TIMER_ARCH_PROTOCOL  *This,
  74   IN EFI_TIMER_NOTIFY         NotifyFunction
  75   )
  76 /*++
  77
  78 Routine Description:
  79
  80   TODO: Add function description
  81
  82 Arguments:
  83
  84   This            - TODO: add argument description
  85   NotifyFunction  - TODO: add argument description
  86
  87 Returns:
  88
  89   TODO: add return values
  90
  91 --*/
  92 ;
  93
  94 EFI_STATUS
  95 EFIAPI
  96 WinNtTimerDriverSetTimerPeriod (
  97   IN EFI_TIMER_ARCH_PROTOCOL  *This,
  98   IN UINT64                   TimerPeriod
  99   )
 100 /*++
 101
 102 Routine Description:
 103
 104   TODO: Add function description
 105
 106 Arguments:
 107
 108   This        - TODO: add argument description
 109   TimerPeriod - TODO: add argument description
 110
 111 Returns:
 112
 113   TODO: add return values
 114
 115 --*/
 116 ;
 117
 118 EFI_STATUS
 119 EFIAPI
 120 WinNtTimerDriverGetTimerPeriod (
 121   IN EFI_TIMER_ARCH_PROTOCOL   *This,
 122   OUT UINT64                   *TimerPeriod
 123   )
 124 /*++
 125
 126 Routine Description:
 127
 128   TODO: Add function description
 129
 130 Arguments:
 131
 132   This        - TODO: add argument description
 133   TimerPeriod - TODO: add argument description
 134
 135 Returns:
 136
 137   TODO: add return values
 138
 139 --*/
 140 ;
 141
 142 EFI_STATUS
 143 EFIAPI
 144 WinNtTimerDriverGenerateSoftInterrupt (
 145   IN EFI_TIMER_ARCH_PROTOCOL  *This
 146   )
 147 /*++
 148
 149 Routine Description:
 150
 151   TODO: Add function description
 152
 153 Arguments:
 154
 155   This  - TODO: add argument description
 156
 157 Returns:
 158
 159   TODO: add return values
 160
 161 --*/
 162 ;
 163
 164 #endif