BaseTools/Source/Python/GenFds/Ffs.py

   1 ## @file
   2 # process FFS generation
   3 #
   4 #  Copyright (c) 2007, Intel Corporation
   5 #
   6 #  All rights reserved. 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 # Import Modules
  17 #
  18 from CommonDataClass.FdfClass import FDClassObject
  19
  20 ## generate FFS
  21 #
  22 #
  23 class Ffs(FDClassObject):
  24
  25     # mapping between MODULE type in FDF (from INF) and file type for GenFfs
  26     ModuleTypeToFileType = {
  27         'SEC'               : 'EFI_FV_FILETYPE_SECURITY_CORE',
  28         'PEI_CORE'          : 'EFI_FV_FILETYPE_PEI_CORE',
  29         'PEIM'              : 'EFI_FV_FILETYPE_PEIM',
  30         'DXE_CORE'          : 'EFI_FV_FILETYPE_DXE_CORE',
  31         'DXE_DRIVER'        : 'EFI_FV_FILETYPE_DRIVER',
  32         'DXE_SAL_DRIVER'    : 'EFI_FV_FILETYPE_DRIVER',
  33         'DXE_SMM_DRIVER'    : 'EFI_FV_FILETYPE_DRIVER',
  34         'DXE_RUNTIME_DRIVER': 'EFI_FV_FILETYPE_DRIVER',
  35         'UEFI_DRIVER'       : 'EFI_FV_FILETYPE_DRIVER',
  36         'UEFI_APPLICATION'  : 'EFI_FV_FILETYPE_APPLICATION',
  37         'SMM_DRIVER'        : 'EFI_FV_FILETYPE_SMM',
  38         'SMM_CORE'          : 'EFI_FV_FILETYPE_SMM_CORE'
  39     }
  40
  41     # mapping between FILE type in FDF and file type for GenFfs
  42     FdfFvFileTypeToFileType = {
  43         'SEC'               : 'EFI_FV_FILETYPE_SECURITY_CORE',
  44         'PEI_CORE'          : 'EFI_FV_FILETYPE_PEI_CORE',
  45         'PEIM'              : 'EFI_FV_FILETYPE_PEIM',
  46         'DXE_CORE'          : 'EFI_FV_FILETYPE_DXE_CORE',
  47         'FREEFORM'          : 'EFI_FV_FILETYPE_FREEFORM',
  48         'DRIVER'            : 'EFI_FV_FILETYPE_DRIVER',
  49         'APPLICATION'       : 'EFI_FV_FILETYPE_APPLICATION',
  50         'FV_IMAGE'          : 'EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE',
  51         'RAW'               : 'EFI_FV_FILETYPE_RAW',
  52         'PEI_DXE_COMBO'     : 'EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER',
  53         'SMM_DXE_COMBO'     : 'EFI_FV_FILETYPE_COMBINED_SMM_DXE',
  54         'SMM'               : 'EFI_FV_FILETYPE_SMM',
  55         'SMM_CORE'          : 'EFI_FV_FILETYPE_SMM_CORE'
  56     }
  57
  58     # mapping between section type in FDF and file suffix
  59     SectionSuffix = {
  60         'PE32'                 : '.pe32',
  61         'PIC'                  : '.pic',
  62         'TE'                   : '.te',
  63         'DXE_DEPEX'            : '.dpx',
  64         'VERSION'              : '.ver',
  65         'UI'                   : '.ui',
  66         'COMPAT16'             : '.com16',
  67         'RAW'                  : '.raw',
  68         'FREEFORM_SUBTYPE_GUID': '.guid',
  69         'FV_IMAGE'             : 'fv.sec',
  70         'COMPRESS'             : '.com',
  71         'GUIDED'               : '.guided',
  72         'PEI_DEPEX'            : '.dpx',
  73         'SMM_DEPEX'            : '.smm'
  74     }
  75
  76     ## The constructor
  77     #
  78     #   @param  self        The object pointer
  79     #
  80     def __init__(self):
  81         FfsClassObject.__init__(self)