EDK II Module Writer's Guide - Intel

More documents

Recommendations

Info

INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL® PRODUCTS. NO LICENSE, EXPRESS ORIMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPTAS PROVIDED IN INTEL’S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, INTEL ASSUMES NO LIABILITYWHATSOEVER, AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF INTELPRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY,OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. Intel products are not intendedfor use in medical, life saving, or life sustaining applications.Intel may make changes to specifications and product descriptions at any time, without notice.Designers must not rely on the absence or characteristics of any features or instructions marked "reserved" or "undefined." Intelreserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities arising fromfuture changes to them.This Intel® specification may contain design defects or errors known as errata that may cause the product to deviate frompublished specifications. Current characterized errata are available on request.Contact your local Intel sales office or your distributor to obtain the latest specifications and before placing your product order.Intel, and the Intel logo are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States andother countries.*Other names and brands may be claimed as the property of others.Copyright © 2009, Intel Corporation. All rights reserved.ii
Contents1 The Basics of EDK II..........................................................................................11.1 Overview ..............................................................................................11.1.1 Module, Package and Platform.....................................................11.1.2 Module Customization ................................................................21.1.3 EDK II Development Lifecycle .....................................................21.1.4 Build Infrastructure ...................................................................41.2 Related References.................................................................................51.3 Terms...................................................................................................51.4 Target Audience .....................................................................................62 An EDK II Package ............................................................................................72.1 Introduction ..........................................................................................72.1.1 EDK II Packages .......................................................................72.1.2 The Package Directory ...............................................................72.1.3 Package Declaration File.............................................................82.1.4 Package DSC File ....................................................................102.2 Manage Package ..................................................................................112.2.1 Create Package .......................................................................112.2.2 Using a Package......................................................................122.2.3 Updating a Package .................................................................123 Module Development .......................................................................................153.1 What is an EDK II module? ....................................................................153.1.1 Module Type...........................................................................163.2 Creating a Module ................................................................................173.2.1 Location.................................................................................173.2.2 Sample: Module Meta File - INF.................................................183.2.3 Adding a Package Dependency ..................................................203.2.4 Adding Source Files .................................................................203.2.5 Add Library Class References ....................................................213.2.6 Adding PCD References ............................................................223.2.7 Referencing a Protocol, PPI, or GUID..........................................243.2.8 Adding a Dependency to a Module .............................................253.3 Additional Steps for Library Instances .....................................................253.3.1 Define Produced Library Class ...................................................253.3.2 Define a Library Constructor (Optional) ......................................253.3.3 Define a Library Destructor (Optional) ........................................263.4 Additional Steps for Driver.....................................................................263.4.1 Define a Driver Entry Point .......................................................263.5 EDK II Common Library Class ................................................................273.6 Module using HII..................................................................................283.6.1 Forms....................................................................................283.6.2 Using Unicode Strings ..............................................................313.7 Building the module..............................................................................333.7.1 Add the module INF in package DSC ..........................................333.7.2 Select Library Instances ...........................................................34iii
Page 1: EDK II Module Writer's GuideApril,
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 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?