Merge branch 'for-3.11' of git://linux-nfs.org/~bfields/linux
[linux-2.6.git] / drivers / edac / edac_pci_sysfs.c
blobe8658e451762647774f71b79101f61efb39194d9
1 /*
2 * (C) 2005, 2006 Linux Networx (http://lnxi.com)
3 * This file may be distributed under the terms of the
4 * GNU General Public License.
6 * Written Doug Thompson <norsk5@xmission.com>
8 */
9 #include <linux/module.h>
10 #include <linux/edac.h>
11 #include <linux/slab.h>
12 #include <linux/ctype.h>
14 #include "edac_core.h"
15 #include "edac_module.h"
17 /* Turn off this whole feature if PCI is not configured */
18 #ifdef CONFIG_PCI
20 #define EDAC_PCI_SYMLINK "device"
22 /* data variables exported via sysfs */
23 static int check_pci_errors; /* default NO check PCI parity */
24 static int edac_pci_panic_on_pe; /* default NO panic on PCI Parity */
25 static int edac_pci_log_pe = 1; /* log PCI parity errors */
26 static int edac_pci_log_npe = 1; /* log PCI non-parity error errors */
27 static int edac_pci_poll_msec = 1000; /* one second workq period */
29 static atomic_t pci_parity_count = ATOMIC_INIT(0);
30 static atomic_t pci_nonparity_count = ATOMIC_INIT(0);
32 static struct kobject *edac_pci_top_main_kobj;
33 static atomic_t edac_pci_sysfs_refcount = ATOMIC_INIT(0);
35 /* getter functions for the data variables */
36 int edac_pci_get_check_errors(void)
38 return check_pci_errors;
41 static int edac_pci_get_log_pe(void)
43 return edac_pci_log_pe;
46 static int edac_pci_get_log_npe(void)
48 return edac_pci_log_npe;
51 static int edac_pci_get_panic_on_pe(void)
53 return edac_pci_panic_on_pe;
56 int edac_pci_get_poll_msec(void)
58 return edac_pci_poll_msec;
61 /**************************** EDAC PCI sysfs instance *******************/
62 static ssize_t instance_pe_count_show(struct edac_pci_ctl_info *pci, char *data)
64 return sprintf(data, "%u\n", atomic_read(&pci->counters.pe_count));
67 static ssize_t instance_npe_count_show(struct edac_pci_ctl_info *pci,
68 char *data)
70 return sprintf(data, "%u\n", atomic_read(&pci->counters.npe_count));
73 #define to_instance(k) container_of(k, struct edac_pci_ctl_info, kobj)
74 #define to_instance_attr(a) container_of(a, struct instance_attribute, attr)
76 /* DEVICE instance kobject release() function */
77 static void edac_pci_instance_release(struct kobject *kobj)
79 struct edac_pci_ctl_info *pci;
81 edac_dbg(0, "\n");
83 /* Form pointer to containing struct, the pci control struct */
84 pci = to_instance(kobj);
86 /* decrement reference count on top main kobj */
87 kobject_put(edac_pci_top_main_kobj);
89 kfree(pci); /* Free the control struct */
92 /* instance specific attribute structure */
93 struct instance_attribute {
94 struct attribute attr;
95 ssize_t(*show) (struct edac_pci_ctl_info *, char *);
96 ssize_t(*store) (struct edac_pci_ctl_info *, const char *, size_t);
99 /* Function to 'show' fields from the edac_pci 'instance' structure */
100 static ssize_t edac_pci_instance_show(struct kobject *kobj,
101 struct attribute *attr, char *buffer)
103 struct edac_pci_ctl_info *pci = to_instance(kobj);
104 struct instance_attribute *instance_attr = to_instance_attr(attr);
106 if (instance_attr->show)
107 return instance_attr->show(pci, buffer);
108 return -EIO;
111 /* Function to 'store' fields into the edac_pci 'instance' structure */
112 static ssize_t edac_pci_instance_store(struct kobject *kobj,
113 struct attribute *attr,
114 const char *buffer, size_t count)
116 struct edac_pci_ctl_info *pci = to_instance(kobj);
117 struct instance_attribute *instance_attr = to_instance_attr(attr);
119 if (instance_attr->store)
120 return instance_attr->store(pci, buffer, count);
121 return -EIO;
124 /* fs_ops table */
125 static const struct sysfs_ops pci_instance_ops = {
126 .show = edac_pci_instance_show,
127 .store = edac_pci_instance_store
130 #define INSTANCE_ATTR(_name, _mode, _show, _store) \
131 static struct instance_attribute attr_instance_##_name = { \
132 .attr = {.name = __stringify(_name), .mode = _mode }, \
133 .show = _show, \
134 .store = _store, \
137 INSTANCE_ATTR(pe_count, S_IRUGO, instance_pe_count_show, NULL);
138 INSTANCE_ATTR(npe_count, S_IRUGO, instance_npe_count_show, NULL);
140 /* pci instance attributes */
141 static struct instance_attribute *pci_instance_attr[] = {
142 &attr_instance_pe_count,
143 &attr_instance_npe_count,
144 NULL
147 /* the ktype for a pci instance */
148 static struct kobj_type ktype_pci_instance = {
149 .release = edac_pci_instance_release,
150 .sysfs_ops = &pci_instance_ops,
151 .default_attrs = (struct attribute **)pci_instance_attr,
155 * edac_pci_create_instance_kobj
157 * construct one EDAC PCI instance's kobject for use
159 static int edac_pci_create_instance_kobj(struct edac_pci_ctl_info *pci, int idx)
161 struct kobject *main_kobj;
162 int err;
164 edac_dbg(0, "\n");
166 /* First bump the ref count on the top main kobj, which will
167 * track the number of PCI instances we have, and thus nest
168 * properly on keeping the module loaded
170 main_kobj = kobject_get(edac_pci_top_main_kobj);
171 if (!main_kobj) {
172 err = -ENODEV;
173 goto error_out;
176 /* And now register this new kobject under the main kobj */
177 err = kobject_init_and_add(&pci->kobj, &ktype_pci_instance,
178 edac_pci_top_main_kobj, "pci%d", idx);
179 if (err != 0) {
180 edac_dbg(2, "failed to register instance pci%d\n", idx);
181 kobject_put(edac_pci_top_main_kobj);
182 goto error_out;
185 kobject_uevent(&pci->kobj, KOBJ_ADD);
186 edac_dbg(1, "Register instance 'pci%d' kobject\n", idx);
188 return 0;
190 /* Error unwind statck */
191 error_out:
192 return err;
196 * edac_pci_unregister_sysfs_instance_kobj
198 * unregister the kobj for the EDAC PCI instance
200 static void edac_pci_unregister_sysfs_instance_kobj(
201 struct edac_pci_ctl_info *pci)
203 edac_dbg(0, "\n");
205 /* Unregister the instance kobject and allow its release
206 * function release the main reference count and then
207 * kfree the memory
209 kobject_put(&pci->kobj);
212 /***************************** EDAC PCI sysfs root **********************/
213 #define to_edacpci(k) container_of(k, struct edac_pci_ctl_info, kobj)
214 #define to_edacpci_attr(a) container_of(a, struct edac_pci_attr, attr)
216 /* simple show/store functions for attributes */
217 static ssize_t edac_pci_int_show(void *ptr, char *buffer)
219 int *value = ptr;
220 return sprintf(buffer, "%d\n", *value);
223 static ssize_t edac_pci_int_store(void *ptr, const char *buffer, size_t count)
225 int *value = ptr;
227 if (isdigit(*buffer))
228 *value = simple_strtoul(buffer, NULL, 0);
230 return count;
233 struct edac_pci_dev_attribute {
234 struct attribute attr;
235 void *value;
236 ssize_t(*show) (void *, char *);
237 ssize_t(*store) (void *, const char *, size_t);
240 /* Set of show/store abstract level functions for PCI Parity object */
241 static ssize_t edac_pci_dev_show(struct kobject *kobj, struct attribute *attr,
242 char *buffer)
244 struct edac_pci_dev_attribute *edac_pci_dev;
245 edac_pci_dev = (struct edac_pci_dev_attribute *)attr;
247 if (edac_pci_dev->show)
248 return edac_pci_dev->show(edac_pci_dev->value, buffer);
249 return -EIO;
252 static ssize_t edac_pci_dev_store(struct kobject *kobj,
253 struct attribute *attr, const char *buffer,
254 size_t count)
256 struct edac_pci_dev_attribute *edac_pci_dev;
257 edac_pci_dev = (struct edac_pci_dev_attribute *)attr;
259 if (edac_pci_dev->store)
260 return edac_pci_dev->store(edac_pci_dev->value, buffer, count);
261 return -EIO;
264 static const struct sysfs_ops edac_pci_sysfs_ops = {
265 .show = edac_pci_dev_show,
266 .store = edac_pci_dev_store
269 #define EDAC_PCI_ATTR(_name,_mode,_show,_store) \
270 static struct edac_pci_dev_attribute edac_pci_attr_##_name = { \
271 .attr = {.name = __stringify(_name), .mode = _mode }, \
272 .value = &_name, \
273 .show = _show, \
274 .store = _store, \
277 #define EDAC_PCI_STRING_ATTR(_name,_data,_mode,_show,_store) \
278 static struct edac_pci_dev_attribute edac_pci_attr_##_name = { \
279 .attr = {.name = __stringify(_name), .mode = _mode }, \
280 .value = _data, \
281 .show = _show, \
282 .store = _store, \
285 /* PCI Parity control files */
286 EDAC_PCI_ATTR(check_pci_errors, S_IRUGO | S_IWUSR, edac_pci_int_show,
287 edac_pci_int_store);
288 EDAC_PCI_ATTR(edac_pci_log_pe, S_IRUGO | S_IWUSR, edac_pci_int_show,
289 edac_pci_int_store);
290 EDAC_PCI_ATTR(edac_pci_log_npe, S_IRUGO | S_IWUSR, edac_pci_int_show,
291 edac_pci_int_store);
292 EDAC_PCI_ATTR(edac_pci_panic_on_pe, S_IRUGO | S_IWUSR, edac_pci_int_show,
293 edac_pci_int_store);
294 EDAC_PCI_ATTR(pci_parity_count, S_IRUGO, edac_pci_int_show, NULL);
295 EDAC_PCI_ATTR(pci_nonparity_count, S_IRUGO, edac_pci_int_show, NULL);
297 /* Base Attributes of the memory ECC object */
298 static struct edac_pci_dev_attribute *edac_pci_attr[] = {
299 &edac_pci_attr_check_pci_errors,
300 &edac_pci_attr_edac_pci_log_pe,
301 &edac_pci_attr_edac_pci_log_npe,
302 &edac_pci_attr_edac_pci_panic_on_pe,
303 &edac_pci_attr_pci_parity_count,
304 &edac_pci_attr_pci_nonparity_count,
305 NULL,
309 * edac_pci_release_main_kobj
311 * This release function is called when the reference count to the
312 * passed kobj goes to zero.
314 * This kobj is the 'main' kobject that EDAC PCI instances
315 * link to, and thus provide for proper nesting counts
317 static void edac_pci_release_main_kobj(struct kobject *kobj)
319 edac_dbg(0, "here to module_put(THIS_MODULE)\n");
321 kfree(kobj);
323 /* last reference to top EDAC PCI kobject has been removed,
324 * NOW release our ref count on the core module
326 module_put(THIS_MODULE);
329 /* ktype struct for the EDAC PCI main kobj */
330 static struct kobj_type ktype_edac_pci_main_kobj = {
331 .release = edac_pci_release_main_kobj,
332 .sysfs_ops = &edac_pci_sysfs_ops,
333 .default_attrs = (struct attribute **)edac_pci_attr,
337 * edac_pci_main_kobj_setup()
339 * setup the sysfs for EDAC PCI attributes
340 * assumes edac_subsys has already been initialized
342 static int edac_pci_main_kobj_setup(void)
344 int err;
345 struct bus_type *edac_subsys;
347 edac_dbg(0, "\n");
349 /* check and count if we have already created the main kobject */
350 if (atomic_inc_return(&edac_pci_sysfs_refcount) != 1)
351 return 0;
353 /* First time, so create the main kobject and its
354 * controls and attributes
356 edac_subsys = edac_get_sysfs_subsys();
357 if (edac_subsys == NULL) {
358 edac_dbg(1, "no edac_subsys\n");
359 err = -ENODEV;
360 goto decrement_count_fail;
363 /* Bump the reference count on this module to ensure the
364 * modules isn't unloaded until we deconstruct the top
365 * level main kobj for EDAC PCI
367 if (!try_module_get(THIS_MODULE)) {
368 edac_dbg(1, "try_module_get() failed\n");
369 err = -ENODEV;
370 goto mod_get_fail;
373 edac_pci_top_main_kobj = kzalloc(sizeof(struct kobject), GFP_KERNEL);
374 if (!edac_pci_top_main_kobj) {
375 edac_dbg(1, "Failed to allocate\n");
376 err = -ENOMEM;
377 goto kzalloc_fail;
380 /* Instanstiate the pci object */
381 err = kobject_init_and_add(edac_pci_top_main_kobj,
382 &ktype_edac_pci_main_kobj,
383 &edac_subsys->dev_root->kobj, "pci");
384 if (err) {
385 edac_dbg(1, "Failed to register '.../edac/pci'\n");
386 goto kobject_init_and_add_fail;
389 /* At this point, to 'release' the top level kobject
390 * for EDAC PCI, then edac_pci_main_kobj_teardown()
391 * must be used, for resources to be cleaned up properly
393 kobject_uevent(edac_pci_top_main_kobj, KOBJ_ADD);
394 edac_dbg(1, "Registered '.../edac/pci' kobject\n");
396 return 0;
398 /* Error unwind statck */
399 kobject_init_and_add_fail:
400 kfree(edac_pci_top_main_kobj);
402 kzalloc_fail:
403 module_put(THIS_MODULE);
405 mod_get_fail:
406 edac_put_sysfs_subsys();
408 decrement_count_fail:
409 /* if are on this error exit, nothing to tear down */
410 atomic_dec(&edac_pci_sysfs_refcount);
412 return err;
416 * edac_pci_main_kobj_teardown()
418 * if no longer linked (needed) remove the top level EDAC PCI
419 * kobject with its controls and attributes
421 static void edac_pci_main_kobj_teardown(void)
423 edac_dbg(0, "\n");
425 /* Decrement the count and only if no more controller instances
426 * are connected perform the unregisteration of the top level
427 * main kobj
429 if (atomic_dec_return(&edac_pci_sysfs_refcount) == 0) {
430 edac_dbg(0, "called kobject_put on main kobj\n");
431 kobject_put(edac_pci_top_main_kobj);
432 edac_put_sysfs_subsys();
438 * edac_pci_create_sysfs
440 * Create the controls/attributes for the specified EDAC PCI device
442 int edac_pci_create_sysfs(struct edac_pci_ctl_info *pci)
444 int err;
445 struct kobject *edac_kobj = &pci->kobj;
447 edac_dbg(0, "idx=%d\n", pci->pci_idx);
449 /* create the top main EDAC PCI kobject, IF needed */
450 err = edac_pci_main_kobj_setup();
451 if (err)
452 return err;
454 /* Create this instance's kobject under the MAIN kobject */
455 err = edac_pci_create_instance_kobj(pci, pci->pci_idx);
456 if (err)
457 goto unregister_cleanup;
459 err = sysfs_create_link(edac_kobj, &pci->dev->kobj, EDAC_PCI_SYMLINK);
460 if (err) {
461 edac_dbg(0, "sysfs_create_link() returned err= %d\n", err);
462 goto symlink_fail;
465 return 0;
467 /* Error unwind stack */
468 symlink_fail:
469 edac_pci_unregister_sysfs_instance_kobj(pci);
471 unregister_cleanup:
472 edac_pci_main_kobj_teardown();
474 return err;
478 * edac_pci_remove_sysfs
480 * remove the controls and attributes for this EDAC PCI device
482 void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci)
484 edac_dbg(0, "index=%d\n", pci->pci_idx);
486 /* Remove the symlink */
487 sysfs_remove_link(&pci->kobj, EDAC_PCI_SYMLINK);
489 /* remove this PCI instance's sysfs entries */
490 edac_pci_unregister_sysfs_instance_kobj(pci);
492 /* Call the main unregister function, which will determine
493 * if this 'pci' is the last instance.
494 * If it is, the main kobject will be unregistered as a result
496 edac_dbg(0, "calling edac_pci_main_kobj_teardown()\n");
497 edac_pci_main_kobj_teardown();
500 /************************ PCI error handling *************************/
501 static u16 get_pci_parity_status(struct pci_dev *dev, int secondary)
503 int where;
504 u16 status;
506 where = secondary ? PCI_SEC_STATUS : PCI_STATUS;
507 pci_read_config_word(dev, where, &status);
509 /* If we get back 0xFFFF then we must suspect that the card has been
510 * pulled but the Linux PCI layer has not yet finished cleaning up.
511 * We don't want to report on such devices
514 if (status == 0xFFFF) {
515 u32 sanity;
517 pci_read_config_dword(dev, 0, &sanity);
519 if (sanity == 0xFFFFFFFF)
520 return 0;
523 status &= PCI_STATUS_DETECTED_PARITY | PCI_STATUS_SIG_SYSTEM_ERROR |
524 PCI_STATUS_PARITY;
526 if (status)
527 /* reset only the bits we are interested in */
528 pci_write_config_word(dev, where, status);
530 return status;
534 /* Clear any PCI parity errors logged by this device. */
535 static void edac_pci_dev_parity_clear(struct pci_dev *dev)
537 u8 header_type;
539 get_pci_parity_status(dev, 0);
541 /* read the device TYPE, looking for bridges */
542 pci_read_config_byte(dev, PCI_HEADER_TYPE, &header_type);
544 if ((header_type & 0x7F) == PCI_HEADER_TYPE_BRIDGE)
545 get_pci_parity_status(dev, 1);
549 * PCI Parity polling
551 * Function to retrieve the current parity status
552 * and decode it
555 static void edac_pci_dev_parity_test(struct pci_dev *dev)
557 unsigned long flags;
558 u16 status;
559 u8 header_type;
561 /* stop any interrupts until we can acquire the status */
562 local_irq_save(flags);
564 /* read the STATUS register on this device */
565 status = get_pci_parity_status(dev, 0);
567 /* read the device TYPE, looking for bridges */
568 pci_read_config_byte(dev, PCI_HEADER_TYPE, &header_type);
570 local_irq_restore(flags);
572 edac_dbg(4, "PCI STATUS= 0x%04x %s\n", status, dev_name(&dev->dev));
574 /* check the status reg for errors on boards NOT marked as broken
575 * if broken, we cannot trust any of the status bits
577 if (status && !dev->broken_parity_status) {
578 if (status & (PCI_STATUS_SIG_SYSTEM_ERROR)) {
579 edac_printk(KERN_CRIT, EDAC_PCI,
580 "Signaled System Error on %s\n",
581 pci_name(dev));
582 atomic_inc(&pci_nonparity_count);
585 if (status & (PCI_STATUS_PARITY)) {
586 edac_printk(KERN_CRIT, EDAC_PCI,
587 "Master Data Parity Error on %s\n",
588 pci_name(dev));
590 atomic_inc(&pci_parity_count);
593 if (status & (PCI_STATUS_DETECTED_PARITY)) {
594 edac_printk(KERN_CRIT, EDAC_PCI,
595 "Detected Parity Error on %s\n",
596 pci_name(dev));
598 atomic_inc(&pci_parity_count);
603 edac_dbg(4, "PCI HEADER TYPE= 0x%02x %s\n",
604 header_type, dev_name(&dev->dev));
606 if ((header_type & 0x7F) == PCI_HEADER_TYPE_BRIDGE) {
607 /* On bridges, need to examine secondary status register */
608 status = get_pci_parity_status(dev, 1);
610 edac_dbg(4, "PCI SEC_STATUS= 0x%04x %s\n",
611 status, dev_name(&dev->dev));
613 /* check the secondary status reg for errors,
614 * on NOT broken boards
616 if (status && !dev->broken_parity_status) {
617 if (status & (PCI_STATUS_SIG_SYSTEM_ERROR)) {
618 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
619 "Signaled System Error on %s\n",
620 pci_name(dev));
621 atomic_inc(&pci_nonparity_count);
624 if (status & (PCI_STATUS_PARITY)) {
625 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
626 "Master Data Parity Error on "
627 "%s\n", pci_name(dev));
629 atomic_inc(&pci_parity_count);
632 if (status & (PCI_STATUS_DETECTED_PARITY)) {
633 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
634 "Detected Parity Error on %s\n",
635 pci_name(dev));
637 atomic_inc(&pci_parity_count);
643 /* reduce some complexity in definition of the iterator */
644 typedef void (*pci_parity_check_fn_t) (struct pci_dev *dev);
647 * pci_dev parity list iterator
649 * Scan the PCI device list looking for SERRORs, Master Parity ERRORS or
650 * Parity ERRORs on primary or secondary devices.
652 static inline void edac_pci_dev_parity_iterator(pci_parity_check_fn_t fn)
654 struct pci_dev *dev = NULL;
656 for_each_pci_dev(dev)
657 fn(dev);
661 * edac_pci_do_parity_check
663 * performs the actual PCI parity check operation
665 void edac_pci_do_parity_check(void)
667 int before_count;
669 edac_dbg(3, "\n");
671 /* if policy has PCI check off, leave now */
672 if (!check_pci_errors)
673 return;
675 before_count = atomic_read(&pci_parity_count);
677 /* scan all PCI devices looking for a Parity Error on devices and
678 * bridges.
679 * The iterator calls pci_get_device() which might sleep, thus
680 * we cannot disable interrupts in this scan.
682 edac_pci_dev_parity_iterator(edac_pci_dev_parity_test);
684 /* Only if operator has selected panic on PCI Error */
685 if (edac_pci_get_panic_on_pe()) {
686 /* If the count is different 'after' from 'before' */
687 if (before_count != atomic_read(&pci_parity_count))
688 panic("EDAC: PCI Parity Error");
693 * edac_pci_clear_parity_errors
695 * function to perform an iteration over the PCI devices
696 * and clearn their current status
698 void edac_pci_clear_parity_errors(void)
700 /* Clear any PCI bus parity errors that devices initially have logged
701 * in their registers.
703 edac_pci_dev_parity_iterator(edac_pci_dev_parity_clear);
707 * edac_pci_handle_pe
709 * Called to handle a PARITY ERROR event
711 void edac_pci_handle_pe(struct edac_pci_ctl_info *pci, const char *msg)
714 /* global PE counter incremented by edac_pci_do_parity_check() */
715 atomic_inc(&pci->counters.pe_count);
717 if (edac_pci_get_log_pe())
718 edac_pci_printk(pci, KERN_WARNING,
719 "Parity Error ctl: %s %d: %s\n",
720 pci->ctl_name, pci->pci_idx, msg);
723 * poke all PCI devices and see which one is the troublemaker
724 * panic() is called if set
726 edac_pci_do_parity_check();
728 EXPORT_SYMBOL_GPL(edac_pci_handle_pe);
732 * edac_pci_handle_npe
734 * Called to handle a NON-PARITY ERROR event
736 void edac_pci_handle_npe(struct edac_pci_ctl_info *pci, const char *msg)
739 /* global NPE counter incremented by edac_pci_do_parity_check() */
740 atomic_inc(&pci->counters.npe_count);
742 if (edac_pci_get_log_npe())
743 edac_pci_printk(pci, KERN_WARNING,
744 "Non-Parity Error ctl: %s %d: %s\n",
745 pci->ctl_name, pci->pci_idx, msg);
748 * poke all PCI devices and see which one is the troublemaker
749 * panic() is called if set
751 edac_pci_do_parity_check();
753 EXPORT_SYMBOL_GPL(edac_pci_handle_npe);
756 * Define the PCI parameter to the module
758 module_param(check_pci_errors, int, 0644);
759 MODULE_PARM_DESC(check_pci_errors,
760 "Check for PCI bus parity errors: 0=off 1=on");
761 module_param(edac_pci_panic_on_pe, int, 0644);
762 MODULE_PARM_DESC(edac_pci_panic_on_pe,
763 "Panic on PCI Bus Parity error: 0=off 1=on");
765 #endif /* CONFIG_PCI */