Files
documentation/source/tools/UcodeUtility.rst
sean-m-mcginn 39319deba6 Add documentation for firmware resiliency (#151)
* Add documentation for firmware resiliency

This change adds a section for firmware resiliency
as well as updates existing sections that are related
to firmware resiliency

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Fix grammatical errors in resiliency and recovery section

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Add in test tool tutorials for SBL resiliency

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Add in block diagrams for SBL resiliency

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Make minor improvements to resiliency and update sections

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Mention non-overlapping region requirement for FW update capsule tool

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Give example for building FW update capsule with TMAC:IPFW

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

* Add note that corruptcomp tool should be disabled in prod builds

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>

Signed-off-by: Sean McGinn <sean.mcginn@intel.com>
2023-01-13 13:40:04 -08:00

26 lines
891 B
ReStructuredText

.. _ucode-utility:
uCode Utility
-------------
``UcodeUtility.py`` generates a microcode binary for use with firmware updates.
Command Syntax::
usage: UcodeUtility.py [-h] -s SLOT_SIZE -i INPUT_FILE_NAMES [INPUT_FILE_NAMES ...] -o OUTPUT_FILE_NAME
optional arguments:
-h, --help show this help message and exit
-s SLOT_SIZE, --slot-size SLOT_SIZE
Specify the ucode slot size (in bytes).
-i INPUT_FILE_NAMES [INPUT_FILE_NAMES ...], --input_file_names INPUT_FILE_NAMES [INPUT_FILE_NAMES ...]
Specify the ucode file names (*.pdb files).
-o OUTPUT_FILE_NAME, --output_file_name OUTPUT_FILE_NAME
Specify an output file name.
It is expected that this microcode binary be integrated into a firmware update capsule (see :ref:`firmware-update`).