blob: 8f2f2899a7a2e06070689a535a1eb54171fd0ef7 [file] [log] [blame]
Dave Jiang91b99042007-07-19 01:49:52 -07001/*
2 * EDAC PCI component
3 *
4 * Author: Dave Jiang <djiang@mvista.com>
5 *
6 * 2007 (c) MontaVista Software, Inc. This file is licensed under
7 * the terms of the GNU General Public License version 2. This program
8 * is licensed "as is" without any warranty of any kind, whether express
9 * or implied.
10 *
11 */
12#include <linux/module.h>
13#include <linux/types.h>
14#include <linux/smp.h>
15#include <linux/init.h>
16#include <linux/sysctl.h>
17#include <linux/highmem.h>
18#include <linux/timer.h>
19#include <linux/slab.h>
20#include <linux/spinlock.h>
21#include <linux/list.h>
Dave Jiang91b99042007-07-19 01:49:52 -070022#include <linux/ctype.h>
23#include <linux/workqueue.h>
24#include <asm/uaccess.h>
25#include <asm/page.h>
26
27#include "edac_core.h"
28#include "edac_module.h"
29
30static DEFINE_MUTEX(edac_pci_ctls_mutex);
Robert P. J. Dayff6ac2a2008-04-29 01:03:17 -070031static LIST_HEAD(edac_pci_list);
Harry Ciao8641a382009-04-02 16:58:47 -070032static atomic_t pci_indexes = ATOMIC_INIT(0);
Dave Jiang91b99042007-07-19 01:49:52 -070033
Dave Jiang91b99042007-07-19 01:49:52 -070034/*
Doug Thompsond4c14652007-07-26 10:41:15 -070035 * edac_pci_alloc_ctl_info
36 *
37 * The alloc() function for the 'edac_pci' control info
38 * structure. The chip driver will allocate one of these for each
39 * edac_pci it is going to control/register with the EDAC CORE.
Dave Jiang91b99042007-07-19 01:49:52 -070040 */
Douglas Thompson079708b2007-07-19 01:49:58 -070041struct edac_pci_ctl_info *edac_pci_alloc_ctl_info(unsigned int sz_pvt,
Douglas Thompson052dfb42007-07-19 01:50:13 -070042 const char *edac_pci_name)
Dave Jiang91b99042007-07-19 01:49:52 -070043{
44 struct edac_pci_ctl_info *pci;
Mauro Carvalho Chehab93e4fe62012-04-16 10:18:12 -030045 void *p = NULL, *pvt;
Dave Jiang91b99042007-07-19 01:49:52 -070046 unsigned int size;
47
Joe Perches956b9ba12012-04-29 17:08:39 -030048 edac_dbg(1, "\n");
Doug Thompsond4c14652007-07-26 10:41:15 -070049
Mauro Carvalho Chehab93e4fe62012-04-16 10:18:12 -030050 pci = edac_align_ptr(&p, sizeof(*pci), 1);
51 pvt = edac_align_ptr(&p, 1, sz_pvt);
Dave Jiang91b99042007-07-19 01:49:52 -070052 size = ((unsigned long)pvt) + sz_pvt;
53
Doug Thompsond4c14652007-07-26 10:41:15 -070054 /* Alloc the needed control struct memory */
55 pci = kzalloc(size, GFP_KERNEL);
56 if (pci == NULL)
Dave Jiang91b99042007-07-19 01:49:52 -070057 return NULL;
58
Doug Thompsond4c14652007-07-26 10:41:15 -070059 /* Now much private space */
Dave Jiang91b99042007-07-19 01:49:52 -070060 pvt = sz_pvt ? ((char *)pci) + ((unsigned long)pvt) : NULL;
61
62 pci->pvt_info = pvt;
Dave Jiang91b99042007-07-19 01:49:52 -070063 pci->op_state = OP_ALLOC;
64
Douglas Thompson079708b2007-07-19 01:49:58 -070065 snprintf(pci->name, strlen(edac_pci_name) + 1, "%s", edac_pci_name);
Dave Jiang91b99042007-07-19 01:49:52 -070066
67 return pci;
68}
69EXPORT_SYMBOL_GPL(edac_pci_alloc_ctl_info);
70
71/*
72 * edac_pci_free_ctl_info()
Doug Thompsond4c14652007-07-26 10:41:15 -070073 *
74 * Last action on the pci control structure.
75 *
Joe Perches6f042b52008-02-03 17:12:34 +020076 * call the remove sysfs information, which will unregister
Doug Thompsond4c14652007-07-26 10:41:15 -070077 * this control struct's kobj. When that kobj's ref count
78 * goes to zero, its release function will be call and then
79 * kfree() the memory.
Dave Jiang91b99042007-07-19 01:49:52 -070080 */
81void edac_pci_free_ctl_info(struct edac_pci_ctl_info *pci)
82{
Joe Perches956b9ba12012-04-29 17:08:39 -030083 edac_dbg(1, "\n");
Douglas Thompson079708b2007-07-19 01:49:58 -070084
Doug Thompsond4c14652007-07-26 10:41:15 -070085 edac_pci_remove_sysfs(pci);
86}
Dave Jiang91b99042007-07-19 01:49:52 -070087EXPORT_SYMBOL_GPL(edac_pci_free_ctl_info);
88
89/*
90 * find_edac_pci_by_dev()
91 * scans the edac_pci list for a specific 'struct device *'
Doug Thompsond4c14652007-07-26 10:41:15 -070092 *
93 * return NULL if not found, or return control struct pointer
Dave Jiang91b99042007-07-19 01:49:52 -070094 */
Douglas Thompson079708b2007-07-19 01:49:58 -070095static struct edac_pci_ctl_info *find_edac_pci_by_dev(struct device *dev)
Dave Jiang91b99042007-07-19 01:49:52 -070096{
97 struct edac_pci_ctl_info *pci;
98 struct list_head *item;
99
Joe Perches956b9ba12012-04-29 17:08:39 -0300100 edac_dbg(1, "\n");
Dave Jiang91b99042007-07-19 01:49:52 -0700101
102 list_for_each(item, &edac_pci_list) {
103 pci = list_entry(item, struct edac_pci_ctl_info, link);
104
105 if (pci->dev == dev)
106 return pci;
107 }
108
109 return NULL;
110}
111
112/*
113 * add_edac_pci_to_global_list
114 * Before calling this function, caller must assign a unique value to
115 * edac_dev->pci_idx.
116 * Return:
117 * 0 on success
118 * 1 on failure
119 */
120static int add_edac_pci_to_global_list(struct edac_pci_ctl_info *pci)
121{
122 struct list_head *item, *insert_before;
123 struct edac_pci_ctl_info *rover;
124
Joe Perches956b9ba12012-04-29 17:08:39 -0300125 edac_dbg(1, "\n");
Doug Thompsond4c14652007-07-26 10:41:15 -0700126
Dave Jiang91b99042007-07-19 01:49:52 -0700127 insert_before = &edac_pci_list;
128
129 /* Determine if already on the list */
Doug Thompsond4c14652007-07-26 10:41:15 -0700130 rover = find_edac_pci_by_dev(pci->dev);
131 if (unlikely(rover != NULL))
Dave Jiang91b99042007-07-19 01:49:52 -0700132 goto fail0;
133
134 /* Insert in ascending order by 'pci_idx', so find position */
135 list_for_each(item, &edac_pci_list) {
136 rover = list_entry(item, struct edac_pci_ctl_info, link);
137
138 if (rover->pci_idx >= pci->pci_idx) {
139 if (unlikely(rover->pci_idx == pci->pci_idx))
140 goto fail1;
141
142 insert_before = item;
143 break;
144 }
145 }
146
147 list_add_tail_rcu(&pci->link, insert_before);
148 return 0;
149
Douglas Thompson052dfb42007-07-19 01:50:13 -0700150fail0:
Dave Jiang91b99042007-07-19 01:49:52 -0700151 edac_printk(KERN_WARNING, EDAC_PCI,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700152 "%s (%s) %s %s already assigned %d\n",
Kay Sievers281efb12009-01-06 14:42:57 -0800153 dev_name(rover->dev), edac_dev_name(rover),
Douglas Thompson052dfb42007-07-19 01:50:13 -0700154 rover->mod_name, rover->ctl_name, rover->pci_idx);
Dave Jiang91b99042007-07-19 01:49:52 -0700155 return 1;
156
Douglas Thompson052dfb42007-07-19 01:50:13 -0700157fail1:
Dave Jiang91b99042007-07-19 01:49:52 -0700158 edac_printk(KERN_WARNING, EDAC_PCI,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700159 "but in low-level driver: attempt to assign\n"
160 "\tduplicate pci_idx %d in %s()\n", rover->pci_idx,
161 __func__);
Dave Jiang91b99042007-07-19 01:49:52 -0700162 return 1;
163}
164
165/*
Dave Jiang91b99042007-07-19 01:49:52 -0700166 * del_edac_pci_from_global_list
Doug Thompsond4c14652007-07-26 10:41:15 -0700167 *
168 * remove the PCI control struct from the global list
Dave Jiang91b99042007-07-19 01:49:52 -0700169 */
170static void del_edac_pci_from_global_list(struct edac_pci_ctl_info *pci)
171{
172 list_del_rcu(&pci->link);
Lai Jiangshane2e77092011-05-26 16:25:58 -0700173
174 /* these are for safe removal of devices from global list while
175 * NMI handlers may be traversing list
176 */
177 synchronize_rcu();
178 INIT_LIST_HEAD(&pci->link);
Dave Jiang91b99042007-07-19 01:49:52 -0700179}
180
Dave Jiang91b99042007-07-19 01:49:52 -0700181/*
182 * edac_pci_workq_function()
Doug Thompsond4c14652007-07-26 10:41:15 -0700183 *
184 * periodic function that performs the operation
185 * scheduled by a workq request, for a given PCI control struct
Dave Jiang91b99042007-07-19 01:49:52 -0700186 */
Dave Jiang91b99042007-07-19 01:49:52 -0700187static void edac_pci_workq_function(struct work_struct *work_req)
188{
Jean Delvarefbeb4382009-04-13 14:40:21 -0700189 struct delayed_work *d_work = to_delayed_work(work_req);
Dave Jiang91b99042007-07-19 01:49:52 -0700190 struct edac_pci_ctl_info *pci = to_edac_pci_ctl_work(d_work);
Doug Thompsond4c14652007-07-26 10:41:15 -0700191 int msec;
192 unsigned long delay;
Dave Jiang91b99042007-07-19 01:49:52 -0700193
Joe Perches956b9ba12012-04-29 17:08:39 -0300194 edac_dbg(3, "checking\n");
Dave Jiang91b99042007-07-19 01:49:52 -0700195
Doug Thompsond4c14652007-07-26 10:41:15 -0700196 mutex_lock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700197
Borislav Petkov06e912d2016-02-02 11:36:11 +0100198 if (pci->op_state != OP_RUNNING_POLL) {
199 mutex_unlock(&edac_pci_ctls_mutex);
200 return;
Doug Thompsond4c14652007-07-26 10:41:15 -0700201 }
202
Borislav Petkov06e912d2016-02-02 11:36:11 +0100203 if (edac_pci_get_check_errors())
204 pci->edac_check(pci);
205
206 /* if we are on a one second period, then use round */
207 msec = edac_pci_get_poll_msec();
208 if (msec == 1000)
209 delay = round_jiffies_relative(msecs_to_jiffies(msec));
210 else
211 delay = msecs_to_jiffies(msec);
212
213 edac_queue_work(&pci->work, delay);
214
Doug Thompsond4c14652007-07-26 10:41:15 -0700215 mutex_unlock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700216}
217
218/*
Harry Ciao8641a382009-04-02 16:58:47 -0700219 * edac_pci_alloc_index: Allocate a unique PCI index number
220 *
221 * Return:
222 * allocated index number
223 *
224 */
225int edac_pci_alloc_index(void)
226{
227 return atomic_inc_return(&pci_indexes) - 1;
228}
229EXPORT_SYMBOL_GPL(edac_pci_alloc_index);
230
231/*
Dave Jiang91b99042007-07-19 01:49:52 -0700232 * edac_pci_add_device: Insert the 'edac_dev' structure into the
233 * edac_pci global list and create sysfs entries associated with
234 * edac_pci structure.
235 * @pci: pointer to the edac_device structure to be added to the list
236 * @edac_idx: A unique numeric identifier to be assigned to the
237 * 'edac_pci' structure.
238 *
239 * Return:
240 * 0 Success
241 * !0 Failure
242 */
243int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx)
244{
Joe Perches956b9ba12012-04-29 17:08:39 -0300245 edac_dbg(0, "\n");
Dave Jiang91b99042007-07-19 01:49:52 -0700246
247 pci->pci_idx = edac_idx;
Doug Thompsond4c14652007-07-26 10:41:15 -0700248 pci->start_time = jiffies;
Dave Jiang91b99042007-07-19 01:49:52 -0700249
Doug Thompsond4c14652007-07-26 10:41:15 -0700250 mutex_lock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700251
252 if (add_edac_pci_to_global_list(pci))
253 goto fail0;
254
Dave Jiang91b99042007-07-19 01:49:52 -0700255 if (edac_pci_create_sysfs(pci)) {
256 edac_pci_printk(pci, KERN_WARNING,
257 "failed to create sysfs pci\n");
258 goto fail1;
259 }
260
Borislav Petkov09667602016-02-02 10:59:53 +0100261 if (pci->edac_check) {
Dave Jiang91b99042007-07-19 01:49:52 -0700262 pci->op_state = OP_RUNNING_POLL;
263
Borislav Petkov626a7a42016-02-02 11:06:41 +0100264 INIT_DELAYED_WORK(&pci->work, edac_pci_workq_function);
265 edac_queue_work(&pci->work, msecs_to_jiffies(edac_pci_get_poll_msec()));
266
Dave Jiang91b99042007-07-19 01:49:52 -0700267 } else {
268 pci->op_state = OP_RUNNING_INTERRUPT;
269 }
270
271 edac_pci_printk(pci, KERN_INFO,
Robert Richter7270a602013-10-10 18:22:36 +0200272 "Giving out device to module %s controller %s: DEV %s (%s)\n",
273 pci->mod_name, pci->ctl_name, pci->dev_name,
274 edac_op_state_to_string(pci->op_state));
Dave Jiang91b99042007-07-19 01:49:52 -0700275
Doug Thompsond4c14652007-07-26 10:41:15 -0700276 mutex_unlock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700277 return 0;
278
Doug Thompsond4c14652007-07-26 10:41:15 -0700279 /* error unwind stack */
Douglas Thompson052dfb42007-07-19 01:50:13 -0700280fail1:
Dave Jiang91b99042007-07-19 01:49:52 -0700281 del_edac_pci_from_global_list(pci);
Douglas Thompson052dfb42007-07-19 01:50:13 -0700282fail0:
Doug Thompsond4c14652007-07-26 10:41:15 -0700283 mutex_unlock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700284 return 1;
285}
286EXPORT_SYMBOL_GPL(edac_pci_add_device);
287
288/*
289 * edac_pci_del_device()
290 * Remove sysfs entries for specified edac_pci structure and
291 * then remove edac_pci structure from global list
292 *
293 * @dev:
294 * Pointer to 'struct device' representing edac_pci structure
295 * to remove
296 *
297 * Return:
298 * Pointer to removed edac_pci structure,
299 * or NULL if device not found
300 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700301struct edac_pci_ctl_info *edac_pci_del_device(struct device *dev)
Dave Jiang91b99042007-07-19 01:49:52 -0700302{
303 struct edac_pci_ctl_info *pci;
304
Joe Perches956b9ba12012-04-29 17:08:39 -0300305 edac_dbg(0, "\n");
Dave Jiang91b99042007-07-19 01:49:52 -0700306
Doug Thompsond4c14652007-07-26 10:41:15 -0700307 mutex_lock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700308
Doug Thompsond4c14652007-07-26 10:41:15 -0700309 /* ensure the control struct is on the global list
310 * if not, then leave
311 */
312 pci = find_edac_pci_by_dev(dev);
313 if (pci == NULL) {
314 mutex_unlock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700315 return NULL;
316 }
317
318 pci->op_state = OP_OFFLINE;
319
Dave Jiang91b99042007-07-19 01:49:52 -0700320 del_edac_pci_from_global_list(pci);
321
Doug Thompsond4c14652007-07-26 10:41:15 -0700322 mutex_unlock(&edac_pci_ctls_mutex);
323
Borislav Petkov09667602016-02-02 10:59:53 +0100324 if (pci->edac_check)
Borislav Petkov626a7a42016-02-02 11:06:41 +0100325 edac_stop_work(&pci->work);
Dave Jiang91b99042007-07-19 01:49:52 -0700326
327 edac_printk(KERN_INFO, EDAC_PCI,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700328 "Removed device %d for %s %s: DEV %s\n",
Stephen Rothwell17aa7e02008-05-05 13:54:19 +1000329 pci->pci_idx, pci->mod_name, pci->ctl_name, edac_dev_name(pci));
Dave Jiang91b99042007-07-19 01:49:52 -0700330
331 return pci;
332}
333EXPORT_SYMBOL_GPL(edac_pci_del_device);
334
Doug Thompsond4c14652007-07-26 10:41:15 -0700335/*
336 * edac_pci_generic_check
337 *
338 * a Generic parity check API
339 */
Adrian Bunk1a450272008-04-29 01:03:18 -0700340static void edac_pci_generic_check(struct edac_pci_ctl_info *pci)
Dave Jiang91b99042007-07-19 01:49:52 -0700341{
Joe Perches956b9ba12012-04-29 17:08:39 -0300342 edac_dbg(4, "\n");
Dave Jiang91b99042007-07-19 01:49:52 -0700343 edac_pci_do_parity_check();
344}
345
Doug Thompsond4c14652007-07-26 10:41:15 -0700346/* free running instance index counter */
Douglas Thompsonf0440912007-07-19 01:50:19 -0700347static int edac_pci_idx;
Dave Jiang91b99042007-07-19 01:49:52 -0700348#define EDAC_PCI_GENCTL_NAME "EDAC PCI controller"
349
350struct edac_pci_gen_data {
351 int edac_idx;
352};
353
Doug Thompsond4c14652007-07-26 10:41:15 -0700354/*
355 * edac_pci_create_generic_ctl
356 *
357 * A generic constructor for a PCI parity polling device
358 * Some systems have more than one domain of PCI busses.
359 * For systems with one domain, then this API will
360 * provide for a generic poller.
361 *
362 * This routine calls the edac_pci_alloc_ctl_info() for
363 * the generic device, with default values
364 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700365struct edac_pci_ctl_info *edac_pci_create_generic_ctl(struct device *dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700366 const char *mod_name)
Dave Jiang91b99042007-07-19 01:49:52 -0700367{
368 struct edac_pci_ctl_info *pci;
369 struct edac_pci_gen_data *pdata;
370
371 pci = edac_pci_alloc_ctl_info(sizeof(*pdata), EDAC_PCI_GENCTL_NAME);
372 if (!pci)
373 return NULL;
374
375 pdata = pci->pvt_info;
376 pci->dev = dev;
377 dev_set_drvdata(pci->dev, pci);
378 pci->dev_name = pci_name(to_pci_dev(dev));
379
380 pci->mod_name = mod_name;
381 pci->ctl_name = EDAC_PCI_GENCTL_NAME;
Borislav Petkov876bb332012-09-10 15:52:27 +0200382 if (edac_op_state == EDAC_OPSTATE_POLL)
383 pci->edac_check = edac_pci_generic_check;
Dave Jiang91b99042007-07-19 01:49:52 -0700384
385 pdata->edac_idx = edac_pci_idx++;
386
387 if (edac_pci_add_device(pci, pdata->edac_idx) > 0) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300388 edac_dbg(3, "failed edac_pci_add_device()\n");
Dave Jiang91b99042007-07-19 01:49:52 -0700389 edac_pci_free_ctl_info(pci);
390 return NULL;
391 }
392
393 return pci;
394}
395EXPORT_SYMBOL_GPL(edac_pci_create_generic_ctl);
396
Doug Thompsond4c14652007-07-26 10:41:15 -0700397/*
398 * edac_pci_release_generic_ctl
399 *
400 * The release function of a generic EDAC PCI polling device
401 */
Dave Jiang91b99042007-07-19 01:49:52 -0700402void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci)
403{
Joe Perches956b9ba12012-04-29 17:08:39 -0300404 edac_dbg(0, "pci mod=%s\n", pci->mod_name);
Doug Thompsond4c14652007-07-26 10:41:15 -0700405
Dave Jiang91b99042007-07-19 01:49:52 -0700406 edac_pci_del_device(pci->dev);
407 edac_pci_free_ctl_info(pci);
408}
Dave Jiang91b99042007-07-19 01:49:52 -0700409EXPORT_SYMBOL_GPL(edac_pci_release_generic_ctl);