[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / BootScriptExecuter.h

/** @file\r
  This file declares Boot Script Executer PPI.\r
\r
  This PPI is published by a PEIM upon dispatch and provides an execution engine for the\r
  Framework boot script. This PEIM should be platform neutral and have no specific knowledge of\r
  platform instructions and other information. The ability to interpret the boot script depends on the\r
  abundance of other PPIs that are available. For example, if the script requests an SMBus command\r
  execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it\r
  by issuing the native IA-32 instruction.\r
\r
  Copyright (c) 2007 - 2009, 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:  BootScriptExecuter.h\r
\r
  @par Revision Reference:\r
  This PPI is defined in Framework of EFI BootScript spec.\r
  Version 0.91.\r
\r
**/\r
\r
#ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
#define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
\r
#include <FrameworkPei.h>\r
\r
#define EFI_ACPI_S3_RESUME_SCRIPT_TABLE               0x00\r
\r
//\r
// Boot Script Opcode Definitions\r
//\r
\r
///\r
/// The opcode is to add a record for an I/O write operation into a specified boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_IO_WRITE_OPCODE               0x00\r
///\r
/// The opcode is to add a record for an I/O modify operation into a specified boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE          0x01\r
///\r
/// The opcode is to add a record for a memory write operation into a specified boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE              0x02\r
///\r
/// The opcode is to add a record for a memory modify operation into a specified boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE         0x03\r
///\r
/// The opcode is to adds a record for a PCI configuration space write operation into a specified boot \r
/// script table.\r
///\r
#define EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE       0x04\r
///\r
/// The opcode is to add a record for a PCI configuration space modify operation into a specified \r
/// boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE  0x05\r
///\r
/// The opcode is to add a record for an SMBus command execution into a specified boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE          0x06\r
///\r
/// The opcode is to adds a record for an execution stall on the processor into a specified\r
/// boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_STALL_OPCODE                  0x07\r
///\r
/// The opcode is to add a record for dispatching specified arbitrary code into a specified \r
/// boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_DISPATCH_OPCODE               0x08\r
\r
//\r
// Extensions to boot script definitions \r
//\r
///\r
/// Inconsistent with specification here: \r
/// Follow OPCODEs are not defined in Framework Spec BootScript_0.91, but in\r
/// PI1.0 Spec. And OPCODEs which are needed in the implementation\r
///\r
///\r
/// The opcode is to add a record for memory reads of the memory location and continues when the \r
/// exit criteria is satisfied or after a defined duration.\r
///\r
#define EFI_BOOT_SCRIPT_MEM_POLL_OPCODE               0x09\r
///\r
/// The opcode is to store arbitrary information in the boot script table which is a no-op on dispatch \r
/// and is only used for debugging script issues.\r
///\r
#define EFI_BOOT_SCRIPT_INFORMATION_OPCODE            0x0A\r
///\r
/// The opcode is to add a record for a PCI configuration space write operation into a \r
/// specified boot script table.\r
/// \r
#define EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE      0x0B\r
///\r
/// The opcode is to add a record for a PCI configuration space modify operation into a specified\r
/// boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE 0x0C\r
///\r
/// The opcode is to add a record for dispatching specified arbitrary code into a specified\r
/// boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE             0x0D\r
\r
///\r
/// The opcode indicate the start of the boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_TABLE_OPCODE                  0xAA\r
///\r
/// The opcode indicate the end of the boot script table.\r
///\r
#define EFI_BOOT_SCRIPT_TERMINATE_OPCODE              0xFF\r
\r
///\r
/// EFI Boot Script Width\r
///\r
typedef enum {\r
  EfiBootScriptWidthUint8,\r
  EfiBootScriptWidthUint16,\r
  EfiBootScriptWidthUint32,\r
  EfiBootScriptWidthUint64,\r
  EfiBootScriptWidthFifoUint8,\r
  EfiBootScriptWidthFifoUint16,\r
  EfiBootScriptWidthFifoUint32,\r
  EfiBootScriptWidthFifoUint64,\r
  EfiBootScriptWidthFillUint8,\r
  EfiBootScriptWidthFillUint16,\r
  EfiBootScriptWidthFillUint32,\r
  EfiBootScriptWidthFillUint64,\r
  EfiBootScriptWidthMaximum\r
} EFI_BOOT_SCRIPT_WIDTH;\r
\r
#define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID \\r
  { \\r
    0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff } \\r
  }\r
