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             "8005", "BASE_LIBRARY_JUMP_BUFFER.S0",
  31             "8005", "BASE_LIBRARY_JUMP_BUFFER.S1",
  32             "8005", "BASE_LIBRARY_JUMP_BUFFER.S2",
  33             "8005", "BASE_LIBRARY_JUMP_BUFFER.S3",
  34             "8005", "BASE_LIBRARY_JUMP_BUFFER.S4",
  35             "8005", "BASE_LIBRARY_JUMP_BUFFER.S5",
  36             "8005", "BASE_LIBRARY_JUMP_BUFFER.S6",
  37             "8005", "BASE_LIBRARY_JUMP_BUFFER.S7",
  38             "8005", "BASE_LIBRARY_JUMP_BUFFER.S8",
  39             "8005", "BASE_LIBRARY_JUMP_BUFFER.SP",
  40             "8005", "BASE_LIBRARY_JUMP_BUFFER.FP",
  41             "8005", "BASE_LIBRARY_JUMP_BUFFER.RA",
  42             "8001", "MSG_IPv6_DP",
  43             "8001", "MSG_IPv4_DP",
  44             "8001", "DEFAULT_ToS",
  45             "8001", "EFI_SERIAL_IO_PROTOCOL_REVISION1p1",
  46             "8001", "EFI_ABS_AltActive",
  47             "8001", "EFI_ABSP_SupportsAltActive",
  48             "8001", "_ReadWriteBarrier",
  49             "8001", "__va_copy",
  50             "8003", "__va_copy",
  51             "7007", "_EFI_LEGACY_SPI_CONTROLLER_PROTOCOL",
  52             "7007", "_EFI_LEGACY_SPI_FLASH_PROTOCOL",
  53             "7007", "_EFI_SPI_NOR_FLASH_PROTOCOL",
  54             "7007", "_EFI_SPI_HC_PROTOCOL",
  55             "8002", "aligned (",
  56             "4002", "_ReturnAddress"
  57         ],
  58         ## Both file path and directory path are accepted.
  59         "IgnoreFiles": [
  60             "Include/IndustryStandard/Acpi64.h",
  61             "Include/IndustryStandard/Tpm12.h",
  62             "Include/IndustryStandard/Tpm20.h",
  63             "Include/IndustryStandard/IoRemappingTable.h",
  64             "Include/IndustryStandard/UefiTcgPlatform.h",
  65             "Include/Library/PcdLib.h",
  66             "Include/Library/SafeIntLib.h",
  67             "Include/Protocol/DebugSupport.h",
  68             "Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLib.c"
  69         ]
  70     },
  71     ## options defined ci/Plugin/CompilerPlugin
  72     "CompilerPlugin": {
  73         "DscPath": "MdePkg.dsc"
  74     },
  75
  76     ## options defined ci/Plugin/HostUnitTestCompilerPlugin
  77     "HostUnitTestCompilerPlugin": {
  78         "DscPath": "Test/MdePkgHostTest.dsc"
  79     },
  80
  81     ## options defined ci/Plugin/CharEncodingCheck
  82     "CharEncodingCheck": {
  83         "IgnoreFiles": []
  84     },
  85
  86     ## options defined ci/Plugin/DependencyCheck
  87     "DependencyCheck": {
  88         "AcceptableDependencies": [
  89             "MdePkg/MdePkg.dec"
  90         ],
  91         # For host based unit tests
  92         "AcceptableDependencies-HOST_APPLICATION":[
  93             "UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
  94         ],
  95         # For UEFI shell based apps
  96         "AcceptableDependencies-UEFI_APPLICATION":[],
  97         "IgnoreInf": []
  98     },
  99
 100     ## options defined ci/Plugin/DscCompleteCheck
 101     "DscCompleteCheck": {
 102         "IgnoreInf": [""],
 103         "DscPath": "MdePkg.dsc"
 104     },
 105
 106     ## options defined ci/Plugin/HostUnitTestDscCompleteCheck
 107     "HostUnitTestDscCompleteCheck": {
 108         "IgnoreInf": [""],
 109         "DscPath": "Test/MdePkgHostTest.dsc"
 110     },
 111
 112     ## options defined ci/Plugin/GuidCheck
 113     "GuidCheck": {
 114         "IgnoreGuidName": [
 115             "gEfiFirmwareVolumeTopFileGuid" # sec modules must be set to this guid
 116         ],
 117         "IgnoreGuidValue": ["00000000-0000-0000-0000-000000000000"],
 118         "IgnoreFoldersAndFiles": [],
 119         "IgnoreDuplicates": [
 120             "gEfiFirmwareVolumeBlockProtocolGuid=gEfiFirmwareVolumeBlock2ProtocolGuid",
 121             "gEfiMmAccessProtocolGuid=gEfiSmmAccess2ProtocolGuid",
 122             "gEfiSmmCommunicationProtocolGuid=gEfiMmCommunicationProtocolGuid",
 123             "gEfiMmPciRootBridgeIoProtocolGuid=gEfiSmmPciRootBridgeIoProtocolGuid",
 124             "gEfiTrEEProtocolGuid=gEfiTcg2ProtocolGuid",
 125             "gEfiSmmPowerButtonDispatch2ProtocolGuid=gEfiMmPowerButtonDispatchProtocolGuid",
 126             "gEfiSmmBase2ProtocolGuid=gEfiMmBaseProtocolGuid",
 127             "gEfiSmmUsbDispatch2ProtocolGuid=gEfiMmUsbDispatchProtocolGuid",
 128             "gEfiSmmCpuProtocolGuid=gEfiMmCpuProtocolGuid",
 129             "gEfiAcpiTableGuid=gEfiAcpi20TableGuid",
 130             "gEfiSmmControl2ProtocolGuid=gEfiMmControlProtocolGuid",
 131             "gEfiSmmStandbyButtonDispatch2ProtocolGuid=gEfiMmStandbyButtonDispatchProtocolGuid",
 132             "gEfiSmmStatusCodeProtocolGuid=gEfiMmStatusCodeProtocolGuid",
 133             "gEfiDxeSmmReadyToLockProtocolGuid=gEfiDxeMmReadyToLockProtocolGuid",
 134             "gEfiSmmIoTrapDispatch2ProtocolGuid=gEfiMmIoTrapDispatchProtocolGuid",
 135             "gEfiSmmReadyToLockProtocolGuid=gEfiMmReadyToLockProtocolGuid",
 136             "gEfiSmmSxDispatch2ProtocolGuid=gEfiMmSxDispatchProtocolGuid",
 137             "gEfiPeiCapsulePpiGuid=gPeiCapsulePpiGuid",
 138             "gEfiSmmCpuIo2ProtocolGuid=gEfiMmCpuIoProtocolGuid",
 139             "gEfiSmmRscHandlerProtocolGuid=gEfiMmRscHandlerProtocolGuid",
 140             "gEfiSmmConfigurationProtocolGuid=gEfiMmConfigurationProtocolGuid",
 141             "gEfiSmmGpiDispatch2ProtocolGuid=gEfiMmGpiDispatchProtocolGuid",
 142             "gEfiSmmEndOfDxeProtocolGuid=gEfiMmEndOfDxeProtocolGuid",
 143             "gEfiSmmSwDispatch2ProtocolGuid=gEfiMmSwDispatchProtocolGuid",
 144             "gEfiDebugPortProtocolGuid=gEfiDebugPortVariableGuid=gEfiDebugPortDevicePathGuid", ## is this a bug
 145             "gEfiProcessorSpecificErrorSectionGuid=gEfiIa32X64ProcessorErrorSectionGuid",  ## is this a bug
 146             "gEfiSmmPeriodicTimerDispatch2ProtocolGuid=gEfiMmPeriodicTimerDispatchProtocolGuid",
 147             "gEfiPeiMmAccessPpiGuid=gPeiSmmAccessPpiGuid",
 148             "gPeiSmmControlPpiGuid=gEfiPeiMmControlPpiGuid",
 149             "gEfiPeiMmCommunicationPpiGuid=gEfiPeiSmmCommunicationPpiGuid",
 150             ]
 151     },
 152
 153     ## options defined ci/Plugin/LibraryClassCheck
 154     "LibraryClassCheck": {
 155         "IgnoreHeaderFile": []
 156     },
 157
 158     ## options defined ci/Plugin/SpellCheck
 159     "SpellCheck": {
 160         "AuditOnly": True,           # Fails test but run in AuditOnly mode to collect log
 161         "IgnoreFiles": [],           # use gitignore syntax to ignore errors in matching files
 162         "ExtendWords": [],           # words to extend to the dictionary for this package
 163         "IgnoreStandardPaths": [],   # Standard Plugin defined paths that should be ignore
 164         "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
 165     }
 166 }