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/sysdev.h>
23 #include <linux/ctype.h>
24 #include <linux/workqueue.h>
25 #include <asm/uaccess.h>
28 #include "edac_core.h"
29 #include "edac_module.h"
31 static DEFINE_MUTEX(edac_pci_ctls_mutex
);
32 static LIST_HEAD(edac_pci_list
);
33 static atomic_t pci_indexes
= ATOMIC_INIT(0);
36 * edac_pci_alloc_ctl_info
38 * The alloc() function for the 'edac_pci' control info
39 * structure. The chip driver will allocate one of these for each
40 * edac_pci it is going to control/register with the EDAC CORE.
42 struct edac_pci_ctl_info
*edac_pci_alloc_ctl_info(unsigned int sz_pvt
,
43 const char *edac_pci_name
)
45 struct edac_pci_ctl_info
*pci
;
49 debugf1("%s()\n", __func__
);
51 pci
= (struct edac_pci_ctl_info
*)0;
52 pvt
= edac_align_ptr(&pci
[1], sz_pvt
);
53 size
= ((unsigned long)pvt
) + sz_pvt
;
55 /* Alloc the needed control struct memory */
56 pci
= kzalloc(size
, GFP_KERNEL
);
60 /* Now much private space */
61 pvt
= sz_pvt
? ((char *)pci
) + ((unsigned long)pvt
) : NULL
;
64 pci
->op_state
= OP_ALLOC
;
66 snprintf(pci
->name
, strlen(edac_pci_name
) + 1, "%s", edac_pci_name
);
70 EXPORT_SYMBOL_GPL(edac_pci_alloc_ctl_info
);
73 * edac_pci_free_ctl_info()
75 * Last action on the pci control structure.
77 * call the remove sysfs information, which will unregister
78 * this control struct's kobj. When that kobj's ref count
79 * goes to zero, its release function will be call and then
82 void edac_pci_free_ctl_info(struct edac_pci_ctl_info
*pci
)
84 debugf1("%s()\n", __func__
);
86 edac_pci_remove_sysfs(pci
);
88 EXPORT_SYMBOL_GPL(edac_pci_free_ctl_info
);
91 * find_edac_pci_by_dev()
92 * scans the edac_pci list for a specific 'struct device *'
94 * return NULL if not found, or return control struct pointer
96 static struct edac_pci_ctl_info
*find_edac_pci_by_dev(struct device
*dev
)
98 struct edac_pci_ctl_info
*pci
;
99 struct list_head
*item
;
101 debugf1("%s()\n", __func__
);
103 list_for_each(item
, &edac_pci_list
) {
104 pci
= list_entry(item
, struct edac_pci_ctl_info
, link
);
114 * add_edac_pci_to_global_list
115 * Before calling this function, caller must assign a unique value to
121 static int add_edac_pci_to_global_list(struct edac_pci_ctl_info
*pci
)
123 struct list_head
*item
, *insert_before
;
124 struct edac_pci_ctl_info
*rover
;
126 debugf1("%s()\n", __func__
);
128 insert_before
= &edac_pci_list
;
130 /* Determine if already on the list */
131 rover
= find_edac_pci_by_dev(pci
->dev
);
132 if (unlikely(rover
!= NULL
))
135 /* Insert in ascending order by 'pci_idx', so find position */
136 list_for_each(item
, &edac_pci_list
) {
137 rover
= list_entry(item
, struct edac_pci_ctl_info
, link
);
139 if (rover
->pci_idx
>= pci
->pci_idx
) {
140 if (unlikely(rover
->pci_idx
== pci
->pci_idx
))
143 insert_before
= item
;
148 list_add_tail_rcu(&pci
->link
, insert_before
);
152 edac_printk(KERN_WARNING
, EDAC_PCI
,
153 "%s (%s) %s %s already assigned %d\n",
154 dev_name(rover
->dev
), edac_dev_name(rover
),
155 rover
->mod_name
, rover
->ctl_name
, rover
->pci_idx
);
159 edac_printk(KERN_WARNING
, EDAC_PCI
,
160 "but in low-level driver: attempt to assign\n"
161 "\tduplicate pci_idx %d in %s()\n", rover
->pci_idx
,
167 * complete_edac_pci_list_del
169 * RCU completion callback to indicate item is deleted
171 static void complete_edac_pci_list_del(struct rcu_head
*head
)
173 struct edac_pci_ctl_info
*pci
;
175 pci
= container_of(head
, struct edac_pci_ctl_info
, rcu
);
176 INIT_LIST_HEAD(&pci
->link
);
180 * del_edac_pci_from_global_list
182 * remove the PCI control struct from the global list
184 static void del_edac_pci_from_global_list(struct edac_pci_ctl_info
*pci
)
186 list_del_rcu(&pci
->link
);
187 call_rcu(&pci
->rcu
, complete_edac_pci_list_del
);
192 /* Older code, but might use in the future */
196 * Search for an edac_pci_ctl_info structure whose index is 'idx'
198 * If found, return a pointer to the structure
201 * Caller must hold pci_ctls_mutex.
203 struct edac_pci_ctl_info
*edac_pci_find(int idx
)
205 struct list_head
*item
;
206 struct edac_pci_ctl_info
*pci
;
208 /* Iterage over list, looking for exact match of ID */
209 list_for_each(item
, &edac_pci_list
) {
210 pci
= list_entry(item
, struct edac_pci_ctl_info
, link
);
212 if (pci
->pci_idx
>= idx
) {
213 if (pci
->pci_idx
== idx
)
216 /* not on list, so terminate early */
223 EXPORT_SYMBOL_GPL(edac_pci_find
);
227 * edac_pci_workq_function()
229 * periodic function that performs the operation
230 * scheduled by a workq request, for a given PCI control struct
232 static void edac_pci_workq_function(struct work_struct
*work_req
)
234 struct delayed_work
*d_work
= to_delayed_work(work_req
);
235 struct edac_pci_ctl_info
*pci
= to_edac_pci_ctl_work(d_work
);
239 debugf3("%s() checking\n", __func__
);
241 mutex_lock(&edac_pci_ctls_mutex
);
243 if (pci
->op_state
== OP_RUNNING_POLL
) {
244 /* we might be in POLL mode, but there may NOT be a poll func
246 if ((pci
->edac_check
!= NULL
) && edac_pci_get_check_errors())
247 pci
->edac_check(pci
);
249 /* if we are on a one second period, then use round */
250 msec
= edac_pci_get_poll_msec();
252 delay
= round_jiffies_relative(msecs_to_jiffies(msec
));
254 delay
= msecs_to_jiffies(msec
);
256 /* Reschedule only if we are in POLL mode */
257 queue_delayed_work(edac_workqueue
, &pci
->work
, delay
);
260 mutex_unlock(&edac_pci_ctls_mutex
);
264 * edac_pci_workq_setup()
265 * initialize a workq item for this edac_pci instance
266 * passing in the new delay period in msec
269 * called when 'edac_pci_ctls_mutex' is locked
271 static void edac_pci_workq_setup(struct edac_pci_ctl_info
*pci
,
274 debugf0("%s()\n", __func__
);
276 INIT_DELAYED_WORK(&pci
->work
, edac_pci_workq_function
);
277 queue_delayed_work(edac_workqueue
, &pci
->work
,
278 msecs_to_jiffies(edac_pci_get_poll_msec()));
282 * edac_pci_workq_teardown()
283 * stop the workq processing on this edac_pci instance
285 static void edac_pci_workq_teardown(struct edac_pci_ctl_info
*pci
)
289 debugf0("%s()\n", __func__
);
291 status
= cancel_delayed_work(&pci
->work
);
293 flush_workqueue(edac_workqueue
);
297 * edac_pci_reset_delay_period
299 * called with a new period value for the workq period
300 * a) stop current workq timer
301 * b) restart workq timer with new value
303 void edac_pci_reset_delay_period(struct edac_pci_ctl_info
*pci
,
306 debugf0("%s()\n", __func__
);
308 edac_pci_workq_teardown(pci
);
310 /* need to lock for the setup */
311 mutex_lock(&edac_pci_ctls_mutex
);
313 edac_pci_workq_setup(pci
, value
);
315 mutex_unlock(&edac_pci_ctls_mutex
);
317 EXPORT_SYMBOL_GPL(edac_pci_reset_delay_period
);
320 * edac_pci_alloc_index: Allocate a unique PCI index number
323 * allocated index number
326 int edac_pci_alloc_index(void)
328 return atomic_inc_return(&pci_indexes
) - 1;
330 EXPORT_SYMBOL_GPL(edac_pci_alloc_index
);
333 * edac_pci_add_device: Insert the 'edac_dev' structure into the
334 * edac_pci global list and create sysfs entries associated with
335 * edac_pci structure.
336 * @pci: pointer to the edac_device structure to be added to the list
337 * @edac_idx: A unique numeric identifier to be assigned to the
338 * 'edac_pci' structure.
344 int edac_pci_add_device(struct edac_pci_ctl_info
*pci
, int edac_idx
)
346 debugf0("%s()\n", __func__
);
348 pci
->pci_idx
= edac_idx
;
349 pci
->start_time
= jiffies
;
351 mutex_lock(&edac_pci_ctls_mutex
);
353 if (add_edac_pci_to_global_list(pci
))
356 if (edac_pci_create_sysfs(pci
)) {
357 edac_pci_printk(pci
, KERN_WARNING
,
358 "failed to create sysfs pci\n");
362 if (pci
->edac_check
!= NULL
) {
363 pci
->op_state
= OP_RUNNING_POLL
;
365 edac_pci_workq_setup(pci
, 1000);
367 pci
->op_state
= OP_RUNNING_INTERRUPT
;
370 edac_pci_printk(pci
, KERN_INFO
,
371 "Giving out device to module '%s' controller '%s':"
375 edac_dev_name(pci
), edac_op_state_to_string(pci
->op_state
));
377 mutex_unlock(&edac_pci_ctls_mutex
);
380 /* error unwind stack */
382 del_edac_pci_from_global_list(pci
);
384 mutex_unlock(&edac_pci_ctls_mutex
);
387 EXPORT_SYMBOL_GPL(edac_pci_add_device
);
390 * edac_pci_del_device()
391 * Remove sysfs entries for specified edac_pci structure and
392 * then remove edac_pci structure from global list
395 * Pointer to 'struct device' representing edac_pci structure
399 * Pointer to removed edac_pci structure,
400 * or NULL if device not found
402 struct edac_pci_ctl_info
*edac_pci_del_device(struct device
*dev
)
404 struct edac_pci_ctl_info
*pci
;
406 debugf0("%s()\n", __func__
);
408 mutex_lock(&edac_pci_ctls_mutex
);
410 /* ensure the control struct is on the global list
413 pci
= find_edac_pci_by_dev(dev
);
415 mutex_unlock(&edac_pci_ctls_mutex
);
419 pci
->op_state
= OP_OFFLINE
;
421 del_edac_pci_from_global_list(pci
);
423 mutex_unlock(&edac_pci_ctls_mutex
);
425 /* stop the workq timer */
426 edac_pci_workq_teardown(pci
);
428 edac_printk(KERN_INFO
, EDAC_PCI
,
429 "Removed device %d for %s %s: DEV %s\n",
430 pci
->pci_idx
, pci
->mod_name
, pci
->ctl_name
, edac_dev_name(pci
));
434 EXPORT_SYMBOL_GPL(edac_pci_del_device
);
437 * edac_pci_generic_check
439 * a Generic parity check API
441 static void edac_pci_generic_check(struct edac_pci_ctl_info
*pci
)
443 debugf4("%s()\n", __func__
);
444 edac_pci_do_parity_check();
447 /* free running instance index counter */
448 static int edac_pci_idx
;
449 #define EDAC_PCI_GENCTL_NAME "EDAC PCI controller"
451 struct edac_pci_gen_data
{
456 * edac_pci_create_generic_ctl
458 * A generic constructor for a PCI parity polling device
459 * Some systems have more than one domain of PCI busses.
460 * For systems with one domain, then this API will
461 * provide for a generic poller.
463 * This routine calls the edac_pci_alloc_ctl_info() for
464 * the generic device, with default values
466 struct edac_pci_ctl_info
*edac_pci_create_generic_ctl(struct device
*dev
,
467 const char *mod_name
)
469 struct edac_pci_ctl_info
*pci
;
470 struct edac_pci_gen_data
*pdata
;
472 pci
= edac_pci_alloc_ctl_info(sizeof(*pdata
), EDAC_PCI_GENCTL_NAME
);
476 pdata
= pci
->pvt_info
;
478 dev_set_drvdata(pci
->dev
, pci
);
479 pci
->dev_name
= pci_name(to_pci_dev(dev
));
481 pci
->mod_name
= mod_name
;
482 pci
->ctl_name
= EDAC_PCI_GENCTL_NAME
;
483 pci
->edac_check
= edac_pci_generic_check
;
485 pdata
->edac_idx
= edac_pci_idx
++;
487 if (edac_pci_add_device(pci
, pdata
->edac_idx
) > 0) {
488 debugf3("%s(): failed edac_pci_add_device()\n", __func__
);
489 edac_pci_free_ctl_info(pci
);
495 EXPORT_SYMBOL_GPL(edac_pci_create_generic_ctl
);
498 * edac_pci_release_generic_ctl
500 * The release function of a generic EDAC PCI polling device
502 void edac_pci_release_generic_ctl(struct edac_pci_ctl_info
*pci
)
504 debugf0("%s() pci mod=%s\n", __func__
, pci
->mod_name
);
506 edac_pci_del_device(pci
->dev
);
507 edac_pci_free_ctl_info(pci
);
509 EXPORT_SYMBOL_GPL(edac_pci_release_generic_ctl
);