[linux-2.6-block.git] / drivers / edac / edac_pci.c

/*
 * EDAC PCI component
 *
 * Author: Dave Jiang <djiang@mvista.com>
 *
 * 2007 (c) MontaVista Software, Inc. This file is licensed under
 * the terms of the GNU General Public License version 2. This program
 * is licensed "as is" without any warranty of any kind, whether express
 * or implied.
 *
 */
#include <linux/module.h>
#include <linux/types.h>
#include <linux/smp.h>
#include <linux/init.h>
#include <linux/sysctl.h>
#include <linux/highmem.h>
#include <linux/timer.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/list.h>
#include <linux/ctype.h>
#include <linux/workqueue.h>
#include <asm/uaccess.h>
#include <asm/page.h>

#include "edac_core.h"
#include "edac_module.h"

static DEFINE_MUTEX(edac_pci_ctls_mutex);
static LIST_HEAD(edac_pci_list);
static atomic_t pci_indexes = ATOMIC_INIT(0);

/*
 * edac_pci_alloc_ctl_info
 *
 *	The alloc() function for the 'edac_pci' control info
 *	structure. The chip driver will allocate one of these for each
 *	edac_pci it is going to control/register with the EDAC CORE.
 */
struct edac_pci_ctl_info *edac_pci_alloc_ctl_info(unsigned int sz_pvt,
						const char *edac_pci_name)
{
	struct edac_pci_ctl_info *pci;
	void *p = NULL, *pvt;
	unsigned int size;

	edac_dbg(1, "\n");

	pci = edac_align_ptr(&p, sizeof(*pci), 1);
	pvt = edac_align_ptr(&p, 1, sz_pvt);
	size = ((unsigned long)pvt) + sz_pvt;

	/* Alloc the needed control struct memory */
	pci = kzalloc(size, GFP_KERNEL);
	if (pci  == NULL)
		return NULL;

	/* Now much private space */
	pvt = sz_pvt ? ((char *)pci) + ((unsigned long)pvt) : NULL;

	pci->pvt_info = pvt;
	pci->op_state = OP_ALLOC;

	snprintf(pci->name, strlen(edac_pci_name) + 1, "%s", edac_pci_name);

	return pci;
}
EXPORT_SYMBOL_GPL(edac_pci_alloc_ctl_info);

/*
 * edac_pci_free_ctl_info()
 *
 *	Last action on the pci control structure.
 *
 *	call the remove sysfs information, which will unregister
 *	this control struct's kobj. When that kobj's ref count
 *	goes to zero, its release function will be call and then
 *	kfree() the memory.
 */
void edac_pci_free_ctl_info(struct edac_pci_ctl_info *pci)
{
	edac_dbg(1, "\n");

	edac_pci_remove_sysfs(pci);
}
EXPORT_SYMBOL_GPL(edac_pci_free_ctl_info);

/*
 * find_edac_pci_by_dev()
 * 	scans the edac_pci list for a specific 'struct device *'
 *
 *	return NULL if not found, or return control struct pointer
 */
static struct edac_pci_ctl_info *find_edac_pci_by_dev(struct device *dev)
{
	struct edac_pci_ctl_info *pci;
	struct list_head *item;

	edac_dbg(1, "\n");

	list_for_each(item, &edac_pci_list) {
		pci = list_entry(item, struct edac_pci_ctl_info, link);

		if (pci->dev == dev)
			return pci;
	}

	return NULL;
}

/*
 * add_edac_pci_to_global_list
 * 	Before calling this function, caller must assign a unique value to
 * 	edac_dev->pci_idx.
 * 	Return:
 * 		0 on success
 * 		1 on failure
 */
static int add_edac_pci_to_global_list(struct edac_pci_ctl_info *pci)
{
	struct list_head *item, *insert_before;
	struct edac_pci_ctl_info *rover;

	edac_dbg(1, "\n");

	insert_before = &edac_pci_list;

	/* Determine if already on the list */
	rover = find_edac_pci_by_dev(pci->dev);
	if (unlikely(rover != NULL))
		goto fail0;

	/* Insert in ascending order by 'pci_idx', so find position */
	list_for_each(item, &edac_pci_list) {
		rover = list_entry(item, struct edac_pci_ctl_info, link);

		if (rover->pci_idx >= pci->pci_idx) {
			if (unlikely(rover->pci_idx == pci->pci_idx))
				goto fail1;

			insert_before = item;
			break;
		}
	}

	list_add_tail_rcu(&pci->link, insert_before);
	return 0;

fail0:
	edac_printk(KERN_WARNING, EDAC_PCI,
		"%s (%s) %s %s already assigned %d\n",
		dev_name(rover->dev), edac_dev_name(rover),
		rover->mod_name, rover->ctl_name, rover->pci_idx);
	return 1;

fail1:
	edac_printk(KERN_WARNING, EDAC_PCI,
		"but in low-level driver: attempt to assign\n"
		"\tduplicate pci_idx %d in %s()\n", rover->pci_idx,
		__func__);
	return 1;
}

