Flash Descriptor Size Report Generator Plugin and Command Line Tool

Copyright © Microsoft Corporation. All rights reserved. SPDX-License-Identifier: BSD-2-Clause-Patent

About

FdSizeReportGenerator is a UEFI Build Plugin and Command Line Tool used to parse EDK2 build reports and FDF files and then produce an HTML report of the module sizes and fd sizes. The HTML report then allows deeper analysis of the Flash Usage, the Module Sizes, and overall breakdown of usage.

UEFI Build Plugin

When used in the plugin capacity this plugin will do its work in the do_post_build function. This plugin uses the following variables from the build environment:

  1. BUILDREPORTING - [REQUIRED] - must be True otherwise plugin will not run
  2. FLASH_DEFINITION - [REQUIRED] - must point to the platform FDF file
  3. BUILDREPORT_FILE - [REQUIRED] - must point to the build report file
  4. FDSIZEREPORT_FILE - [OPTIONAL] - should be path for output HTML report. If not set default path will be set based on BUILD_OUTPUT_BASE variable
  5. PRODUCT_NAME - [OPTIONAL] - should give friendly product name
  6. BUILDID_STRING - [OPTIONAL] - should give friendly version string of firmware version

Command Line Tool

When used as a command line tool check the required parameters by using the -h option.