EDK II Module Writer's Guide - Intel

More documents

Recommendations

Info

PlatformFor example, Nt32Pkg group the definitions and modules required by Nt32platform. And a platform package also will provide a DSC and FDF file forplatform building.At the beginning of developing a module, the module developers need to consider thepurpose and release process for the module to select the appropriate package.Note: The packages in https://edk2.tianocore.org are basic core packages.Generally, a new module should not be created in them.3.2.1.2 Adding a Module DirectoryA module directory should be added to the proper package with the followingrecommendations:• Put a library module to “/Library” directory.• Put PROTOCOL/PPI/GUID/Library Class definitions in “/Include/Protocol” or “/Include/Ppi” or “/Include/Guid” or “/Include/Library” directoryrespectively.• Put a driver module in “” directory.• Put an application module in “/Application” directory• Use recommend directory name for module as follows:Table 2 Recommended name convention for module directoryRecommended directory name conventionXxxPeiXxxDxeXxxRuntimeDxeXxxxDxeSalXxxxLibModule TypePEIM, PEI_COREDXE_DRIVER, UEFI_DRIVERDXE_RUNTIME_DRIVERDXE_SAL_DRIVERLibrary Instance3.2.2 Sample: Module Meta File - INFEach module requires a module INF file in the root directory of the module.A module is INF file (sometimes referred to as the module meta-file) includes thefollowing items:• Module's basic information, such as name, GUID, module type, etc• The path to any packages the module is dependent on• Path to binary files or source files included in the module• Listing of all interfaces required by the module, i.e. Protocol, Ppi, Guid• List of all PCDs and Library classes required by the module18
• Others, such as dependency section depending on the module type3.2.2.1 Example: Application Module INF##[Defines]INF_VERSION= 0x00010005BASE_NAME= HelloWorldFILE_GUID= XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXMODULE_TYPE= UEFI_APPLICATIONVERSION_STRING = 1.0EDK_RELEASE_VERSION= 0x00020000EFI_SPECIFICATION_VERSION = 0x00020000ENTRY_POINT= UefiMain## The following information is for reference only and not required by the#build tools.## VALID_ARCHITECTURES = IA32 X64 IPF EBC###[Sources.common]HelloWorld.c##[Packages]MdePkg/MdePkg.dec##[LibraryClasses]UefiBootServicesTableLibUefiApplicationEntryPointUefiLibDebugLib3.2.2.2 Example: Library Module INFFollows is a sample INF file for PeiSevicesTablePointerLib.inf library instance:19
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 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

Create successful ePaper yourself

Delete template?

Save as template?