From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.61]) by mx.groups.io with SMTP id smtpd.web11.4198.1586414887535197313 for ; Wed, 08 Apr 2020 23:48:07 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=che3EZ7t; spf=pass (domain: redhat.com, ip: 205.139.110.61, mailfrom: lersek@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1586414886; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=nGqABzYkfLjg0oKDyHf3fk4hoEYKlusptNxDw47vmqw=; b=che3EZ7tLPk82a7mKHnXgFbLxOxM87aS1RxbioQPS6G4U386nZM1FETk8NL5UYab6/Q/za WSCIoj5EgUctqxSg0UKjlEaLPm6+oCY55YWsdeo33O7o+lEN4dloCE20+SH+aJ1J1i+YU8 2+TtHluEKa5wP73qCQ/3LkjbSiYWtTU= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-222-nuJ21PdDNFmNOnbhyFxyqQ-1; Thu, 09 Apr 2020 02:47:59 -0400 X-MC-Unique: nuJ21PdDNFmNOnbhyFxyqQ-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id CA289107ACCA; Thu, 9 Apr 2020 06:47:57 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-112-213.ams2.redhat.com [10.36.112.213]) by smtp.corp.redhat.com (Postfix) with ESMTP id 27F225C1C5; Thu, 9 Apr 2020 06:47:55 +0000 (UTC) Subject: Re: [PATCH v1 2/6] ArmVirtPkg: Add Platform CI and configuration for Core CI To: michael.kubacki@outlook.com, devel@edk2.groups.io Cc: Ard Biesheuvel , Leif Lindholm References: <20200408181327.4324-1-michael.kubacki@outlook.com> From: "Laszlo Ersek" Message-ID: <6fe668c4-44ff-fd22-ea3c-d05047054f55@redhat.com> Date: Thu, 9 Apr 2020 08:47:55 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 MIME-Version: 1.0 In-Reply-To: X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable On 04/08/20 20:13, michael.kubacki@outlook.com wrote: > From: Sean Brogan >=20 > REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3D2570 >=20 > Add new Azure Pipeline definitions to build and run ArmVirtPkg with: > * Ubuntu GCC5 > Add PyTool based build of ArmVirtPkg > Add extdep for managing the iasl dependency > Add ArmVirtPkg.ci.yaml for Core CI > Add README-pytools for details and instructions >=20 > Cc: Laszlo Ersek > Cc: Ard Biesheuvel > Cc: Leif Lindholm > Signed-off-by: Sean Brogan > --- > ArmVirtPkg/.azurepipelines/Ubuntu-GCC5.yml | 89 +++++++ > ArmVirtPkg/ArmVirtPkg.ci.yaml | 103 ++++++++ > ArmVirtPkg/PlatformBuild.py | 263 ++++++++++++++++++++ > ArmVirtPkg/README-pytools.md | 123 +++++++++ > ArmVirtPkg/iasl_ext_dep.yaml | 21 ++ > 5 files changed, 599 insertions(+) Can we move as many as possible from these files under a separate subdirectory? For example, "PlatformBuild.py" seems to be referenced explicitly by the other files, so I guess at least "PlatformBuild.py" could be "tucked away". My intent with this request is two-fold: - collect CI-related files ("metafiles") in their own dedicated space, - when someone runs "ls -l" in the package root dir, prevent them from thinking that e.g. "PlatformBuild.py" or "iasl_ext_dep.yaml" are somehow necessary (or useful) for building locally. Otherwise I'm ready to ACK this patch! Thanks, Laszlo >=20 > diff --git a/ArmVirtPkg/.azurepipelines/Ubuntu-GCC5.yml b/ArmVirtPkg/.azu= repipelines/Ubuntu-GCC5.yml > new file mode 100644 > index 000000000000..ef5b61a0d4df > --- /dev/null > +++ b/ArmVirtPkg/.azurepipelines/Ubuntu-GCC5.yml > @@ -0,0 +1,89 @@ > +## @file > +# Azure Pipeline build file for building a platform. > +# > +# Platform: ArmVirtQemu > +# OS: Ubuntu > +# Toolchain: GCC5 > +# > +# Copyright (c) Microsoft Corporation. > +# SPDX-License-Identifier: BSD-2-Clause-Patent > +## > +trigger: > + - master > +pr: > + - master > + > +jobs: > + - job: Platform_CI > + variables: > + package: 'ArmVirtPkg' > + vm_image: 'ubuntu-latest' > + should_run: true > + run_flags: "MAKE_STARTUP_NSH=3DTRUE QEMU_HEADLESS=3DTRUE" > + > + #Use matrix to speed up the build process > + strategy: > + matrix: > + QEMU_AARCH64_DEBUG: > + Build.File: "$(package)/PlatformBuild.py" > + Build.Arch: "AARCH64" > + Build.Flags: "" > + Build.Target: "DEBUG" > + Run.Flags: $(run_flags) > + Run: $(should_run) > + QEMU_AARCH64_RELEASE: > + Build.File: "$(package)/PlatformBuild.py" > + Build.Arch: "AARCH64" > + Build.Flags: "" > + Build.Target: "RELEASE" > + Run.Flags: $(run_flags) > + Run: $(should_run) > + QEMU_AARCH64_NOOPT: > + Build.File: "$(package)/PlatformBuild.py" > + Build.Arch: "AARCH64" > + Build.Flags: "" > + Build.Target: "NOOPT" > + Run.Flags: $(run_flags) > + Run: $(should_run) > + QEMU_ARM_DEBUG: > + Build.File: "$(package)/PlatformBuild.py" > + Build.Arch: "ARM" > + Build.Flags: "" > + Build.Target: "DEBUG" > + Run.Flags: $(run_flags) > + Run: $(should_run) > + QEMU_ARM_RELEASE: > + Build.File: "$(package)/PlatformBuild.py" > + Build.Arch: "ARM" > + Build.Flags: "" > + Build.Target: "RELEASE" > + Run.Flags: $(run_flags) > + Run: $(should_run) > + QEMU_ARM_NOOPT: > + Build.File: "$(package)/PlatformBuild.py" > + Build.Arch: "ARM" > + Build.Flags: "" > + 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) > + extra_install_step: > + - bash: sudo apt-get install qemu > + displayName: Install qemu > + condition: and(gt(variables.pkg_count, 0), succeeded()) > diff --git a/ArmVirtPkg/ArmVirtPkg.ci.yaml b/ArmVirtPkg/ArmVirtPkg.ci.yam= l > new file mode 100644 > index 000000000000..4553725ee528 > --- /dev/null > +++ b/ArmVirtPkg/ArmVirtPkg.ci.yaml > @@ -0,0 +1,103 @@ > +## @file > +# Core CI configuration for ArmVirtPkg > +# > +# ArmVirtPkg is part of Platform Ci for builds so this is only > +# used for code analysis. > +# > +# Copyright (c) Microsoft Corporation > +# SPDX-License-Identifier: BSD-2-Clause-Patent > +## > +{ > + ## options defined .pytool/Plugin/CompilerPlugin > + "CompilerPlugin": { > + "DscPath": "" # Don't support this test > + }, > + > + ## options defined .pytool/Plugin/HostUnitTestCompilerPlugin > + "HostUnitTestCompilerPlugin": { > + "DscPath": "" # Don't support this test > + }, > + > + ## options defined .pytool/Plugin/CharEncodingCheck > + "CharEncodingCheck": { > + "IgnoreFiles": [] > + }, > + > + ## options defined .pytool/Plugin/DependencyCheck > + "DependencyCheck": { > + "AcceptableDependencies": [ > + "MdePkg/MdePkg.dec", > + "MdeModulePkg/MdeModulePkg.dec", > + "ArmVirtPkg/ArmVirtPkg.dec", > + "NetworkPkg/NetworkPkg.dec", > + "ArmPkg/ArmPkg.dec", > + "OvmfPkg/OvmfPkg.dec", > + "EmbeddedPkg/EmbeddedPkg.dec", > + "ArmPlatformPkg/ArmPlatformPkg.dec", > + "SecurityPkg/SecurityPkg.dec", > + "ShellPkg/ShellPkg.dec" #Is this ok? > + ], > + # For host based unit tests > + "AcceptableDependencies-HOST_APPLICATION":[ > + "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec" > + ], > + # For UEFI shell based apps > + "AcceptableDependencies-UEFI_APPLICATION":[ > + > + ], > + "IgnoreInf": [] > + }, > + > + ## options defined .pytool/Plugin/DscCompleteCheck > + "DscCompleteCheck": { > + "IgnoreInf": [""], > + "DscPath": "" # Don't support this test > + }, > + > + ## options defined .pytool/Plugin/HostUnitTestDscCompleteCheck > + "HostUnitTestDscCompleteCheck": { > + "IgnoreInf": [""], > + "DscPath": "" # Don't support this test > + }, > + > + ## options defined .pytool/Plugin/GuidCheck > + "GuidCheck": { > + "IgnoreGuidName": [], > + "IgnoreGuidValue": [], > + "IgnoreFoldersAndFiles": [], > + "IgnoreDuplicates": [], > + }, > + > + ## options defined .pytool/Plugin/LibraryClassCheck > + "LibraryClassCheck": { > + "IgnoreHeaderFile": [] > + }, > + > + ## options defined .pytool/Plugin/SpellCheck > + "SpellCheck": { > + "AuditOnly": False, # Fails right now with over 270 er= rors > + "IgnoreFiles": [], # use gitignore syntax to ignore er= rors in matching files > + "ExtendWords": [ > + "setjump", > + "plong", > + "lparam", > + "lpdword", > + "lpthread", > + "lresult", > + "bootable", > + "bsymbolic", > + "endiannness", > + "fvmain", > + "multiboot", > + "qemu's", > + "ramdisk", > + "ramfb", > + "unbootable", > + "virt's", > + "werror", > + "xenio" > + ], # words to extend to the dictionary for this packag= e > + "IgnoreStandardPaths": [], # Standard Plugin defined paths tha= t should be ignore > + "AdditionalIncludePaths": [] # Additional paths to spell check (= wildcards supported) > + } > +} > diff --git a/ArmVirtPkg/PlatformBuild.py b/ArmVirtPkg/PlatformBuild.py > new file mode 100644 > index 000000000000..c2c5cd098e7e > --- /dev/null > +++ b/ArmVirtPkg/PlatformBuild.py > @@ -0,0 +1,263 @@ > +=EF=BB=BF# @file > +# Script to Build ArmVirtPkg UEFI firmware > +# > +# Copyright (c) Microsoft Corporation. > +# SPDX-License-Identifier: BSD-2-Clause-Patent > +## > +import os > +import logging > + > +from edk2toolext.environment import shell_environment > +from edk2toolext.environment.uefi_build import UefiBuilder > +from edk2toolext.invocables.edk2_platform_build import BuildSettingsMana= ger > +from edk2toolext.invocables.edk2_setup import SetupSettingsManager, Requ= iredSubmodule > +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 =3D ("ArmVirtPkg",) > + ArchSupported =3D ("AARCH64", "ARM") > + TargetsSupported =3D ("DEBUG", "RELEASE", "NOOPT") > + Scopes =3D ('armvirt', 'edk2-build') > + WorkspaceRoot =3D os.path.realpath(os.path.join( > + os.path.dirname(os.path.abspath(__file__)), "..")) > + > + # ##################################################################= ##################### # > + # Configuration for Update & Setup = # > + # ##################################################################= ##################### # > + > + > +class SettingsManager(UpdateSettingsManager, SetupSettingsManager, PrEva= lSettingsManager): > + > + 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 buil= d ''' > + 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 =3D [] > + rs.append(RequiredSubmodule( > + "ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3", False= )) > + rs.append(RequiredSubmodule( > + "CryptoPkg/Library/OpensslLib/openssl", False)) > + return rs > + > + def SetArchitectures(self, list_of_requested_architectures): > + ''' Confirm the requests architecture list is valid and configur= e SettingsManager > + to run only the requested architectures. > + > + Raise Exception if a list_of_requested_architectures is not supp= orted > + ''' > + unsupported =3D set(list_of_requested_architectures) - \ > + set(self.GetArchitecturesSupported()) > + if(len(unsupported) > 0): > + errorString =3D ( > + "Unsupported Architecture Requested: " + " ".join(unsupp= orted)) > + logging.critical(errorString) > + raise Exception(errorString) > + self.ActualArchitectures =3D list_of_requested_architectures > + > + def GetWorkspaceRoot(self): > + ''' get WorkspacePath ''' > + return CommonPlatform.WorkspaceRoot > + > + def GetActiveScopes(self): > + ''' return tuple containing scopes that should be active for thi= s process ''' > + > + scopes =3D CommonPlatform.Scopes > + ActualToolChainTag =3D shell_environment.GetBuildVars().GetValue= ("TOOL_CHAIN_TAG", "") > + > + if GetHostInfo().os.upper() =3D=3D "LINUX" and ActualToolChainTa= g.upper().startswith("GCC"): > + if "AARCH64" in self.ActualArchitectures: > + scopes +=3D ("gcc_aarch64_linux",) > + if "ARM" in self.ActualArchitectures: > + scopes +=3D ("gcc_arm_linux",) > + return scopes > + > + def FilterPackagesToTest(self, changedFilesList: list, potentialPack= agesList: 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 =3D [] > + possible_packages =3D 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 =3D possible_packages > + break > + > + # if the azure pipeline file changed > + if ".azurepipelines" in f and "ArmVirt" in f: > + build_these_packages =3D possible_packages > + break > + > + # if the azure pipeline platform template file changed > + if ".azurepipelines" in f and "platforms" in f and "template= s" in f: > + build_these_packages =3D 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("ArmVirtPkg", "ArmVirtQemu.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=3D"build_arch", type= =3Dstr, default=3D"AARCH64", > + help=3D"Optional - Architecture to build.= Default =3D AARCH64") > + > + 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", "ArmVirtPkg/ArmVirtQemu.dsc", "From CmdLi= ne") > + > + def GetWorkspaceRoot(self): > + ''' get WorkspacePath ''' > + return CommonPlatform.WorkspaceRoot > + > + def GetPackagesPath(self): > + ''' Return a list of workspace relative paths that should be map= ped as edk2 PackagesPath ''' > + return () > + > + def GetActiveScopes(self): > + ''' return tuple containing scopes that should be active for thi= s process ''' > + scopes =3D CommonPlatform.Scopes > + ActualToolChainTag =3D shell_environment.GetBuildVars().GetValue= ("TOOL_CHAIN_TAG", "") > + Arch =3D shell_environment.GetBuildVars().GetValue("TARGET_ARCH"= , "") > + > + if GetHostInfo().os.upper() =3D=3D "LINUX" and ActualToolChainTa= g.upper().startswith("GCC"): > + if "AARCH64" =3D=3D Arch: > + scopes +=3D ("gcc_aarch64_linux",) > + elif "ARM" =3D=3D Arch: > + scopes +=3D ("gcc_arm_linux",) > + return 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 run= ning > + # uses the stuart_build command. > + if(shell_environment.GetBuildVars().GetValue("MAKE_STARTUP_NSH",= "FALSE") =3D=3D "TRUE"): > + return "ArmVirtPkg_With_Run" > + return "ArmVirtPkg" > + > + def GetLoggingLevel(self, loggerType): > + ''' Get the logging level for a given type > + base =3D=3D lowest logging level supported > + con =3D=3D Screen logging > + txt =3D=3D plain text file logging > + md =3D=3D markdown file logging > + ''' > + return logging.DEBUG > + > + def SetPlatformEnv(self): > + logging.debug("PlatformBuilder SetPlatformEnv") > + self.env.SetValue("PRODUCT_NAME", "ArmVirtQemu", "Platform Hardc= oded") > + self.env.SetValue("MAKE_STARTUP_NSH", "FALSE", "Default to false= ") > + self.env.SetValue("QEMU_HEADLESS", "FALSE", "Default to false") > + return 0 > + > + def PlatformPreBuild(self): > + return 0 > + > + def PlatformPostBuild(self): > + return 0 > + > + def FlashRomImage(self): > + VirtualDrive =3D os.path.join(self.env.GetValue( > + "BUILD_OUTPUT_BASE"), "VirtualDrive") > + os.makedirs(VirtualDrive, exist_ok=3DTrue) > + OutputPath_FV =3D os.path.join( > + self.env.GetValue("BUILD_OUTPUT_BASE"), "FV") > + Built_FV =3D os.path.join(OutputPath_FV, "QEMU_EFI.fd") > + > + # pad fd to 64mb > + with open(Built_FV, "ab") as fvfile: > + fvfile.seek(0, os.SEEK_END) > + additional =3D b'\0' * ((64 * 1024 * 1024)-fvfile.tell()) > + fvfile.write(additional) > + > + # QEMU must be on that path > + > + # Unique Command and Args parameters per ARCH > + if (self.env.GetValue("TARGET_ARCH").upper() =3D=3D "AARCH64"): > + cmd =3D "qemu-system-aarch64" > + args =3D "-M virt" > + args +=3D " -cpu cortex-a57" = # emulate cpu > + elif(self.env.GetValue("TARGET_ARCH").upper() =3D=3D "ARM"): > + cmd =3D "qemu-system-arm" > + args =3D "-M virt" > + args +=3D " -cpu cortex-a15" = # emulate cpu > + else: > + raise NotImplementedError() > + > + # Common Args > + args +=3D " -pflash " + Built_FV = # path to fw > + args +=3D " -m 1024" = # 1gb memory > + # turn off network > + args +=3D " -net none" > + # Serial messages out > + args +=3D " -serial stdio" > + # Mount disk with startup.nsh > + args +=3D f" -drive file=3Dfat:rw:{VirtualDrive},format=3Draw,me= dia=3Ddisk" > + > + # Conditional Args > + if (self.env.GetValue("QEMU_HEADLESS").upper() =3D=3D "TRUE"): > + args +=3D " -display none" # no graphics > + > + if (self.env.GetValue("MAKE_STARTUP_NSH").upper() =3D=3D "TRUE")= : > + f =3D open(os.path.join(VirtualDrive, "startup.nsh"), "w") > + f.write("BOOT SUCCESS !!! \n") > + # add commands here > + f.write("reset -s\n") > + f.close() > + > + ret =3D RunCmd(cmd, args) > + > + if ret =3D=3D 0xc0000005: > + # for some reason getting a c0000005 on successful return > + return 0 > + > + return ret > diff --git a/ArmVirtPkg/README-pytools.md b/ArmVirtPkg/README-pytools.md > new file mode 100644 > index 000000000000..ea70018e510a > --- /dev/null > +++ b/ArmVirtPkg/README-pytools.md > @@ -0,0 +1,123 @@ > +# ArmVirtPkg > + > +This README-pytools.md summarizes the current state of Platform CI for A= rmVirtPkg. It also describes how to _build_ ArmVirtPkg using the Pytools b= uild system. > + > +## Platform CI Current Status > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > + > +
ConfigBuild & RunNotes
DEBUGRELEASENOOPT
> + Ubuntu 18.04 GCC5 > +
AARCH64 > + > + > + > + > + > + > + > + > +
ARM > + > + > + > + > + > + > + > + > +
> + > +### Config Details > + > +| Config | Architectures |Additional Flags | > +| :---- | :----- | :---- | > +| AARCH64 | AARCH64 | None | > +| ARM | ARM | None | > + > +## Setup > + > +### The Usual EDK2 Build Setup > + > +- [Python 3.8.x - Download & Install](https://www.python.org/downloads/) > +- [GIT - Download & Install](https://git-scm.com/download/) > +- [GIT - Configure for EDK II](https://github.com/tianocore/tianocore.gi= thub.io/wiki/Windows-systems#github-help) > +- [QEMU - Download, Install, and add to your path](https://www.qemu.org/= download/) > +- [EDKII Source - Download/Checkout from Github](https://github.com/tian= ocore/tianocore.github.io/wiki/Windows-systems#download) > + - **NOTE:** Do _not_ follow the EDK II Compile Tools and Build instruc= tions, see below... > + > +### Differences from EDK Classic Build Setup > + > +- Build BaseTools using "`C:\git\edk2>python BaseTools\Edk2ToolsBuild.py= [-t ]`" > + - This replaces "`edksetup Rebuild`" from the classic build system > + - For Windows `` examples, refer to [Windows ToolChain M= atrix](https://github.com/tianocore/tianocore.github.io/wiki/Windows-system= s-ToolChain-Matrix), defaults to `VS2017` if not specified > +- **No Action:** Submodule initialization and manual installation/setup = of NASM and iASL is **not** required, it is handled by the PyTools build sy= stem > + > +### Building with Pytools for ArmVirtPkg > + > +- Install Pytools > + - `pip install --upgrade -r pip-requirements.txt` > +- Initialize & Update Submodules > + - `stuart_setup -c ArmVirt\PlatformBuild.py TOOL_CHAIN_TAG=3D -a ` > +- Initialize & Update Dependencies (e.g. iASL, NASM & GCC Arm/Aarch64 Co= mpilers) > + - `stuart_update -c ArmVirtPkg\PlatformBuild.py TOOL_CHAIN_TAG=3D -a ` > +- Compile (AARCH64 supported / ARM support coming soon) > + - `stuart_build -c ArmVirtPkg\PlatformBuild.py TOOL_CHAIN_TAG=3D -a ` > +- Running Emulator > + - You can add `--FlashRom` to the end of your build command and the em= ulator will run after the build is complete. > + - or use the FlashOnly feature like `stuart_build -c ArmVirtPkg\Platfo= rmBuild.py TOOL_CHAIN_TAG=3D -a --FlashOnly` = to just run the emulator. > + > +### Notes > + > +1. Including the expected build architecture and toolchain to the _stuar= t_update_ command is critical. This is because there are extra scopes and t= ools that will be resolved during the update step that need to match your b= uild step. > +2. 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. > +3. QEMU must be on your path. On Windows this is a manual process and n= ot part of the QEMU installer. > + > +**NOTE:** Logging the execution output will be in the normal stuart log = as well as to your console. > + > +## Custom Build Options > + > +**MAKE_STARTUP_NSH=3DTRUE** will output a _startup.nsh_ file to the loca= tion mapped as fs0. This is used in CI in combination with the --FlashOnly = feature to run QEMU to the UEFI shell and then execute the contents of star= tup.nsh. > + > +**QEMU_HEADLESS=3DTRUE** Since CI servers run headless QEMU must be told= to run with no display otherwise an error occurs. Locally you don't need t= o set this. > + > +## Passing Build Defines > + > +To pass build defines through _stuart_build_, prepend `BLD_*_`to the def= ine name and pass it on the command-line. _stuart_build_ currently requires= values to be assigned, so add an`=3D1` suffix for bare defines. > +For example, to enable the TPM2 support, instead of the traditional "-D = TPM2_ENABLE=3DTRUE", the stuart_build command-line would be: > + > +`stuart_build -c ArmVirtPkg/PlatformBuild.py BLD_*_TPM2_ENABLE=3DTRUE` > + > +## References > + > +- [Installing Pytools](https://github.com/tianocore/edk2-pytool-extensio= ns/blob/master/docs/using.md#installing) > +- For each workspace, consider creating & using a [Python Virtual Enviro= nment](https://docs.python.org/3/library/venv.html). For example > +- [stuart_build command-line parser](https://github.com/tianocore/edk2-p= ytool-extensions/blob/56f6a7aee09995c2f22da4765e8b0a29c1cbf5de/edk2toolext/= edk2_invocable.py#L109) > diff --git a/ArmVirtPkg/iasl_ext_dep.yaml b/ArmVirtPkg/iasl_ext_dep.yaml > new file mode 100644 > index 000000000000..8869ed3ecef1 > --- /dev/null > +++ b/ArmVirtPkg/iasl_ext_dep.yaml > @@ -0,0 +1,21 @@ > +## @file > +# Download iasl executable tool from a nuget.org package > +# - package contains different binaries based on host > +# Add the folder with the tool to the path > +# > +# This is only downloaded for scope armvirt thus > +# should have no impact on the asl compiler used by any > +# other platform build > +# > +# Copyright (c) Microsoft Corporation. > +# SPDX-License-Identifier: BSD-2-Clause-Patent > +## > +{ > + "id": "iasl-armvirt-1", > + "scope": "armvirt", > + "type": "nuget", > + "name": "iasl", > + "source": "https://api.nuget.org/v3/index.json", > + "version": "20190215.0.0", > + "flags": ["set_path", "host_specific"], > +} >=20