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 /* Older code, but might use in the future */
186 * Search for an edac_pci_ctl_info structure whose index is 'idx'
188 * If found, return a pointer to the structure
191 * Caller must hold pci_ctls_mutex.
193 struct edac_pci_ctl_info
*edac_pci_find(int idx
)
195 struct list_head
*item
;
196 struct edac_pci_ctl_info
*pci
;
198 /* Iterage over list, looking for exact match of ID */
199 list_for_each(item
, &edac_pci_list
) {
200 pci
= list_entry(item
, struct edac_pci_ctl_info
, link
);
202 if (pci
->pci_idx
>= idx
) {
203 if (pci
->pci_idx
== idx
)
206 /* not on list, so terminate early */
213 EXPORT_SYMBOL_GPL(edac_pci_find
);
217 * edac_pci_workq_function()
219 * periodic function that performs the operation
220 * scheduled by a workq request, for a given PCI control struct
222 static void edac_pci_workq_function(struct work_struct
*work_req
)
224 struct delayed_work
*d_work
= to_delayed_work(work_req
);
225 struct edac_pci_ctl_info
*pci
= to_edac_pci_ctl_work(d_work
);
229 edac_dbg(3, "checking\n");
231 mutex_lock(&edac_pci_ctls_mutex
);
233 if (pci
->op_state
== OP_RUNNING_POLL
) {
234 /* we might be in POLL mode, but there may NOT be a poll func
236 if ((pci
->edac_check
!= NULL
) && edac_pci_get_check_errors())
237 pci
->edac_check(pci
);
239 /* if we are on a one second period, then use round */
240 msec
= edac_pci_get_poll_msec();
242 delay
= round_jiffies_relative(msecs_to_jiffies(msec
));
244 delay
= msecs_to_jiffies(msec
);
246 /* Reschedule only if we are in POLL mode */
247 queue_delayed_work(edac_workqueue
, &pci
->work
, delay
);
250 mutex_unlock(&edac_pci_ctls_mutex
);
254 * edac_pci_workq_setup()
255 * initialize a workq item for this edac_pci instance
256 * passing in the new delay period in msec
259 * called when 'edac_pci_ctls_mutex' is locked
261 static void edac_pci_workq_setup(struct edac_pci_ctl_info
*pci
,
266 INIT_DELAYED_WORK(&pci
->work
, edac_pci_workq_function
);
267 queue_delayed_work(edac_workqueue
, &pci
->work
,
268 msecs_to_jiffies(edac_pci_get_poll_msec()));
272 * edac_pci_workq_teardown()
273 * stop the workq processing on this edac_pci instance
275 static void edac_pci_workq_teardown(struct edac_pci_ctl_info
*pci
)
279 pci
->op_state
= OP_OFFLINE
;
281 cancel_delayed_work_sync(&pci
->work
);
282 flush_workqueue(edac_workqueue
);
286 * edac_pci_reset_delay_period
288 * called with a new period value for the workq period
289 * a) stop current workq timer
290 * b) restart workq timer with new value
292 void edac_pci_reset_delay_period(struct edac_pci_ctl_info
*pci
,
297 edac_pci_workq_teardown(pci
);
299 /* need to lock for the setup */
300 mutex_lock(&edac_pci_ctls_mutex
);
302 edac_pci_workq_setup(pci
, value
);
304 mutex_unlock(&edac_pci_ctls_mutex
);
306 EXPORT_SYMBOL_GPL(edac_pci_reset_delay_period
);
309 * edac_pci_alloc_index: Allocate a unique PCI index number
312 * allocated index number
315 int edac_pci_alloc_index(void)
317 return atomic_inc_return(&pci_indexes
) - 1;
319 EXPORT_SYMBOL_GPL(edac_pci_alloc_index
);
322 * edac_pci_add_device: Insert the 'edac_dev' structure into the
323 * edac_pci global list and create sysfs entries associated with
324 * edac_pci structure.
325 * @pci: pointer to the edac_device structure to be added to the list
326 * @edac_idx: A unique numeric identifier to be assigned to the
327 * 'edac_pci' structure.
333 int edac_pci_add_device(struct edac_pci_ctl_info
*pci
, int edac_idx
)
337 pci
->pci_idx
= edac_idx
;
338 pci
->start_time
= jiffies
;
340 mutex_lock(&edac_pci_ctls_mutex
);
342 if (add_edac_pci_to_global_list(pci
))
345 if (edac_pci_create_sysfs(pci
)) {
346 edac_pci_printk(pci
, KERN_WARNING
,
347 "failed to create sysfs pci\n");
351 if (pci
->edac_check
!= NULL
) {
352 pci
->op_state
= OP_RUNNING_POLL
;
354 edac_pci_workq_setup(pci
, 1000);
356 pci
->op_state
= OP_RUNNING_INTERRUPT
;
359 edac_pci_printk(pci
, KERN_INFO
,
360 "Giving out device to module %s controller %s: DEV %s (%s)\n",
361 pci
->mod_name
, pci
->ctl_name
, pci
->dev_name
,
362 edac_op_state_to_string(pci
->op_state
));
364 mutex_unlock(&edac_pci_ctls_mutex
);
367 /* error unwind stack */
369 del_edac_pci_from_global_list(pci
);
371 mutex_unlock(&edac_pci_ctls_mutex
);
374 EXPORT_SYMBOL_GPL(edac_pci_add_device
);
377 * edac_pci_del_device()
378 * Remove sysfs entries for specified edac_pci structure and
379 * then remove edac_pci structure from global list
382 * Pointer to 'struct device' representing edac_pci structure
386 * Pointer to removed edac_pci structure,
387 * or NULL if device not found
389 struct edac_pci_ctl_info
*edac_pci_del_device(struct device
*dev
)
391 struct edac_pci_ctl_info
*pci
;
395 mutex_lock(&edac_pci_ctls_mutex
);
397 /* ensure the control struct is on the global list
400 pci
= find_edac_pci_by_dev(dev
);
402 mutex_unlock(&edac_pci_ctls_mutex
);
406 pci
->op_state
= OP_OFFLINE
;
408 del_edac_pci_from_global_list(pci
);
410 mutex_unlock(&edac_pci_ctls_mutex
);
412 /* stop the workq timer */
413 edac_pci_workq_teardown(pci
);
415 edac_printk(KERN_INFO
, EDAC_PCI
,
416 "Removed device %d for %s %s: DEV %s\n",
417 pci
->pci_idx
, pci
->mod_name
, pci
->ctl_name
, edac_dev_name(pci
));
421 EXPORT_SYMBOL_GPL(edac_pci_del_device
);
424 * edac_pci_generic_check
426 * a Generic parity check API
428 static void edac_pci_generic_check(struct edac_pci_ctl_info
*pci
)
431 edac_pci_do_parity_check();
434 /* free running instance index counter */
435 static int edac_pci_idx
;
436 #define EDAC_PCI_GENCTL_NAME "EDAC PCI controller"
438 struct edac_pci_gen_data
{
443 * edac_pci_create_generic_ctl
445 * A generic constructor for a PCI parity polling device
446 * Some systems have more than one domain of PCI busses.
447 * For systems with one domain, then this API will
448 * provide for a generic poller.
450 * This routine calls the edac_pci_alloc_ctl_info() for
451 * the generic device, with default values
453 struct edac_pci_ctl_info
*edac_pci_create_generic_ctl(struct device
*dev
,
454 const char *mod_name
)
456 struct edac_pci_ctl_info
*pci
;
457 struct edac_pci_gen_data
*pdata
;
459 pci
= edac_pci_alloc_ctl_info(sizeof(*pdata
), EDAC_PCI_GENCTL_NAME
);
463 pdata
= pci
->pvt_info
;
465 dev_set_drvdata(pci
->dev
, pci
);
466 pci
->dev_name
= pci_name(to_pci_dev(dev
));
468 pci
->mod_name
= mod_name
;
469 pci
->ctl_name
= EDAC_PCI_GENCTL_NAME
;
470 if (edac_op_state
== EDAC_OPSTATE_POLL
)
471 pci
->edac_check
= edac_pci_generic_check
;
473 pdata
->edac_idx
= edac_pci_idx
++;
475 if (edac_pci_add_device(pci
, pdata
->edac_idx
) > 0) {
476 edac_dbg(3, "failed edac_pci_add_device()\n");
477 edac_pci_free_ctl_info(pci
);
483 EXPORT_SYMBOL_GPL(edac_pci_create_generic_ctl
);
486 * edac_pci_release_generic_ctl
488 * The release function of a generic EDAC PCI polling device
490 void edac_pci_release_generic_ctl(struct edac_pci_ctl_info
*pci
)
492 edac_dbg(0, "pci mod=%s\n", pci
->mod_name
);
494 edac_pci_del_device(pci
->dev
);
495 edac_pci_free_ctl_info(pci
);
497 EXPORT_SYMBOL_GPL(edac_pci_release_generic_ctl
);