summaryrefslogtreecommitdiff
path: root/usr/src/common/ucode/ucode_utils.c
blob: 7721c5c3109a8b6e74b3e8946f25a0781fc32715 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*
 * CDDL HEADER START
 *
 * 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.
 *
 * 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.
 *
 * 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]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#include <sys/types.h>
#include <sys/ucode.h>
#ifdef	_KERNEL
#include <sys/systm.h>
#else
#include <strings.h>
#endif

/*
 * Refer to
 *	Intel 64 and IA-32 Architectures Software Developers's Manual
 *		Chapter 9.11 Microcode Update Facilities
 * for details.
 */

/*
 * Validates the microcode header.
 * Returns EM_OK on success, EM_HEADER on failure.
 */
ucode_errno_t
ucode_header_validate_intel(ucode_header_intel_t *uhp)
{
	uint32_t header_size, body_size, total_size;

	if (uhp == NULL)
		return (EM_HEADER);

	/*
	 * The only header version number supported is 1.
	 */
	if (uhp->uh_header_ver != 0x1)
		return (EM_HEADER);

	header_size = UCODE_HEADER_SIZE_INTEL;
	total_size = UCODE_TOTAL_SIZE_INTEL(uhp->uh_total_size);
	body_size = UCODE_BODY_SIZE_INTEL(uhp->uh_body_size);

	/*
	 * The body size field of the microcode code header specifies the size
	 * of the encrypted data section, its value must be a multiple of the
	 * size of DWORD.  The total size field must be in multiples of 1K
	 * bytes.
	 */
	if ((body_size % sizeof (int)) ||
	    (total_size < (header_size + body_size)) ||
	    (total_size % UCODE_KB(1)))

		return (EM_HEADER);

	/*
	 * Sanity check to avoid reading bogus files
	 */
	if (total_size < UCODE_MIN_SIZE || total_size > UCODE_MAX_SIZE)
		return (EM_HEADER);

	/*
	 * If there is extended signature table, total_size is the sum of
	 *	header_size
	 *	body_size
	 *	sizeof (struct ucode_ext_table)
	 *	n * sizeof (struct ucode_ext_sig)
	 * where n is indicated by uet_count in struct ucode_ext_table.
	 */
	if (total_size > (header_size + body_size)) {
		if ((total_size - body_size - header_size -
		    UCODE_EXT_TABLE_SIZE_INTEL) % UCODE_EXT_SIG_SIZE_INTEL) {

			return (EM_HEADER);
		}
	}

	return (EM_OK);
}

/*
 * Returns checksum.
 */
uint32_t
ucode_checksum_intel(uint32_t sum, uint32_t size, uint8_t *code)
{
	int i;
	uint32_t *lcode = (uint32_t *)(intptr_t)code;

	i = size >> 2;
	while (i--)
		sum += lcode[i];

	return (sum);
}

ucode_errno_t
ucode_validate_amd(uint8_t *ucodep, int size)
{
	/* LINTED: pointer alignment */
	uint32_t *ptr = (uint32_t *)ucodep;
	uint32_t count;

	if (ucodep == NULL || size <= 0)
		return (EM_INVALIDARG);

	/* Magic Number: "AMD\0" */
	size -= 4;
	if (*ptr++ != 0x00414d44)
		return (EM_FILEFORMAT);

	/* equivalence table */
	size -= 4;
	if (*ptr++)
		return (EM_FILEFORMAT);

	size -= 4;
	if (((count = *ptr++) > size) || (count % 16))
		return (EM_FILEFORMAT);

	/* LINTED: pointer alignment */
	ptr = (uint32_t *)(((uint8_t *)ptr) + count);
	size -= count;

	while (size > 8) {
		/* microcode patch */
		size -= 4;
		if (*ptr++ != 1)
			return (EM_FILEFORMAT);

		size -= 4;
		if (((count = *ptr++) > size))
			return (EM_FILEFORMAT);

		/* LINTED: pointer alignment */
		ptr = (uint32_t *)(((uint8_t *)ptr) + count);
		size -= count;
	}

	if (size)
		return (EM_FILEFORMAT);

	return (EM_OK);
}

ucode_errno_t
ucode_validate_intel(uint8_t *ucodep, int size)
{
	uint32_t header_size = UCODE_HEADER_SIZE_INTEL;
	int remaining;

	if (ucodep == NULL || size <= 0)
		return (EM_INVALIDARG);

	for (remaining = size; remaining > 0; ) {
		uint32_t total_size, body_size, ext_size;
		ucode_header_intel_t *uhp;
		uint8_t *curbuf = &ucodep[size - remaining];
		ucode_errno_t rc;

		uhp = (ucode_header_intel_t *)(intptr_t)curbuf;

		if ((rc = ucode_header_validate_intel(uhp)) != EM_OK)
			return (rc);

		total_size = UCODE_TOTAL_SIZE_INTEL(uhp->uh_total_size);

		if (ucode_checksum_intel(0, total_size, curbuf))
			return (EM_CHECKSUM);

		body_size = UCODE_BODY_SIZE_INTEL(uhp->uh_body_size);
		ext_size = total_size - (header_size + body_size);

		if (ext_size > 0) {
			uint32_t i;

			if (ucode_checksum_intel(0, ext_size,
			    &curbuf[header_size + body_size])) {
				return (EM_CHECKSUM);
			}

			ext_size -= UCODE_EXT_TABLE_SIZE_INTEL;
			for (i = 0; i < ext_size / UCODE_EXT_SIG_SIZE_INTEL;
			    i++) {
				if (ucode_checksum_intel(0,
				    UCODE_EXT_SIG_SIZE_INTEL,
				    &curbuf[total_size - ext_size +
				    i * UCODE_EXT_SIG_SIZE_INTEL])) {

					return (EM_CHECKSUM);
				}
			}
		}

		remaining -= total_size;
	}
	return (EM_OK);
}