UnixPkg/UnixPkg.fdf

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