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>
9 #include <linux/module.h>
10 #include <linux/sysdev.h>
11 #include <linux/ctype.h>
13 #include "edac_core.h"
14 #include "edac_module.h"
16 /* Turn off this whole feature if PCI is not configured */
19 #define EDAC_PCI_SYMLINK "device"
21 /* data variables exported via sysfs */
22 static int check_pci_errors; /* default NO check PCI parity */
23 static int edac_pci_panic_on_pe; /* default NO panic on PCI Parity */
24 static int edac_pci_log_pe = 1; /* log PCI parity errors */
25 static int edac_pci_log_npe = 1; /* log PCI non-parity error errors */
26 static int edac_pci_poll_msec = 1000; /* one second workq period */
28 static atomic_t pci_parity_count = ATOMIC_INIT(0);
29 static atomic_t pci_nonparity_count = ATOMIC_INIT(0);
31 static struct kobject edac_pci_top_main_kobj;
32 static atomic_t edac_pci_sysfs_refcount = ATOMIC_INIT(0);
34 /* getter functions for the data variables */
35 int edac_pci_get_check_errors(void)
37 return check_pci_errors;
40 static int edac_pci_get_log_pe(void)
42 return edac_pci_log_pe;
45 static int edac_pci_get_log_npe(void)
47 return edac_pci_log_npe;
50 static int edac_pci_get_panic_on_pe(void)
52 return edac_pci_panic_on_pe;
55 int edac_pci_get_poll_msec(void)
57 return edac_pci_poll_msec;
60 /**************************** EDAC PCI sysfs instance *******************/
61 static ssize_t instance_pe_count_show(struct edac_pci_ctl_info *pci, char *data)
63 return sprintf(data, "%u\n", atomic_read(&pci->counters.pe_count));
66 static ssize_t instance_npe_count_show(struct edac_pci_ctl_info *pci,
69 return sprintf(data, "%u\n", atomic_read(&pci->counters.npe_count));
72 #define to_instance(k) container_of(k, struct edac_pci_ctl_info, kobj)
73 #define to_instance_attr(a) container_of(a, struct instance_attribute, attr)
75 /* DEVICE instance kobject release() function */
76 static void edac_pci_instance_release(struct kobject *kobj)
78 struct edac_pci_ctl_info *pci;
80 debugf0("%s()\n", __func__);
82 /* Form pointer to containing struct, the pci control struct */
83 pci = to_instance(kobj);
85 /* decrement reference count on top main kobj */
86 kobject_put(&edac_pci_top_main_kobj);
88 kfree(pci); /* Free the control struct */
91 /* instance specific attribute structure */
92 struct instance_attribute {
93 struct attribute attr;
94 ssize_t(*show) (struct edac_pci_ctl_info *, char *);
95 ssize_t(*store) (struct edac_pci_ctl_info *, const char *, size_t);
98 /* Function to 'show' fields from the edac_pci 'instance' structure */
99 static ssize_t edac_pci_instance_show(struct kobject *kobj,
100 struct attribute *attr, char *buffer)
102 struct edac_pci_ctl_info *pci = to_instance(kobj);
103 struct instance_attribute *instance_attr = to_instance_attr(attr);
105 if (instance_attr->show)
106 return instance_attr->show(pci, buffer);
110 /* Function to 'store' fields into the edac_pci 'instance' structure */
111 static ssize_t edac_pci_instance_store(struct kobject *kobj,
112 struct attribute *attr,
113 const char *buffer, size_t count)
115 struct edac_pci_ctl_info *pci = to_instance(kobj);
116 struct instance_attribute *instance_attr = to_instance_attr(attr);
118 if (instance_attr->store)
119 return instance_attr->store(pci, buffer, count);
124 static struct sysfs_ops pci_instance_ops = {
125 .show = edac_pci_instance_show,
126 .store = edac_pci_instance_store
129 #define INSTANCE_ATTR(_name, _mode, _show, _store) \
130 static struct instance_attribute attr_instance_##_name = { \
131 .attr = {.name = __stringify(_name), .mode = _mode }, \
136 INSTANCE_ATTR(pe_count, S_IRUGO, instance_pe_count_show, NULL);
137 INSTANCE_ATTR(npe_count, S_IRUGO, instance_npe_count_show, NULL);
139 /* pci instance attributes */
140 static struct instance_attribute *pci_instance_attr[] = {
141 &attr_instance_pe_count,
142 &attr_instance_npe_count,
146 /* the ktype for a pci instance */
147 static struct kobj_type ktype_pci_instance = {
148 .release = edac_pci_instance_release,
149 .sysfs_ops = &pci_instance_ops,
150 .default_attrs = (struct attribute **)pci_instance_attr,
154 * edac_pci_create_instance_kobj
156 * construct one EDAC PCI instance's kobject for use
158 static int edac_pci_create_instance_kobj(struct edac_pci_ctl_info *pci, int idx)
160 struct kobject *main_kobj;
163 debugf0("%s()\n", __func__);
165 /* First bump the ref count on the top main kobj, which will
166 * track the number of PCI instances we have, and thus nest
167 * properly on keeping the module loaded
169 main_kobj = kobject_get(&edac_pci_top_main_kobj);
175 /* And now register this new kobject under the main kobj */
176 err = kobject_init_and_add(&pci->kobj, &ktype_pci_instance,
177 &edac_pci_top_main_kobj, "pci%d", idx);
179 debugf2("%s() failed to register instance pci%d\n",
181 kobject_put(&edac_pci_top_main_kobj);
185 kobject_uevent(&pci->kobj, KOBJ_ADD);
186 debugf1("%s() Register instance 'pci%d' kobject\n", __func__, idx);
190 /* Error unwind statck */
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 debugf0("%s()\n", __func__);
205 /* Unregister the instance kobject and allow its release
206 * function release the main reference count and then
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)
220 return sprintf(buffer, "%d\n", *value);
223 static ssize_t edac_pci_int_store(void *ptr, const char *buffer, size_t count)
227 if (isdigit(*buffer))
228 *value = simple_strtoul(buffer, NULL, 0);
233 struct edac_pci_dev_attribute {
234 struct attribute attr;
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,
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);
252 static ssize_t edac_pci_dev_store(struct kobject *kobj,
253 struct attribute *attr, const char *buffer,
256 struct edac_pci_dev_attribute *edac_pci_dev;
257 edac_pci_dev = (struct edac_pci_dev_attribute *)attr;
259 if (edac_pci_dev->show)
260 return edac_pci_dev->store(edac_pci_dev->value, buffer, count);
264 static 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 }, \
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 }, \
285 /* PCI Parity control files */
286 EDAC_PCI_ATTR(check_pci_errors, S_IRUGO | S_IWUSR, edac_pci_int_show,
288 EDAC_PCI_ATTR(edac_pci_log_pe, S_IRUGO | S_IWUSR, edac_pci_int_show,
290 EDAC_PCI_ATTR(edac_pci_log_npe, S_IRUGO | S_IWUSR, edac_pci_int_show,
292 EDAC_PCI_ATTR(edac_pci_panic_on_pe, S_IRUGO | S_IWUSR, edac_pci_int_show,
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,
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)
320 debugf0("%s() here to module_put(THIS_MODULE)\n", __func__);
322 /* last reference to top EDAC PCI kobject has been removed,
323 * NOW release our ref count on the core module
325 module_put(THIS_MODULE);
328 /* ktype struct for the EDAC PCI main kobj */
329 static struct kobj_type ktype_edac_pci_main_kobj = {
330 .release = edac_pci_release_main_kobj,
331 .sysfs_ops = &edac_pci_sysfs_ops,
332 .default_attrs = (struct attribute **)edac_pci_attr,
336 * edac_pci_main_kobj_setup()
338 * setup the sysfs for EDAC PCI attributes
339 * assumes edac_class has already been initialized
341 static int edac_pci_main_kobj_setup(void)
344 struct sysdev_class *edac_class;
346 debugf0("%s()\n", __func__);
348 /* check and count if we have already created the main kobject */
349 if (atomic_inc_return(&edac_pci_sysfs_refcount) != 1)
352 /* First time, so create the main kobject and its
353 * controls and atributes
355 edac_class = edac_get_edac_class();
356 if (edac_class == NULL) {
357 debugf1("%s() no edac_class\n", __func__);
359 goto decrement_count_fail;
362 /* Bump the reference count on this module to ensure the
363 * modules isn't unloaded until we deconstruct the top
364 * level main kobj for EDAC PCI
366 if (!try_module_get(THIS_MODULE)) {
367 debugf1("%s() try_module_get() failed\n", __func__);
369 goto decrement_count_fail;
372 /* Instanstiate the pci object */
373 err = kobject_init_and_add(&edac_pci_top_main_kobj, &ktype_edac_pci_main_kobj,
374 &edac_class->kset.kobj, "pci");
376 debugf1("Failed to register '.../edac/pci'\n");
377 goto kobject_init_and_add_fail;
380 /* At this point, to 'release' the top level kobject
381 * for EDAC PCI, then edac_pci_main_kobj_teardown()
382 * must be used, for resources to be cleaned up properly
384 kobject_uevent(&edac_pci_top_main_kobj, KOBJ_ADD);
385 debugf1("Registered '.../edac/pci' kobject\n");
389 /* Error unwind statck */
390 kobject_init_and_add_fail:
391 module_put(THIS_MODULE);
393 decrement_count_fail:
394 /* if are on this error exit, nothing to tear down */
395 atomic_dec(&edac_pci_sysfs_refcount);
401 * edac_pci_main_kobj_teardown()
403 * if no longer linked (needed) remove the top level EDAC PCI
404 * kobject with its controls and attributes
406 static void edac_pci_main_kobj_teardown(void)
408 debugf0("%s()\n", __func__);
410 /* Decrement the count and only if no more controller instances
411 * are connected perform the unregisteration of the top level
414 if (atomic_dec_return(&edac_pci_sysfs_refcount) == 0) {
415 debugf0("%s() called kobject_put on main kobj\n",
417 kobject_put(&edac_pci_top_main_kobj);
423 * edac_pci_create_sysfs
425 * Create the controls/attributes for the specified EDAC PCI device
427 int edac_pci_create_sysfs(struct edac_pci_ctl_info *pci)
430 struct kobject *edac_kobj = &pci->kobj;
432 debugf0("%s() idx=%d\n", __func__, pci->pci_idx);
434 /* create the top main EDAC PCI kobject, IF needed */
435 err = edac_pci_main_kobj_setup();
439 /* Create this instance's kobject under the MAIN kobject */
440 err = edac_pci_create_instance_kobj(pci, pci->pci_idx);
442 goto unregister_cleanup;
444 err = sysfs_create_link(edac_kobj, &pci->dev->kobj, EDAC_PCI_SYMLINK);
446 debugf0("%s() sysfs_create_link() returned err= %d\n",
453 /* Error unwind stack */
455 edac_pci_unregister_sysfs_instance_kobj(pci);
458 edac_pci_main_kobj_teardown();
464 * edac_pci_remove_sysfs
466 * remove the controls and attributes for this EDAC PCI device
468 void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci)
470 debugf0("%s() index=%d\n", __func__, pci->pci_idx);
472 /* Remove the symlink */
473 sysfs_remove_link(&pci->kobj, EDAC_PCI_SYMLINK);
475 /* remove this PCI instance's sysfs entries */
476 edac_pci_unregister_sysfs_instance_kobj(pci);
478 /* Call the main unregister function, which will determine
479 * if this 'pci' is the last instance.
480 * If it is, the main kobject will be unregistered as a result
482 debugf0("%s() calling edac_pci_main_kobj_teardown()\n", __func__);
483 edac_pci_main_kobj_teardown();
486 /************************ PCI error handling *************************/
487 static u16 get_pci_parity_status(struct pci_dev *dev, int secondary)
492 where = secondary ? PCI_SEC_STATUS : PCI_STATUS;
493 pci_read_config_word(dev, where, &status);
495 /* If we get back 0xFFFF then we must suspect that the card has been
496 * pulled but the Linux PCI layer has not yet finished cleaning up.
497 * We don't want to report on such devices
500 if (status == 0xFFFF) {
503 pci_read_config_dword(dev, 0, &sanity);
505 if (sanity == 0xFFFFFFFF)
509 status &= PCI_STATUS_DETECTED_PARITY | PCI_STATUS_SIG_SYSTEM_ERROR |
513 /* reset only the bits we are interested in */
514 pci_write_config_word(dev, where, status);
520 /* Clear any PCI parity errors logged by this device. */
521 static void edac_pci_dev_parity_clear(struct pci_dev *dev)
525 debugf0("%s()\n", __func__);
527 get_pci_parity_status(dev, 0);
529 /* read the device TYPE, looking for bridges */
530 pci_read_config_byte(dev, PCI_HEADER_TYPE, &header_type);
532 if ((header_type & 0x7F) == PCI_HEADER_TYPE_BRIDGE)
533 get_pci_parity_status(dev, 1);
539 * Fucntion to retrieve the current parity status
543 static void edac_pci_dev_parity_test(struct pci_dev *dev)
549 /* stop any interrupts until we can acquire the status */
550 local_irq_save(flags);
552 /* read the STATUS register on this device */
553 status = get_pci_parity_status(dev, 0);
555 /* read the device TYPE, looking for bridges */
556 pci_read_config_byte(dev, PCI_HEADER_TYPE, &header_type);
558 local_irq_restore(flags);
560 debugf4("PCI STATUS= 0x%04x %s\n", status, dev->dev.bus_id);
562 /* check the status reg for errors on boards NOT marked as broken
563 * if broken, we cannot trust any of the status bits
565 if (status && !dev->broken_parity_status) {
566 if (status & (PCI_STATUS_SIG_SYSTEM_ERROR)) {
567 edac_printk(KERN_CRIT, EDAC_PCI,
568 "Signaled System Error on %s\n",
570 atomic_inc(&pci_nonparity_count);
573 if (status & (PCI_STATUS_PARITY)) {
574 edac_printk(KERN_CRIT, EDAC_PCI,
575 "Master Data Parity Error on %s\n",
578 atomic_inc(&pci_parity_count);
581 if (status & (PCI_STATUS_DETECTED_PARITY)) {
582 edac_printk(KERN_CRIT, EDAC_PCI,
583 "Detected Parity Error on %s\n",
586 atomic_inc(&pci_parity_count);
591 debugf4("PCI HEADER TYPE= 0x%02x %s\n", header_type, dev->dev.bus_id);
593 if ((header_type & 0x7F) == PCI_HEADER_TYPE_BRIDGE) {
594 /* On bridges, need to examine secondary status register */
595 status = get_pci_parity_status(dev, 1);
597 debugf4("PCI SEC_STATUS= 0x%04x %s\n", status, dev->dev.bus_id);
599 /* check the secondary status reg for errors,
600 * on NOT broken boards
602 if (status && !dev->broken_parity_status) {
603 if (status & (PCI_STATUS_SIG_SYSTEM_ERROR)) {
604 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
605 "Signaled System Error on %s\n",
607 atomic_inc(&pci_nonparity_count);
610 if (status & (PCI_STATUS_PARITY)) {
611 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
612 "Master Data Parity Error on "
613 "%s\n", pci_name(dev));
615 atomic_inc(&pci_parity_count);
618 if (status & (PCI_STATUS_DETECTED_PARITY)) {
619 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
620 "Detected Parity Error on %s\n",
623 atomic_inc(&pci_parity_count);
629 /* reduce some complexity in definition of the iterator */
630 typedef void (*pci_parity_check_fn_t) (struct pci_dev *dev);
633 * pci_dev parity list iterator
634 * Scan the PCI device list for one pass, looking for SERRORs
635 * Master Parity ERRORS or Parity ERRORs on primary or secondary devices
637 static inline void edac_pci_dev_parity_iterator(pci_parity_check_fn_t fn)
639 struct pci_dev *dev = NULL;
641 /* request for kernel access to the next PCI device, if any,
642 * and while we are looking at it have its reference count
643 * bumped until we are done with it
645 while ((dev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, dev)) != NULL) {
651 * edac_pci_do_parity_check
653 * performs the actual PCI parity check operation
655 void edac_pci_do_parity_check(void)
659 debugf3("%s()\n", __func__);
661 /* if policy has PCI check off, leave now */
662 if (!check_pci_errors)
665 before_count = atomic_read(&pci_parity_count);
667 /* scan all PCI devices looking for a Parity Error on devices and
669 * The iterator calls pci_get_device() which might sleep, thus
670 * we cannot disable interrupts in this scan.
672 edac_pci_dev_parity_iterator(edac_pci_dev_parity_test);
674 /* Only if operator has selected panic on PCI Error */
675 if (edac_pci_get_panic_on_pe()) {
676 /* If the count is different 'after' from 'before' */
677 if (before_count != atomic_read(&pci_parity_count))
678 panic("EDAC: PCI Parity Error");
683 * edac_pci_clear_parity_errors
685 * function to perform an iteration over the PCI devices
686 * and clearn their current status
688 void edac_pci_clear_parity_errors(void)
690 /* Clear any PCI bus parity errors that devices initially have logged
691 * in their registers.
693 edac_pci_dev_parity_iterator(edac_pci_dev_parity_clear);
699 * Called to handle a PARITY ERROR event
701 void edac_pci_handle_pe(struct edac_pci_ctl_info *pci, const char *msg)
704 /* global PE counter incremented by edac_pci_do_parity_check() */
705 atomic_inc(&pci->counters.pe_count);
707 if (edac_pci_get_log_pe())
708 edac_pci_printk(pci, KERN_WARNING,
709 "Parity Error ctl: %s %d: %s\n",
710 pci->ctl_name, pci->pci_idx, msg);
713 * poke all PCI devices and see which one is the troublemaker
714 * panic() is called if set
716 edac_pci_do_parity_check();
718 EXPORT_SYMBOL_GPL(edac_pci_handle_pe);
722 * edac_pci_handle_npe
724 * Called to handle a NON-PARITY ERROR event
726 void edac_pci_handle_npe(struct edac_pci_ctl_info *pci, const char *msg)
729 /* global NPE counter incremented by edac_pci_do_parity_check() */
730 atomic_inc(&pci->counters.npe_count);
732 if (edac_pci_get_log_npe())
733 edac_pci_printk(pci, KERN_WARNING,
734 "Non-Parity Error ctl: %s %d: %s\n",
735 pci->ctl_name, pci->pci_idx, msg);
738 * poke all PCI devices and see which one is the troublemaker
739 * panic() is called if set
741 edac_pci_do_parity_check();
743 EXPORT_SYMBOL_GPL(edac_pci_handle_npe);
746 * Define the PCI parameter to the module
748 module_param(check_pci_errors, int, 0644);
749 MODULE_PARM_DESC(check_pci_errors,
750 "Check for PCI bus parity errors: 0=off 1=on");
751 module_param(edac_pci_panic_on_pe, int, 0644);
752 MODULE_PARM_DESC(edac_pci_panic_on_pe,
753 "Panic on PCI Bus Parity error: 0=off 1=on");
755 #endif /* CONFIG_PCI */