Pkg-Module: CorebootPayloadPkg

[mirror_edk2.git] / CorebootPayloadPkg / BuildAndIntegrationInstructions.txt

diff --git a/CorebootPayloadPkg/BuildAndIntegrationInstructions.txt b/CorebootPayloadPkg/BuildAndIntegrationInstructions.txt
new file mode 100644 (file)
index 0000000..057ea5d
--- /dev/null
+++ b/CorebootPayloadPkg/BuildAndIntegrationInstructions.txt
@@ -0,0 +1,91 @@
+================================================================================\r
+Build And Integration Instructions\r
+2014 June 24th\r
+================================================================================\r
+\r
+================================================================================\r
+DISCLAIMER\r
+================================================================================\r
+This release note as well as the software described in it is furnished under license\r
+and may only be used or copied in accordance with the terms of the license. The\r
+information in this manual is furnished for informational use only, is subject to\r
+change without notice, and should not be construed as a commitment by Intel Corporation.\r
+Intel Corporation assumes no responsibility or liability for any errors or inaccuracies\r
+that may appear in this document or any software that may be provided in association\r
+with this document.\r
+Except as permitted by such license, no part of this document may be reproduced,\r
+stored in a retrieval system, or transmitted in any form or by any means without\r
+the express written consent of Intel Corporation.\r
+\r
+================================================================================\r
+                                     INDEX\r
+================================================================================\r
+A. INTRODUCTION\r
+B. HOW TO BUILD\r
+C. HOW TO INTEGRATE \r
+\r
+================================================================================\r
+A. INTRODUCTION\r
+================================================================================\r
+This document provides instructions on how to build Coreboot Uefi Payload and \r
+how to integrate it into coreboot firmware.\r
+\r
+================================================================================\r
+B. HOW TO BUILD \r
+================================================================================\r
+1. Run the below two commands in windows command prompt window:\r
+   edksetup.bat\r
+   \r
+   For debug ia32 build:\r
+   build -a IA32 -p CorebootPayloadPkg\CorebootPayloadPkgIA32.dsc -b DEBUG -t <ToolChain>\r
+   \r
+   For release ia32 build:\r
+   build -a IA32 -p CorebootPayloadPkg\CorebootPayloadPkgIA32.dsc -b RELEASE -t <ToolChain>\r
+   \r
+   For debug X64 build:\r
+   build -a IA32 -a X64 -p CorebootPayloadPkg\CorebootPayloadPkgX64.dsc -b DEBUG -t <ToolChain>\r
+   \r
+   For release X64 build:\r
+   build -a IA32 -a X64 -p CorebootPayloadPkg\CorebootPayloadPkgX64.dsc -b RELEASE -t <ToolChain>\r
+   \r
+   <ToolChain> is the EDK II build environment on your host. Currently it was tested with VS2008x64 toolchain.\r
+\r
+   For details about EDK II build steps, refer to http://svn.code.sf.net/p/edk2/code/branches/UDK2014/BuildNotes2.txt\r
+   \r
+2. If build is successfully, the payload image (UEFIPAYLOAD.fd) will be generated inside the folder of Build\CorebootPayloadPkg.\r
+\r
+================================================================================\r
+C. HOW TO INTEGRATE\r
+================================================================================\r
+1. Copy the payload image (UEFIPAYLOAD.fd) into the top-level directory of Coreboot source tree.\r
+2. Run "make menuconfig" in linux console to start Coreboot configuration surface.\r
+3. In the Payload section,\r
+   1) Choose "An ELF executable payload" for the option of "Add a payload".\r
+   2) Type the path of payload image for the option of "Payload path and filename".\r
+   3) Select the option of "Use LZMA compression for payloads".\r
+   \r
+4. If the graphics console is required in Coreboot UEFI payload, running VGA option rom should be enabled.\r
+   For details:\r
+   1) In the Device section, select the option of "Run VGA Option ROMs".\r
+   2) In the VGA BIOS section, select the option of "Add a VGA BIOS Image", Input the path of vga bios image \r
+   for the option of VGA BIOS path and filename, give the values of vendor id and device id for the option \r
+   of  "VGA device PCI IDs".\r
+   3) In the Display section,\r
+      Select the option of "Set framebuffer graphics resolution"\r
+      Choose a right display mode for the option of "framebuffer graphics resolution".\r
+      Note: If the boot OS is windows, please choose the display mode supporting 32 bit color.\r
+      Select the option of "Keep VESA framebuffer"\r
+   \r
+5. Press ESC key to exit the Coreboot configuration surface. If there is a question prompted like "Do you wish to save your new configuration?",\r
+   choose Yes.\r
+   \r
+6. Run "make" to build the coreboot firmware image.\r
+\r
+\r
+  \r
+   \r
+\r
+            \r
+            \r
+   \r
+   
\ No newline at end of file