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 __FBSDID("$FreeBSD$");
29 #include <sys/types.h>
32 #include <sys/ioctl.h>
33 #include <sys/ioccom.h>
34 #include <sys/cpuctl.h>
36 #include <machine/cpufunc.h>
37 #include <machine/specialreg.h>
47 #include "cpucontrol.h"
54 cpuctl_cpuid_args_t idargs;
60 error = ioctl(fd, CPUCTL_CPUID, &idargs);
65 ((uint32_t *)vendor)[0] = idargs.data[1];
66 ((uint32_t *)vendor)[1] = idargs.data[3];
67 ((uint32_t *)vendor)[2] = idargs.data[2];
69 if (strncmp(vendor, AMD_VENDOR_ID, sizeof(AMD_VENDOR_ID)) != 0)
73 error = ioctl(fd, CPUCTL_CPUID, &idargs);
78 signature = idargs.data[0];
79 family = ((signature >> 8) & 0x0f) + ((signature >> 20) & 0xff);
86 * NB: the format of microcode update files is not documented by AMD.
87 * It has been reverse engineered from studying Coreboot, illumos and Linux
91 amd10h_update(const char *dev, const char *path)
94 cpuctl_cpuid_args_t idargs;
95 cpuctl_msr_args_t msrargs;
96 cpuctl_update_args_t args;
97 const amd_10h_fw_header_t *fw_header;
98 const amd_10h_fw_header_t *selected_fw;
99 const equiv_cpu_entry_t *equiv_cpu_table;
100 const section_header_t *section_header;
101 const container_header_t *container_header;
102 const uint8_t *fw_data;
105 size_t selected_size;
118 fw_image = MAP_FAILED;
119 devfd = open(dev, O_RDWR);
121 WARN(0, "could not open %s for writing", dev);
125 error = ioctl(devfd, CPUCTL_CPUID, &idargs);
130 signature = idargs.data[0];
132 msrargs.msr = MSR_BIOS_SIGN;
133 error = ioctl(devfd, CPUCTL_RDMSR, &msrargs);
135 WARN(0, "ioctl(%s)", dev);
138 revision = (uint32_t)msrargs.data;
140 WARNX(1, "found cpu family %#x model %#x "
141 "stepping %#x extfamily %#x extmodel %#x.",
142 ((signature >> 8) & 0x0f) + ((signature >> 20) & 0xff),
143 (signature >> 4) & 0x0f,
144 (signature >> 0) & 0x0f, (signature >> 20) & 0xff,
145 (signature >> 16) & 0x0f);
146 WARNX(1, "microcode revision %#x", revision);
149 * Open the firmware file.
151 WARNX(1, "checking %s for update.", path);
152 fd = open(path, O_RDONLY, 0);
154 WARN(0, "open(%s)", path);
157 error = fstat(fd, &st);
159 WARN(0, "fstat(%s)", path);
162 if (st.st_size < 0 || (size_t)st.st_size <
163 (sizeof(*container_header) + sizeof(*section_header))) {
164 WARNX(2, "file too short: %s", path);
167 fw_size = st.st_size;
170 * mmap the whole image.
172 fw_image = (uint8_t *)mmap(NULL, st.st_size, PROT_READ,
174 if (fw_image == MAP_FAILED) {
175 WARN(0, "mmap(%s)", path);
180 container_header = (const container_header_t *)fw_data;
181 if (container_header->magic != AMD_10H_MAGIC) {
182 WARNX(2, "%s is not a valid amd firmware: bad magic", path);
185 fw_data += sizeof(*container_header);
186 fw_size -= sizeof(*container_header);
188 section_header = (const section_header_t *)fw_data;
189 if (section_header->type != AMD_10H_EQUIV_TABLE_TYPE) {
190 WARNX(2, "%s is not a valid amd firmware: "
191 "first section is not CPU equivalence table", path);
194 if (section_header->size == 0) {
195 WARNX(2, "%s is not a valid amd firmware: "
196 "first section is empty", path);
199 fw_data += sizeof(*section_header);
200 fw_size -= sizeof(*section_header);
202 if (section_header->size > fw_size) {
203 WARNX(2, "%s is not a valid amd firmware: "
204 "file is truncated", path);
207 if (section_header->size < sizeof(*equiv_cpu_table)) {
208 WARNX(2, "%s is not a valid amd firmware: "
209 "first section is too short", path);
212 equiv_cpu_table = (const equiv_cpu_entry_t *)fw_data;
213 fw_data += section_header->size;
214 fw_size -= section_header->size;
217 for (i = 0; equiv_cpu_table[i].installed_cpu != 0; i++) {
218 if (signature == equiv_cpu_table[i].installed_cpu) {
219 equiv_id = equiv_cpu_table[i].equiv_cpu;
220 WARNX(3, "equiv_id: %x, signature %8x,"
221 " equiv_cpu_table[%d] %8x", equiv_id, signature,
222 i, equiv_cpu_table[i].installed_cpu);
227 WARNX(2, "CPU is not found in the equivalence table");
233 while (fw_size >= sizeof(*section_header)) {
234 section_header = (const section_header_t *)fw_data;
235 fw_data += sizeof(*section_header);
236 fw_size -= sizeof(*section_header);
237 if (section_header->type != AMD_10H_uCODE_TYPE) {
238 WARNX(2, "%s is not a valid amd firmware: "
239 "section has incorret type", path);
242 if (section_header->size > fw_size) {
243 WARNX(2, "%s is not a valid amd firmware: "
244 "file is truncated", path);
247 if (section_header->size < sizeof(*fw_header)) {
248 WARNX(2, "%s is not a valid amd firmware: "
249 "section is too short", path);
252 fw_header = (const amd_10h_fw_header_t *)fw_data;
253 fw_data += section_header->size;
254 fw_size -= section_header->size;
256 if (fw_header->processor_rev_id != equiv_id) {
257 WARNX(1, "firmware processort_rev_id %x, equiv_id %x",
258 fw_header->processor_rev_id, equiv_id);
259 continue; /* different cpu */
261 if (fw_header->patch_id <= revision) {
262 WARNX(1, "patch_id %x, revision %x",
263 fw_header->patch_id, revision);
264 continue; /* not newer revision */
266 if (fw_header->nb_dev_id != 0 || fw_header->sb_dev_id != 0) {
267 WARNX(2, "Chipset-specific microcode is not supported");
270 WARNX(3, "selecting revision: %x", fw_header->patch_id);
271 revision = fw_header->patch_id;
272 selected_fw = fw_header;
273 selected_size = section_header->size;
277 WARNX(2, "%s is not a valid amd firmware: "
278 "file is truncated", path);
282 if (selected_fw != NULL) {
283 WARNX(1, "selected ucode size is %zu", selected_size);
284 fprintf(stderr, "%s: updating cpu %s to revision %#x... ",
285 path, dev, revision);
287 args.data = __DECONST(void *, selected_fw);
288 args.size = selected_size;
289 error = ioctl(devfd, CPUCTL_UPDATE, &args);
291 fprintf(stderr, "failed.\n");
295 fprintf(stderr, "done.\n");
298 msrargs.msr = MSR_BIOS_SIGN;
299 error = ioctl(devfd, CPUCTL_RDMSR, &msrargs);
301 WARN(0, "ioctl(%s)", dev);
304 new_rev = (uint32_t)msrargs.data;
305 if (new_rev != revision)
306 WARNX(0, "revision after update %#x", new_rev);
313 if (fw_image != MAP_FAILED)
314 if (munmap(fw_image, st.st_size) != 0)
315 warn("munmap(%s)", path);