]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/MdeModulePkg.dec
MdeModulePkg: Add a pcd to set the OS indications bit
[mirror_edk2.git] / MdeModulePkg / MdeModulePkg.dec
index 441118507321139f2747c135834cc5558bdeb1fa..12e0bbf57997020ce9bc367715e1ec6f22fdf274 100644 (file)
@@ -8,13 +8,7 @@
 # (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
 # Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
 # Copyright (c) 2016, Microsoft Corporation<BR>\r
-# This program and the accompanying materials are licensed and made available under\r
-# the terms and conditions of the BSD License that accompanies this distribution.\r
-# The full text of the license may be found at\r
-# http://opensource.org/licenses/bsd-license.php.\r
-#\r
-# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+# SPDX-License-Identifier: BSD-2-Clause-Patent\r
 #\r
 ##\r
 \r
 \r
 \r
 [LibraryClasses]\r
-  ##  @libraryclass  IpIo layer upon EFI IP4 Protocol.\r
-  #   This library is only intended to be used by UEFI network stack modules.\r
-  IpIoLib|Include/Library/IpIoLib.h\r
-\r
-  ##  @libraryclass  Basic function for UEFI network stack.\r
-  #   This library is only intended to be used by UEFI network stack modules.\r
-  NetLib|Include/Library/NetLib.h\r
-\r
-  ##  @libraryclass  The helper routines to access UDP service.\r
-  #   This library is only intended to be used by UEFI network stack modules.\r
-  UdpIoLib|Include/Library/UdpIoLib.h\r
-\r
-  ##  @libraryclass  The helper routines to access TCP service.\r
-  #   This library is only intended to be used by UEFI network stack modules.\r
-  TcpIoLib|Include/Library/TcpIoLib.h\r
-\r
-  ##  @libraryclass  The helper routines to access HTTP service.\r
-  #   This library is only intended to be used by UEFI network stack modules.\r
-  HttpLib|Include/Library/HttpLib.h\r
-\r
   ##  @libraryclass  Defines a set of methods to reset whole system.\r
   ResetSystemLib|Include/Library/ResetSystemLib.h\r
 \r
@@ -73,9 +47,6 @@
   ##  @libraryclass  Defines a set of interfaces on how to process capusle image update.\r
   CapsuleLib|Include/Library/CapsuleLib.h\r
 \r
-  ##  @libraryclass  Library for Deferred Procedure Calls.\r
-  DpcLib|Include/Library/DpcLib.h\r
-\r
   ##  @libraryclass    Provides global variables that are pointers\r
   #   to the UEFI HII related protocols.\r
   #\r
   ## Include/Guid/S3SmmInitDone.h\r
   gEdkiiS3SmmInitDoneGuid = { 0x8f9d4825, 0x797d, 0x48fc, { 0x84, 0x71, 0x84, 0x50, 0x25, 0x79, 0x2e, 0xf6 } }\r
 \r
+  ## Include/Guid/S3StorageDeviceInitList.h\r
+  gS3StorageDeviceInitListGuid = { 0x310e9b8c, 0xcf90, 0x421e, { 0x8e, 0x9b, 0x9e, 0xef, 0xb6, 0x17, 0xc8, 0xef } }\r
+\r
+  ## Include/Guid/SerialPortLibVendor.h\r
+  gEdkiiSerialPortLibVendorGuid = { 0xD3987D4B, 0x971A, 0x435F, { 0x8C, 0xAF, 0x49, 0x67, 0xEB, 0x62, 0x72, 0x41 } }\r
+\r
+  ## GUID indicates the capsule is to store Capsule On Disk file names.\r
+  gEdkiiCapsuleOnDiskNameGuid = { 0x98c80a4f, 0xe16b, 0x4d11, { 0x93, 0x9a, 0xab, 0xe5, 0x61, 0x26, 0x3, 0x30 } }\r
+\r
 [Ppis]\r
   ## Include/Ppi/AtaController.h\r
   gPeiAtaControllerPpiGuid       = { 0xa45e60d1, 0xc719, 0x44aa, { 0xb0, 0x7a, 0xaa, 0x77, 0x7f, 0x85, 0x90, 0x6d }}\r
   ## Include/Ppi/AtaAhciController.h\r
   gEdkiiPeiAtaAhciHostControllerPpiGuid     = { 0x61dd33ea, 0x421f, 0x4cc0, { 0x89, 0x29, 0xff, 0xee, 0xa9, 0xa1, 0xa2, 0x61 } }\r
 \r
