xref: /illumos-gate/usr/src/data/ucode/README.ucode (revision dd03b475cb030673a110ddade24162f09801d116)
1#
2# This file and its contents are supplied under the terms of the
3# Common Development and Distribution License ("CDDL"), version 1.0.
4# You may only use this file in accordance with the terms of version
5# 1.0 of the CDDL.
6#
7# A full copy of the text of the CDDL should have accompanied this
8# source.  A copy of the CDDL is also available via the Internet at
9# http://www.illumos.org/license/CDDL.
10#
11
12#
13# Copyright 2019 Joyent, Inc.
14# Copyright 2022 OmniOS Community Edition (OmniOSce) Association.
15#
16
17Microcode Management
18
19Historically microcode files were delivered by Intel as a single
20microcode file that we would break apart and install with ucodeadm. Each
21individual file represented a single platform's microcode. However,
22recently Intel has changed that policy and is no longer distributing
23microcode in that fashion. Further, we also relied on bootadm to go
24through and turn this microcode into individual files as part of setting
25up the boot environment.
26
27Intead of using this method, we will update the microcode and manage
28them in here as individual files. When updating files, please indicate
29the release that the microcode was obtained from here.
30
31>>> Intel
32
33The upstream microcode for Intel can currently be found at:
34
35    https://github.com/intel/Intel-Linux-Processor-Microcode-Data-Files
36
37The script "update.intel" in this directory can be used to help automate
38the update by providing a tarball of the above microcode, and takes care
39of updating the manifest as necessary. Be careful about new files.
40
41Intel - see:
42    usr/src/pkg/manifests/system-microcode-intel.p5m
43for exact current version
44
45>>> AMD
46
47The upstream microcode for AMD can currently be found at:
48
49    git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git
50
51The script "update.amd" in this directory can be used to help automate
52the update by automatically checking out the latest upstream firmware and
53inserting it into the tree and package manifest. Be careful about new files.
54
55NOTE: If any microcode file is larger than 8KiB (8192 bytes), then the size of
56      the ucode_file_amd_t structure in uts/common/sys/ucode.h will need
57      increasing to cater for this.
58
59AMD - see:
60    usr/src/pkg/manifests/system-microcode-amd.p5m
61for exact current version
62
63