EDK II Module Writer's Guide - Intel

More documents

Recommendations

Info

[Defines]INF_VERSION= 0x00010005BASE_NAME= PeiServicesTablePointerLibFILE_GUID= XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXMODULE_TYPE= PEIMVERSION_STRING = 1.0LIBRARY_CLASS= PeiServicesTablePointerLib|PEIMPEI_CORE SECEDK_RELEASE_VERSION= 0x00020000CONSTRUCTOR= PeiServicesTablePointerLibConstructor## VALID_ARCHITECTURES = IA32 X64 IPF EBC (EBC is for build#only)#[Sources.common]PeiServicesTablePointer.c[Packages]MdePkg/MdePkg.dec[LibraryClasses]DebugLib3.2.3 Adding a Package DependencyThe [Packages] section of the INF file describes all packages dependencies of thismodule. The EDK II relative path of dependent package DEC file is described in INF’s[Packages] section as follows:[Packages]MdePkg/MdePkg.decIntelFrameworkPkg/IntelFrameworkPkg.decNote: The path is from the root of the $workspace. Not from the module directoryA Module should use the following rules for determining package dependency:• The MdePkg package is required for all modules• If using definitions from Intel framework specification, dependency on theIntelFrameworkPkg is required• Beyond the rules given above, more package dependencies are introduced byreferencing/using surface items, such as Protocol/Ppi/Guid/PCD/Library Classetc. For example, if a module uses definitions or interfaces from the libraryclass “HiiLib” that is defined in MdeModulePkg package, it would need to bedependent on the MdeModulePkg.3.2.4 Adding Source FilesAll module source code is described in the INF [sources] section, and is based onfollowing rules:Note: The UNIX-style path separator “/” should be used, not the Windows*-style “\”.20
• Different architecture sources are put in different source sections[Sources.common] # source in this section is suitable for all archCheckSum.c...[Sources.Ia32] # source in this section is suitable for IA32 archIa32/Wbinvd.c | MSFT...Ia32/WriteMm7.S | GCC...[Sources.X64]X64/Thunk16.asm...[Sources.IPF]Ipf/AsmCpuMisc.s...# source in this section is suitable for X64 arch# source in this section is suitable for IPF arch[Sources.EBC] # source in this section is suitable for EBC archSynchronization.c...• Tool Tags are used describe the sources for different tool chains.[Sources.Ia32]Ia32/Wbinvd.c | MSFT # source is built when MSFT tool is used...Ia32/WriteMm7.S | GCC # source is built when GCC tool is used..."$(CC)" -o ${dst} $(CC_FLAGS) $(INC) ${src}• All files should be put under the module’s main folder. Do not use “../”• All C include files should also be listed in the sources section.3.2.4.1 Supported Tool TagThe following tool tag name is supported by edk2:Table 3 EDK II supported file extensionsTool TagDescriptionMSFTINTELGCCMicrosoft Family Tool ChainINTEL Tool ChainGCC Tool Chain3.2.5 Add Library Class ReferencesThe library class abstracts some macro/structure definitions and function declarations.The library instance, which is the implementation of a given library class, can bedifferent for different platform or for different phases (SEC/PEI/DXE) in one platform.Therefore, a module will be dependent on a library class for platform or phase specificbehavior.The steps of using a library class in a module are:21
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 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 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

Create successful ePaper yourself

Delete template?

Save as template?