4 * (C) 2007 www.douglaskthompson.com
6 * This file may be distributed under the terms of the
7 * GNU General Public License.
9 * Written by Doug Thompson <norsk5@xmission.com>
11 * edac_device API implementation
15 #include <linux/module.h>
16 #include <linux/types.h>
17 #include <linux/smp.h>
18 #include <linux/init.h>
19 #include <linux/sysctl.h>
20 #include <linux/highmem.h>
21 #include <linux/timer.h>
22 #include <linux/slab.h>
23 #include <linux/jiffies.h>
24 #include <linux/spinlock.h>
25 #include <linux/list.h>
26 #include <linux/sysdev.h>
27 #include <linux/ctype.h>
28 #include <linux/workqueue.h>
29 #include <asm/uaccess.h>
32 #include "edac_core.h"
33 #include "edac_module.h"
35 /* lock for the list: 'edac_device_list', manipulation of this list
36 * is protected by the 'device_ctls_mutex' lock
38 static DEFINE_MUTEX(device_ctls_mutex
);
39 static struct list_head edac_device_list
= LIST_HEAD_INIT(edac_device_list
);
41 #ifdef CONFIG_EDAC_DEBUG
42 static void edac_device_dump_device(struct edac_device_ctl_info
*edac_dev
)
44 debugf3("\tedac_dev = %p dev_idx=%d \n", edac_dev
, edac_dev
->dev_idx
);
45 debugf4("\tedac_dev->edac_check = %p\n", edac_dev
->edac_check
);
46 debugf3("\tdev = %p\n", edac_dev
->dev
);
47 debugf3("\tmod_name:ctl_name = %s:%s\n",
48 edac_dev
->mod_name
, edac_dev
->ctl_name
);
49 debugf3("\tpvt_info = %p\n\n", edac_dev
->pvt_info
);
51 #endif /* CONFIG_EDAC_DEBUG */
55 * edac_device_alloc_ctl_info()
56 * Allocate a new edac device control info structure
58 * The control structure is allocated in complete chunk
59 * from the OS. It is in turn sub allocated to the
60 * various objects that compose the struture
62 * The structure has a 'nr_instance' array within itself.
63 * Each instance represents a major component
64 * Example: L1 cache and L2 cache are 2 instance components
66 * Within each instance is an array of 'nr_blocks' blockoffsets
68 struct edac_device_ctl_info
*edac_device_alloc_ctl_info(
70 char *edac_device_name
, unsigned nr_instances
,
71 char *edac_block_name
, unsigned nr_blocks
,
72 unsigned offset_value
, /* zero, 1, or other based offset */
73 struct edac_dev_sysfs_block_attribute
*attrib_spec
, unsigned nr_attrib
,
76 struct edac_device_ctl_info
*dev_ctl
;
77 struct edac_device_instance
*dev_inst
, *inst
;
78 struct edac_device_block
*dev_blk
, *blk_p
, *blk
;
79 struct edac_dev_sysfs_block_attribute
*dev_attrib
, *attrib_p
, *attrib
;
82 unsigned instance
, block
, attr
;
86 debugf1("%s() instances=%d blocks=%d\n",
87 __func__
, nr_instances
, nr_blocks
);
89 /* Calculate the size of memory we need to allocate AND
90 * determine the offsets of the various item arrays
91 * (instance,block,attrib) from the start of an allocated structure.
92 * We want the alignment of each item (instance,block,attrib)
93 * to be at least as stringent as what the compiler would
94 * provide if we could simply hardcode everything into a single struct.
96 dev_ctl
= (struct edac_device_ctl_info
*)NULL
;
98 /* Calc the 'end' offset past end of ONE ctl_info structure
99 * which will become the start of the 'instance' array
101 dev_inst
= edac_align_ptr(&dev_ctl
[1], sizeof(*dev_inst
));
103 /* Calc the 'end' offset past the instance array within the ctl_info
104 * which will become the start of the block array
106 dev_blk
= edac_align_ptr(&dev_inst
[nr_instances
], sizeof(*dev_blk
));
108 /* Calc the 'end' offset past the dev_blk array
109 * which will become the start of the attrib array, if any.
111 count
= nr_instances
* nr_blocks
;
112 dev_attrib
= edac_align_ptr(&dev_blk
[count
], sizeof(*dev_attrib
));
114 /* Check for case of when an attribute array is specified */
116 /* calc how many nr_attrib we need */
119 /* Calc the 'end' offset past the attributes array */
120 pvt
= edac_align_ptr(&dev_attrib
[count
], sz_private
);
122 /* no attribute array specificed */
123 pvt
= edac_align_ptr(dev_attrib
, sz_private
);
126 /* 'pvt' now points to where the private data area is.
127 * At this point 'pvt' (like dev_inst,dev_blk and dev_attrib)
128 * is baselined at ZERO
130 total_size
= ((unsigned long)pvt
) + sz_private
;
132 /* Allocate the amount of memory for the set of control structures */
133 dev_ctl
= kzalloc(total_size
, GFP_KERNEL
);
137 /* Adjust pointers so they point within the actual memory we
138 * just allocated rather than an imaginary chunk of memory
139 * located at address 0.
140 * 'dev_ctl' points to REAL memory, while the others are
141 * ZERO based and thus need to be adjusted to point within
142 * the allocated memory.
144 dev_inst
= (struct edac_device_instance
*)
145 (((char *)dev_ctl
) + ((unsigned long)dev_inst
));
146 dev_blk
= (struct edac_device_block
*)
147 (((char *)dev_ctl
) + ((unsigned long)dev_blk
));
148 dev_attrib
= (struct edac_dev_sysfs_block_attribute
*)
149 (((char *)dev_ctl
) + ((unsigned long)dev_attrib
));
150 pvt
= sz_private
? (((char *)dev_ctl
) + ((unsigned long)pvt
)) : NULL
;
152 /* Begin storing the information into the control info structure */
153 dev_ctl
->dev_idx
= device_index
;
154 dev_ctl
->nr_instances
= nr_instances
;
155 dev_ctl
->instances
= dev_inst
;
156 dev_ctl
->pvt_info
= pvt
;
158 /* Name of this edac device */
159 snprintf(dev_ctl
->name
,sizeof(dev_ctl
->name
),"%s",edac_device_name
);
161 /* Initialize every Instance */
162 for (instance
= 0; instance
< nr_instances
; instance
++) {
163 inst
= &dev_inst
[instance
];
165 inst
->nr_blocks
= nr_blocks
;
166 blk_p
= &dev_blk
[instance
* nr_blocks
];
167 inst
->blocks
= blk_p
;
169 /* name of this instance */
170 snprintf(inst
->name
, sizeof(inst
->name
),
171 "%s%u", edac_device_name
, instance
);
173 /* Initialize every block in each instance */
174 for (block
= 0; block
< nr_blocks
; block
++) {
176 blk
->instance
= inst
;
177 snprintf(blk
->name
, sizeof(blk
->name
),
178 "%s%d", edac_block_name
, block
+offset_value
);
180 debugf1("%s() instance=%d block=%d name=%s\n",
181 __func__
, instance
, block
, blk
->name
);
183 /* if there are NO attributes OR no attribute pointer
184 * then continue on to next block iteration
186 if ((nr_attrib
== 0) || (attrib_spec
== NULL
))
189 /* setup the attribute array for this block */
190 blk
->nr_attribs
= nr_attrib
;
191 attrib_p
= &dev_attrib
[block
*nr_instances
*nr_attrib
];
192 blk
->block_attributes
= attrib_p
;
194 /* Initialize every user specified attribute in this
195 * block with the data the caller passed in
197 for (attr
= 0; attr
< nr_attrib
; attr
++) {
198 attrib
= &attrib_p
[attr
];
199 attrib
->attr
= attrib_spec
->attr
;
200 attrib
->show
= attrib_spec
->show
;
201 attrib
->store
= attrib_spec
->store
;
203 /* up reference this block */
206 /* bump the attrib_spec */
212 /* Mark this instance as merely ALLOCATED */
213 dev_ctl
->op_state
= OP_ALLOC
;
216 * Initialize the 'root' kobj for the edac_device controller
218 err
= edac_device_register_sysfs_main_kobj(dev_ctl
);
224 /* at this point, the root kobj is valid, and in order to
225 * 'free' the object, then the function:
226 * edac_device_unregister_sysfs_main_kobj() must be called
227 * which will perform kobj unregistration and the actual free
228 * will occur during the kobject callback operation
233 EXPORT_SYMBOL_GPL(edac_device_alloc_ctl_info
);
236 * edac_device_free_ctl_info()
237 * frees the memory allocated by the edac_device_alloc_ctl_info()
240 void edac_device_free_ctl_info(struct edac_device_ctl_info
*ctl_info
)
242 edac_device_unregister_sysfs_main_kobj(ctl_info
);
244 EXPORT_SYMBOL_GPL(edac_device_free_ctl_info
);
247 * find_edac_device_by_dev
248 * scans the edac_device list for a specific 'struct device *'
250 * lock to be held prior to call: device_ctls_mutex
253 * pointer to control structure managing 'dev'
254 * NULL if not found on list
256 static struct edac_device_ctl_info
*find_edac_device_by_dev(struct device
*dev
)
258 struct edac_device_ctl_info
*edac_dev
;
259 struct list_head
*item
;
261 debugf3("%s()\n", __func__
);
263 list_for_each(item
, &edac_device_list
) {
264 edac_dev
= list_entry(item
, struct edac_device_ctl_info
, link
);
266 if (edac_dev
->dev
== dev
)
274 * add_edac_dev_to_global_list
275 * Before calling this function, caller must
276 * assign a unique value to edac_dev->dev_idx.
278 * lock to be held prior to call: device_ctls_mutex
284 static int add_edac_dev_to_global_list(struct edac_device_ctl_info
*edac_dev
)
286 struct list_head
*item
, *insert_before
;
287 struct edac_device_ctl_info
*rover
;
289 insert_before
= &edac_device_list
;
291 /* Determine if already on the list */
292 rover
= find_edac_device_by_dev(edac_dev
->dev
);
293 if (unlikely(rover
!= NULL
))
296 /* Insert in ascending order by 'dev_idx', so find position */
297 list_for_each(item
, &edac_device_list
) {
298 rover
= list_entry(item
, struct edac_device_ctl_info
, link
);
300 if (rover
->dev_idx
>= edac_dev
->dev_idx
) {
301 if (unlikely(rover
->dev_idx
== edac_dev
->dev_idx
))
304 insert_before
= item
;
309 list_add_tail_rcu(&edac_dev
->link
, insert_before
);
313 edac_printk(KERN_WARNING
, EDAC_MC
,
314 "%s (%s) %s %s already assigned %d\n",
315 rover
->dev
->bus_id
, dev_name(rover
),
316 rover
->mod_name
, rover
->ctl_name
, rover
->dev_idx
);
320 edac_printk(KERN_WARNING
, EDAC_MC
,
321 "bug in low-level driver: attempt to assign\n"
322 " duplicate dev_idx %d in %s()\n", rover
->dev_idx
,
328 * complete_edac_device_list_del
330 * callback function when reference count is zero
332 static void complete_edac_device_list_del(struct rcu_head
*head
)
334 struct edac_device_ctl_info
*edac_dev
;
336 edac_dev
= container_of(head
, struct edac_device_ctl_info
, rcu
);
337 INIT_LIST_HEAD(&edac_dev
->link
);
338 complete(&edac_dev
->removal_complete
);
342 * del_edac_device_from_global_list
344 * remove the RCU, setup for a callback call,
345 * then wait for the callback to occur
347 static void del_edac_device_from_global_list(struct edac_device_ctl_info
350 list_del_rcu(&edac_device
->link
);
352 init_completion(&edac_device
->removal_complete
);
353 call_rcu(&edac_device
->rcu
, complete_edac_device_list_del
);
354 wait_for_completion(&edac_device
->removal_complete
);
359 * Search for a edac_device_ctl_info structure whose index is 'idx'.
361 * If found, return a pointer to the structure.
364 * Caller must hold device_ctls_mutex.
366 struct edac_device_ctl_info
*edac_device_find(int idx
)
368 struct list_head
*item
;
369 struct edac_device_ctl_info
*edac_dev
;
371 /* Iterate over list, looking for exact match of ID */
372 list_for_each(item
, &edac_device_list
) {
373 edac_dev
= list_entry(item
, struct edac_device_ctl_info
, link
);
375 if (edac_dev
->dev_idx
>= idx
) {
376 if (edac_dev
->dev_idx
== idx
)
379 /* not on list, so terminate early */
386 EXPORT_SYMBOL_GPL(edac_device_find
);
389 * edac_device_workq_function
390 * performs the operation scheduled by a workq request
392 * this workq is embedded within an edac_device_ctl_info
393 * structure, that needs to be polled for possible error events.
395 * This operation is to acquire the list mutex lock
396 * (thus preventing insertation or deletion)
397 * and then call the device's poll function IFF this device is
398 * running polled and there is a poll function defined.
400 static void edac_device_workq_function(struct work_struct
*work_req
)
402 struct delayed_work
*d_work
= (struct delayed_work
*)work_req
;
403 struct edac_device_ctl_info
*edac_dev
= to_edac_device_ctl_work(d_work
);
405 //debugf0("%s() here and running\n", __func__);
406 mutex_lock(&device_ctls_mutex
);
408 /* Only poll controllers that are running polled and have a check */
409 if ((edac_dev
->op_state
== OP_RUNNING_POLL
) &&
410 (edac_dev
->edac_check
!= NULL
)) {
411 edac_dev
->edac_check(edac_dev
);
414 mutex_unlock(&device_ctls_mutex
);
416 /* Reschedule the workq for the next time period to start again
417 * if the number of msec is for 1 sec, then adjust to the next
418 * whole one second to save timers fireing all over the period
419 * between integral seconds
421 if (edac_dev
->poll_msec
== 1000)
422 queue_delayed_work(edac_workqueue
, &edac_dev
->work
,
423 round_jiffies(edac_dev
->delay
));
425 queue_delayed_work(edac_workqueue
, &edac_dev
->work
,
430 * edac_device_workq_setup
431 * initialize a workq item for this edac_device instance
432 * passing in the new delay period in msec
434 void edac_device_workq_setup(struct edac_device_ctl_info
*edac_dev
,
437 debugf0("%s()\n", __func__
);
439 /* take the arg 'msec' and set it into the control structure
440 * to used in the time period calculation
441 * then calc the number of jiffies that represents
443 edac_dev
->poll_msec
= msec
;
444 edac_dev
->delay
= msecs_to_jiffies(msec
);
446 INIT_DELAYED_WORK(&edac_dev
->work
, edac_device_workq_function
);
448 /* optimize here for the 1 second case, which will be normal value, to
449 * fire ON the 1 second time event. This helps reduce all sorts of
450 * timers firing on sub-second basis, while they are happy
451 * to fire together on the 1 second exactly
453 if (edac_dev
->poll_msec
== 1000)
454 queue_delayed_work(edac_workqueue
, &edac_dev
->work
,
455 round_jiffies(edac_dev
->delay
));
457 queue_delayed_work(edac_workqueue
, &edac_dev
->work
,
462 * edac_device_workq_teardown
463 * stop the workq processing on this edac_dev
465 void edac_device_workq_teardown(struct edac_device_ctl_info
*edac_dev
)
469 status
= cancel_delayed_work(&edac_dev
->work
);
471 /* workq instance might be running, wait for it */
472 flush_workqueue(edac_workqueue
);
477 * edac_device_reset_delay_period
479 * need to stop any outstanding workq queued up at this time
480 * because we will be resetting the sleep time.
481 * Then restart the workq on the new delay
483 void edac_device_reset_delay_period(struct edac_device_ctl_info
*edac_dev
,
486 /* cancel the current workq request, without the mutex lock */
487 edac_device_workq_teardown(edac_dev
);
489 /* acquire the mutex before doing the workq setup */
490 mutex_lock(&device_ctls_mutex
);
492 /* restart the workq request, with new delay value */
493 edac_device_workq_setup(edac_dev
, value
);
495 mutex_unlock(&device_ctls_mutex
);
499 * edac_device_add_device: Insert the 'edac_dev' structure into the
500 * edac_device global list and create sysfs entries associated with
501 * edac_device structure.
502 * @edac_device: pointer to the edac_device structure to be added to the list
503 * 'edac_device' structure.
509 int edac_device_add_device(struct edac_device_ctl_info
*edac_dev
)
511 debugf0("%s()\n", __func__
);
513 #ifdef CONFIG_EDAC_DEBUG
514 if (edac_debug_level
>= 3)
515 edac_device_dump_device(edac_dev
);
517 mutex_lock(&device_ctls_mutex
);
519 if (add_edac_dev_to_global_list(edac_dev
))
522 /* set load time so that error rate can be tracked */
523 edac_dev
->start_time
= jiffies
;
525 /* create this instance's sysfs entries */
526 if (edac_device_create_sysfs(edac_dev
)) {
527 edac_device_printk(edac_dev
, KERN_WARNING
,
528 "failed to create sysfs device\n");
532 /* If there IS a check routine, then we are running POLLED */
533 if (edac_dev
->edac_check
!= NULL
) {
534 /* This instance is NOW RUNNING */
535 edac_dev
->op_state
= OP_RUNNING_POLL
;
538 * enable workq processing on this instance,
539 * default = 1000 msec
541 edac_device_workq_setup(edac_dev
, 1000);
543 edac_dev
->op_state
= OP_RUNNING_INTERRUPT
;
546 /* Report action taken */
547 edac_device_printk(edac_dev
, KERN_INFO
,
548 "Giving out device to module '%s' controller "
549 "'%s': DEV '%s' (%s)\n",
553 edac_op_state_to_string(edac_dev
->op_state
));
555 mutex_unlock(&device_ctls_mutex
);
559 /* Some error, so remove the entry from the lsit */
560 del_edac_device_from_global_list(edac_dev
);
563 mutex_unlock(&device_ctls_mutex
);
566 EXPORT_SYMBOL_GPL(edac_device_add_device
);
569 * edac_device_del_device:
570 * Remove sysfs entries for specified edac_device structure and
571 * then remove edac_device structure from global list
574 * Pointer to 'struct device' representing edac_device
575 * structure to remove.
578 * Pointer to removed edac_device structure,
579 * OR NULL if device not found.
581 struct edac_device_ctl_info
*edac_device_del_device(struct device
*dev
)
583 struct edac_device_ctl_info
*edac_dev
;
585 debugf0("MC: %s()\n", __func__
);
587 mutex_lock(&device_ctls_mutex
);
589 /* Find the structure on the list, if not there, then leave */
590 edac_dev
= find_edac_device_by_dev(dev
);
591 if (edac_dev
== NULL
) {
592 mutex_unlock(&device_ctls_mutex
);
596 /* mark this instance as OFFLINE */
597 edac_dev
->op_state
= OP_OFFLINE
;
599 /* clear workq processing on this instance */
600 edac_device_workq_teardown(edac_dev
);
602 /* deregister from global list */
603 del_edac_device_from_global_list(edac_dev
);
605 mutex_unlock(&device_ctls_mutex
);
607 /* Tear down the sysfs entries for this instance */
608 edac_device_remove_sysfs(edac_dev
);
610 edac_printk(KERN_INFO
, EDAC_MC
,
611 "Removed device %d for %s %s: DEV %s\n",
613 edac_dev
->mod_name
, edac_dev
->ctl_name
, dev_name(edac_dev
));
617 EXPORT_SYMBOL_GPL(edac_device_del_device
);
619 static inline int edac_device_get_log_ce(struct edac_device_ctl_info
*edac_dev
)
621 return edac_dev
->log_ce
;
624 static inline int edac_device_get_log_ue(struct edac_device_ctl_info
*edac_dev
)
626 return edac_dev
->log_ue
;
629 static inline int edac_device_get_panic_on_ue(struct edac_device_ctl_info
632 return edac_dev
->panic_on_ue
;
636 * edac_device_handle_ce
637 * perform a common output and handling of an 'edac_dev' CE event
639 void edac_device_handle_ce(struct edac_device_ctl_info
*edac_dev
,
640 int inst_nr
, int block_nr
, const char *msg
)
642 struct edac_device_instance
*instance
;
643 struct edac_device_block
*block
= NULL
;
645 if ((inst_nr
>= edac_dev
->nr_instances
) || (inst_nr
< 0)) {
646 edac_device_printk(edac_dev
, KERN_ERR
,
647 "INTERNAL ERROR: 'instance' out of range "
648 "(%d >= %d)\n", inst_nr
,
649 edac_dev
->nr_instances
);
653 instance
= edac_dev
->instances
+ inst_nr
;
655 if ((block_nr
>= instance
->nr_blocks
) || (block_nr
< 0)) {
656 edac_device_printk(edac_dev
, KERN_ERR
,
657 "INTERNAL ERROR: instance %d 'block' "
658 "out of range (%d >= %d)\n",
660 instance
->nr_blocks
);
664 if (instance
->nr_blocks
> 0) {
665 block
= instance
->blocks
+ block_nr
;
666 block
->counters
.ce_count
++;
669 /* Propogate the count up the 'totals' tree */
670 instance
->counters
.ce_count
++;
671 edac_dev
->counters
.ce_count
++;
673 if (edac_device_get_log_ce(edac_dev
))
674 edac_device_printk(edac_dev
, KERN_WARNING
,
675 "CE: %s instance: %s block: %s '%s'\n",
676 edac_dev
->ctl_name
, instance
->name
,
677 block
? block
->name
: "N/A", msg
);
679 EXPORT_SYMBOL_GPL(edac_device_handle_ce
);
682 * edac_device_handle_ue
683 * perform a common output and handling of an 'edac_dev' UE event
685 void edac_device_handle_ue(struct edac_device_ctl_info
*edac_dev
,
686 int inst_nr
, int block_nr
, const char *msg
)
688 struct edac_device_instance
*instance
;
689 struct edac_device_block
*block
= NULL
;
691 if ((inst_nr
>= edac_dev
->nr_instances
) || (inst_nr
< 0)) {
692 edac_device_printk(edac_dev
, KERN_ERR
,
693 "INTERNAL ERROR: 'instance' out of range "
694 "(%d >= %d)\n", inst_nr
,
695 edac_dev
->nr_instances
);
699 instance
= edac_dev
->instances
+ inst_nr
;
701 if ((block_nr
>= instance
->nr_blocks
) || (block_nr
< 0)) {
702 edac_device_printk(edac_dev
, KERN_ERR
,
703 "INTERNAL ERROR: instance %d 'block' "
704 "out of range (%d >= %d)\n",
706 instance
->nr_blocks
);
710 if (instance
->nr_blocks
> 0) {
711 block
= instance
->blocks
+ block_nr
;
712 block
->counters
.ue_count
++;
715 /* Propogate the count up the 'totals' tree */
716 instance
->counters
.ue_count
++;
717 edac_dev
->counters
.ue_count
++;
719 if (edac_device_get_log_ue(edac_dev
))
720 edac_device_printk(edac_dev
, KERN_EMERG
,
721 "UE: %s instance: %s block: %s '%s'\n",
722 edac_dev
->ctl_name
, instance
->name
,
723 block
? block
->name
: "N/A", msg
);
725 if (edac_device_get_panic_on_ue(edac_dev
))
726 panic("EDAC %s: UE instance: %s block %s '%s'\n",
727 edac_dev
->ctl_name
, instance
->name
,
728 block
? block
->name
: "N/A", msg
);
730 EXPORT_SYMBOL_GPL(edac_device_handle_ue
);