/*
 * del_edac_pci_from_global_list
 *
 *	remove the PCI control struct from the global list
 */
static void del_edac_pci_from_global_list(struct edac_pci_ctl_info *pci)
{
	list_del_rcu(&pci->link);

	/* these are for safe removal of devices from global list while
	 * NMI handlers may be traversing list
	 */
	synchronize_rcu();
	INIT_LIST_HEAD(&pci->link);
}

#if 0
/* Older code, but might use in the future */

/*
 * edac_pci_find()
 * 	Search for an edac_pci_ctl_info structure whose index is 'idx'
 *
 * If found, return a pointer to the structure
 * Else return NULL.
 *
 * Caller must hold pci_ctls_mutex.
 */
struct edac_pci_ctl_info *edac_pci_find(int idx)
{
	struct list_head *item;
	struct edac_pci_ctl_info *pci;

	/* Iterage over list, looking for exact match of ID */
	list_for_each(item, &edac_pci_list) {
		pci = list_entry(item, struct edac_pci_ctl_info, link);

		if (pci->pci_idx >= idx) {
			if (pci->pci_idx == idx)
				return pci;

			/* not on list, so terminate early */
			break;
		}
	}

	return NULL;
}
EXPORT_SYMBOL_GPL(edac_pci_find);
#endif

/*
 * edac_pci_workq_function()
 *
 * 	periodic function that performs the operation
 *	scheduled by a workq request, for a given PCI control struct
 */
static void edac_pci_workq_function(struct work_struct *work_req)
{
	struct delayed_work *d_work = to_delayed_work(work_req);
	struct edac_pci_ctl_info *pci = to_edac_pci_ctl_work(d_work);
	int msec;
	unsigned long delay;

	edac_dbg(3, "checking\n");

	mutex_lock(&edac_pci_ctls_mutex);

	if (pci->op_state == OP_RUNNING_POLL) {
		/* we might be in POLL mode, but there may NOT be a poll func
		 */
		if ((pci->edac_check != NULL) && edac_pci_get_check_errors())
			pci->edac_check(pci);

		/* if we are on a one second period, then use round */
		msec = edac_pci_get_poll_msec();
		if (msec == 1000)
			delay = round_jiffies_relative(msecs_to_jiffies(msec));
		else
			delay = msecs_to_jiffies(msec);

		/* Reschedule only if we are in POLL mode */
		queue_delayed_work(edac_workqueue, &pci->work, delay);
	}

	mutex_unlock(&edac_pci_ctls_mutex);
}

/*
 * edac_pci_workq_setup()
 * 	initialize a workq item for this edac_pci instance
 * 	passing in the new delay period in msec
 *
 *	locking model:
 *		called when 'edac_pci_ctls_mutex' is locked
 */
static void edac_pci_workq_setup(struct edac_pci_ctl_info *pci,
				 unsigned int msec)
{
	edac_dbg(0, "\n");

	INIT_DELAYED_WORK(&pci->work, edac_pci_workq_function);
	queue_delayed_work(edac_workqueue, &pci->work,
			msecs_to_jiffies(edac_pci_get_poll_msec()));
}

/*
 * edac_pci_workq_teardown()
 * 	stop the workq processing on this edac_pci instance
 */
static void edac_pci_workq_teardown(struct edac_pci_ctl_info *pci)
{
	int status;

	edac_dbg(0, "\n");

	status = cancel_delayed_work(&pci->work);
	if (status == 0)
		flush_workqueue(edac_workqueue);
}

/*
 * edac_pci_reset_delay_period
 *
 *	called with a new period value for the workq period
 *	a) stop current workq timer
 *	b) restart workq timer with new value
 */
void edac_pci_reset_delay_period(struct edac_pci_ctl_info *pci,
				 unsigned long value)
{
	edac_dbg(0, "\n");

	edac_pci_workq_teardown(pci);

	/* need to lock for the setup */
	mutex_lock(&edac_pci_ctls_mutex);

	edac_pci_workq_setup(pci, value);

	mutex_unlock(&edac_pci_ctls_mutex);
}
EXPORT_SYMBOL_GPL(edac_pci_reset_delay_period);

