[net-next-2.6.git] / drivers / pci / pcie / aer / aerdrv.h

/*
 * 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 AER_NONFATAL			0
#define AER_FATAL			1
#define AER_CORRECTABLE			2

#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)

struct header_log_regs {
	unsigned int dw0;
	unsigned int dw1;
	unsigned int dw2;
	unsigned int dw3;
};

#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 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];
	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
					 */
	wait_queue_head_t wait_release;
};

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_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 = new;
		break;
	default:
		break;
	}

	return orig;
}

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

#ifdef CONFIG_ACPI
extern int aer_osc_setup(struct pcie_device *pciedev);
#else
static inline int aer_osc_setup(struct pcie_device *pciedev)
{
	return 0;
}
#endif

#ifdef CONFIG_ACPI_APEI
extern 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

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