[linux-2.6-block.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_EXITING		0x0002

struct ghes {
	union {
		struct acpi_hest_generic *generic;
		struct acpi_hest_generic_v2 *generic_v2;
	};
	struct acpi_hest_generic_status *estatus;
	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;

	int task_work_cpu;
	struct callback_head task_work;
};

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,
};

#ifdef CONFIG_ACPI_APEI_GHES
/**
 * ghes_register_vendor_record_notifier - register a notifier for vendor
 * records that the kernel would otherwise ignore.
 * @nb: pointer to the notifier_block structure of the event handler.
 *
 * return 0 : SUCCESS, non-zero : FAIL
 */
int ghes_register_vendor_record_notifier(struct notifier_block *nb);

/**
 * ghes_unregister_vendor_record_notifier - unregister the previously
 * registered vendor record notifier.
 * @nb: pointer to the notifier_block structure of the vendor record handler.
 */
void ghes_unregister_vendor_record_notifier(struct notifier_block *nb);
#endif

int ghes_estatus_pool_init(int num_ghes);

/* 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	*/
40e06415 MCC	16	#define GHES_EXITING 0x0002
	17
	18	struct ghes {
42aa5604 TB	19	union {
	20	struct acpi_hest_generic *generic;
	21	struct acpi_hest_generic_v2 *generic_v2;
	22	};
0a00fd5e	23	struct acpi_hest_generic_status *estatus;
40e06415 MCC	24	unsigned long flags;
	25	union {
	26	struct list_head list;
	27	struct timer_list timer;
	28	unsigned int irq;
	29	};
	30	};
	31
	32	struct ghes_estatus_node {
	33	struct llist_node llnode;
	34	struct acpi_hest_generic *generic;
21480547	35	struct ghes *ghes;
7f17b4a1 JM	36
	37	int task_work_cpu;
	38	struct callback_head task_work;
40e06415 MCC	39	};
	40
	41	struct ghes_estatus_cache {
	42	u32 estatus_len;
	43	atomic_t count;
	44	struct acpi_hest_generic *generic;
	45	unsigned long long time_in;
	46	struct rcu_head rcu;
	47	};
	48
	49	enum {
	50	GHES_SEV_NO = 0x0,
	51	GHES_SEV_CORRECTED = 0x1,
	52	GHES_SEV_RECOVERABLE = 0x2,
	53	GHES_SEV_PANIC = 0x3,
	54	};
21480547	55
9aa9cf3e SJ	56	#ifdef CONFIG_ACPI_APEI_GHES
	57	/**
	58	* ghes_register_vendor_record_notifier - register a notifier for vendor
	59	* records that the kernel would otherwise ignore.
	60	* @nb: pointer to the notifier_block structure of the event handler.
	61	*
	62	* return 0 : SUCCESS, non-zero : FAIL
	63	*/
	64	int ghes_register_vendor_record_notifier(struct notifier_block *nb);
	65
	66	/**
	67	* ghes_unregister_vendor_record_notifier - unregister the previously
	68	* registered vendor record notifier.
	69	* @nb: pointer to the notifier_block structure of the vendor record handler.
	70	*/
	71	void ghes_unregister_vendor_record_notifier(struct notifier_block *nb);
	72	#endif
	73
fb7be08f	74	int ghes_estatus_pool_init(int num_ghes);
e147133a	75
21480547 MCC	76	/* From drivers/edac/ghes_edac.c */
	77
	78	#ifdef CONFIG_EDAC_GHES
305d0e00	79	void ghes_edac_report_mem_error(int sev, struct cper_sec_mem_err *mem_err);
21480547 MCC	80
	81	int ghes_edac_register(struct ghes ghes, struct device dev);
	82
	83	void ghes_edac_unregister(struct ghes *ghes);
	84
	85	#else
305d0e00	86	static inline void ghes_edac_report_mem_error(int sev,
21480547 MCC	87	struct cper_sec_mem_err *mem_err)
	88	{
	89	}
	90
	91	static inline int ghes_edac_register(struct ghes ghes, struct device dev)
	92	{
cc7f3f13	93	return -ENODEV;
21480547 MCC	94	}
	95
	96	static inline void ghes_edac_unregister(struct ghes *ghes)
	97	{
	98	}
	99	#endif
bbcc2e7b TB	100
	101	static inline int acpi_hest_get_version(struct acpi_hest_generic_data *gdata)
	102	{
	103	return gdata->revision >> 8;
	104	}
	105
	106	static inline void acpi_hest_get_payload(struct acpi_hest_generic_data gdata)
	107	{
	108	if (acpi_hest_get_version(gdata) >= 3)
	109	return (void )(((struct acpi_hest_generic_data_v300 )(gdata)) + 1);
	110
	111	return gdata + 1;
	112	}
	113
	114	static inline int acpi_hest_get_error_length(struct acpi_hest_generic_data *gdata)
	115	{
	116	return ((struct acpi_hest_generic_data *)(gdata))->error_data_length;
	117	}
	118
	119	static inline int acpi_hest_get_size(struct acpi_hest_generic_data *gdata)
	120	{
	121	if (acpi_hest_get_version(gdata) >= 3)
	122	return sizeof(struct acpi_hest_generic_data_v300);
	123
	124	return sizeof(struct acpi_hest_generic_data);
	125	}
	126
	127	static inline int acpi_hest_get_record_size(struct acpi_hest_generic_data *gdata)
	128	{
	129	return (acpi_hest_get_size(gdata) + acpi_hest_get_error_length(gdata));
	130	}
	131
	132	static inline void acpi_hest_get_next(struct acpi_hest_generic_data gdata)
	133	{
	134	return (void *)(gdata) + acpi_hest_get_record_size(gdata);
	135	}
7edda088	136
c4335fdd	137	#define apei_estatus_for_each_section(estatus, section) \
	138	for (section = (struct acpi_hest_generic_data *)(estatus + 1); \
	139	(void )section - (void )(estatus + 1) < estatus->data_length; \
	140	section = acpi_hest_get_next(section))
	141
1035a078	142	#ifdef CONFIG_ACPI_APEI_SEA
621f48e4	143	int ghes_notify_sea(void);
1035a078 DG	144	#else
	145	static inline int ghes_notify_sea(void) { return -ENOENT; }
	146	#endif
7edda088 TB	147
7edda088 TB	148	#endif /* GHES_H */