[linux.git] / drivers / edac / edac_pci.c

/*
 * EDAC PCI component
 *
 * Author: Dave Jiang <[email protected]>
 *
 * 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/sysdev.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 struct list_head edac_pci_list = LIST_HEAD_INIT(edac_pci_list);

/*
 * 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 *pvt;
	unsigned int size;

	debugf1("%s()\n", __func__);

	pci = (struct edac_pci_ctl_info *)0;
	pvt = edac_align_ptr(&pci[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 informaton, 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)
{
	debugf1("%s()\n", __func__);

	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;

	debugf1("%s()\n", __func__);

	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;

	debugf1("%s()\n", __func__);

	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",
		rover->dev->bus_id, 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;
}

/*
 * complete_edac_pci_list_del
 *
 *	RCU completion callback to indicate item is deleted
 */
static void complete_edac_pci_list_del(struct rcu_head *head)
{
	struct edac_pci_ctl_info *pci;

	pci = container_of(head, struct edac_pci_ctl_info, rcu);
	INIT_LIST_HEAD(&pci->link);
	complete(&pci->complete);
}

/*
 * 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);
	init_completion(&pci->complete);
	call_rcu(&pci->rcu, complete_edac_pci_list_del);
	wait_for_completion(&pci->complete);
}

/*
 * 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);

/*
 * 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 = (struct delayed_work *)work_req;
	struct edac_pci_ctl_info *pci = to_edac_pci_ctl_work(d_work);
	int msec;
	unsigned long delay;

	debugf3("%s() checking\n", __func__);

	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(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)
{
	debugf0("%s()\n", __func__);

	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;

	debugf0("%s()\n", __func__);

	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)
{
	debugf0("%s()\n", __func__);

	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_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)
{
	debugf0("%s()\n", __func__);

	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,
			dev_name(pci), 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;

	debugf0("%s()\n", __func__);

	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, dev_name(pci));

	return pci;
}
EXPORT_SYMBOL_GPL(edac_pci_del_device);

/*
 * edac_pci_generic_check
 *
 *	a Generic parity check API
 */
