From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.19]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 62EDC222584 for ; Tue, 7 Apr 2026 01:44:33 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.175.65.19 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1775526275; cv=none; b=EqW/76gNThHchB4yXcFxCzoG2eUpxqWKxUvvS75UN2zZvSqQuuKTpQpl0LNnRvCNQjDdzS1fesv5dZaHX2fMWxHfMgEBFW1NfONLii4unLOPWMB4QegnsEA1v0xALhjU/prldz9LiQhJKBfclo8zpfyaU4hbKt7EMj02v3K0/4g= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1775526275; c=relaxed/simple; bh=QrPgv/AokZF5J+3s8qtVs4SSlSWLcKcGrB6+Z7ngd7c=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Is1tUotbW40Aq19JvJP0Qhj7mhcQIVnnNviZvvEXU0AUeWD0mKKi8qh/hGFRWOA1EgfBE0q3NjQv1bHMBg1Vzm+TM6DL1S5jDy0gcYqRNgTKNGj8PCRJeFSOUy4R6dm7t3Ay/Uwqd68JVkPNDCIVgbnSww1TXuowy9NUPuAc+z4= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=intel.com; spf=pass smtp.mailfrom=intel.com; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.b=JOwaCjBc; arc=none smtp.client-ip=198.175.65.19 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=intel.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=intel.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.b="JOwaCjBc" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1775526273; x=1807062273; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=QrPgv/AokZF5J+3s8qtVs4SSlSWLcKcGrB6+Z7ngd7c=; b=JOwaCjBcTIBMXrLlirm97CQyqNZgJzxtU8V2uGkqXYCFFkhNPD1dc+N3 9P820YO5TVgpoSVJ/X9K7pFWPeQAlqWz+gehA2cyWZp5FASSKQMFIqMP7 OmEDMwRvCcj/xpMDxImMzQcr6LWaVFles7MJN1fq5rhkmJMDMK38Z/W6n nhzd1NlLj5Zdw7Ueo4Y/wsvoRx1NiCJO+bX8FqJ7zCGL1x6gYMSZrSnO9 EG5qW5qV9NCvTsGyuyV2ZDaSPIGf3S3y4XJQa0wSrzVgvNamk0KstJbh8 TTcmZA9gmfBUSR8SjRzJgYYYclf1IEVBbbudl+4PQ0qJbDyXtsARb6xV6 g==; X-CSE-ConnectionGUID: AZWM3QnwRzSkZYC6utyHtg== X-CSE-MsgGUID: VNa07f+lQK69QKj0un3vmQ== X-IronPort-AV: E=McAfee;i="6800,10657,11751"; a="76377466" X-IronPort-AV: E=Sophos;i="6.23,164,1770624000"; d="scan'208";a="76377466" Received: from orviesa007.jf.intel.com ([10.64.159.147]) by orvoesa111.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Apr 2026 18:44:31 -0700 X-CSE-ConnectionGUID: AIUmXBwTTG6vbQlM4itgqg== X-CSE-MsgGUID: PG17D+qvR4yIzjnGy6K0qA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.23,164,1770624000"; d="scan'208";a="228294525" Received: from sohilmeh.sc.intel.com ([172.25.103.65]) by orviesa007.jf.intel.com with ESMTP; 06 Apr 2026 18:44:31 -0700 From: Sohil Mehta To: Dave Hansen , Borislav Petkov , x86@kernel.org Cc: Thomas Gleixner , Ingo Molnar , "H . Peter Anvin" , Peter Zijlstra , Josh Poimboeuf , Pawan Gupta , Dave Hansen , Nikolay Borisov , Tony Luck , Andrew Cooper , Sohil Mehta , linux-kernel@vger.kernel.org Subject: [PATCH v5 2/2] scripts/x86/intel: Add a script to update the old microcode list Date: Mon, 6 Apr 2026 18:42:26 -0700 Message-ID: <20260407014226.1169040-3-sohil.mehta@intel.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20260407014226.1169040-1-sohil.mehta@intel.com> References: <20260407014226.1169040-1-sohil.mehta@intel.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit The kernel maintains a table of minimum expected microcode revisions for Intel CPUs in intel-ucode-defs.h. Systems with microcode older than these revisions are flagged with X86_BUG_OLD_MICROCODE. The static list of microcode revisions needs to be updated periodically in response to releases of the official microcode at: https://github.com/intel/Intel-Linux-Processor-Microcode-Data-Files.git. Introduce a simple script to extract the revision information from the microcode files and print it in the precise format expected by the microcode header. Maintaining the script in the kernel tree ensures a central location that a submitter can use to generate the kernel-specific update. This not only reduces the possibility of errors but also makes it easier to validate the changes for reviewers and maintainers. Typically, someone at Intel would see a new public release, wait for at least three months to ensure the update is stable, run this script to refresh the intel-ucode-defs.h file, and send a patch upstream to update the mainline and stable versions. Having a standard update script and a defined process minimizes the ambiguity when refreshing the old microcode list. As always, there can be exceptions to this process which should be supported with appropriate justification. Originally-by: Dave Hansen Signed-off-by: Sohil Mehta --- v5: - Improvements from Andy Cooper - Cover variations of iucode-tool name (Tony) - Add SPDX license information in the generated header - Minor changes to match other kernel scripts v4: - Add suggested timeline to the update process. - Include platform ID information based on Dave's series: https://lore.kernel.org/all/20260119195047.86E3C696@davehans-spike.ostc.intel.com/ This patch should be applied after the bug-fix series has merged. v3: https://lore.kernel.org/lkml/20250825171510.3332029-1-sohil.mehta@intel.com/ - Include motivation for having the script in the kernel. (Boris) - Update instructions to clarify typical usage. (Boris) --- MAINTAINERS | 1 + scripts/update-intel-ucode-defs.py | 130 +++++++++++++++++++++++++++++ 2 files changed, 131 insertions(+) create mode 100755 scripts/update-intel-ucode-defs.py diff --git a/MAINTAINERS b/MAINTAINERS index 61bf550fd37c..9536d9b3efbc 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -28588,6 +28588,7 @@ S: Maintained F: Documentation/admin-guide/hw-vuln/ F: arch/x86/include/asm/nospec-branch.h F: arch/x86/kernel/cpu/bugs.c +F: scripts/update-intel-ucode-defs.py X86 MCE INFRASTRUCTURE M: Tony Luck diff --git a/scripts/update-intel-ucode-defs.py b/scripts/update-intel-ucode-defs.py new file mode 100755 index 000000000000..9d6cc2c6075f --- /dev/null +++ b/scripts/update-intel-ucode-defs.py @@ -0,0 +1,130 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-2.0 +import argparse +import re +import shutil +import subprocess +import sys +import os + +script = os.path.relpath(__file__) + +DESCRIPTION = f""" +For Intel CPUs, update the microcode revisions that determine +X86_BUG_OLD_MICROCODE. + +This script is intended to be run in response to releases of the +official Intel microcode GitHub repository: +https://github.com/intel/Intel-Linux-Processor-Microcode-Data-Files.git + +It takes the Intel microcode files as input and uses iucode-tool to +extract the revision information. It prints the output in the format +expected by intel-ucode-defs.h. + +Usage: + ./{script} /path/to/microcode/files > /path/to/intel-ucode-defs.h + +Typically, someone at Intel would see a new public release, wait for at +least three months to ensure the update is stable, run this script to +refresh the intel-ucode-defs.h file, and send a patch upstream to update +the mainline and stable versions. + +Any exception to this process should be supported with an appropriate +justification. +""" + +SIG_RE = re.compile(r'sig (0x[0-9a-fA-F]+)') +PFM_RE = re.compile(r'pf_mask (0x[0-9a-fA-F]+)') +REV_RE = re.compile(r'rev (0x[0-9a-fA-F]+)') + +# Functions to extract family, model, and stepping +def bits(val, bottom, top): + mask = (1 << (top + 1 - bottom)) - 1 + return (val >> bottom) & mask + +def family(sig): + if bits(sig, 8, 11) == 0xf: + return bits(sig, 8, 11) + bits(sig, 20, 27) + return bits(sig, 8, 11) + +def model(sig): + return bits(sig, 4, 7) | (bits(sig, 16, 19) << 4) + +def step(sig): + return bits(sig, 0, 3) + +class Ucode: + def __init__(self, sig, pfm, rev): + self.family = family(sig) + self.model = model(sig) + self.steppings = 1 << step(sig) + self.platforms = pfm + self.rev = rev + + self.key = (self.family, self.model, self.steppings, self.platforms) + + def __eq__(self, other): + return self.key == other.key + + def __hash__(self): + return hash(self.key) + + def __str__(self): + return "{ .flags = X86_CPU_ID_FLAG_ENTRY_VALID, .vendor = X86_VENDOR_INTEL, .family = 0x%x, .model = 0x%02x, .steppings = 0x%04x, .platform_mask = 0x%02x, .driver_data = 0x%x }," % \ + (self.family, self.model, self.steppings, self.platforms, self.rev) + +def main(): + parser = argparse.ArgumentParser(description=DESCRIPTION, + formatter_class=argparse.RawDescriptionHelpFormatter) + parser.add_argument('ucode_files', nargs='+', help='Path(s) to the microcode files') + + args = parser.parse_args() + + # Process the microcode files using iucode-tool + iucode_tool = shutil.which("iucode-tool") or shutil.which("iucode_tool") + if iucode_tool is None: + print("Error: iucode-tool not found, please install it", file=sys.stderr) + sys.exit(1) + + cmd = [iucode_tool, '--list-all'] + args.ucode_files + + result = subprocess.run(cmd, capture_output=True, text=True) + if result.returncode != 0: + print("Error: iucode-tool ran into an error, exiting", file=sys.stderr) + if result.stderr: + print(result.stderr, file=sys.stderr, end='') + sys.exit(1) + + ucodes = set() + + # Parse the output of iucode-tool + for line in result.stdout.splitlines(): + sig_match = SIG_RE.search(line) + pfm_match = PFM_RE.search(line) + rev_match = REV_RE.search(line) + + if not (sig_match and pfm_match and rev_match): + continue + + sig = int(sig_match.group(1), 16) + pfm = int(pfm_match.group(1), 16) + rev = int(rev_match.group(1), 16) + debug_rev = bits(rev, 31, 31) + if debug_rev != 0: + print("Error: Debug ucode file found, exiting", file=sys.stderr) + sys.exit(1) + + ucodes.add(Ucode(sig, pfm, rev)) + + if not ucodes: + print("Error: No valid microcode files found, exiting", file=sys.stderr) + sys.exit(1) + + # Sort and print the microcode entries + print("/* SPDX-License-Identifier: GPL-2.0 */") + print("/* Auto-generated by scripts/update-intel-ucode-defs.py */") + for u in sorted(ucodes, key=lambda x: x.key): + print(u) + +if __name__ == "__main__": + main() -- 2.43.0