UefiCpuPkg/MicrocodeUpdate: Add Microcode FMP build sample

[mirror_edk2.git] / UefiCpuPkg / Feature / Capsule / MicrocodeCapsulePdb / Readme.md

diff --git a/UefiCpuPkg/Feature/Capsule/MicrocodeCapsulePdb/Readme.md b/UefiCpuPkg/Feature/Capsule/MicrocodeCapsulePdb/Readme.md
new file mode 100644 (file)
index 0000000..9f81373
--- /dev/null
+++ b/UefiCpuPkg/Feature/Capsule/MicrocodeCapsulePdb/Readme.md
@@ -0,0 +1,20 @@
+# How to generate Microcode FMP from Microcode PDB file\r
+\r
+1) Copy directory `UefiCpuPkg/Feature/Capsule/MicrocodeUpdatePdb` to `<Your Platform Package>/MicrocodeUpdatePdb`.\r
+\r
+2) Uncomment and update `FILE DATA` statement in `<Your Platform Package>/MicrocodeUpdatePdb/MicrocodeCapsulePdb.fdf` with path to a Microcode PDB file.  The PDB file can placed in `<Your Platform Package>/MicrocodeUpdatePdb` or any other path.\r
+\r
+`FILE DATA = <your Microcode PDB file path>`\r
+\r
+Uncomment and update `PLATFORM_NAME`, `FLASH_DEFINITION`, `OUTPUT_DIRECTORY` section in `<Your Platform Package>/MicrocodeUpdatePdb/MicrocodeCapsulePdb.dsc` with <Your Platform Package>.\r
+\r
+    PLATFORM_NAME                  = <Your Platform Package>\r
+    FLASH_DEFINITION               = <Your Platform Package>/MicrocodeCapsulePdb/MicrocodeCapsulePdb.fdf\r
+    OUTPUT_DIRECTORY               = Build/<Your Platform Package>\r
+\r
+3) Use EDK II build tools to generate the Microcode FMP Capsule\r
+\r
+`build -p <Your Platform Package>/MicrocodeCapsulePdb/MicrocodeCapsulePdb.dsc`\r
+\r
+4) The Microcode FMP Capsule is generated at `$(WORKSPACE)/$(OUTPUT_DIRECTORY)/$(TARGET)_$(TOOL_CHAIN_TAG)/FV/MicrocodeCapsule.Cap`\r
+\r