/*
 * edac_pci_alloc_index: Allocate a unique PCI index number
 *
 * Return:
 *      allocated index number
 *
 */
int edac_pci_alloc_index(void)
{
	return atomic_inc_return(&pci_indexes) - 1;
}
EXPORT_SYMBOL_GPL(edac_pci_alloc_index);

/*
 * edac_pci_add_device: Insert the 'edac_dev' structure into the
 * edac_pci global list and create sysfs entries associated with
 * edac_pci structure.
 * @pci: pointer to the edac_device structure to be added to the list
 * @edac_idx: A unique numeric identifier to be assigned to the
 * 'edac_pci' structure.
 *
 * Return:
 *      0       Success
 *      !0      Failure
 */
int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx)
{
	edac_dbg(0, "\n");

	pci->pci_idx = edac_idx;
	pci->start_time = jiffies;

	mutex_lock(&edac_pci_ctls_mutex);

	if (add_edac_pci_to_global_list(pci))
		goto fail0;

	if (edac_pci_create_sysfs(pci)) {
		edac_pci_printk(pci, KERN_WARNING,
				"failed to create sysfs pci\n");
		goto fail1;
	}

	if (pci->edac_check != NULL) {
		pci->op_state = OP_RUNNING_POLL;

		edac_pci_workq_setup(pci, 1000);
	} else {
		pci->op_state = OP_RUNNING_INTERRUPT;
	}

	edac_pci_printk(pci, KERN_INFO,
		"Giving out device to module %s controller %s: DEV %s (%s)\n",
		pci->mod_name, pci->ctl_name, pci->dev_name,
		edac_op_state_to_string(pci->op_state));

	mutex_unlock(&edac_pci_ctls_mutex);
	return 0;

	/* error unwind stack */
fail1:
	del_edac_pci_from_global_list(pci);
fail0:
	mutex_unlock(&edac_pci_ctls_mutex);
	return 1;
}
EXPORT_SYMBOL_GPL(edac_pci_add_device);

/*
 * edac_pci_del_device()
 * 	Remove sysfs entries for specified edac_pci structure and
 * 	then remove edac_pci structure from global list
 *
 * @dev:
 * 	Pointer to 'struct device' representing edac_pci structure
 * 	to remove
 *
 * Return:
 * 	Pointer to removed edac_pci structure,
 * 	or NULL if device not found
 */
struct edac_pci_ctl_info *edac_pci_del_device(struct device *dev)
{
	struct edac_pci_ctl_info *pci;

	edac_dbg(0, "\n");

	mutex_lock(&edac_pci_ctls_mutex);

	/* ensure the control struct is on the global list
	 * if not, then leave
	 */
	pci = find_edac_pci_by_dev(dev);
	if (pci  == NULL) {
		mutex_unlock(&edac_pci_ctls_mutex);
		return NULL;
	}

	pci->op_state = OP_OFFLINE;

	del_edac_pci_from_global_list(pci);

	mutex_unlock(&edac_pci_ctls_mutex);

	/* stop the workq timer */
	edac_pci_workq_teardown(pci);

	edac_printk(KERN_INFO, EDAC_PCI,
		"Removed device %d for %s %s: DEV %s\n",
		pci->pci_idx, pci->mod_name, pci->ctl_name, edac_dev_name(pci));

	return pci;
}
EXPORT_SYMBOL_GPL(edac_pci_del_device);

/*
 * edac_pci_generic_check
 *
 *	a Generic parity check API
 */
static void edac_pci_generic_check(struct edac_pci_ctl_info *pci)
{
	edac_dbg(4, "\n");
	edac_pci_do_parity_check();
}

/* free running instance index counter */
static int edac_pci_idx;
#define EDAC_PCI_GENCTL_NAME	"EDAC PCI controller"

struct edac_pci_gen_data {
	int edac_idx;
};

/*
 * edac_pci_create_generic_ctl
 *
 *	A generic constructor for a PCI parity polling device
 *	Some systems have more than one domain of PCI busses.
 *	For systems with one domain, then this API will
 *	provide for a generic poller.
 *
 *	This routine calls the edac_pci_alloc_ctl_info() for
 *	the generic device, with default values
 */