+  ## Include/Ppi/StorageSecurityCommand.h\r
+  gEdkiiPeiStorageSecurityCommandPpiGuid    = { 0x35de0b4e, 0x30fb, 0x46c3, { 0xbd, 0x84, 0x1f, 0xdb, 0xa1, 0x58, 0xbb, 0x56 } }\r
+\r
+  ## Include/Ppi/AtaPassThru.h\r
+  gEdkiiPeiAtaPassThruPpiGuid               = { 0xa16473fd, 0xd474, 0x4c89, { 0xae, 0xc7, 0x90, 0xb8, 0x3c, 0x73, 0x86, 0x9  } }\r
+\r
+  ## Include/Ppi/Debug.h\r
+  gEdkiiDebugPpiGuid                        = { 0x999e699c, 0xb013, 0x475e, { 0xb1, 0x7b, 0xf3, 0xa8, 0xae, 0x5c, 0x48, 0x75 } }\r
+\r
+  ## Include/Ppi/NvmExpressPassThru.h\r
+  gEdkiiPeiNvmExpressPassThruPpiGuid    = { 0x6af31b2c, 0x3be, 0x46c1, { 0xb1, 0x2d, 0xea, 0x4a, 0x36, 0xdf, 0xa7, 0x4c } }\r
+\r
+  ## Include/Ppi/CapsuleOnDisk.h\r
+  gEdkiiPeiCapsuleOnDiskPpiGuid             = { 0x71a9ea61, 0x5a35, 0x4a5d, { 0xac, 0xef, 0x9c, 0xf8, 0x6d, 0x6d, 0x67, 0xe0 } }\r
+  gEdkiiPeiBootInCapsuleOnDiskModePpiGuid   = { 0xb08a11e4, 0xe2b7, 0x4b75, { 0xb5, 0x15, 0xaf, 0x61, 0x6, 0x68, 0xbf, 0xd1  } }\r
+\r
 [Protocols]\r
   ## Load File protocol provides capability to load and unload EFI image into memory and execute it.\r
   #  Include/Protocol/LoadPe32Image.h\r
 \r
   ## Include/Protocol/AtaAtapiPolicy.h\r
   gEdkiiAtaAtapiPolicyProtocolGuid = { 0xe59cd769, 0x5083, 0x4f26,{ 0x90, 0x94, 0x6c, 0x91, 0x9f, 0x91, 0x6c, 0x4e } }\r
+\r
+  ## Include/Protocol/PeCoffImageEmulator.h\r
+  gEdkiiPeCoffImageEmulatorProtocolGuid = { 0x96f46153, 0x97a7, 0x4793, { 0xac, 0xc1, 0xfa, 0x19, 0xbf, 0x78, 0xea, 0x97 } }\r
+\r
 #\r
 # [Error.gEfiMdeModulePkgTokenSpaceGuid]\r
 #   0x80000001 | Invalid value provided.\r
   # @Prompt Disable default keyboard layout in USB KeyBoard Driver.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver|FALSE|BOOLEAN|0x00010200\r
 \r
-  ## Indicates if backward compatibility to Framework HII and Framework FvHob is supported.<BR><BR>\r
-  #   TRUE  - Setup Browser supports GUID opcodes generated from Framework HII VFR file by VFR compiler.\r
-  #           the PeiCore will handle the framework FvHob and install FvInfo PPI for it.<BR>\r
-  #   FALSE - Setup Browser doesn't support GUID opcodes generated from Framework HII VFR file by VFR compiler.\r
-  #           the PeiCore will not handle the framework FvHob and install FvInfo PPI for it.<BR>\r
-  # @Prompt Enable framework backward compatibility support.\r
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkCompatibilitySupport|FALSE|BOOLEAN|0x00012009\r
-\r
   ## Indicates if HelloWorld Application will print the verbose information.\r
   #  This PCD is a sample to explain FeatureFlag PCD usage.<BR><BR>\r
   #   TRUE  - HelloWorld Application will print the verbose information.<BR>\r
   # @Prompt Serial port registers use MMIO.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdSerialUseMmio|FALSE|BOOLEAN|0x00020000\r
 \r
+  ## Indicates the access width for 16550 serial port registers.\r
+  # Default is 8-bit access mode.<BR><BR>\r
+  #    8  - 16550 serial port registers are accessed in 8-bit width.<BR>\r
+  #   32 - 16550 serial port registers are accessed in 32-bit width.<BR>\r
+  # @Prompt Serial port register access width.\r
+  gEfiMdeModulePkgTokenSpaceGuid.PcdSerialRegisterAccessWidth|8|UINT8|0x00020007\r
+\r
   ## Indicates if the 16550 serial port hardware flow control will be enabled. Default is FALSE.<BR><BR>\r
   #   TRUE  - 16550 serial port hardware flow control will be enabled.<BR>\r
   #   FALSE - 16550 serial port hardware flow control will be disabled.<BR>\r
   # @Prompt Maximum Number of PEI Reset Filters, Reset Notifications or Reset Handlers.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdMaximumPeiResetNotifies|0x10|UINT32|0x0000010A\r
 \r
