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 int edac_pci_get_log_pe(void)
42 return edac_pci_log_pe
;
45 int edac_pci_get_log_npe(void)
47 return edac_pci_log_npe
;
50 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 void edac_pci_unregister_sysfs_instance_kobj(struct edac_pci_ctl_info
*pci
)
202 debugf0("%s()\n", __func__
);
204 /* Unregister the instance kobject and allow its release
205 * function release the main reference count and then
208 kobject_put(&pci
->kobj
);
211 /***************************** EDAC PCI sysfs root **********************/
212 #define to_edacpci(k) container_of(k, struct edac_pci_ctl_info, kobj)
213 #define to_edacpci_attr(a) container_of(a, struct edac_pci_attr, attr)
215 /* simple show/store functions for attributes */
216 static ssize_t
edac_pci_int_show(void *ptr
, char *buffer
)
219 return sprintf(buffer
, "%d\n", *value
);
222 static ssize_t
edac_pci_int_store(void *ptr
, const char *buffer
, size_t count
)
226 if (isdigit(*buffer
))
227 *value
= simple_strtoul(buffer
, NULL
, 0);
232 struct edac_pci_dev_attribute
{
233 struct attribute attr
;
235 ssize_t(*show
) (void *, char *);
236 ssize_t(*store
) (void *, const char *, size_t);
239 /* Set of show/store abstract level functions for PCI Parity object */
240 static ssize_t
edac_pci_dev_show(struct kobject
*kobj
, struct attribute
*attr
,
243 struct edac_pci_dev_attribute
*edac_pci_dev
;
244 edac_pci_dev
= (struct edac_pci_dev_attribute
*)attr
;
246 if (edac_pci_dev
->show
)
247 return edac_pci_dev
->show(edac_pci_dev
->value
, buffer
);
251 static ssize_t
edac_pci_dev_store(struct kobject
*kobj
,
252 struct attribute
*attr
, const char *buffer
,
255 struct edac_pci_dev_attribute
*edac_pci_dev
;
256 edac_pci_dev
= (struct edac_pci_dev_attribute
*)attr
;
258 if (edac_pci_dev
->show
)
259 return edac_pci_dev
->store(edac_pci_dev
->value
, buffer
, count
);
263 static struct sysfs_ops edac_pci_sysfs_ops
= {
264 .show
= edac_pci_dev_show
,
265 .store
= edac_pci_dev_store
268 #define EDAC_PCI_ATTR(_name,_mode,_show,_store) \
269 static struct edac_pci_dev_attribute edac_pci_attr_##_name = { \
270 .attr = {.name = __stringify(_name), .mode = _mode }, \
276 #define EDAC_PCI_STRING_ATTR(_name,_data,_mode,_show,_store) \
277 static struct edac_pci_dev_attribute edac_pci_attr_##_name = { \
278 .attr = {.name = __stringify(_name), .mode = _mode }, \
284 /* PCI Parity control files */
285 EDAC_PCI_ATTR(check_pci_errors
, S_IRUGO
| S_IWUSR
, edac_pci_int_show
,
287 EDAC_PCI_ATTR(edac_pci_log_pe
, S_IRUGO
| S_IWUSR
, edac_pci_int_show
,
289 EDAC_PCI_ATTR(edac_pci_log_npe
, S_IRUGO
| S_IWUSR
, edac_pci_int_show
,
291 EDAC_PCI_ATTR(edac_pci_panic_on_pe
, S_IRUGO
| S_IWUSR
, edac_pci_int_show
,
293 EDAC_PCI_ATTR(pci_parity_count
, S_IRUGO
, edac_pci_int_show
, NULL
);
294 EDAC_PCI_ATTR(pci_nonparity_count
, S_IRUGO
, edac_pci_int_show
, NULL
);
296 /* Base Attributes of the memory ECC object */
297 static struct edac_pci_dev_attribute
*edac_pci_attr
[] = {
298 &edac_pci_attr_check_pci_errors
,
299 &edac_pci_attr_edac_pci_log_pe
,
300 &edac_pci_attr_edac_pci_log_npe
,
301 &edac_pci_attr_edac_pci_panic_on_pe
,
302 &edac_pci_attr_pci_parity_count
,
303 &edac_pci_attr_pci_nonparity_count
,
308 * edac_pci_release_main_kobj
310 * This release function is called when the reference count to the
311 * passed kobj goes to zero.
313 * This kobj is the 'main' kobject that EDAC PCI instances
314 * link to, and thus provide for proper nesting counts
316 static void edac_pci_release_main_kobj(struct kobject
*kobj
)
319 debugf0("%s() here to module_put(THIS_MODULE)\n", __func__
);
321 /* last reference to top EDAC PCI kobject has been removed,
322 * NOW release our ref count on the core module
324 module_put(THIS_MODULE
);
327 /* ktype struct for the EDAC PCI main kobj */
328 static struct kobj_type ktype_edac_pci_main_kobj
= {
329 .release
= edac_pci_release_main_kobj
,
330 .sysfs_ops
= &edac_pci_sysfs_ops
,
331 .default_attrs
= (struct attribute
**)edac_pci_attr
,
335 * edac_pci_main_kobj_setup()
337 * setup the sysfs for EDAC PCI attributes
338 * assumes edac_class has already been initialized
340 int edac_pci_main_kobj_setup(void)
343 struct sysdev_class
*edac_class
;
345 debugf0("%s()\n", __func__
);
347 /* check and count if we have already created the main kobject */
348 if (atomic_inc_return(&edac_pci_sysfs_refcount
) != 1)
351 /* First time, so create the main kobject and its
352 * controls and atributes
354 edac_class
= edac_get_edac_class();
355 if (edac_class
== NULL
) {
356 debugf1("%s() no edac_class\n", __func__
);
358 goto decrement_count_fail
;
361 /* Bump the reference count on this module to ensure the
362 * modules isn't unloaded until we deconstruct the top
363 * level main kobj for EDAC PCI
365 if (!try_module_get(THIS_MODULE
)) {
366 debugf1("%s() try_module_get() failed\n", __func__
);
368 goto decrement_count_fail
;
371 /* Instanstiate the pci object */
372 err
= kobject_init_and_add(&edac_pci_top_main_kobj
, &ktype_edac_pci_main_kobj
,
373 &edac_class
->kset
.kobj
, "pci");
375 debugf1("Failed to register '.../edac/pci'\n");
376 goto kobject_init_and_add_fail
;
379 /* At this point, to 'release' the top level kobject
380 * for EDAC PCI, then edac_pci_main_kobj_teardown()
381 * must be used, for resources to be cleaned up properly
383 kobject_uevent(&edac_pci_top_main_kobj
, KOBJ_ADD
);
384 debugf1("Registered '.../edac/pci' kobject\n");
388 /* Error unwind statck */
389 kobject_init_and_add_fail
:
390 module_put(THIS_MODULE
);
392 decrement_count_fail
:
393 /* if are on this error exit, nothing to tear down */
394 atomic_dec(&edac_pci_sysfs_refcount
);
400 * edac_pci_main_kobj_teardown()
402 * if no longer linked (needed) remove the top level EDAC PCI
403 * kobject with its controls and attributes
405 static void edac_pci_main_kobj_teardown(void)
407 debugf0("%s()\n", __func__
);
409 /* Decrement the count and only if no more controller instances
410 * are connected perform the unregisteration of the top level
413 if (atomic_dec_return(&edac_pci_sysfs_refcount
) == 0) {
414 debugf0("%s() called kobject_put on main kobj\n",
416 kobject_put(&edac_pci_top_main_kobj
);
422 * edac_pci_create_sysfs
424 * Create the controls/attributes for the specified EDAC PCI device
426 int edac_pci_create_sysfs(struct edac_pci_ctl_info
*pci
)
429 struct kobject
*edac_kobj
= &pci
->kobj
;
431 debugf0("%s() idx=%d\n", __func__
, pci
->pci_idx
);
433 /* create the top main EDAC PCI kobject, IF needed */
434 err
= edac_pci_main_kobj_setup();
438 /* Create this instance's kobject under the MAIN kobject */
439 err
= edac_pci_create_instance_kobj(pci
, pci
->pci_idx
);
441 goto unregister_cleanup
;
443 err
= sysfs_create_link(edac_kobj
, &pci
->dev
->kobj
, EDAC_PCI_SYMLINK
);
445 debugf0("%s() sysfs_create_link() returned err= %d\n",
452 /* Error unwind stack */
454 edac_pci_unregister_sysfs_instance_kobj(pci
);
457 edac_pci_main_kobj_teardown();
463 * edac_pci_remove_sysfs
465 * remove the controls and attributes for this EDAC PCI device
467 void edac_pci_remove_sysfs(struct edac_pci_ctl_info
*pci
)
469 debugf0("%s() index=%d\n", __func__
, pci
->pci_idx
);
471 /* Remove the symlink */
472 sysfs_remove_link(&pci
->kobj
, EDAC_PCI_SYMLINK
);
474 /* remove this PCI instance's sysfs entries */
475 edac_pci_unregister_sysfs_instance_kobj(pci
);
477 /* Call the main unregister function, which will determine
478 * if this 'pci' is the last instance.
479 * If it is, the main kobject will be unregistered as a result
481 debugf0("%s() calling edac_pci_main_kobj_teardown()\n", __func__
);
482 edac_pci_main_kobj_teardown();
485 /************************ PCI error handling *************************/
486 static u16
get_pci_parity_status(struct pci_dev
*dev
, int secondary
)
491 where
= secondary
? PCI_SEC_STATUS
: PCI_STATUS
;
492 pci_read_config_word(dev
, where
, &status
);
494 /* If we get back 0xFFFF then we must suspect that the card has been
495 * pulled but the Linux PCI layer has not yet finished cleaning up.
496 * We don't want to report on such devices
499 if (status
== 0xFFFF) {
502 pci_read_config_dword(dev
, 0, &sanity
);
504 if (sanity
== 0xFFFFFFFF)
508 status
&= PCI_STATUS_DETECTED_PARITY
| PCI_STATUS_SIG_SYSTEM_ERROR
|
512 /* reset only the bits we are interested in */
513 pci_write_config_word(dev
, where
, status
);
519 /* Clear any PCI parity errors logged by this device. */
520 static void edac_pci_dev_parity_clear(struct pci_dev
*dev
)
524 debugf0("%s()\n", __func__
);
526 get_pci_parity_status(dev
, 0);
528 /* read the device TYPE, looking for bridges */
529 pci_read_config_byte(dev
, PCI_HEADER_TYPE
, &header_type
);
531 if ((header_type
& 0x7F) == PCI_HEADER_TYPE_BRIDGE
)
532 get_pci_parity_status(dev
, 1);
538 * Fucntion to retrieve the current parity status
542 static void edac_pci_dev_parity_test(struct pci_dev
*dev
)
548 /* stop any interrupts until we can acquire the status */
549 local_irq_save(flags
);
551 /* read the STATUS register on this device */
552 status
= get_pci_parity_status(dev
, 0);
554 /* read the device TYPE, looking for bridges */
555 pci_read_config_byte(dev
, PCI_HEADER_TYPE
, &header_type
);
557 local_irq_restore(flags
);
559 debugf4("PCI STATUS= 0x%04x %s\n", status
, dev
->dev
.bus_id
);
561 /* check the status reg for errors on boards NOT marked as broken
562 * if broken, we cannot trust any of the status bits
564 if (status
&& !dev
->broken_parity_status
) {
565 if (status
& (PCI_STATUS_SIG_SYSTEM_ERROR
)) {
566 edac_printk(KERN_CRIT
, EDAC_PCI
,
567 "Signaled System Error on %s\n",
569 atomic_inc(&pci_nonparity_count
);
572 if (status
& (PCI_STATUS_PARITY
)) {
573 edac_printk(KERN_CRIT
, EDAC_PCI
,
574 "Master Data Parity Error on %s\n",
577 atomic_inc(&pci_parity_count
);
580 if (status
& (PCI_STATUS_DETECTED_PARITY
)) {
581 edac_printk(KERN_CRIT
, EDAC_PCI
,
582 "Detected Parity Error on %s\n",
585 atomic_inc(&pci_parity_count
);
590 debugf4("PCI HEADER TYPE= 0x%02x %s\n", header_type
, dev
->dev
.bus_id
);
592 if ((header_type
& 0x7F) == PCI_HEADER_TYPE_BRIDGE
) {
593 /* On bridges, need to examine secondary status register */
594 status
= get_pci_parity_status(dev
, 1);
596 debugf4("PCI SEC_STATUS= 0x%04x %s\n", status
, dev
->dev
.bus_id
);
598 /* check the secondary status reg for errors,
599 * on NOT broken boards
601 if (status
&& !dev
->broken_parity_status
) {
602 if (status
& (PCI_STATUS_SIG_SYSTEM_ERROR
)) {
603 edac_printk(KERN_CRIT
, EDAC_PCI
, "Bridge "
604 "Signaled System Error on %s\n",
606 atomic_inc(&pci_nonparity_count
);
609 if (status
& (PCI_STATUS_PARITY
)) {
610 edac_printk(KERN_CRIT
, EDAC_PCI
, "Bridge "
611 "Master Data Parity Error on "
612 "%s\n", pci_name(dev
));
614 atomic_inc(&pci_parity_count
);
617 if (status
& (PCI_STATUS_DETECTED_PARITY
)) {
618 edac_printk(KERN_CRIT
, EDAC_PCI
, "Bridge "
619 "Detected Parity Error on %s\n",
622 atomic_inc(&pci_parity_count
);
628 /* reduce some complexity in definition of the iterator */
629 typedef void (*pci_parity_check_fn_t
) (struct pci_dev
*dev
);
632 * pci_dev parity list iterator
633 * Scan the PCI device list for one pass, looking for SERRORs
634 * Master Parity ERRORS or Parity ERRORs on primary or secondary devices
636 static inline void edac_pci_dev_parity_iterator(pci_parity_check_fn_t fn
)
638 struct pci_dev
*dev
= NULL
;
640 /* request for kernel access to the next PCI device, if any,
641 * and while we are looking at it have its reference count
642 * bumped until we are done with it
644 while ((dev
= pci_get_device(PCI_ANY_ID
, PCI_ANY_ID
, dev
)) != NULL
) {
650 * edac_pci_do_parity_check
652 * performs the actual PCI parity check operation
654 void edac_pci_do_parity_check(void)
658 debugf3("%s()\n", __func__
);
660 /* if policy has PCI check off, leave now */
661 if (!check_pci_errors
)
664 before_count
= atomic_read(&pci_parity_count
);
666 /* scan all PCI devices looking for a Parity Error on devices and
668 * The iterator calls pci_get_device() which might sleep, thus
669 * we cannot disable interrupts in this scan.
671 edac_pci_dev_parity_iterator(edac_pci_dev_parity_test
);
673 /* Only if operator has selected panic on PCI Error */
674 if (edac_pci_get_panic_on_pe()) {
675 /* If the count is different 'after' from 'before' */
676 if (before_count
!= atomic_read(&pci_parity_count
))
677 panic("EDAC: PCI Parity Error");
682 * edac_pci_clear_parity_errors
684 * function to perform an iteration over the PCI devices
685 * and clearn their current status
687 void edac_pci_clear_parity_errors(void)
689 /* Clear any PCI bus parity errors that devices initially have logged
690 * in their registers.
692 edac_pci_dev_parity_iterator(edac_pci_dev_parity_clear
);
698 * Called to handle a PARITY ERROR event
700 void edac_pci_handle_pe(struct edac_pci_ctl_info
*pci
, const char *msg
)
703 /* global PE counter incremented by edac_pci_do_parity_check() */
704 atomic_inc(&pci
->counters
.pe_count
);
706 if (edac_pci_get_log_pe())
707 edac_pci_printk(pci
, KERN_WARNING
,
708 "Parity Error ctl: %s %d: %s\n",
709 pci
->ctl_name
, pci
->pci_idx
, msg
);
712 * poke all PCI devices and see which one is the troublemaker
713 * panic() is called if set
715 edac_pci_do_parity_check();
717 EXPORT_SYMBOL_GPL(edac_pci_handle_pe
);
721 * edac_pci_handle_npe
723 * Called to handle a NON-PARITY ERROR event
725 void edac_pci_handle_npe(struct edac_pci_ctl_info
*pci
, const char *msg
)
728 /* global NPE counter incremented by edac_pci_do_parity_check() */
729 atomic_inc(&pci
->counters
.npe_count
);
731 if (edac_pci_get_log_npe())
732 edac_pci_printk(pci
, KERN_WARNING
,
733 "Non-Parity Error ctl: %s %d: %s\n",
734 pci
->ctl_name
, pci
->pci_idx
, msg
);
737 * poke all PCI devices and see which one is the troublemaker
738 * panic() is called if set
740 edac_pci_do_parity_check();
742 EXPORT_SYMBOL_GPL(edac_pci_handle_npe
);
745 * Define the PCI parameter to the module
747 module_param(check_pci_errors
, int, 0644);
748 MODULE_PARM_DESC(check_pci_errors
,
749 "Check for PCI bus parity errors: 0=off 1=on");
750 module_param(edac_pci_panic_on_pe
, int, 0644);
751 MODULE_PARM_DESC(edac_pci_panic_on_pe
,
752 "Panic on PCI Bus Parity error: 0=off 1=on");
754 #endif /* CONFIG_PCI */