blob: 22ec9d5d4312940199a7cf425cb73f3d10b11229 [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>
22#include <linux/sysdev.h>
23#include <linux/ctype.h>
24#include <linux/workqueue.h>
25#include <asm/uaccess.h>
26#include <asm/page.h>
27
28#include "edac_core.h"
29#include "edac_module.h"
30
31static DEFINE_MUTEX(edac_pci_ctls_mutex);
Robert P. J. Dayff6ac2a2008-04-29 01:03:17 -070032static LIST_HEAD(edac_pci_list);
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;
45 void *pvt;
46 unsigned int size;
47
Doug Thompsond4c14652007-07-26 10:41:15 -070048 debugf1("%s()\n", __func__);
49
Dave Jiang91b99042007-07-19 01:49:52 -070050 pci = (struct edac_pci_ctl_info *)0;
51 pvt = edac_align_ptr(&pci[1], sz_pvt);
52 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{
Doug Thompsond4c14652007-07-26 10:41:15 -070083 debugf1("%s()\n", __func__);
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
Doug Thompsond4c14652007-07-26 10:41:15 -0700100 debugf1("%s()\n", __func__);
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
Doug Thompsond4c14652007-07-26 10:41:15 -0700125 debugf1("%s()\n", __func__);
126
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",
Stephen Rothwell17aa7e02008-05-05 13:54:19 +1000153 rover->dev->bus_id, 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/*
166 * complete_edac_pci_list_del
Doug Thompsond4c14652007-07-26 10:41:15 -0700167 *
168 * RCU completion callback to indicate item is deleted
Dave Jiang91b99042007-07-19 01:49:52 -0700169 */
170static void complete_edac_pci_list_del(struct rcu_head *head)
171{
172 struct edac_pci_ctl_info *pci;
173
174 pci = container_of(head, struct edac_pci_ctl_info, rcu);
175 INIT_LIST_HEAD(&pci->link);
176 complete(&pci->complete);
177}
178
179/*
180 * del_edac_pci_from_global_list
Doug Thompsond4c14652007-07-26 10:41:15 -0700181 *
182 * remove the PCI control struct from the global list
Dave Jiang91b99042007-07-19 01:49:52 -0700183 */
184static void del_edac_pci_from_global_list(struct edac_pci_ctl_info *pci)
185{
186 list_del_rcu(&pci->link);
187 init_completion(&pci->complete);
188 call_rcu(&pci->rcu, complete_edac_pci_list_del);
189 wait_for_completion(&pci->complete);
190}
191
Adrian Bunk1a450272008-04-29 01:03:18 -0700192#if 0
193/* Older code, but might use in the future */
194
Dave Jiang91b99042007-07-19 01:49:52 -0700195/*
196 * edac_pci_find()
197 * Search for an edac_pci_ctl_info structure whose index is 'idx'
198 *
199 * If found, return a pointer to the structure
200 * Else return NULL.
201 *
202 * Caller must hold pci_ctls_mutex.
203 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700204struct edac_pci_ctl_info *edac_pci_find(int idx)
Dave Jiang91b99042007-07-19 01:49:52 -0700205{
206 struct list_head *item;
207 struct edac_pci_ctl_info *pci;
208
209 /* Iterage over list, looking for exact match of ID */
210 list_for_each(item, &edac_pci_list) {
211 pci = list_entry(item, struct edac_pci_ctl_info, link);
212
213 if (pci->pci_idx >= idx) {
214 if (pci->pci_idx == idx)
215 return pci;
216
Douglas Thompson079708b2007-07-19 01:49:58 -0700217 /* not on list, so terminate early */
Dave Jiang91b99042007-07-19 01:49:52 -0700218 break;
219 }
220 }
221
222 return NULL;
223}
224EXPORT_SYMBOL_GPL(edac_pci_find);
Adrian Bunk1a450272008-04-29 01:03:18 -0700225#endif
Dave Jiang91b99042007-07-19 01:49:52 -0700226
227/*
228 * edac_pci_workq_function()
Doug Thompsond4c14652007-07-26 10:41:15 -0700229 *
230 * periodic function that performs the operation
231 * scheduled by a workq request, for a given PCI control struct
Dave Jiang91b99042007-07-19 01:49:52 -0700232 */
Dave Jiang91b99042007-07-19 01:49:52 -0700233static void edac_pci_workq_function(struct work_struct *work_req)
234{
235 struct delayed_work *d_work = (struct delayed_work *)work_req;
236 struct edac_pci_ctl_info *pci = to_edac_pci_ctl_work(d_work);
Doug Thompsond4c14652007-07-26 10:41:15 -0700237 int msec;
238 unsigned long delay;
Dave Jiang91b99042007-07-19 01:49:52 -0700239
Doug Thompsond4c14652007-07-26 10:41:15 -0700240 debugf3("%s() checking\n", __func__);
Dave Jiang91b99042007-07-19 01:49:52 -0700241
Doug Thompsond4c14652007-07-26 10:41:15 -0700242 mutex_lock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700243
Doug Thompsond4c14652007-07-26 10:41:15 -0700244 if (pci->op_state == OP_RUNNING_POLL) {
245 /* we might be in POLL mode, but there may NOT be a poll func
246 */
247 if ((pci->edac_check != NULL) && edac_pci_get_check_errors())
248 pci->edac_check(pci);
Dave Jiang91b99042007-07-19 01:49:52 -0700249
Doug Thompsond4c14652007-07-26 10:41:15 -0700250 /* if we are on a one second period, then use round */
251 msec = edac_pci_get_poll_msec();
252 if (msec == 1000)
Anton Blanchardc2ae24c2008-02-07 00:14:51 -0800253 delay = round_jiffies_relative(msecs_to_jiffies(msec));
Doug Thompsond4c14652007-07-26 10:41:15 -0700254 else
255 delay = msecs_to_jiffies(msec);
256
257 /* Reschedule only if we are in POLL mode */
258 queue_delayed_work(edac_workqueue, &pci->work, delay);
259 }
260
261 mutex_unlock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700262}
263
264/*
265 * edac_pci_workq_setup()
266 * initialize a workq item for this edac_pci instance
267 * passing in the new delay period in msec
Doug Thompsond4c14652007-07-26 10:41:15 -0700268 *
269 * locking model:
270 * called when 'edac_pci_ctls_mutex' is locked
Dave Jiang91b99042007-07-19 01:49:52 -0700271 */
272static void edac_pci_workq_setup(struct edac_pci_ctl_info *pci,
Douglas Thompson079708b2007-07-19 01:49:58 -0700273 unsigned int msec)
Dave Jiang91b99042007-07-19 01:49:52 -0700274{
275 debugf0("%s()\n", __func__);
276
Dave Jiang91b99042007-07-19 01:49:52 -0700277 INIT_DELAYED_WORK(&pci->work, edac_pci_workq_function);
Dave Jiang4de78c62007-07-19 01:49:54 -0700278 queue_delayed_work(edac_workqueue, &pci->work,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700279 msecs_to_jiffies(edac_pci_get_poll_msec()));
Dave Jiang91b99042007-07-19 01:49:52 -0700280}
281
282/*
283 * edac_pci_workq_teardown()
284 * stop the workq processing on this edac_pci instance
285 */
286static void edac_pci_workq_teardown(struct edac_pci_ctl_info *pci)
287{
288 int status;
289
Doug Thompsond4c14652007-07-26 10:41:15 -0700290 debugf0("%s()\n", __func__);
291
Dave Jiang91b99042007-07-19 01:49:52 -0700292 status = cancel_delayed_work(&pci->work);
293 if (status == 0)
294 flush_workqueue(edac_workqueue);
295}
296
297/*
298 * edac_pci_reset_delay_period
Doug Thompsond4c14652007-07-26 10:41:15 -0700299 *
300 * called with a new period value for the workq period
301 * a) stop current workq timer
302 * b) restart workq timer with new value
Dave Jiang91b99042007-07-19 01:49:52 -0700303 */
304void edac_pci_reset_delay_period(struct edac_pci_ctl_info *pci,
Douglas Thompson079708b2007-07-19 01:49:58 -0700305 unsigned long value)
Dave Jiang91b99042007-07-19 01:49:52 -0700306{
Doug Thompsond4c14652007-07-26 10:41:15 -0700307 debugf0("%s()\n", __func__);
Dave Jiang91b99042007-07-19 01:49:52 -0700308
309 edac_pci_workq_teardown(pci);
310
Doug Thompsond4c14652007-07-26 10:41:15 -0700311 /* need to lock for the setup */
312 mutex_lock(&edac_pci_ctls_mutex);
313
Dave Jiang91b99042007-07-19 01:49:52 -0700314 edac_pci_workq_setup(pci, value);
315
Doug Thompsond4c14652007-07-26 10:41:15 -0700316 mutex_unlock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700317}
318EXPORT_SYMBOL_GPL(edac_pci_reset_delay_period);
319
320/*
321 * edac_pci_add_device: Insert the 'edac_dev' structure into the
322 * edac_pci global list and create sysfs entries associated with
323 * edac_pci structure.
324 * @pci: pointer to the edac_device structure to be added to the list
325 * @edac_idx: A unique numeric identifier to be assigned to the
326 * 'edac_pci' structure.
327 *
328 * Return:
329 * 0 Success
330 * !0 Failure
331 */
332int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx)
333{
334 debugf0("%s()\n", __func__);
335
336 pci->pci_idx = edac_idx;
Doug Thompsond4c14652007-07-26 10:41:15 -0700337 pci->start_time = jiffies;
Dave Jiang91b99042007-07-19 01:49:52 -0700338
Doug Thompsond4c14652007-07-26 10:41:15 -0700339 mutex_lock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700340
341 if (add_edac_pci_to_global_list(pci))
342 goto fail0;
343
Dave Jiang91b99042007-07-19 01:49:52 -0700344 if (edac_pci_create_sysfs(pci)) {
345 edac_pci_printk(pci, KERN_WARNING,
346 "failed to create sysfs pci\n");
347 goto fail1;
348 }
349
350 if (pci->edac_check != NULL) {
351 pci->op_state = OP_RUNNING_POLL;
352
353 edac_pci_workq_setup(pci, 1000);
354 } else {
355 pci->op_state = OP_RUNNING_INTERRUPT;
356 }
357
358 edac_pci_printk(pci, KERN_INFO,
Douglas Thompson079708b2007-07-19 01:49:58 -0700359 "Giving out device to module '%s' controller '%s':"
360 " DEV '%s' (%s)\n",
361 pci->mod_name,
362 pci->ctl_name,
Stephen Rothwell17aa7e02008-05-05 13:54:19 +1000363 edac_dev_name(pci), edac_op_state_to_string(pci->op_state));
Dave Jiang91b99042007-07-19 01:49:52 -0700364
Doug Thompsond4c14652007-07-26 10:41:15 -0700365 mutex_unlock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700366 return 0;
367
Doug Thompsond4c14652007-07-26 10:41:15 -0700368 /* error unwind stack */
Douglas Thompson052dfb42007-07-19 01:50:13 -0700369fail1:
Dave Jiang91b99042007-07-19 01:49:52 -0700370 del_edac_pci_from_global_list(pci);
Douglas Thompson052dfb42007-07-19 01:50:13 -0700371fail0:
Doug Thompsond4c14652007-07-26 10:41:15 -0700372 mutex_unlock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700373 return 1;
374}
375EXPORT_SYMBOL_GPL(edac_pci_add_device);
376
377/*
378 * edac_pci_del_device()
379 * Remove sysfs entries for specified edac_pci structure and
380 * then remove edac_pci structure from global list
381 *
382 * @dev:
383 * Pointer to 'struct device' representing edac_pci structure
384 * to remove
385 *
386 * Return:
387 * Pointer to removed edac_pci structure,
388 * or NULL if device not found
389 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700390struct edac_pci_ctl_info *edac_pci_del_device(struct device *dev)
Dave Jiang91b99042007-07-19 01:49:52 -0700391{
392 struct edac_pci_ctl_info *pci;
393
394 debugf0("%s()\n", __func__);
395
Doug Thompsond4c14652007-07-26 10:41:15 -0700396 mutex_lock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700397
Doug Thompsond4c14652007-07-26 10:41:15 -0700398 /* ensure the control struct is on the global list
399 * if not, then leave
400 */
401 pci = find_edac_pci_by_dev(dev);
402 if (pci == NULL) {
403 mutex_unlock(&edac_pci_ctls_mutex);
Dave Jiang91b99042007-07-19 01:49:52 -0700404 return NULL;
405 }
406
407 pci->op_state = OP_OFFLINE;
408
Dave Jiang91b99042007-07-19 01:49:52 -0700409 del_edac_pci_from_global_list(pci);
410
Doug Thompsond4c14652007-07-26 10:41:15 -0700411 mutex_unlock(&edac_pci_ctls_mutex);
412
413 /* stop the workq timer */
414 edac_pci_workq_teardown(pci);
Dave Jiang91b99042007-07-19 01:49:52 -0700415
416 edac_printk(KERN_INFO, EDAC_PCI,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700417 "Removed device %d for %s %s: DEV %s\n",
Stephen Rothwell17aa7e02008-05-05 13:54:19 +1000418 pci->pci_idx, pci->mod_name, pci->ctl_name, edac_dev_name(pci));
Dave Jiang91b99042007-07-19 01:49:52 -0700419
420 return pci;
421}
422EXPORT_SYMBOL_GPL(edac_pci_del_device);
423
Doug Thompsond4c14652007-07-26 10:41:15 -0700424/*
425 * edac_pci_generic_check
426 *
427 * a Generic parity check API
428 */
Adrian Bunk1a450272008-04-29 01:03:18 -0700429static void edac_pci_generic_check(struct edac_pci_ctl_info *pci)
Dave Jiang91b99042007-07-19 01:49:52 -0700430{
Doug Thompsond4c14652007-07-26 10:41:15 -0700431 debugf4("%s()\n", __func__);
Dave Jiang91b99042007-07-19 01:49:52 -0700432 edac_pci_do_parity_check();
433}
434
Doug Thompsond4c14652007-07-26 10:41:15 -0700435/* free running instance index counter */
Douglas Thompsonf0440912007-07-19 01:50:19 -0700436static int edac_pci_idx;
Dave Jiang91b99042007-07-19 01:49:52 -0700437#define EDAC_PCI_GENCTL_NAME "EDAC PCI controller"
438
439struct edac_pci_gen_data {
440 int edac_idx;
441};
442
Doug Thompsond4c14652007-07-26 10:41:15 -0700443/*
444 * edac_pci_create_generic_ctl
445 *
446 * A generic constructor for a PCI parity polling device
447 * Some systems have more than one domain of PCI busses.
448 * For systems with one domain, then this API will
449 * provide for a generic poller.
450 *
451 * This routine calls the edac_pci_alloc_ctl_info() for
452 * the generic device, with default values
453 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700454struct edac_pci_ctl_info *edac_pci_create_generic_ctl(struct device *dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700455 const char *mod_name)
Dave Jiang91b99042007-07-19 01:49:52 -0700456{
457 struct edac_pci_ctl_info *pci;
458 struct edac_pci_gen_data *pdata;
459
460 pci = edac_pci_alloc_ctl_info(sizeof(*pdata), EDAC_PCI_GENCTL_NAME);
461 if (!pci)
462 return NULL;
463
464 pdata = pci->pvt_info;
465 pci->dev = dev;
466 dev_set_drvdata(pci->dev, pci);
467 pci->dev_name = pci_name(to_pci_dev(dev));
468
469 pci->mod_name = mod_name;
470 pci->ctl_name = EDAC_PCI_GENCTL_NAME;
471 pci->edac_check = edac_pci_generic_check;
472
473 pdata->edac_idx = edac_pci_idx++;
474
475 if (edac_pci_add_device(pci, pdata->edac_idx) > 0) {
476 debugf3("%s(): failed edac_pci_add_device()\n", __func__);
477 edac_pci_free_ctl_info(pci);
478 return NULL;
479 }
480
481 return pci;
482}
483EXPORT_SYMBOL_GPL(edac_pci_create_generic_ctl);
484
Doug Thompsond4c14652007-07-26 10:41:15 -0700485/*
486 * edac_pci_release_generic_ctl
487 *
488 * The release function of a generic EDAC PCI polling device
489 */
Dave Jiang91b99042007-07-19 01:49:52 -0700490void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci)
491{
Doug Thompsond4c14652007-07-26 10:41:15 -0700492 debugf0("%s() pci mod=%s\n", __func__, pci->mod_name);
493
Dave Jiang91b99042007-07-19 01:49:52 -0700494 edac_pci_del_device(pci->dev);
495 edac_pci_free_ctl_info(pci);
496}
Dave Jiang91b99042007-07-19 01:49:52 -0700497EXPORT_SYMBOL_GPL(edac_pci_release_generic_ctl);