xref: /linux-6.15/include/linux/cper.h (revision 61eac5f7)
145051539SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
206d65deaSHuang Ying /*
306d65deaSHuang Ying  * UEFI Common Platform Error Record
406d65deaSHuang Ying  *
506d65deaSHuang Ying  * Copyright (C) 2010, Intel Corp.
606d65deaSHuang Ying  *	Author: Huang Ying <[email protected]>
706d65deaSHuang Ying  */
806d65deaSHuang Ying 
906d65deaSHuang Ying #ifndef LINUX_CPER_H
1006d65deaSHuang Ying #define LINUX_CPER_H
1106d65deaSHuang Ying 
1206d65deaSHuang Ying #include <linux/uuid.h>
132dfb7d51SChen, Gong #include <linux/trace_seq.h>
1406d65deaSHuang Ying 
1506d65deaSHuang Ying /* CPER record signature and the size */
1606d65deaSHuang Ying #define CPER_SIG_RECORD				"CPER"
1706d65deaSHuang Ying #define CPER_SIG_SIZE				4
1806d65deaSHuang Ying /* Used in signature_end field in struct cper_record_header */
1906d65deaSHuang Ying #define CPER_SIG_END				0xffffffff
2006d65deaSHuang Ying 
2106d65deaSHuang Ying /*
2206d65deaSHuang Ying  * CPER record header revision, used in revision field in struct
2306d65deaSHuang Ying  * cper_record_header
2406d65deaSHuang Ying  */
2506d65deaSHuang Ying #define CPER_RECORD_REV				0x0100
2606d65deaSHuang Ying 
2706d65deaSHuang Ying /*
283760cd20SChen, Gong  * CPER record length contains the CPER fields which are relevant for further
293760cd20SChen, Gong  * handling of a memory error in userspace (we don't carry all the fields
303760cd20SChen, Gong  * defined in the UEFI spec because some of them don't make any sense.)
313760cd20SChen, Gong  * Currently, a length of 256 should be more than enough.
323760cd20SChen, Gong  */
333760cd20SChen, Gong #define CPER_REC_LEN					256
343760cd20SChen, Gong /*
3512fa4f47SBjorn Helgaas  * Severity definition for error_severity in struct cper_record_header
3606d65deaSHuang Ying  * and section_severity in struct cper_section_descriptor
3706d65deaSHuang Ying  */
38c9aa308fSHuang Ying enum {
39c9aa308fSHuang Ying 	CPER_SEV_RECOVERABLE,
40c9aa308fSHuang Ying 	CPER_SEV_FATAL,
41c9aa308fSHuang Ying 	CPER_SEV_CORRECTED,
42c9aa308fSHuang Ying 	CPER_SEV_INFORMATIONAL,
43c9aa308fSHuang Ying };
4406d65deaSHuang Ying 
4506d65deaSHuang Ying /*
4612fa4f47SBjorn Helgaas  * Validation bits definition for validation_bits in struct
4706d65deaSHuang Ying  * cper_record_header. If set, corresponding fields in struct
4806d65deaSHuang Ying  * cper_record_header contain valid information.
4906d65deaSHuang Ying  */
5006d65deaSHuang Ying #define CPER_VALID_PLATFORM_ID			0x0001
5106d65deaSHuang Ying #define CPER_VALID_TIMESTAMP			0x0002
5206d65deaSHuang Ying #define CPER_VALID_PARTITION_ID			0x0004
5306d65deaSHuang Ying 
5406d65deaSHuang Ying /*
5506d65deaSHuang Ying  * Notification type used to generate error record, used in
5612fa4f47SBjorn Helgaas  * notification_type in struct cper_record_header.  These UUIDs are defined
5712fa4f47SBjorn Helgaas  * in the UEFI spec v2.7, sec N.2.1.
5806d65deaSHuang Ying  */
5912fa4f47SBjorn Helgaas 
6012fa4f47SBjorn Helgaas /* Corrected Machine Check */
6106d65deaSHuang Ying #define CPER_NOTIFY_CMC							\
62c0020756SAndy Shevchenko 	GUID_INIT(0x2DCE8BB1, 0xBDD7, 0x450e, 0xB9, 0xAD, 0x9C, 0xF4,	\
6306d65deaSHuang Ying 		  0xEB, 0xD4, 0xF8, 0x90)
6406d65deaSHuang Ying /* Corrected Platform Error */
6506d65deaSHuang Ying #define CPER_NOTIFY_CPE							\
66c0020756SAndy Shevchenko 	GUID_INIT(0x4E292F96, 0xD843, 0x4a55, 0xA8, 0xC2, 0xD4, 0x81,	\
6706d65deaSHuang Ying 		  0xF2, 0x7E, 0xBE, 0xEE)
6806d65deaSHuang Ying /* Machine Check Exception */
6906d65deaSHuang Ying #define CPER_NOTIFY_MCE							\
70c0020756SAndy Shevchenko 	GUID_INIT(0xE8F56FFE, 0x919C, 0x4cc5, 0xBA, 0x88, 0x65, 0xAB,	\
7106d65deaSHuang Ying 		  0xE1, 0x49, 0x13, 0xBB)
7206d65deaSHuang Ying /* PCI Express Error */
7306d65deaSHuang Ying #define CPER_NOTIFY_PCIE						\
74c0020756SAndy Shevchenko 	GUID_INIT(0xCF93C01F, 0x1A16, 0x4dfc, 0xB8, 0xBC, 0x9C, 0x4D,	\
7506d65deaSHuang Ying 		  0xAF, 0x67, 0xC1, 0x04)
7606d65deaSHuang Ying /* INIT Record (for IPF) */
7706d65deaSHuang Ying #define CPER_NOTIFY_INIT						\
78c0020756SAndy Shevchenko 	GUID_INIT(0xCC5263E8, 0x9308, 0x454a, 0x89, 0xD0, 0x34, 0x0B,	\
7906d65deaSHuang Ying 		  0xD3, 0x9B, 0xC9, 0x8E)
8006d65deaSHuang Ying /* Non-Maskable Interrupt */
8106d65deaSHuang Ying #define CPER_NOTIFY_NMI							\
82c0020756SAndy Shevchenko 	GUID_INIT(0x5BAD89FF, 0xB7E6, 0x42c9, 0x81, 0x4A, 0xCF, 0x24,	\
8306d65deaSHuang Ying 		  0x85, 0xD6, 0xE9, 0x8A)
8406d65deaSHuang Ying /* BOOT Error Record */
8506d65deaSHuang Ying #define CPER_NOTIFY_BOOT						\
86c0020756SAndy Shevchenko 	GUID_INIT(0x3D61A466, 0xAB40, 0x409a, 0xA6, 0x98, 0xF3, 0x62,	\
8706d65deaSHuang Ying 		  0xD4, 0x64, 0xB3, 0x8F)
8806d65deaSHuang Ying /* DMA Remapping Error */
8906d65deaSHuang Ying #define CPER_NOTIFY_DMAR						\
90c0020756SAndy Shevchenko 	GUID_INIT(0x667DD791, 0xC6B3, 0x4c27, 0x8A, 0x6B, 0x0F, 0x8E,	\
9106d65deaSHuang Ying 		  0x72, 0x2D, 0xEB, 0x41)
92958c3a67SSmita Koralahalli /* CXL Protocol Error Section */
93958c3a67SSmita Koralahalli #define CPER_SEC_CXL_PROT_ERR						\
94958c3a67SSmita Koralahalli 	GUID_INIT(0x80B9EFB4, 0x52B5, 0x4DE3, 0xA7, 0x77, 0x68, 0x78,	\
95958c3a67SSmita Koralahalli 		  0x4B, 0x77, 0x10, 0x48)
9606d65deaSHuang Ying 
9754ce1927SIra Weiny /* CXL Event record UUIDs are formatted as GUIDs and reported in section type */
9854ce1927SIra Weiny /*
9954ce1927SIra Weiny  * General Media Event Record
10054ce1927SIra Weiny  * CXL rev 3.0 Section 8.2.9.2.1.1; Table 8-43
10154ce1927SIra Weiny  */
10254ce1927SIra Weiny #define CPER_SEC_CXL_GEN_MEDIA_GUID					\
10354ce1927SIra Weiny 	GUID_INIT(0xfbcd0a77, 0xc260, 0x417f,				\
10454ce1927SIra Weiny 		  0x85, 0xa9, 0x08, 0x8b, 0x16, 0x21, 0xeb, 0xa6)
10554ce1927SIra Weiny /*
10654ce1927SIra Weiny  * DRAM Event Record
10754ce1927SIra Weiny  * CXL rev 3.0 section 8.2.9.2.1.2; Table 8-44
10854ce1927SIra Weiny  */
10954ce1927SIra Weiny #define CPER_SEC_CXL_DRAM_GUID						\
11054ce1927SIra Weiny 	GUID_INIT(0x601dcbb3, 0x9c06, 0x4eab,				\
11154ce1927SIra Weiny 		  0xb8, 0xaf, 0x4e, 0x9b, 0xfb, 0x5c, 0x96, 0x24)
11254ce1927SIra Weiny /*
11354ce1927SIra Weiny  * Memory Module Event Record
11454ce1927SIra Weiny  * CXL rev 3.0 section 8.2.9.2.1.3; Table 8-45
11554ce1927SIra Weiny  */
11654ce1927SIra Weiny #define CPER_SEC_CXL_MEM_MODULE_GUID					\
11754ce1927SIra Weiny 	GUID_INIT(0xfe927475, 0xdd59, 0x4339,				\
11854ce1927SIra Weiny 		  0xa5, 0x86, 0x79, 0xba, 0xb1, 0x13, 0xb7, 0x74)
11954ce1927SIra Weiny 
12006d65deaSHuang Ying /*
12106d65deaSHuang Ying  * Flags bits definitions for flags in struct cper_record_header
12206d65deaSHuang Ying  * If set, the error has been recovered
12306d65deaSHuang Ying  */
12406d65deaSHuang Ying #define CPER_HW_ERROR_FLAGS_RECOVERED		0x1
12506d65deaSHuang Ying /* If set, the error is for previous boot */
12606d65deaSHuang Ying #define CPER_HW_ERROR_FLAGS_PREVERR		0x2
12706d65deaSHuang Ying /* If set, the error is injected for testing */
12806d65deaSHuang Ying #define CPER_HW_ERROR_FLAGS_SIMULATED		0x4
12906d65deaSHuang Ying 
13006d65deaSHuang Ying /*
13106d65deaSHuang Ying  * CPER section header revision, used in revision field in struct
13206d65deaSHuang Ying  * cper_section_descriptor
13306d65deaSHuang Ying  */
13406d65deaSHuang Ying #define CPER_SEC_REV				0x0100
13506d65deaSHuang Ying 
13606d65deaSHuang Ying /*
13712fa4f47SBjorn Helgaas  * Validation bits definition for validation_bits in struct
13806d65deaSHuang Ying  * cper_section_descriptor. If set, corresponding fields in struct
13906d65deaSHuang Ying  * cper_section_descriptor contain valid information.
14006d65deaSHuang Ying  */
14106d65deaSHuang Ying #define CPER_SEC_VALID_FRU_ID			0x1
14206d65deaSHuang Ying #define CPER_SEC_VALID_FRU_TEXT			0x2
14306d65deaSHuang Ying 
14406d65deaSHuang Ying /*
14506d65deaSHuang Ying  * Flags bits definitions for flags in struct cper_section_descriptor
14606d65deaSHuang Ying  *
14706d65deaSHuang Ying  * If set, the section is associated with the error condition
14806d65deaSHuang Ying  * directly, and should be focused on
14906d65deaSHuang Ying  */
15006d65deaSHuang Ying #define CPER_SEC_PRIMARY			0x0001
15106d65deaSHuang Ying /*
15206d65deaSHuang Ying  * If set, the error was not contained within the processor or memory
15306d65deaSHuang Ying  * hierarchy and the error may have propagated to persistent storage
15406d65deaSHuang Ying  * or network
15506d65deaSHuang Ying  */
15606d65deaSHuang Ying #define CPER_SEC_CONTAINMENT_WARNING		0x0002
15706d65deaSHuang Ying /* If set, the component must be re-initialized or re-enabled prior to use */
15806d65deaSHuang Ying #define CPER_SEC_RESET				0x0004
15906d65deaSHuang Ying /* If set, Linux may choose to discontinue use of the resource */
16006d65deaSHuang Ying #define CPER_SEC_ERROR_THRESHOLD_EXCEEDED	0x0008
16106d65deaSHuang Ying /*
16206d65deaSHuang Ying  * If set, resource could not be queried for error information due to
16306d65deaSHuang Ying  * conflicts with other system software or resources. Some fields of
16406d65deaSHuang Ying  * the section will be invalid
16506d65deaSHuang Ying  */
16606d65deaSHuang Ying #define CPER_SEC_RESOURCE_NOT_ACCESSIBLE	0x0010
16706d65deaSHuang Ying /*
16806d65deaSHuang Ying  * If set, action has been taken to ensure error containment (such as
16906d65deaSHuang Ying  * poisoning data), but the error has not been fully corrected and the
17006d65deaSHuang Ying  * data has not been consumed. Linux may choose to take further
17106d65deaSHuang Ying  * corrective action before the data is consumed
17206d65deaSHuang Ying  */
17306d65deaSHuang Ying #define CPER_SEC_LATENT_ERROR			0x0020
17406d65deaSHuang Ying 
17506d65deaSHuang Ying /*
17606d65deaSHuang Ying  * Section type definitions, used in section_type field in struct
17712fa4f47SBjorn Helgaas  * cper_section_descriptor.  These UUIDs are defined in the UEFI spec
17812fa4f47SBjorn Helgaas  * v2.7, sec N.2.2.
17906d65deaSHuang Ying  */
18012fa4f47SBjorn Helgaas 
18112fa4f47SBjorn Helgaas /* Processor Generic */
18206d65deaSHuang Ying #define CPER_SEC_PROC_GENERIC						\
183c0020756SAndy Shevchenko 	GUID_INIT(0x9876CCAD, 0x47B4, 0x4bdb, 0xB6, 0x5E, 0x16, 0xF1,	\
18406d65deaSHuang Ying 		  0x93, 0xC4, 0xF3, 0xDB)
18506d65deaSHuang Ying /* Processor Specific: X86/X86_64 */
18606d65deaSHuang Ying #define CPER_SEC_PROC_IA						\
187c0020756SAndy Shevchenko 	GUID_INIT(0xDC3EA0B0, 0xA144, 0x4797, 0xB9, 0x5B, 0x53, 0xFA,	\
18806d65deaSHuang Ying 		  0x24, 0x2B, 0x6E, 0x1D)
18906d65deaSHuang Ying /* Processor Specific: IA64 */
19006d65deaSHuang Ying #define CPER_SEC_PROC_IPF						\
191c0020756SAndy Shevchenko 	GUID_INIT(0xE429FAF1, 0x3CB7, 0x11D4, 0x0B, 0xCA, 0x07, 0x00,	\
19206d65deaSHuang Ying 		  0x80, 0xC7, 0x3C, 0x88, 0x81)
1932f74f09bSTyler Baicar /* Processor Specific: ARM */
1942f74f09bSTyler Baicar #define CPER_SEC_PROC_ARM						\
195c0020756SAndy Shevchenko 	GUID_INIT(0xE19E3D16, 0xBC11, 0x11E4, 0x9C, 0xAA, 0xC2, 0x05,	\
1962f74f09bSTyler Baicar 		  0x1D, 0x5D, 0x46, 0xB0)
19706d65deaSHuang Ying /* Platform Memory */
19806d65deaSHuang Ying #define CPER_SEC_PLATFORM_MEM						\
199c0020756SAndy Shevchenko 	GUID_INIT(0xA5BC1114, 0x6F64, 0x4EDE, 0xB8, 0x63, 0x3E, 0x83,	\
20006d65deaSHuang Ying 		  0xED, 0x7C, 0x83, 0xB1)
20106d65deaSHuang Ying #define CPER_SEC_PCIE							\
202c0020756SAndy Shevchenko 	GUID_INIT(0xD995E954, 0xBBC1, 0x430F, 0xAD, 0x91, 0xB4, 0x4D,	\
20306d65deaSHuang Ying 		  0xCB, 0x3C, 0x6F, 0x35)
20406d65deaSHuang Ying /* Firmware Error Record Reference */
20506d65deaSHuang Ying #define CPER_SEC_FW_ERR_REC_REF						\
206c0020756SAndy Shevchenko 	GUID_INIT(0x81212A96, 0x09ED, 0x4996, 0x94, 0x71, 0x8D, 0x72,	\
20706d65deaSHuang Ying 		  0x9C, 0x8E, 0x69, 0xED)
20806d65deaSHuang Ying /* PCI/PCI-X Bus */
20906d65deaSHuang Ying #define CPER_SEC_PCI_X_BUS						\
210c0020756SAndy Shevchenko 	GUID_INIT(0xC5753963, 0x3B84, 0x4095, 0xBF, 0x78, 0xED, 0xDA,	\
21106d65deaSHuang Ying 		  0xD3, 0xF9, 0xC9, 0xDD)
21206d65deaSHuang Ying /* PCI Component/Device */
21306d65deaSHuang Ying #define CPER_SEC_PCI_DEV						\
214c0020756SAndy Shevchenko 	GUID_INIT(0xEB5E4685, 0xCA66, 0x4769, 0xB6, 0xA2, 0x26, 0x06,	\
21506d65deaSHuang Ying 		  0x8B, 0x00, 0x13, 0x26)
21606d65deaSHuang Ying #define CPER_SEC_DMAR_GENERIC						\
217c0020756SAndy Shevchenko 	GUID_INIT(0x5B51FEF7, 0xC79D, 0x4434, 0x8F, 0x1B, 0xAA, 0x62,	\
21806d65deaSHuang Ying 		  0xDE, 0x3E, 0x2C, 0x64)
21906d65deaSHuang Ying /* Intel VT for Directed I/O specific DMAr */
22006d65deaSHuang Ying #define CPER_SEC_DMAR_VT						\
221c0020756SAndy Shevchenko 	GUID_INIT(0x71761D37, 0x32B2, 0x45cd, 0xA7, 0xD0, 0xB0, 0xFE,	\
22206d65deaSHuang Ying 		  0xDD, 0x93, 0xE8, 0xCF)
22306d65deaSHuang Ying /* IOMMU specific DMAr */
22406d65deaSHuang Ying #define CPER_SEC_DMAR_IOMMU						\
225c0020756SAndy Shevchenko 	GUID_INIT(0x036F84E1, 0x7F37, 0x428c, 0xA7, 0x9E, 0x57, 0x5F,	\
22606d65deaSHuang Ying 		  0xDF, 0xAA, 0x84, 0xEC)
22706d65deaSHuang Ying 
228c9aa308fSHuang Ying #define CPER_PROC_VALID_TYPE			0x0001
229c9aa308fSHuang Ying #define CPER_PROC_VALID_ISA			0x0002
230c9aa308fSHuang Ying #define CPER_PROC_VALID_ERROR_TYPE		0x0004
231c9aa308fSHuang Ying #define CPER_PROC_VALID_OPERATION		0x0008
232c9aa308fSHuang Ying #define CPER_PROC_VALID_FLAGS			0x0010
233c9aa308fSHuang Ying #define CPER_PROC_VALID_LEVEL			0x0020
234c9aa308fSHuang Ying #define CPER_PROC_VALID_VERSION			0x0040
235c9aa308fSHuang Ying #define CPER_PROC_VALID_BRAND_INFO		0x0080
236c9aa308fSHuang Ying #define CPER_PROC_VALID_ID			0x0100
237c9aa308fSHuang Ying #define CPER_PROC_VALID_TARGET_ADDRESS		0x0200
238c9aa308fSHuang Ying #define CPER_PROC_VALID_REQUESTOR_ID		0x0400
239c9aa308fSHuang Ying #define CPER_PROC_VALID_RESPONDER_ID		0x0800
240c9aa308fSHuang Ying #define CPER_PROC_VALID_IP			0x1000
241c9aa308fSHuang Ying 
242c9aa308fSHuang Ying #define CPER_MEM_VALID_ERROR_STATUS		0x0001
243147de147SChen, Gong #define CPER_MEM_VALID_PA			0x0002
244147de147SChen, Gong #define CPER_MEM_VALID_PA_MASK			0x0004
245c9aa308fSHuang Ying #define CPER_MEM_VALID_NODE			0x0008
246c9aa308fSHuang Ying #define CPER_MEM_VALID_CARD			0x0010
247c9aa308fSHuang Ying #define CPER_MEM_VALID_MODULE			0x0020
248c9aa308fSHuang Ying #define CPER_MEM_VALID_BANK			0x0040
249c9aa308fSHuang Ying #define CPER_MEM_VALID_DEVICE			0x0080
250c9aa308fSHuang Ying #define CPER_MEM_VALID_ROW			0x0100
251c9aa308fSHuang Ying #define CPER_MEM_VALID_COLUMN			0x0200
252c9aa308fSHuang Ying #define CPER_MEM_VALID_BIT_POSITION		0x0400
253c9aa308fSHuang Ying #define CPER_MEM_VALID_REQUESTOR_ID		0x0800
254c9aa308fSHuang Ying #define CPER_MEM_VALID_RESPONDER_ID		0x1000
255c9aa308fSHuang Ying #define CPER_MEM_VALID_TARGET_ID		0x2000
256c9aa308fSHuang Ying #define CPER_MEM_VALID_ERROR_TYPE		0x4000
257147de147SChen, Gong #define CPER_MEM_VALID_RANK_NUMBER		0x8000
258147de147SChen, Gong #define CPER_MEM_VALID_CARD_HANDLE		0x10000
259147de147SChen, Gong #define CPER_MEM_VALID_MODULE_HANDLE		0x20000
2609baf68ccSAlex Kluver #define CPER_MEM_VALID_ROW_EXT			0x40000
261612b5d50SAlex Kluver #define CPER_MEM_VALID_BANK_GROUP		0x80000
262612b5d50SAlex Kluver #define CPER_MEM_VALID_BANK_ADDRESS		0x100000
263612b5d50SAlex Kluver #define CPER_MEM_VALID_CHIP_ID			0x200000
2649baf68ccSAlex Kluver 
2659baf68ccSAlex Kluver #define CPER_MEM_EXT_ROW_MASK			0x3
2669baf68ccSAlex Kluver #define CPER_MEM_EXT_ROW_SHIFT			16
267c9aa308fSHuang Ying 
268612b5d50SAlex Kluver #define CPER_MEM_BANK_ADDRESS_MASK		0xff
269612b5d50SAlex Kluver #define CPER_MEM_BANK_GROUP_SHIFT		8
270612b5d50SAlex Kluver 
271612b5d50SAlex Kluver #define CPER_MEM_CHIP_ID_SHIFT			5
272612b5d50SAlex Kluver 
273c9aa308fSHuang Ying #define CPER_PCIE_VALID_PORT_TYPE		0x0001
274c9aa308fSHuang Ying #define CPER_PCIE_VALID_VERSION			0x0002
275c9aa308fSHuang Ying #define CPER_PCIE_VALID_COMMAND_STATUS		0x0004
276c9aa308fSHuang Ying #define CPER_PCIE_VALID_DEVICE_ID		0x0008
277c9aa308fSHuang Ying #define CPER_PCIE_VALID_SERIAL_NUMBER		0x0010
278c9aa308fSHuang Ying #define CPER_PCIE_VALID_BRIDGE_CONTROL_STATUS	0x0020
279c9aa308fSHuang Ying #define CPER_PCIE_VALID_CAPABILITY		0x0040
280c9aa308fSHuang Ying #define CPER_PCIE_VALID_AER_INFO		0x0080
281c9aa308fSHuang Ying 
282c9aa308fSHuang Ying #define CPER_PCIE_SLOT_SHIFT			3
283c9aa308fSHuang Ying 
2842f74f09bSTyler Baicar #define CPER_ARM_VALID_MPIDR			BIT(0)
2852f74f09bSTyler Baicar #define CPER_ARM_VALID_AFFINITY_LEVEL		BIT(1)
2862f74f09bSTyler Baicar #define CPER_ARM_VALID_RUNNING_STATE		BIT(2)
2872f74f09bSTyler Baicar #define CPER_ARM_VALID_VENDOR_INFO		BIT(3)
2882f74f09bSTyler Baicar 
2892f74f09bSTyler Baicar #define CPER_ARM_INFO_VALID_MULTI_ERR		BIT(0)
2902f74f09bSTyler Baicar #define CPER_ARM_INFO_VALID_FLAGS		BIT(1)
2912f74f09bSTyler Baicar #define CPER_ARM_INFO_VALID_ERR_INFO		BIT(2)
2922f74f09bSTyler Baicar #define CPER_ARM_INFO_VALID_VIRT_ADDR		BIT(3)
2932f74f09bSTyler Baicar #define CPER_ARM_INFO_VALID_PHYSICAL_ADDR	BIT(4)
2942f74f09bSTyler Baicar 
2952f74f09bSTyler Baicar #define CPER_ARM_INFO_FLAGS_FIRST		BIT(0)
2962f74f09bSTyler Baicar #define CPER_ARM_INFO_FLAGS_LAST		BIT(1)
2972f74f09bSTyler Baicar #define CPER_ARM_INFO_FLAGS_PROPAGATED		BIT(2)
2982f74f09bSTyler Baicar #define CPER_ARM_INFO_FLAGS_OVERFLOW		BIT(3)
2992f74f09bSTyler Baicar 
300301f55b1STyler Baicar #define CPER_ARM_CACHE_ERROR			0
301301f55b1STyler Baicar #define CPER_ARM_TLB_ERROR			1
302301f55b1STyler Baicar #define CPER_ARM_BUS_ERROR			2
303301f55b1STyler Baicar #define CPER_ARM_VENDOR_ERROR			3
304301f55b1STyler Baicar #define CPER_ARM_MAX_TYPE			CPER_ARM_VENDOR_ERROR
305301f55b1STyler Baicar 
306301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_TRANSACTION_TYPE	BIT(0)
307301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_OPERATION_TYPE	BIT(1)
308301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_LEVEL		BIT(2)
309301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_PROC_CONTEXT_CORRUPT	BIT(3)
310301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_CORRECTED		BIT(4)
311301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_PRECISE_PC		BIT(5)
312301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_RESTARTABLE_PC	BIT(6)
313301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_PARTICIPATION_TYPE	BIT(7)
314301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_TIME_OUT		BIT(8)
315301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_ADDRESS_SPACE	BIT(9)
316301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_MEM_ATTRIBUTES	BIT(10)
317301f55b1STyler Baicar #define CPER_ARM_ERR_VALID_ACCESS_MODE		BIT(11)
318301f55b1STyler Baicar 
319301f55b1STyler Baicar #define CPER_ARM_ERR_TRANSACTION_SHIFT		16
320301f55b1STyler Baicar #define CPER_ARM_ERR_TRANSACTION_MASK		GENMASK(1,0)
321301f55b1STyler Baicar #define CPER_ARM_ERR_OPERATION_SHIFT		18
322301f55b1STyler Baicar #define CPER_ARM_ERR_OPERATION_MASK		GENMASK(3,0)
323301f55b1STyler Baicar #define CPER_ARM_ERR_LEVEL_SHIFT		22
324301f55b1STyler Baicar #define CPER_ARM_ERR_LEVEL_MASK			GENMASK(2,0)
325301f55b1STyler Baicar #define CPER_ARM_ERR_PC_CORRUPT_SHIFT		25
326301f55b1STyler Baicar #define CPER_ARM_ERR_PC_CORRUPT_MASK		GENMASK(0,0)
327301f55b1STyler Baicar #define CPER_ARM_ERR_CORRECTED_SHIFT		26
328301f55b1STyler Baicar #define CPER_ARM_ERR_CORRECTED_MASK		GENMASK(0,0)
329301f55b1STyler Baicar #define CPER_ARM_ERR_PRECISE_PC_SHIFT		27
330301f55b1STyler Baicar #define CPER_ARM_ERR_PRECISE_PC_MASK		GENMASK(0,0)
331301f55b1STyler Baicar #define CPER_ARM_ERR_RESTARTABLE_PC_SHIFT	28
332301f55b1STyler Baicar #define CPER_ARM_ERR_RESTARTABLE_PC_MASK	GENMASK(0,0)
333301f55b1STyler Baicar #define CPER_ARM_ERR_PARTICIPATION_TYPE_SHIFT	29
334301f55b1STyler Baicar #define CPER_ARM_ERR_PARTICIPATION_TYPE_MASK	GENMASK(1,0)
335301f55b1STyler Baicar #define CPER_ARM_ERR_TIME_OUT_SHIFT		31
336301f55b1STyler Baicar #define CPER_ARM_ERR_TIME_OUT_MASK		GENMASK(0,0)
337301f55b1STyler Baicar #define CPER_ARM_ERR_ADDRESS_SPACE_SHIFT	32
338301f55b1STyler Baicar #define CPER_ARM_ERR_ADDRESS_SPACE_MASK		GENMASK(1,0)
339301f55b1STyler Baicar #define CPER_ARM_ERR_MEM_ATTRIBUTES_SHIFT	34
340301f55b1STyler Baicar #define CPER_ARM_ERR_MEM_ATTRIBUTES_MASK	GENMASK(8,0)
341301f55b1STyler Baicar #define CPER_ARM_ERR_ACCESS_MODE_SHIFT		43
342301f55b1STyler Baicar #define CPER_ARM_ERR_ACCESS_MODE_MASK		GENMASK(0,0)
343301f55b1STyler Baicar 
34406d65deaSHuang Ying /*
34506d65deaSHuang Ying  * All tables and structs must be byte-packed to match CPER
34606d65deaSHuang Ying  * specification, since the tables are provided by the system BIOS
34706d65deaSHuang Ying  */
34806d65deaSHuang Ying #pragma pack(1)
34906d65deaSHuang Ying 
35012fa4f47SBjorn Helgaas /* Record Header, UEFI v2.7 sec N.2.1 */
35106d65deaSHuang Ying struct cper_record_header {
35206d65deaSHuang Ying 	char	signature[CPER_SIG_SIZE];	/* must be CPER_SIG_RECORD */
353113fb03eSBjorn Helgaas 	u16	revision;			/* must be CPER_RECORD_REV */
354113fb03eSBjorn Helgaas 	u32	signature_end;			/* must be CPER_SIG_END */
355113fb03eSBjorn Helgaas 	u16	section_count;
356113fb03eSBjorn Helgaas 	u32	error_severity;
357113fb03eSBjorn Helgaas 	u32	validation_bits;
358113fb03eSBjorn Helgaas 	u32	record_length;
359113fb03eSBjorn Helgaas 	u64	timestamp;
360c0020756SAndy Shevchenko 	guid_t	platform_id;
361c0020756SAndy Shevchenko 	guid_t	partition_id;
362c0020756SAndy Shevchenko 	guid_t	creator_id;
363c0020756SAndy Shevchenko 	guid_t	notification_type;
364113fb03eSBjorn Helgaas 	u64	record_id;
365113fb03eSBjorn Helgaas 	u32	flags;
366113fb03eSBjorn Helgaas 	u64	persistence_information;
367113fb03eSBjorn Helgaas 	u8	reserved[12];			/* must be zero */
36806d65deaSHuang Ying };
36906d65deaSHuang Ying 
37012fa4f47SBjorn Helgaas /* Section Descriptor, UEFI v2.7 sec N.2.2 */
37106d65deaSHuang Ying struct cper_section_descriptor {
372113fb03eSBjorn Helgaas 	u32	section_offset;		/* Offset in bytes of the
37306d65deaSHuang Ying 					 *  section body from the base
37406d65deaSHuang Ying 					 *  of the record header */
375113fb03eSBjorn Helgaas 	u32	section_length;
376113fb03eSBjorn Helgaas 	u16	revision;		/* must be CPER_RECORD_REV */
377113fb03eSBjorn Helgaas 	u8	validation_bits;
378113fb03eSBjorn Helgaas 	u8	reserved;		/* must be zero */
379113fb03eSBjorn Helgaas 	u32	flags;
380c0020756SAndy Shevchenko 	guid_t	section_type;
381c0020756SAndy Shevchenko 	guid_t	fru_id;
382113fb03eSBjorn Helgaas 	u32	section_severity;
383113fb03eSBjorn Helgaas 	u8	fru_text[20];
38406d65deaSHuang Ying };
38506d65deaSHuang Ying 
38612fa4f47SBjorn Helgaas /* Generic Processor Error Section, UEFI v2.7 sec N.2.4.1 */
38706d65deaSHuang Ying struct cper_sec_proc_generic {
388113fb03eSBjorn Helgaas 	u64	validation_bits;
389113fb03eSBjorn Helgaas 	u8	proc_type;
390113fb03eSBjorn Helgaas 	u8	proc_isa;
391113fb03eSBjorn Helgaas 	u8	proc_error_type;
392113fb03eSBjorn Helgaas 	u8	operation;
393113fb03eSBjorn Helgaas 	u8	flags;
394113fb03eSBjorn Helgaas 	u8	level;
395113fb03eSBjorn Helgaas 	u16	reserved;
396113fb03eSBjorn Helgaas 	u64	cpu_version;
39706d65deaSHuang Ying 	char	cpu_brand[128];
398113fb03eSBjorn Helgaas 	u64	proc_id;
399113fb03eSBjorn Helgaas 	u64	target_addr;
400113fb03eSBjorn Helgaas 	u64	requestor_id;
401113fb03eSBjorn Helgaas 	u64	responder_id;
402113fb03eSBjorn Helgaas 	u64	ip;
40306d65deaSHuang Ying };
40406d65deaSHuang Ying 
40512fa4f47SBjorn Helgaas /* IA32/X64 Processor Error Section, UEFI v2.7 sec N.2.4.2 */
40606d65deaSHuang Ying struct cper_sec_proc_ia {
407113fb03eSBjorn Helgaas 	u64	validation_bits;
408113fb03eSBjorn Helgaas 	u64	lapic_id;
409113fb03eSBjorn Helgaas 	u8	cpuid[48];
41006d65deaSHuang Ying };
41106d65deaSHuang Ying 
41212fa4f47SBjorn Helgaas /* IA32/X64 Processor Error Information Structure, UEFI v2.7 sec N.2.4.2.1 */
41306d65deaSHuang Ying struct cper_ia_err_info {
414c0020756SAndy Shevchenko 	guid_t	err_type;
415113fb03eSBjorn Helgaas 	u64	validation_bits;
416113fb03eSBjorn Helgaas 	u64	check_info;
417113fb03eSBjorn Helgaas 	u64	target_id;
418113fb03eSBjorn Helgaas 	u64	requestor_id;
419113fb03eSBjorn Helgaas 	u64	responder_id;
420113fb03eSBjorn Helgaas 	u64	ip;
42106d65deaSHuang Ying };
42206d65deaSHuang Ying 
42312fa4f47SBjorn Helgaas /* IA32/X64 Processor Context Information Structure, UEFI v2.7 sec N.2.4.2.2 */
42406d65deaSHuang Ying struct cper_ia_proc_ctx {
425113fb03eSBjorn Helgaas 	u16	reg_ctx_type;
426113fb03eSBjorn Helgaas 	u16	reg_arr_size;
427113fb03eSBjorn Helgaas 	u32	msr_addr;
428113fb03eSBjorn Helgaas 	u64	mm_reg_addr;
42906d65deaSHuang Ying };
43006d65deaSHuang Ying 
43112fa4f47SBjorn Helgaas /* ARM Processor Error Section, UEFI v2.7 sec N.2.4.4 */
4322f74f09bSTyler Baicar struct cper_sec_proc_arm {
433113fb03eSBjorn Helgaas 	u32	validation_bits;
434113fb03eSBjorn Helgaas 	u16	err_info_num;		/* Number of Processor Error Info */
435113fb03eSBjorn Helgaas 	u16	context_info_num;	/* Number of Processor Context Info Records*/
436113fb03eSBjorn Helgaas 	u32	section_length;
437113fb03eSBjorn Helgaas 	u8	affinity_level;
438113fb03eSBjorn Helgaas 	u8	reserved[3];		/* must be zero */
439113fb03eSBjorn Helgaas 	u64	mpidr;
440113fb03eSBjorn Helgaas 	u64	midr;
441113fb03eSBjorn Helgaas 	u32	running_state;		/* Bit 0 set - Processor running. PSCI = 0 */
442113fb03eSBjorn Helgaas 	u32	psci_state;
4432f74f09bSTyler Baicar };
4442f74f09bSTyler Baicar 
44512fa4f47SBjorn Helgaas /* ARM Processor Error Information Structure, UEFI v2.7 sec N.2.4.4.1 */
4462f74f09bSTyler Baicar struct cper_arm_err_info {
447113fb03eSBjorn Helgaas 	u8	version;
448113fb03eSBjorn Helgaas 	u8	length;
449113fb03eSBjorn Helgaas 	u16	validation_bits;
450113fb03eSBjorn Helgaas 	u8	type;
451113fb03eSBjorn Helgaas 	u16	multiple_error;
452113fb03eSBjorn Helgaas 	u8	flags;
453113fb03eSBjorn Helgaas 	u64	error_info;
454113fb03eSBjorn Helgaas 	u64	virt_fault_addr;
455113fb03eSBjorn Helgaas 	u64	physical_fault_addr;
4562f74f09bSTyler Baicar };
4572f74f09bSTyler Baicar 
45812fa4f47SBjorn Helgaas /* ARM Processor Context Information Structure, UEFI v2.7 sec N.2.4.4.2 */
4592f74f09bSTyler Baicar struct cper_arm_ctx_info {
460113fb03eSBjorn Helgaas 	u16	version;
461113fb03eSBjorn Helgaas 	u16	type;
462113fb03eSBjorn Helgaas 	u32	size;
4632f74f09bSTyler Baicar };
4642f74f09bSTyler Baicar 
46512fa4f47SBjorn Helgaas /* Old Memory Error Section, UEFI v2.1, v2.2 */
4664c62360dSLuck, Tony struct cper_sec_mem_err_old {
467113fb03eSBjorn Helgaas 	u64	validation_bits;
468113fb03eSBjorn Helgaas 	u64	error_status;
469113fb03eSBjorn Helgaas 	u64	physical_addr;
470113fb03eSBjorn Helgaas 	u64	physical_addr_mask;
471113fb03eSBjorn Helgaas 	u16	node;
472113fb03eSBjorn Helgaas 	u16	card;
473113fb03eSBjorn Helgaas 	u16	module;
474113fb03eSBjorn Helgaas 	u16	bank;
475113fb03eSBjorn Helgaas 	u16	device;
476113fb03eSBjorn Helgaas 	u16	row;
477113fb03eSBjorn Helgaas 	u16	column;
478113fb03eSBjorn Helgaas 	u16	bit_pos;
479113fb03eSBjorn Helgaas 	u64	requestor_id;
480113fb03eSBjorn Helgaas 	u64	responder_id;
481113fb03eSBjorn Helgaas 	u64	target_id;
482113fb03eSBjorn Helgaas 	u8	error_type;
4834c62360dSLuck, Tony };
4844c62360dSLuck, Tony 
4859baf68ccSAlex Kluver /* Memory Error Section (UEFI >= v2.3), UEFI v2.8 sec N.2.5 */
48606d65deaSHuang Ying struct cper_sec_mem_err {
487113fb03eSBjorn Helgaas 	u64	validation_bits;
488113fb03eSBjorn Helgaas 	u64	error_status;
489113fb03eSBjorn Helgaas 	u64	physical_addr;
490113fb03eSBjorn Helgaas 	u64	physical_addr_mask;
491113fb03eSBjorn Helgaas 	u16	node;
492113fb03eSBjorn Helgaas 	u16	card;
493113fb03eSBjorn Helgaas 	u16	module;
494113fb03eSBjorn Helgaas 	u16	bank;
495113fb03eSBjorn Helgaas 	u16	device;
496113fb03eSBjorn Helgaas 	u16	row;
497113fb03eSBjorn Helgaas 	u16	column;
498113fb03eSBjorn Helgaas 	u16	bit_pos;
499113fb03eSBjorn Helgaas 	u64	requestor_id;
500113fb03eSBjorn Helgaas 	u64	responder_id;
501113fb03eSBjorn Helgaas 	u64	target_id;
502113fb03eSBjorn Helgaas 	u8	error_type;
5039baf68ccSAlex Kluver 	u8	extended;
504113fb03eSBjorn Helgaas 	u16	rank;
505113fb03eSBjorn Helgaas 	u16	mem_array_handle;	/* "card handle" in UEFI 2.4 */
506113fb03eSBjorn Helgaas 	u16	mem_dev_handle;		/* "module handle" in UEFI 2.4 */
50706d65deaSHuang Ying };
50806d65deaSHuang Ying 
5092dfb7d51SChen, Gong struct cper_mem_err_compact {
510113fb03eSBjorn Helgaas 	u64	validation_bits;
511113fb03eSBjorn Helgaas 	u16	node;
512113fb03eSBjorn Helgaas 	u16	card;
513113fb03eSBjorn Helgaas 	u16	module;
514113fb03eSBjorn Helgaas 	u16	bank;
515113fb03eSBjorn Helgaas 	u16	device;
516113fb03eSBjorn Helgaas 	u16	row;
517113fb03eSBjorn Helgaas 	u16	column;
518113fb03eSBjorn Helgaas 	u16	bit_pos;
519113fb03eSBjorn Helgaas 	u64	requestor_id;
520113fb03eSBjorn Helgaas 	u64	responder_id;
521113fb03eSBjorn Helgaas 	u64	target_id;
522113fb03eSBjorn Helgaas 	u16	rank;
523113fb03eSBjorn Helgaas 	u16	mem_array_handle;
524113fb03eSBjorn Helgaas 	u16	mem_dev_handle;
5259baf68ccSAlex Kluver 	u8      extended;
5262dfb7d51SChen, Gong };
5272dfb7d51SChen, Gong 
cper_get_mem_extension(u64 mem_valid,u8 mem_extended)5289baf68ccSAlex Kluver static inline u32 cper_get_mem_extension(u64 mem_valid, u8 mem_extended)
5299baf68ccSAlex Kluver {
5309baf68ccSAlex Kluver 	if (!(mem_valid & CPER_MEM_VALID_ROW_EXT))
5319baf68ccSAlex Kluver 		return 0;
5329baf68ccSAlex Kluver 	return (mem_extended & CPER_MEM_EXT_ROW_MASK) << CPER_MEM_EXT_ROW_SHIFT;
5339baf68ccSAlex Kluver }
5349baf68ccSAlex Kluver 
53512fa4f47SBjorn Helgaas /* PCI Express Error Section, UEFI v2.7 sec N.2.7 */
536c9aa308fSHuang Ying struct cper_sec_pcie {
537113fb03eSBjorn Helgaas 	u64		validation_bits;
538113fb03eSBjorn Helgaas 	u32		port_type;
539c9aa308fSHuang Ying 	struct {
540113fb03eSBjorn Helgaas 		u8	minor;
541113fb03eSBjorn Helgaas 		u8	major;
542113fb03eSBjorn Helgaas 		u8	reserved[2];
543c9aa308fSHuang Ying 	}		version;
544113fb03eSBjorn Helgaas 	u16		command;
545113fb03eSBjorn Helgaas 	u16		status;
546113fb03eSBjorn Helgaas 	u32		reserved;
547c9aa308fSHuang Ying 	struct {
548113fb03eSBjorn Helgaas 		u16	vendor_id;
549113fb03eSBjorn Helgaas 		u16	device_id;
550113fb03eSBjorn Helgaas 		u8	class_code[3];
551113fb03eSBjorn Helgaas 		u8	function;
552113fb03eSBjorn Helgaas 		u8	device;
553113fb03eSBjorn Helgaas 		u16	segment;
554113fb03eSBjorn Helgaas 		u8	bus;
555113fb03eSBjorn Helgaas 		u8	secondary_bus;
556113fb03eSBjorn Helgaas 		u16	slot;
557113fb03eSBjorn Helgaas 		u8	reserved;
558c9aa308fSHuang Ying 	}		device_id;
559c9aa308fSHuang Ying 	struct {
560113fb03eSBjorn Helgaas 		u32	lower;
561113fb03eSBjorn Helgaas 		u32	upper;
562c9aa308fSHuang Ying 	}		serial_number;
563c9aa308fSHuang Ying 	struct {
564113fb03eSBjorn Helgaas 		u16	secondary_status;
565113fb03eSBjorn Helgaas 		u16	control;
566c9aa308fSHuang Ying 	}		bridge;
567113fb03eSBjorn Helgaas 	u8	capability[60];
568113fb03eSBjorn Helgaas 	u8	aer_info[96];
569c9aa308fSHuang Ying };
570c9aa308fSHuang Ying 
5713d8c11efSPunit Agrawal /* Firmware Error Record Reference, UEFI v2.7 sec N.2.10  */
5723d8c11efSPunit Agrawal struct cper_sec_fw_err_rec_ref {
5733d8c11efSPunit Agrawal 	u8 record_type;
5743d8c11efSPunit Agrawal 	u8 revision;
5753d8c11efSPunit Agrawal 	u8 reserved[6];
5763d8c11efSPunit Agrawal 	u64 record_identifier;
5773d8c11efSPunit Agrawal 	guid_t record_identifier_guid;
5783d8c11efSPunit Agrawal };
5793d8c11efSPunit Agrawal 
58006d65deaSHuang Ying /* Reset to default packing */
58106d65deaSHuang Ying #pragma pack()
58206d65deaSHuang Ying 
583c6d8c8efSTyler Baicar extern const char *const cper_proc_error_type_strs[4];
584c6d8c8efSTyler Baicar 
58506d65deaSHuang Ying u64 cper_next_record_id(void);
5863760cd20SChen, Gong const char *cper_severity_str(unsigned int);
5873760cd20SChen, Gong const char *cper_mem_err_type_str(unsigned int);
588bdae7965SShuai Xue const char *cper_mem_err_status_str(u64 status);
589c413d768SHuang Ying void cper_print_bits(const char *prefix, unsigned int bits,
59088f074f4SChen, Gong 		     const char * const strs[], unsigned int strs_size);
5912dfb7d51SChen, Gong void cper_mem_err_pack(const struct cper_sec_mem_err *,
5922dfb7d51SChen, Gong 		       struct cper_mem_err_compact *);
5932dfb7d51SChen, Gong const char *cper_mem_err_unpack(struct trace_seq *,
5942dfb7d51SChen, Gong 				struct cper_mem_err_compact *);
595c6d8c8efSTyler Baicar void cper_print_proc_arm(const char *pfx,
596c6d8c8efSTyler Baicar 			 const struct cper_sec_proc_arm *proc);
597f9e1bdb9SYazen Ghannam void cper_print_proc_ia(const char *pfx,
598f9e1bdb9SYazen Ghannam 			const struct cper_sec_proc_ia *proc);
599ed27b5dfSShuai Xue int cper_mem_err_location(struct cper_mem_err_compact *mem, char *msg);
600ed27b5dfSShuai Xue int cper_dimm_err_location(struct cper_mem_err_compact *mem, char *msg);
60106d65deaSHuang Ying 
602fd936fd8SArnd Bergmann struct acpi_hest_generic_status;
603fd936fd8SArnd Bergmann void cper_estatus_print(const char *pfx,
604fd936fd8SArnd Bergmann 			const struct acpi_hest_generic_status *estatus);
605fd936fd8SArnd Bergmann int cper_estatus_check_header(const struct acpi_hest_generic_status *estatus);
606fd936fd8SArnd Bergmann int cper_estatus_check(const struct acpi_hest_generic_status *estatus);
607fd936fd8SArnd Bergmann 
608*61eac5f7SSmita Koralahalli struct cxl_cper_sec_prot_err;
609*61eac5f7SSmita Koralahalli void cxl_cper_print_prot_err(const char *pfx,
610*61eac5f7SSmita Koralahalli 			     const struct cxl_cper_sec_prot_err *prot_err);
611*61eac5f7SSmita Koralahalli 
61206d65deaSHuang Ying #endif
613