[mirror_edk2.git] / MdePkg / Include / Library / S3StallLib.h

/** @file\r
  Stall Services that perform stalls and also enable the Stall operatation\r
  to be replayed during an S3 resume. This library class maps directly on top\r
  of the Timer class.\r
\r
  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __S3_STALL_LIB_H__\r
#define __S3_STALL_LIB_H__\r
\r
/**\r
  Stalls the CPU for at least the given number of microseconds and saves\r
  the value in the S3 script to be replayed on S3 resume.\r
\r
  Stalls the CPU for the number of microseconds specified by MicroSeconds.\r
\r
  @param[in] MicroSeconds   The minimum number of microseconds to delay.\r
\r
  @return   MicroSeconds.\r
\r
**/\r
UINTN\r
EFIAPI\r
S3Stall (\r
  IN UINTN  MicroSeconds\r
  );\r
\r
#endif\r
Commit	Line	Data
fe69ac84	1	/** @file\r
	2	Stall Services that perform stalls and also enable the Stall operatation\r
	3	to be replayed during an S3 resume. This library class maps directly on top\r
9095d37b	4	of the Timer class.\r
fe69ac84	5	\r
9095d37b	6	Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
fe69ac84	7	\r
9344f092	8	SPDX-License-Identifier: BSD-2-Clause-Patent\r
fe69ac84	9	\r
	10	**/\r
	11	\r
	12	#ifndef __S3_STALL_LIB_H__\r
	13	#define __S3_STALL_LIB_H__\r
	14	\r
	15	/**\r
	16	Stalls the CPU for at least the given number of microseconds and saves\r
	17	the value in the S3 script to be replayed on S3 resume.\r
	18	\r
	19	Stalls the CPU for the number of microseconds specified by MicroSeconds.\r
	20	\r
	21	@param[in] MicroSeconds The minimum number of microseconds to delay.\r
	22	\r
	23	@return MicroSeconds.\r
	24	\r
	25	**/\r
	26	UINTN\r
	27	EFIAPI\r
	28	S3Stall (\r
	29	IN UINTN MicroSeconds\r
	30	);\r
	31	\r
	32	#endif\r