EDK II Module Writer's Guide - Intel

More documents

Recommendations

Info

2.1.4 Package DSC FileEach package usually creates another build description file (DSC). All modules can beadded into DSC to be compiled and verified. DSC has Defines, a LibraryClass, PCD,,and Components sections.The [Defines] section sets build related information, such as the build outputdirectory, build target, Guid, and build ARCHs.The [Components] lists all modules (Drivers, Application, and Library Instances) in theplatform.The [LibraryClasses] section specifies the chosen library instance for every libraryclass, which is consumed by the drivers and applications in the [Components] section.The [PCDs] section configures PCD type and value for those PCDs used by themodules in the [Components] section. If the PCD value is same as the default value inDEC, and the PCD type has no specific requirement, the PCD may not be configured inthe DSC. Its value and type will be the default setting in DEC. If all PCDs are notrequired in the DSC file, the [PCDs] section may be not created.Note: Only the DSC file fort the active platform is used in a build.The following is a sample DSC file. More modules can be added.10
5BAn EDK II Package2.1.4.1 Example: Package.dsc[Defines]PLATFORM_NAME= PacakgeNamePLATFORM_GUID= xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxPLATFORM_VERSION = 0.1DSC_SPECIFICATION = 0x00010005OUTPUT_DIRECTORY = Build/PackageNameSUPPORTED_ARCHITECTURES = IA32|IPF|X64|EBCBUILD_TARGETS= DEBUG|RELEASESKUID_IDENTIFIER = DEFAULT[SkuIds]0|DEFAULT #The entry: 0|DEFAULT is reserved and required.[LibraryClasses]## More library instances need to be added if more library classes areused## by the components in the following [Components] section.## library class name | library instance INF file path from packageDebugLib | MdePkg/Library/UefiDebugLibStdErr/UefiDebugLibStdErr.infBaseLib | MdePkg/Library/BaseLib/BaseLib.infBaseMemoryLib | MdePkg/Library/BaseMemoryLib/BaseMemoryLib.inf……##PCDs sections are not specified.##All PCDs value are from their Default value in DEC.##[PcdsFeatureFlag]##[PcdsFixedAtBuild][Components]## All libraries, drivers and applications are added here to be compiled## Module INF file path are specified from package directory.PackageNamePkg/Library/NameOneLib/NameOneLib.infPackageNamePkg/NameOneDxe/NameOneDxe.infPackageNamePkg/NameTwoPei/NameTwoPei.infA detailed description of the DSC file form is given in the DSC Specification.2.2 Manage Package2.2.1 Create PackageWhen current packages don’t satisfy a requirement or the original code base is splitinto EDK II packages, new packages need to be created. Here are the recommendedrules to follow when defining the new package:• All modules related to the same functionality should go in the same package.For example, different packages should be created for different chipsets.• Generic modules shared between different platforms should be in anotherpackage. For example,the MdePkg and MdeModulePkg are shared.• Modules should go in packages according to their release requirements.I Ifmodules are released only to specific customers, they should go in specificpackages.Note: There is no limitation for source files in a new package. Even if only one file isin a package, this package will be valid.11
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 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?