update the file header/function comments of DiskInfo/PciHotPlugRequest protocols...
[edk2.git] / UnixPkg / UnixPkg.fdf
blobbae66cdd4ab1a8cbe1e67fb0a9daf70aa5b93ceb
1 # This is Unix FDF file with UEFI HII features enabled\r
2 #\r
3 # Copyright (c) 2008, Intel Corporation\r
4 #\r
5 #  All rights reserved. This program and the accompanying materials\r
6 #    are licensed and made available under the terms and conditions of the BSD License\r
7 #    which accompanies this distribution. The full text of the license may be found at\r
8 #    http://opensource.org/licenses/bsd-license.php\r
9 #\r
10 #    THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 #    WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12 #\r
14 ################################################################################\r
15 #\r
16 # FD Section\r
17 # The [FD] Section is made up of the definition statements and a\r
18 # description of what goes into  the Flash Device Image.  Each FD section\r
19 # defines one flash "device" image.  A flash device image may be one of\r
20 # the following: Removable media bootable image (like a boot floppy\r
21 # image,) an Option ROM image (that would be "flashed" into an add-in\r
22 # card,) a System "Flash"  image (that would be burned into a system's\r
23 # flash) or an Update ("Capsule") image that will be used to update and\r
24 # existing system flash.\r
25 #\r
26 ################################################################################\r
27 [FD.Fv_Recovery]\r
28 BaseAddress   = 0x0|gEfiUnixPkgTokenSpaceGuid.PcdUnixFdBaseAddress  #The base address of the FLASH Device.\r
29 Size          = 0x002a0000                                           #The size in bytes of the FLASH Device\r
30 ErasePolarity = 1\r
31 BlockSize     = 0x10000\r
32 NumBlocks     = 0x2a\r
34 ################################################################################\r
35 #\r
36 # Following are lists of FD Region layout which correspond to the locations of different\r
37 # images within the flash device.\r
38 #\r
39 # Regions must be defined in ascending order and may not overlap.\r
40 #\r
41 # A Layout Region start with a eight digit hex offset (leading "0x" required) followed by\r
42 # the pipe "|" character, followed by the size of the region, also in hex with the leading\r
43 # "0x" characters. Like:\r
44 # Offset|Size\r
45 # PcdOffsetCName|PcdSizeCName\r
46 # RegionType <FV, DATA, or FILE>\r
47 #\r
48 ################################################################################\r
49 0x00000000|0x00280000\r
50 gEfiUnixPkgTokenSpaceGuid.PcdUnixFlashFvRecoveryBase|gEfiUnixPkgTokenSpaceGuid.PcdUnixFlashFvRecoverySize\r
51 FV = FvRecovery\r
53 0x00280000|0x0000c000\r
54 gEfiUnixPkgTokenSpaceGuid.PcdUnixFlashNvStorageVariableBase|gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize\r
55 #NV_VARIABLE_STORE\r
56 DATA = {\r
57   ## This is the EFI_FIRMWARE_VOLUME_HEADER\r
58   # ZeroVector []\r
59   0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\r
60   0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\r
61   # FileSystemGuid: gEfiSystemNvDataFvGuid         =\r
62   #  { 0xFFF12B8D, 0x7696, 0x4C8B, { 0xA9, 0x85, 0x27, 0x47, 0x07, 0x5B, 0x4F, 0x50 }}\r
63   0x8D, 0x2B, 0xF1, 0xFF, 0x96, 0x76, 0x8B, 0x4C,\r
64   0xA9, 0x85, 0x27, 0x47, 0x07, 0x5B, 0x4F, 0x50,\r
65   # FvLength: 0x20000\r
66   0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00,\r
67   # Signature "_FVH"       #Attributes\r
68   0x5f, 0x46, 0x56, 0x48, 0xff, 0xfe, 0x04, 0x00,\r
69   # HeaderLength #CheckSum #ExtHeaderOffset #Reserved #Revision\r
70   0x48, 0x00, 0x36, 0x09, 0x00, 0x00, 0x00, 0x02,\r
71   # Blockmap[0]: 2 Blocks * 0x10000 Bytes / Block\r
72   0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00,\r
73   # Blockmap[1]: End\r
74   0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\r
75   ## This is the VARIABLE_STORE_HEADER\r
76   #Signature: gEfiVariableGuid =\r
77   #  { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}\r
78   0x16, 0x36, 0xcf, 0xdd, 0x75, 0x32, 0x64, 0x41,\r
79   0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d,\r
80   #Size: 0xc000 (gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize) - 0x48 (size of EFI_FIRMWARE_VOLUME_HEADER) = 0xBFB8\r
81   # This can speed up the Variable Dispatch a bit.\r
82   0xB8, 0xBF, 0x00, 0x00,\r
83   #FORMATTED: 0x5A #HEALTHY: 0xFE #Reserved: UINT16 #Reserved1: UINT32\r
84   0x5A, 0xFE, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00\r
85 }\r
87 0x0028c000|0x00002000\r
88 #NV_EVENT_LOG\r
89 gEfiUnixPkgTokenSpaceGuid.PcdUnixFlashNvStorageEventLogBase|gEfiUnixPkgTokenSpaceGuid.PcdUnixFlashNvStorageEventLogSize\r
91 0x0028e000|0x00002000\r
92 gEfiUnixPkgTokenSpaceGuid.PcdUnixFlashNvStorageFtwWorkingBase|gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize\r
93 #NV_FTW_WORKING\r
94 DATA = {\r
95   # EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER->Signature = gEfiSystemNvDataFvGuid         =\r
96   #  { 0xFFF12B8D, 0x7696, 0x4C8B, { 0xA9, 0x85, 0x27, 0x47, 0x07, 0x5B, 0x4F, 0x50 }}\r
97   0x8D, 0x2B, 0xF1, 0xFF, 0x96, 0x76, 0x8B, 0x4C,\r
98   0xA9, 0x85, 0x27, 0x47, 0x07, 0x5B, 0x4F, 0x50,\r
99   # Crc:UINT32            #WorkingBlockValid:1, WorkingBlockInvalid:1, Reserved\r
100   0x77, 0x13, 0x9B, 0xD7, 0xFE, 0xFF, 0xFF, 0xFF,\r
101   # WriteQueueSize: UINT64\r
102   0xE0, 0x1F, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00\r
105 0x00290000|0x00010000\r
106 #NV_FTW_SPARE\r
107 gEfiUnixPkgTokenSpaceGuid.PcdUnixFlashNvStorageFtwSpareBase|gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize\r
109 ################################################################################\r
111 # FV Section\r
113 # [FV] section is used to define what components or modules are placed within a flash\r
114 # device file.  This section also defines order the components and modules are positioned\r
115 # within the image.  The [FV] section consists of define statements, set statements and\r
116 # module statements.\r
118 ################################################################################\r
119 [FV.FvRecovery]\r
120 FvAlignment        = 16         #FV alignment and FV attributes setting.\r
121 ERASE_POLARITY     = 1\r
122 MEMORY_MAPPED      = TRUE\r
123 STICKY_WRITE       = TRUE\r
124 LOCK_CAP           = TRUE\r
125 LOCK_STATUS        = TRUE\r
126 WRITE_DISABLED_CAP = TRUE\r
127 WRITE_ENABLED_CAP  = TRUE\r
128 WRITE_STATUS       = TRUE\r
129 WRITE_LOCK_CAP     = TRUE\r
130 WRITE_LOCK_STATUS  = TRUE\r
131 READ_DISABLED_CAP  = TRUE\r
132 READ_ENABLED_CAP   = TRUE\r
133 READ_STATUS        = TRUE\r
134 READ_LOCK_CAP      = TRUE\r
135 READ_LOCK_STATUS   = TRUE\r
137 ################################################################################\r
139 # The INF statements point to EDK component and EDK II module INF files, which will be placed into this FV image.\r
140 # Parsing tools will scan the INF file to determine the type of component or module.\r
141 # The component or module type is used to reference the standard rules\r
142 # defined elsewhere in the FDF file.\r
144 # The format for INF statements is:\r
145 # INF $(PathAndInfFileName)\r
147 ################################################################################\r
148 ##\r
149 #  PEI Phase modules\r
150 ##\r
151 ##\r
152 #  PEI Apriori file example, more PEIM module added later.\r
153 ##\r
154 APRIORI PEI {\r
155   INF  MdeModulePkg/Universal/PCD/Pei/Pcd.inf\r
156   INF  IntelFrameworkModulePkg/Universal/StatusCode/Pei/StatusCodePei.inf\r
157   }\r
158 APRIORI DXE {\r
159   INF  MdeModulePkg/Universal/PCD/Dxe/Pcd.inf\r
160   INF  IntelFrameworkModulePkg/Universal/StatusCode/RuntimeDxe/StatusCodeRuntimeDxe.inf\r
161   INF  UnixPkg/MetronomeDxe/Metronome.inf\r
162   }\r
163 INF  MdeModulePkg/Core/Pei/PeiMain.inf\r
164 INF  MdeModulePkg/Universal/PCD/Pei/Pcd.inf\r
165 INF  IntelFrameworkModulePkg/Universal/StatusCode/Pei/StatusCodePei.inf\r
166 INF  UnixPkg/BootModePei/BootModePei.inf\r
167 INF  UnixPkg/UnixFlashMapPei/FlashMap.inf\r
168 INF  UnixPkg/UnixAutoScanPei/UnixAutoScan.inf\r
169 INF  UnixPkg/UnixFirmwareVolumePei/UnixFwh.inf\r
170 INF  MdeModulePkg/Universal/Variable/Pei/VariablePei.inf\r
171 INF  UnixPkg/UnixThunkPpiToProtocolPei/UnixThunkPpiToProtocol.inf\r
172 INF  MdeModulePkg/Core/DxeIplPeim/DxeIpl.inf\r
174 ##\r
175 #  DXE Phase modules\r
176 ##\r
177 INF  MdeModulePkg/Core/Dxe/DxeMain.inf\r
178 INF  IntelFrameworkModulePkg/Universal/StatusCode/RuntimeDxe/StatusCodeRuntimeDxe.inf\r
179 INF  MdeModulePkg/Universal/PCD/Dxe/Pcd.inf\r
180 INF  UnixPkg/MetronomeDxe/Metronome.inf\r
181 INF  UnixPkg/RealTimeClockRuntimeDxe/RealTimeClock.inf\r
182 INF  UnixPkg/ResetRuntimeDxe/Reset.inf\r
183 INF  MdeModulePkg/Core/RuntimeDxe/RuntimeDxe.inf\r
184 INF  UnixPkg/FvbServicesRuntimeDxe/UnixFwh.inf\r
185 INF  MdeModulePkg/Universal/SecurityStubDxe/SecurityStubDxe.inf\r
186 INF  IntelFrameworkModulePkg/Universal/DataHubDxe/DataHubDxe.inf\r
187 INF  MdeModulePkg/Universal/EbcDxe/EbcDxe.inf\r
188 INF  MdeModulePkg/Universal/MemoryTest/NullMemoryTestDxe/NullMemoryTestDxe.inf\r
189 INF  UnixPkg/UnixThunkDxe/UnixThunk.inf\r
190 INF  UnixPkg/CpuRuntimeDxe/Cpu.inf\r
191 INF  MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf\r
192 INF  IntelFrameworkModulePkg/Universal/DataHubStdErrDxe/DataHubStdErrDxe.inf\r
193 INF  UnixPkg/MiscSubClassPlatformDxe/MiscSubClassDriver.inf\r
194 INF  UnixPkg/TimerDxe/Timer.inf\r
195 INF  MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf\r
196 INF  MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.inf\r
197 INF  MdeModulePkg/Universal/MonotonicCounterRuntimeDxe/MonotonicCounterRuntimeDxe.inf\r
198 INF  MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf\r
199 INF  MdeModulePkg/Universal/Console/ConPlatformDxe/ConPlatformDxe.inf\r
200 INF  MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterDxe.inf\r
201 INF  MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsoleDxe.inf\r
202 INF  MdeModulePkg/Universal/Console/TerminalDxe/TerminalDxe.inf\r
203 INF  MdeModulePkg/Universal/DevicePathDxe/DevicePathDxe.inf\r
204 INF  MdeModulePkg/Universal/Disk/DiskIoDxe/DiskIoDxe.inf\r
205 INF  MdeModulePkg/Universal/Disk/PartitionDxe/PartitionDxe.inf\r
206 INF  MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/EnglishDxe.inf\r
207 INF  IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciBusDxe.inf\r
208 INF  MdeModulePkg/Bus/Scsi/ScsiBusDxe/ScsiBusDxe.inf\r
209 INF  MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDiskDxe.inf\r
210 INF  IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBusDxe.inf\r
211 INF  UnixPkg/UnixBusDriverDxe/UnixBusDriver.inf\r
212  \r
213 INF  UnixPkg/UnixBlockIoDxe/UnixBlockIo.inf\r
214 INF  UnixPkg/UnixSerialIoDxe/UnixSerialIo.inf\r
215 INF  UnixPkg/UnixUgaDxe/UnixUga.inf\r
216 #INF  UnixPkg/UnixConsoleDxe/UnixConsole.inf\r
217 INF  MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabaseDxe.inf\r
218 INF  MdeModulePkg/Universal/SetupBrowserDxe/SetupBrowserDxe.inf\r
219 INF  MdeModulePkg/Universal/PrintDxe/PrintDxe.inf\r
220 INF  IntelFrameworkModulePkg/Universal/BdsDxe/BdsDxe.inf \r
221 INF  UnixPkg/UnixSimpleFileSystemDxe/UnixSimpleFileSystem.inf\r
222 INF  MdeModulePkg/Universal/DriverSampleDxe/DriverSampleDxe.inf\r
223 INF  MdeModulePkg/Application/HelloWorld/HelloWorld.inf\r
226 # Network stack drivers\r
227 # To test network drivers, need network Io driver(SnpNt32Io.dll), please refer to NETWORK-IO Subproject.\r
229 #INF  MdeModulePkg/Universal/Network/DpcDxe/DpcDxe.inf\r
230 #INF  MdeModulePkg/Universal/Network/ArpDxe/ArpDxe.inf\r
231 #INF  MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Dxe.inf\r
232 #INF  MdeModulePkg/Universal/Network/Ip4ConfigDxe/Ip4ConfigDxe.inf\r
233 #INF  MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Dxe.inf\r
234 #INF  MdeModulePkg/Universal/Network/MnpDxe/MnpDxe.inf\r
235 #INF  MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Dxe.inf\r
236 #INF  MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf\r
237 #INF  MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Dxe.inf\r
238 #INF  UnixPkg/SnpUnixDxe/SnpUnixDxe.inf\r
241    \r
242 ################################################################################\r
243 #  \r
244 # FILE statements are provided so that a platform integrator can include\r
245 # complete EFI FFS files, as well as a method for constructing FFS files\r
246 # using curly "{}" brace scoping. The following three FILEs are\r
247 # for binary shell, binary fat and logo module.\r
248 #  \r
249 ################################################################################\r
250 FILE APPLICATION = PCD(gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile) {\r
251     SECTION COMPRESS PI_STD {\r
252       SECTION GUIDED {\r
253         SECTION PE32 = EdkShellBinPkg/FullShell/Ia32/Shell_Full.efi\r
254       }\r
255     }\r
256   }\r
258 FILE DRIVER = 961578FE-B6B7-44c3-AF35-6BC705CD2B1F {\r
259     SECTION COMPRESS PI_STD {\r
260       SECTION GUIDED {\r
261         SECTION PE32 = FatBinPkg/EnhancedFatDxe/Ia32/Fat.efi\r
262       }\r
263     }\r
264   }\r
266 FILE FREEFORM = PCD(gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLogoFile) {\r
267     SECTION COMPRESS PI_STD {\r
268       SECTION GUIDED {\r
269         SECTION RAW = MdeModulePkg/Logo/Logo.bmp\r
270       }\r
271     }\r
272   }\r
273    \r
274    \r
275 ################################################################################\r
276 #  \r
277 # Rules are use with the [FV] section's module INF type to define\r
278 # how an FFS file is created for a given INF file. The following Rule are the default\r
279 # rules for the different module type. User can add the customized rules to define the\r
280 # content of the FFS file.\r
281 #  \r
282 ################################################################################\r
283    \r
284    \r
285 ############################################################################\r
286 # Example of a DXE_DRIVER FFS file with a Checksum encapsulation section   # \r
287 ############################################################################\r
288 #  \r
289 #[Rule.Common.DXE_DRIVER]\r
290 #  FILE DRIVER = $(NAMED_GUID) {\r
291 #    DXE_DEPEX    DXE_DEPEX Optional      |.depex\r
292 #    COMPRESS PI_STD {\r
293 #      GUIDED {\r
294 #        PE32     PE32                    |.efi\r
295 #        UI       STRING="$(MODULE_NAME)" Optional\r
296 #        VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)\r
297 #      }\r
298 #    }\r
299 #  }\r
301 ############################################################################\r
303 [Rule.Common.PEI_CORE]\r
304   FILE PEI_CORE = $(NAMED_GUID) {\r
305     PE32     PE32           |.efi\r
306     UI       STRING ="$(MODULE_NAME)" Optional         \r
307     VERSION  STRING ="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)    \r
308   }\r
310 [Rule.Common.PEIM]\r
311   FILE PEIM = $(NAMED_GUID) {\r
312      PEI_DEPEX PEI_DEPEX Optional        |.depex\r
313      PE32      PE32                      |.efi\r
314      UI       STRING="$(MODULE_NAME)" Optional         \r
315      VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)   \r
316   }\r
318 [Rule.Common.PEIM.TIANOCOMPRESSED]\r
319   FILE PEIM = $(NAMED_GUID) {\r
320     PEI_DEPEX PEI_DEPEX Optional         |.depex\r
321     GUIDED A31280AD-481E-41B6-95E8-127F4C984779 PROCESSING_REQUIRED = TRUE {\r
322       PE32      PE32                     |.efi\r
323       UI        STRING="$(MODULE_NAME)" Optional\r
324       VERSION   STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)\r
325     }\r
326   }\r
328 [Rule.Common.DXE_CORE]\r
329   FILE DXE_CORE = $(NAMED_GUID) {\r
330     COMPRESS PI_STD {\r
331       PE32     PE32           |.efi\r
332       UI       STRING="$(MODULE_NAME)" Optional\r
333       VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)\r
334     }\r
335   }\r
337 [Rule.Common.UEFI_DRIVER]\r
338   FILE DRIVER = $(NAMED_GUID) {\r
339     DXE_DEPEX    DXE_DEPEX Optional      |.depex\r
340     COMPRESS PI_STD {\r
341       GUIDED {\r
342         PE32     PE32                    |.efi\r
343         UI       STRING="$(MODULE_NAME)" Optional\r
344         VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)\r
345       }\r
346     }\r
347   }\r
349 [Rule.Common.DXE_DRIVER]\r
350   FILE DRIVER = $(NAMED_GUID) {\r
351     DXE_DEPEX    DXE_DEPEX Optional      |.depex\r
352     COMPRESS PI_STD {\r
353       GUIDED {\r
354         PE32     PE32                    |.efi\r
355         UI       STRING="$(MODULE_NAME)" Optional\r
356         VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)\r
357       }\r
358     }\r
359   }\r
361 [Rule.Common.DXE_RUNTIME_DRIVER]\r
362   FILE DRIVER = $(NAMED_GUID) {\r
363     DXE_DEPEX    DXE_DEPEX Optional      |.depex\r
364     COMPRESS PI_STD {\r
365       GUIDED {\r
366         PE32     PE32                    |.efi\r
367         UI       STRING="$(MODULE_NAME)" Optional\r
368         VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)\r
369       }\r
370     }\r
371   }\r
373 [Rule.Common.UEFI_APPLICATION]\r
374   FILE APPLICATION = $(NAMED_GUID) {\r
375     COMPRESS PI_STD {\r
376       GUIDED {\r
377         PE32     PE32                    |.efi\r
378         UI       STRING="$(MODULE_NAME)" Optional\r
379         VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)\r
380       }\r
381     }\r
382   }\r