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 - 2015, 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
  56 [Packages]
  57   MdePkg/MdePkg.dec
  58   MdeModulePkg/MdeModulePkg.dec
  59
  60 [LibraryClasses]
  61   UefiDriverEntryPoint
  62   MemoryAllocationLib
  63   BaseLib
  64   SynchronizationLib
  65   UefiLib
  66   SmmServicesTableLib
  67   BaseMemoryLib
  68   DebugLib
  69   DxeServicesTableLib
  70   HobLib
  71   PcdLib
  72   SmmMemLib
  73   AuthVariableLib
  74   VarCheckLib
  75
  76 [Protocols]
  77   gEfiSmmFirmwareVolumeBlockProtocolGuid        ## CONSUMES
  78   ## CONSUMES
  79   ## NOTIFY
  80   gEfiSmmFaultTolerantWriteProtocolGuid
  81   ## PRODUCES
  82   ## UNDEFINED # SmiHandlerRegister
  83   gEfiSmmVariableProtocolGuid
  84   gEfiSmmEndOfDxeProtocolGuid                   ## NOTIFY
  85   gEdkiiSmmVarCheckProtocolGuid                 ## PRODUCES
  86
  87 [Guids]
  88   ## PRODUCES             ## GUID # Signature of Variable store header
  89   ## CONSUMES             ## GUID # Signature of Variable store header
  90   ## SOMETIMES_CONSUMES   ## HOB
  91   ## SOMETIMES_PRODUCES   ## SystemTable
  92   gEfiAuthenticatedVariableGuid
  93
  94   ## PRODUCES             ## GUID # Signature of Variable store header
  95   ## CONSUMES             ## GUID # Signature of Variable store header
  96   ## SOMETIMES_CONSUMES   ## HOB
  97   ## SOMETIMES_PRODUCES   ## SystemTable
  98   gEfiVariableGuid
  99
 100   ## SOMETIMES_CONSUMES   ## Variable:L"PlatformLang"
 101   ## SOMETIMES_PRODUCES   ## Variable:L"PlatformLang"
 102   ## SOMETIMES_CONSUMES   ## Variable:L"Lang"
 103   ## SOMETIMES_PRODUCES   ## Variable:L"Lang"
 104   gEfiGlobalVariableGuid
 105
 106   gSmmVariableWriteGuid                         ## PRODUCES             ## GUID # Install protocol
 107   gEfiSystemNvDataFvGuid                        ## CONSUMES             ## GUID
 108   gEdkiiFaultTolerantWriteGuid                  ## SOMETIMES_CONSUMES   ## HOB
 109   gEdkiiVarErrorFlagGuid                        ## CONSUMES             ## GUID
 110   gZeroGuid                                     ## SOMETIMES_CONSUMES   ## GUID
 111
 112 [Pcd]
 113   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize       ## CONSUMES
 114   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase       ## SOMETIMES_CONSUMES
 115   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64     ## CONSUMES
 116   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                  ## CONSUMES
 117   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxAuthVariableSize              ## CONSUMES
 118   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize     ## CONSUMES
 119   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize                ## CONSUMES
 120   gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize                 ## CONSUMES
 121   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize           ## CONSUMES
 122   gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpaceSize  ## CONSUMES
 123   gEfiMdeModulePkgTokenSpaceGuid.PcdReclaimVariableSpaceAtEndOfDxe   ## CONSUMES
 124
 125 [FeaturePcd]
 126   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics        ## CONSUMES  # statistic the information of variable.
 127   gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangDeprecate       ## CONSUMES  # Auto update PlatformLang/Lang
 128
 129 [Depex]
 130   TRUE
 131
 132 [UserExtensions.TianoCore."ExtraFiles"]
 133   VariableSmmExtra.uni