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 - 2016, Intel Corporation. All rights reserved.<BR>
  22 # This program and the accompanying materials
  23 # are licensed and made available under the terms and conditions of the BSD License
  24 # which accompanies this distribution. The full text of the license may be found at
  25 # http://opensource.org/licenses/bsd-license.php
  26 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  27 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  28 #
  29 ##
  30
  31 [Defines]
  32   INF_VERSION                    = 0x00010005
  33   BASE_NAME                      = VariableSmm
  34   MODULE_UNI_FILE                = VariableSmm.uni
  35   FILE_GUID                      = 23A089B3-EED5-4ac5-B2AB-43E3298C2343
  36   MODULE_TYPE                    = DXE_SMM_DRIVER
  37   VERSION_STRING                 = 1.0
  38   PI_SPECIFICATION_VERSION       = 0x0001000A
  39   ENTRY_POINT                    = VariableServiceInitialize
  40
  41 #
  42 # The following information is for reference only and not required by the build tools.
  43 #
  44 #  VALID_ARCHITECTURES           = IA32 X64
  45 #
  46
  47
  48 [Sources]
  49   Reclaim.c
  50   Variable.c
  51   VariableSmm.c
  52   VarCheck.c
  53   Variable.h
  54   VariableExLib.c
  55   TcgMorLockSmm.c
  56
  57 [Packages]
  58   MdePkg/MdePkg.dec
  59   MdeModulePkg/MdeModulePkg.dec
  60
  61 [LibraryClasses]
  62   UefiDriverEntryPoint
  63   MemoryAllocationLib
  64   BaseLib
  65   SynchronizationLib
  66   UefiLib
  67   SmmServicesTableLib
  68   BaseMemoryLib
  69   DebugLib
  70   DxeServicesTableLib
  71   HobLib
  72   PcdLib
  73   SmmMemLib
  74   AuthVariableLib
  75   VarCheckLib
  76
  77 [Protocols]
  78   gEfiSmmFirmwareVolumeBlockProtocolGuid        ## CONSUMES
  79   ## CONSUMES
  80   ## NOTIFY
  81   gEfiSmmFaultTolerantWriteProtocolGuid
  82   ## PRODUCES
  83   ## UNDEFINED # SmiHandlerRegister
  84   gEfiSmmVariableProtocolGuid
  85   gEfiSmmEndOfDxeProtocolGuid                   ## NOTIFY
  86   gEdkiiSmmVarCheckProtocolGuid                 ## PRODUCES
  87
  88 [Guids]
  89   ## SOMETIMES_CONSUMES   ## GUID # Signature of Variable store header
  90   ## SOMETIMES_PRODUCES   ## GUID # Signature of Variable store header
  91   ## SOMETIMES_CONSUMES   ## HOB
  92   ## SOMETIMES_PRODUCES   ## SystemTable
  93   gEfiAuthenticatedVariableGuid
  94
  95   ## SOMETIMES_CONSUMES   ## GUID # Signature of Variable store header
  96   ## SOMETIMES_PRODUCES   ## GUID # Signature of Variable store header
  97   ## SOMETIMES_CONSUMES   ## HOB
  98   ## SOMETIMES_PRODUCES   ## SystemTable
  99   gEfiVariableGuid
 100
 101   ## SOMETIMES_CONSUMES   ## Variable:L"PlatformLang"
 102   ## SOMETIMES_PRODUCES   ## Variable:L"PlatformLang"
 103   ## SOMETIMES_CONSUMES   ## Variable:L"Lang"
 104   ## SOMETIMES_PRODUCES   ## Variable:L"Lang"
 105   gEfiGlobalVariableGuid
 106
 107   gEfiMemoryOverwriteControlDataGuid            ## SOMETIMES_CONSUMES   ## Variable:L"MemoryOverwriteRequestControl"
 108   gEfiMemoryOverwriteRequestControlLockGuid     ## SOMETIMES_PRODUCES   ## Variable:L"MemoryOverwriteRequestControlLock"
 109
 110   gSmmVariableWriteGuid                         ## PRODUCES             ## GUID # Install protocol
 111   gEfiSystemNvDataFvGuid                        ## CONSUMES             ## GUID
 112   gEdkiiFaultTolerantWriteGuid                  ## SOMETIMES_CONSUMES   ## HOB
 113
 114   ## SOMETIMES_CONSUMES   ## Variable:L"VarErrorFlag"
 115   ## SOMETIMES_PRODUCES   ## Variable:L"VarErrorFlag"
 116   gEdkiiVarErrorFlagGuid
 117
 118 [Pcd]
 119   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize       ## CONSUMES
 120   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase       ## SOMETIMES_CONSUMES
 121   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64     ## CONSUMES
 122   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                  ## CONSUMES
 123   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxAuthVariableSize              ## CONSUMES
 124   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize     ## CONSUMES
 125   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize                ## CONSUMES
 126   gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize                 ## CONSUMES
 127   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize           ## CONSUMES
 128   gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpaceSize  ## CONSUMES
 129   gEfiMdeModulePkgTokenSpaceGuid.PcdReclaimVariableSpaceAtEndOfDxe   ## CONSUMES
 130
 131 [FeaturePcd]
 132   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics        ## CONSUMES  # statistic the information of variable.
 133   gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangDeprecate       ## CONSUMES  # Auto update PlatformLang/Lang
 134
 135 [Depex]
 136   TRUE
 137
 138 [UserExtensions.TianoCore."ExtraFiles"]
 139   VariableSmmExtra.uni