MdePkg/Library/BaseTimerLibNullTemplate/TimerLibNull.c

   1 /** @file
   2   A non-functional instance of the Timer Library.
   3
   4   Copyright (c) 2007 - 2008, Intel Corporation<BR>
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15
  16 #include <Base.h>
  17
  18
  19 #include <Library/TimerLib.h>
  20 #include <Library/DebugLib.h>
  21
  22 /**
  23   Stalls the CPU for the number of microseconds specified by MicroSeconds.
  24
  25   @param  MicroSeconds  The minimum number of microseconds to delay.
  26
  27   @return MicroSeconds.
  28
  29 **/
  30 UINTN
  31 EFIAPI
  32 MicroSecondDelay (
  33   IN      UINTN                     MicroSeconds
  34   )
  35 {
  36   ASSERT (FALSE);
  37   return MicroSeconds;
  38 }
  39
  40 /**
  41   Stalls the CPU for the number of nanoseconds specified by NanoSeconds.
  42
  43   @param  NanoSeconds The minimum number of nanoseconds to delay.
  44
  45   @return NanoSeconds.
  46
  47 **/
  48 UINTN
  49 EFIAPI
  50 NanoSecondDelay (
  51   IN      UINTN                     NanoSeconds
  52   )
  53 {
  54   ASSERT (FALSE);
  55   return 0;
  56 }
  57
  58 /**
  59   Retrieves the current value of a 64-bit free running performance counter. The
  60   counter can either count up by 1 or count down by 1. If the physical
  61   performance counter counts by a larger increment, then the counter values
  62   must be translated. The properties of the counter can be retrieved from
  63   GetPerformanceCounterProperties().
  64
  65   @return The current value of the free running performance counter.
  66
  67 **/
  68 UINT64
  69 EFIAPI
  70 GetPerformanceCounter (
  71   VOID
  72   )
  73 {
  74   ASSERT (FALSE);
  75   return 0;
  76 }
  77
  78 /**
  79   Retrieves the 64-bit frequency in Hz and the range of performance counter
  80   values.
  81
  82   If StartValue is not NULL, then the value that the performance counter starts
  83   with immediately after is it rolls over is returned in StartValue. If
  84   EndValue is not NULL, then the value that the performance counter end with
  85   immediately before it rolls over is returned in EndValue. The 64-bit
  86   frequency of the performance counter in Hz is always returned. If StartValue
  87   is less than EndValue, then the performance counter counts up. If StartValue
  88   is greater than EndValue, then the performance counter counts down. For
  89   example, a 64-bit free running counter that counts up would have a StartValue
  90   of 0 and an EndValue of 0xFFFFFFFFFFFFFFFF. A 24-bit free running counter
  91   that counts down would have a StartValue of 0xFFFFFF and an EndValue of 0.
  92
  93   @param  StartValue  The value the performance counter starts with when it
  94                       rolls over.
  95   @param  EndValue    The value that the performance counter ends with before
  96                       it rolls over.
  97
  98   @return The frequency in Hz.
  99
 100 **/
 101 UINT64
 102 EFIAPI
 103 GetPerformanceCounterProperties (
 104   OUT      UINT64                    *StartValue,  OPTIONAL
 105   OUT      UINT64                    *EndValue     OPTIONAL
 106   )
 107 {
 108   ASSERT (FALSE);
 109
 110   return (UINT64)(-1);
 111 }