Add comments to describe PlatformDriOverrideDxe is used for test purpose.
[mirror_edk2.git] / MdeModulePkg / Universal / PlatformDriOverrideDxe / PlatformDriOverrideDxe.inf
1 ## @file
2 # This driver produces UEFI PLATFORM_DRIVER_OVERRIDE_PROTOCOL if this protocol doesn't exist.
3 # It doesn't install again if this protocol exists.
4 # It only implements one interface GetDriver of PLATFORM_DRIVER_OVERRIDE_PROTOCOL protocol
5 # and doesn't support other two interfaces GetDriverPath, DriverLoaded.
6 #
7 # This driver also offers an UI interface in device manager to let user configure
8 # platform override protocol to override the default algorithm for matching
9 # drivers to controllers.
10 #
11 # The main flow:
12 # 1. It dynamicly locate all controller device path.
13 # 2. It dynamicly locate all drivers which support binding protocol.
14 # 3. It export and dynamicly update two menu to let user select the
15 # mapping between drivers to controllers.
16 # 4. It save all the mapping info in NV variables for the following boot,
17 # which will be consumed by GetDriver API of the produced the platform override protocol.
18 #
19 # Caution: This module is a sample implementation for the test purpose.
20 #
21 # Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>
22 #
23 # This program and the accompanying materials
24 # are licensed and made available under the terms and conditions of the BSD License
25 # which accompanies this distribution. The full text of the license may be found at
26 # http://opensource.org/licenses/bsd-license.php
27 #
28 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
29 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
30 #
31 ##
32
33 [Defines]
34 INF_VERSION = 0x00010005
35 BASE_NAME = PlatDriOverrideDxe
36 FILE_GUID = 35034CE2-A6E5-4fb4-BABE-A0156E9B2549
37 MODULE_TYPE = DXE_DRIVER
38 VERSION_STRING = 1.0
39 ENTRY_POINT = PlatDriOverrideDxeInit
40 UNLOAD_IMAGE = PlatDriOverrideDxeUnload
41
42 #
43 # The following information is for reference only and not required by the build tools.
44 #
45 # VALID_ARCHITECTURES = IA32 X64 IPF EBC
46 #
47
48 [Sources]
49 VfrStrings.uni
50 Vfr.vfr
51 PlatDriOverrideDxe.c
52 PlatOverMngr.h
53 PlatDriOverrideLib.c
54 InternalPlatDriOverrideDxe.h
55
56 [Packages]
57 MdePkg/MdePkg.dec
58 MdeModulePkg/MdeModulePkg.dec
59
60 [LibraryClasses]
61 BaseLib
62 DebugLib
63 UefiLib
64 UefiDriverEntryPoint
65 UefiBootServicesTableLib
66 HiiLib
67 BaseMemoryLib
68 MemoryAllocationLib
69 DevicePathLib
70 DxeServicesTableLib
71 UefiRuntimeServicesTableLib
72 PrintLib
73
74 [Guids]
75 ## This GUID C Name is not required for build since it is from UefiLib and not directly used by this module source.
76 ## gEfiGlobalVariableGuid ## SOMETIMES_CONSUMED ## Variable:L"PlatformLang" this variable specifies the platform supported language string (RFC 4646 format)
77 ## gEfiGlobalVariableGuid ## SOMETIMES_CONSUMED ## Variable:L"Lang" this variable specifies the platform supported language string (ISO 639-2 format)
78 ##
79 # There could be more than one variables, from PlatDriOver, PlatDriOver1, PlatDriOver2,...
80 #
81 # gEfiCallerIdGuid ## Private ## Variable:L"PlatDriOver"
82 gEfiIfrTianoGuid ## CONSUMES ## Guid
83 gPlatformOverridesManagerGuid ## PRODUCES ## Guid
84
85 [Protocols]
86 gEfiComponentName2ProtocolGuid ## SOMETIMES_CONSUMED (Get Driver Name if ComponentName2Protocol exists)
87 gEfiComponentNameProtocolGuid ## SOMETIMES_CONSUMED (Get Driver Name if ComponentNameProtocol exists and ComponentName2Protocol doesn't exist)
88 gEfiFirmwareVolume2ProtocolGuid ## SOMETIMES_CONSUMED (Get Driver Name from EFI UI section if ComponentName2Protocol and ComponentNameProtocol don't exist)
89 gEfiPciIoProtocolGuid ## SOMETIMES_CONSUMED (Find the PCI device if PciIo protocol is installed)
90 gEfiBusSpecificDriverOverrideProtocolGuid ## SOMETIMES_CONSUMED (Check whether the PCI device contains one or more efi drivers in its option rom by this protocol)
91
92 gEfiDriverBindingProtocolGuid ## SOMETIMES_CONSUMED
93 gEfiLoadedImageProtocolGuid ## SOMETIMES_CONSUMED
94 gEfiLoadedImageDevicePathProtocolGuid ## SOMETIMES_CONSUMED (Show the drivers in the second page that support DriverBindingProtocol, LoadedImageProtocol and LoadedImageDevicePathProtocol)
95 gEfiDevicePathProtocolGuid ## SOMETIMES_CONSUMED (Show the controller device in the first page that support DevicePathProtocol)
96
97 gEfiFormBrowser2ProtocolGuid ## CONSUMED
98 gEfiHiiConfigRoutingProtocolGuid ## CONSUMED
99 gEfiHiiConfigAccessProtocolGuid ## PRODUCED
100 gEfiPlatformDriverOverrideProtocolGuid ## PRODUCED
101
102 [Depex]
103 gEfiFormBrowser2ProtocolGuid AND gEfiHiiConfigRoutingProtocolGuid