struct edac_pci_ctl_info *edac_pci_create_generic_ctl(struct device *dev,
						const char *mod_name)
{
	struct edac_pci_ctl_info *pci;
	struct edac_pci_gen_data *pdata;

	pci = edac_pci_alloc_ctl_info(sizeof(*pdata), EDAC_PCI_GENCTL_NAME);
	if (!pci)
		return NULL;

	pdata = pci->pvt_info;
	pci->dev = dev;
	dev_set_drvdata(pci->dev, pci);
	pci->dev_name = pci_name(to_pci_dev(dev));

	pci->mod_name = mod_name;
	pci->ctl_name = EDAC_PCI_GENCTL_NAME;
	if (edac_op_state == EDAC_OPSTATE_POLL)
		pci->edac_check = edac_pci_generic_check;

	pdata->edac_idx = edac_pci_idx++;

	if (edac_pci_add_device(pci, pdata->edac_idx) > 0) {
		edac_dbg(3, "failed edac_pci_add_device()\n");
		edac_pci_free_ctl_info(pci);
		return NULL;
	}

	return pci;
}
EXPORT_SYMBOL_GPL(edac_pci_create_generic_ctl);

/*
 * edac_pci_release_generic_ctl
 *
 *	The release function of a generic EDAC PCI polling device
 */
void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci)
{
	edac_dbg(0, "pci mod=%s\n", pci->mod_name);

	edac_pci_del_device(pci->dev);
	edac_pci_free_ctl_info(pci);
}
EXPORT_SYMBOL_GPL(edac_pci_release_generic_ctl);
Commit	Line	Data
91b99041 DJ	1	/*
	2	* EDAC PCI component
	3	*
	4	* Author: Dave Jiang <djiang@mvista.com>
	5	*
	6	* 2007 (c) MontaVista Software, Inc. This file is licensed under
	7	* the terms of the GNU General Public License version 2. This program
	8	* is licensed "as is" without any warranty of any kind, whether express
	9	* or implied.
	10	*
	11	*/
	12	#include <linux/module.h>
	13	#include <linux/types.h>
	14	#include <linux/smp.h>
	15	#include <linux/init.h>
	16	#include <linux/sysctl.h>
	17	#include <linux/highmem.h>
	18	#include <linux/timer.h>
	19	#include <linux/slab.h>
	20	#include <linux/spinlock.h>
	21	#include <linux/list.h>
91b99041 DJ	22	#include <linux/ctype.h>
	23	#include <linux/workqueue.h>
	24	#include <asm/uaccess.h>
	25	#include <asm/page.h>
	26
	27	#include "edac_core.h"
	28	#include "edac_module.h"
	29
	30	static DEFINE_MUTEX(edac_pci_ctls_mutex);
