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 #include <Base.h>
  16 #include <Library/TimerLib.h>
  17 #include <Library/DebugLib.h>
  18
  19 /**
  20   Stalls the CPU for the number of microseconds specified by MicroSeconds.
  21
  22   @param  MicroSeconds  The minimum number of microseconds to delay.
  23
  24   @return The value of MicroSeconds inputted.
  25
  26 **/
  27 UINTN
  28 EFIAPI
  29 MicroSecondDelay (
  30   IN      UINTN                     MicroSeconds
  31   )
  32 {
  33   ASSERT (FALSE);
  34   return MicroSeconds;
  35 }
  36
  37 /**
  38   Stalls the CPU for the number of nanoseconds specified by NanoSeconds.
  39
  40   @param  NanoSeconds The minimum number of nanoseconds to delay.
  41
  42   @return The value of NanoSeconds inputted.
  43
  44 **/
  45 UINTN
  46 EFIAPI
  47 NanoSecondDelay (
  48   IN      UINTN                     NanoSeconds
  49   )
  50 {
  51   ASSERT (FALSE);
  52   return 0;
  53 }
  54
  55 /**
  56   Retrieves the current value of a 64-bit free running performance counter. The
  57   counter can either count up by 1 or count down by 1. If the physical
  58   performance counter counts by a larger increment, then the counter values
  59   must be translated. The properties of the counter can be retrieved from
  60   GetPerformanceCounterProperties().
  61
  62   @return The current value of the free running performance counter.
  63
  64 **/
  65 UINT64
  66 EFIAPI
  67 GetPerformanceCounter (
  68   VOID
  69   )
  70 {
  71   ASSERT (FALSE);
  72   return 0;
  73 }
  74
  75 /**
  76   Retrieves the 64-bit frequency in Hz and the range of performance counter
  77   values.
  78
  79   If StartValue is not NULL, then the value that the performance counter starts
  80   with immediately after is it rolls over is returned in StartValue. If
  81   EndValue is not NULL, then the value that the performance counter end with
  82   immediately before it rolls over is returned in EndValue. The 64-bit
  83   frequency of the performance counter in Hz is always returned. If StartValue
  84   is less than EndValue, then the performance counter counts up. If StartValue
  85   is greater than EndValue, then the performance counter counts down. For
  86   example, a 64-bit free running counter that counts up would have a StartValue
  87   of 0 and an EndValue of 0xFFFFFFFFFFFFFFFF. A 24-bit free running counter
  88   that counts down would have a StartValue of 0xFFFFFF and an EndValue of 0.
  89
  90   @param  StartValue  The value the performance counter starts with when it
  91                       rolls over.
  92   @param  EndValue    The value that the performance counter ends with before
  93                       it rolls over.
  94
  95   @return The frequency in Hz.
  96
  97 **/
  98 UINT64
  99 EFIAPI
 100 GetPerformanceCounterProperties (
 101   OUT      UINT64                    *StartValue,  OPTIONAL
 102   OUT      UINT64                    *EndValue     OPTIONAL
 103   )
 104 {
 105   ASSERT (FALSE);
 106
 107   return (UINT64)(-1);
 108 }