Add more comments for IntelFramework's header files.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
index 0cb81040beef533842e9b2d54920ecbd41a73ca7..c98f3821ebd61bc78d6d3c09ade0447b2ed90b75 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
+++ b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
@@ -1,6 +1,13 @@
 /** @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, 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