ff6ac2a6	31	static LIST_HEAD(edac_pci_list);
8641a384	32	static atomic_t pci_indexes = ATOMIC_INIT(0);
91b99041	33
91b99041	34	/*
d4c1465b DT	35	* edac_pci_alloc_ctl_info
	36	*
	37	* The alloc() function for the 'edac_pci' control info
	38	* structure. The chip driver will allocate one of these for each
	39	* edac_pci it is going to control/register with the EDAC CORE.
91b99041	40	*/
079708b9	41	struct edac_pci_ctl_info *edac_pci_alloc_ctl_info(unsigned int sz_pvt,
052dfb45	42	const char *edac_pci_name)
91b99041 DJ	43	{
91b99041 DJ	44	struct edac_pci_ctl_info *pci;
93e4fe64	45	void p = NULL, pvt;
91b99041 DJ	46	unsigned int size;
91b99041 DJ	47
956b9ba1	48	edac_dbg(1, "\n");
d4c1465b	49
93e4fe64 MCC	50	pci = edac_align_ptr(&p, sizeof(*pci), 1);
93e4fe64 MCC	51	pvt = edac_align_ptr(&p, 1, sz_pvt);
91b99041 DJ	52	size = ((unsigned long)pvt) + sz_pvt;
91b99041 DJ	53
d4c1465b DT	54	/* Alloc the needed control struct memory */
	55	pci = kzalloc(size, GFP_KERNEL);
	56	if (pci == NULL)
91b99041 DJ	57	return NULL;
91b99041 DJ	58
d4c1465b	59	/* Now much private space */
91b99041 DJ	60	pvt = sz_pvt ? ((char *)pci) + ((unsigned long)pvt) : NULL;
	61
	62	pci->pvt_info = pvt;
91b99041 DJ	63	pci->op_state = OP_ALLOC;
91b99041 DJ	64
079708b9	65	snprintf(pci->name, strlen(edac_pci_name) + 1, "%s", edac_pci_name);
91b99041 DJ	66
	67	return pci;
	68	}
	69	EXPORT_SYMBOL_GPL(edac_pci_alloc_ctl_info);
	70
	71	/*
	72	* edac_pci_free_ctl_info()
d4c1465b DT	73	*
	74	* Last action on the pci control structure.
	75	*
6f042b50	76	* call the remove sysfs information, which will unregister
d4c1465b DT	77	* this control struct's kobj. When that kobj's ref count
	78	* goes to zero, its release function will be call and then
	79	* kfree() the memory.
91b99041 DJ	80	*/
	81	void edac_pci_free_ctl_info(struct edac_pci_ctl_info *pci)
	82	{
956b9ba1	83	edac_dbg(1, "\n");
079708b9	84
d4c1465b DT	85	edac_pci_remove_sysfs(pci);
d4c1465b DT	86	}
91b99041 DJ	87	EXPORT_SYMBOL_GPL(edac_pci_free_ctl_info);
	88
	89	/*
	90	* find_edac_pci_by_dev()
	91	* scans the edac_pci list for a specific 'struct device *'
d4c1465b DT	92	*
d4c1465b DT	93	* return NULL if not found, or return control struct pointer
91b99041	94	*/
079708b9	95	static struct edac_pci_ctl_info find_edac_pci_by_dev(struct device dev)
91b99041 DJ	96	{
	97	struct edac_pci_ctl_info *pci;
	98	struct list_head *item;
	99
956b9ba1	100	edac_dbg(1, "\n");
91b99041 DJ	101
	102	list_for_each(item, &edac_pci_list) {
	103	pci = list_entry(item, struct edac_pci_ctl_info, link);
	104
	105	if (pci->dev == dev)
	106	return pci;
	107	}
	108
	109	return NULL;
	110	}
	111
	112	/*
	113	* add_edac_pci_to_global_list
	114	* Before calling this function, caller must assign a unique value to
	115	* edac_dev->pci_idx.
	116	* Return:
	117	* 0 on success
	118	* 1 on failure
	119	*/
	120	static int add_edac_pci_to_global_list(struct edac_pci_ctl_info *pci)
	121	{
	122	struct list_head item, insert_before;
	123	struct edac_pci_ctl_info *rover;
	124
956b9ba1	125	edac_dbg(1, "\n");
d4c1465b	126
91b99041 DJ	127	insert_before = &edac_pci_list;
	128
	129	/* Determine if already on the list */
d4c1465b DT	130	rover = find_edac_pci_by_dev(pci->dev);
d4c1465b DT	131	if (unlikely(rover != NULL))
91b99041 DJ	132	goto fail0;
	133
	134	/* Insert in ascending order by 'pci_idx', so find position */
	135	list_for_each(item, &edac_pci_list) {
	136	rover = list_entry(item, struct edac_pci_ctl_info, link);
	137
	138	if (rover->pci_idx >= pci->pci_idx) {
	139	if (unlikely(rover->pci_idx == pci->pci_idx))
	140	goto fail1;
	141
	142	insert_before = item;
	143	break;
	144	}
	145	}
	146
	147	list_add_tail_rcu(&pci->link, insert_before);
	148	return 0;
	149
052dfb45	150	fail0:
91b99041	151	edac_printk(KERN_WARNING, EDAC_PCI,
052dfb45	152	"%s (%s) %s %s already assigned %d\n",
281efb17	153	dev_name(rover->dev), edac_dev_name(rover),
052dfb45	154	rover->mod_name, rover->ctl_name, rover->pci_idx);
91b99041 DJ	155	return 1;
91b99041 DJ	156
052dfb45	157	fail1:
91b99041	158	edac_printk(KERN_WARNING, EDAC_PCI,
052dfb45 DT	159	"but in low-level driver: attempt to assign\n"
	160	"\tduplicate pci_idx %d in %s()\n", rover->pci_idx,
	161	__func__);
91b99041 DJ	162	return 1;
	163	}
	164
