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