[thirdparty/linux.git] / drivers / pci / pcie / aer / aerdrv.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (C) 2006 Intel Corp.
 *	Tom Long Nguyen (tom.l.nguyen@intel.com)
 *	Zhang Yanmin (yanmin.zhang@intel.com)
 *
 */

#ifndef _AERDRV_H_
#define _AERDRV_H_

#include <linux/workqueue.h>
#include <linux/pcieport_if.h>
#include <linux/aer.h>
#include <linux/interrupt.h>

#define SYSTEM_ERROR_INTR_ON_MESG_MASK	(PCI_EXP_RTCTL_SECEE|	\
					PCI_EXP_RTCTL_SENFEE|	\
					PCI_EXP_RTCTL_SEFEE)
#define ROOT_PORT_INTR_ON_MESG_MASK	(PCI_ERR_ROOT_CMD_COR_EN|	\
					PCI_ERR_ROOT_CMD_NONFATAL_EN|	\
					PCI_ERR_ROOT_CMD_FATAL_EN)
#define ERR_COR_ID(d)			(d & 0xffff)
#define ERR_UNCOR_ID(d)			(d >> 16)

#define AER_ERROR_SOURCES_MAX		100

#define AER_LOG_TLP_MASKS		(PCI_ERR_UNC_POISON_TLP|	\
					PCI_ERR_UNC_ECRC|		\
					PCI_ERR_UNC_UNSUP|		\
					PCI_ERR_UNC_COMP_ABORT|		\
					PCI_ERR_UNC_UNX_COMP|		\
					PCI_ERR_UNC_MALF_TLP)

#define AER_MAX_MULTI_ERR_DEVICES	5	/* Not likely to have more */
struct aer_err_info {
	struct pci_dev *dev[AER_MAX_MULTI_ERR_DEVICES];
	int error_dev_num;

	unsigned int id:16;

	unsigned int severity:2;	/* 0:NONFATAL | 1:FATAL | 2:COR */
	unsigned int __pad1:5;
	unsigned int multi_error_valid:1;

	unsigned int first_error:5;
	unsigned int __pad2:2;
	unsigned int tlp_header_valid:1;

	unsigned int status;		/* COR/UNCOR Error Status */
	unsigned int mask;		/* COR/UNCOR Error Mask */
	struct aer_header_log_regs tlp;	/* TLP Header */
};

struct aer_err_source {
	unsigned int status;
	unsigned int id;
};

struct aer_rpc {
	struct pcie_device *rpd;	/* Root Port device */
	struct work_struct dpc_handler;
	struct aer_err_source e_sources[AER_ERROR_SOURCES_MAX];
	struct aer_err_info e_info;
	unsigned short prod_idx;	/* Error Producer Index */
	unsigned short cons_idx;	/* Error Consumer Index */
	int isr;
	spinlock_t e_lock;		/*
					 * Lock access to Error Status/ID Regs
					 * and error producer/consumer index
					 */
	struct mutex rpc_mutex;		/*
					 * only one thread could do
					 * recovery on the same
					 * root port hierarchy
					 */
};

struct aer_broadcast_data {
	enum pci_channel_state state;
	enum pci_ers_result result;
};

static inline pci_ers_result_t merge_result(enum pci_ers_result orig,
		enum pci_ers_result new)
{
	if (new == PCI_ERS_RESULT_NO_AER_DRIVER)
		return PCI_ERS_RESULT_NO_AER_DRIVER;

	if (new == PCI_ERS_RESULT_NONE)
		return orig;

	switch (orig) {
	case PCI_ERS_RESULT_CAN_RECOVER:
	case PCI_ERS_RESULT_RECOVERED:
		orig = new;
		break;
	case PCI_ERS_RESULT_DISCONNECT:
		if (new == PCI_ERS_RESULT_NEED_RESET)
			orig = PCI_ERS_RESULT_NEED_RESET;
		break;
	default:
		break;
	}

	return orig;
}

extern struct bus_type pcie_port_bus_type;
void aer_isr(struct work_struct *work);
void aer_print_error(struct pci_dev *dev, struct aer_err_info *info);
void aer_print_port_info(struct pci_dev *dev, struct aer_err_info *info);
irqreturn_t aer_irq(int irq, void *context);

#ifdef CONFIG_ACPI_APEI
int pcie_aer_get_firmware_first(struct pci_dev *pci_dev);
#else
static inline int pcie_aer_get_firmware_first(struct pci_dev *pci_dev)
{
	if (pci_dev->__aer_firmware_first_valid)
		return pci_dev->__aer_firmware_first;
	return 0;
}
#endif
#endif /* _AERDRV_H_ */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
6c2b374d ZY	2	/*
	3	* Copyright (C) 2006 Intel Corp.
	4	* Tom Long Nguyen (tom.l.nguyen@intel.com)
	5	* Zhang Yanmin (yanmin.zhang@intel.com)
	6	*
	7	*/
	8
	9	#ifndef _AERDRV_H_
	10	#define _AERDRV_H_
	11
