EDK II Module Writer's Guide - Intel

More documents

Recommendations

Info

1.1.1.3 What is a Platform?A platform is a special type of package with additional meta data files. A packagemust contain one DSC file and zero or one FDF file. The FDF is only required if flashoutput is required.For information regarding FDF file, please refer to EDK II FDF File Specification.Readers interested in platform porting between EDK and EDK II should refer to theEDK II Platform Port Guide.1.1.2 Module CustomizationDeveloper should use the EDK II User Manual, to understand the design purpose ofthe Library class/Library instance and PCD mechanisms. These mechanisms provideways for developers to customize modules without changing the source code.1.1.2.1 Library class/Library instance1.1.2.2 PCDDevelopers can choose a proper library instance according to its requirement, such asfrom performance, image size, or the limitation of module type. In$WORKSPACE\MdePkg core package, there are many supported library classes andcorresponding library instances. Developers can browse the $WORKSPACE\MdePkg\include\library directory for basic information regarding the helper function APIprovided by these library classes.Developers can take advantage of the PCD mechanism to extract information fromoutside a module and control procedure behavior inside a module. The informationmay be known at compile time from platform DSC or package DEC files, but somemay arrive at flash image generation time, and some may be determined duringexecution.For example, in the following chapter, PcdDebugPropertyMask declared inMdePkg.dec file in $WORKSPACE\MdePkg is used to control DebugLib behavior. ThisPCD is FixedAtBuild type, which means its value is determined at build time. The EDKII build system converts this pcd to the value configured in DEC or DSC to enable ordisable the print ability.1.1.3 EDK II Development LifecycleThe lifecycle of EDK II development can be divided into five phases.1.1.3.1 Phase 1: Create a packageA package is the container of modules. A developer should first consider where themodule should be placed. As a generic rule, modules newly developed by an IHV/IBVshould not be placed into existing EDK II core packages, which include MdePkg,MdeModulePkg, IntelFrameworkPkg and IntelFrameworkModulePkg. One reason is2
4BThe Basics of EDK IIthat these packages are published as a base-supported package to facilitatemodule/platform development.Note: These packages are open-source code and compliant with the BSD license. Ifthe developed module doesn’t want to be open source, it should not be put intothose core packages.To create a new package, developers must create the DEC file to define the package’sinterfaces, including:• include directories for modules from other packages• the value of GUIDs• the value of Protocol GUIDs• the value of PPI GUIDs• the declaration of the PCD entries published by this package1.1.3.2 Phase 2: Create module meta-data/Implement basicfunctionality.After the module to be placed into a package is determined, developers must createan INF file to indicate the module’s behavior, including:• module type• required library classes• required ppi/protocol/guid/PCD• dependency relationship with other modules.Note: Dependency relationship may exist or not, depending on various module type.Viewing a module’s INF file provides a quick overview to an unfamiliar module.After finishing the INF file, developers should start writing source code to implementbasic functionality.Note: In $WORKSPACE\MdePkg\Include\Library directory, there are many libraryclasses to provide support functions. There are also entry point libraries forvarious module types. Developers should browse the header files for details.1.1.3.3 Phase 3: Create DSC to buildIn EDK II, the DSC file describes the build behavior of the package, including:• modules needed to be built• chosen library instances for various module type• the configuration of the PCD entries used by modulesThe single platform DSC and each referenced package’s DEC files cooperate to definea package. These files and the module INF files are required to build all modules inthe package.3
Page 1 and 2: EDK II Module Writer's GuideApril,
Page 3 and 4: Contents1 The Basics of EDK II.....
Page 6 and 7: Revision HistoryRevisionNumberDescr
Page 10 and 11: 1.1.3.4 Phase 4: Tune modulesTo tun
Page 12 and 13: EDK II ModuleA generic term to desc
Page 14 and 15: Each module (library instance, appl
Page 16 and 17: 2.1.4 Package DSC FileEach package
Page 18 and 19: According to the rules given immedi
Page 20 and 21: the DEC file for the package where
Page 22 and 23: 3.1.1 Module TypeEDK II defines man
Page 24 and 25: PlatformFor example, Nt32Pkg group
Page 26 and 27: [Defines]INF_VERSION= 0x00010005BAS
Page 28 and 29: 1. Add a dependency for the package
Page 30 and 31: DynamicPCD3.2.6.4 Accessing a PCD v
Page 32 and 33: [Defines]……CONSTRUCTOR= HobLibC
Page 34 and 35: PEI Services Table Pointer LibraryU
Page 36 and 37: key= FRONT_PAGE_KEY_CONTINUE;label
Page 38 and 39: =##langdef en-US "English"#langdef
Page 40 and 41: Example Package.dsc Components[Defi
Page 42 and 43: 3.7.2.2 Example Package.dsc Library
Page 44 and 45: When this type PCD is used in a mod
Page 46 and 47: 3.7.4.3.1 Example Module.inf[BuildO
Page 48 and 49: # Build all modules in PacakgeOne D
Page 50 and 51: 3.7.6.1 Example OptionRom INF[Defin
Page 52 and 53: For the DebugLib library class, Mde
Page 54 and 55: Its prototype is list below:EFI_STA
Page 56 and 57: 5UEFI DriversThe UEFI Specification
Page 58 and 59:
EFI_DRIVER_BINDING_PROTOCOL gAbcDri
Page 60:
Note: For UEFI drivers, the EDK II
Page 63 and 64:
4. Configure temporary RAM (not onl
Page 66 and 67:
7Pre-EFI Initialization ModulesThe
Page 68 and 69:
Template PPI//EFI_PEI_TEMPLATE_PPI
Page 70 and 71:
2. Invoke GetVariable() with size i
Page 72 and 73:
66PI also defines a generic rule to
Page 74 and 75:
EFI_STATUSEFIAPIWatchdogTimerDriver
Page 76 and 77:
Handle for new protocol instance. S
Page 78 and 79:
EFI_STATUSReadAndWriteVariable (IN
Page 80 and 81:
EFI_HOB_CPU *Hob;Hob = GetHobList (
Page 82 and 83:
8.7 Handler for EVT_SIGNAL_EXIT_BOO
Page 84 and 85:
Template code for notification func
Page 86 and 87:
SMM Initialization:The phase of SMM
Page 89 and 90:
Appendix ADynamic PCDThe dynamic ty
show all

EDK II Module Writer's Guide - Intel

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?