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/UnixGopDxe/UnixGop.inf
 222
 223 #INF  UnixPkg/UnixConsoleDxe/UnixConsole.inf
 224 INF  MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabaseDxe.inf
 225 INF  MdeModulePkg/Universal/SetupBrowserDxe/SetupBrowserDxe.inf
 226 INF  MdeModulePkg/Universal/PrintDxe/PrintDxe.inf
 227 INF  IntelFrameworkModulePkg/Universal/BdsDxe/BdsDxe.inf
 228 INF  UnixPkg/UnixSimpleFileSystemDxe/UnixSimpleFileSystem.inf
 229 INF  MdeModulePkg/Universal/DriverSampleDxe/DriverSampleDxe.inf
 230 INF  MdeModulePkg/Application/HelloWorld/HelloWorld.inf
 231
 232 #
 233 # Network stack drivers
 234 #
 235 INF  MdeModulePkg/Universal/Network/DpcDxe/DpcDxe.inf
 236 INF  MdeModulePkg/Universal/Network/ArpDxe/ArpDxe.inf
 237 INF  MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Dxe.inf
 238 INF  MdeModulePkg/Universal/Network/Ip4ConfigDxe/Ip4ConfigDxe.inf
 239 INF  MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Dxe.inf
 240 INF  MdeModulePkg/Universal/Network/MnpDxe/MnpDxe.inf
 241 INF  MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxe.inf
 242 INF  MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Dxe.inf
 243 INF  MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf
 244 INF  MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Dxe.inf
 245 INF  UnixPkg/UnixSnpDxe/UnixSnpDxe.inf
 246
 247 #
 248 # Build from source or use checked in binary
 249 #
 250 #INF FatPkg/EnhancedFatDxe/Fat.inf
 251 INF  RuleOverride = BINARY USE = IA32 FatBinPkg/EnhancedFatDxe/Fat.inf
 252
 253 # If  you build GccShellPkg you can source level debug shell
 254 #FILE APPLICATION = PCD(gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile) {
 255 #  SECTION PE32 =Build/GccShellPkg/DEBUG_XCODE32/IA32/ShellFull.efi
 256 #}
 257 INF  RuleOverride = BINARY USE = IA32 EdkShellBinPkg/FullShell/FullShell.inf
 258
 259
 260 FILE FREEFORM = PCD(gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLogoFile) {
 261   SECTION RAW = MdeModulePkg/Logo/Logo.bmp
 262 }
 263
 264
 265 ################################################################################
 266 #
 267 # Rules are use with the [FV] section's module INF type to define
 268 # how an FFS file is created for a given INF file. The following Rule are the default
 269 # rules for the different module type. User can add the customized rules to define the
 270 # content of the FFS file.
 271 #
 272 ################################################################################
 273
 274
 275 ############################################################################
 276 # Example of a DXE_DRIVER FFS file with a Checksum encapsulation section   #
 277 ############################################################################
 278 #
 279 #[Rule.Common.DXE_DRIVER]
 280 #  FILE DRIVER = $(NAMED_GUID) {
 281 #    DXE_DEPEX    DXE_DEPEX Optional      $(INF_OUTPUT)/$(MODULE_NAME).depex
 282 #    COMPRESS PI_STD {
 283 #      GUIDED {
 284 #        PE32     PE32                    $(INF_OUTPUT)/$(MODULE_NAME).efi
 285 #        UI       STRING="$(MODULE_NAME)" Optional
 286 #        VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
 287 #      }
 288 #    }
 289 #  }
 290 #
 291 ############################################################################
 292
 293 [Rule.Common.PEI_CORE]
 294   FILE PEI_CORE = $(NAMED_GUID) {
 295     PE32     PE32    Align=32       $(INF_OUTPUT)/$(MODULE_NAME).efi
 296     UI       STRING ="$(MODULE_NAME)" Optional
 297     VERSION  STRING ="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
 298   }
 299
 300 [Rule.Common.PEIM]
 301   FILE PEIM = $(NAMED_GUID) {
 302      PEI_DEPEX PEI_DEPEX Optional        $(INF_OUTPUT)/$(MODULE_NAME).depex
 303      PE32      PE32   Align=32       $(INF_OUTPUT)/$(MODULE_NAME).efi
 304      UI       STRING="$(MODULE_NAME)" Optional
 305      VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
 306   }
 307
 308 [Rule.Common.DXE_CORE]
 309   FILE DXE_CORE = $(NAMED_GUID) {
 310     COMPRESS PI_STD {
 311       PE32     PE32           $(INF_OUTPUT)/$(MODULE_NAME).efi
 312       UI       STRING="$(MODULE_NAME)" Optional
 313       VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
 314     }
 315   }
 316
 317 [Rule.Common.UEFI_DRIVER]
 318   FILE DRIVER = $(NAMED_GUID) {
 319     DXE_DEPEX    DXE_DEPEX Optional      $(INF_OUTPUT)/$(MODULE_NAME).depex
 320     COMPRESS PI_STD {
 321       GUIDED {
 322         PE32     PE32                    $(INF_OUTPUT)/$(MODULE_NAME).efi
 323         UI       STRING="$(MODULE_NAME)" Optional
 324         VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
 325       }
 326     }
 327   }
 328
 329 [Rule.Common.DXE_DRIVER]
 330   FILE DRIVER = $(NAMED_GUID) {
 331     DXE_DEPEX    DXE_DEPEX Optional      $(INF_OUTPUT)/$(MODULE_NAME).depex
 332     COMPRESS PI_STD {
 333       GUIDED {
 334         PE32     PE32                    $(INF_OUTPUT)/$(MODULE_NAME).efi
 335         UI       STRING="$(MODULE_NAME)" Optional
 336         VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
 337       }
 338     }
 339   }
 340
 341 [Rule.Common.DXE_RUNTIME_DRIVER]
 342   FILE DRIVER = $(NAMED_GUID) {
 343     DXE_DEPEX    DXE_DEPEX Optional      $(INF_OUTPUT)/$(MODULE_NAME).depex
 344     COMPRESS PI_STD {
 345       GUIDED {
 346         PE32     PE32                    $(INF_OUTPUT)/$(MODULE_NAME).efi
 347         UI       STRING="$(MODULE_NAME)" Optional
 348         VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
 349       }
 350     }
 351   }
 352
 353 [Rule.Common.UEFI_APPLICATION]
 354   FILE APPLICATION = $(NAMED_GUID) {
 355     COMPRESS PI_STD {
 356       GUIDED {
 357         PE32     PE32                    $(INF_OUTPUT)/$(MODULE_NAME).efi
 358         UI       STRING="$(MODULE_NAME)" Optional
 359         VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
 360       }
 361     }
 362   }
 363
 364
 365 [Rule.Common.UEFI_DRIVER.BINARY]
 366   FILE DRIVER = $(NAMED_GUID) {
 367     DXE_DEPEX DXE_DEPEX Optional      |.depex
 368     PE32      PE32                    |.efi
 369     UI        STRING="$(MODULE_NAME)" Optional
 370     VERSION   STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
 371   }
 372
 373 [Rule.Common.UEFI_APPLICATION.BINARY]
 374   FILE APPLICATION = $(NAMED_GUID) {
 375     PE32      PE32                    |.efi
 376     UI        STRING="$(MODULE_NAME)" Optional
 377     VERSION   STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
 378   }
 379