MdePkg/MdePkg.ci.yaml

   1 ## @file
   2 # CI configuration for MdePkg
   3 #
   4 # Copyright (c) Microsoft Corporation
   5 # Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
   6 # Copyright (c) 2021, Arm Limited. All rights reserved.<BR>
   7 # SPDX-License-Identifier: BSD-2-Clause-Patent
   8 ##
   9 {
  10     ## options defined .pytool/Plugin/LicenseCheck
  11     "LicenseCheck": {
  12         "IgnoreFiles": []
  13     },
  14     "EccCheck": {
  15         ## Exception sample looks like below:
  16         ## "ExceptionList": [
  17         ##     "<ErrorID>", "<KeyWord>"
  18         ## ]
  19         "ExceptionList": [
  20             "9005", "@VDD",
  21             "8005", "gST",
  22             "8005", "gBS",
  23             "8005", "gDS",
  24             "8005", "gDS",
  25             "8002", "va_list",
  26             "8005", "EFI_BLUETOOTH_LE_SCAN_CALLBACK_INFORMATION.RSSI",
  27             "8005", "void",
  28             "8005", "va_list.__ap",
  29             "8005", "__stack_chk_guard",
  30             "8001", "MSG_IPv6_DP",
  31             "8001", "MSG_IPv4_DP",
  32             "8001", "DEFAULT_ToS",
  33             "8001", "EFI_SERIAL_IO_PROTOCOL_REVISION1p1",
  34             "8001", "EFI_ABS_AltActive",
  35             "8001", "EFI_ABSP_SupportsAltActive",
  36             "8001", "_ReadWriteBarrier",
  37             "8001", "__va_copy",
  38             "8003", "__va_copy",
  39             "7007", "_EFI_LEGACY_SPI_CONTROLLER_PROTOCOL",
  40             "7007", "_EFI_LEGACY_SPI_FLASH_PROTOCOL",
  41             "7007", "_EFI_SPI_NOR_FLASH_PROTOCOL",
  42             "7007", "_EFI_SPI_HC_PROTOCOL",
  43             "8002", "aligned (",
  44             "4002", "_ReturnAddress"
  45         ],
  46         ## Both file path and directory path are accepted.
  47         "IgnoreFiles": [
  48             "Include/IndustryStandard/Acpi64.h",
  49             "Include/IndustryStandard/Tpm12.h",
  50             "Include/IndustryStandard/Tpm20.h",
  51             "Include/IndustryStandard/IoRemappingTable.h",
  52             "Include/IndustryStandard/UefiTcgPlatform.h",
  53             "Include/Library/PcdLib.h",
  54             "Include/Library/SafeIntLib.h",
  55             "Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLib.c"
  56         ]
  57     },
  58     ## options defined ci/Plugin/CompilerPlugin
  59     "CompilerPlugin": {
  60         "DscPath": "MdePkg.dsc"
  61     },
  62
  63     ## options defined ci/Plugin/HostUnitTestCompilerPlugin
  64     "HostUnitTestCompilerPlugin": {
  65         "DscPath": "Test/MdePkgHostTest.dsc"
  66     },
  67
  68     ## options defined ci/Plugin/CharEncodingCheck
  69     "CharEncodingCheck": {
  70         "IgnoreFiles": []
  71     },
  72
  73     ## options defined ci/Plugin/DependencyCheck
  74     "DependencyCheck": {
  75         "AcceptableDependencies": [
  76             "MdePkg/MdePkg.dec"
  77         ],
  78         # For host based unit tests
  79         "AcceptableDependencies-HOST_APPLICATION":[
  80             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  81         ],
  82         # For UEFI shell based apps
  83         "AcceptableDependencies-UEFI_APPLICATION":[],
  84         "IgnoreInf": []
  85     },
  86
  87     ## options defined ci/Plugin/DscCompleteCheck
  88     "DscCompleteCheck": {
  89         "IgnoreInf": [""],
  90         "DscPath": "MdePkg.dsc"
  91     },
  92
  93     ## options defined ci/Plugin/HostUnitTestDscCompleteCheck
  94     "HostUnitTestDscCompleteCheck": {
  95         "IgnoreInf": [""],
  96         "DscPath": "Test/MdePkgHostTest.dsc"
  97     },
  98
  99     ## options defined ci/Plugin/GuidCheck
 100     "GuidCheck": {
 101         "IgnoreGuidName": [
 102             "gEfiFirmwareVolumeTopFileGuid" # sec modules must be set to this guid
 103         ],
 104         "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],
 105         "IgnoreFoldersAndFiles": [],
 106         "IgnoreDuplicates": [
 107             "gEfiFirmwareVolumeBlockProtocolGuid=gEfiFirmwareVolumeBlock2ProtocolGuid",
 108             "gEfiMmAccessProtocolGuid=gEfiSmmAccess2ProtocolGuid",
 109             "gEfiSmmCommunicationProtocolGuid=gEfiMmCommunicationProtocolGuid",
 110             "gEfiMmPciRootBridgeIoProtocolGuid=gEfiSmmPciRootBridgeIoProtocolGuid",
 111             "gEfiTrEEProtocolGuid=gEfiTcg2ProtocolGuid",
 112             "gEfiSmmPowerButtonDispatch2ProtocolGuid=gEfiMmPowerButtonDispatchProtocolGuid",
 113             "gEfiSmmBase2ProtocolGuid=gEfiMmBaseProtocolGuid",
 114             "gEfiSmmUsbDispatch2ProtocolGuid=gEfiMmUsbDispatchProtocolGuid",
 115             "gEfiSmmCpuProtocolGuid=gEfiMmCpuProtocolGuid",
 116             "gEfiAcpiTableGuid=gEfiAcpi20TableGuid",
 117             "gEfiSmmControl2ProtocolGuid=gEfiMmControlProtocolGuid",
 118             "gEfiSmmStandbyButtonDispatch2ProtocolGuid=gEfiMmStandbyButtonDispatchProtocolGuid",
 119             "gEfiSmmStatusCodeProtocolGuid=gEfiMmStatusCodeProtocolGuid",
 120             "gEfiDxeSmmReadyToLockProtocolGuid=gEfiDxeMmReadyToLockProtocolGuid",
 121             "gEfiSmmIoTrapDispatch2ProtocolGuid=gEfiMmIoTrapDispatchProtocolGuid",
 122             "gEfiSmmReadyToLockProtocolGuid=gEfiMmReadyToLockProtocolGuid",
 123             "gEfiSmmSxDispatch2ProtocolGuid=gEfiMmSxDispatchProtocolGuid",
 124             "gEfiPeiCapsulePpiGuid=gPeiCapsulePpiGuid",
 125             "gEfiSmmCpuIo2ProtocolGuid=gEfiMmCpuIoProtocolGuid",
 126             "gEfiSmmRscHandlerProtocolGuid=gEfiMmRscHandlerProtocolGuid",
 127             "gEfiSmmConfigurationProtocolGuid=gEfiMmConfigurationProtocolGuid",
 128             "gEfiSmmGpiDispatch2ProtocolGuid=gEfiMmGpiDispatchProtocolGuid",
 129             "gEfiSmmEndOfDxeProtocolGuid=gEfiMmEndOfDxeProtocolGuid",
 130             "gEfiSmmSwDispatch2ProtocolGuid=gEfiMmSwDispatchProtocolGuid",
 131             "gEfiDebugPortProtocolGuid=gEfiDebugPortVariableGuid=gEfiDebugPortDevicePathGuid", ## is this a bug
 132             "gEfiProcessorSpecificErrorSectionGuid=gEfiIa32X64ProcessorErrorSectionGuid",  ## is this a bug
 133             "gEfiSmmPeriodicTimerDispatch2ProtocolGuid=gEfiMmPeriodicTimerDispatchProtocolGuid",
 134             "gEfiPeiMmAccessPpiGuid=gPeiSmmAccessPpiGuid",
 135             "gPeiSmmControlPpiGuid=gEfiPeiMmControlPpiGuid",
 136             "gEfiPeiMmCommunicationPpiGuid=gEfiPeiSmmCommunicationPpiGuid",
 137             ]
 138     },
 139
 140     ## options defined ci/Plugin/LibraryClassCheck
 141     "LibraryClassCheck": {
 142         "IgnoreHeaderFile": []
 143     },
 144
 145     ## options defined ci/Plugin/SpellCheck
 146     "SpellCheck": {
 147         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
 148         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
 149         "ExtendWords": [],           # words to extend to the dictionary for this package
 150         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
 151         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
 152     }
 153 }