Blame SOURCES/intel-microcode2ucode.8.in

4eb1a6
.\" intel-microcode2ucode stub man page
4eb1a6
.\"
4eb1a6
.\" SPDX-License-Identifier: CC0-1.0
4eb1a6
.\"
4eb1a6
.TH INTEL-MICROCODE2UCODE 8 "@DATE@" "MICROCODE_CTL @VERSION@"
4eb1a6
.\"
4eb1a6
.SH NAME
4eb1a6
intel\-microcode2ucode \- convert Intel microcode.dat file into ucode files
4eb1a6
.\"
4eb1a6
.SH SYNOPSIS
4eb1a6
.SY intel\-microcode2ucode
4eb1a6
.RI [ MICROCODE_FILE ]
4eb1a6
.YS
4eb1a6
.\"
4eb1a6
.SH DESCRIPTION
4eb1a6
.B intel\-microcode2ucode
4eb1a6
parses Intel microcode combined text data file (which usually has name
4eb1a6
.BR microcode.dat )
4eb1a6
and splits it into individual binary microcode files that can be loaded by the
4eb1a6
Linux kernel.
4eb1a6
.LP
4eb1a6
Generated microcode files are placed into
4eb1a6
.B intel-ucode
4eb1a6
directory, which is created in the current working directory, and have file name
4eb1a6
format of
4eb1a6
.IR FF - MM - SS ,
4eb1a6
where
4eb1a6
.I FF
4eb1a6
is the CPU family number,
4eb1a6
.I MM
4eb1a6
is the model number, and
4eb1a6
.I SS
4eb1a6
is stepping.
4eb1a6
All three values are zero-filled to two digits and are hexadecimal
4eb1a6
(letters are in the lower case).
4eb1a6
.LP
4eb1a6
This tool is mostly of historic interest, as Intel ships separate microcode
4eb1a6
files now.
4eb1a6
.\"
4eb1a6
.SH OPTIONS
4eb1a6
.\"
4eb1a6
.TP
4eb1a6
.I MICROCODE_FILE
4eb1a6
Path to the
4eb1a6
.B microcode.dat
4eb1a6
file.
4eb1a6
If no path has been provided, the default path
4eb1a6
.B /lib/firmware/microcode.dat
4eb1a6
is used.
4eb1a6
If
4eb1a6
.B -
4eb1a6
(single dash) is provided as an argument, data is read from the standard input.
4eb1a6
.\"
4eb1a6
.SH EXIT STATUS
4eb1a6
.TP
4eb1a6
.B 0
4eb1a6
Success.
4eb1a6
.TP
4eb1a6
.B 1
4eb1a6
Error occurred:
4eb1a6
temporary buffer cannot be allocated,
4eb1a6
input microcode file cannot be opened,
4eb1a6
microcode version and/or format are unknown,
4eb1a6
cannot open output file,
4eb1a6
cannot write to the output file.
4eb1a6
.\"
4eb1a6
.SH REPORTING BUGS
4eb1a6
Problems with
4eb1a6
.B intel-microcode2ucode
4eb1a6
should be reported to
4eb1a6
.UR https://bugzilla.redhat.com/
4eb1a6
Red Hat Bugzilla
4eb1a6
.UE
4eb1a6
.\"
4eb1a6
.SH AUTHORS
4eb1a6
.B intel-microcode2ucode
4eb1a6
was written by
4eb1a6
Kay Sievers <kay.sievers@vrfy.org> and
4eb1a6
Anton Arapov <anton@redhat.com>.
4eb1a6
This manpage was written for Red Hat Enterprise Linux and may be
4eb1a6
used, modified, and/or distributed freely by anyone.
4eb1a6
.\"
4eb1a6
.SH "SEE ALSO"
4eb1a6
.UR https://gitlab.com\:/iucode-tool\:/iucode-tool
4eb1a6
iucode-tool, a tool for manipulating Intel microcode files
4eb1a6
.UE ,
4eb1a6
.LP
4eb1a6
.UR @MICROCODE_URL@
4eb1a6
Intel microcode
4eb1a6
.UE