EdkUnixPkg/Dxe/UnixThunk/Chipset/Timer/Timer.h

   1 /*++
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   Timer.h
  15
  16 Abstract:
  17
  18   UNIX Emulation Architectural Protocol Driver as defined in Tiano.
  19   This Timer module uses an UNIX Thread to simulate the timer-tick driven
  20   timer service.
  21
  22 --*/
  23
  24 #ifndef _TIMER_H_
  25 #define _TIMER_H_
  26
  27
  28
  29
  30 //
  31 // Legal timer value range in 100 ns units
  32 //
  33 #define TIMER_MINIMUM_VALUE 0
  34 #define TIMER_MAXIMUM_VALUE (0x100000000ULL - 1)
  35
  36 //
  37 // Default timer value in 100 ns units (10 ms)
  38 //
  39 #define DEFAULT_TIMER_TICK_DURATION 100000
  40
  41 //
  42 // Function Prototypes
  43 //
  44 EFI_STATUS
  45 EFIAPI
  46 UnixTimerDriverInitialize (
  47   IN EFI_HANDLE        ImageHandle,
  48   IN EFI_SYSTEM_TABLE  *SystemTable
  49   )
  50 /*++
  51
  52 Routine Description:
  53
  54   TODO: Add function description
  55
  56 Arguments:
  57
  58   ImageHandle - TODO: add argument description
  59   SystemTable - TODO: add argument description
  60
  61 Returns:
  62
  63   TODO: add return values
  64
  65 --*/
  66 ;
  67
  68 EFI_STATUS
  69 EFIAPI
  70 UnixTimerDriverRegisterHandler (
  71   IN EFI_TIMER_ARCH_PROTOCOL  *This,
  72   IN EFI_TIMER_NOTIFY         NotifyFunction
  73   )
  74 /*++
  75
  76 Routine Description:
  77
  78   TODO: Add function description
  79
  80 Arguments:
  81
  82   This            - TODO: add argument description
  83   NotifyFunction  - TODO: add argument description
  84
  85 Returns:
  86
  87   TODO: add return values
  88
  89 --*/
  90 ;
  91
  92 EFI_STATUS
  93 EFIAPI
  94 UnixTimerDriverSetTimerPeriod (
  95   IN EFI_TIMER_ARCH_PROTOCOL  *This,
  96   IN UINT64                   TimerPeriod
  97   )
  98 /*++
  99
 100 Routine Description:
 101
 102   TODO: Add function description
 103
 104 Arguments:
 105
 106   This        - TODO: add argument description
 107   TimerPeriod - TODO: add argument description
 108
 109 Returns:
 110
 111   TODO: add return values
 112
 113 --*/
 114 ;
 115
 116 EFI_STATUS
 117 EFIAPI
 118 UnixTimerDriverGetTimerPeriod (
 119   IN EFI_TIMER_ARCH_PROTOCOL   *This,
 120   OUT UINT64                   *TimerPeriod
 121   )
 122 /*++
 123
 124 Routine Description:
 125
 126   TODO: Add function description
 127
 128 Arguments:
 129
 130   This        - TODO: add argument description
 131   TimerPeriod - TODO: add argument description
 132
 133 Returns:
 134
 135   TODO: add return values
 136
 137 --*/
 138 ;
 139
 140 EFI_STATUS
 141 EFIAPI
 142 UnixTimerDriverGenerateSoftInterrupt (
 143   IN EFI_TIMER_ARCH_PROTOCOL  *This
 144   )
 145 /*++
 146
 147 Routine Description:
 148
 149   TODO: Add function description
 150
 151 Arguments:
 152
 153   This  - TODO: add argument description
 154
 155 Returns:
 156
 157   TODO: add return values
 158
 159 --*/
 160 ;
 161
 162 #endif