MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf

   1 ## @file
   2 #  Provides SMM variable service.
   3 #
   4 #  This module installs SMM variable protocol into SMM protocol database,
   5 #  which can be used by SMM driver, and installs SMM variable protocol
   6 #  into BS protocol database, which can be used to notify the SMM Runtime
   7 #  Dxe driver that the SMM variable service is ready.
   8 #  This module should be used with SMM Runtime DXE module together. The
   9 #  SMM Runtime DXE module would install variable arch protocol and variable
  10 #  write arch protocol based on SMM variable module.
  11 #
  12 #  Caution: This module requires additional review when modified.
  13 #  This driver will have external input - variable data and communicate buffer in SMM mode.
  14 #  This external input must be validated carefully to avoid security issues such as
  15 #  buffer overflow or integer overflow.
  16 #    The whole SMM authentication variable design relies on the integrity of flash part and SMM.
  17 #  which is assumed to be protected by platform.  All variable code and metadata in flash/SMM Memory
  18 #  may not be modified without authorization. If platform fails to protect these resources,
  19 #  the authentication service provided in this driver will be broken, and the behavior is undefined.
  20 #
  21 # Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.<BR>
  22 # SPDX-License-Identifier: BSD-2-Clause-Patent
  23 #
  24 ##
  25
  26 [Defines]
  27   INF_VERSION                    = 0x00010005
  28   BASE_NAME                      = VariableSmm
  29   MODULE_UNI_FILE                = VariableSmm.uni
  30   FILE_GUID                      = 23A089B3-EED5-4ac5-B2AB-43E3298C2343
  31   MODULE_TYPE                    = DXE_SMM_DRIVER
  32   VERSION_STRING                 = 1.0
  33   PI_SPECIFICATION_VERSION       = 0x0001000A
  34   ENTRY_POINT                    = VariableServiceInitialize
  35
  36 #
  37 # The following information is for reference only and not required by the build tools.
  38 #
  39 #  VALID_ARCHITECTURES           = IA32 X64
  40 #
  41
  42
  43 [Sources]
  44   Reclaim.c
  45   Variable.c
  46   VariableTraditionalMm.c
  47   VariableSmm.c
  48   VariableNonVolatile.c
  49   VariableNonVolatile.h
  50   VariableParsing.c
  51   VariableParsing.h
  52   VarCheck.c
  53   Variable.h
  54   PrivilegePolymorphic.h
  55   VariableExLib.c
  56   TcgMorLockSmm.c
  57   SpeculationBarrierSmm.c
  58
  59 [Packages]
  60   MdePkg/MdePkg.dec
  61   MdeModulePkg/MdeModulePkg.dec
  62
  63 [LibraryClasses]
  64   UefiDriverEntryPoint
  65   MemoryAllocationLib
  66   BaseLib
  67   SynchronizationLib
  68   UefiLib
  69   MmServicesTableLib
  70   BaseMemoryLib
  71   DebugLib
  72   DxeServicesTableLib
  73   HobLib
  74   PcdLib
  75   SmmMemLib
  76   AuthVariableLib
  77   VarCheckLib
  78   UefiBootServicesTableLib
  79
  80 [Protocols]
  81   gEfiSmmFirmwareVolumeBlockProtocolGuid        ## CONSUMES
  82   ## CONSUMES
  83   ## NOTIFY
  84   gEfiSmmFaultTolerantWriteProtocolGuid
  85   ## PRODUCES
  86   ## UNDEFINED # SmiHandlerRegister
  87   gEfiSmmVariableProtocolGuid
  88   gEfiMmEndOfDxeProtocolGuid                    ## NOTIFY
  89   gEdkiiSmmVarCheckProtocolGuid                 ## PRODUCES
  90   gEfiTcgProtocolGuid                           ## SOMETIMES_CONSUMES
  91   gEfiTcg2ProtocolGuid                          ## SOMETIMES_CONSUMES
  92
  93 [Guids]
  94   ## SOMETIMES_CONSUMES   ## GUID # Signature of Variable store header
  95   ## SOMETIMES_PRODUCES   ## GUID # Signature of Variable store header
  96   ## SOMETIMES_CONSUMES   ## HOB
  97   ## SOMETIMES_PRODUCES   ## SystemTable
  98   gEfiAuthenticatedVariableGuid
  99
 100   ## SOMETIMES_CONSUMES   ## GUID # Signature of Variable store header
 101   ## SOMETIMES_PRODUCES   ## GUID # Signature of Variable store header
 102   ## SOMETIMES_CONSUMES   ## HOB
 103   ## SOMETIMES_PRODUCES   ## SystemTable
 104   gEfiVariableGuid
 105
 106   ## SOMETIMES_CONSUMES   ## Variable:L"PlatformLang"
 107   ## SOMETIMES_PRODUCES   ## Variable:L"PlatformLang"
 108   ## SOMETIMES_CONSUMES   ## Variable:L"Lang"
 109   ## SOMETIMES_PRODUCES   ## Variable:L"Lang"
 110   gEfiGlobalVariableGuid
 111
 112   gEfiMemoryOverwriteControlDataGuid            ## SOMETIMES_CONSUMES   ## Variable:L"MemoryOverwriteRequestControl"
 113   gEfiMemoryOverwriteRequestControlLockGuid     ## SOMETIMES_PRODUCES   ## Variable:L"MemoryOverwriteRequestControlLock"
 114
 115   gSmmVariableWriteGuid                         ## PRODUCES             ## GUID # Install protocol
 116   gEfiSystemNvDataFvGuid                        ## CONSUMES             ## GUID
 117   gEdkiiFaultTolerantWriteGuid                  ## SOMETIMES_CONSUMES   ## HOB
 118
 119   ## SOMETIMES_CONSUMES   ## Variable:L"VarErrorFlag"
 120   ## SOMETIMES_PRODUCES   ## Variable:L"VarErrorFlag"
 121   gEdkiiVarErrorFlagGuid
 122
 123 [Pcd]
 124   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize       ## CONSUMES
 125   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase       ## SOMETIMES_CONSUMES
 126   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64     ## CONSUMES
 127   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                  ## CONSUMES
 128   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxAuthVariableSize              ## CONSUMES
 129   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVolatileVariableSize          ## CONSUMES
 130   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize     ## CONSUMES
 131   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize                ## CONSUMES
 132   gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize                 ## CONSUMES
 133   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize           ## CONSUMES
 134   gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpaceSize  ## CONSUMES
 135   gEfiMdeModulePkgTokenSpaceGuid.PcdReclaimVariableSpaceAtEndOfDxe   ## CONSUMES
 136   gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvModeEnable          ## SOMETIMES_CONSUMES
 137   gEfiMdeModulePkgTokenSpaceGuid.PcdEmuVariableNvStoreReserved       ## SOMETIMES_CONSUMES
 138
 139 [FeaturePcd]
 140   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics        ## CONSUMES  # statistic the information of variable.
 141   gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangDeprecate       ## CONSUMES  # Auto update PlatformLang/Lang
 142
 143 [Depex]
 144   TRUE
 145
 146 [UserExtensions.TianoCore."ExtraFiles"]
 147   VariableSmmExtra.uni