91b99041 DJ	165	/*
91b99041 DJ	166	* del_edac_pci_from_global_list
d4c1465b DT	167	*
d4c1465b DT	168	* remove the PCI control struct from the global list
91b99041 DJ	169	*/
	170	static void del_edac_pci_from_global_list(struct edac_pci_ctl_info *pci)
	171	{
	172	list_del_rcu(&pci->link);
e2e77098 LJ	173
	174	/* these are for safe removal of devices from global list while
	175	* NMI handlers may be traversing list
	176	*/
	177	synchronize_rcu();
	178	INIT_LIST_HEAD(&pci->link);
91b99041 DJ	179	}
91b99041 DJ	180
1a45027d AB	181	#if 0
	182	/* Older code, but might use in the future */
	183
91b99041 DJ	184	/*
	185	* edac_pci_find()
	186	* Search for an edac_pci_ctl_info structure whose index is 'idx'
	187	*
	188	* If found, return a pointer to the structure
	189	* Else return NULL.
	190	*
	191	* Caller must hold pci_ctls_mutex.
	192	*/
079708b9	193	struct edac_pci_ctl_info *edac_pci_find(int idx)
91b99041 DJ	194	{
	195	struct list_head *item;
	196	struct edac_pci_ctl_info *pci;
	197
	198	/* Iterage over list, looking for exact match of ID */
	199	list_for_each(item, &edac_pci_list) {
	200	pci = list_entry(item, struct edac_pci_ctl_info, link);
	201
	202	if (pci->pci_idx >= idx) {
	203	if (pci->pci_idx == idx)
	204	return pci;
	205
079708b9	206	/* not on list, so terminate early */
91b99041 DJ	207	break;
	208	}
	209	}
	210
	211	return NULL;
	212	}
	213	EXPORT_SYMBOL_GPL(edac_pci_find);
1a45027d	214	#endif
91b99041 DJ	215
	216	/*
	217	* edac_pci_workq_function()
d4c1465b DT	218	*
	219	* periodic function that performs the operation
	220	* scheduled by a workq request, for a given PCI control struct
91b99041	221	*/
91b99041 DJ	222	static void edac_pci_workq_function(struct work_struct *work_req)
91b99041 DJ	223	{
fbeb4384	224	struct delayed_work *d_work = to_delayed_work(work_req);
91b99041	225	struct edac_pci_ctl_info *pci = to_edac_pci_ctl_work(d_work);
d4c1465b DT	226	int msec;
d4c1465b DT	227	unsigned long delay;
91b99041	228
956b9ba1	229	edac_dbg(3, "checking\n");
91b99041	230
d4c1465b	231	mutex_lock(&edac_pci_ctls_mutex);
91b99041	232
d4c1465b DT	233	if (pci->op_state == OP_RUNNING_POLL) {
	234	/* we might be in POLL mode, but there may NOT be a poll func
	235	*/
	236	if ((pci->edac_check != NULL) && edac_pci_get_check_errors())
	237	pci->edac_check(pci);
	238
	239	/* if we are on a one second period, then use round */
	240	msec = edac_pci_get_poll_msec();
	241	if (msec == 1000)
c2ae24cf	242	delay = round_jiffies_relative(msecs_to_jiffies(msec));
d4c1465b DT	243	else
	244	delay = msecs_to_jiffies(msec);
	245
	246	/* Reschedule only if we are in POLL mode */
	247	queue_delayed_work(edac_workqueue, &pci->work, delay);
	248	}
91b99041	249
d4c1465b	250	mutex_unlock(&edac_pci_ctls_mutex);
91b99041 DJ	251	}
	252
	253	/*
	254	* edac_pci_workq_setup()
	255	* initialize a workq item for this edac_pci instance
	256	* passing in the new delay period in msec
d4c1465b DT	257	*
	258	* locking model:
	259	* called when 'edac_pci_ctls_mutex' is locked
91b99041 DJ	260	*/
91b99041 DJ	261	static void edac_pci_workq_setup(struct edac_pci_ctl_info *pci,
079708b9	262	unsigned int msec)
91b99041	263	{
956b9ba1	264	edac_dbg(0, "\n");
91b99041	265
91b99041	266	INIT_DELAYED_WORK(&pci->work, edac_pci_workq_function);
4de78c68	267	queue_delayed_work(edac_workqueue, &pci->work,
052dfb45	268	msecs_to_jiffies(edac_pci_get_poll_msec()));
91b99041 DJ	269	}
	270
	271	/*
	272	* edac_pci_workq_teardown()
	273	* stop the workq processing on this edac_pci instance
	274	*/
	275	static void edac_pci_workq_teardown(struct edac_pci_ctl_info *pci)
	276	{
	277	int status;
	278
956b9ba1	279	edac_dbg(0, "\n");
d4c1465b	280
91b99041 DJ	281	status = cancel_delayed_work(&pci->work);
	282	if (status == 0)
	283	flush_workqueue(edac_workqueue);
	284	}
	285
	286	/*
	287	* edac_pci_reset_delay_period
d4c1465b DT	288	*
	289	* called with a new period value for the workq period
	290	* a) stop current workq timer
	291	* b) restart workq timer with new value
91b99041 DJ	292	*/
91b99041 DJ	293	void edac_pci_reset_delay_period(struct edac_pci_ctl_info *pci,
079708b9	294	unsigned long value)
91b99041	295	{
956b9ba1	296	edac_dbg(0, "\n");
91b99041 DJ	297
	298	edac_pci_workq_teardown(pci);
	299
d4c1465b DT	300	/* need to lock for the setup */
	301	mutex_lock(&edac_pci_ctls_mutex);
	302
91b99041 DJ	303	edac_pci_workq_setup(pci, value);
91b99041 DJ	304
d4c1465b	305	mutex_unlock(&edac_pci_ctls_mutex);
91b99041 DJ	306	}
	307	EXPORT_SYMBOL_GPL(edac_pci_reset_delay_period);
	308
