[mirror_edk2.git] / MdeModulePkg / Universal / Variable / RuntimeDxe / VariableSmm.inf

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