+  ## Capsule On Disk is to deliver capsules via files on Mass Storage device.<BR><BR>\r
+  #  This PCD indicates if the Capsule On Disk is supported.<BR>\r
+  #   TRUE  - Capsule On Disk is supported.<BR>\r
+  #   FALSE - Capsule On Disk is not supported.<BR>\r
+  #  If platform does not use this feature, this PCD should be set to FALSE.<BR><BR>\r
+  #  Two sulotions to deliver Capsule On Disk:<BR>\r
+  #    a) If PcdCapsuleInRamSupport = TRUE, Load Capsule On Disk image out of TCB, and reuse\r
+  #       Capsule In Ram to deliver capsule.<BR>\r
+  #    b) If PcdCapsuleInRamSupport = FALSE, Relocate Capsule On Disk image to RootDir out\r
+  #       of TCB, and reuse FatPei to load capsules from external storage.<BR>\r
+  #  Note:<BR>\r
+  #    If Both Capsule In Ram and Capsule On Disk are provisioned at the same time, the Capsule\r
+  #  On Disk will be bypassed.\r
+  # @Prompt Enable Capsule On Disk support.\r
+  gEfiMdeModulePkgTokenSpaceGuid.PcdCapsuleOnDiskSupport|FALSE|BOOLEAN|0x0000002d\r
+\r
 [PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]\r
   ## This PCD defines the Console output row. The default value is 25 according to UEFI spec.\r
   #  This PCD could be set to 0 then console output would be at max column and max row.\r
   # @Prompt Reset on memory type information change.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdResetOnMemoryTypeInformationChange|TRUE|BOOLEAN|0x00010056\r
 \r
+  ## Indicates if the BDS supports Platform Recovery.<BR><BR>\r
+  #   TRUE  - BDS supports Platform Recovery.<BR>\r
+  #   FALSE - BDS does not support Platform Recovery.<BR>\r
+  # @Prompt Support Platform Recovery.\r
+  gEfiMdeModulePkgTokenSpaceGuid.PcdPlatformRecoverySupport|TRUE|BOOLEAN|0x00010078\r
+\r
   ## Specify the foreground color for Subtile text in HII Form Browser. The default value is EFI_BLUE.\r
   #  Only following values defined in UEFI specification are valid:<BR><BR>\r
   #  0x00 (EFI_BLACK)<BR>\r
   # @Prompt Recover file name in PEI phase\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdRecoveryFileName|L"FVMAIN.FV"|VOID*|0x30001045\r
 \r
+  ## This is Capsule Temp Relocation file name in PEI phase.\r
+  #  The file must be in the root directory.\r
+  #  The file name must be the 8.3 format.\r
+  #  The PCD data must be in UNICODE format.\r
+  #  CapsuleOnDiskLoadPei PEI module will set value of this PCD to PcdRecoveryFileName, then\r
+  #  leverage recovery to get Capsule On Disk Temp Relocation file.\r
+  #  Note: The file name must be shorter than PcdRecoveryFileName, otherwise CapsuleOnDiskLoadPei\r
+  #  PEI module will fail to get Capsule On Disk Temp Relocation file.\r
+  # @Prompt Capsule On Disk Temp Relocation file name in PEI phase\r
+  gEfiMdeModulePkgTokenSpaceGuid.PcdCoDRelocationFileName|L"Cod.tmp"|VOID*|0x30001048\r
+\r
   ## This PCD hold a list GUIDs for the ImageTypeId to indicate the\r
   #  FMP capsule is a system FMP.\r
   # @Prompt A list of system FMP ImageTypeId GUIDs\r
   # @Prompt The address mask when memory encryption is enabled.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdPteMemoryEncryptionAddressOrMask|0x0|UINT64|0x30001047\r
 \r
+  ## Capsule In Ram is to use memory to deliver the capsules that will be processed after system\r
+  #  reset.<BR><BR>\r
+  #  This PCD indicates if the Capsule In Ram is supported.<BR>\r
+  #   TRUE  - Capsule In Ram is supported.<BR>\r
+  #   FALSE - Capsule In Ram is not supported.\r
+  # @Prompt Enable Capsule In Ram support.\r
+  gEfiMdeModulePkgTokenSpaceGuid.PcdCapsuleInRamSupport|TRUE|BOOLEAN|0x0000002e\r
+\r
+  ## Full device path of plaform specific device to store Capsule On Disk temp relocation file.<BR>\r
+  #  If this PCD is set, Capsule On Disk temp relocation file will be stored in the device specified\r
+  #  by this PCD, instead of the EFI System Partition that stores capsule image file.\r
+  # @Prompt Capsule On Disk relocation device path.\r
+  gEfiMdeModulePkgTokenSpaceGuid.PcdCodRelocationDevPath|{0xFF}|VOID*|0x0000002f\r
+\r
 [PcdsPatchableInModule]\r
   ## Specify memory size with page number for PEI code when\r
   #  Loading Module at Fixed Address feature is enabled.\r