]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - arch/x86/include/asm/mce.h
x86/ras/amd: Make sysfs names of banks more user-friendly
[mirror_ubuntu-jammy-kernel.git] / arch / x86 / include / asm / mce.h
1 #ifndef _ASM_X86_MCE_H
2 #define _ASM_X86_MCE_H
3
4 #include <uapi/asm/mce.h>
5
6 /*
7 * Machine Check support for x86
8 */
9
10 /* MCG_CAP register defines */
11 #define MCG_BANKCNT_MASK 0xff /* Number of Banks */
12 #define MCG_CTL_P (1ULL<<8) /* MCG_CTL register available */
13 #define MCG_EXT_P (1ULL<<9) /* Extended registers available */
14 #define MCG_CMCI_P (1ULL<<10) /* CMCI supported */
15 #define MCG_EXT_CNT_MASK 0xff0000 /* Number of Extended registers */
16 #define MCG_EXT_CNT_SHIFT 16
17 #define MCG_EXT_CNT(c) (((c) & MCG_EXT_CNT_MASK) >> MCG_EXT_CNT_SHIFT)
18 #define MCG_SER_P (1ULL<<24) /* MCA recovery/new status bits */
19 #define MCG_ELOG_P (1ULL<<26) /* Extended error log supported */
20 #define MCG_LMCE_P (1ULL<<27) /* Local machine check supported */
21
22 /* MCG_STATUS register defines */
23 #define MCG_STATUS_RIPV (1ULL<<0) /* restart ip valid */
24 #define MCG_STATUS_EIPV (1ULL<<1) /* ip points to correct instruction */
25 #define MCG_STATUS_MCIP (1ULL<<2) /* machine check in progress */
26 #define MCG_STATUS_LMCES (1ULL<<3) /* LMCE signaled */
27
28 /* MCG_EXT_CTL register defines */
29 #define MCG_EXT_CTL_LMCE_EN (1ULL<<0) /* Enable LMCE */
30
31 /* MCi_STATUS register defines */
32 #define MCI_STATUS_VAL (1ULL<<63) /* valid error */
33 #define MCI_STATUS_OVER (1ULL<<62) /* previous errors lost */
34 #define MCI_STATUS_UC (1ULL<<61) /* uncorrected error */
35 #define MCI_STATUS_EN (1ULL<<60) /* error enabled */
36 #define MCI_STATUS_MISCV (1ULL<<59) /* misc error reg. valid */
37 #define MCI_STATUS_ADDRV (1ULL<<58) /* addr reg. valid */
38 #define MCI_STATUS_PCC (1ULL<<57) /* processor context corrupt */
39 #define MCI_STATUS_S (1ULL<<56) /* Signaled machine check */
40 #define MCI_STATUS_AR (1ULL<<55) /* Action required */
41
42 /* AMD-specific bits */
43 #define MCI_STATUS_TCC (1ULL<<55) /* Task context corrupt */
44 #define MCI_STATUS_SYNDV (1ULL<<53) /* synd reg. valid */
45 #define MCI_STATUS_DEFERRED (1ULL<<44) /* uncorrected error, deferred exception */
46 #define MCI_STATUS_POISON (1ULL<<43) /* access poisonous data */
47
48 /*
49 * McaX field if set indicates a given bank supports MCA extensions:
50 * - Deferred error interrupt type is specifiable by bank.
51 * - MCx_MISC0[BlkPtr] field indicates presence of extended MISC registers,
52 * But should not be used to determine MSR numbers.
53 * - TCC bit is present in MCx_STATUS.
54 */
55 #define MCI_CONFIG_MCAX 0x1
56 #define MCI_IPID_MCATYPE 0xFFFF0000
57 #define MCI_IPID_HWID 0xFFF
58
59 /*
60 * Note that the full MCACOD field of IA32_MCi_STATUS MSR is
61 * bits 15:0. But bit 12 is the 'F' bit, defined for corrected
62 * errors to indicate that errors are being filtered by hardware.
63 * We should mask out bit 12 when looking for specific signatures
64 * of uncorrected errors - so the F bit is deliberately skipped
65 * in this #define.
66 */
67 #define MCACOD 0xefff /* MCA Error Code */
68
69 /* Architecturally defined codes from SDM Vol. 3B Chapter 15 */
70 #define MCACOD_SCRUB 0x00C0 /* 0xC0-0xCF Memory Scrubbing */
71 #define MCACOD_SCRUBMSK 0xeff0 /* Skip bit 12 ('F' bit) */
72 #define MCACOD_L3WB 0x017A /* L3 Explicit Writeback */
73 #define MCACOD_DATA 0x0134 /* Data Load */
74 #define MCACOD_INSTR 0x0150 /* Instruction Fetch */
75
76 /* MCi_MISC register defines */
77 #define MCI_MISC_ADDR_LSB(m) ((m) & 0x3f)
78 #define MCI_MISC_ADDR_MODE(m) (((m) >> 6) & 7)
79 #define MCI_MISC_ADDR_SEGOFF 0 /* segment offset */
80 #define MCI_MISC_ADDR_LINEAR 1 /* linear address */
81 #define MCI_MISC_ADDR_PHYS 2 /* physical address */
82 #define MCI_MISC_ADDR_MEM 3 /* memory address */
83 #define MCI_MISC_ADDR_GENERIC 7 /* generic */
84
85 /* CTL2 register defines */
86 #define MCI_CTL2_CMCI_EN (1ULL << 30)
87 #define MCI_CTL2_CMCI_THRESHOLD_MASK 0x7fffULL
88
89 #define MCJ_CTX_MASK 3
90 #define MCJ_CTX(flags) ((flags) & MCJ_CTX_MASK)
91 #define MCJ_CTX_RANDOM 0 /* inject context: random */
92 #define MCJ_CTX_PROCESS 0x1 /* inject context: process */
93 #define MCJ_CTX_IRQ 0x2 /* inject context: IRQ */
94 #define MCJ_NMI_BROADCAST 0x4 /* do NMI broadcasting */
95 #define MCJ_EXCEPTION 0x8 /* raise as exception */
96 #define MCJ_IRQ_BROADCAST 0x10 /* do IRQ broadcasting */
97
98 #define MCE_OVERFLOW 0 /* bit 0 in flags means overflow */
99
100 #define MCE_LOG_LEN 32
101 #define MCE_LOG_SIGNATURE "MACHINECHECK"
102
103 /* AMD Scalable MCA */
104 #define MSR_AMD64_SMCA_MC0_CTL 0xc0002000
105 #define MSR_AMD64_SMCA_MC0_STATUS 0xc0002001
106 #define MSR_AMD64_SMCA_MC0_ADDR 0xc0002002
107 #define MSR_AMD64_SMCA_MC0_MISC0 0xc0002003
108 #define MSR_AMD64_SMCA_MC0_CONFIG 0xc0002004
109 #define MSR_AMD64_SMCA_MC0_IPID 0xc0002005
110 #define MSR_AMD64_SMCA_MC0_SYND 0xc0002006
111 #define MSR_AMD64_SMCA_MC0_DESTAT 0xc0002008
112 #define MSR_AMD64_SMCA_MC0_DEADDR 0xc0002009
113 #define MSR_AMD64_SMCA_MC0_MISC1 0xc000200a
114 #define MSR_AMD64_SMCA_MCx_CTL(x) (MSR_AMD64_SMCA_MC0_CTL + 0x10*(x))
115 #define MSR_AMD64_SMCA_MCx_STATUS(x) (MSR_AMD64_SMCA_MC0_STATUS + 0x10*(x))
116 #define MSR_AMD64_SMCA_MCx_ADDR(x) (MSR_AMD64_SMCA_MC0_ADDR + 0x10*(x))
117 #define MSR_AMD64_SMCA_MCx_MISC(x) (MSR_AMD64_SMCA_MC0_MISC0 + 0x10*(x))
118 #define MSR_AMD64_SMCA_MCx_CONFIG(x) (MSR_AMD64_SMCA_MC0_CONFIG + 0x10*(x))
119 #define MSR_AMD64_SMCA_MCx_IPID(x) (MSR_AMD64_SMCA_MC0_IPID + 0x10*(x))
120 #define MSR_AMD64_SMCA_MCx_SYND(x) (MSR_AMD64_SMCA_MC0_SYND + 0x10*(x))
121 #define MSR_AMD64_SMCA_MCx_DESTAT(x) (MSR_AMD64_SMCA_MC0_DESTAT + 0x10*(x))
122 #define MSR_AMD64_SMCA_MCx_DEADDR(x) (MSR_AMD64_SMCA_MC0_DEADDR + 0x10*(x))
123 #define MSR_AMD64_SMCA_MCx_MISCy(x, y) ((MSR_AMD64_SMCA_MC0_MISC1 + y) + (0x10*(x)))
124
125 /*
126 * This structure contains all data related to the MCE log. Also
127 * carries a signature to make it easier to find from external
128 * debugging tools. Each entry is only valid when its finished flag
129 * is set.
130 */
131 struct mce_log {
132 char signature[12]; /* "MACHINECHECK" */
133 unsigned len; /* = MCE_LOG_LEN */
134 unsigned next;
135 unsigned flags;
136 unsigned recordlen; /* length of struct mce */
137 struct mce entry[MCE_LOG_LEN];
138 };
139
140 struct mca_config {
141 bool dont_log_ce;
142 bool cmci_disabled;
143 bool lmce_disabled;
144 bool ignore_ce;
145 bool disabled;
146 bool ser;
147 bool recovery;
148 bool bios_cmci_threshold;
149 u8 banks;
150 s8 bootlog;
151 int tolerant;
152 int monarch_timeout;
153 int panic_timeout;
154 u32 rip_msr;
155 };
156
157 struct mce_vendor_flags {
158 /*
159 * Indicates that overflow conditions are not fatal, when set.
160 */
161 __u64 overflow_recov : 1,
162
163 /*
164 * (AMD) SUCCOR stands for S/W UnCorrectable error COntainment and
165 * Recovery. It indicates support for data poisoning in HW and deferred
166 * error interrupts.
167 */
168 succor : 1,
169
170 /*
171 * (AMD) SMCA: This bit indicates support for Scalable MCA which expands
172 * the register space for each MCA bank and also increases number of
173 * banks. Also, to accommodate the new banks and registers, the MCA
174 * register space is moved to a new MSR range.
175 */
176 smca : 1,
177
178 __reserved_0 : 61;
179 };
180
181 struct mca_msr_regs {
182 u32 (*ctl) (int bank);
183 u32 (*status) (int bank);
184 u32 (*addr) (int bank);
185 u32 (*misc) (int bank);
186 };
187
188 extern struct mce_vendor_flags mce_flags;
189
190 extern struct mca_config mca_cfg;
191 extern struct mca_msr_regs msr_ops;
192 extern void mce_register_decode_chain(struct notifier_block *nb);
193 extern void mce_unregister_decode_chain(struct notifier_block *nb);
194
195 #include <linux/percpu.h>
196 #include <linux/atomic.h>
197
198 extern int mce_p5_enabled;
199
200 #ifdef CONFIG_X86_MCE
201 int mcheck_init(void);
202 void mcheck_cpu_init(struct cpuinfo_x86 *c);
203 void mcheck_cpu_clear(struct cpuinfo_x86 *c);
204 void mcheck_vendor_init_severity(void);
205 #else
206 static inline int mcheck_init(void) { return 0; }
207 static inline void mcheck_cpu_init(struct cpuinfo_x86 *c) {}
208 static inline void mcheck_cpu_clear(struct cpuinfo_x86 *c) {}
209 static inline void mcheck_vendor_init_severity(void) {}
210 #endif
211
212 #ifdef CONFIG_X86_ANCIENT_MCE
213 void intel_p5_mcheck_init(struct cpuinfo_x86 *c);
214 void winchip_mcheck_init(struct cpuinfo_x86 *c);
215 static inline void enable_p5_mce(void) { mce_p5_enabled = 1; }
216 #else
217 static inline void intel_p5_mcheck_init(struct cpuinfo_x86 *c) {}
218 static inline void winchip_mcheck_init(struct cpuinfo_x86 *c) {}
219 static inline void enable_p5_mce(void) {}
220 #endif
221
222 void mce_setup(struct mce *m);
223 void mce_log(struct mce *m);
224 DECLARE_PER_CPU(struct device *, mce_device);
225
226 /*
227 * Maximum banks number.
228 * This is the limit of the current register layout on
229 * Intel CPUs.
230 */
231 #define MAX_NR_BANKS 32
232
233 #ifdef CONFIG_X86_MCE_INTEL
234 void mce_intel_feature_init(struct cpuinfo_x86 *c);
235 void mce_intel_feature_clear(struct cpuinfo_x86 *c);
236 void cmci_clear(void);
237 void cmci_reenable(void);
238 void cmci_rediscover(void);
239 void cmci_recheck(void);
240 #else
241 static inline void mce_intel_feature_init(struct cpuinfo_x86 *c) { }
242 static inline void mce_intel_feature_clear(struct cpuinfo_x86 *c) { }
243 static inline void cmci_clear(void) {}
244 static inline void cmci_reenable(void) {}
245 static inline void cmci_rediscover(void) {}
246 static inline void cmci_recheck(void) {}
247 #endif
248
249 #ifdef CONFIG_X86_MCE_AMD
250 void mce_amd_feature_init(struct cpuinfo_x86 *c);
251 int umc_normaddr_to_sysaddr(u64 norm_addr, u16 nid, u8 umc, u64 *sys_addr);
252 #else
253 static inline void mce_amd_feature_init(struct cpuinfo_x86 *c) { }
254 static inline int umc_normaddr_to_sysaddr(u64 norm_addr, u16 nid, u8 umc, u64 *sys_addr) { return -EINVAL; };
255 #endif
256
257 int mce_available(struct cpuinfo_x86 *c);
258
259 DECLARE_PER_CPU(unsigned, mce_exception_count);
260 DECLARE_PER_CPU(unsigned, mce_poll_count);
261
262 typedef DECLARE_BITMAP(mce_banks_t, MAX_NR_BANKS);
263 DECLARE_PER_CPU(mce_banks_t, mce_poll_banks);
264
265 enum mcp_flags {
266 MCP_TIMESTAMP = BIT(0), /* log time stamp */
267 MCP_UC = BIT(1), /* log uncorrected errors */
268 MCP_DONTLOG = BIT(2), /* only clear, don't log */
269 };
270 bool machine_check_poll(enum mcp_flags flags, mce_banks_t *b);
271
272 int mce_notify_irq(void);
273
274 DECLARE_PER_CPU(struct mce, injectm);
275
276 extern void register_mce_write_callback(ssize_t (*)(struct file *filp,
277 const char __user *ubuf,
278 size_t usize, loff_t *off));
279
280 /* Disable CMCI/polling for MCA bank claimed by firmware */
281 extern void mce_disable_bank(int bank);
282
283 /*
284 * Exception handler
285 */
286
287 /* Call the installed machine check handler for this CPU setup. */
288 extern void (*machine_check_vector)(struct pt_regs *, long error_code);
289 void do_machine_check(struct pt_regs *, long);
290
291 /*
292 * Threshold handler
293 */
294 extern void (*mce_threshold_vector)(void);
295
296 /* Deferred error interrupt handler */
297 extern void (*deferred_error_int_vector)(void);
298
299 /*
300 * Thermal handler
301 */
302
303 void intel_init_thermal(struct cpuinfo_x86 *c);
304
305 /* Interrupt Handler for core thermal thresholds */
306 extern int (*platform_thermal_notify)(__u64 msr_val);
307
308 /* Interrupt Handler for package thermal thresholds */
309 extern int (*platform_thermal_package_notify)(__u64 msr_val);
310
311 /* Callback support of rate control, return true, if
312 * callback has rate control */
313 extern bool (*platform_thermal_package_rate_control)(void);
314
315 #ifdef CONFIG_X86_THERMAL_VECTOR
316 extern void mcheck_intel_therm_init(void);
317 #else
318 static inline void mcheck_intel_therm_init(void) { }
319 #endif
320
321 /*
322 * Used by APEI to report memory error via /dev/mcelog
323 */
324
325 struct cper_sec_mem_err;
326 extern void apei_mce_report_mem_error(int corrected,
327 struct cper_sec_mem_err *mem_err);
328
329 /*
330 * Enumerate new IP types and HWID values in AMD processors which support
331 * Scalable MCA.
332 */
333 #ifdef CONFIG_X86_MCE_AMD
334
335 /* These may be used by multiple smca_hwid_mcatypes */
336 enum smca_bank_types {
337 SMCA_LS = 0, /* Load Store */
338 SMCA_IF, /* Instruction Fetch */
339 SMCA_L2_CACHE, /* L2 Cache */
340 SMCA_DE, /* Decoder Unit */
341 SMCA_EX, /* Execution Unit */
342 SMCA_FP, /* Floating Point */
343 SMCA_L3_CACHE, /* L3 Cache */
344 SMCA_CS, /* Coherent Slave */
345 SMCA_PIE, /* Power, Interrupts, etc. */
346 SMCA_UMC, /* Unified Memory Controller */
347 SMCA_PB, /* Parameter Block */
348 SMCA_PSP, /* Platform Security Processor */
349 SMCA_SMU, /* System Management Unit */
350 N_SMCA_BANK_TYPES
351 };
352
353 #define HWID_MCATYPE(hwid, mcatype) (((hwid) << 16) | (mcatype))
354
355 struct smca_hwid {
356 unsigned int bank_type; /* Use with smca_bank_types for easy indexing. */
357 u32 hwid_mcatype; /* (hwid,mcatype) tuple */
358 u32 xec_bitmap; /* Bitmap of valid ExtErrorCodes; current max is 21. */
359 u8 count; /* Number of instances. */
360 };
361
362 struct smca_bank {
363 struct smca_hwid *hwid;
364 u32 id; /* Value of MCA_IPID[InstanceId]. */
365 u8 sysfs_id; /* Value used for sysfs name. */
366 };
367
368 extern struct smca_bank smca_banks[MAX_NR_BANKS];
369
370 extern const char *smca_get_long_name(enum smca_bank_types t);
371
372 extern int mce_threshold_create_device(unsigned int cpu);
373 extern int mce_threshold_remove_device(unsigned int cpu);
374
375 #else
376
377 static inline int mce_threshold_create_device(unsigned int cpu) { return 0; };
378 static inline int mce_threshold_remove_device(unsigned int cpu) { return 0; };
379
380 #endif
381
382 #endif /* _ASM_X86_MCE_H */