9d39cf
The microcode_ctl package contains microcode files (vendor-provided binary data
9d39cf
and/or code in proprietary format that affects behaviour of a device) for Intel
9d39cf
CPUs that may be loaded into the CPU during boot.
9d39cf
9d39cf
This directory contains information regarding various aspects of the provided
9d39cf
microcode files and their usage.
9d39cf
9d39cf
 * LICENSE.intel-ucode
9d39cf
   "license" file from the Intel x86 CPU microcode archive.
9d39cf
 * README
9d39cf
   This file.
9d39cf
 * README.caveats
9d39cf
   Caveats (mechanism for enabling/disabling usage of sets of microcode files
9d39cf
   based on caveat configuration and user preferences) documentation.
9d39cf
   Also contains general information about microcode update behaviour and links
9d39cf
   with additional information about the relevant microarchitectural
9d39cf
   vulnerabilities.
9d39cf
 * README.intel-ucode
9d39cf
   "README.md" file from the Intel x86 CPU microcode archive.
9d39cf
 * RELEASE_NOTES.intel-ucode
9d39cf
   "releasenote.md" file from the Intel x86 CPU microcode archive.
9d39cf
 * SECURITY.intel-ucode
9d39cf
   "security.md" file from the Intel x86 CPU microcode archive.
9d39cf
 * SUMMARY.intel-ucode
cc944f
   Information about supplied microcode files extracted from their headers,
cc944f
   in a table form.  Columns have the following meaning:
cc944f
    * "Path": path to the microcode file under one of the following directories:
cc944f
       * /usr/share/microcode_ctl/ucode_with_caveats/intel
cc944f
       * /usr/share/microcode_ctl/ucode_with_caveats
cc944f
       * /usr/share/microcode_ctl
cc944f
       * /lib/firmware
cc944f
       * /etc/firmware
cc944f
    * "Offset": offset of the microcode blob within the micocode file in bytes.
cc944f
    * "Ext. Offset": offset of the extended signature header within
cc944f
      the microcode file in bytes.
cc944f
    * "Data Size": size of microcode data in bytes.  0 means 2000 bytes.
cc944f
    * "Total Size": size of microcode blob in bytes, incuding headers.
cc944f
      0 means 2048 bytes.
cc944f
    * "CPUID": CPU ID signature (in format returned by the CPUID instruction).
cc944f
    * "Platform ID Mask": mask of suitable Platform IDs (provided in bits
cc944f
      52..50 of MSR 0x17).
cc944f
    * "Revision": microcode revision.
cc944f
    * "Date": microcode creation date.
cc944f
    * "Checksum": sum (in base 1<< 32) of all 32-bit values comprising
cc944f
      the microcode (from Offset up to Offset + Total Size).
cc944f
    * "Codenames": list of known CPU codenames associated with the CPUID
cc944f
      and Platform ID Mask combination.
cc944f
   Please refer to README.cavets, section "Microcode file structure"
cc944f
   for additional information regarding microcode header fields.
9d39cf
 * caveats
cc944f
   Directory that contains readme files for each specific caveat.