8641a384 HC	309	/*
	310	* edac_pci_alloc_index: Allocate a unique PCI index number
	311	*
	312	* Return:
	313	* allocated index number
	314	*
	315	*/
	316	int edac_pci_alloc_index(void)
	317	{
	318	return atomic_inc_return(&pci_indexes) - 1;
	319	}
	320	EXPORT_SYMBOL_GPL(edac_pci_alloc_index);
	321
91b99041 DJ	322	/*
	323	* edac_pci_add_device: Insert the 'edac_dev' structure into the
	324	* edac_pci global list and create sysfs entries associated with
	325	* edac_pci structure.
	326	* @pci: pointer to the edac_device structure to be added to the list
	327	* @edac_idx: A unique numeric identifier to be assigned to the
	328	* 'edac_pci' structure.
	329	*
	330	* Return:
	331	* 0 Success
	332	* !0 Failure
	333	*/
	334	int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx)
	335	{
956b9ba1	336	edac_dbg(0, "\n");
91b99041 DJ	337
91b99041 DJ	338	pci->pci_idx = edac_idx;
d4c1465b	339	pci->start_time = jiffies;
91b99041	340
d4c1465b	341	mutex_lock(&edac_pci_ctls_mutex);
91b99041 DJ	342
	343	if (add_edac_pci_to_global_list(pci))
	344	goto fail0;
	345
91b99041 DJ	346	if (edac_pci_create_sysfs(pci)) {
	347	edac_pci_printk(pci, KERN_WARNING,
	348	"failed to create sysfs pci\n");
	349	goto fail1;
	350	}
	351
	352	if (pci->edac_check != NULL) {
	353	pci->op_state = OP_RUNNING_POLL;
	354
	355	edac_pci_workq_setup(pci, 1000);
	356	} else {
	357	pci->op_state = OP_RUNNING_INTERRUPT;
	358	}
	359
	360	edac_pci_printk(pci, KERN_INFO,
7270a608 RR	361	"Giving out device to module %s controller %s: DEV %s (%s)\n",
	362	pci->mod_name, pci->ctl_name, pci->dev_name,
	363	edac_op_state_to_string(pci->op_state));
91b99041	364
d4c1465b	365	mutex_unlock(&edac_pci_ctls_mutex);
91b99041 DJ	366	return 0;
91b99041 DJ	367
d4c1465b	368	/* error unwind stack */
052dfb45	369	fail1:
91b99041	370	del_edac_pci_from_global_list(pci);
052dfb45	371	fail0:
d4c1465b	372	mutex_unlock(&edac_pci_ctls_mutex);
91b99041 DJ	373	return 1;
	374	}
	375	EXPORT_SYMBOL_GPL(edac_pci_add_device);
	376
	377	/*
	378	* edac_pci_del_device()
	379	* Remove sysfs entries for specified edac_pci structure and
	380	* then remove edac_pci structure from global list
	381	*
	382	* @dev:
	383	* Pointer to 'struct device' representing edac_pci structure
	384	* to remove
	385	*
	386	* Return:
	387	* Pointer to removed edac_pci structure,
	388	* or NULL if device not found
	389	*/
