blob: 7b44afcf48db06dc7254259244984eabdb11028c [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>
Borislav Petkov30e1f7a2010-09-02 17:26:48 +020010#include <linux/edac.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090011#include <linux/slab.h>
Douglas Thompson7c9281d2007-07-19 01:49:33 -070012#include <linux/ctype.h>
13
Mauro Carvalho Chehab0b892c72016-10-29 09:56:00 -020014#include "edac_pci.h"
Douglas Thompson7c9281d2007-07-19 01:49:33 -070015#include "edac_module.h"
16
Dave Jiang91b99042007-07-19 01:49:52 -070017#define EDAC_PCI_SYMLINK "device"
18
Doug Thompsond4c14652007-07-26 10:41:15 -070019/* data variables exported via sysfs */
20static int check_pci_errors; /* default NO check PCI parity */
21static int edac_pci_panic_on_pe; /* default NO panic on PCI Parity */
22static int edac_pci_log_pe = 1; /* log PCI parity errors */
Dave Jiang4de78c62007-07-19 01:49:54 -070023static int edac_pci_log_npe = 1; /* log PCI non-parity error errors */
Doug Thompsond4c14652007-07-26 10:41:15 -070024static int edac_pci_poll_msec = 1000; /* one second workq period */
25
Douglas Thompson7c9281d2007-07-19 01:49:33 -070026static atomic_t pci_parity_count = ATOMIC_INIT(0);
Dave Jiang91b99042007-07-19 01:49:52 -070027static atomic_t pci_nonparity_count = ATOMIC_INIT(0);
Douglas Thompson7c9281d2007-07-19 01:49:33 -070028
Arthur Jones14cc5712008-07-25 01:49:08 -070029static struct kobject *edac_pci_top_main_kobj;
Dave Jiang91b99042007-07-19 01:49:52 -070030static atomic_t edac_pci_sysfs_refcount = ATOMIC_INIT(0);
Douglas Thompson7c9281d2007-07-19 01:49:33 -070031
Doug Thompsond4c14652007-07-26 10:41:15 -070032/* getter functions for the data variables */
Dave Jiang4de78c62007-07-19 01:49:54 -070033int edac_pci_get_check_errors(void)
34{
35 return check_pci_errors;
36}
37
Adrian Bunk1a450272008-04-29 01:03:18 -070038static int edac_pci_get_log_pe(void)
Dave Jiang4de78c62007-07-19 01:49:54 -070039{
40 return edac_pci_log_pe;
41}
42
Adrian Bunk1a450272008-04-29 01:03:18 -070043static int edac_pci_get_log_npe(void)
Dave Jiang4de78c62007-07-19 01:49:54 -070044{
45 return edac_pci_log_npe;
46}
47
Adrian Bunk1a450272008-04-29 01:03:18 -070048static int edac_pci_get_panic_on_pe(void)
Dave Jiang4de78c62007-07-19 01:49:54 -070049{
50 return edac_pci_panic_on_pe;
51}
52
53int edac_pci_get_poll_msec(void)
54{
55 return edac_pci_poll_msec;
56}
57
Dave Jiang91b99042007-07-19 01:49:52 -070058/**************************** EDAC PCI sysfs instance *******************/
59static ssize_t instance_pe_count_show(struct edac_pci_ctl_info *pci, char *data)
60{
Douglas Thompson079708b2007-07-19 01:49:58 -070061 return sprintf(data, "%u\n", atomic_read(&pci->counters.pe_count));
Dave Jiang91b99042007-07-19 01:49:52 -070062}
63
64static ssize_t instance_npe_count_show(struct edac_pci_ctl_info *pci,
Douglas Thompson052dfb42007-07-19 01:50:13 -070065 char *data)
Dave Jiang91b99042007-07-19 01:49:52 -070066{
Douglas Thompson079708b2007-07-19 01:49:58 -070067 return sprintf(data, "%u\n", atomic_read(&pci->counters.npe_count));
Dave Jiang91b99042007-07-19 01:49:52 -070068}
69
70#define to_instance(k) container_of(k, struct edac_pci_ctl_info, kobj)
71#define to_instance_attr(a) container_of(a, struct instance_attribute, attr)
72
73/* DEVICE instance kobject release() function */
74static void edac_pci_instance_release(struct kobject *kobj)
75{
76 struct edac_pci_ctl_info *pci;
77
Joe Perches956b9ba12012-04-29 17:08:39 -030078 edac_dbg(0, "\n");
Dave Jiang91b99042007-07-19 01:49:52 -070079
Doug Thompsond4c14652007-07-26 10:41:15 -070080 /* Form pointer to containing struct, the pci control struct */
Dave Jiang91b99042007-07-19 01:49:52 -070081 pci = to_instance(kobj);
Doug Thompsond4c14652007-07-26 10:41:15 -070082
83 /* decrement reference count on top main kobj */
Arthur Jones14cc5712008-07-25 01:49:08 -070084 kobject_put(edac_pci_top_main_kobj);
Doug Thompsond4c14652007-07-26 10:41:15 -070085
86 kfree(pci); /* Free the control struct */
Dave Jiang91b99042007-07-19 01:49:52 -070087}
88
89/* instance specific attribute structure */
90struct instance_attribute {
Douglas Thompson079708b2007-07-19 01:49:58 -070091 struct attribute attr;
Doug Thompsond4c14652007-07-26 10:41:15 -070092 ssize_t(*show) (struct edac_pci_ctl_info *, char *);
93 ssize_t(*store) (struct edac_pci_ctl_info *, const char *, size_t);
Dave Jiang91b99042007-07-19 01:49:52 -070094};
95
96/* Function to 'show' fields from the edac_pci 'instance' structure */
97static ssize_t edac_pci_instance_show(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -070098 struct attribute *attr, char *buffer)
Dave Jiang91b99042007-07-19 01:49:52 -070099{
Douglas Thompson079708b2007-07-19 01:49:58 -0700100 struct edac_pci_ctl_info *pci = to_instance(kobj);
101 struct instance_attribute *instance_attr = to_instance_attr(attr);
Dave Jiang91b99042007-07-19 01:49:52 -0700102
Douglas Thompson079708b2007-07-19 01:49:58 -0700103 if (instance_attr->show)
104 return instance_attr->show(pci, buffer);
105 return -EIO;
Dave Jiang91b99042007-07-19 01:49:52 -0700106}
107
Dave Jiang91b99042007-07-19 01:49:52 -0700108/* Function to 'store' fields into the edac_pci 'instance' structure */
109static ssize_t edac_pci_instance_store(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700110 struct attribute *attr,
111 const char *buffer, size_t count)
Dave Jiang91b99042007-07-19 01:49:52 -0700112{
Douglas Thompson079708b2007-07-19 01:49:58 -0700113 struct edac_pci_ctl_info *pci = to_instance(kobj);
114 struct instance_attribute *instance_attr = to_instance_attr(attr);
Dave Jiang91b99042007-07-19 01:49:52 -0700115
Douglas Thompson079708b2007-07-19 01:49:58 -0700116 if (instance_attr->store)
117 return instance_attr->store(pci, buffer, count);
118 return -EIO;
Dave Jiang91b99042007-07-19 01:49:52 -0700119}
120
Doug Thompsond4c14652007-07-26 10:41:15 -0700121/* fs_ops table */
Emese Revfy52cf25d2010-01-19 02:58:23 +0100122static const struct sysfs_ops pci_instance_ops = {
Dave Jiang91b99042007-07-19 01:49:52 -0700123 .show = edac_pci_instance_show,
124 .store = edac_pci_instance_store
125};
126
127#define INSTANCE_ATTR(_name, _mode, _show, _store) \
128static struct instance_attribute attr_instance_##_name = { \
129 .attr = {.name = __stringify(_name), .mode = _mode }, \
130 .show = _show, \
131 .store = _store, \
132};
133
134INSTANCE_ATTR(pe_count, S_IRUGO, instance_pe_count_show, NULL);
135INSTANCE_ATTR(npe_count, S_IRUGO, instance_npe_count_show, NULL);
136
137/* pci instance attributes */
Greg Kroah-Hartman625c6b52022-01-04 12:24:01 +0100138static struct attribute *pci_instance_attrs[] = {
Greg Kroah-Hartman11413892022-01-04 12:24:00 +0100139 &attr_instance_pe_count.attr,
140 &attr_instance_npe_count.attr,
Dave Jiang91b99042007-07-19 01:49:52 -0700141 NULL
142};
Greg Kroah-Hartman625c6b52022-01-04 12:24:01 +0100143ATTRIBUTE_GROUPS(pci_instance);
Dave Jiang91b99042007-07-19 01:49:52 -0700144
Doug Thompsond4c14652007-07-26 10:41:15 -0700145/* the ktype for a pci instance */
Dave Jiang91b99042007-07-19 01:49:52 -0700146static struct kobj_type ktype_pci_instance = {
147 .release = edac_pci_instance_release,
148 .sysfs_ops = &pci_instance_ops,
Greg Kroah-Hartman625c6b52022-01-04 12:24:01 +0100149 .default_groups = pci_instance_groups,
Dave Jiang91b99042007-07-19 01:49:52 -0700150};
151
Doug Thompsond4c14652007-07-26 10:41:15 -0700152/*
153 * edac_pci_create_instance_kobj
154 *
155 * construct one EDAC PCI instance's kobject for use
156 */
Dave Jiang91b99042007-07-19 01:49:52 -0700157static int edac_pci_create_instance_kobj(struct edac_pci_ctl_info *pci, int idx)
158{
Doug Thompsond4c14652007-07-26 10:41:15 -0700159 struct kobject *main_kobj;
Dave Jiang91b99042007-07-19 01:49:52 -0700160 int err;
161
Joe Perches956b9ba12012-04-29 17:08:39 -0300162 edac_dbg(0, "\n");
Doug Thompsond4c14652007-07-26 10:41:15 -0700163
Doug Thompsond4c14652007-07-26 10:41:15 -0700164 /* First bump the ref count on the top main kobj, which will
165 * track the number of PCI instances we have, and thus nest
166 * properly on keeping the module loaded
167 */
Arthur Jones14cc5712008-07-25 01:49:08 -0700168 main_kobj = kobject_get(edac_pci_top_main_kobj);
Doug Thompsond4c14652007-07-26 10:41:15 -0700169 if (!main_kobj) {
170 err = -ENODEV;
171 goto error_out;
172 }
173
174 /* And now register this new kobject under the main kobj */
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400175 err = kobject_init_and_add(&pci->kobj, &ktype_pci_instance,
Arthur Jones14cc5712008-07-25 01:49:08 -0700176 edac_pci_top_main_kobj, "pci%d", idx);
Dave Jiang91b99042007-07-19 01:49:52 -0700177 if (err != 0) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300178 edac_dbg(2, "failed to register instance pci%d\n", idx);
Arthur Jones14cc5712008-07-25 01:49:08 -0700179 kobject_put(edac_pci_top_main_kobj);
Doug Thompsond4c14652007-07-26 10:41:15 -0700180 goto error_out;
Dave Jiang91b99042007-07-19 01:49:52 -0700181 }
182
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400183 kobject_uevent(&pci->kobj, KOBJ_ADD);
Joe Perches956b9ba12012-04-29 17:08:39 -0300184 edac_dbg(1, "Register instance 'pci%d' kobject\n", idx);
Dave Jiang91b99042007-07-19 01:49:52 -0700185
186 return 0;
Doug Thompsond4c14652007-07-26 10:41:15 -0700187
188 /* Error unwind statck */
189error_out:
190 return err;
Dave Jiang91b99042007-07-19 01:49:52 -0700191}
192
Doug Thompsond4c14652007-07-26 10:41:15 -0700193/*
194 * edac_pci_unregister_sysfs_instance_kobj
195 *
196 * unregister the kobj for the EDAC PCI instance
197 */
Adrian Bunk1a450272008-04-29 01:03:18 -0700198static void edac_pci_unregister_sysfs_instance_kobj(
199 struct edac_pci_ctl_info *pci)
Dave Jiang91b99042007-07-19 01:49:52 -0700200{
Joe Perches956b9ba12012-04-29 17:08:39 -0300201 edac_dbg(0, "\n");
Doug Thompsond4c14652007-07-26 10:41:15 -0700202
203 /* Unregister the instance kobject and allow its release
204 * function release the main reference count and then
205 * kfree the memory
206 */
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800207 kobject_put(&pci->kobj);
Dave Jiang91b99042007-07-19 01:49:52 -0700208}
209
210/***************************** EDAC PCI sysfs root **********************/
211#define to_edacpci(k) container_of(k, struct edac_pci_ctl_info, kobj)
212#define to_edacpci_attr(a) container_of(a, struct edac_pci_attr, attr)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700213
Doug Thompsond4c14652007-07-26 10:41:15 -0700214/* simple show/store functions for attributes */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700215static ssize_t edac_pci_int_show(void *ptr, char *buffer)
216{
217 int *value = ptr;
Douglas Thompson079708b2007-07-19 01:49:58 -0700218 return sprintf(buffer, "%d\n", *value);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700219}
220
221static ssize_t edac_pci_int_store(void *ptr, const char *buffer, size_t count)
222{
223 int *value = ptr;
224
225 if (isdigit(*buffer))
Douglas Thompson079708b2007-07-19 01:49:58 -0700226 *value = simple_strtoul(buffer, NULL, 0);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700227
228 return count;
229}
230
231struct edac_pci_dev_attribute {
232 struct attribute attr;
233 void *value;
Douglas Thompson079708b2007-07-19 01:49:58 -0700234 ssize_t(*show) (void *, char *);
235 ssize_t(*store) (void *, const char *, size_t);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700236};
237
238/* Set of show/store abstract level functions for PCI Parity object */
239static ssize_t edac_pci_dev_show(struct kobject *kobj, struct attribute *attr,
Douglas Thompson079708b2007-07-19 01:49:58 -0700240 char *buffer)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700241{
242 struct edac_pci_dev_attribute *edac_pci_dev;
Douglas Thompson079708b2007-07-19 01:49:58 -0700243 edac_pci_dev = (struct edac_pci_dev_attribute *)attr;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700244
245 if (edac_pci_dev->show)
246 return edac_pci_dev->show(edac_pci_dev->value, buffer);
247 return -EIO;
248}
249
250static ssize_t edac_pci_dev_store(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700251 struct attribute *attr, const char *buffer,
252 size_t count)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700253{
254 struct edac_pci_dev_attribute *edac_pci_dev;
Douglas Thompson079708b2007-07-19 01:49:58 -0700255 edac_pci_dev = (struct edac_pci_dev_attribute *)attr;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700256
Dan Carpenter8024c4c2013-01-26 10:49:24 +0300257 if (edac_pci_dev->store)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700258 return edac_pci_dev->store(edac_pci_dev->value, buffer, count);
259 return -EIO;
260}
261
Emese Revfy52cf25d2010-01-19 02:58:23 +0100262static const struct sysfs_ops edac_pci_sysfs_ops = {
Douglas Thompson079708b2007-07-19 01:49:58 -0700263 .show = edac_pci_dev_show,
264 .store = edac_pci_dev_store
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700265};
266
267#define EDAC_PCI_ATTR(_name,_mode,_show,_store) \
268static struct edac_pci_dev_attribute edac_pci_attr_##_name = { \
269 .attr = {.name = __stringify(_name), .mode = _mode }, \
270 .value = &_name, \
271 .show = _show, \
272 .store = _store, \
273};
274
275#define EDAC_PCI_STRING_ATTR(_name,_data,_mode,_show,_store) \
276static struct edac_pci_dev_attribute edac_pci_attr_##_name = { \
277 .attr = {.name = __stringify(_name), .mode = _mode }, \
278 .value = _data, \
279 .show = _show, \
280 .store = _store, \
281};
282
283/* PCI Parity control files */
Douglas Thompson079708b2007-07-19 01:49:58 -0700284EDAC_PCI_ATTR(check_pci_errors, S_IRUGO | S_IWUSR, edac_pci_int_show,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700285 edac_pci_int_store);
Douglas Thompson079708b2007-07-19 01:49:58 -0700286EDAC_PCI_ATTR(edac_pci_log_pe, S_IRUGO | S_IWUSR, edac_pci_int_show,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700287 edac_pci_int_store);
Douglas Thompson079708b2007-07-19 01:49:58 -0700288EDAC_PCI_ATTR(edac_pci_log_npe, S_IRUGO | S_IWUSR, edac_pci_int_show,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700289 edac_pci_int_store);
Douglas Thompson079708b2007-07-19 01:49:58 -0700290EDAC_PCI_ATTR(edac_pci_panic_on_pe, S_IRUGO | S_IWUSR, edac_pci_int_show,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700291 edac_pci_int_store);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700292EDAC_PCI_ATTR(pci_parity_count, S_IRUGO, edac_pci_int_show, NULL);
Dave Jiang91b99042007-07-19 01:49:52 -0700293EDAC_PCI_ATTR(pci_nonparity_count, S_IRUGO, edac_pci_int_show, NULL);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700294
295/* Base Attributes of the memory ECC object */
Greg Kroah-Hartman625c6b52022-01-04 12:24:01 +0100296static struct attribute *edac_pci_attrs[] = {
Greg Kroah-Hartman11413892022-01-04 12:24:00 +0100297 &edac_pci_attr_check_pci_errors.attr,
298 &edac_pci_attr_edac_pci_log_pe.attr,
299 &edac_pci_attr_edac_pci_log_npe.attr,
300 &edac_pci_attr_edac_pci_panic_on_pe.attr,
301 &edac_pci_attr_pci_parity_count.attr,
302 &edac_pci_attr_pci_nonparity_count.attr,
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700303 NULL,
304};
Greg Kroah-Hartman625c6b52022-01-04 12:24:01 +0100305ATTRIBUTE_GROUPS(edac_pci);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700306
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{
Joe Perches956b9ba12012-04-29 17:08:39 -0300318 edac_dbg(0, "here to module_put(THIS_MODULE)\n");
Dave Jiang91b99042007-07-19 01:49:52 -0700319
Arthur Jones14cc5712008-07-25 01:49:08 -0700320 kfree(kobj);
321
Doug Thompsond4c14652007-07-26 10:41:15 -0700322 /* last reference to top EDAC PCI kobject has been removed,
323 * NOW release our ref count on the core module
324 */
325 module_put(THIS_MODULE);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700326}
327
Doug Thompsond4c14652007-07-26 10:41:15 -0700328/* ktype struct for the EDAC PCI main kobj */
329static struct kobj_type ktype_edac_pci_main_kobj = {
330 .release = edac_pci_release_main_kobj,
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700331 .sysfs_ops = &edac_pci_sysfs_ops,
Greg Kroah-Hartman625c6b52022-01-04 12:24:01 +0100332 .default_groups = edac_pci_groups,
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700333};
334
335/**
Borislav Petkovd4538002015-11-30 14:20:41 +0100336 * edac_pci_main_kobj_setup: Setup the sysfs for EDAC PCI attributes.
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700337 */
Adrian Bunk1a450272008-04-29 01:03:18 -0700338static int edac_pci_main_kobj_setup(void)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700339{
Greg Kroah-Hartmancb4a0be2023-03-13 19:28:43 +0100340 int err = -ENODEV;
Greg Kroah-Hartmanf36be9c2023-12-19 14:13:10 +0100341 const struct bus_type *edac_subsys;
Greg Kroah-Hartmancb4a0be2023-03-13 19:28:43 +0100342 struct device *dev_root;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700343
Joe Perches956b9ba12012-04-29 17:08:39 -0300344 edac_dbg(0, "\n");
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700345
Doug Thompsond4c14652007-07-26 10:41:15 -0700346 /* check and count if we have already created the main kobject */
347 if (atomic_inc_return(&edac_pci_sysfs_refcount) != 1)
348 return 0;
349
350 /* First time, so create the main kobject and its
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300351 * controls and attributes
Doug Thompsond4c14652007-07-26 10:41:15 -0700352 */
Kay Sieversfe5ff8b2011-12-14 15:21:07 -0800353 edac_subsys = edac_get_sysfs_subsys();
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700354
Doug Thompsond4c14652007-07-26 10:41:15 -0700355 /* Bump the reference count on this module to ensure the
356 * modules isn't unloaded until we deconstruct the top
357 * level main kobj for EDAC PCI
358 */
359 if (!try_module_get(THIS_MODULE)) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300360 edac_dbg(1, "try_module_get() failed\n");
Borislav Petkov733476c2015-11-27 11:40:43 +0100361 goto decrement_count_fail;
Doug Thompsond4c14652007-07-26 10:41:15 -0700362 }
Dave Jiang91b99042007-07-19 01:49:52 -0700363
Arthur Jones14cc5712008-07-25 01:49:08 -0700364 edac_pci_top_main_kobj = kzalloc(sizeof(struct kobject), GFP_KERNEL);
365 if (!edac_pci_top_main_kobj) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300366 edac_dbg(1, "Failed to allocate\n");
Arthur Jones14cc5712008-07-25 01:49:08 -0700367 err = -ENOMEM;
368 goto kzalloc_fail;
369 }
370
Dave Jiang91b99042007-07-19 01:49:52 -0700371 /* Instanstiate the pci object */
Greg Kroah-Hartmancb4a0be2023-03-13 19:28:43 +0100372 dev_root = bus_get_dev_root(edac_subsys);
373 if (dev_root) {
374 err = kobject_init_and_add(edac_pci_top_main_kobj,
375 &ktype_edac_pci_main_kobj,
376 &dev_root->kobj, "pci");
377 put_device(dev_root);
378 }
Dave Jiang91b99042007-07-19 01:49:52 -0700379 if (err) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300380 edac_dbg(1, "Failed to register '.../edac/pci'\n");
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400381 goto kobject_init_and_add_fail;
Dave Jiang91b99042007-07-19 01:49:52 -0700382 }
383
Doug Thompsond4c14652007-07-26 10:41:15 -0700384 /* At this point, to 'release' the top level kobject
385 * for EDAC PCI, then edac_pci_main_kobj_teardown()
386 * must be used, for resources to be cleaned up properly
387 */
Arthur Jones14cc5712008-07-25 01:49:08 -0700388 kobject_uevent(edac_pci_top_main_kobj, KOBJ_ADD);
Joe Perches956b9ba12012-04-29 17:08:39 -0300389 edac_dbg(1, "Registered '.../edac/pci' kobject\n");
Dave Jiang91b99042007-07-19 01:49:52 -0700390
391 return 0;
Doug Thompsond4c14652007-07-26 10:41:15 -0700392
393 /* Error unwind statck */
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400394kobject_init_and_add_fail:
Qiushi Wu17ed8082020-05-28 15:22:37 -0500395 kobject_put(edac_pci_top_main_kobj);
Arthur Jones14cc5712008-07-25 01:49:08 -0700396
397kzalloc_fail:
Doug Thompsond4c14652007-07-26 10:41:15 -0700398 module_put(THIS_MODULE);
399
400decrement_count_fail:
401 /* if are on this error exit, nothing to tear down */
402 atomic_dec(&edac_pci_sysfs_refcount);
403
404 return err;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700405}
406
407/*
Doug Thompsond4c14652007-07-26 10:41:15 -0700408 * edac_pci_main_kobj_teardown()
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700409 *
Doug Thompsond4c14652007-07-26 10:41:15 -0700410 * if no longer linked (needed) remove the top level EDAC PCI
411 * kobject with its controls and attributes
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700412 */
Doug Thompsond4c14652007-07-26 10:41:15 -0700413static void edac_pci_main_kobj_teardown(void)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700414{
Joe Perches956b9ba12012-04-29 17:08:39 -0300415 edac_dbg(0, "\n");
Doug Thompsond4c14652007-07-26 10:41:15 -0700416
417 /* Decrement the count and only if no more controller instances
418 * are connected perform the unregisteration of the top level
419 * main kobj
420 */
421 if (atomic_dec_return(&edac_pci_sysfs_refcount) == 0) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300422 edac_dbg(0, "called kobject_put on main kobj\n");
Arthur Jones14cc5712008-07-25 01:49:08 -0700423 kobject_put(edac_pci_top_main_kobj);
Doug Thompsond4c14652007-07-26 10:41:15 -0700424 }
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700425}
426
Dave Jiang91b99042007-07-19 01:49:52 -0700427int edac_pci_create_sysfs(struct edac_pci_ctl_info *pci)
428{
429 int err;
430 struct kobject *edac_kobj = &pci->kobj;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700431
Joe Perches956b9ba12012-04-29 17:08:39 -0300432 edac_dbg(0, "idx=%d\n", pci->pci_idx);
Dave Jiang91b99042007-07-19 01:49:52 -0700433
Doug Thompsond4c14652007-07-26 10:41:15 -0700434 /* create the top main EDAC PCI kobject, IF needed */
435 err = edac_pci_main_kobj_setup();
436 if (err)
437 return err;
438
439 /* Create this instance's kobject under the MAIN kobject */
440 err = edac_pci_create_instance_kobj(pci, pci->pci_idx);
441 if (err)
442 goto unregister_cleanup;
443
Douglas Thompson079708b2007-07-19 01:49:58 -0700444 err = sysfs_create_link(edac_kobj, &pci->dev->kobj, EDAC_PCI_SYMLINK);
Dave Jiang91b99042007-07-19 01:49:52 -0700445 if (err) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300446 edac_dbg(0, "sysfs_create_link() returned err= %d\n", 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
462void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci)
463{
Joe Perches956b9ba12012-04-29 17:08:39 -0300464 edac_dbg(0, "index=%d\n", pci->pci_idx);
Dave Jiang91b99042007-07-19 01:49:52 -0700465
Doug Thompsond4c14652007-07-26 10:41:15 -0700466 /* Remove the symlink */
Dave Jiang91b99042007-07-19 01:49:52 -0700467 sysfs_remove_link(&pci->kobj, EDAC_PCI_SYMLINK);
468
Doug Thompsond4c14652007-07-26 10:41:15 -0700469 /* remove this PCI instance's sysfs entries */
470 edac_pci_unregister_sysfs_instance_kobj(pci);
471
472 /* Call the main unregister function, which will determine
473 * if this 'pci' is the last instance.
474 * If it is, the main kobject will be unregistered as a result
475 */
Joe Perches956b9ba12012-04-29 17:08:39 -0300476 edac_dbg(0, "calling edac_pci_main_kobj_teardown()\n");
Doug Thompsond4c14652007-07-26 10:41:15 -0700477 edac_pci_main_kobj_teardown();
Dave Jiang91b99042007-07-19 01:49:52 -0700478}
479
480/************************ PCI error handling *************************/
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700481static u16 get_pci_parity_status(struct pci_dev *dev, int secondary)
482{
483 int where;
484 u16 status;
485
486 where = secondary ? PCI_SEC_STATUS : PCI_STATUS;
487 pci_read_config_word(dev, where, &status);
488
489 /* If we get back 0xFFFF then we must suspect that the card has been
490 * pulled but the Linux PCI layer has not yet finished cleaning up.
491 * We don't want to report on such devices
492 */
493
494 if (status == 0xFFFF) {
495 u32 sanity;
496
497 pci_read_config_dword(dev, 0, &sanity);
498
499 if (sanity == 0xFFFFFFFF)
500 return 0;
501 }
502
503 status &= PCI_STATUS_DETECTED_PARITY | PCI_STATUS_SIG_SYSTEM_ERROR |
Douglas Thompson052dfb42007-07-19 01:50:13 -0700504 PCI_STATUS_PARITY;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700505
506 if (status)
507 /* reset only the bits we are interested in */
508 pci_write_config_word(dev, where, status);
509
510 return status;
511}
512
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700513
514/* Clear any PCI parity errors logged by this device. */
515static void edac_pci_dev_parity_clear(struct pci_dev *dev)
516{
517 u8 header_type;
518
519 get_pci_parity_status(dev, 0);
520
521 /* read the device TYPE, looking for bridges */
522 pci_read_config_byte(dev, PCI_HEADER_TYPE, &header_type);
523
Ilpo Järvinen5f57b712023-11-24 11:09:17 +0200524 if ((header_type & PCI_HEADER_TYPE_MASK) == PCI_HEADER_TYPE_BRIDGE)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700525 get_pci_parity_status(dev, 1);
526}
527
528/*
529 * PCI Parity polling
530 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300531 * Function to retrieve the current parity status
Doug Thompsond4c14652007-07-26 10:41:15 -0700532 * and decode it
533 *
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700534 */
535static void edac_pci_dev_parity_test(struct pci_dev *dev)
536{
Doug Thompsond4c14652007-07-26 10:41:15 -0700537 unsigned long flags;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700538 u16 status;
Douglas Thompson079708b2007-07-19 01:49:58 -0700539 u8 header_type;
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700540
Doug Thompsond4c14652007-07-26 10:41:15 -0700541 /* stop any interrupts until we can acquire the status */
542 local_irq_save(flags);
543
544 /* read the STATUS register on this device */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700545 status = get_pci_parity_status(dev, 0);
546
Doug Thompsond4c14652007-07-26 10:41:15 -0700547 /* read the device TYPE, looking for bridges */
548 pci_read_config_byte(dev, PCI_HEADER_TYPE, &header_type);
549
550 local_irq_restore(flags);
551
Joe Perches956b9ba12012-04-29 17:08:39 -0300552 edac_dbg(4, "PCI STATUS= 0x%04x %s\n", status, dev_name(&dev->dev));
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700553
Bryan Boatright6b09ff92008-02-07 00:14:58 -0800554 /* check the status reg for errors on boards NOT marked as broken
555 * if broken, we cannot trust any of the status bits
556 */
557 if (status && !dev->broken_parity_status) {
Dave Jiang91b99042007-07-19 01:49:52 -0700558 if (status & (PCI_STATUS_SIG_SYSTEM_ERROR)) {
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700559 edac_printk(KERN_CRIT, EDAC_PCI,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700560 "Signaled System Error on %s\n",
561 pci_name(dev));
Dave Jiang91b99042007-07-19 01:49:52 -0700562 atomic_inc(&pci_nonparity_count);
563 }
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700564
565 if (status & (PCI_STATUS_PARITY)) {
566 edac_printk(KERN_CRIT, EDAC_PCI,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700567 "Master Data Parity Error on %s\n",
568 pci_name(dev));
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700569
570 atomic_inc(&pci_parity_count);
571 }
572
573 if (status & (PCI_STATUS_DETECTED_PARITY)) {
574 edac_printk(KERN_CRIT, EDAC_PCI,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700575 "Detected Parity Error on %s\n",
576 pci_name(dev));
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700577
578 atomic_inc(&pci_parity_count);
579 }
580 }
581
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700582
Joe Perches956b9ba12012-04-29 17:08:39 -0300583 edac_dbg(4, "PCI HEADER TYPE= 0x%02x %s\n",
584 header_type, dev_name(&dev->dev));
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700585
Ilpo Järvinen5f57b712023-11-24 11:09:17 +0200586 if ((header_type & PCI_HEADER_TYPE_MASK) == PCI_HEADER_TYPE_BRIDGE) {
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700587 /* On bridges, need to examine secondary status register */
588 status = get_pci_parity_status(dev, 1);
589
Joe Perches956b9ba12012-04-29 17:08:39 -0300590 edac_dbg(4, "PCI SEC_STATUS= 0x%04x %s\n",
591 status, dev_name(&dev->dev));
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700592
Bryan Boatright6b09ff92008-02-07 00:14:58 -0800593 /* check the secondary status reg for errors,
594 * on NOT broken boards
595 */
596 if (status && !dev->broken_parity_status) {
Dave Jiang91b99042007-07-19 01:49:52 -0700597 if (status & (PCI_STATUS_SIG_SYSTEM_ERROR)) {
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700598 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
Douglas Thompson052dfb42007-07-19 01:50:13 -0700599 "Signaled System Error on %s\n",
600 pci_name(dev));
Dave Jiang91b99042007-07-19 01:49:52 -0700601 atomic_inc(&pci_nonparity_count);
602 }
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700603
604 if (status & (PCI_STATUS_PARITY)) {
605 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
Douglas Thompson052dfb42007-07-19 01:50:13 -0700606 "Master Data Parity Error on "
607 "%s\n", pci_name(dev));
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700608
609 atomic_inc(&pci_parity_count);
610 }
611
612 if (status & (PCI_STATUS_DETECTED_PARITY)) {
613 edac_printk(KERN_CRIT, EDAC_PCI, "Bridge "
Douglas Thompson052dfb42007-07-19 01:50:13 -0700614 "Detected Parity Error on %s\n",
615 pci_name(dev));
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700616
617 atomic_inc(&pci_parity_count);
618 }
619 }
620 }
621}
622
Doug Thompsond4c14652007-07-26 10:41:15 -0700623/* reduce some complexity in definition of the iterator */
624typedef void (*pci_parity_check_fn_t) (struct pci_dev *dev);
625
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700626/*
627 * pci_dev parity list iterator
Wei Yongjun3bfe5aa2012-12-04 00:01:42 -0500628 *
629 * Scan the PCI device list looking for SERRORs, Master Parity ERRORS or
630 * Parity ERRORs on primary or secondary devices.
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700631 */
632static inline void edac_pci_dev_parity_iterator(pci_parity_check_fn_t fn)
633{
634 struct pci_dev *dev = NULL;
635
Wei Yongjun3bfe5aa2012-12-04 00:01:42 -0500636 for_each_pci_dev(dev)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700637 fn(dev);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700638}
639
640/*
641 * edac_pci_do_parity_check
642 *
643 * performs the actual PCI parity check operation
644 */
645void edac_pci_do_parity_check(void)
646{
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700647 int before_count;
648
Joe Perches956b9ba12012-04-29 17:08:39 -0300649 edac_dbg(3, "\n");
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700650
Doug Thompsond4c14652007-07-26 10:41:15 -0700651 /* if policy has PCI check off, leave now */
Dave Jiang91b99042007-07-19 01:49:52 -0700652 if (!check_pci_errors)
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700653 return;
654
655 before_count = atomic_read(&pci_parity_count);
656
657 /* scan all PCI devices looking for a Parity Error on devices and
Doug Thompsond4c14652007-07-26 10:41:15 -0700658 * bridges.
659 * The iterator calls pci_get_device() which might sleep, thus
660 * we cannot disable interrupts in this scan.
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700661 */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700662 edac_pci_dev_parity_iterator(edac_pci_dev_parity_test);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700663
664 /* Only if operator has selected panic on PCI Error */
Dave Jiang4de78c62007-07-19 01:49:54 -0700665 if (edac_pci_get_panic_on_pe()) {
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700666 /* If the count is different 'after' from 'before' */
667 if (before_count != atomic_read(&pci_parity_count))
668 panic("EDAC: PCI Parity Error");
669 }
670}
671
Doug Thompsond4c14652007-07-26 10:41:15 -0700672/*
673 * edac_pci_clear_parity_errors
674 *
675 * function to perform an iteration over the PCI devices
676 * and clearn their current status
677 */
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700678void edac_pci_clear_parity_errors(void)
679{
680 /* Clear any PCI bus parity errors that devices initially have logged
681 * in their registers.
682 */
683 edac_pci_dev_parity_iterator(edac_pci_dev_parity_clear);
684}
Doug Thompsond4c14652007-07-26 10:41:15 -0700685
686/*
687 * edac_pci_handle_pe
688 *
689 * Called to handle a PARITY ERROR event
690 */
Dave Jiang91b99042007-07-19 01:49:52 -0700691void edac_pci_handle_pe(struct edac_pci_ctl_info *pci, const char *msg)
692{
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700693
Dave Jiang91b99042007-07-19 01:49:52 -0700694 /* global PE counter incremented by edac_pci_do_parity_check() */
695 atomic_inc(&pci->counters.pe_count);
696
Dave Jiang4de78c62007-07-19 01:49:54 -0700697 if (edac_pci_get_log_pe())
Dave Jiang91b99042007-07-19 01:49:52 -0700698 edac_pci_printk(pci, KERN_WARNING,
699 "Parity Error ctl: %s %d: %s\n",
700 pci->ctl_name, pci->pci_idx, msg);
701
702 /*
703 * poke all PCI devices and see which one is the troublemaker
704 * panic() is called if set
705 */
706 edac_pci_do_parity_check();
707}
708EXPORT_SYMBOL_GPL(edac_pci_handle_pe);
709
Doug Thompsond4c14652007-07-26 10:41:15 -0700710
711/*
712 * edac_pci_handle_npe
713 *
714 * Called to handle a NON-PARITY ERROR event
715 */
Dave Jiang91b99042007-07-19 01:49:52 -0700716void edac_pci_handle_npe(struct edac_pci_ctl_info *pci, const char *msg)
717{
718
719 /* global NPE counter incremented by edac_pci_do_parity_check() */
720 atomic_inc(&pci->counters.npe_count);
721
Dave Jiang4de78c62007-07-19 01:49:54 -0700722 if (edac_pci_get_log_npe())
Dave Jiang91b99042007-07-19 01:49:52 -0700723 edac_pci_printk(pci, KERN_WARNING,
724 "Non-Parity Error ctl: %s %d: %s\n",
725 pci->ctl_name, pci->pci_idx, msg);
726
727 /*
728 * poke all PCI devices and see which one is the troublemaker
729 * panic() is called if set
730 */
731 edac_pci_do_parity_check();
732}
733EXPORT_SYMBOL_GPL(edac_pci_handle_npe);
Douglas Thompson7c9281d2007-07-19 01:49:33 -0700734
735/*
736 * Define the PCI parameter to the module
737 */
Dave Jiang91b99042007-07-19 01:49:52 -0700738module_param(check_pci_errors, int, 0644);
Dave Jiang4de78c62007-07-19 01:49:54 -0700739MODULE_PARM_DESC(check_pci_errors,
Douglas Thompson079708b2007-07-19 01:49:58 -0700740 "Check for PCI bus parity errors: 0=off 1=on");
Dave Jiang4de78c62007-07-19 01:49:54 -0700741module_param(edac_pci_panic_on_pe, int, 0644);
742MODULE_PARM_DESC(edac_pci_panic_on_pe,
Douglas Thompson079708b2007-07-19 01:49:58 -0700743 "Panic on PCI Bus Parity error: 0=off 1=on");