diff --git a/UefiPayloadPkg/PlatformCI/.azurepipelines/Ubuntu-GCC5.yml b/UefiPayloadPkg/PlatformCI/.azurepipelines/Ubuntu-GCC5.yml new file mode 100644 index 0000000000000..94c9947fc027f --- /dev/null +++ b/UefiPayloadPkg/PlatformCI/.azurepipelines/Ubuntu-GCC5.yml @@ -0,0 +1,87 @@ +## @file +# Azure Pipeline build file for building a platform. +# +# Platform: UefiPayloadPkg +# OS: Ubuntu +# Toolchain: GCC5 +# +# Copyright (c) Microsoft Corporation. +# Copyright (c) 2020, Intel Corporation. All rights reserved. +# SPDX-License-Identifier: BSD-2-Clause-Patent +## +trigger: + - master + - stable/* +pr: + - master + - stable/* +jobs: + - job: Platform_CI + variables: + package: 'UefiPayloadPkg' + vm_image: 'ubuntu-18.04' + should_run: false + run_flags: "MAKE_STARTUP_NSH=TRUE" + + #Use matrix to speed up the build process + strategy: + matrix: + UefiPayloadPkg_X64_DEBUG: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "" + Build.Target: "DEBUG" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_X64_RELEASE: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "" + Build.Target: "RELEASE" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_X64_NOOPT: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "" + Build.Target: "NOOPT" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_X64_FULL_DEBUG: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=TRUE" + Build.Target: "DEBUG" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_X64_FULL_RELEASE: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=TRUE" + Build.Target: "RELEASE" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_X64_FULL_NOOPT: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=TRUE" + Build.Target: "NOOPT" + Run.Flags: $(run_flags) + Run: $(should_run) + + workspace: + clean: all + + pool: + vmImage: $(vm_image) + + steps: + - template: ../../../.azurepipelines/templates/platform-build-run-steps.yml + parameters: + tool_chain_tag: GCC5 + build_pkg: $(package) + build_target: $(Build.Target) + build_arch: $(Build.Arch) + build_file: $(Build.File) + build_flags: $(Build.Flags) + run_flags: $(Run.Flags) diff --git a/UefiPayloadPkg/PlatformCI/.azurepipelines/Windows-VS2019.yml b/UefiPayloadPkg/PlatformCI/.azurepipelines/Windows-VS2019.yml new file mode 100644 index 0000000000000..54bafcf200b9e --- /dev/null +++ b/UefiPayloadPkg/PlatformCI/.azurepipelines/Windows-VS2019.yml @@ -0,0 +1,87 @@ +## @file +# Azure Pipeline build file for building a platform. +# +# Platform: UefiPayloadPkg +# OS: Windows +# Toolchain: VS2019 +# +# Copyright (c) Microsoft Corporation. +# Copyright (c) 2020, Intel Corporation. All rights reserved. +# SPDX-License-Identifier: BSD-2-Clause-Patent +## +trigger: + - master + - stable/* +pr: + - master + - stable/* + +jobs: + - job: Platform_CI + variables: + package: 'UefiPayloadPkg' + vm_image: 'windows-latest' + should_run: true + run_flags: "MAKE_STARTUP_NSH=TRUE" + Path_LLVM: "c:\LLVM\bin" + Module_name: "$(package)/UefiPayloadEntry/UniversalPayloadEntry.inf" + CLANG_BIN: "" + + #Use matrix to speed up the build process + strategy: + matrix: + UefiPayloadPkg_X64_DEBUG: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "BLD_*_UNIVERSAL_PAYLOAD=TRUE BLD_*_EMU_VARIABLE_ENABLE=FALSE BLD_*_DISABLE_RESET_SYSTEM=TRUE BLD_*_SERIAL_DRIVER_ENABLE=FALSE BLD_*_MAX_LOGICAL_PROCESSORS=1024 BLD_*_MAX_SIZE_NON_POPULATE_CAPSULE=0x2100000 BLD_*_RTC_INDEX_REGISTER=0x74 BLD_*_RTC_TARGET_REGISTER=0x75" + Build.Target: "DEBUG" + Run.Flags: $(run_flags) + Run: $(should_run) + Build.ToolChain: "VS2019" + UefiPayloadPkg_X64_DEBUG_Entry: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "BLD_*_UNIVERSAL_PAYLOAD=TRUE BLD_*_EMU_VARIABLE_ENABLE=FALSE BLD_*_DISABLE_RESET_SYSTEM=TRUE BLD_*_SERIAL_DRIVER_ENABLE=FALSE BLD_*_MAX_LOGICAL_PROCESSORS=1024 BLD_*_MAX_SIZE_NON_POPULATE_CAPSULE=0x2100000 BLD_*_RTC_INDEX_REGISTER=0x74 BLD_*_RTC_TARGET_REGISTER=0x75 BUILDMODULE=$(Module_name) CLANG_BIN=$(Path_LLVM)" + Build.Target: "DEBUG" + Run.Flags: $(run_flags) + Run: $(should_run) + Build.ToolChain: "VS2019" + + workspace: + clean: all + + pool: + vmImage: $(vm_image) + + steps: + - template: ../../../.azurepipelines/templates/platform-build-run-steps.yml + parameters: + tool_chain_tag: $(Build.ToolChain) + build_pkg: $(package) + build_target: $(Build.Target) + build_arch: $(Build.Arch) + build_file: $(Build.File) + build_flags: $(Build.Flags) + run_flags: $(Run.Flags) + extra_install_step: + - powershell: choco install llvm --version=11.0.0; Write-Host "##vso[task.prependpath]c:\LLVM" + displayName: Install LLVM and Set LLVM on path # friendly name displayed in the UI + condition: and(gt(variables.pkg_count, 0), succeeded()) + # Change the build toolchain + + + + + + + - bash: echo "##vso[task.setvariable variable=parameters.tool_chain_tag]CLANGDWARF" + + + + + + - script: | + echo $(TOOL_CHAIN_TAG) + echo $(CLANG_BIN) + echo $(BUILDMODULE) + echo $(tool_chain_tag) \ No newline at end of file diff --git a/UefiPayloadPkg/PlatformCI/.azurepipelines/backup_full_vs.yml b/UefiPayloadPkg/PlatformCI/.azurepipelines/backup_full_vs.yml new file mode 100644 index 0000000000000..dab4fe194ad29 --- /dev/null +++ b/UefiPayloadPkg/PlatformCI/.azurepipelines/backup_full_vs.yml @@ -0,0 +1,130 @@ +## @file +# Azure Pipeline build file for building a platform. +# +# Platform: UefiPayloadPkg +# OS: Windows +# Toolchain: VS2019 +# +# Copyright (c) Microsoft Corporation. +# Copyright (c) 2020, Intel Corporation. All rights reserved. +# SPDX-License-Identifier: BSD-2-Clause-Patent +## +trigger: + - master + - stable/* +pr: + - master + - stable/* + +jobs: + - job: Platform_CI + variables: + package: 'UefiPayloadPkg' + vm_image: 'windows-latest' + should_run: true + run_flags: "MAKE_STARTUP_NSH=TRUE" + + #Use matrix to speed up the build process + strategy: + matrix: + UefiPayloadPkg_X64_DEBUG: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "" + Build.Target: "DEBUG" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_X64_RELEASE: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "" + Build.Target: "RELEASE" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_X64_NOOPT: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "" + Build.Target: "NOOPT" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_IA32_DEBUG: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "IA32 " + Build.Flags: "" + Build.Target: "DEBUG" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_IA32_RELEASE: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "IA32 " + Build.Flags: "" + Build.Target: "RELEASE" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_IA32_NOOPT: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "IA32 " + Build.Flags: "" + Build.Target: "NOOPT" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_X64_FULL_DEBUG: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "BLD_*_UNIVERSAL_PAYLOAD=TRUE BLD_*_EMU_VARIABLE_ENABLE=FALSE BLD_*_DISABLE_RESET_SYSTEM=TRUE BLD_*_SERIAL_DRIVER_ENABLE=FALSE BLD_*_MAX_LOGICAL_PROCESSORS=1024 BLD_*_MAX_SIZE_NON_POPULATE_CAPSULE=0x2100000 BLD_*_RTC_INDEX_REGISTER=0x74 BLD_*_RTC_TARGET_REGISTER=0x75" + Build.Target: "DEBUG" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_X64_FULL_RELEASE: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "BLD_*_UNIVERSAL_PAYLOAD=TRUE BLD_*_EMU_VARIABLE_ENABLE=FALSE BLD_*_DISABLE_RESET_SYSTEM=TRUE BLD_*_SERIAL_DRIVER_ENABLE=FALSE BLD_*_MAX_LOGICAL_PROCESSORS=1024 BLD_*_MAX_SIZE_NON_POPULATE_CAPSULE=0x2100000 BLD_*_RTC_INDEX_REGISTER=0x74 BLD_*_RTC_TARGET_REGISTER=0x75" + Build.Target: "RELEASE" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_X64_FULL_NOOPT: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "X64" + Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=TRUE" + Build.Target: "NOOPT" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_IA32_FULL_DEBUG: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "IA32" + Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=TRUE" + Build.Target: "DEBUG" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_IA32_FULL_RELEASE: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "IA32" + Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=TRUE" + Build.Target: "RELEASE" + Run.Flags: $(run_flags) + Run: $(should_run) + UefiPayloadPkg_IA32_FULL_NOOPT: + Build.File: "$(package)/PlatformCI/PlatformBuild.py" + Build.Arch: "IA32" + Build.Flags: "BLD_*_SECURE_BOOT_ENABLE=TRUE" + Build.Target: "NOOPT" + Run.Flags: $(run_flags) + Run: $(should_run) + + workspace: + clean: all + + pool: + vmImage: $(vm_image) + + steps: + - template: ../../../.azurepipelines/templates/platform-build-run-steps.yml + parameters: + tool_chain_tag: VS2019 + build_pkg: $(package) + build_target: $(Build.Target) + build_arch: $(Build.Arch) + build_file: $(Build.File) + build_flags: $(Build.Flags) + run_flags: $(Run.Flags) diff --git a/UefiPayloadPkg/PlatformCI/PlatformBuild.py b/UefiPayloadPkg/PlatformCI/PlatformBuild.py new file mode 100644 index 0000000000000..16d9c7e0fdf9c --- /dev/null +++ b/UefiPayloadPkg/PlatformCI/PlatformBuild.py @@ -0,0 +1,202 @@ +# @file +# Script to Build UefiPayloadPkg UEFI firmware +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +## +import os +import logging +import io + +from edk2toolext.environment import shell_environment +from edk2toolext.environment.uefi_build import UefiBuilder +from edk2toolext.invocables.edk2_platform_build import BuildSettingsManager +from edk2toolext.invocables.edk2_setup import SetupSettingsManager, RequiredSubmodule +from edk2toolext.invocables.edk2_update import UpdateSettingsManager +from edk2toolext.invocables.edk2_pr_eval import PrEvalSettingsManager +from edk2toollib.utility_functions import RunCmd +from edk2toollib.utility_functions import GetHostInfo + +# ####################################################################################### # +# Common Configuration # +# ####################################################################################### # + + +class CommonPlatform(): + ''' Common settings for this platform. Define static data here and use + for the different parts of stuart + ''' + PackagesSupported = ("UefiPayloadPkg",) + ArchSupported = ("X64", "IA32") + TargetsSupported = ("DEBUG", "RELEASE", "NOOPT") + Scopes = ('uefipayloadpkg', 'edk2-build') + WorkspaceRoot = os.path.realpath(os.path.join( + os.path.dirname(os.path.abspath(__file__)), "..", "..")) + + # ####################################################################################### # + # Configuration for Update & Setup # + # ####################################################################################### # + + +class SettingsManager(UpdateSettingsManager, SetupSettingsManager, PrEvalSettingsManager): + + def GetPackagesSupported(self): + ''' return iterable of edk2 packages supported by this build. + These should be edk2 workspace relative paths ''' + return CommonPlatform.PackagesSupported + + def GetArchitecturesSupported(self): + ''' return iterable of edk2 architectures supported by this build ''' + return CommonPlatform.ArchSupported + + def GetTargetsSupported(self): + ''' return iterable of edk2 target tags supported by this build ''' + return CommonPlatform.TargetsSupported + + def GetRequiredSubmodules(self): + ''' return iterable containing RequiredSubmodule objects. + If no RequiredSubmodules return an empty iterable + ''' + rs = [] + # intentionally declare this one with recursive false to avoid overhead + rs.append(RequiredSubmodule( + "CryptoPkg/Library/OpensslLib/openssl", False)) + + # To avoid maintenance of this file for every new submodule + # lets just parse the .gitmodules and add each if not already in list. + # The GetRequiredSubmodules is designed to allow a build to optimize + # the desired submodules but it isn't necessary for this repository. + result = io.StringIO() + ret = RunCmd("git", "config --file .gitmodules --get-regexp path", workingdir=self.GetWorkspaceRoot(), outstream=result) + # Cmd output is expected to look like: + # submodule.CryptoPkg/Library/OpensslLib/openssl.path CryptoPkg/Library/OpensslLib/openssl + # submodule.SoftFloat.path ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3 + if ret == 0: + for line in result.getvalue().splitlines(): + _, _, path = line.partition(" ") + if path is not None: + if path not in [x.path for x in rs]: + rs.append(RequiredSubmodule(path, True)) # add it with recursive since we don't know + return rs + + def SetArchitectures(self, list_of_requested_architectures): + ''' Confirm the requests architecture list is valid and configure SettingsManager + to run only the requested architectures. + + Raise Exception if a list_of_requested_architectures is not supported + ''' + unsupported = set(list_of_requested_architectures) - \ + set(self.GetArchitecturesSupported()) + if(len(unsupported) > 0): + errorString = ( + "Unsupported Architecture Requested: " + " ".join(unsupported)) + logging.critical(errorString) + raise Exception(errorString) + self.ActualArchitectures = list_of_requested_architectures + + def GetWorkspaceRoot(self): + ''' get WorkspacePath ''' + return CommonPlatform.WorkspaceRoot + + def GetActiveScopes(self): + ''' return tuple containing scopes that should be active for this process ''' + return CommonPlatform.Scopes + + def FilterPackagesToTest(self, changedFilesList: list, potentialPackagesList: list) -> list: + ''' Filter other cases that this package should be built + based on changed files. This should cover things that can't + be detected as dependencies. ''' + build_these_packages = [] + possible_packages = potentialPackagesList.copy() + for f in changedFilesList: + # BaseTools files that might change the build + if "BaseTools" in f: + if os.path.splitext(f) not in [".txt", ".md"]: + build_these_packages = possible_packages + break + # if the azure pipeline platform template file changed + if "platform-build-run-steps.yml" in f: + build_these_packages = possible_packages + break + return build_these_packages + + def GetPlatformDscAndConfig(self) -> tuple: + ''' If a platform desires to provide its DSC then Policy 4 will evaluate if + any of the changes will be built in the dsc. + + The tuple should be (, ) + ''' + return (os.path.join("UefiPayloadPkg", "UefiPayloadPkg.dsc"), {}) + + # ####################################################################################### # + # Actual Configuration for Platform Build # + # ####################################################################################### # + + +class PlatformBuilder(UefiBuilder, BuildSettingsManager): + def __init__(self): + UefiBuilder.__init__(self) + + def AddCommandLineOptions(self, parserObj): + ''' Add command line options to the argparser ''' + parserObj.add_argument('-a', "--arch", dest="build_arch", type=str, default="X64", + help="Optional - architecture to build. IA32 will use IA32 for Pei & Dxe. " + "X64 will use X64 for both PEI and DXE.") + + def RetrieveCommandLineOptions(self, args): + ''' Retrieve command line options from the argparser ''' + + shell_environment.GetBuildVars().SetValue( + "TARGET_ARCH", args.build_arch.upper(), "From CmdLine") + shell_environment.GetBuildVars().SetValue( + "ACTIVE_PLATFORM", "UefiPayloadPkg/UefiPayloadPkg.dsc", "From CmdLine") + + def GetWorkspaceRoot(self): + ''' get WorkspacePath ''' + return CommonPlatform.WorkspaceRoot + + def GetPackagesPath(self): + ''' Return a list of workspace relative paths that should be mapped as edk2 PackagesPath ''' + return () + + def GetActiveScopes(self): + ''' return tuple containing scopes that should be active for this process ''' + return CommonPlatform.Scopes + + def GetName(self): + ''' Get the name of the repo, platform, or product being build ''' + ''' Used for naming the log file, among others ''' + + # check the startup nsh flag and if set then rename the log file. + # this helps in CI so we don't overwrite the build log since running + # uses the stuart_build command. + if(shell_environment.GetBuildVars().GetValue("MAKE_STARTUP_NSH", "FALSE") == "TRUE"): + return "UefiPayloadPkg_With_Run" + return "UefiPayloadPkg" + + def GetLoggingLevel(self, loggerType): + ''' Get the logging level for a given type + base == lowest logging level supported + con == Screen logging + txt == plain text file logging + md == markdown file logging + ''' + return logging.DEBUG + + def SetPlatformEnv(self): + logging.debug("PlatformBuilder SetPlatformEnv") + self.env.SetValue("PRODUCT_NAME", "UefiPayloadPkg", "Platform Hardcoded") + self.env.SetValue("MAKE_STARTUP_NSH", "FALSE", "Default to false") + self.env.SetValue("QEMU_HEADLESS", "FALSE", "Default to false") + self.env.SetValue("BUILDMODULE", "", "Default to blank") + self.env.SetValue("CLANG_BIN", "", "Default to blank") + return 0 + + def PlatformPreBuild(self): + return 0 + + def PlatformPostBuild(self): + return 0 + + def FlashRomImage(self): + return 0 diff --git a/UefiPayloadPkg/PlatformCI/ReadMe.md b/UefiPayloadPkg/PlatformCI/ReadMe.md new file mode 100644 index 0000000000000..3ccae34e1c3f1 --- /dev/null +++ b/UefiPayloadPkg/PlatformCI/ReadMe.md @@ -0,0 +1,130 @@ +# UefiPayloadPkg - Platform CI + +This ReadMe.md describes the Azure DevOps based Platform CI for UefiPayloadPkg and how +to use the same Pytools based build infrastructure locally. + +## Supported Configuration Details + +This solution for building and running UefiPayloadPkg has only been validated with Windows 10 +with VS2019 and Ubuntu 18.04 with GCC5 toolchain. Four different firmware builds are +supported and are described below. + +| Configuration name | Architectures | DSC File |Additional Flags | +| :---- | :----- | :---- | :---- | +| IA32 | IA32 | EmulatorPkg.dsc | None | +| X64 | X64 | EmulatorPkg.dsc | None | +| IA32 Full | IA32 | EmulatorPkg.dsc | SECURE_BOOT_ENABLE=TRUE | +| X64 Full | X64 | EmulatorPkg.dsc | SECURE_BOOT_ENABLE=TRUE | + +## EDK2 Developer environment + +- [Python 3.8.x - Download & Install](https://www.python.org/downloads/) +- [GIT - Download & Install](https://git-scm.com/download/) +- [Edk2 Source](https://github.com/tianocore/edk2) +- For building Basetools and other host applications + + ``` bash + sudo apt-get update + sudo apt-get install gcc g++ make uuid-dev + ``` + +- For building ARCH IA32 on X64 Ubuntu 18.04 LTS these steps where needed. + + ``` bash + sudo dpkg --add-architecture i386 + sudo apt-get update + sudo apt-get install libc6-dev:i386 libx11-dev:i386 libxext-dev:i386 lib32gcc-7-dev + ``` + +Note: edksetup, Submodule initialization and manual installation of NASM, iASL, or +the required cross-compiler toolchains are **not** required, this is handled by the +Pytools build system. + +## Building with Pytools for EmulatorPkg + +1. [Optional] Create a Python Virtual Environment - generally once per workspace + + ``` bash + python -m venv + ``` + +2. [Optional] Activate Virtual Environment - each time new shell opened + - Linux + + ```bash + source /bin/activate + ``` + + - Windows + + ``` bash + /Scripts/activate.bat + ``` + +3. Install Pytools - generally once per virtual env or whenever pip-requirements.txt changes + + ``` bash + pip install --upgrade -r pip-requirements.txt + ``` + +4. Initialize & Update Submodules - only when submodules updated + + ``` bash + stuart_setup -c EmulatorPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG= -a + ``` + +5. Initialize & Update Dependencies - only as needed when ext_deps change + + ``` bash + stuart_update -c EmulatorPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG= -a + ``` + +6. Compile the basetools if necessary - only when basetools C source files change + + ``` bash + python BaseTools/Edk2ToolsBuild.py -t + ``` + +7. Compile Firmware + + ``` bash + stuart_build -c EmulatorPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG= -a + ``` + + - use `stuart_build -c EmulatorPkg/PlatformCI/PlatformBuild.py -h` option to see additional + options like `--clean` + +8. Running Emulator + - You can add `--FlashRom` to the end of your build command and the emulator will run after the + build is complete. + - or use the `--FlashOnly` feature to just run the emulator. + + ``` bash + stuart_build -c EmulatorPkg/PlatformCI/PlatformBuild.py TOOL_CHAIN_TAG= -a --FlashOnly + ``` + +### Notes + +1. Configuring *ACTIVE_PLATFORM* and *TARGET_ARCH* in Conf/target.txt is **not** required. This + environment is set by PlatformBuild.py based upon the `[-a ]` parameter. + +**NOTE:** Logging the execution output will be in the normal stuart log as well as to your console. + +### Custom Build Options + +**MAKE_STARTUP_NSH=TRUE** will output a *startup.nsh* file to the location mapped as fs0. This is +used in CI in combination with the `--FlashOnly` feature to run the Emulator to the UEFI shell and then execute +the contents of *startup.nsh*. + +### Passing Build Defines + +To pass build defines through _stuart_build_, prepend `BLD_*_`to the define name and pass it on the +command-line. _stuart_build_ currently requires values to be assigned, so add an`=1` suffix for bare defines. +For example, to enable the IP6 Network Stack, the stuart_build command-line would be: + +`stuart_build -c EmulatorPkg/PlatformCI/PlatformBuild.py BLD_*_NETWORK_IP6_ENABLE=1` + +## References + +- [Installing and using Pytools](https://github.com/tianocore/edk2-pytool-extensions/blob/master/docs/using.md#installing) +- More on [python virtual environments](https://docs.python.org/3/library/venv.html)