usr/src/man/man1m/ucodeadm.1m

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH UCODEADM 1M "Jul 10, 2007"
   7 .SH NAME
   8 ucodeadm \- update processor microcode
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/ucodeadm\fR \fB-v\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/sbin/ucodeadm\fR \fB-u\fR\fImicrocode-text-file\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fB/usr/sbin/ucodeadm\fR \fB-i\fR [\fB-R\fR \fIpath\fR] \fImicrocode-text-file\fR
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBucodeadm\fR utility can be used to report running microcode revision on
  29 the processors, update microcode, or install microcode on the target system to
  30 be used during the boot process.
  31 .sp
  32 .LP
  33 The \fImicrocode-text-file\fR can be obtained from processor vendors.
  34 .SH OPTIONS
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fB-v\fR\fR
  39 .ad
  40 .RS 26n
  41 Report microcode revision.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fB-u\fR \fImicrocode-text-file\fR\fR
  48 .ad
  49 .RS 26n
  50 Update microcode on all cross-call interrupt ready processors.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fB-i\fR \fImicrocode-text-file\fR\fR
  57 .ad
  58 .RS 26n
  59 Install microcode files on target system to be used during the next boot
  60 cycle. The text file name must have the vendor name prefix, such as
  61 "\fBintel\fR" or "\fBamd\fR".
  62 .sp
  63 By default the microcode files will be installed at:
  64 .sp
  65 .in +2
  66 .nf
  67  /platform/i86pc/ucode/$VENDORSTR/
  68 .fi
  69 .in -2
  70 .sp
  71
  72 where \fBVENDORSTR\fR is either "\fBGenuineIntel\fR" or "\fBAuthenticAMD\fR".
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fB-R\fR \fIalternate path\fR\fR
  79 .ad
  80 .RS 26n
  81 Install \fImicrocode\fR path in the \fIalternate path\fR.
  82 .RE
  83
  84 .SH EXAMPLES
  85 .LP
  86 \fBExample 1 \fRReporting the Microcode Revision
  87 .sp
  88 .LP
  89 The following example displays the microcode revision that is currently
  90 running:
  91
  92 .sp
  93 .in +2
  94 .nf
  95 # ucodeadm -v
  96 .fi
  97 .in -2
  98 .sp
  99
 100 .LP
 101 \fBExample 2 \fRUpdating the Processor Microcode
 102 .sp
 103 .LP
 104 The following example updates the processor microcode to \fBintel-ucode.txt\fR:
 105
 106 .sp
 107 .in +2
 108 .nf
 109 # ucodeadm -u intel-ucode.txt
 110 .fi
 111 .in -2
 112 .sp
 113
 114 .LP
 115 \fBExample 3 \fRInstalling the Microcode on the Target System
 116 .sp
 117 .LP
 118 The following example installs the microcode on the target system,
 119 \fB/export/ucode-path\fR:
 120
 121 .sp
 122 .in +2
 123 .nf
 124 # ucodeadm -i -R /export/ucode-path intel-ucode.txt
 125 .fi
 126 .in -2
 127 .sp
 128
 129 .sp
 130 .LP
 131 If an alternate path is used when installing the microcode on the target
 132 system, the installed microcode file is not used on the next boot cycle.
 133
 134 .SH EXIT STATUS
 135 .sp
 136 .LP
 137 The following exit values are returned:
 138 .sp
 139 .ne 2
 140 .na
 141 \fB0\fR
 142 .ad
 143 .RS 6n
 144 Successful completion.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB>0\fR
 151 .ad
 152 .RS 6n
 153 An error occurred.
 154 .RE
 155
 156 .SH ATTRIBUTES
 157 .sp
 158 .LP
 159 See \fBattributes\fR(5) for descriptions of the following attributes:
 160 .sp
 161
 162 .sp
 163 .TS
 164 box;
 165 c | c
 166 l | l .
 167 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 168 _
 169 Interface Stability     Stable
 170 .TE
 171
 172 .SH SEE ALSO
 173 .sp
 174 .LP
 175 \fBpsradm\fR(1M), \fBpsrinfo\fR(1M), \fBattributes\fR(5)