079708b9	390	struct edac_pci_ctl_info edac_pci_del_device(struct device dev)
91b99041 DJ	391	{
	392	struct edac_pci_ctl_info *pci;
	393
956b9ba1	394	edac_dbg(0, "\n");
91b99041	395
d4c1465b	396	mutex_lock(&edac_pci_ctls_mutex);
91b99041	397
d4c1465b DT	398	/* ensure the control struct is on the global list
	399	* if not, then leave
	400	*/
	401	pci = find_edac_pci_by_dev(dev);
	402	if (pci == NULL) {
	403	mutex_unlock(&edac_pci_ctls_mutex);
91b99041 DJ	404	return NULL;
	405	}
	406
	407	pci->op_state = OP_OFFLINE;
	408
91b99041 DJ	409	del_edac_pci_from_global_list(pci);
91b99041 DJ	410
d4c1465b DT	411	mutex_unlock(&edac_pci_ctls_mutex);
	412
	413	/* stop the workq timer */
	414	edac_pci_workq_teardown(pci);
91b99041 DJ	415
91b99041 DJ	416	edac_printk(KERN_INFO, EDAC_PCI,
052dfb45	417	"Removed device %d for %s %s: DEV %s\n",
17aa7e03	418	pci->pci_idx, pci->mod_name, pci->ctl_name, edac_dev_name(pci));
91b99041 DJ	419
	420	return pci;
	421	}
	422	EXPORT_SYMBOL_GPL(edac_pci_del_device);
	423
d4c1465b DT	424	/*
	425	* edac_pci_generic_check
	426	*
	427	* a Generic parity check API
	428	*/
1a45027d	429	static void edac_pci_generic_check(struct edac_pci_ctl_info *pci)
91b99041	430	{
956b9ba1	431	edac_dbg(4, "\n");
91b99041 DJ	432	edac_pci_do_parity_check();
	433	}
	434
d4c1465b	435	/* free running instance index counter */
f044091c	436	static int edac_pci_idx;
91b99041 DJ	437	#define EDAC_PCI_GENCTL_NAME "EDAC PCI controller"
	438
	439	struct edac_pci_gen_data {
	440	int edac_idx;
	441	};
	442
d4c1465b DT	443	/*
	444	* edac_pci_create_generic_ctl
	445	*
	446	* A generic constructor for a PCI parity polling device
	447	* Some systems have more than one domain of PCI busses.
	448	* For systems with one domain, then this API will
	449	* provide for a generic poller.
	450	*
	451	* This routine calls the edac_pci_alloc_ctl_info() for
	452	* the generic device, with default values
	453	*/
079708b9	454	struct edac_pci_ctl_info edac_pci_create_generic_ctl(struct device dev,
052dfb45	455	const char *mod_name)
91b99041 DJ	456	{
	457	struct edac_pci_ctl_info *pci;
	458	struct edac_pci_gen_data *pdata;
	459
	460	pci = edac_pci_alloc_ctl_info(sizeof(*pdata), EDAC_PCI_GENCTL_NAME);
	461	if (!pci)
	462	return NULL;
	463
	464	pdata = pci->pvt_info;
	465	pci->dev = dev;
	466	dev_set_drvdata(pci->dev, pci);
	467	pci->dev_name = pci_name(to_pci_dev(dev));
	468
	469	pci->mod_name = mod_name;
	470	pci->ctl_name = EDAC_PCI_GENCTL_NAME;
876bb331 BP	471	if (edac_op_state == EDAC_OPSTATE_POLL)
876bb331 BP	472	pci->edac_check = edac_pci_generic_check;
91b99041 DJ	473
	474	pdata->edac_idx = edac_pci_idx++;
	475
	476	if (edac_pci_add_device(pci, pdata->edac_idx) > 0) {
956b9ba1	477	edac_dbg(3, "failed edac_pci_add_device()\n");
91b99041 DJ	478	edac_pci_free_ctl_info(pci);
	479	return NULL;
	480	}
	481
	482	return pci;
	483	}
	484	EXPORT_SYMBOL_GPL(edac_pci_create_generic_ctl);
	485
d4c1465b DT	486	/*
	487	* edac_pci_release_generic_ctl
	488	*
	489	* The release function of a generic EDAC PCI polling device
	490	*/
91b99041 DJ	491	void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci)
91b99041 DJ	492	{
956b9ba1	493	edac_dbg(0, "pci mod=%s\n", pci->mod_name);
d4c1465b	494
91b99041 DJ	495	edac_pci_del_device(pci->dev);
	496	edac_pci_free_ctl_info(pci);
	497	}
	498	EXPORT_SYMBOL_GPL(edac_pci_release_generic_ctl);