A.1 Design Discussion

Directive statements are permitted within the EDK INF files.

A.1.1 [defines] Section

The [defines] section of an EDK INF file is used to define variable assignments that can be used in later build steps. The EDK parsing utilities process local symbol assignments made in this section. Note that the sections are processed in the order listed here, and later assignments of these local symbols do not override previous assignments.

This section will typically use one of the following section definitions:

[define]
[defines]
[defines.IA32]
[defines.X64]
[defines.IPF]
[defines.EBC]

Note: The [define] section tag is only valid for EDK INF files. EDK II INF files must use the 'defines' keyword.

The format for entries in this section is:

Name = Value

The following is an example of this section.

[defines]
  BASE_NAME      = DiskIo
  FILE_GUID      = CA261A26-7718-4b9b-8A07-5178B1AE3A02
  COMPONENT_TYPE = BS_DRIVER

The following table lists the possible content of this section.

Table 6 EDK [defines] Section Elements

The following table lists the available COMPONENT_TYPE values supported by EDK INF files.

Table 7 EDK Component (module) Output File Extensions

A.1.2 [sources] Section

The [sources] section is used to specify the files that make up the component. Directories names are required for files existing in subdirectories of the component. All directory names are relative to the location of the INF file. Macros are allowed in the source file path. For EDK builds, each file is added to the macro of $(INC_DEPS), which can be used in a makefile dependency expression.

This section will typically use one of the following section definitions:

[sources]
[sources.common]
[sources.IA32]
[sources.X64]
[sources.IPF]
[sources.EBC]

The following example demonstrates entries in this section.

[sources.common]
  DxeIpl.dxs
  DxeIpl.h
  DxeLoad.c

[sources.Ia32]
  Ia32/VirtualMemory.h
  Ia32/VirtualMemory.c
  Ia32/DxeLoadFunc.c
  Ia32/ImageRead.c

[sources.X64]
  X64/DxeLoadFunc.c

[sources.IPF]
  Ipf/DxeLoadFunc.c
  Ipf/ImageRead.c

Binary file types - EDK does not have the flexibility of EDK II, but does provide a method for specifying binary files in the [sources] section. The following lists the mapping of EDK specific binary file types to EFI sections.

SEC_GUID

The binary file is an EFI_SECTION_FREEFORM_SUBTYPE_GUID section.

SEC_PE32

This binary is an EFI_SECTION_PE32 section.

SEC_PIC

This binary is an EFI_SECTION_PIC section.

SEC_PEI_DEPEX

This binary is an EFI_SECTION_PEI_DEPEX section.

SEC_DXE_DEPEX

This binary is an EFI_SECTION_DXE_DEPEX section.

SEC_TE

This binary is an EFI_SECTION_TE section.

SEC_VER

This binary is an EFI_SECTION_VERSION section.

SEC_UI

This binary is an EFI_SECTION_USER_INTERFACE section.

SEC_BIN

The binary is an EFI_SECTION_RAW section.

SEC_COMPAT16

This binary is an EFI_SECTION_COMPATIBILTY16 section.

A.1.3 [libraries] Section

The [libraries] section of the EDK INF is used to list the names of the libraries that will be linked into the EDK component. The library names do not include the directory locations or the extension name of the file. For each library, {LibName}, found, the {LibName} is added to the LIBS definition in the output makefile:

LIBS = $(LIBS) $(LIB_DIR)\{LibName}

This section will typically use one of the following section definitions:

[libraries.common]
[libraries.IA32]
[libraries.X64]
[libraries.IPF]
[libraries.EBC]

The formats for entries in this section is:

LibraryName

The following is an example of a libraries section.

[libraries.common]
  EfiProtocolLib
  EfiDriverLib

A.1.4 [includes] Section

The [includes] section of the EDK INF file is a list of directories to be included on the compile command line. These are included in a section of the Makefile generated by the parsing utilities. For each include path specified, the following line is written to the component's makefile.

INC = $(INC) -I $(SOURCE_DIR)\{path}

The path must be absolute, however the use of the global variable, EDK_SOURCE is recommended to construct the path.

This section will typically use one of the following section definitions:

[includes.common]
[includes.IA32]
[includes.X64]
[includes.IPF]
[includes.Nt32]
[include.common]
[include.IA32]
[include.X64]
[include.IPF]

The formats for entries in this section is:

$(EDK_SOURCE)/path/to/header/files

The following is an example of the [includes] section.

[includes.common]
  $(EDK_SOURCE)FoundationEfi
  $(EDK_SOURCE)Foundation
  $(EDK_SOURCE)FoundationFramework
  .
  $(EDK_SOURCE)FoundationInclude
  $(EDK_SOURCE)FoundationEfiInclude
  $(EDK_SOURCE)FoundationFrameworkInclude
  $(EDK_SOURCE)FoundationIncludeIndustryStandard
  $(EDK_SOURCE)FoundationCoreDxe
  $(EDK_SOURCE)FoundationLibraryDxeInclude

A.1.5 [nmake] Section

The optional EDK [nmake] section may also include a ".ProcessorName" to restrict processing based on the processor name. The section data is simply copied directly to the component makefile, before the build commands are emitted.

This section will typically use one of the following section definitions:

[nmake]
[nmake.common]
[nmake.IA32]
[nmake.X64]
[nmake.IPF]
[nmake.EBC]

The format for entries in this section is any valid Makefile syntax. Refer to make command reference for your tool chains.

The following is an example of the EDK [nmake] section.

[nmake.common]
  IMAGE_ENTRY_POINT = DiskIoDriverEntryPoint