4 * Author: Dave Jiang <djiang@mvista.com>
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
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/ctype.h>
23 #include <linux/workqueue.h>
24 #include <asm/uaccess.h>
27 #include "edac_core.h"
28 #include "edac_module.h"
30 static DEFINE_MUTEX(edac_pci_ctls_mutex);
31 static LIST_HEAD(edac_pci_list);
32 static atomic_t pci_indexes = ATOMIC_INIT(0);
35 * edac_pci_alloc_ctl_info
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.
41 struct edac_pci_ctl_info *edac_pci_alloc_ctl_info(unsigned int sz_pvt,
42 const char *edac_pci_name)
44 struct edac_pci_ctl_info *pci;
50 pci = edac_align_ptr(&p, sizeof(*pci), 1);
51 pvt = edac_align_ptr(&p, 1, sz_pvt);
52 size = ((unsigned long)pvt) + sz_pvt;
54 /* Alloc the needed control struct memory */
55 pci = kzalloc(size, GFP_KERNEL);
59 /* Now much private space */
60 pvt = sz_pvt ? ((char *)pci) + ((unsigned long)pvt) : NULL;
63 pci->op_state = OP_ALLOC;
65 snprintf(pci->name, strlen(edac_pci_name) + 1, "%s", edac_pci_name);
69 EXPORT_SYMBOL_GPL(edac_pci_alloc_ctl_info);
72 * edac_pci_free_ctl_info()
74 * Last action on the pci control structure.
76 * call the remove sysfs information, which will unregister
77 * this control struct's kobj. When that kobj's ref count
78 * goes to zero, its release function will be call and then
81 void edac_pci_free_ctl_info(struct edac_pci_ctl_info *pci)
85 edac_pci_remove_sysfs(pci);
87 EXPORT_SYMBOL_GPL(edac_pci_free_ctl_info);
90 * find_edac_pci_by_dev()
91 * scans the edac_pci list for a specific 'struct device *'
93 * return NULL if not found, or return control struct pointer
95 static struct edac_pci_ctl_info *find_edac_pci_by_dev(struct device *dev)
97 struct edac_pci_ctl_info *pci;
98 struct list_head *item;
102 list_for_each(item, &edac_pci_list) {
103 pci = list_entry(item, struct edac_pci_ctl_info, link);
113 * add_edac_pci_to_global_list
114 * Before calling this function, caller must assign a unique value to
120 static int add_edac_pci_to_global_list(struct edac_pci_ctl_info *pci)
122 struct list_head *item, *insert_before;
123 struct edac_pci_ctl_info *rover;
127 insert_before = &edac_pci_list;
129 /* Determine if already on the list */
130 rover = find_edac_pci_by_dev(pci->dev);
131 if (unlikely(rover != NULL))
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);
138 if (rover->pci_idx >= pci->pci_idx) {
139 if (unlikely(rover->pci_idx == pci->pci_idx))
142 insert_before = item;
147 list_add_tail_rcu(&pci->link, insert_before);
151 edac_printk(KERN_WARNING, EDAC_PCI,
152 "%s (%s) %s %s already assigned %d\n",
153 dev_name(rover->dev), edac_dev_name(rover),
154 rover->mod_name, rover->ctl_name, rover->pci_idx);
158 edac_printk(KERN_WARNING, EDAC_PCI,
159 "but in low-level driver: attempt to assign\n"
160 "\tduplicate pci_idx %d in %s()\n", rover->pci_idx,
166 * del_edac_pci_from_global_list
168 * remove the PCI control struct from the global list
170 static void del_edac_pci_from_global_list(struct edac_pci_ctl_info *pci)
172 list_del_rcu(&pci->link);
174 /* these are for safe removal of devices from global list while
175 * NMI handlers may be traversing list
178 INIT_LIST_HEAD(&pci->link);
182 * edac_pci_workq_function()
184 * periodic function that performs the operation
185 * scheduled by a workq request, for a given PCI control struct
187 static void edac_pci_workq_function(struct work_struct *work_req)
189 struct delayed_work *d_work = to_delayed_work(work_req);
190 struct edac_pci_ctl_info *pci = to_edac_pci_ctl_work(d_work);
194 edac_dbg(3, "checking\n");
196 mutex_lock(&edac_pci_ctls_mutex);
198 if (pci->op_state == OP_RUNNING_POLL) {
199 /* we might be in POLL mode, but there may NOT be a poll func
201 if ((pci->edac_check != NULL) && edac_pci_get_check_errors())
202 pci->edac_check(pci);
204 /* if we are on a one second period, then use round */
205 msec = edac_pci_get_poll_msec();
207 delay = round_jiffies_relative(msecs_to_jiffies(msec));
209 delay = msecs_to_jiffies(msec);
211 /* Reschedule only if we are in POLL mode */
212 edac_queue_work(&pci->work, delay);
215 mutex_unlock(&edac_pci_ctls_mutex);
219 * edac_pci_workq_setup()
220 * initialize a workq item for this edac_pci instance
221 * passing in the new delay period in msec
224 * called when 'edac_pci_ctls_mutex' is locked
226 static void edac_pci_workq_setup(struct edac_pci_ctl_info *pci,
231 INIT_DELAYED_WORK(&pci->work, edac_pci_workq_function);
233 edac_queue_work(&pci->work, msecs_to_jiffies(edac_pci_get_poll_msec()));
237 * edac_pci_workq_teardown()
238 * stop the workq processing on this edac_pci instance
240 static void edac_pci_workq_teardown(struct edac_pci_ctl_info *pci)
244 pci->op_state = OP_OFFLINE;
246 edac_stop_work(&pci->work);
250 * edac_pci_alloc_index: Allocate a unique PCI index number
253 * allocated index number
256 int edac_pci_alloc_index(void)
258 return atomic_inc_return(&pci_indexes) - 1;
260 EXPORT_SYMBOL_GPL(edac_pci_alloc_index);
263 * edac_pci_add_device: Insert the 'edac_dev' structure into the
264 * edac_pci global list and create sysfs entries associated with
265 * edac_pci structure.
266 * @pci: pointer to the edac_device structure to be added to the list
267 * @edac_idx: A unique numeric identifier to be assigned to the
268 * 'edac_pci' structure.
274 int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx)
278 pci->pci_idx = edac_idx;
279 pci->start_time = jiffies;
281 mutex_lock(&edac_pci_ctls_mutex);
283 if (add_edac_pci_to_global_list(pci))
286 if (edac_pci_create_sysfs(pci)) {
287 edac_pci_printk(pci, KERN_WARNING,
288 "failed to create sysfs pci\n");
292 if (pci->edac_check != NULL) {
293 pci->op_state = OP_RUNNING_POLL;
295 edac_pci_workq_setup(pci, 1000);
297 pci->op_state = OP_RUNNING_INTERRUPT;
300 edac_pci_printk(pci, KERN_INFO,
301 "Giving out device to module %s controller %s: DEV %s (%s)\n",
302 pci->mod_name, pci->ctl_name, pci->dev_name,
303 edac_op_state_to_string(pci->op_state));
305 mutex_unlock(&edac_pci_ctls_mutex);
308 /* error unwind stack */
310 del_edac_pci_from_global_list(pci);
312 mutex_unlock(&edac_pci_ctls_mutex);
315 EXPORT_SYMBOL_GPL(edac_pci_add_device);
318 * edac_pci_del_device()
319 * Remove sysfs entries for specified edac_pci structure and
320 * then remove edac_pci structure from global list
323 * Pointer to 'struct device' representing edac_pci structure
327 * Pointer to removed edac_pci structure,
328 * or NULL if device not found
330 struct edac_pci_ctl_info *edac_pci_del_device(struct device *dev)
332 struct edac_pci_ctl_info *pci;
336 mutex_lock(&edac_pci_ctls_mutex);
338 /* ensure the control struct is on the global list
341 pci = find_edac_pci_by_dev(dev);
343 mutex_unlock(&edac_pci_ctls_mutex);
347 pci->op_state = OP_OFFLINE;
349 del_edac_pci_from_global_list(pci);
351 mutex_unlock(&edac_pci_ctls_mutex);
353 /* stop the workq timer */
354 edac_pci_workq_teardown(pci);
356 edac_printk(KERN_INFO, EDAC_PCI,
357 "Removed device %d for %s %s: DEV %s\n",
358 pci->pci_idx, pci->mod_name, pci->ctl_name, edac_dev_name(pci));
362 EXPORT_SYMBOL_GPL(edac_pci_del_device);
365 * edac_pci_generic_check
367 * a Generic parity check API
369 static void edac_pci_generic_check(struct edac_pci_ctl_info *pci)
372 edac_pci_do_parity_check();
375 /* free running instance index counter */
376 static int edac_pci_idx;
377 #define EDAC_PCI_GENCTL_NAME "EDAC PCI controller"
379 struct edac_pci_gen_data {
384 * edac_pci_create_generic_ctl
386 * A generic constructor for a PCI parity polling device
387 * Some systems have more than one domain of PCI busses.
388 * For systems with one domain, then this API will
389 * provide for a generic poller.
391 * This routine calls the edac_pci_alloc_ctl_info() for
392 * the generic device, with default values
394 struct edac_pci_ctl_info *edac_pci_create_generic_ctl(struct device *dev,
395 const char *mod_name)
397 struct edac_pci_ctl_info *pci;
398 struct edac_pci_gen_data *pdata;
400 pci = edac_pci_alloc_ctl_info(sizeof(*pdata), EDAC_PCI_GENCTL_NAME);
404 pdata = pci->pvt_info;
406 dev_set_drvdata(pci->dev, pci);
407 pci->dev_name = pci_name(to_pci_dev(dev));
409 pci->mod_name = mod_name;
410 pci->ctl_name = EDAC_PCI_GENCTL_NAME;
411 if (edac_op_state == EDAC_OPSTATE_POLL)
412 pci->edac_check = edac_pci_generic_check;
414 pdata->edac_idx = edac_pci_idx++;
416 if (edac_pci_add_device(pci, pdata->edac_idx) > 0) {
417 edac_dbg(3, "failed edac_pci_add_device()\n");
418 edac_pci_free_ctl_info(pci);
424 EXPORT_SYMBOL_GPL(edac_pci_create_generic_ctl);
427 * edac_pci_release_generic_ctl
429 * The release function of a generic EDAC PCI polling device
431 void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci)
433 edac_dbg(0, "pci mod=%s\n", pci->mod_name);
435 edac_pci_del_device(pci->dev);
436 edac_pci_free_ctl_info(pci);
438 EXPORT_SYMBOL_GPL(edac_pci_release_generic_ctl);