e8edc6e0	12	#include <linux/workqueue.h>
6c2b374d ZY	13	#include <linux/pcieport_if.h>
6c2b374d ZY	14	#include <linux/aer.h>
634deb02	15	#include <linux/interrupt.h>
6c2b374d	16
6c2b374d ZY	17	#define SYSTEM_ERROR_INTR_ON_MESG_MASK (PCI_EXP_RTCTL_SECEE\| \
	18	PCI_EXP_RTCTL_SENFEE\| \
	19	PCI_EXP_RTCTL_SEFEE)
	20	#define ROOT_PORT_INTR_ON_MESG_MASK (PCI_ERR_ROOT_CMD_COR_EN\| \
	21	PCI_ERR_ROOT_CMD_NONFATAL_EN\| \
	22	PCI_ERR_ROOT_CMD_FATAL_EN)
	23	#define ERR_COR_ID(d) (d & 0xffff)
	24	#define ERR_UNCOR_ID(d) (d >> 16)
	25
6c2b374d ZY	26	#define AER_ERROR_SOURCES_MAX 100
	27
	28	#define AER_LOG_TLP_MASKS (PCI_ERR_UNC_POISON_TLP\| \
	29	PCI_ERR_UNC_ECRC\| \
	30	PCI_ERR_UNC_UNSUP\| \
	31	PCI_ERR_UNC_COMP_ABORT\| \
	32	PCI_ERR_UNC_UNX_COMP\| \
	33	PCI_ERR_UNC_MALF_TLP)
	34
3d5505c5	35	#define AER_MAX_MULTI_ERR_DEVICES 5 /* Not likely to have more */
6c2b374d	36	struct aer_err_info {
3d5505c5 ZY	37	struct pci_dev *dev[AER_MAX_MULTI_ERR_DEVICES];
3d5505c5 ZY	38	int error_dev_num;
273024de HS	39
	40	unsigned int id:16;
	41
	42	unsigned int severity:2; /* 0:NONFATAL \| 1:FATAL \| 2:COR */
	43	unsigned int __pad1:5;
	44	unsigned int multi_error_valid:1;
	45
	46	unsigned int first_error:5;
	47	unsigned int __pad2:2;
	48	unsigned int tlp_header_valid:1;
	49
6c2b374d	50	unsigned int status; /* COR/UNCOR Error Status */
0d90c3ac	51	unsigned int mask; /* COR/UNCOR Error Mask */
c413d768	52	struct aer_header_log_regs tlp; /* TLP Header */
6c2b374d ZY	53	};
	54
	55	struct aer_err_source {
	56	unsigned int status;
	57	unsigned int id;
	58	};
	59
	60	struct aer_rpc {
	61	struct pcie_device rpd; / Root Port device */
	62	struct work_struct dpc_handler;
	63	struct aer_err_source e_sources[AER_ERROR_SOURCES_MAX];
4b202b71	64	struct aer_err_info e_info;
6c2b374d ZY	65	unsigned short prod_idx; /* Error Producer Index */
	66	unsigned short cons_idx; /* Error Consumer Index */
	67	int isr;
	68	spinlock_t e_lock; /*
	69	* Lock access to Error Status/ID Regs
	70	* and error producer/consumer index
	71	*/
	72	struct mutex rpc_mutex; /*
	73	* only one thread could do
	74	* recovery on the same
1b3c3714	75	* root port hierarchy
6c2b374d	76	*/
6c2b374d ZY	77	};
	78
	79	struct aer_broadcast_data {
	80	enum pci_channel_state state;
	81	enum pci_ers_result result;
	82	};
	83
	84	static inline pci_ers_result_t merge_result(enum pci_ers_result orig,
	85	enum pci_ers_result new)
	86	{
918b4053 VMP	87	if (new == PCI_ERS_RESULT_NO_AER_DRIVER)
	88	return PCI_ERS_RESULT_NO_AER_DRIVER;
	89
029091df ZY	90	if (new == PCI_ERS_RESULT_NONE)
	91	return orig;
	92
6c2b374d ZY	93	switch (orig) {
	94	case PCI_ERS_RESULT_CAN_RECOVER:
	95	case PCI_ERS_RESULT_RECOVERED:
	96	orig = new;
	97	break;
	98	case PCI_ERS_RESULT_DISCONNECT:
	99	if (new == PCI_ERS_RESULT_NEED_RESET)
918b4053	100	orig = PCI_ERS_RESULT_NEED_RESET;
6c2b374d ZY	101	break;
	102	default:
	103	break;
	104	}
	105
	106	return orig;
	107	}
	108
	109	extern struct bus_type pcie_port_bus_type;
f39d5b72 BH	110	void aer_isr(struct work_struct *work);
	111	void aer_print_error(struct pci_dev dev, struct aer_err_info info);
	112	void aer_print_port_info(struct pci_dev dev, struct aer_err_info info);
	113	irqreturn_t aer_irq(int irq, void *context);
8d29bfb7	114
affb72c3	115	#ifdef CONFIG_ACPI_APEI
f39d5b72	116	int pcie_aer_get_firmware_first(struct pci_dev *pci_dev);
affb72c3 HY	117	#else
	118	static inline int pcie_aer_get_firmware_first(struct pci_dev *pci_dev)
	119	{
	120	if (pci_dev->__aer_firmware_first_valid)
	121	return pci_dev->__aer_firmware_first;
	122	return 0;
	123	}
	124	#endif
c9a91883	125	#endif /* _AERDRV_H_ */