MdePkg/Include/Library/S3StallLib.h

   1 /** @file
   2   Stall Services that perform stalls and also enable the Stall operatation
   3   to be replayed during an S3 resume. This library class maps directly on top
   4   of the Timer class.
   5
   6   Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
   7
   8   This program and the accompanying materials
   9   are licensed and made available under the terms and conditions
  10   of the BSD License which accompanies this distribution.  The
  11   full text of the license may be found at
  12   http://opensource.org/licenses/bsd-license.php
  13
  14   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  15   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  16
  17 **/
  18
  19 #ifndef __S3_STALL_LIB_H__
  20 #define __S3_STALL_LIB_H__
  21
  22 /**
  23   Stalls the CPU for at least the given number of microseconds and saves
  24   the value in the S3 script to be replayed on S3 resume.
  25
  26   Stalls the CPU for the number of microseconds specified by MicroSeconds.
  27
  28   @param[in] MicroSeconds   The minimum number of microseconds to delay.
  29
  30   @return   MicroSeconds.
  31
  32 **/
  33 UINTN
  34 EFIAPI
  35 S3Stall (
  36   IN UINTN  MicroSeconds
  37   );
  38
  39 #endif