summaryrefslogtreecommitdiffstats
path: root/MdePkg/Include/Library/S3StallLib.h
blob: 5f8c5ce89d2dfb7e02267fe9a09262c54040a53b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
/** @file
  Stall Services that perform stalls and also enable the Stall operatation
  to be replayed during an S3 resume. This library class maps directly on top
  of the Timer class.

  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>

  SPDX-License-Identifier: BSD-2-Clause-Patent

**/

#ifndef __S3_STALL_LIB_H__
#define __S3_STALL_LIB_H__

/**
  Stalls the CPU for at least the given number of microseconds and saves
  the value in the S3 script to be replayed on S3 resume.

  Stalls the CPU for the number of microseconds specified by MicroSeconds.

  @param[in] MicroSeconds   The minimum number of microseconds to delay.

  @return   MicroSeconds.

**/
UINTN
EFIAPI
S3Stall (
  IN UINTN  MicroSeconds
  );

#endif