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