EmulatorPkg/PlatformCI/ReadMe.md

   1 # EmulatorPkg - Platform CI
   2
   3 This ReadMe.md describes the Azure DevOps based Platform CI for EmulatorPkg and how
   4 to use the same Pytools based build infrastructure locally.
   5
   6 ## Supported Configuration Details
   7
   8 This solution for building and running EmulatorPkg has only been validated with Windows 10
   9 with VS2019 and Ubuntu 18.04 with GCC5 toolchain. Four different firmware builds are
  10 supported and are described below.
  11
  12 | Configuration name      | Architectures      | DSC File         |Additional Flags |
  13 | :----                   | :-----             | :----            | :----           |
  14 | IA32                    | IA32               | EmulatorPkg.dsc  | None            |
  15 | X64                     | X64                | EmulatorPkg.dsc  | None            |
  16 | IA32 Full               | IA32               | EmulatorPkg.dsc  | SECURE_BOOT_ENABLE=TRUE |
  17 | X64 Full                | X64                | EmulatorPkg.dsc  | SECURE_BOOT_ENABLE=TRUE |
  18
  19 ## EDK2 Developer environment
  20
  21 - [Python 3.8.x - Download & Install](https://www.python.org/downloads/)
  22 - [GIT - Download & Install](https://git-scm.com/download/)
  23 - [Edk2 Source](https://github.com/tianocore/edk2)
  24 - For building Basetools and other host applications
  25
  26   ``` bash
  27   sudo apt-get update
  28   sudo apt-get install gcc g++ make uuid-dev
  29   ```
  30
  31 - For building ARCH IA32 on X64 Ubuntu 18.04 LTS these steps where needed.
  32
  33   ``` bash
  34   sudo dpkg --add-architecture i386
  35   sudo apt-get update
  36   sudo apt-get install libc6-dev:i386 libx11-dev:i386 libxext-dev:i386 lib32gcc-7-dev
  37   ```
  38
  39 Note: edksetup, Submodule initialization and manual installation of NASM, iASL, or
  40 the required cross-compiler toolchains are **not** required, this is handled by the
  41 Pytools build system.
  42
  43 ## Building with Pytools for EmulatorPkg
  44
  45 1. [Optional] Create a Python Virtual Environment - generally once per workspace
  46
  47     ``` bash
  48     python -m venv <name of virtual environment>
  49     ```
  50
  51 2. [Optional] Activate Virtual Environment - each time new shell opened
  52     - Linux
  53
  54       ```bash
  55       source <name of virtual environment>/bin/activate
  56       ```
  57
  58     - Windows
  59
  60       ``` bash
  61       <name of virtual environment>/Scripts/activate.bat
  62       ```
  63
  64 3. Install Pytools - generally once per virtual env or whenever pip-requirements.txt changes
  65
  66     ``` bash
  67     pip install --upgrade -r pip-requirements.txt
  68     ```
  69
  70 4. Initialize & Update Submodules - only when submodules updated
  71
  72     ``` bash
  73     stuart_setup -c EmulatorPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
  74     ```
  75
  76 5. Initialize & Update Dependencies - only as needed when ext_deps change
  77
  78     ``` bash
  79     stuart_update -c EmulatorPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
  80     ```
  81
  82 6. Compile the basetools if necessary - only when basetools C source files change
  83
  84     ``` bash
  85     python BaseTools/Edk2ToolsBuild.py -t <ToolChainTag>
  86     ```
  87
  88 7. Compile Firmware
  89
  90     ``` bash
  91     stuart_build -c EmulatorPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH>
  92     ```
  93
  94     - use `stuart_build -c EmulatorPkg/PlatformCI/PlatformBuild.py -h` option to see additional
  95     options like `--clean`
  96
  97 8. Running Emulator
  98     - You can add `--FlashRom` to the end of your build command and the emulator will run after the
  99     build is complete.
 100     - or use the `--FlashOnly` feature to just run the emulator.
 101
 102       ``` bash
 103       stuart_build -c EmulatorPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG> -a <TARGET_ARCH> --FlashOnly
 104       ```
 105
 106 ### Notes
 107
 108 1. Configuring *ACTIVE_PLATFORM* and *TARGET_ARCH* in Conf/target.txt is **not** required. This
 109    environment is set by PlatformBuild.py based upon the `[-a <TARGET_ARCH>]` parameter.
 110
 111 **NOTE:** Logging the execution output will be in the normal stuart log as well as to your console.
 112
 113 ### Custom Build Options
 114
 115 **MAKE_STARTUP_NSH=TRUE** will output a *startup.nsh* file to the location mapped as fs0. This is
 116 used in CI in combination with the `--FlashOnly` feature to run the Emulator to the UEFI shell and then execute
 117 the contents of *startup.nsh*.
 118
 119 ### Passing Build Defines
 120
 121 To pass build defines through _stuart_build_, prepend `BLD_*_`to the define name and pass it on the
 122 command-line. _stuart_build_ currently requires values to be assigned, so add an`=1` suffix for bare defines.
 123 For example, to enable the IP6 Network Stack, the stuart_build command-line would be:
 124
 125 `stuart_build -c EmulatorPkg/PlatformCI/PlatformBuild.py BLD_*_NETWORK_IP6_ENABLE=1`
 126
 127 ## References
 128
 129 - [Installing and using Pytools](https://github.com/tianocore/edk2-pytool-extensions/blob/master/docs/using.md#installing)
 130 - More on [python virtual environments](https://docs.python.org/3/library/venv.html)