[deliverable/linux.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/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 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 *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 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)
{
	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",
		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;

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