blob: 71c3195d3704428fc16a3f69848d739f0a8d723e [file] [log] [blame]
Douglas Thompson20bcb7a2007-07-19 01:49:47 -07001/*
Douglas Thompson7c9281d2007-07-19 01:49:33 -07002 * (C) 2005, 2006 Linux Networx (http://lnxi.com)
3 * This file may be distributed under the terms of the
4 * GNU General Public License.
5 *
6 * Written Doug Thompson <norsk5@xmission.com>
7 *
8 */
9#include <linux/module.h>
10#include <linux/sysdev.h>
11#include <linux/ctype.h>
12
Douglas Thompson20bcb7a2007-07-19 01:49:47 -070013#include "edac_core.h"
Douglas Thompson7c9281d2007-07-19 01:49:33 -070014#include "edac_module.h"
15
Doug Thompsond4c14652007-07-26 10:41:15 -070016/* Turn off this whole feature if PCI is not configured */
Douglas Thompson7c9281d2007-07-19 01:49:33 -070017#ifdef CONFIG_PCI
Dave Jiang91b99042007-07-19 01:49:52 -070018
19#define EDAC_PCI_SYMLINK "device"
20
Doug Thompsond4c14652007-07-26 10:41:15 -070021/* data variables exported via sysfs */
22static int check_pci_errors; /* default NO check PCI parity */
23static int edac_pci_panic_on_pe; /* default NO panic on PCI Parity */
24static int edac_pci_log_pe = 1; /* log PCI parity errors */
Dave Jiang4de78c62007-07-19 01:49:54 -070025static int edac_pci_log_npe = 1; /* log PCI non-parity error errors */
Doug Thompsond4c14652007-07-26 10:41:15 -070026static int edac_pci_poll_msec = 1000; /* one second workq period */
27
Douglas Thompson7c9281d2007-07-19 01:49:33 -070028static atomic_t pci_parity_count = ATOMIC_INIT(0);
Dave Jiang91b99042007-07-19 01:49:52 -070029static atomic_t pci_nonparity_count = ATOMIC_INIT(0);
Douglas Thompson7c9281d2007-07-19 01:49:33 -070030
Doug Thompsond4c14652007-07-26 10:41:15 -070031static struct kobject edac_pci_top_main_kobj;
Dave Jiang91b99042007-07-19 01:49:52 -070032static atomic_t edac_pci_sysfs_refcount = ATOMIC_INIT(0);
Douglas Thompson7c9281d2007-07-19 01:49:33 -070033
Doug Thompsond4c14652007-07-26 10:41:15 -070034/* getter functions for the data variables */
Dave Jiang4de78c62007-07-19 01:49:54 -070035int edac_pci_get_check_errors(void)
36{
37 return check_pci_errors;
38}
39
40int edac_pci_get_log_pe(void)
41{
42 return edac_pci_log_pe;
43}
44
45int edac_pci_get_log_npe(void)
46{
47 return edac_pci_log_npe;
48}
49
50int edac_pci_get_panic_on_pe(void)
51{
52 return edac_pci_panic_on_pe;
53}
54
55int edac_pci_get_poll_msec(void)
56{
57 return edac_pci_poll_msec;
58}
59
Dave Jiang91b99042007-07-19 01:49:52 -070060/**************************** EDAC PCI sysfs instance *******************/
61static ssize_t instance_pe_count_show(struct edac_pci_ctl_info *pci, char *data)
62{
Douglas Thompson079708b2007-07-19 01:49:58 -070063 return sprintf(data, "%u\n", atomic_read(&pci->counters.pe_count));
Dave Jiang91b99042007-07-19 01:49:52 -070064}
65
66static ssize_t instance_npe_count_show(struct edac_pci_ctl_info *pci,
Douglas Thompson052dfb42007-07-19 01:50:13 -070067 char *data)
Dave Jiang91b99042007-07-19 01:49:52 -070068{
Douglas Thompson079708b2007-07-19 01:49:58 -070069 return sprintf(data, "%u\n", atomic_read(&pci->counters.npe_count));
Dave Jiang91b99042007-07-19 01:49:52 -070070}
71
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)
74
75/* DEVICE instance kobject release() function */
76static void edac_pci_instance_release(struct kobject *kobj)
77{
78 struct edac_pci_ctl_info *pci;
79
Doug Thompsond4c14652007-07-26 10:41:15 -070080 debugf0("%s()\n", __func__);
Dave Jiang91b99042007-07-19 01:49:52 -070081
Doug Thompsond4c14652007-07-26 10:41:15 -070082 /* Form pointer to containing struct, the pci control struct */
Dave Jiang91b99042007-07-19 01:49:52 -070083 pci = to_instance(kobj);
Doug Thompsond4c14652007-07-26 10:41:15 -070084
85 /* decrement reference count on top main kobj */
86 kobject_put(&edac_pci_top_main_kobj);
87
88 kfree(pci); /* Free the control struct */
Dave Jiang91b99042007-07-19 01:49:52 -070089}
90
91/* instance specific attribute structure */
92struct instance_attribute {
Douglas Thompson079708b2007-07-19 01:49:58 -070093 struct attribute attr;
Doug Thompsond4c14652007-07-26 10:41:15 -070094 ssize_t(*show) (struct edac_pci_ctl_info *, char *);
95 ssize_t(*store) (struct edac_pci_ctl_info *, const char *, size_t);
Dave Jiang91b99042007-07-19 01:49:52 -070096};
97
98/* Function to 'show' fields from the edac_pci 'instance' structure */
99static ssize_t edac_pci_instance_show(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700100 struct attribute *attr, char *buffer)
Dave Jiang91b99042007-07-19 01:49:52 -0700101{
Douglas Thompson079708b2007-07-19 01:49:58 -0700102 struct edac_pci_ctl_info *pci = to_instance(kobj);
103 struct instance_attribute *instance_attr = to_instance_attr(attr);
Dave Jiang91b99042007-07-19 01:49:52 -0700104
Douglas Thompson079708b2007-07-19 01:49:58 -0700105 if (instance_attr->show)
106 return instance_attr->show(pci, buffer);
107 return -EIO;
Dave Jiang91b99042007-07-19 01:49:52 -0700108}
109
Dave Jiang91b99042007-07-19 01:49:52 -0700110/* Function to 'store' fields into the edac_pci 'instance' structure */
111static ssize_t edac_pci_instance_store(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700112 struct attribute *attr,
113 const char *buffer, size_t count)
Dave Jiang91b99042007-07-19 01:49:52 -0700114{
Douglas Thompson079708b2007-07-19 01:49:58 -0700115 struct edac_pci_ctl_info *pci = to_instance(kobj);
116 struct instance_attribute *instance_attr = to_instance_attr(attr);
Dave Jiang91b99042007-07-19 01:49:52 -0700117
Douglas Thompson079708b2007-07-19 01:49:58 -0700118 if (instance_attr->store)
119 return instance_attr->store(pci, buffer, count);
120 return -EIO;
Dave Jiang91b99042007-07-19 01:49:52 -0700121}
122
Doug Thompsond4c14652007-07-26 10:41:15 -0700123/* fs_ops table */
Dave Jiang91b99042007-07-19 01:49:52 -0700124static struct sysfs_ops pci_instance_ops = {
125 .show = edac_pci_instance_show,
126 .store = edac_pci_instance_store
127};
128
129#define INSTANCE_ATTR(_name, _mode, _show, _store) \
130static struct instance_attribute attr_instance_##_name = { \
131 .attr = {.name = __stringify(_name), .mode = _mode }, \
132 .show = _show, \
133 .store = _store, \
134};
135
136INSTANCE_ATTR(pe_count, S_IRUGO, instance_pe_count_show, NULL);
137INSTANCE_ATTR(npe_count, S_IRUGO, instance_npe_count_show, NULL);
138
139/* pci instance attributes */
140static struct instance_attribute *pci_instance_attr[] = {
141 &attr_instance_pe_count,
142 &attr_instance_npe_count,
143 NULL
144};
145
Doug Thompsond4c14652007-07-26 10:41:15 -0700146/* the ktype for a pci instance */
Dave Jiang91b99042007-07-19 01:49:52 -0700147static 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,
151};
152
Doug Thompsond4c14652007-07-26 10:41:15 -0700153/*
154 * edac_pci_create_instance_kobj
155 *
156 * construct one EDAC PCI instance's kobject for use
157 */
Dave Jiang91b99042007-07-19 01:49:52 -0700158static int edac_pci_create_instance_kobj(struct edac_pci_ctl_info *pci, int idx)
159{
Doug Thompsond4c14652007-07-26 10:41:15 -0700160 struct kobject *main_kobj;
Dave Jiang91b99042007-07-19 01:49:52 -0700161 int err;
162
Doug Thompsond4c14652007-07-26 10:41:15 -0700163 debugf0("%s()\n", __func__);
164
Doug Thompsond4c14652007-07-26 10:41:15 -0700165 /* 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
168 */
169 main_kobj = kobject_get(&edac_pci_top_main_kobj);
170 if (!main_kobj) {
171 err = -ENODEV;
172 goto error_out;
173 }
174
175 /* And now register this new kobject under the main kobj */
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400176 err = kobject_init_and_add(&pci->kobj, &ktype_pci_instance,
177 &edac_pci_top_main_kobj, "pci%d", idx);
Dave Jiang91b99042007-07-19 01:49:52 -0700178 if (err != 0) {
179 debugf2("%s() failed to register instance pci%d\n",
Douglas Thompson079708b2007-07-19 01:49:58 -0700180 __func__, idx);
Doug Thompsond4c14652007-07-26 10:41:15 -0700181 kobject_put(&edac_pci_top_main_kobj);
182 goto error_out;
Dave Jiang91b99042007-07-19 01:49:52 -0700183 }
184
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400185 kobject_uevent(&pci->kobj, KOBJ_ADD);
Dave Jiang91b99042007-07-19 01:49:52 -0700186 debugf1("%s() Register instance 'pci%d' kobject\n", __func__, idx);
187
188 return 0;
Doug Thompsond4c14652007-07-26 10:41:15 -0700189
190 /* Error unwind statck */
191error_out:
192 return err;
Dave Jiang91b99042007-07-19 01:49:52 -0700193}
194
Doug Thompsond4c14652007-07-26 10:41:15 -0700195/*
196 * edac_pci_unregister_sysfs_instance_kobj
197 *
198 * unregister the kobj for the EDAC PCI instance
199 */
200void edac_pci_unregister_sysfs_instance_kobj(struct edac_pci_ctl_info *pci)
Dave Jiang91b99042007-07-19 01:49:52 -0700201{
Doug Thompsond4c14652007-07-26 10:41:15 -0700202 debugf0("%s()\n", __func__);
203
204 /* Unregister the instance kobject and allow its release
205 * function release the main reference count and then
206 * kfree the memory
207 */
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800208 kobject_put(&pci->kobj);
Dave Jiang91b99042007-07-19 01:49:52 -0700209}
210
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)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700214
Doug Thompsond4c14652007-07-26 10:41:15 -0700215/* simple show/store functions for attributes */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700216static ssize_t edac_pci_int_show(void *ptr, char *buffer)
217{
218 int *value = ptr;
Douglas Thompson079708b2007-07-19 01:49:58 -0700219 return sprintf(buffer, "%d\n", *value);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700220}
221
222static ssize_t edac_pci_int_store(void *ptr, const char *buffer, size_t count)
223{
224 int *value = ptr;
225
226 if (isdigit(*buffer))
Douglas Thompson079708b2007-07-19 01:49:58 -0700227 *value = simple_strtoul(buffer, NULL, 0);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700228
229 return count;
230}
231
232struct edac_pci_dev_attribute {
233 struct attribute attr;
234 void *value;
Douglas Thompson079708b2007-07-19 01:49:58 -0700235 ssize_t(*show) (void *, char *);
236 ssize_t(*store) (void *, const char *, size_t);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700237};
238
239/* Set of show/store abstract level functions for PCI Parity object */
240static ssize_t edac_pci_dev_show(struct kobject *kobj, struct attribute *attr,
Douglas Thompson079708b2007-07-19 01:49:58 -0700241 char *buffer)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700242{
243 struct edac_pci_dev_attribute *edac_pci_dev;
Douglas Thompson079708b2007-07-19 01:49:58 -0700244 edac_pci_dev = (struct edac_pci_dev_attribute *)attr;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700245
246 if (edac_pci_dev->show)
247 return edac_pci_dev->show(edac_pci_dev->value, buffer);
248 return -EIO;
249}
250
251static ssize_t edac_pci_dev_store(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700252 struct attribute *attr, const char *buffer,
253 size_t count)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700254{
255 struct edac_pci_dev_attribute *edac_pci_dev;
Douglas Thompson079708b2007-07-19 01:49:58 -0700256 edac_pci_dev = (struct edac_pci_dev_attribute *)attr;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700257
258 if (edac_pci_dev->show)
259 return edac_pci_dev->store(edac_pci_dev->value, buffer, count);
260 return -EIO;
261}
262
263static struct sysfs_ops edac_pci_sysfs_ops = {
Douglas Thompson079708b2007-07-19 01:49:58 -0700264 .show = edac_pci_dev_show,
265 .store = edac_pci_dev_store
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700266};
267
268#define EDAC_PCI_ATTR(_name,_mode,_show,_store) \
269static struct edac_pci_dev_attribute edac_pci_attr_##_name = { \
270 .attr = {.name = __stringify(_name), .mode = _mode }, \
271 .value = &_name, \
272 .show = _show, \
273 .store = _store, \
274};
275
276#define EDAC_PCI_STRING_ATTR(_name,_data,_mode,_show,_store) \
277static struct edac_pci_dev_attribute edac_pci_attr_##_name = { \
278 .attr = {.name = __stringify(_name), .mode = _mode }, \
279 .value = _data, \
280 .show = _show, \
281 .store = _store, \
282};
283
284/* PCI Parity control files */
Douglas Thompson079708b2007-07-19 01:49:58 -0700285EDAC_PCI_ATTR(check_pci_errors, S_IRUGO | S_IWUSR, edac_pci_int_show,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700286 edac_pci_int_store);
Douglas Thompson079708b2007-07-19 01:49:58 -0700287EDAC_PCI_ATTR(edac_pci_log_pe, S_IRUGO | S_IWUSR, edac_pci_int_show,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700288 edac_pci_int_store);
Douglas Thompson079708b2007-07-19 01:49:58 -0700289EDAC_PCI_ATTR(edac_pci_log_npe, S_IRUGO | S_IWUSR, edac_pci_int_show,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700290 edac_pci_int_store);
Douglas Thompson079708b2007-07-19 01:49:58 -0700291EDAC_PCI_ATTR(edac_pci_panic_on_pe, S_IRUGO | S_IWUSR, edac_pci_int_show,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700292 edac_pci_int_store);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700293EDAC_PCI_ATTR(pci_parity_count, S_IRUGO, edac_pci_int_show, NULL);
Dave Jiang91b99042007-07-19 01:49:52 -0700294EDAC_PCI_ATTR(pci_nonparity_count, S_IRUGO, edac_pci_int_show, NULL);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700295
296/* Base Attributes of the memory ECC object */
297static struct edac_pci_dev_attribute *edac_pci_attr[] = {
Dave Jiang91b99042007-07-19 01:49:52 -0700298 &edac_pci_attr_check_pci_errors,
Dave Jiang4de78c62007-07-19 01:49:54 -0700299 &edac_pci_attr_edac_pci_log_pe,
300 &edac_pci_attr_edac_pci_log_npe,
301 &edac_pci_attr_edac_pci_panic_on_pe,
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700302 &edac_pci_attr_pci_parity_count,
Dave Jiang91b99042007-07-19 01:49:52 -0700303 &edac_pci_attr_pci_nonparity_count,
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700304 NULL,
305};
306
Doug Thompsond4c14652007-07-26 10:41:15 -0700307/*
308 * edac_pci_release_main_kobj
309 *
310 * This release function is called when the reference count to the
311 * passed kobj goes to zero.
312 *
313 * This kobj is the 'main' kobject that EDAC PCI instances
314 * link to, and thus provide for proper nesting counts
315 */
316static void edac_pci_release_main_kobj(struct kobject *kobj)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700317{
Dave Jiang91b99042007-07-19 01:49:52 -0700318
Doug Thompsond4c14652007-07-26 10:41:15 -0700319 debugf0("%s() here to module_put(THIS_MODULE)\n", __func__);
Dave Jiang91b99042007-07-19 01:49:52 -0700320
Doug Thompsond4c14652007-07-26 10:41:15 -0700321 /* last reference to top EDAC PCI kobject has been removed,
322 * NOW release our ref count on the core module
323 */
324 module_put(THIS_MODULE);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700325}
326
Doug Thompsond4c14652007-07-26 10:41:15 -0700327/* ktype struct for the EDAC PCI main kobj */
328static struct kobj_type ktype_edac_pci_main_kobj = {
329 .release = edac_pci_release_main_kobj,
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700330 .sysfs_ops = &edac_pci_sysfs_ops,
Douglas Thompson079708b2007-07-19 01:49:58 -0700331 .default_attrs = (struct attribute **)edac_pci_attr,
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700332};
333
334/**
Doug Thompsond4c14652007-07-26 10:41:15 -0700335 * edac_pci_main_kobj_setup()
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700336 *
337 * setup the sysfs for EDAC PCI attributes
338 * assumes edac_class has already been initialized
339 */
Doug Thompsond4c14652007-07-26 10:41:15 -0700340int edac_pci_main_kobj_setup(void)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700341{
342 int err;
343 struct sysdev_class *edac_class;
344
Doug Thompsond4c14652007-07-26 10:41:15 -0700345 debugf0("%s()\n", __func__);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700346
Doug Thompsond4c14652007-07-26 10:41:15 -0700347 /* check and count if we have already created the main kobject */
348 if (atomic_inc_return(&edac_pci_sysfs_refcount) != 1)
349 return 0;
350
351 /* First time, so create the main kobject and its
352 * controls and atributes
353 */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700354 edac_class = edac_get_edac_class();
Dave Jiang91b99042007-07-19 01:49:52 -0700355 if (edac_class == NULL) {
356 debugf1("%s() no edac_class\n", __func__);
Doug Thompsond4c14652007-07-26 10:41:15 -0700357 err = -ENODEV;
358 goto decrement_count_fail;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700359 }
360
Doug Thompsond4c14652007-07-26 10:41:15 -0700361 /* 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
364 */
365 if (!try_module_get(THIS_MODULE)) {
366 debugf1("%s() try_module_get() failed\n", __func__);
367 err = -ENODEV;
368 goto decrement_count_fail;
369 }
Dave Jiang91b99042007-07-19 01:49:52 -0700370
371 /* Instanstiate the pci object */
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400372 err = kobject_init_and_add(&edac_pci_top_main_kobj, &ktype_edac_pci_main_kobj,
373 &edac_class->kset.kobj, "pci");
Dave Jiang91b99042007-07-19 01:49:52 -0700374 if (err) {
375 debugf1("Failed to register '.../edac/pci'\n");
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400376 goto kobject_init_and_add_fail;
Dave Jiang91b99042007-07-19 01:49:52 -0700377 }
378
Doug Thompsond4c14652007-07-26 10:41:15 -0700379 /* 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
382 */
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400383 kobject_uevent(&edac_pci_top_main_kobj, KOBJ_ADD);
Dave Jiang91b99042007-07-19 01:49:52 -0700384 debugf1("Registered '.../edac/pci' kobject\n");
385
386 return 0;
Doug Thompsond4c14652007-07-26 10:41:15 -0700387
388 /* Error unwind statck */
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400389kobject_init_and_add_fail:
Doug Thompsond4c14652007-07-26 10:41:15 -0700390 module_put(THIS_MODULE);
391
392decrement_count_fail:
393 /* if are on this error exit, nothing to tear down */
394 atomic_dec(&edac_pci_sysfs_refcount);
395
396 return err;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700397}
398
399/*
Doug Thompsond4c14652007-07-26 10:41:15 -0700400 * edac_pci_main_kobj_teardown()
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700401 *
Doug Thompsond4c14652007-07-26 10:41:15 -0700402 * if no longer linked (needed) remove the top level EDAC PCI
403 * kobject with its controls and attributes
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700404 */
Doug Thompsond4c14652007-07-26 10:41:15 -0700405static void edac_pci_main_kobj_teardown(void)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700406{
407 debugf0("%s()\n", __func__);
Doug Thompsond4c14652007-07-26 10:41:15 -0700408
409 /* Decrement the count and only if no more controller instances
410 * are connected perform the unregisteration of the top level
411 * main kobj
412 */
413 if (atomic_dec_return(&edac_pci_sysfs_refcount) == 0) {
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800414 debugf0("%s() called kobject_put on main kobj\n",
Doug Thompsond4c14652007-07-26 10:41:15 -0700415 __func__);
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800416 kobject_put(&edac_pci_top_main_kobj);
Doug Thompsond4c14652007-07-26 10:41:15 -0700417 }
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700418}
419
Doug Thompsond4c14652007-07-26 10:41:15 -0700420/*
421 *
422 * edac_pci_create_sysfs
423 *
424 * Create the controls/attributes for the specified EDAC PCI device
425 */
Dave Jiang91b99042007-07-19 01:49:52 -0700426int edac_pci_create_sysfs(struct edac_pci_ctl_info *pci)
427{
428 int err;
429 struct kobject *edac_kobj = &pci->kobj;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700430
Dave Jiang91b99042007-07-19 01:49:52 -0700431 debugf0("%s() idx=%d\n", __func__, pci->pci_idx);
432
Doug Thompsond4c14652007-07-26 10:41:15 -0700433 /* create the top main EDAC PCI kobject, IF needed */
434 err = edac_pci_main_kobj_setup();
435 if (err)
436 return err;
437
438 /* Create this instance's kobject under the MAIN kobject */
439 err = edac_pci_create_instance_kobj(pci, pci->pci_idx);
440 if (err)
441 goto unregister_cleanup;
442
Douglas Thompson079708b2007-07-19 01:49:58 -0700443 err = sysfs_create_link(edac_kobj, &pci->dev->kobj, EDAC_PCI_SYMLINK);
Dave Jiang91b99042007-07-19 01:49:52 -0700444 if (err) {
445 debugf0("%s() sysfs_create_link() returned err= %d\n",
Douglas Thompson079708b2007-07-19 01:49:58 -0700446 __func__, err);
Doug Thompsond4c14652007-07-26 10:41:15 -0700447 goto symlink_fail;
Dave Jiang91b99042007-07-19 01:49:52 -0700448 }
449
450 return 0;
Doug Thompsond4c14652007-07-26 10:41:15 -0700451
452 /* Error unwind stack */
453symlink_fail:
454 edac_pci_unregister_sysfs_instance_kobj(pci);
455
456unregister_cleanup:
457 edac_pci_main_kobj_teardown();
458
459 return err;
Dave Jiang91b99042007-07-19 01:49:52 -0700460}
461
Doug Thompsond4c14652007-07-26 10:41:15 -0700462/*
463 * edac_pci_remove_sysfs
464 *
465 * remove the controls and attributes for this EDAC PCI device
466 */
Dave Jiang91b99042007-07-19 01:49:52 -0700467void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci)
468{
Doug Thompsond4c14652007-07-26 10:41:15 -0700469 debugf0("%s() index=%d\n", __func__, pci->pci_idx);
Dave Jiang91b99042007-07-19 01:49:52 -0700470
Doug Thompsond4c14652007-07-26 10:41:15 -0700471 /* Remove the symlink */
Dave Jiang91b99042007-07-19 01:49:52 -0700472 sysfs_remove_link(&pci->kobj, EDAC_PCI_SYMLINK);
473
Doug Thompsond4c14652007-07-26 10:41:15 -0700474 /* remove this PCI instance's sysfs entries */
475 edac_pci_unregister_sysfs_instance_kobj(pci);
476
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
480 */
481 debugf0("%s() calling edac_pci_main_kobj_teardown()\n", __func__);
482 edac_pci_main_kobj_teardown();
Dave Jiang91b99042007-07-19 01:49:52 -0700483}
484
485/************************ PCI error handling *************************/
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700486static u16 get_pci_parity_status(struct pci_dev *dev, int secondary)
487{
488 int where;
489 u16 status;
490
491 where = secondary ? PCI_SEC_STATUS : PCI_STATUS;
492 pci_read_config_word(dev, where, &status);
493
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
497 */
498
499 if (status == 0xFFFF) {
500 u32 sanity;
501
502 pci_read_config_dword(dev, 0, &sanity);
503
504 if (sanity == 0xFFFFFFFF)
505 return 0;
506 }
507
508 status &= PCI_STATUS_DETECTED_PARITY | PCI_STATUS_SIG_SYSTEM_ERROR |
Douglas Thompson052dfb42007-07-19 01:50:13 -0700509 PCI_STATUS_PARITY;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700510
511 if (status)
512 /* reset only the bits we are interested in */
513 pci_write_config_word(dev, where, status);
514
515 return status;
516}
517
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700518
519/* Clear any PCI parity errors logged by this device. */
520static void edac_pci_dev_parity_clear(struct pci_dev *dev)
521{
522 u8 header_type;
523
Doug Thompsond4c14652007-07-26 10:41:15 -0700524 debugf0("%s()\n", __func__);
525
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700526 get_pci_parity_status(dev, 0);
527
528 /* read the device TYPE, looking for bridges */
529 pci_read_config_byte(dev, PCI_HEADER_TYPE, &header_type);
530
531 if ((header_type & 0x7F) == PCI_HEADER_TYPE_BRIDGE)
532 get_pci_parity_status(dev, 1);
533}
534
535/*
536 * PCI Parity polling
537 *
Doug Thompsond4c14652007-07-26 10:41:15 -0700538 * Fucntion to retrieve the current parity status
539 * and decode it
540 *
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700541 */
542static void edac_pci_dev_parity_test(struct pci_dev *dev)
543{
Doug Thompsond4c14652007-07-26 10:41:15 -0700544 unsigned long flags;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700545 u16 status;
Douglas Thompson079708b2007-07-19 01:49:58 -0700546 u8 header_type;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700547
Doug Thompsond4c14652007-07-26 10:41:15 -0700548 /* stop any interrupts until we can acquire the status */
549 local_irq_save(flags);
550
551 /* read the STATUS register on this device */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700552 status = get_pci_parity_status(dev, 0);
553
Doug Thompsond4c14652007-07-26 10:41:15 -0700554 /* read the device TYPE, looking for bridges */
555 pci_read_config_byte(dev, PCI_HEADER_TYPE, &header_type);
556
557 local_irq_restore(flags);
558
559 debugf4("PCI STATUS= 0x%04x %s\n", status, dev->dev.bus_id);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700560
Bryan Boatright6b09ff92008-02-07 00:14:58 -0800561 /* check the status reg for errors on boards NOT marked as broken
562 * if broken, we cannot trust any of the status bits
563 */
564 if (status && !dev->broken_parity_status) {
Dave Jiang91b99042007-07-19 01:49:52 -0700565 if (status & (PCI_STATUS_SIG_SYSTEM_ERROR)) {
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700566 edac_printk(KERN_CRIT, EDAC_PCI,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700567 "Signaled System Error on %s\n",
568 pci_name(dev));
Dave Jiang91b99042007-07-19 01:49:52 -0700569 atomic_inc(&pci_nonparity_count);
570 }
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700571
572 if (status & (PCI_STATUS_PARITY)) {
573 edac_printk(KERN_CRIT, EDAC_PCI,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700574 "Master Data Parity Error on %s\n",
575 pci_name(dev));
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700576
577 atomic_inc(&pci_parity_count);
578 }
579
580 if (status & (PCI_STATUS_DETECTED_PARITY)) {
581 edac_printk(KERN_CRIT, EDAC_PCI,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700582 "Detected Parity Error on %s\n",
583 pci_name(dev));
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700584
585 atomic_inc(&pci_parity_count);
586 }
587 }
588
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700589
Doug Thompsond4c14652007-07-26 10:41:15 -0700590 debugf4("PCI HEADER TYPE= 0x%02x %s\n", header_type, dev->dev.bus_id);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700591
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);
595
Doug Thompsond4c14652007-07-26 10:41:15 -0700596 debugf4("PCI SEC_STATUS= 0x%04x %s\n", status, dev->dev.bus_id);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700597
Bryan Boatright6b09ff92008-02-07 00:14:58 -0800598 /* check the secondary status reg for errors,
599 * on NOT broken boards
600 */
601 if (status && !dev->broken_parity_status) {
Dave Jiang91b99042007-07-19 01:49:52 -0700602 if (status & (PCI_STATUS_SIG_SYSTEM_ERROR)) {
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700603 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
Douglas Thompson052dfb42007-07-19 01:50:13 -0700604 "Signaled System Error on %s\n",
605 pci_name(dev));
Dave Jiang91b99042007-07-19 01:49:52 -0700606 atomic_inc(&pci_nonparity_count);
607 }
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700608
609 if (status & (PCI_STATUS_PARITY)) {
610 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
Douglas Thompson052dfb42007-07-19 01:50:13 -0700611 "Master Data Parity Error on "
612 "%s\n", pci_name(dev));
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700613
614 atomic_inc(&pci_parity_count);
615 }
616
617 if (status & (PCI_STATUS_DETECTED_PARITY)) {
618 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
Douglas Thompson052dfb42007-07-19 01:50:13 -0700619 "Detected Parity Error on %s\n",
620 pci_name(dev));
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700621
622 atomic_inc(&pci_parity_count);
623 }
624 }
625 }
626}
627
Doug Thompsond4c14652007-07-26 10:41:15 -0700628/* reduce some complexity in definition of the iterator */
629typedef void (*pci_parity_check_fn_t) (struct pci_dev *dev);
630
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700631/*
632 * pci_dev parity list iterator
Doug Thompsond4c14652007-07-26 10:41:15 -0700633 * Scan the PCI device list for one pass, looking for SERRORs
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700634 * Master Parity ERRORS or Parity ERRORs on primary or secondary devices
635 */
636static inline void edac_pci_dev_parity_iterator(pci_parity_check_fn_t fn)
637{
638 struct pci_dev *dev = NULL;
639
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
643 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700644 while ((dev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, dev)) != NULL) {
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700645 fn(dev);
646 }
647}
648
649/*
650 * edac_pci_do_parity_check
651 *
652 * performs the actual PCI parity check operation
653 */
654void edac_pci_do_parity_check(void)
655{
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700656 int before_count;
657
658 debugf3("%s()\n", __func__);
659
Doug Thompsond4c14652007-07-26 10:41:15 -0700660 /* if policy has PCI check off, leave now */
Dave Jiang91b99042007-07-19 01:49:52 -0700661 if (!check_pci_errors)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700662 return;
663
664 before_count = atomic_read(&pci_parity_count);
665
666 /* scan all PCI devices looking for a Parity Error on devices and
Doug Thompsond4c14652007-07-26 10:41:15 -0700667 * bridges.
668 * The iterator calls pci_get_device() which might sleep, thus
669 * we cannot disable interrupts in this scan.
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700670 */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700671 edac_pci_dev_parity_iterator(edac_pci_dev_parity_test);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700672
673 /* Only if operator has selected panic on PCI Error */
Dave Jiang4de78c62007-07-19 01:49:54 -0700674 if (edac_pci_get_panic_on_pe()) {
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700675 /* If the count is different 'after' from 'before' */
676 if (before_count != atomic_read(&pci_parity_count))
677 panic("EDAC: PCI Parity Error");
678 }
679}
680
Doug Thompsond4c14652007-07-26 10:41:15 -0700681/*
682 * edac_pci_clear_parity_errors
683 *
684 * function to perform an iteration over the PCI devices
685 * and clearn their current status
686 */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700687void edac_pci_clear_parity_errors(void)
688{
689 /* Clear any PCI bus parity errors that devices initially have logged
690 * in their registers.
691 */
692 edac_pci_dev_parity_iterator(edac_pci_dev_parity_clear);
693}
Doug Thompsond4c14652007-07-26 10:41:15 -0700694
695/*
696 * edac_pci_handle_pe
697 *
698 * Called to handle a PARITY ERROR event
699 */
Dave Jiang91b99042007-07-19 01:49:52 -0700700void edac_pci_handle_pe(struct edac_pci_ctl_info *pci, const char *msg)
701{
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700702
Dave Jiang91b99042007-07-19 01:49:52 -0700703 /* global PE counter incremented by edac_pci_do_parity_check() */
704 atomic_inc(&pci->counters.pe_count);
705
Dave Jiang4de78c62007-07-19 01:49:54 -0700706 if (edac_pci_get_log_pe())
Dave Jiang91b99042007-07-19 01:49:52 -0700707 edac_pci_printk(pci, KERN_WARNING,
708 "Parity Error ctl: %s %d: %s\n",
709 pci->ctl_name, pci->pci_idx, msg);
710
711 /*
712 * poke all PCI devices and see which one is the troublemaker
713 * panic() is called if set
714 */
715 edac_pci_do_parity_check();
716}
717EXPORT_SYMBOL_GPL(edac_pci_handle_pe);
718
Doug Thompsond4c14652007-07-26 10:41:15 -0700719
720/*
721 * edac_pci_handle_npe
722 *
723 * Called to handle a NON-PARITY ERROR event
724 */
Dave Jiang91b99042007-07-19 01:49:52 -0700725void edac_pci_handle_npe(struct edac_pci_ctl_info *pci, const char *msg)
726{
727
728 /* global NPE counter incremented by edac_pci_do_parity_check() */
729 atomic_inc(&pci->counters.npe_count);
730
Dave Jiang4de78c62007-07-19 01:49:54 -0700731 if (edac_pci_get_log_npe())
Dave Jiang91b99042007-07-19 01:49:52 -0700732 edac_pci_printk(pci, KERN_WARNING,
733 "Non-Parity Error ctl: %s %d: %s\n",
734 pci->ctl_name, pci->pci_idx, msg);
735
736 /*
737 * poke all PCI devices and see which one is the troublemaker
738 * panic() is called if set
739 */
740 edac_pci_do_parity_check();
741}
742EXPORT_SYMBOL_GPL(edac_pci_handle_npe);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700743
744/*
745 * Define the PCI parameter to the module
746 */
Dave Jiang91b99042007-07-19 01:49:52 -0700747module_param(check_pci_errors, int, 0644);
Dave Jiang4de78c62007-07-19 01:49:54 -0700748MODULE_PARM_DESC(check_pci_errors,
Douglas Thompson079708b2007-07-19 01:49:58 -0700749 "Check for PCI bus parity errors: 0=off 1=on");
Dave Jiang4de78c62007-07-19 01:49:54 -0700750module_param(edac_pci_panic_on_pe, int, 0644);
751MODULE_PARM_DESC(edac_pci_panic_on_pe,
Douglas Thompson079708b2007-07-19 01:49:58 -0700752 "Panic on PCI Bus Parity error: 0=off 1=on");
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700753
Douglas Thompson079708b2007-07-19 01:49:58 -0700754#endif /* CONFIG_PCI */