EDK II Specifications - Wayne777Chiu/Chinese_Practice_about_TianoCore GitHub Wiki
(2019/03/08)
EDK II 規範
本頁包含透過 Gitbook公開發表的 EDK II 規範的發行版本。
- 最新的 EDK II 規範草稿版本能在此頁 EDK II 規範草稿版 找到。
- EDK II 規範的之前版本能於此頁 EDK II 規範存檔 找到。
為了基本的認知建立和了解如何使用 EDK II 規範裡的檔案 .DEC,.DSC 和 .INF 的範例，可參考 wiki 頁面 建置描述檔 。
EDK II 樣板規範 (Template Specification) 是一個使用來給一個新文件當成樣板的範例文件。關於如何協助 TianoCore 文件的完整內容，請看 這裡 的資訊
每種規範的描述詳列於下
| EDK II 規範 | 校訂版本 | 日期 | 下載 |
|---|---|---|---|
| 建置 | v1.28 | April 2018 | HTML , PDF , Mobi , ePub , Gitbook, Github |
| DEC | v1.27 | April 2018 | HTML , PDF , Mobi , ePub , Gitbook, Github |
| DSC | v1.28 | April 2018 | 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.27 | April 2018 | 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.92 | April 2018 | HTML , PDF , Mobi , ePub , Gitbook, Github |
| C 編碼標準 | v 2.2 | June 2017 | HTML , PDF , Mobi , ePub , Gitbook, Github |
建置
建置規範 -[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - 這文件描述 EDK II 建置架構。 規範被設計來支援新的建置需求給建置 EDK II 模組和 EDK 元件在 EDK II 建置基礎架構下和產生二元韌體映像檔和統一可延伸韌體介面 (UEFI) 應用程式。
DEC
宣告檔格式-[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - 該文件描述 EDK II 宣告檔 (DEC) 格式。 這格式被設計來支援建置套件和 EDK II 模組的布局，以及使用 EDK II 建置基礎架構下給建置平台和模組。 EDK II 宣告檔可能在遵循 UEFI 平台初始化發行套件規範下的發行版的安裝中被創建出來。他們也可以被手動創建。 EDK II 基礎架構支援產生 UEFI 2.5 和 PI 1.4 (Unified EFI, Inc.) 相容的二元映像檔。
DSC
平台組態描述檔格式 -[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - 該文件描述 EDK II 平台組態描述檔 (DSC) 格式。 EDK 建置工具 (Build Tools)被涵蓋成 EDK II 相容性套件的一部分。為了要使用 EDK II 模組或 EDK II 建置工具，一個 EDK II DSC 和 FDF 檔必須使用。 EDK II 使用 INI 風格文本基底的檔案去描述元件，平台和韌體冊 (Firmware Volumes)。 雖然相似 EDK DSC 檔，這 EDK II 建置格式是不同的，且新的套裝軟體已經被提供去處理 (process) 這些檔案。 EDK II 建置基礎結構支援實現 Unified EFI (UEFI) 2.5 和 平台基礎結構 (PI) 1.4 規範下的二元映像檔創建。
FDF
刷錄描述檔格式 - [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - 這文件描述 EDK II 刷錄描述檔格式。這格式被設計用來支援在 EDK 和 EDK II 建置基礎架構裡建置 EDK 和 EDK II 模組的新的建置需求。 EDK II 建置基礎架構支援產生目前 Unified EFI, Inc. (UEFI 2.5 和 PI 1.4) 相容的二元映像檔。這 FDF 檔被使用來描述二進制映像檔布局的內容。在檔案裡的二進制映像檔描述可能是任何組合- 開機映像檔，膠囊映像檔或 PCI 選擇 ROMs。
IDF
映像定義檔 (IDF) 格式規範 - [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - 這文件描述檔案格式給映像描述檔使用來創造 在統一延伸韌體介面規範，版本 2.1 裡被介紹的 HII 映像檔套件。
INF
資訊檔格式 - [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - 這個文件描述 EDK II 建置資訊 (INF) 檔案格式。這個格式支援在 EDK II 建置基礎架構下建置 EDK 元件和 EDK II 模組的新建置需求。 EDK II 建置基礎結構支援實現 Unified EFI (UEFI) 2.5 和 平台基礎結構 (PI) 1.4 規範下的二元映像檔創建。
Meta-Data
後設資料表達式語法規範 -[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - 這文件描述表達式陳述的語法給 EDK II 後設資料檔在資料欄位 (data field)，功能旗標表達式和狀態指示陳述句上。
PCD
EDK II 平台配置資料庫 (PCD) 規範 -[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - 這文件討論讓其變得更容易去編碼在可移植的矽模組上和更容易去移植 (port) 框架從平台到平台間的機制和組態條目。
UNI
單一碼格式檔案規範 - [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - 這文件描述多字串建置資訊 (UNI) 檔格式。詳細內容參見文件內校訂版本歷史。
VFR
虛擬表單呈現規範 -[ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - 為了簡化內部表單展現的設計，一個高階虛擬表單展現語言在這文件描述。使用這個語言語法，編譯器能被設計去抓取傳統文本檔案包含 VFR 當輸入，和輸出 IFR 給使用者的程式來使用。 有各式各樣的方法去定義 VFR 語言。
C 編碼標準
EDK II C 編碼標準規範 - [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] - EDK II C 編碼標準規範建立一個規矩叢，不是打算用來限制而是當成實行原理用來:
- 建立單一性風格。
- 設立最小資訊內容的需求。
- 允許所有程式設計師更容易理解原始碼。
- 藉著建立單一慣例加強支援任務。
- 利用源碼裡嵌入設計文件來簡化文件工作。
- 提供精準的源碼文件和單一風格減輕客戶和新進員工學習曲線。
這些規則適用所有的開發源碼。
- EDK II 樣板規範 [ HTML , PDF , Mobi , ePub , Gitbook, GitHub ] 這文件是一個樣板能被複製去開始(創造)一個新的 Tianocore Gitbook 文件。它也提供了可在 Tianocore 規範裡找到的一般性風格和格式的範例。
原文
EDK II Specifications
This page contains the released versions of the EDK II Specifications published using Gitbook.
- The latest draft versions of the EDK II Specification can be found on the EDK II Draft Specification page.
- The previous versions of the EDK II Specifications can be found on the EDK II Specifications Archived page.
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.28 | April 2018 | HTML , PDF , Mobi , ePub , Gitbook, Github |
| DEC | v1.27 | April 2018 | HTML , PDF , Mobi , ePub , Gitbook, Github |
| DSC | v1.28 | April 2018 | 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.27 | April 2018 | 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.92 | April 2018 | 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.