\r
typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI;\r
\r
/**\r
  Executes the Framework boot script table.\r
\r
  @param  PeiServices    A pointer to the system PEI Services Table.\r
  @param  This           A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.\r
  @param  Address        The physical memory address where the table is stored.\r
                         It must be zero if the table to be executed is stored in a firmware volume file.\r
  @param  FvFile         The firmware volume file name that contains the table to\r
                         be executed. It must be NULL if the table to be executed is stored in physical memory.\r
\r
  @retval EFI_SUCCESS           The boot script table was executed successfully.\r
  @retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.\r
  @retval EFI_NOT_FOUND         The file name specified in FvFile cannot be found.\r
  @retval EFI_UNSUPPORTED       The format of the boot script table is invalid.\r
                                Or An unsupported opcode occurred in the table.\r
                                Or There were opcode execution errors, such as an insufficient dependency.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE)(\r
  IN     EFI_PEI_SERVICES                        **PeiServices,\r
  IN     EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI        *This,\r
  IN     EFI_PHYSICAL_ADDRESS                    Address,\r
  IN     EFI_GUID                                *FvFile OPTIONAL\r
  );\r
\r
///\r
/// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and \r
/// executes the Framework boot script table\r
///\r
struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {\r
	///\r
	/// Executes a boot script table\r
	///\r
  EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;  \r
};\r
\r
extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r
\r
#endif\r
Commit	Line	Data
79964ac8	1	/** @file\r
	2	This file declares Boot Script Executer PPI.\r
	3	\r
4a71b21a	4	This PPI is published by a PEIM upon dispatch and provides an execution engine for the\r
	5	Framework boot script. This PEIM should be platform neutral and have no specific knowledge of\r
	6	platform instructions and other information. The ability to interpret the boot script depends on the\r
	7	abundance of other PPIs that are available. For example, if the script requests an SMBus command\r
	8	execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it\r
	9	by issuing the native IA-32 instruction.\r
	10	\r
2bbaeb0d	11	Copyright (c) 2007 - 2009, Intel Corporation\r
79964ac8	12	All rights reserved. This program and the accompanying materials\r
	13	are licensed and made available under the terms and conditions of the BSD License\r
	14	which accompanies this distribution. The full text of the license may be found at\r
	15	http://opensource.org/licenses/bsd-license.php\r
	16	\r
	17	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	18	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	19	\r
	20	Module Name: BootScriptExecuter.h\r
	21	\r
	22	@par Revision Reference:\r
	23	This PPI is defined in Framework of EFI BootScript spec.\r
	24	Version 0.91.\r
	25	\r
	26	**/\r
	27	\r
694b922c	28	#ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
	29	#define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
	30	\r
0e0eeeca	31	#include <FrameworkPei.h>\r
79964ac8	32	\r
c3902377	33	#define EFI_ACPI_S3_RESUME_SCRIPT_TABLE 0x00\r
	34	\r
	35	//\r
	36	// Boot Script Opcode Definitions\r
	37	//\r
	38	\r
18998e40	39	///\r
	40	/// The opcode is to add a record for an I/O write operation into a specified boot script table.\r
	41	///\r
c3902377	42	#define EFI_BOOT_SCRIPT_IO_WRITE_OPCODE 0x00\r
18998e40	43	///\r
	44	/// The opcode is to add a record for an I/O modify operation into a specified boot script table.\r
	45	///\r
c3902377	46	#define EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE 0x01\r
18998e40	47	///\r
	48	/// The opcode is to add a record for a memory write operation into a specified boot script table.\r
	49	///\r
c3902377	50	#define EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE 0x02\r
18998e40	51	///\r
	52	/// The opcode is to add a record for a memory modify operation into a specified boot script table.\r
	53	///\r
c3902377	54	#define EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE 0x03\r
18998e40	55	///\r
	56	/// The opcode is to adds a record for a PCI configuration space write operation into a specified boot \r
	57	/// script table.\r
	58	///\r
c3902377	59	#define EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE 0x04\r
18998e40	60	///\r
	61	/// The opcode is to add a record for a PCI configuration space modify operation into a specified \r
	62	/// boot script table.\r
	63	///\r
c3902377	64	#define EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE 0x05\r
18998e40	65	///\r
	66	/// The opcode is to add a record for an SMBus command execution into a specified boot script table.\r
	67	///\r
c3902377	68	#define EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE 0x06\r
18998e40	69	///\r
	70	/// The opcode is to adds a record for an execution stall on the processor into a specified\r
	71	/// boot script table.\r
	72	///\r
c3902377	73	#define EFI_BOOT_SCRIPT_STALL_OPCODE 0x07\r
18998e40	74	///\r
	75	/// The opcode is to add a record for dispatching specified arbitrary code into a specified \r
	76	/// boot script table.\r
	77	///\r
c3902377	78	#define EFI_BOOT_SCRIPT_DISPATCH_OPCODE 0x08\r
	79	\r
	80	//\r
