1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_UCODE_H 27 #define _SYS_UCODE_H 28 29 #ifdef _KERNEL 30 #include <sys/cpuvar.h> 31 #endif 32 #include <sys/types.h> 33 #include <sys/priv.h> 34 #include <sys/processor.h> 35 #ifndef _KERNEL 36 #include <limits.h> 37 #endif 38 #include <ucode/ucode_errno.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* 45 * /dev/ucode 46 */ 47 #define UCODE_DRIVER_NAME "ucode" 48 #define UCODE_NODE_NAME "ucode" 49 #define UCODE_MINOR ((minor_t)0x3fffful) 50 51 /* 52 * Where to install the microcode 53 */ 54 #define UCODE_INSTALL_PATH "platform/i86pc/ucode" 55 #define UCODE_INSTALL_COMMON_PATH ".f" 56 57 /* 58 * ioctl numbers 59 */ 60 #define UCODE_IOC (('u'<<24)|('c'<<16)|('o'<<8)) 61 62 #define UCODE_GET_VERSION (UCODE_IOC|0) 63 #define UCODE_UPDATE (UCODE_IOC|1) 64 65 struct ucode_get_rev_struct { 66 uint32_t *ugv_rev; /* microcode revision array */ 67 int ugv_size; /* size of the array */ 68 ucode_errno_t ugv_errno; /* EUC error code */ 69 }; 70 71 struct ucode_write_struct { 72 uint32_t uw_size; /* size of the uw_code buffer */ 73 uint8_t *uw_ucode; /* pointer to the undigested microcode */ 74 ucode_errno_t uw_errno; /* EUC error code */ 75 }; 76 77 #if defined(_SYSCALL32_IMPL) 78 79 #include <sys/types32.h> 80 81 struct ucode_get_rev_struct32 { 82 caddr32_t ugv_rev; /* microcode revision array */ 83 int ugv_size; /* size of the array */ 84 ucode_errno_t ugv_errno; /* EUC error code */ 85 }; 86 87 struct ucode_write_struct32 { 88 uint32_t uw_size; /* size of the uw_code buffer */ 89 caddr32_t uw_ucode; /* pointer to the undigested microcode */ 90 ucode_errno_t uw_errno; /* EUC error code */ 91 }; 92 93 #endif /* _SYSCALL32_IMPL */ 94 95 /* 96 * AMD Microcode file information 97 */ 98 typedef struct ucode_header_amd { 99 uint32_t uh_date; 100 uint32_t uh_patch_id; 101 uint32_t uh_internal; /* patch data id & length, init flag */ 102 uint32_t uh_cksum; 103 uint32_t uh_nb_id; 104 uint32_t uh_sb_id; 105 uint16_t uh_cpu_rev; 106 uint8_t uh_nb_rev; 107 uint8_t uh_sb_rev; 108 uint32_t uh_bios_rev; 109 uint32_t uh_match[8]; 110 } ucode_header_amd_t; 111 112 typedef struct ucode_file_amd { 113 ucode_header_amd_t uf_header; 114 uint8_t uf_data[896]; 115 uint8_t uf_resv[896]; 116 uint8_t uf_code_present; 117 uint8_t uf_code[191]; 118 } ucode_file_amd_t; 119 120 typedef struct ucode_eqtbl_amd { 121 uint32_t ue_inst_cpu; 122 uint32_t ue_fixed_mask; 123 uint32_t ue_fixed_comp; 124 uint32_t ue_equiv_cpu; 125 } ucode_eqtbl_amd_t; 126 127 /* 128 * Intel Microcode file information 129 */ 130 typedef struct ucode_header_intel { 131 uint32_t uh_header_ver; 132 uint32_t uh_rev; 133 uint32_t uh_date; 134 uint32_t uh_signature; 135 uint32_t uh_checksum; 136 uint32_t uh_loader_ver; 137 uint32_t uh_proc_flags; 138 uint32_t uh_body_size; 139 uint32_t uh_total_size; 140 uint32_t uh_reserved[3]; 141 } ucode_header_intel_t; 142 143 typedef struct ucode_ext_sig_intel { 144 uint32_t ues_signature; 145 uint32_t ues_proc_flags; 146 uint32_t ues_checksum; 147 } ucode_ext_sig_intel_t; 148 149 typedef struct ucode_ext_table_intel { 150 uint32_t uet_count; 151 uint32_t uet_checksum; 152 uint32_t uet_reserved[3]; 153 ucode_ext_sig_intel_t uet_ext_sig[1]; 154 } ucode_ext_table_intel_t; 155 156 typedef struct ucode_file_intel { 157 ucode_header_intel_t *uf_header; 158 uint8_t *uf_body; 159 ucode_ext_table_intel_t *uf_ext_table; 160 } ucode_file_intel_t; 161 162 /* 163 * common container 164 */ 165 typedef union ucode_file { 166 ucode_file_amd_t *amd; 167 ucode_file_intel_t intel; 168 } ucode_file_t; 169 170 171 #define UCODE_SHORT_NAME_LEN 12 /* "32-bit-sig"-"8-bit-platid"\0 */ 172 /* 173 * Length of UCODE_INSTALL_COMMON_PATH/short-name 174 * strlen(UCODE_INSTALL_COMMON_PATH) + 1 + UCODE_SHORT_NAME_LEN 175 * Use sizeof which will give us the additional byte for the '/' in between 176 * the common path and the file name. 177 */ 178 #define UCODE_COMMON_NAME_LEN \ 179 (sizeof (UCODE_INSTALL_COMMON_PATH) + (UCODE_SHORT_NAME_LEN)) 180 #define UCODE_MAX_PATH_LEN (PATH_MAX - UCODE_COMMON_NAME_LEN) 181 182 183 #define UCODE_HEADER_SIZE_INTEL (sizeof (struct ucode_header_intel)) 184 #define UCODE_EXT_TABLE_SIZE_INTEL (20) /* 20-bytes */ 185 #define UCODE_EXT_SIG_SIZE_INTEL (sizeof (struct ucode_ext_sig_intel)) 186 187 #define UCODE_KB(a) ((a) << 10) /* KB */ 188 #define UCODE_MB(a) ((a) << 20) /* MB */ 189 #define UCODE_DEFAULT_TOTAL_SIZE UCODE_KB(2) 190 #define UCODE_DEFAULT_BODY_SIZE (UCODE_KB(2) - UCODE_HEADER_SIZE_INTEL) 191 192 /* 193 * For a single microcode file, the minimum size is 1K, maximum size is 16K. 194 * Such limitations, while somewhat artificial, are not only to provide better 195 * sanity checks, but also avoid wasting precious memory at startup time as the 196 * microcode buffer for the first processor has to be statically allocated. 197 * 198 * For the concatenation of all the microcode binary files, the maximum size 199 * is 16M. 200 */ 201 #define UCODE_MIN_SIZE UCODE_KB(1) 202 #define UCODE_MAX_SIZE UCODE_KB(16) 203 #define UCODE_MAX_COMBINED_SIZE UCODE_MB(16) 204 205 #define UCODE_SIZE_CONVERT(size, default_size) \ 206 ((size) == 0 ? (default_size) : (size)) 207 208 #define UCODE_BODY_SIZE_INTEL(size) \ 209 UCODE_SIZE_CONVERT((size), UCODE_DEFAULT_BODY_SIZE) 210 211 #define UCODE_TOTAL_SIZE_INTEL(size) \ 212 UCODE_SIZE_CONVERT((size), UCODE_DEFAULT_TOTAL_SIZE) 213 214 #define UCODE_MATCH_INTEL(sig1, sig2, pf1, pf2) \ 215 (((sig1) == (sig2)) && \ 216 (((pf1) & (pf2)) || (((pf1) == 0) && ((pf2) == 0)))) 217 218 extern ucode_errno_t ucode_header_validate_intel(ucode_header_intel_t *); 219 extern uint32_t ucode_checksum_intel(uint32_t, uint32_t, uint8_t *); 220 221 extern ucode_errno_t ucode_validate_amd(uint8_t *, int); 222 extern ucode_errno_t ucode_validate_intel(uint8_t *, int); 223 224 #ifdef _KERNEL 225 extern ucode_errno_t ucode_get_rev(uint32_t *); 226 extern ucode_errno_t ucode_update(uint8_t *, int); 227 228 /* 229 * Microcode specific information per core 230 */ 231 typedef struct cpu_ucode_info { 232 uint32_t cui_platid; /* platform id */ 233 uint32_t cui_rev; /* microcode revision */ 234 } cpu_ucode_info_t; 235 236 /* 237 * Data structure used for xcall 238 */ 239 typedef struct ucode_update { 240 uint32_t sig; /* signature */ 241 cpu_ucode_info_t info; /* ucode info */ 242 uint32_t expected_rev; 243 uint32_t new_rev; 244 uint8_t *ucodep; /* pointer to ucode */ 245 uint32_t usize; 246 } ucode_update_t; 247 248 /* 249 * Microcode kernel operations 250 */ 251 struct ucode_ops { 252 uint32_t write_msr; 253 int (*capable)(cpu_t *); 254 void (*file_reset)(ucode_file_t *, processorid_t); 255 void (*read_rev)(cpu_ucode_info_t *); 256 uint32_t (*load)(ucode_file_t *, cpu_ucode_info_t *, cpu_t *); 257 ucode_errno_t (*validate)(uint8_t *, int); 258 ucode_errno_t (*extract)(ucode_update_t *, uint8_t *, int); 259 ucode_errno_t (*locate)(cpu_t *, cpu_ucode_info_t *, ucode_file_t *); 260 }; 261 #else 262 263 #define UCODE_MAX_VENDORS_NAME_LEN 20 264 265 #define UCODE_VENDORS \ 266 static struct { \ 267 char *filestr; \ 268 char *extstr; \ 269 char *vendorstr; \ 270 int supported; \ 271 } ucode_vendors[] = { \ 272 { "intel", "txt", "GenuineIntel", 1 }, \ 273 { "amd", "bin", "AuthenticAMD", 1 }, \ 274 { NULL, NULL, NULL, 0 } \ 275 } 276 277 /* 278 * Microcode user operations 279 */ 280 struct ucode_ops { 281 int (*convert)(const char *, uint8_t *, size_t); 282 ucode_errno_t (*gen_files)(uint8_t *, int, char *); 283 ucode_errno_t (*validate)(uint8_t *, int); 284 }; 285 #endif 286 287 extern const struct ucode_ops *ucode; 288 289 #ifdef __cplusplus 290 } 291 #endif 292 293 #endif /* _SYS_UCODE_H */ 294