EDK II Module Writer's Guide - Intel

More documents

Recommendations

Info

1.1.3.4 Phase 4: Tune modulesTo tune modules• use EDK II libraries for code reuse• use EDK II PCD mechanism for configurationThe distinction between an EDK module and an EDK II module is that the EDK IImodule can be customized either statically or dynamically, as necessary. The staticcustomization is preferred to choose the library instance or determine the value ofFeatureFlag/Fixed type of PCD in build time. Dynamic customization is preferred forusing Patchable/Dynamic type PCD to control procedure behavior on the fly.EDK II module developers should consider what logic in the module could begeneralized as early in the development of the module as possible. For example, ifsome functionality had been implemented in a library class of a core package, thedeveloper should replace it by using the library class.If a segment of logic can be extracted as common logic and shared by variousmodules, the developer can create a new library class and instance.Note: In the EDK II module development, developers are strongly discouraged fromusing a conditional macro to control procedure behavior. The PCD mechanismprovides a unified interface, and developers should use it to configure a module’sbehavior.1.1.4 Build InfrastructureThe EDK II build system is based on Python and portable C code to provide crossplatformbuild ability. From Figure 1, developer can see some of the conceptualworkflow of the EDK II build system infrastructure.Figure 1 Conceptual workflow4
4BThe Basics of EDK IIIn brief, the EDK II build tool parses the meta-data files (DSC, DECs, INFs) togenerate corresponding one top-level makefile and a separate set of makefile andautogen.c/autogen.h files for every module.In the autogen files, the EDK II build tool generates all definitions of guids, protocols,ppis, and PCDs used by the module and automatically invokes all of the constructorsof used library instances in the module’s entry point implementations.1.2 Related ReferencesThe following publications and sources of information may be useful to you or arereferred to by this document:• Unified Extensible Firmware Interface Specification Version 2.1, Unified EFI,Inc, 2007, http://www.uefi.org.• Extensible Firmware Interface Specification Version 1.10, Intel, 2001,http://developer.intel.com/technology/efi.• Intel® Platform Innovation Framework for EFI Specifications, Intel, 2006,http://www.intel.com/technology/framework/.The following publications are available at edk2.tianocore.org:• EDK II MDE (Module Development Environment) Library Specification, Version0.50, Intel, 2006.• EDK II DSC File Specification, Version 0.50, Intel, 2007.• EDK II DEC File Specification, Version 0.50, Intel, 2007.• EDK II Extended INF Specification, Version 0.50, Intel, 2007.• EDK II FDF (Flash Description File) File Specification, Version 0.50, Intel,2007.• EDK II Build Specification, Version 1.00, Intel, 2008.1.3 TermsThe following terms are used throughout this document to describe varying aspects ofinput localization:EDKEDK IIEFI Developer’s kit; the open source project of the Intel PlatformInnovation Framework for EFI that can be found athttp://edk.tianocore.org.A generic term to describe the open source project found athttp://edk2.tianocore.org. In this document, it refers to the new release ofEDK II which supports a build infrastructure that makes use of theExtended INF, DEC and Extended DSC.5
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 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?