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