4 * Author: Dave Jiang <djiang@mvista.com>
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
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>
28 #include "edac_core.h"
29 #include "edac_module.h"
31 static DEFINE_MUTEX(edac_pci_ctls_mutex);
32 static LIST_HEAD(edac_pci_list);
33 static atomic_t pci_indexes = ATOMIC_INIT(0);
36 * edac_pci_alloc_ctl_info
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.
42 struct edac_pci_ctl_info *edac_pci_alloc_ctl_info(unsigned int sz_pvt,
43 const char *edac_pci_name)
45 struct edac_pci_ctl_info *pci;
49 debugf1("%s()\n", __func__);
51 pci = (struct edac_pci_ctl_info *)0;
52 pvt = edac_align_ptr(&pci[1], sz_pvt);
53 size = ((unsigned long)pvt) + sz_pvt;
55 /* Alloc the needed control struct memory */
56 pci = kzalloc(size, GFP_KERNEL);
60 /* Now much private space */
61 pvt = sz_pvt ? ((char *)pci) + ((unsigned long)pvt) : NULL;
64 pci->op_state = OP_ALLOC;
66 snprintf(pci->name, strlen(edac_pci_name) + 1, "%s", edac_pci_name);
70 EXPORT_SYMBOL_GPL(edac_pci_alloc_ctl_info);
73 * edac_pci_free_ctl_info()
75 * Last action on the pci control structure.
77 * call the remove sysfs information, which will unregister
78 * this control struct's kobj. When that kobj's ref count
79 * goes to zero, its release function will be call and then
82 void edac_pci_free_ctl_info(struct edac_pci_ctl_info *pci)
84 debugf1("%s()\n", __func__);
86 edac_pci_remove_sysfs(pci);
88 EXPORT_SYMBOL_GPL(edac_pci_free_ctl_info);
91 * find_edac_pci_by_dev()
92 * scans the edac_pci list for a specific 'struct device *'
94 * return NULL if not found, or return control struct pointer
96 static struct edac_pci_ctl_info *find_edac_pci_by_dev(struct device *dev)
98 struct edac_pci_ctl_info *pci;
99 struct list_head *item;
101 debugf1("%s()\n", __func__);
103 list_for_each(item, &edac_pci_list) {
104 pci = list_entry(item, struct edac_pci_ctl_info, link);
114 * add_edac_pci_to_global_list
115 * Before calling this function, caller must assign a unique value to
121 static int add_edac_pci_to_global_list(struct edac_pci_ctl_info *pci)
123 struct list_head *item, *insert_before;
124 struct edac_pci_ctl_info *rover;
126 debugf1("%s()\n", __func__);
128 insert_before = &edac_pci_list;
130 /* Determine if already on the list */
131 rover = find_edac_pci_by_dev(pci->dev);
132 if (unlikely(rover != NULL))
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);
139 if (rover->pci_idx >= pci->pci_idx) {
140 if (unlikely(rover->pci_idx == pci->pci_idx))
143 insert_before = item;
148 list_add_tail_rcu(&pci->link, insert_before);
152 edac_printk(KERN_WARNING, EDAC_PCI,
153 "%s (%s) %s %s already assigned %d\n",
154 dev_name(rover->dev), edac_dev_name(rover),
155 rover->mod_name, rover->ctl_name, rover->pci_idx);
159 edac_printk(KERN_WARNING, EDAC_PCI,
160 "but in low-level driver: attempt to assign\n"
161 "\tduplicate pci_idx %d in %s()\n", rover->pci_idx,
167 * del_edac_pci_from_global_list
169 * remove the PCI control struct from the global list
171 static void del_edac_pci_from_global_list(struct edac_pci_ctl_info *pci)
173 list_del_rcu(&pci->link);
175 /* these are for safe removal of devices from global list while
176 * NMI handlers may be traversing list
179 INIT_LIST_HEAD(&pci->link);
183 /* Older code, but might use in the future */
187 * Search for an edac_pci_ctl_info structure whose index is 'idx'
189 * If found, return a pointer to the structure
192 * Caller must hold pci_ctls_mutex.
194 struct edac_pci_ctl_info *edac_pci_find(int idx)
196 struct list_head *item;
197 struct edac_pci_ctl_info *pci;
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);
203 if (pci->pci_idx >= idx) {
204 if (pci->pci_idx == idx)
207 /* not on list, so terminate early */
214 EXPORT_SYMBOL_GPL(edac_pci_find);
218 * edac_pci_workq_function()
220 * periodic function that performs the operation
221 * scheduled by a workq request, for a given PCI control struct
223 static void edac_pci_workq_function(struct work_struct *work_req)
225 struct delayed_work *d_work = to_delayed_work(work_req);
226 struct edac_pci_ctl_info *pci = to_edac_pci_ctl_work(d_work);
230 debugf3("%s() checking\n", __func__);
232 mutex_lock(&edac_pci_ctls_mutex);
234 if (pci->op_state == OP_RUNNING_POLL) {
235 /* we might be in POLL mode, but there may NOT be a poll func
237 if ((pci->edac_check != NULL) && edac_pci_get_check_errors())
238 pci->edac_check(pci);
240 /* if we are on a one second period, then use round */
241 msec = edac_pci_get_poll_msec();
243 delay = round_jiffies_relative(msecs_to_jiffies(msec));
245 delay = msecs_to_jiffies(msec);
247 /* Reschedule only if we are in POLL mode */
248 queue_delayed_work(edac_workqueue, &pci->work, delay);
251 mutex_unlock(&edac_pci_ctls_mutex);
255 * edac_pci_workq_setup()
256 * initialize a workq item for this edac_pci instance
257 * passing in the new delay period in msec
260 * called when 'edac_pci_ctls_mutex' is locked
262 static void edac_pci_workq_setup(struct edac_pci_ctl_info *pci,
265 debugf0("%s()\n", __func__);
267 INIT_DELAYED_WORK(&pci->work, edac_pci_workq_function);
268 queue_delayed_work(edac_workqueue, &pci->work,
269 msecs_to_jiffies(edac_pci_get_poll_msec()));
273 * edac_pci_workq_teardown()
274 * stop the workq processing on this edac_pci instance
276 static void edac_pci_workq_teardown(struct edac_pci_ctl_info *pci)
280 debugf0("%s()\n", __func__);
282 status = cancel_delayed_work(&pci->work);
284 flush_workqueue(edac_workqueue);
288 * edac_pci_reset_delay_period
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
294 void edac_pci_reset_delay_period(struct edac_pci_ctl_info *pci,
297 debugf0("%s()\n", __func__);
299 edac_pci_workq_teardown(pci);
301 /* need to lock for the setup */
302 mutex_lock(&edac_pci_ctls_mutex);
304 edac_pci_workq_setup(pci, value);
306 mutex_unlock(&edac_pci_ctls_mutex);
308 EXPORT_SYMBOL_GPL(edac_pci_reset_delay_period);
311 * edac_pci_alloc_index: Allocate a unique PCI index number
314 * allocated index number
317 int edac_pci_alloc_index(void)
319 return atomic_inc_return(&pci_indexes) - 1;
321 EXPORT_SYMBOL_GPL(edac_pci_alloc_index);
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.
335 int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx)
337 debugf0("%s()\n", __func__);
339 pci->pci_idx = edac_idx;
340 pci->start_time = jiffies;
342 mutex_lock(&edac_pci_ctls_mutex);
344 if (add_edac_pci_to_global_list(pci))
347 if (edac_pci_create_sysfs(pci)) {
348 edac_pci_printk(pci, KERN_WARNING,
349 "failed to create sysfs pci\n");
353 if (pci->edac_check != NULL) {
354 pci->op_state = OP_RUNNING_POLL;
356 edac_pci_workq_setup(pci, 1000);
358 pci->op_state = OP_RUNNING_INTERRUPT;
361 edac_pci_printk(pci, KERN_INFO,
362 "Giving out device to module '%s' controller '%s':"
366 edac_dev_name(pci), edac_op_state_to_string(pci->op_state));
368 mutex_unlock(&edac_pci_ctls_mutex);
371 /* error unwind stack */
373 del_edac_pci_from_global_list(pci);
375 mutex_unlock(&edac_pci_ctls_mutex);
378 EXPORT_SYMBOL_GPL(edac_pci_add_device);
381 * edac_pci_del_device()
382 * Remove sysfs entries for specified edac_pci structure and
383 * then remove edac_pci structure from global list
386 * Pointer to 'struct device' representing edac_pci structure
390 * Pointer to removed edac_pci structure,
391 * or NULL if device not found
393 struct edac_pci_ctl_info *edac_pci_del_device(struct device *dev)
395 struct edac_pci_ctl_info *pci;
397 debugf0("%s()\n", __func__);
399 mutex_lock(&edac_pci_ctls_mutex);
401 /* ensure the control struct is on the global list
404 pci = find_edac_pci_by_dev(dev);
406 mutex_unlock(&edac_pci_ctls_mutex);
410 pci->op_state = OP_OFFLINE;
412 del_edac_pci_from_global_list(pci);
414 mutex_unlock(&edac_pci_ctls_mutex);
416 /* stop the workq timer */
417 edac_pci_workq_teardown(pci);
419 edac_printk(KERN_INFO, EDAC_PCI,
420 "Removed device %d for %s %s: DEV %s\n",
421 pci->pci_idx, pci->mod_name, pci->ctl_name, edac_dev_name(pci));
425 EXPORT_SYMBOL_GPL(edac_pci_del_device);
428 * edac_pci_generic_check
430 * a Generic parity check API
432 static void edac_pci_generic_check(struct edac_pci_ctl_info *pci)
434 debugf4("%s()\n", __func__);
435 edac_pci_do_parity_check();
438 /* free running instance index counter */
439 static int edac_pci_idx;
440 #define EDAC_PCI_GENCTL_NAME "EDAC PCI controller"
442 struct edac_pci_gen_data {
447 * edac_pci_create_generic_ctl
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.
454 * This routine calls the edac_pci_alloc_ctl_info() for
455 * the generic device, with default values
457 struct edac_pci_ctl_info *edac_pci_create_generic_ctl(struct device *dev,
458 const char *mod_name)
460 struct edac_pci_ctl_info *pci;
461 struct edac_pci_gen_data *pdata;
463 pci = edac_pci_alloc_ctl_info(sizeof(*pdata), EDAC_PCI_GENCTL_NAME);
467 pdata = pci->pvt_info;
469 dev_set_drvdata(pci->dev, pci);
470 pci->dev_name = pci_name(to_pci_dev(dev));
472 pci->mod_name = mod_name;
473 pci->ctl_name = EDAC_PCI_GENCTL_NAME;
474 pci->edac_check = edac_pci_generic_check;
476 pdata->edac_idx = edac_pci_idx++;
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);
486 EXPORT_SYMBOL_GPL(edac_pci_create_generic_ctl);
489 * edac_pci_release_generic_ctl
491 * The release function of a generic EDAC PCI polling device
493 void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci)
495 debugf0("%s() pci mod=%s\n", __func__, pci->mod_name);
497 edac_pci_del_device(pci->dev);
498 edac_pci_free_ctl_info(pci);
500 EXPORT_SYMBOL_GPL(edac_pci_release_generic_ctl);