CorebootPayloadPkg/BuildAndIntegrationInstructions.txt

   1 ================================================================================
   2 Build And Integration Instructions
   3 2014 June 24th
   4 ================================================================================
   5
   6 ================================================================================
   7 DISCLAIMER
   8 ================================================================================
   9 This release note as well as the software described in it is furnished under license
  10 and may only be used or copied in accordance with the terms of the license. The
  11 information in this manual is furnished for informational use only, is subject to
  12 change without notice, and should not be construed as a commitment by Intel Corporation.
  13 Intel Corporation assumes no responsibility or liability for any errors or inaccuracies
  14 that may appear in this document or any software that may be provided in association
  15 with this document.
  16 Except as permitted by such license, no part of this document may be reproduced,
  17 stored in a retrieval system, or transmitted in any form or by any means without
  18 the express written consent of Intel Corporation.
  19
  20 ================================================================================
  21                                      INDEX
  22 ================================================================================
  23 A. INTRODUCTION
  24 B. HOW TO BUILD
  25 C. HOW TO INTEGRATE
  26
  27 ================================================================================
  28 A. INTRODUCTION
  29 ================================================================================
  30 This document provides instructions on how to build Coreboot Uefi Payload and
  31 how to integrate it into coreboot firmware.
  32
  33 ================================================================================
  34 B. HOW TO BUILD
  35 ================================================================================
  36 1. Run the below two commands in windows command prompt window:
  37    edksetup.bat
  38
  39    For debug ia32 build:
  40    build -a IA32 -p CorebootPayloadPkg\CorebootPayloadPkgIa32.dsc -b DEBUG -t <ToolChain>
  41
  42    For release ia32 build:
  43    build -a IA32 -p CorebootPayloadPkg\CorebootPayloadPkgIa32.dsc -b RELEASE -t <ToolChain>
  44
  45    For debug X64 build:
  46    build -a IA32 -a X64 -p CorebootPayloadPkg\CorebootPayloadPkgIa32X64.dsc -b DEBUG -t <ToolChain>
  47
  48    For release X64 build:
  49    build -a IA32 -a X64 -p CorebootPayloadPkg\CorebootPayloadPkgIa32X64.dsc -b RELEASE -t <ToolChain>
  50
  51    <ToolChain> is the EDK II build environment on your host. Currently it was tested with VS2008x64 toolchain.
  52
  53    For details about EDK II build steps, refer to http://svn.code.sf.net/p/edk2/code/branches/UDK2014/BuildNotes2.txt
  54
  55 2. If build is successfully, the payload image (UEFIPAYLOAD.fd) will be generated inside the folder of Build\CorebootPayloadPkg.
  56
  57 ================================================================================
  58 C. HOW TO INTEGRATE
  59 ================================================================================
  60 1. Copy the payload image (UEFIPAYLOAD.fd) into the top-level directory of Coreboot source tree.
  61 2. Run "make menuconfig" in linux console to start Coreboot configuration surface.
  62 3. In the Payload section,
  63    1) Choose "An ELF executable payload" for the option of "Add a payload".
  64    2) Type the path of payload image for the option of "Payload path and filename".
  65    3) Select the option of "Use LZMA compression for payloads".
  66
  67 4. If the graphics console is required in Coreboot UEFI payload, running VGA option rom should be enabled.
  68    For details:
  69    1) In the Device section, select the option of "Run VGA Option ROMs".
  70    2) In the VGA BIOS section, select the option of "Add a VGA BIOS Image", Input the path of vga bios image
  71    for the option of VGA BIOS path and filename, give the values of vendor id and device id for the option
  72    of  "VGA device PCI IDs".
  73    3) In the Display section,
  74       Select the option of "Set framebuffer graphics resolution"
  75       Choose a right display mode for the option of "framebuffer graphics resolution".
  76       Note: If the boot OS is windows, please choose the display mode supporting 32 bit color.
  77       Select the option of "Keep VESA framebuffer"
  78
  79 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?",
  80    choose Yes.
  81
  82 6. Run "make" to build the coreboot firmware image.