NAME

ucodeadm — processor microcode utility

SYNOPSIS

ucodeadm -i [-t type] [-R path] microcode-file

ucodeadm -l [-t type] microcode-file

ucodeadm -u [-t type] microcode-file

ucodeadm -v

DESCRIPTION

The ucodeadm utility can be used to report the running microcode revision on the processors, update microcode, extract microcode to the target system to be used during the boot process, or to view details of the microcode patches contained within microcode-file, where microcode-file is an update obtained from a processor vendor.

In general, processor microcode updates are provided as part of the operating system and automatically applied during system boot, and there is no need for a system administrator to use ucodeadm directly. The operating system bundled files are not suitable for use with ucodeadm.

OPTIONS

-i microcode-file

Install microcode files on target system to be used during the next boot cycle. The type of the file must either be specified with the -t option, or microcode-file name must start with the vendor name prefix, either “intel” or “amd”, so that the type can be inferred from it.

By default the microcode files will be installed at:

/platform/$ARCH/ucode/$VENDORSTR/

where VENDORSTR is either “GenuineIntel” or “AuthenticAMD” and ARCH is the architecture of the running machine — the same value that is shown by the -m option of uname(1).

-l microcode-file

Display details of the microcode patches contained within microcode-file.

-t type

Specify the type of microcode-file. Either “intel” or “amd”.

-u microcode-file

Update microcode on all cross-call interrupt ready processors.

-v

Report the microcode revision for each CPU on the current system.

-R alternate-path

Install microcode files into the provided alternate-path.

EXIT STATUS

The following exit values are returned:

0: Successful completion.
>0: An error occurred.

EXAMPLES

Example 1 Reporting the Microcode Revision

The following example displays the microcode revision that is currently running:

# ucodeadm -v
CPU     Microcode Version
0       0x2f
1       0x2f

Example 2 Updating the Processor Microcode

The following example updates the processor microcode using intel-ucode.txt:

# ucodeadm -u intel-ucode.txt

Example 3 Installing the Microcode on the Target System

The following example installs the microcode into /export/ucode-path on the target system:

# ucodeadm -i -R /export/ucode-path intel-ucode.txt
# ls /export/ucode-path
00001632-00

If an alternate path is used when installing the microcode on the target system, the installed microcode file is not used on the next boot cycle.

Example 4 Listing the contents of a microcode file

# ucodeadm -l amd_fam17h.bin
Equivalence table:
    00800F82 Family=17 Model=08 Stepping=02 -> 8082
    00800F12 Family=17 Model=01 Stepping=02 -> 8012
    00830F10 Family=17 Model=31 Stepping=00 -> 8310
Microcode patches:
    8082 -> Patch=0800820D Date=04162019 Bytes=3200
    8012 -> Patch=0800126E Date=11112021 Bytes=3200
    8310 -> Patch=08301055 Date=02152022 Bytes=3200

# ucodeadm -l intel-ucode.txt
Microcode patches:
    00090672-03 -> Family=06 Model=97 Stepping=02
                   Date=03032022 Bytes=212876
Extended Signature Table:
    00090672-03 -> Family=06 Model=97 Stepping=02
    00090675-03 -> Family=06 Model=97 Stepping=05
    000B06F2-03 -> Family=06 Model=bf Stepping=02
    000B06F5-03 -> Family=06 Model=bf Stepping=05

INTERFACE STABILITY

The command line interface of ucodeadm is Committed. The output of ucodeadm is Not-An-Interface and may change at any time.