[mirror_ubuntu-jammy-kernel.git] / include / acpi / ghes.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef GHES_H
#define GHES_H

#include <acpi/apei.h>
#include <acpi/hed.h>

/*
 * One struct ghes is created for each generic hardware error source.
 * It provides the context for APEI hardware error timer/IRQ/SCI/NMI
 * handler.
 *
 * estatus: memory buffer for error status block, allocated during
 * HEST parsing.
 */
#define GHES_TO_CLEAR		0x0001
#define GHES_EXITING		0x0002

struct ghes {
	union {
		struct acpi_hest_generic *generic;
		struct acpi_hest_generic_v2 *generic_v2;
	};
	struct acpi_hest_generic_status *estatus;
	u64 buffer_paddr;
	unsigned long flags;
	union {
		struct list_head list;
		struct timer_list timer;
		unsigned int irq;
	};
};

struct ghes_estatus_node {
	struct llist_node llnode;
	struct acpi_hest_generic *generic;
	struct ghes *ghes;
};

struct ghes_estatus_cache {
	u32 estatus_len;
	atomic_t count;
	struct acpi_hest_generic *generic;
	unsigned long long time_in;
	struct rcu_head rcu;
};

enum {
	GHES_SEV_NO = 0x0,
	GHES_SEV_CORRECTED = 0x1,
	GHES_SEV_RECOVERABLE = 0x2,
	GHES_SEV_PANIC = 0x3,
};

/* From drivers/edac/ghes_edac.c */

#ifdef CONFIG_EDAC_GHES
void ghes_edac_report_mem_error(int sev, struct cper_sec_mem_err *mem_err);

int ghes_edac_register(struct ghes *ghes, struct device *dev);

void ghes_edac_unregister(struct ghes *ghes);

#else
static inline void ghes_edac_report_mem_error(int sev,
				       struct cper_sec_mem_err *mem_err)
{
}

static inline int ghes_edac_register(struct ghes *ghes, struct device *dev)
{
	return -ENODEV;
}

static inline void ghes_edac_unregister(struct ghes *ghes)
{
}
#endif

static inline int acpi_hest_get_version(struct acpi_hest_generic_data *gdata)
{
	return gdata->revision >> 8;
}

static inline void *acpi_hest_get_payload(struct acpi_hest_generic_data *gdata)
{
	if (acpi_hest_get_version(gdata) >= 3)
		return (void *)(((struct acpi_hest_generic_data_v300 *)(gdata)) + 1);

	return gdata + 1;
}

static inline int acpi_hest_get_error_length(struct acpi_hest_generic_data *gdata)
{
	return ((struct acpi_hest_generic_data *)(gdata))->error_data_length;
}

static inline int acpi_hest_get_size(struct acpi_hest_generic_data *gdata)
{
	if (acpi_hest_get_version(gdata) >= 3)
		return sizeof(struct acpi_hest_generic_data_v300);

	return sizeof(struct acpi_hest_generic_data);
}

static inline int acpi_hest_get_record_size(struct acpi_hest_generic_data *gdata)
{
	return (acpi_hest_get_size(gdata) + acpi_hest_get_error_length(gdata));
}

static inline void *acpi_hest_get_next(struct acpi_hest_generic_data *gdata)
{
	return (void *)(gdata) + acpi_hest_get_record_size(gdata);
}

#define apei_estatus_for_each_section(estatus, section)			\
	for (section = (struct acpi_hest_generic_data *)(estatus + 1);	\
	     (void *)section - (void *)(estatus + 1) < estatus->data_length; \
	     section = acpi_hest_get_next(section))

#ifdef CONFIG_ACPI_APEI_SEA
int ghes_notify_sea(void);
#else
static inline int ghes_notify_sea(void) { return -ENOENT; }
#endif

#endif /* GHES_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
7edda088 TB	2	#ifndef GHES_H
	3	#define GHES_H
	4
