[mirror_edk2.git] / MdePkg / Include / Protocol / SmmSxDispatch.h

/** @file\r
  This file declares EFI Smm Sx Smi Child Protocol\r
\r
  Copyright (c) 2006, Intel Corporation                                                         \r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
  Module Name:  SmmSxDispatch.h\r
\r
  @par Revision Reference:\r
  This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
  Version 0.9.\r
\r
**/\r
\r
#ifndef _EFI_SMM_SX_DISPATCH_H_\r
#define _EFI_SMM_SX_DISPATCH_H_\r
\r
//\r
// Global ID for the Sx SMI Protocol\r
//\r
#define EFI_SMM_SX_DISPATCH_PROTOCOL_GUID \\r
  { \\r
    0x14fc52be, 0x1dc, 0x426c, {0x91, 0xae, 0xa2, 0x3c, 0x3e, 0x22, 0xa, 0xe8 } \\r
  }\r
\r
typedef struct _EFI_SMM_SX_DISPATCH_PROTOCOL  EFI_SMM_SX_DISPATCH_PROTOCOL;\r
//\r
// Related Definitions\r
//\r
typedef enum {\r
  SxS0,\r
  SxS1,\r
  SxS2,\r
  SxS3,\r
  SxS4,\r
  SxS5,\r
  EfiMaximumSleepType\r
} EFI_SLEEP_TYPE;\r
\r
typedef enum {\r
  SxEntry,\r
  SxExit,\r
  EfiMaximumPhase\r
} EFI_SLEEP_PHASE;\r
\r
typedef struct {\r
  EFI_SLEEP_TYPE  Type;\r
  EFI_SLEEP_PHASE Phase;\r
} EFI_SMM_SX_DISPATCH_CONTEXT;\r
\r
//\r
// Member functions\r
//\r
/**\r
  Dispatch function for a Sx state SMI handler.\r
\r
  @param  DispatchHandle        Handle of this dispatch function.\r
Commit	Line	Data
878ddf1f	1	/** @file\r
	2	This file declares EFI Smm Sx Smi Child Protocol\r
	3	\r
	4	Copyright (c) 2006, Intel Corporation \r
	5	All rights reserved. This program and the accompanying materials \r
	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	\r
	13	Module Name: SmmSxDispatch.h\r
	14	\r
	15	@par Revision Reference:\r
	16	This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
	17	Version 0.9.\r
	18	\r
	19	**/\r
	20	\r
	21	#ifndef _EFI_SMM_SX_DISPATCH_H_\r
	22	#define _EFI_SMM_SX_DISPATCH_H_\r
	23	\r
	24	//\r
	25	// Global ID for the Sx SMI Protocol\r
	26	//\r
	27	#define EFI_SMM_SX_DISPATCH_PROTOCOL_GUID \\r
	28	{ \\r
	29	0x14fc52be, 0x1dc, 0x426c, {0x91, 0xae, 0xa2, 0x3c, 0x3e, 0x22, 0xa, 0xe8 } \\r
	30	}\r
	31	\r
	32	typedef struct _EFI_SMM_SX_DISPATCH_PROTOCOL EFI_SMM_SX_DISPATCH_PROTOCOL;\r
	33	//\r
	34	// Related Definitions\r
	35	//\r
	36	typedef enum {\r
	37	SxS0,\r
	38	SxS1,\r
	39	SxS2,\r
	40	SxS3,\r
	41	SxS4,\r
	42	SxS5,\r
	43	EfiMaximumSleepType\r
	44	} EFI_SLEEP_TYPE;\r
	45	\r
	46	typedef enum {\r
	47	SxEntry,\r
	48	SxExit,\r
	49	EfiMaximumPhase\r
	50	} EFI_SLEEP_PHASE;\r
	51	\r
	52	typedef struct {\r
	53	EFI_SLEEP_TYPE Type;\r
	54	EFI_SLEEP_PHASE Phase;\r
	55	} EFI_SMM_SX_DISPATCH_CONTEXT;\r
	56	\r
	57	//\r
	58	// Member functions\r
	59	//\r
	60	/**\r
	61	Dispatch function for a Sx state SMI handler.\r
	62	\r
0647c9ad LG	63	@param DispatchHandle Handle of this dispatch function.\r
	64