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