EDK II Specifications

Kevin Shaw edited this page Jun 11, 2018 · 5 revisions

EDK II Specifications

This page contains the released versions of the EDK II Specifications published using Gitbook.

For an understanding of the basic setup and to see examples of how to use the EDK II Specification files .DEC,.DSC and .INF, see the wiki page Build Description Files.

The EDK II Template Specification is an example document that may be used as a template for a new document. For complete details on how to contribute to TianoCore documents, please see the information here.

Descriptions for each specification is listed below.

EDK II Specification Revision Date Download
Build v1.27 May 2017 HTML , PDF , Mobi , ePub , Gitbook, Github
DEC v1.26 April 2017 HTML , PDF , Mobi , ePub , Gitbook, Github
DSC v1.27 June 2017 HTML , PDF , Mobi , ePub , Gitbook, Github
FDF v1.28 June 2017 HTML , PDF , Mobi , ePub , Gitbook, Github
IDF v1.0 April 2017 HTML , PDF , Mobi , ePub , Gitbook, Github
INF v1.26 May 2017 HTML , PDF , Mobi , ePub , Gitbook, Github
Meta-Data v1.20 April 2017 HTML , PDF , Mobi , ePub , Gitbook, Github
PCD v0.56 April 2017 HTML , PDF , Mobi , ePub , Gitbook, Github
UNI v1.4 May 2017 HTML , PDF , Mobi , ePub , Gitbook, Github
VFR v1.91 April 2017 HTML , PDF , Mobi , ePub , Gitbook, Github
C Coding Standards v 2.2 June 2017 HTML , PDF , Mobi , ePub , Gitbook, Github

Build

Build Specification -[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - This document describes the EDK II Build Architecture. This specification was designed to support new build requirements for building EDK II modules and EDK components within the EDK II build infrastructure as well as to generate binary firmware images and Unified Extensible Firmware Image (UEFI) applications.

DEC

Declaration file format-[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - This document describes the EDK II Declaration (DEC) file format. This format was designed to support building packaging and distribution of EDK II modules, as well as for building platforms and modules using the EDK II build infrastructure. EDK II declaration files may be created during installation of a distribution that follows the UEFI Platform Initialization Distribution Package Specification. They may also be created manually. The EDK II Build Infrastructure supports generation of UEFI 2.5 and PI 1.4 (Unified EFI, Inc.) compliant binary images.

DSC

Platform Description file format -[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] -This document describes the EDK II Platform Description file (DSC) format. The EDK Build Tools are included as part of the EDK II compatibility package. In order to use EDK II Modules or the EDK II Build Tools, an EDK II DSC and FDF file must be used. EDK II tools use INI style text based files to describe components, platforms and firmware volumes. While similar to EDK DSC files, the EDK II DSC file format is different, and new utilities have been provided to process these files. The EDK II Build Infrastructure supports creation of binary images that comply with Unified EFI (UEFI) 2.5 and UEFI Platform Infrastructure (PI) 1.4 specifications.

FDF

Flash Description file format - [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - This document describes the EDK II Flash Description (FDF) file format. This format was designed to support new build requirements of building EDK and EDK II modules within the EDK II build infrastructure. The EDK II Build Infrastructure supports generation of current Unified EFI, Inc. (UEFI 2.5 and PI 1.4) compliant binary images. The FDF file is used to describe the content and layout of binary images. Binary images described in this file may be any combination of boot images, capsule images or PCI Options ROMs.

IDF

Image Definition IDF File Format Specification - [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - This document describes file format for Image Description files that are used to create HII Image Packages introduced in the Unified Extensible Firmware Interface Specification, Version 2.1.

INF

information file format - [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - This document describes the EDK II build information (INF) file format. This format supports the new build requirements of build EDK components and EDK II modules within the EDK II build infrastructure. The EDK II Build Infrastructure supports creation of binary images that comply with Unified EFI (UEFI) 2.5 and UEFI Platform Infrastructure (PI) 1.4 specifications.

Meta-Data

Meta-Data Expression Syntax Specification -[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - This document describes the syntax of expression statements for EDK II Meta-data files used in data fields, feature flag expressions and conditional directive statements.

PCD

EDK II PCD Specification -[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - This document discusses the mechanisms and configuration entries required to make it easy to write portable silicon modules and to port the Framework from platform to platform.

UNI

Unicode Format File Specification - [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - This document describes the Multi-String build information (UNI) file format . See details in the Revision History in the document for more details.

VFR

Visual Form Representation Specification -[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - To simplify the creation of Internal Forms Representation (IFR), a high-level Visual Forms Representation (VFR) language is described in this document. Using this language syntax, a compiler can be designed to take an ordinary text file containing VFR as an input, and output IFR for use in a user’s program. There are various methods to define the VFR language.

C Coding Standards

EDK II C Coding Standards Specification - [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - The EDK II C Coding Standards Specification establishes a set of rules intended not as a constraint, but as an enabling philosophy which will:

  • Establish uniformity of style.
  • Set minimum information content requirements.
  • Allow all programmers to easily understand the code.
  • Facilitate support tasks by establishing uniform conventions.
  • Ease documentation efforts by embedding the design documentation in the code.
  • Reduce customer and new employee learning curves by providing accurate code documentation and uniform style.

These rules apply to all code developed.


  • EDK II Template Specification [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] This document is a template that can be copied to start a new Tianocore Gitbook document. It also provides examples for styles and formats commonly found in Tianocore specifications.
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.