18998e40	81	// Extensions to boot script definitions \r
c3902377	82	//\r
fdf3ad81	83	///\r
	84	/// Inconsistent with specification here: \r
	85	/// Follow OPCODEs are not defined in Framework Spec BootScript_0.91, but in\r
	86	/// PI1.0 Spec. And OPCODEs which are needed in the implementation\r
	87	///\r
18998e40	88	///\r
	89	/// The opcode is to add a record for memory reads of the memory location and continues when the \r
	90	/// exit criteria is satisfied or after a defined duration.\r
	91	///\r
c3902377	92	#define EFI_BOOT_SCRIPT_MEM_POLL_OPCODE 0x09\r
18998e40	93	///\r
	94	/// The opcode is to store arbitrary information in the boot script table which is a no-op on dispatch \r
	95	/// and is only used for debugging script issues.\r
	96	///\r
c3902377	97	#define EFI_BOOT_SCRIPT_INFORMATION_OPCODE 0x0A\r
18998e40	98	///\r
	99	/// The opcode is to add a record for a PCI configuration space write operation into a \r
	100	/// specified boot script table.\r
	101	/// \r
c3902377	102	#define EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE 0x0B\r
18998e40	103	///\r
	104	/// The opcode is to add a record for a PCI configuration space modify operation into a specified\r
	105	/// boot script table.\r
	106	///\r
c3902377	107	#define EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE 0x0C\r
18998e40	108	///\r
	109	/// The opcode is to add a record for dispatching specified arbitrary code into a specified\r
	110	/// boot script table.\r
	111	///\r
c3902377	112	#define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE 0x0D\r
fdf3ad81	113	\r
18998e40	114	///\r
	115	/// The opcode indicate the start of the boot script table.\r
	116	///\r
c3902377	117	#define EFI_BOOT_SCRIPT_TABLE_OPCODE 0xAA\r
18998e40	118	///\r
	119	/// The opcode indicate the end of the boot script table.\r
	120	///\r
c3902377	121	#define EFI_BOOT_SCRIPT_TERMINATE_OPCODE 0xFF\r
c3902377	122	\r
18998e40	123	///\r
	124	/// EFI Boot Script Width\r
	125	///\r
c3902377	126	typedef enum {\r
	127	EfiBootScriptWidthUint8,\r
	128	EfiBootScriptWidthUint16,\r
	129	EfiBootScriptWidthUint32,\r
	130	EfiBootScriptWidthUint64,\r
	131	EfiBootScriptWidthFifoUint8,\r
	132	EfiBootScriptWidthFifoUint16,\r
	133	EfiBootScriptWidthFifoUint32,\r
	134	EfiBootScriptWidthFifoUint64,\r
	135	EfiBootScriptWidthFillUint8,\r
	136	EfiBootScriptWidthFillUint16,\r
	137	EfiBootScriptWidthFillUint32,\r
	138	EfiBootScriptWidthFillUint64,\r
	139	EfiBootScriptWidthMaximum\r
	140	} EFI_BOOT_SCRIPT_WIDTH;\r
b80fbe85	141	\r
79964ac8	142	#define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID \\r
	143	{ \\r
	144	0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff } \\r
	145	}\r
	146	\r
	147	typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI;\r
	148	\r
	149	/**\r
	150	Executes the Framework boot script table.\r
	151	\r
	152	@param PeiServices A pointer to the system PEI Services Table.\r
	153	@param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.\r
	154	@param Address The physical memory address where the table is stored.\r
	155	It must be zero if the table to be executed is stored in a firmware volume file.\r
	156	@param FvFile The firmware volume file name that contains the table to\r
	157	be executed. It must be NULL if the table to be executed is stored in physical memory.\r
	158	\r
	159	@retval EFI_SUCCESS The boot script table was executed successfully.\r
	160	@retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.\r
	161	@retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.\r
	162	@retval EFI_UNSUPPORTED The format of the boot script table is invalid.\r
	163	Or An unsupported opcode occurred in the table.\r
	164	Or There were opcode execution errors, such as an insufficient dependency.\r
	165	\r
	166	**/\r
	167	typedef\r
	168	EFI_STATUS\r
69686d56	169	(EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE)(\r
79964ac8	170	IN EFI_PEI_SERVICES **PeiServices,\r
	171	IN EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI *This,\r
	172	IN EFI_PHYSICAL_ADDRESS Address,\r
	173	IN EFI_GUID *FvFile OPTIONAL\r
	174	);\r
	175	\r
2bbaeb0d	176	///\r
18998e40	177	/// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and \r
18998e40	178	/// executes the Framework boot script table\r
2bbaeb0d	179	///\r
79964ac8	180	struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {\r
18998e40	181	///\r
	182	/// Executes a boot script table\r
	183	///\r
	184	EFI_PEI_BOOT_SCRIPT_EXECUTE Execute; \r
79964ac8	185	};\r
	186	\r
	187	extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r
	188	\r
	189	#endif\r