EmulatorPkg/Unix/UnixX64.fdf

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