From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from NAM04-BN3-obe.outbound.protection.outlook.com (NAM04-BN3-obe.outbound.protection.outlook.com [40.92.9.96]) by mx.groups.io with SMTP id smtpd.web12.947.1586369645783710558 for ; Wed, 08 Apr 2020 11:14:06 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@outlook.com header.s=selector1 header.b=JXb+YWLy; spf=pass (domain: outlook.com, ip: 40.92.9.96, mailfrom: michael.kubacki@outlook.com) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=nLQ6q+WxHBqE+BwvpxR/B9FHvhQiMfjUmUTGVEOEZH7JqrAlLMRitO/wX2F6i2A8cVA0AkTec1Onh+I64a5KFF5oAxh3dj5S6lueZDxLkNqP8L9D216MZXH1IblDjns5bN+OGz9PKK6/dnoz3ALn3rE8UzvSYZz/4Bs9pBk504m6T9a2e2ea0QXHcYuxskdrokLUCIEfAOfbeHAe0JxnEI4rcxivbQpSjMaMYJ5ZfOLl9DtuBEK0oBfur7kN3Z9Fnf4L+Ed7dpui/r4/HZ4iH4q/vpovgheCZK+rWSXr0mqRPYS2m8NuhXQeQfTOdDeh/cVAxviv2hlE4ynJrslSvQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=ovCuri+AHRf8uqYZnmCFPtVqUSXWi+P3Ucclwdyl9/k=; b=Dd4WidomMcJO32wZQlEXuOKVfRbgxIC3XjW9TBlaYrfjfFWREVLIYNQFCwNqnQD1EnOKN0g7xdSpRP/LMO4uMkfp9bu1O/1ui1h0Vm5cquRD0PZ7vV+5XoNulZo0DB2DmtGf4ojefEDk3zEus+SRKQc09ZrM3WC6r02Mes3v9FX5z2t7UKIv0wHLY1tD0SjMCabPw4cbEyK6qKVkIC/VWNhAVheCo2lVBC8CQx+rFcy1oSFYNS/pghKCEVOjNuc9fSRUDP7vJDWSa5RIVXmgLDTBbyFoa+KTWQRlpg5b4GOYxaGreS+BhA6SHvh7fT73CU4L1FCbnTXugQMvvyg1Lw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=outlook.com; dmarc=pass action=none header.from=outlook.com; dkim=pass header.d=outlook.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=outlook.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=ovCuri+AHRf8uqYZnmCFPtVqUSXWi+P3Ucclwdyl9/k=; b=JXb+YWLyQMeyFZD7MAzcPEtE9X1chFRQdWP/hjzh07y6r7SyEqh4rsp4fKppQJAPmYb/Sjbk7DTNzJJ8H5RC1dW4AeOLTAUPh0t3UKm7yZTOsoMuh/p1GgMEHYfoLT04J6VZtjdAxpPJzy5CODzrmwftJ6al2NeXUERp2p8aPi6DkXWjp11eP9FqnZbob/UghheoQcdZA/wLm0Te4yQX4YvCJvgOJ6pHf8Su45RsEtGi6psNfSMrjBnhA/nUNyO5yS6yM0/ZRVWYkUEYtU9v87yXS9XPPCkOL8B5eIMOHT2kLW0YhCv5o5a1gayq1iK4tt11WS+g3In1dcVycuoijw== Received: from CO1NAM04FT025.eop-NAM04.prod.protection.outlook.com (10.152.90.57) by CO1NAM04HT173.eop-NAM04.prod.protection.outlook.com (10.152.91.5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2878.19; Wed, 8 Apr 2020 18:14:04 +0000 Received: from MWHPR07MB3440.namprd07.prod.outlook.com (2a01:111:e400:7e4d::42) by CO1NAM04FT025.mail.protection.outlook.com (2a01:111:e400:7e4d::160) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2878.19 via Frontend Transport; Wed, 8 Apr 2020 18:14:04 +0000 X-IncomingTopHeaderMarker: OriginalChecksum:DF262FDE01C73FBDD219E7F52426BDEE613E2218034F802206144416D9E27B80;UpperCasedChecksum:5B340A16B2F3B893525276100AF70BC29ACC0239FB6C213F6268D8EC536EC726;SizeAsReceived:8949;Count:50 Received: from MWHPR07MB3440.namprd07.prod.outlook.com ([fe80::f5a7:e51b:e22a:959f]) by MWHPR07MB3440.namprd07.prod.outlook.com ([fe80::f5a7:e51b:e22a:959f%7]) with mapi id 15.20.2878.022; Wed, 8 Apr 2020 18:14:04 +0000 From: "Michael Kubacki" To: devel@edk2.groups.io CC: Laszlo Ersek , Ard Biesheuvel , Leif Lindholm Subject: [PATCH v1 2/6] ArmVirtPkg: Add Platform CI and configuration for Core CI Date: Wed, 8 Apr 2020 11:13:23 -0700 Message-ID: X-Mailer: git-send-email 2.16.3.windows.1 In-Reply-To: <20200408181327.4324-1-michael.kubacki@outlook.com> References: <20200408181327.4324-1-michael.kubacki@outlook.com> X-ClientProxiedBy: MWHPR10CA0054.namprd10.prod.outlook.com (2603:10b6:300:2c::16) To MWHPR07MB3440.namprd07.prod.outlook.com (2603:10b6:301:69::28) Return-Path: michael.kubacki@outlook.com X-Microsoft-Original-Message-ID: <20200408181327.4324-3-michael.kubacki@outlook.com> MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 Received: from localhost.localdomain (2001:4898:80e8:2:c970:b9b:c52f:94cf) by MWHPR10CA0054.namprd10.prod.outlook.com (2603:10b6:300:2c::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2900.15 via Frontend Transport; Wed, 8 Apr 2020 18:14:03 +0000 X-Mailer: git-send-email 2.16.3.windows.1 X-Microsoft-Original-Message-ID: <20200408181327.4324-3-michael.kubacki@outlook.com> X-TMN: [mgRR/GPh8lTw8IglHHqK+Ozt3+VdHXY2usnXE+DnzYaELGqzHvvgWCGXPwrxVERp] X-MS-PublicTrafficType: Email X-IncomingHeaderCount: 50 X-EOPAttributedMessage: 0 X-MS-Office365-Filtering-Correlation-Id: 05306b82-fff6-4217-7479-08d7dbe89ec6 X-MS-TrafficTypeDiagnostic: CO1NAM04HT173: X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: rV1PK3aciM9bB2br6zhRYnSEo5FxMNkkWo/A1jrw8OBooDcsO2FTJ+FlzMLXTaxtATT1IeF+PZmTjv4PdQy3EleS8XJyVoJUi0IOP3nDsPXPloa1Mp+oBTBw7zyeUdAIxjdoAKm04Bhvi/lN2G5/ZQ862tpfBhGRDh7IrnKO/gOXxH4PLOJXjOX/UVFx3nGwedXyuFJyPqt+Q2fdjb679AvycH/AMNtVxt4UEF+6Q8s= X-Forefront-Antispam-Report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:0;SRV:;IPV:NLI;SFV:NSPM;H:MWHPR07MB3440.namprd07.prod.outlook.com;PTR:;CAT:NONE;SFTY:;SFS:;DIR:OUT;SFP:1901; X-MS-Exchange-AntiSpam-MessageData: 0nZbuitubr6zsvb5BAPDEqvItEmVQ8qX2/Drpzz8EQNoVVrFoFRmmy+RKKX+cEWPRHJynbDmS4zki6ulvU9XyG+Iv+RVVoo6gKEmYGsazkUdpNoP6S4WwXLrhiHKGTr7nSmqPrqFZAypKZMStSN1mIEJGX1lnoLuEH4tBPjRYyb5IacwUx+XSl3AFenFtaFBFcJksex6hdDk2QjAq8EUrg== X-OriginatorOrg: outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 05306b82-fff6-4217-7479-08d7dbe89ec6 X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Apr 2020 18:14:04.1037 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa X-MS-Exchange-CrossTenant-FromEntityHeader: Internet X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000 X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO1NAM04HT173 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable From: Sean Brogan REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3D2570 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 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(+) diff --git a/ArmVirtPkg/.azurepipelines/Ubuntu-GCC5.yml b/ArmVirtPkg/.azure= pipelines/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.y= ml + 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.yaml 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 erro= rs + "IgnoreFiles": [], # use gitignore syntax to ignore erro= rs 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 package + "IgnoreStandardPaths": [], # Standard Plugin defined paths that = should be ignore + "AdditionalIncludePaths": [] # Additional paths to spell check (wi= ldcards 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 BuildSettingsManage= r +from edk2toolext.invocables.edk2_setup import SetupSettingsManager, Requir= edSubmodule +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 us= e + 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, PrEvalS= ettingsManager): + + 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 =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 configure = SettingsManager + to run only the requested architectures. + + Raise Exception if a list_of_requested_architectures is not suppor= ted + ''' + unsupported =3D set(list_of_requested_architectures) - \ + set(self.GetArchitecturesSupported()) + if(len(unsupported) > 0): + errorString =3D ( + "Unsupported Architecture Requested: " + " ".join(unsuppor= ted)) + 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 this = process ''' + + scopes =3D CommonPlatform.Scopes + ActualToolChainTag =3D shell_environment.GetBuildVars().GetValue("= TOOL_CHAIN_TAG", "") + + if GetHostInfo().os.upper() =3D=3D "LINUX" and ActualToolChainTag.= 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, potentialPackag= esList: 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 "templates"= 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 ev= aluate 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 CmdLine= ") + + def GetWorkspaceRoot(self): + ''' get WorkspacePath ''' + return CommonPlatform.WorkspaceRoot + + def GetPackagesPath(self): + ''' Return a list of workspace relative paths that should be mappe= d as edk2 PackagesPath ''' + return () + + def GetActiveScopes(self): + ''' return tuple containing scopes that should be active for this = 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 ActualToolChainTag.= 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 runni= ng + # 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 Hardcod= ed") + 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,medi= a=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 Arm= VirtPkg. It also describes how to _build_ ArmVirtPkg using the Pytools bui= ld 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.gith= ub.io/wiki/Windows-systems#github-help) +- [QEMU - Download, Install, and add to your path](https://www.qemu.org/do= wnload/) +- [EDKII Source - Download/Checkout from Github](https://github.com/tianoc= ore/tianocore.github.io/wiki/Windows-systems#download) + - **NOTE:** Do _not_ follow the EDK II Compile Tools and Build instructi= ons, 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 Mat= rix](https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems-= 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 syst= em + +### 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 Comp= ilers) + - `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 emul= ator will run after the build is complete. + - or use the FlashOnly feature like `stuart_build -c ArmVirtPkg\Platform= Build.py TOOL_CHAIN_TAG=3D -a --FlashOnly` to= just run the emulator. + +### Notes + +1. Including the expected build architecture and toolchain to the _stuart_= update_ command is critical. This is because there are extra scopes and too= ls that will be resolved during the update step that need to match your bui= ld 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 not= 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 locati= on mapped as fs0. This is used in CI in combination with the --FlashOnly fe= ature to run QEMU to the UEFI shell and then execute the contents of startu= p.nsh. + +**QEMU_HEADLESS=3DTRUE** Since CI servers run headless QEMU must be told t= o run with no display otherwise an error occurs. Locally you don't need to = set this. + +## Passing Build Defines + +To pass build defines through _stuart_build_, prepend `BLD_*_`to the defin= e name and pass it on the command-line. _stuart_build_ currently requires v= alues to be assigned, so add an`=3D1` suffix for bare defines. +For example, to enable the TPM2 support, instead of the traditional "-D TP= M2_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-extensions= /blob/master/docs/using.md#installing) +- For each workspace, consider creating & using a [Python Virtual Environm= ent](https://docs.python.org/3/library/venv.html). For example +- [stuart_build command-line parser](https://github.com/tianocore/edk2-pyt= ool-extensions/blob/56f6a7aee09995c2f22da4765e8b0a29c1cbf5de/edk2toolext/ed= k2_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 2.16.3.windows.1