xref: /titanic_44/usr/src/man/man1m/ucodeadm.1m (revision f05d7fc81533be643136e12ce92516d1d4292921)
te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
UCODEADM 1M "Jul 10, 2007"
NAME
ucodeadm - update processor microcode
SYNOPSIS

/usr/sbin/ucodeadm -v

/usr/sbin/ucodeadm -umicrocode-text-file

/usr/sbin/ucodeadm -i [-R path] microcode-text-file
DESCRIPTION

The ucodeadm utility can be used to report running microcode revision on the processors, update microcode, or install microcode on the target system to be used during the boot process.

The microcode-text-file can be obtained from processor vendors.

OPTIONS
-v

Report microcode revision.

-u microcode-text-file

Update microcode on all cross-call interrupt ready processors.

-i microcode-text-file

Install microcode files on target system to be used during the next boot cycle. The text file name must have the vendor name prefix, such as "intel" or "amd". By default the microcode files will be installed at:

 /platform/i86pc/ucode/$VENDORSTR/
where VENDORSTR is either "GenuineIntel" or "AuthenticAMD".
-R alternate path

Install microcode path in the alternate path.

EXAMPLES

Example 1 Reporting the Microcode Revision

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

# ucodeadm -v

Example 2 Updating the Processor Microcode

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

# ucodeadm -u intel-ucode.txt

Example 3 Installing the Microcode on the Target System

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

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

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.

EXIT STATUS

The following exit values are returned: 0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Stable
SEE ALSO

psradm(1M), psrinfo(1M), attributes(5)