EDK II Module Writer's Guide - Intel

More documents

Recommendations

Info

Each module (library instance, application and driver) has its own directory in whichto group its source files. A module may only depend on files under its directory or onpublic header files. A module is not permitted to depend on source files from anothermodule directory.Sample directories and sub-directories in a package follow:• Package.dec Package declaration file• Package.dsc Platform Package build description file• Include Public header fileso Protocol\ Public Protocol header fileso Ppi\ Public PPI header fileso Guid\ Public GUID header fileso IndustryStandard\ Public Industry Standard header fileso Library\ Public Library class header files• Library\ Libraries instanceso NameOneLib\ Library instance NameOne source files and INFo NameTwoLib\ Library instance NameTwo source files and INF• Application\ Uefi Applicationso NameOneApp\ Application NameOne source files and INFo NameTwoApp\ Application NameTwo source files and INF• NameOneDxe\ Dxe Driver NameOne source files and INF.• NameTwoPei\ Pei Driver NameTwo source files and INF.If no related source files exist in a package, the corresponding directory may not becreated. For example, if no application is provided in a package, the blank Applicationdirectory is not required.2.1.3 Package Declaration FileEach package has a single package declaration file (DEC) to define the package’spublic interfaces. The public interfaces are the package’s public header files, GUIDs,and PCDs.The DEC has Defines, Includes, LibraryClasses, Guids, Ppis, Protocols and Pcdssections.The [Defines] section defines the package name and package GUID.The [Includes] section must list the root directory of public header file directory.The [LibraryClasses] section contains every library class header file in thePackage\Include\Library directory.The [Guids] section specifies the Guid value for each Guid in thePackage\Include\Guid directory.8
5BAn EDK II PackageThe [Ppis] section specifies the Guid value for each PPI in the Package\Include\Ppidirectory.The [Protocols] section specifies the Guid for each Protocol in thePackage\Include\Protocol directory.The PCDs are declared in different PCD sections according to their type (FeatureFlag,FixedAtBuild, PatchableInModule, Dynamic, and DynamicEx). If a PCD supportsmultiple PCD types, it must be declared into all supported type sections. When a PCDis declared, its data type and default value must also be specified.The following is a sample DEC file, additional package public information can beadded.2.1.3.1 Example: Package.dec[Defines]DEC_SPECIFICATION = 0x00010005PACKAGE_NAME = PackageNamePACKAGE_GUID = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxPACKAGE_VERSION = 0.1[Includes]Include#Package Include directory[LibraryClasses]## Library class name is same to library header file nameOneClassLib|Include/Library/OneClassLib.h[Guids]#GuidCName = {xxxxxxxx,xxxx,xxxx,{xx,xx,xx,xx,xx,xx,xx,xx}},[Ppis]#PpiGuidCName = {xxxxxxxx,xxxx,xxxx,{xx,xx,xx,xx,xx,xx,xx,xx}},[Protocols]#ProtocolGuidCName = {xxxxxxxx,xxxx,xxxx,{xx,xx,xx,xx,xx,xx,xx,xx}},[PcdsFeatureFlag]#FeatureFlag PCD is BOOLEAN type, the value is TRUR or FALSE.#PcdTokenSpaceCGuidName.PcdName|TRUE|BOOLEAN|TokenNumber#PcdTokenSpaceCGuidName.PcdName|FALSE|BOOLEAN|TokenNumber[PcdsFixedAtBuild]#PcdTokenSpaceCGuidName.PcdName|DefaultValue|DataType|TokenNumber[PcdsPatchableInModule]#PcdTokenSpaceCGuidName.PcdName|DefaultValue|DataType|TokenNumber[PcdsDynamic]#PcdTokenSpaceCGuidName.PcdName|DefaultValue|DataType|TokenNumber[PcdsDynamicEx]#PcdTokenSpaceCGuidName.PcdName|DefaultValue|DataType|TokenNumberA detailed description of the DEC file format can be found the EDK II DEC FileSpecification.9
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 8 and 9: 1.1.1.3 What is a Platform?A platfo
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 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?