EDK II Module Writer's Guide - Intel

More documents

Recommendations

Info

the DEC file for the package where the module is located. Then the DEC file willspecify the PCD type and default value.2.2.3.4.1 Example: Package.dec[PcdsFixedAtBuild]#Add new FixedAtBuild PCD#PcdTokenSpaceCGuidName.PcdName|DefaultValue|DataType|TokenNumbergEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldTimes|1|UINT32|0x400000052.2.3.5 Updating ModulesChanges to modules (Library instance, drivers and applications) cause the dependentheader file, library class and PCDs be modified, which requires the DSC file to beupdated. If a module INF file name is changed, the DSC files that refers to thismodule is updated to new file name. If a module is completely removed, it will not becompiled any more, and is removed from the package DSC. When a new module isadded to a package, it should be added to the package DSC to be compiled andverified.2.2.3.5.1 Example: Package.dsc[Components]#Module INF file path are specified from package directory.#PackageNamePkg/NameTwoPei/NameTwoDxe.inf #updated toMdeModulePkg/Application/HelloWorld/HelloWorld.inf14
3Module Development3.1 What is an EDK II module?An EDK II module consists of source files or binary files and a module definition file(INF file). An INF file describes a module’s basic information and interfaces such asconsumed/produced library class/PCD/Protocol/Ppi/Guid. (Please refer to the EDK IIExtended INF SpecificationA typical EDK II module is a firmware component which is built, put in an FFS file andthen put into a FV image. The component may be:• A driver or application which is built to *.efi binary file and put into FFS file asEFI_PE_SECTION:Firmware VolumeFirmware File 1EFI_PE_SECTIONsection contains .EFIbinaryFirmware File 2…………..Figure 2 Firmware Volume• Raw data binary. For example, $(WORKSPACE)\MdeModulePkg\Logo\Logo.infis a raw binary module which contains logo bitmap image.• An option ROM driver which is put into a device’s option ROM.• A standalone UEFI driver• A standalone UEFI application.• A library instance which is built to a library object file(.lib) and statically linkedto another module.Note: A module can be released in source code or in EFI binary format.15
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 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?