40e06415 MCC	5	#include <acpi/apei.h>
	6	#include <acpi/hed.h>
	7
	8	/*
	9	* One struct ghes is created for each generic hardware error source.
	10	* It provides the context for APEI hardware error timer/IRQ/SCI/NMI
	11	* handler.
	12	*
	13	* estatus: memory buffer for error status block, allocated during
	14	* HEST parsing.
	15	*/
	16	#define GHES_TO_CLEAR 0x0001
	17	#define GHES_EXITING 0x0002
	18
	19	struct ghes {
42aa5604 TB	20	union {
	21	struct acpi_hest_generic *generic;
	22	struct acpi_hest_generic_v2 *generic_v2;
	23	};
0a00fd5e	24	struct acpi_hest_generic_status *estatus;
40e06415 MCC	25	u64 buffer_paddr;
	26	unsigned long flags;
	27	union {
	28	struct list_head list;
	29	struct timer_list timer;
	30	unsigned int irq;
	31	};
	32	};
	33
	34	struct ghes_estatus_node {
	35	struct llist_node llnode;
	36	struct acpi_hest_generic *generic;
21480547	37	struct ghes *ghes;
40e06415 MCC	38	};
	39
	40	struct ghes_estatus_cache {
	41	u32 estatus_len;
	42	atomic_t count;
	43	struct acpi_hest_generic *generic;
	44	unsigned long long time_in;
	45	struct rcu_head rcu;
	46	};
	47
	48	enum {
	49	GHES_SEV_NO = 0x0,
	50	GHES_SEV_CORRECTED = 0x1,
	51	GHES_SEV_RECOVERABLE = 0x2,
	52	GHES_SEV_PANIC = 0x3,
	53	};
21480547 MCC	54
	55	/* From drivers/edac/ghes_edac.c */
	56
	57	#ifdef CONFIG_EDAC_GHES
305d0e00	58	void ghes_edac_report_mem_error(int sev, struct cper_sec_mem_err *mem_err);
21480547 MCC	59
	60	int ghes_edac_register(struct ghes ghes, struct device dev);
	61
	62	void ghes_edac_unregister(struct ghes *ghes);
	63
	64	#else
305d0e00	65	static inline void ghes_edac_report_mem_error(int sev,
21480547 MCC	66	struct cper_sec_mem_err *mem_err)
	67	{
	68	}
	69
	70	static inline int ghes_edac_register(struct ghes ghes, struct device dev)
	71	{
cc7f3f13	72	return -ENODEV;
21480547 MCC	73	}
	74
	75	static inline void ghes_edac_unregister(struct ghes *ghes)
	76	{
	77	}
	78	#endif
bbcc2e7b TB	79
	80	static inline int acpi_hest_get_version(struct acpi_hest_generic_data *gdata)
	81	{
	82	return gdata->revision >> 8;
	83	}
	84
	85	static inline void acpi_hest_get_payload(struct acpi_hest_generic_data gdata)
	86	{
	87	if (acpi_hest_get_version(gdata) >= 3)
	88	return (void )(((struct acpi_hest_generic_data_v300 )(gdata)) + 1);
	89
	90	return gdata + 1;
	91	}
	92
	93	static inline int acpi_hest_get_error_length(struct acpi_hest_generic_data *gdata)
	94	{
	95	return ((struct acpi_hest_generic_data *)(gdata))->error_data_length;
	96	}
	97
	98	static inline int acpi_hest_get_size(struct acpi_hest_generic_data *gdata)
	99	{
	100	if (acpi_hest_get_version(gdata) >= 3)
	101	return sizeof(struct acpi_hest_generic_data_v300);
	102
	103	return sizeof(struct acpi_hest_generic_data);
	104	}
	105
	106	static inline int acpi_hest_get_record_size(struct acpi_hest_generic_data *gdata)
	107	{
	108	return (acpi_hest_get_size(gdata) + acpi_hest_get_error_length(gdata));
	109	}
	110
	111	static inline void acpi_hest_get_next(struct acpi_hest_generic_data gdata)
	112	{
	113	return (void *)(gdata) + acpi_hest_get_record_size(gdata);
	114	}
7edda088	115
c4335fdd	116	#define apei_estatus_for_each_section(estatus, section) \
	117	for (section = (struct acpi_hest_generic_data *)(estatus + 1); \
	118	(void )section - (void )(estatus + 1) < estatus->data_length; \
	119	section = acpi_hest_get_next(section))
	120
1035a078	121	#ifdef CONFIG_ACPI_APEI_SEA
621f48e4	122	int ghes_notify_sea(void);
1035a078 DG	123	#else
	124	static inline int ghes_notify_sea(void) { return -ENOENT; }
	125	#endif
7edda088 TB	126
7edda088 TB	127	#endif /* GHES_H */