2 * Copyright (c) 2012 Andriy Gapon <avg@FreeBSD.org>.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #include <sys/cdefs.h>
27 #include <sys/types.h>
30 #include <sys/ioctl.h>
31 #include <sys/ioccom.h>
32 #include <sys/cpuctl.h>
34 #include <machine/cpufunc.h>
35 #include <machine/specialreg.h>
45 #include "cpucontrol.h"
52 cpuctl_cpuid_args_t idargs;
58 error = ioctl(fd, CPUCTL_CPUID, &idargs);
63 ((uint32_t *)vendor)[0] = idargs.data[1];
64 ((uint32_t *)vendor)[1] = idargs.data[3];
65 ((uint32_t *)vendor)[2] = idargs.data[2];
67 if (strncmp(vendor, AMD_VENDOR_ID, sizeof(AMD_VENDOR_ID)) != 0)
71 error = ioctl(fd, CPUCTL_CPUID, &idargs);
76 signature = idargs.data[0];
77 family = ((signature >> 8) & 0x0f) + ((signature >> 20) & 0xff);
84 * NB: the format of microcode update files is not documented by AMD.
85 * It has been reverse engineered from studying Coreboot, illumos and Linux
89 amd10h_update(const struct ucode_update_params *params)
91 cpuctl_cpuid_args_t idargs;
92 cpuctl_msr_args_t msrargs;
93 cpuctl_update_args_t args;
94 const amd_10h_fw_header_t *fw_header;
95 const amd_10h_fw_header_t *selected_fw;
96 const equiv_cpu_entry_t *equiv_cpu_table;
97 const section_header_t *section_header;
98 const container_header_t *container_header;
99 const uint8_t *fw_data;
100 const uint8_t *fw_image;
101 const char *dev, *path;
103 size_t selected_size;
112 dev = params->dev_path;
113 path = params->fw_path;
114 devfd = params->devfd;
115 fw_image = params->fwimage;
116 fw_size = params->fwsize;
122 error = ioctl(devfd, CPUCTL_CPUID, &idargs);
127 signature = idargs.data[0];
129 msrargs.msr = MSR_BIOS_SIGN;
130 error = ioctl(devfd, CPUCTL_RDMSR, &msrargs);
132 WARN(0, "ioctl(%s)", dev);
135 revision = (uint32_t)msrargs.data;
137 WARNX(1, "found cpu family %#x model %#x "
138 "stepping %#x extfamily %#x extmodel %#x.",
139 ((signature >> 8) & 0x0f) + ((signature >> 20) & 0xff),
140 (signature >> 4) & 0x0f,
141 (signature >> 0) & 0x0f, (signature >> 20) & 0xff,
142 (signature >> 16) & 0x0f);
143 WARNX(1, "microcode revision %#x", revision);
146 * Open the firmware file.
148 WARNX(1, "checking %s for update.", path);
150 (sizeof(*container_header) + sizeof(*section_header))) {
151 WARNX(2, "file too short: %s", path);
156 * mmap the whole image.
159 container_header = (const container_header_t *)fw_data;
160 if (container_header->magic != AMD_10H_MAGIC) {
161 WARNX(2, "%s is not a valid amd firmware: bad magic", path);
164 fw_data += sizeof(*container_header);
165 fw_size -= sizeof(*container_header);
167 section_header = (const section_header_t *)fw_data;
168 if (section_header->type != AMD_10H_EQUIV_TABLE_TYPE) {
169 WARNX(2, "%s is not a valid amd firmware: "
170 "first section is not CPU equivalence table", path);
173 if (section_header->size == 0) {
174 WARNX(2, "%s is not a valid amd firmware: "
175 "first section is empty", path);
178 fw_data += sizeof(*section_header);
179 fw_size -= sizeof(*section_header);
181 if (section_header->size > fw_size) {
182 WARNX(2, "%s is not a valid amd firmware: "
183 "file is truncated", path);
186 if (section_header->size < sizeof(*equiv_cpu_table)) {
187 WARNX(2, "%s is not a valid amd firmware: "
188 "first section is too short", path);
191 equiv_cpu_table = (const equiv_cpu_entry_t *)fw_data;
192 fw_data += section_header->size;
193 fw_size -= section_header->size;
196 for (i = 0; equiv_cpu_table[i].installed_cpu != 0; i++) {
197 if (signature == equiv_cpu_table[i].installed_cpu) {
198 equiv_id = equiv_cpu_table[i].equiv_cpu;
199 WARNX(3, "equiv_id: %x, signature %8x,"
200 " equiv_cpu_table[%d] %8x", equiv_id, signature,
201 i, equiv_cpu_table[i].installed_cpu);
206 WARNX(2, "CPU is not found in the equivalence table");
212 while (fw_size >= sizeof(*section_header)) {
213 section_header = (const section_header_t *)fw_data;
214 fw_data += sizeof(*section_header);
215 fw_size -= sizeof(*section_header);
216 if (section_header->type != AMD_10H_uCODE_TYPE) {
217 WARNX(2, "%s is not a valid amd firmware: "
218 "section has incorrect type", path);
221 if (section_header->size > fw_size) {
222 WARNX(2, "%s is not a valid amd firmware: "
223 "file is truncated", path);
226 if (section_header->size < sizeof(*fw_header)) {
227 WARNX(2, "%s is not a valid amd firmware: "
228 "section is too short", path);
231 fw_header = (const amd_10h_fw_header_t *)fw_data;
232 fw_data += section_header->size;
233 fw_size -= section_header->size;
235 if (fw_header->processor_rev_id != equiv_id) {
236 WARNX(1, "firmware processor_rev_id %x, equiv_id %x",
237 fw_header->processor_rev_id, equiv_id);
238 continue; /* different cpu */
240 if (fw_header->patch_id <= revision) {
241 WARNX(1, "patch_id %x, revision %x",
242 fw_header->patch_id, revision);
243 continue; /* not newer revision */
245 if (fw_header->nb_dev_id != 0 || fw_header->sb_dev_id != 0) {
246 WARNX(2, "Chipset-specific microcode is not supported");
249 WARNX(3, "selecting revision: %x", fw_header->patch_id);
250 revision = fw_header->patch_id;
251 selected_fw = fw_header;
252 selected_size = section_header->size;
256 WARNX(2, "%s is not a valid amd firmware: "
257 "file is truncated", path);
261 if (selected_fw != NULL) {
262 WARNX(1, "selected ucode size is %zu", selected_size);
263 fprintf(stderr, "%s: updating cpu %s to revision %#x... ",
264 path, dev, revision);
266 args.data = __DECONST(void *, selected_fw);
267 args.size = selected_size;
268 error = ioctl(devfd, CPUCTL_UPDATE, &args);
270 fprintf(stderr, "failed.\n");
274 fprintf(stderr, "done.\n");
277 msrargs.msr = MSR_BIOS_SIGN;
278 error = ioctl(devfd, CPUCTL_RDMSR, &msrargs);
280 WARN(0, "ioctl(%s)", dev);
283 new_rev = (uint32_t)msrargs.data;
284 if (new_rev != revision)
285 WARNX(0, "revision after update %#x", new_rev);