EDK II Module Writer's Guide - Intel

1The Basics of EDK IIThis document is intended to be a guideline for new EDK II module developers, andprovides detailed instructions on how to develop and build a new module, as well ashow to release with a package. For information about developing new modules, thereaders should start with this document.1.1 OverviewBy referencing the EDK II User Manual, module writers should understand how toobtain EDK II and how to build existing modules.This chapter also clarifies new concepts introduced by EDK II.1.1.1 Module, Package and Platform1.1.1.1 What is a Module?A module is the smallest piece of separately compile-able code or pre-built binary. Itcontains a meta-data file (INF) plus source code or binary. The INF file is required bythe EDKII build system to describe a module’s behavior, such as produced orconsumed library classes, ppis, guids, protocols, pcds, and other information. For thesyntax of the INF file, refer to the EDK II Extended INF Specification.For example, in $WORKSPACE\MdeModulePkg\Universal\Bus\Pci\UhciDxe, the sourcefiles mentioned and the INF file compose a module.1.1.1.2 What is a Package?A Package is a group of zero or more modules. A package must contain a packagemeta-data file (DEC) and possibly a platform meta-data file (DSC).Functionally, a package is a logical division of a project. Developers depend onreasonable judgment, such as license or specification compliance, to determine whereto place a module. These meta-data files and the module’s INF files are used by theEDK II build system to automatically generate makefiles and a single module tip orwhole flash tip, according to the build options used.For information regarding the syntax of DSC and DEC files, please refer to EDK II DSCFile Specification and EDK II DEC File Specification.1