void edac_pci_generic_check(struct edac_pci_ctl_info *pci)
{
	debugf4("%s()\n", __func__);
	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;
	pci->edac_check = edac_pci_generic_check;

	pdata->edac_idx = edac_pci_idx++;

	if (edac_pci_add_device(pci, pdata->edac_idx) > 0) {
		debugf3("%s(): failed edac_pci_add_device()\n", __func__);
		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)
{
	debugf0("%s() pci mod=%s\n", __func__, 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 <[email protected]>
	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>
	22	#include <linux/sysdev.h>
	23	#include <linux/ctype.h>
	24	#include <linux/workqueue.h>
	25	#include <asm/uaccess.h>
	26	#include <asm/page.h>
	27
	28	#include "edac_core.h"
	29	#include "edac_module.h"
	30
	31	static DEFINE_MUTEX(edac_pci_ctls_mutex);
	32	static struct list_head edac_pci_list = LIST_HEAD_INIT(edac_pci_list);
	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	{
	44	struct edac_pci_ctl_info *pci;
	45	void *pvt;
	46	unsigned int size;
	47
d4c1465b DT	48	debugf1("%s()\n", __func__);
d4c1465b DT	49
91b99041 DJ	50	pci = (struct edac_pci_ctl_info *)0;
	51	pvt = edac_align_ptr(&pci[1], sz_pvt);
	52	size = ((unsigned long)pvt) + sz_pvt;
	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	*
	76	* call the remove sysfs informaton, which will unregister
	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	{
d4c1465b	83	debugf1("%s()\n", __func__);
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
d4c1465b	100	debugf1("%s()\n", __func__);
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
d4c1465b DT	125	debugf1("%s()\n", __func__);
d4c1465b DT	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 DT	152	"%s (%s) %s %s already assigned %d\n",
	153	rover->dev->bus_id, dev_name(rover),
	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
	165	/*
	166	* complete_edac_pci_list_del
d4c1465b DT	167	*
d4c1465b DT	168	* RCU completion callback to indicate item is deleted
91b99041 DJ	169	*/
	170	static void complete_edac_pci_list_del(struct rcu_head *head)
	171	{
	172	struct edac_pci_ctl_info *pci;
	173
	174	pci = container_of(head, struct edac_pci_ctl_info, rcu);
	175	INIT_LIST_HEAD(&pci->link);
	176	complete(&pci->complete);
	177	}
	178
	179	/*
	180	* del_edac_pci_from_global_list
d4c1465b DT	181	*
d4c1465b DT	182	* remove the PCI control struct from the global list
91b99041 DJ	183	*/
	184	static void del_edac_pci_from_global_list(struct edac_pci_ctl_info *pci)
	185	{
	186	list_del_rcu(&pci->link);
	187	init_completion(&pci->complete);
	188	call_rcu(&pci->rcu, complete_edac_pci_list_del);
	189	wait_for_completion(&pci->complete);
	190	}
	191
	192	/*
	193	* edac_pci_find()
	194	* Search for an edac_pci_ctl_info structure whose index is 'idx'
	195	*
	196	* If found, return a pointer to the structure
	197	* Else return NULL.
	198	*
	199	* Caller must hold pci_ctls_mutex.
	200	*/
079708b9	201	struct edac_pci_ctl_info *edac_pci_find(int idx)
91b99041 DJ	202	{
	203	struct list_head *item;
	204	struct edac_pci_ctl_info *pci;
	205
	206	/* Iterage over list, looking for exact match of ID */
	207	list_for_each(item, &edac_pci_list) {
	208	pci = list_entry(item, struct edac_pci_ctl_info, link);
	209
	210	if (pci->pci_idx >= idx) {
	211	if (pci->pci_idx == idx)
	212	return pci;
	213
079708b9	214	/* not on list, so terminate early */
91b99041 DJ	215	break;
	216	}
	217	}
	218
	219	return NULL;
	220	}
	221	EXPORT_SYMBOL_GPL(edac_pci_find);
	222
	223	/*
	224	* edac_pci_workq_function()
d4c1465b DT	225	*
	226	* periodic function that performs the operation
	227	* scheduled by a workq request, for a given PCI control struct
91b99041	228	*/
91b99041 DJ	229	static void edac_pci_workq_function(struct work_struct *work_req)
	230	{
	231	struct delayed_work d_work = (struct delayed_work )work_req;
	232	struct edac_pci_ctl_info *pci = to_edac_pci_ctl_work(d_work);
d4c1465b DT	233	int msec;
d4c1465b DT	234	unsigned long delay;
91b99041	235
d4c1465b	236	debugf3("%s() checking\n", __func__);
91b99041	237
d4c1465b	238	mutex_lock(&edac_pci_ctls_mutex);
91b99041	239
d4c1465b DT	240	if (pci->op_state == OP_RUNNING_POLL) {
	241	/* we might be in POLL mode, but there may NOT be a poll func
	242	*/
	243	if ((pci->edac_check != NULL) && edac_pci_get_check_errors())
	244	pci->edac_check(pci);
	245
	246	/* if we are on a one second period, then use round */
	247	msec = edac_pci_get_poll_msec();
	248	if (msec == 1000)
	249	delay = round_jiffies(msecs_to_jiffies(msec));
	250	else
	251	delay = msecs_to_jiffies(msec);
	252
	253	/* Reschedule only if we are in POLL mode */
	254	queue_delayed_work(edac_workqueue, &pci->work, delay);
	255	}
91b99041	256
d4c1465b	257	mutex_unlock(&edac_pci_ctls_mutex);
91b99041 DJ	258	}
	259
	260	/*
	261	* edac_pci_workq_setup()
	262	* initialize a workq item for this edac_pci instance
	263	* passing in the new delay period in msec
d4c1465b DT	264	*
	265	* locking model:
	266	* called when 'edac_pci_ctls_mutex' is locked
91b99041 DJ	267	*/
91b99041 DJ	268	static void edac_pci_workq_setup(struct edac_pci_ctl_info *pci,
079708b9	269	unsigned int msec)
91b99041 DJ	270	{
	271	debugf0("%s()\n", __func__);
	272
91b99041	273	INIT_DELAYED_WORK(&pci->work, edac_pci_workq_function);
4de78c68	274	queue_delayed_work(edac_workqueue, &pci->work,
052dfb45	275	msecs_to_jiffies(edac_pci_get_poll_msec()));
91b99041 DJ	276	}
	277
	278	/*
	279	* edac_pci_workq_teardown()
	280	* stop the workq processing on this edac_pci instance
	281	*/
	282	static void edac_pci_workq_teardown(struct edac_pci_ctl_info *pci)
	283	{
	284	int status;
	285
d4c1465b DT	286	debugf0("%s()\n", __func__);
d4c1465b DT	287
91b99041 DJ	288	status = cancel_delayed_work(&pci->work);
	289	if (status == 0)
	290	flush_workqueue(edac_workqueue);
	291	}
	292
	293	/*
	294	* edac_pci_reset_delay_period
d4c1465b DT	295	*
	296	* called with a new period value for the workq period
	297	* a) stop current workq timer
	298	* b) restart workq timer with new value
91b99041 DJ	299	*/
91b99041 DJ	300	void edac_pci_reset_delay_period(struct edac_pci_ctl_info *pci,
079708b9	301	unsigned long value)
91b99041	302	{
d4c1465b	303	debugf0("%s()\n", __func__);
91b99041 DJ	304
	305	edac_pci_workq_teardown(pci);
	306
d4c1465b DT	307	/* need to lock for the setup */
	308	mutex_lock(&edac_pci_ctls_mutex);
	309
91b99041 DJ	310	edac_pci_workq_setup(pci, value);
91b99041 DJ	311
d4c1465b	312	mutex_unlock(&edac_pci_ctls_mutex);
91b99041 DJ	313	}
	314	EXPORT_SYMBOL_GPL(edac_pci_reset_delay_period);
	315
	316	/*
	317	* edac_pci_add_device: Insert the 'edac_dev' structure into the
	318	* edac_pci global list and create sysfs entries associated with
	319	* edac_pci structure.
	320	* @pci: pointer to the edac_device structure to be added to the list
	321	* @edac_idx: A unique numeric identifier to be assigned to the
	322	* 'edac_pci' structure.
	323	*
	324	* Return:
	325	* 0 Success
	326	* !0 Failure
	327	*/
	328	int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx)
	329	{
	330	debugf0("%s()\n", __func__);
	331
	332	pci->pci_idx = edac_idx;
d4c1465b	333	pci->start_time = jiffies;
91b99041	334
d4c1465b	335	mutex_lock(&edac_pci_ctls_mutex);
91b99041 DJ	336
	337	if (add_edac_pci_to_global_list(pci))
	338	goto fail0;
	339
91b99041 DJ	340	if (edac_pci_create_sysfs(pci)) {
	341	edac_pci_printk(pci, KERN_WARNING,
	342	"failed to create sysfs pci\n");
	343	goto fail1;
	344	}
	345
	346	if (pci->edac_check != NULL) {
	347	pci->op_state = OP_RUNNING_POLL;
	348
	349	edac_pci_workq_setup(pci, 1000);
	350	} else {
	351	pci->op_state = OP_RUNNING_INTERRUPT;
	352	}
	353
	354	edac_pci_printk(pci, KERN_INFO,
079708b9 DT	355	"Giving out device to module '%s' controller '%s':"
	356	" DEV '%s' (%s)\n",
	357	pci->mod_name,
	358	pci->ctl_name,
494d0d55	359	dev_name(pci), edac_op_state_to_string(pci->op_state));
91b99041	360
d4c1465b	361	mutex_unlock(&edac_pci_ctls_mutex);
91b99041 DJ	362	return 0;
91b99041 DJ	363
d4c1465b	364	/* error unwind stack */
052dfb45	365	fail1:
91b99041	366	del_edac_pci_from_global_list(pci);
052dfb45	367	fail0:
d4c1465b	368	mutex_unlock(&edac_pci_ctls_mutex);
91b99041 DJ	369	return 1;
	370	}
	371	EXPORT_SYMBOL_GPL(edac_pci_add_device);
	372
	373	/*
	374	* edac_pci_del_device()
	375	* Remove sysfs entries for specified edac_pci structure and
	376	* then remove edac_pci structure from global list
	377	*
	378	* @dev:
	379	* Pointer to 'struct device' representing edac_pci structure
	380	* to remove
	381	*
	382	* Return:
	383	* Pointer to removed edac_pci structure,
	384	* or NULL if device not found
	385	*/
079708b9	386	struct edac_pci_ctl_info edac_pci_del_device(struct device dev)
91b99041 DJ	387	{
	388	struct edac_pci_ctl_info *pci;
	389
	390	debugf0("%s()\n", __func__);
	391
d4c1465b	392	mutex_lock(&edac_pci_ctls_mutex);
91b99041	393
d4c1465b DT	394	/* ensure the control struct is on the global list
	395	* if not, then leave
	396	*/
	397	pci = find_edac_pci_by_dev(dev);
	398	if (pci == NULL) {
	399	mutex_unlock(&edac_pci_ctls_mutex);
91b99041 DJ	400	return NULL;
	401	}
	402
	403	pci->op_state = OP_OFFLINE;
	404
91b99041 DJ	405	del_edac_pci_from_global_list(pci);
91b99041 DJ	406
d4c1465b DT	407	mutex_unlock(&edac_pci_ctls_mutex);
	408
	409	/* stop the workq timer */
	410	edac_pci_workq_teardown(pci);
91b99041 DJ	411
91b99041 DJ	412	edac_printk(KERN_INFO, EDAC_PCI,
052dfb45 DT	413	"Removed device %d for %s %s: DEV %s\n",
052dfb45 DT	414	pci->pci_idx, pci->mod_name, pci->ctl_name, dev_name(pci));
91b99041 DJ	415
	416	return pci;
	417	}
	418	EXPORT_SYMBOL_GPL(edac_pci_del_device);
	419
d4c1465b DT	420	/*
	421	* edac_pci_generic_check
	422	*
	423	* a Generic parity check API
	424	*/
91b99041 DJ	425	void edac_pci_generic_check(struct edac_pci_ctl_info *pci)
91b99041 DJ	426	{
d4c1465b	427	debugf4("%s()\n", __func__);
91b99041 DJ	428	edac_pci_do_parity_check();
	429	}
	430
d4c1465b	431	/* free running instance index counter */
f044091c	432	static int edac_pci_idx;
91b99041 DJ	433	#define EDAC_PCI_GENCTL_NAME "EDAC PCI controller"
	434
	435	struct edac_pci_gen_data {
	436	int edac_idx;
	437	};
	438
d4c1465b DT	439	/*
	440	* edac_pci_create_generic_ctl
	441	*
	442	* A generic constructor for a PCI parity polling device
	443	* Some systems have more than one domain of PCI busses.
	444	* For systems with one domain, then this API will
	445	* provide for a generic poller.
	446	*
	447	* This routine calls the edac_pci_alloc_ctl_info() for
	448	* the generic device, with default values
	449	*/
079708b9	450	struct edac_pci_ctl_info edac_pci_create_generic_ctl(struct device dev,
052dfb45	451	const char *mod_name)
91b99041 DJ	452	{
	453	struct edac_pci_ctl_info *pci;
	454	struct edac_pci_gen_data *pdata;
	455
	456	pci = edac_pci_alloc_ctl_info(sizeof(*pdata), EDAC_PCI_GENCTL_NAME);
	457	if (!pci)
	458	return NULL;
	459
	460	pdata = pci->pvt_info;
	461	pci->dev = dev;
	462	dev_set_drvdata(pci->dev, pci);
	463	pci->dev_name = pci_name(to_pci_dev(dev));
	464
	465	pci->mod_name = mod_name;
	466	pci->ctl_name = EDAC_PCI_GENCTL_NAME;
	467	pci->edac_check = edac_pci_generic_check;
	468
	469	pdata->edac_idx = edac_pci_idx++;
	470
	471	if (edac_pci_add_device(pci, pdata->edac_idx) > 0) {
	472	debugf3("%s(): failed edac_pci_add_device()\n", __func__);
	473	edac_pci_free_ctl_info(pci);
	474	return NULL;
	475	}
	476
	477	return pci;
	478	}
	479	EXPORT_SYMBOL_GPL(edac_pci_create_generic_ctl);
	480
d4c1465b DT	481	/*
	482	* edac_pci_release_generic_ctl
	483	*
	484	* The release function of a generic EDAC PCI polling device
	485	*/
91b99041 DJ	486	void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci)
91b99041 DJ	487	{
d4c1465b DT	488	debugf0("%s() pci mod=%s\n", __func__, pci->mod_name);
d4c1465b DT	489
91b99041 DJ	490	edac_pci_del_device(pci->dev);
	491	edac_pci_free_ctl_info(pci);
	492	}
	493	EXPORT_SYMBOL_GPL(edac_pci_release_generic_ctl);