Add comments for FDF file.
authorlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 3 Jul 2007 09:10:26 +0000 (09:10 +0000)
committerlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 3 Jul 2007 09:10:26 +0000 (09:10 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@2996 6f19259b-4bc3-4df7-8a09-765794883524

Nt32Pkg/Nt32Pkg.fdf

index 1471c5b..5ec4278 100644 (file)
@@ -1,13 +1,40 @@
 # This is NT32 FDF file\r
-# $(BUILD_NUMBER) The number may be specified in the platform description (DSC) file¡¯s [Defines] section, BUILD_NUMBER element. \r
 \r
+################################################################################\r
+#\r
+# FD Section\r
+# The [FD] Section is made up of the definition statements and a \r
+# description of what goes into  the Flash Device Image.  Each FD section \r
+# defines one flash ¡°device¡± image.  A flash device image may be one of \r
+# the following: Removable media bootable image (like a boot floppy \r
+# image,) an Option ROM image (that would be ¡°flashed¡± into an add-in \r
+# card,) a System ¡°Flash¡±  image (that would be burned into a system¡¯s \r
+# flash) or an Update (¡°Capsule¡±) image that will be used to update and \r
+# existing system flash.\r
+#\r
+################################################################################\r
 [FD.Fv_Recovery]\r
-BaseAddress   = 0x0|PcdFdBaseAddress\r
-Size          = 0x002a0000\r
+BaseAddress   = 0x0|PcdFdBaseAddress  #The base address of the FLASH Device.\r
+Size          = 0x002a0000            #The size in bytes of the FLASH Device\r
 ErasePolarity = 1\r
 BlockSize     = 0x10000\r
 NumBlocks     = 0x2a\r
 \r
+################################################################################\r
+#\r
+# Following are lists of FD Region layout which correspond to the locations of different \r
+# images within the flash device. \r
+# \r
+# Regions must be defined in ascending order and may not overlap.\r
+#\r
+# A Layout Region start with a eight digit hex offset (leading ¡°0x¡± required) followed by \r
+# the pipe ¡°|¡± character, followed by the size of the region, also in hex with the leading \r
+# ¡°0x¡± characters. Like: \r
+# Offset|Size\r
+# PcdOffsetCName|PcdSizeCName\r
+# RegionType <FV, DATA, or FILE>\r
+#\r
+################################################################################\r
 0x00000000|0x00280000\r
 PcdFlashFvRecoveryBase|PcdFlashFvRecoverySize\r
 FV = FvRecovery\r
@@ -43,10 +70,18 @@ DATA = {
 0x00290000|0x00010000\r
 PcdFlashNvStorageFtwSpareBase|PcdFlashNvStorageFtwSpareBase\r
 \r
+################################################################################\r
+#\r
+# FV Section\r
+#\r
+# [FV] section is used to define what components or modules are placed within a flash\r
+# device file.  This section also defines order the components and modules are positioned\r
+# within the image.  The [FV] section consists of define statements, set statements and\r
+# module statements.\r
+#\r
+################################################################################\r
 [FV.FvRecovery]\r
-BlockSize     = 0x10000\r
-NumBlocks     = 0x28\r
-FvAlignment        = 16\r
+FvAlignment        = 16         #FV alignment and FV attributes setting.    \r
 ERASE_POLARITY     = 1\r
 MEMORY_MAPPED      = TRUE\r
 STICKY_WRITE       = TRUE\r
@@ -63,6 +98,17 @@ READ_STATUS        = TRUE
 READ_LOCK_CAP      = TRUE\r
 READ_LOCK_STATUS   = TRUE\r
 \r
+################################################################################\r
+#\r
+# The INF statements point to EDK component and EDK II module INF files, which will be placed into this FV image.\r
+# Parsing tools will scan the INF file to determine the type of component or module.\r
+# The component or module type is used to reference the standard rules \r
+# defined elsewhere in the FDF file.\r
+#\r
+# The format for INF statements is:\r
+# INF $(PathAndInfFileName)\r
+#\r
+################################################################################\r
 INF  $(WORKSPACE)/Nt32Pkg/BootModePei/BootMode.inf\r
 INF  $(WORKSPACE)/Nt32Pkg/WinNtThunkDxe/WinNtThunk.inf\r
 #INF  $(WORKSPACE)/Nt32Pkg/MiscSubClassPlatformDxe/MiscSubclassDriver.inf\r
@@ -77,7 +123,7 @@ INF  $(WORKSPACE)/Nt32Pkg/WinNtSerialIoDxe/WinNtSerialIo.inf
 INF  $(WORKSPACE)/Nt32Pkg/TimerDxe/Timer.inf\r
 INF  $(WORKSPACE)/Nt32Pkg/ResetRuntimeDxe/Reset.inf\r
 INF  $(WORKSPACE)/Nt32Pkg/RealTimeClockRuntimeDxe/RealTimeClock.inf\r
-INF  $(WORKSPACE)/Nt32Pkg/MonotonicCounterRuntimeDxe/Metronome.inf\r
+INF  $(WORKSPACE)/Nt32Pkg/MetronomeDxe/Metronome.inf\r
 INF  $(WORKSPACE)/Nt32Pkg/CpuRuntimeDxe/Cpu.inf\r
 INF  $(WORKSPACE)/Nt32Pkg/FvbServicesRuntimeDxe/Nt32Fwh.inf\r
 #INF  $(WORKSPACE)/Nt32Pkg/PlatformBdsDxe/PlatformBds.inf\r
@@ -94,7 +140,7 @@ INF  $(WORKSPACE)/MdeModulePkg/Universal/BaseMemoryTestPei/BaseMemoryTest.inf
 INF  $(WORKSPACE)/MdeModulePkg/Universal/FirmwareVolume/GuidedSectionExtraction/Crc32SectionExtract/Dxe/Crc32SectionExtract.inf\r
 INF  $(WORKSPACE)/MdeModulePkg/Universal/VariableRuntimeDxe/Variable.inf\r
 INF  $(WORKSPACE)/MdeModulePkg/Universal/RuntimeDxe/Runtime.inf\r
-INF  $(WORKSPACE)/MdeModulePkg/Bus/Pci/AtapiPassThru/Dxe/AtapiPassThru.inf\r
+INF  $(WORKSPACE)/MdeModulePkg/Bus/Pci/AtapiPassThruDxe/AtapiPassThru.inf\r
 INF  $(WORKSPACE)/MdeModulePkg/Universal/WatchDogTimerDxe/WatchDogTimer.inf\r
 INF  $(WORKSPACE)/MdeModulePkg/Universal/VariablePei/Variable.inf\r
 INF  $(WORKSPACE)/MdeModulePkg/Universal/VariableRuntimeDxe/Variable.inf\r
@@ -111,6 +157,15 @@ INF  $(WORKSPACE)/IntelFrameworkModulePkg/Universal/SetupBrowserDxe/SetupBrowser
 #INF  $(WORKSPACE)/IntelFrameworkModulePkg/Universal/DriverSampleDxe/DriverSample.inf\r
 INF  $(WORKSPACE)/MdeModulePkg/Bus/Scsi/ScsiBusDxe/ScsiBus.inf     ##This driver follows UEFI specification definition\r
 INF  $(WORKSPACE)/MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.inf    ##This driver follows UEFI specification definition\r
+\r
+################################################################################\r
+#\r
+# FILE statements are provided so that a platform integrator can include \r
+# complete EFI FFS files, as well as a method for constructing FFS files \r
+# using curly "{}" brace scoping. The following three FILEs are \r
+# for binary shell, binary fat and logo module.\r
+#\r
+################################################################################\r
 FILE APPLICATION = c57ad6b7-0515-40a8-9d21-551652854e37 CHECKSUM {\r
     SECTION COMPRESS PI_STD {\r
       SECTION GUIDED { \r
@@ -133,6 +188,15 @@ FILE FREEFORM = 7BB28B99-61BB-11D5-9A5D-0090273FC14D CHECKSUM {
     } \r
   } \r
 \r
+\r
+################################################################################\r
+#\r
+# Rules are use with the [FV] section¡¯s module INF type to define \r
+# how an FFS file is created for a given INF file. The following Rule are the default\r
+# rules for the different module type. User can add the customized rules to define the\r
+# content of the FFS file.\r
+#\r
+################################################################################\r
 [Rule.Common.PEI_CORE]\r
   FILE PEI_CORE = $(NAMED_GUID) CheckSum {\r
     PE32                $(INF_OUTPUT)/$(MODULE_NAME).efi\r