blob: ca9113e1c1060ad9195d7cba55a35d70ed007f20 [file] [log] [blame]
Douglas Thompsone27e3da2007-07-19 01:49:36 -07001
2/*
3 * edac_device.c
4 * (C) 2007 www.douglaskthompson.com
5 *
6 * This file may be distributed under the terms of the
7 * GNU General Public License.
8 *
9 * Written by Doug Thompson <norsk5@xmission.com>
10 *
11 * edac_device API implementation
12 * 19 Jan 2007
13 */
14
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>
Douglas Thompson52490c82007-07-19 01:50:20 -070023#include <linux/jiffies.h>
Douglas Thompsone27e3da2007-07-19 01:49:36 -070024#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>
30#include <asm/page.h>
31
32#include "edac_core.h"
33#include "edac_module.h"
34
Doug Thompsonbf52fa42007-07-19 01:50:30 -070035/* lock for the list: 'edac_device_list', manipulation of this list
36 * is protected by the 'device_ctls_mutex' lock
37 */
Doug Thompson0ca84762007-07-19 01:50:22 -070038static DEFINE_MUTEX(device_ctls_mutex);
Robert P. J. Dayff6ac2a2008-04-29 01:03:17 -070039static LIST_HEAD(edac_device_list);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070040
Douglas Thompsone27e3da2007-07-19 01:49:36 -070041#ifdef CONFIG_EDAC_DEBUG
42static void edac_device_dump_device(struct edac_device_ctl_info *edac_dev)
43{
Douglas Thompson079708b2007-07-19 01:49:58 -070044 debugf3("\tedac_dev = %p dev_idx=%d \n", edac_dev, edac_dev->dev_idx);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070045 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);
50}
Douglas Thompson079708b2007-07-19 01:49:58 -070051#endif /* CONFIG_EDAC_DEBUG */
Douglas Thompsone27e3da2007-07-19 01:49:36 -070052
Douglas Thompson1c3631f2007-07-19 01:50:29 -070053
Douglas Thompsone27e3da2007-07-19 01:49:36 -070054/*
Douglas Thompson52490c82007-07-19 01:50:20 -070055 * edac_device_alloc_ctl_info()
56 * Allocate a new edac device control info structure
57 *
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
61 *
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
65 *
66 * Within each instance is an array of 'nr_blocks' blockoffsets
Douglas Thompsone27e3da2007-07-19 01:49:36 -070067 */
68struct edac_device_ctl_info *edac_device_alloc_ctl_info(
69 unsigned sz_private,
Douglas Thompson52490c82007-07-19 01:50:20 -070070 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 */
Doug Thompsond45e7822007-07-19 01:50:27 -070073 struct edac_dev_sysfs_block_attribute *attrib_spec, unsigned nr_attrib,
74 int device_index)
Douglas Thompsone27e3da2007-07-19 01:49:36 -070075{
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;
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -070079 struct edac_dev_sysfs_block_attribute *dev_attrib, *attrib_p, *attrib;
Douglas Thompsone27e3da2007-07-19 01:49:36 -070080 unsigned total_size;
81 unsigned count;
82 unsigned instance, block, attr;
83 void *pvt;
Douglas Thompson1c3631f2007-07-19 01:50:29 -070084 int err;
Douglas Thompsone27e3da2007-07-19 01:49:36 -070085
Doug Thompsonb2a4ac02007-07-19 01:50:33 -070086 debugf4("%s() instances=%d blocks=%d\n",
Douglas Thompson079708b2007-07-19 01:49:58 -070087 __func__, nr_instances, nr_blocks);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070088
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -070089 /* 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)
Douglas Thompsone27e3da2007-07-19 01:49:36 -070093 * to be at least as stringent as what the compiler would
94 * provide if we could simply hardcode everything into a single struct.
95 */
Douglas Thompson52490c82007-07-19 01:50:20 -070096 dev_ctl = (struct edac_device_ctl_info *)NULL;
Douglas Thompsone27e3da2007-07-19 01:49:36 -070097
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -070098 /* Calc the 'end' offset past end of ONE ctl_info structure
99 * which will become the start of the 'instance' array
100 */
Douglas Thompson7391c6d2007-07-19 01:50:21 -0700101 dev_inst = edac_align_ptr(&dev_ctl[1], sizeof(*dev_inst));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700102
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700103 /* Calc the 'end' offset past the instance array within the ctl_info
104 * which will become the start of the block array
105 */
Douglas Thompson7391c6d2007-07-19 01:50:21 -0700106 dev_blk = edac_align_ptr(&dev_inst[nr_instances], sizeof(*dev_blk));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700107
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700108 /* Calc the 'end' offset past the dev_blk array
109 * which will become the start of the attrib array, if any.
110 */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700111 count = nr_instances * nr_blocks;
Douglas Thompson7391c6d2007-07-19 01:50:21 -0700112 dev_attrib = edac_align_ptr(&dev_blk[count], sizeof(*dev_attrib));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700113
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700114 /* Check for case of when an attribute array is specified */
115 if (nr_attrib > 0) {
116 /* calc how many nr_attrib we need */
117 count *= nr_attrib;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700118
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700119 /* Calc the 'end' offset past the attributes array */
120 pvt = edac_align_ptr(&dev_attrib[count], sz_private);
121 } else {
122 /* no attribute array specificed */
123 pvt = edac_align_ptr(dev_attrib, sz_private);
124 }
125
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
129 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700130 total_size = ((unsigned long)pvt) + sz_private;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700131
132 /* Allocate the amount of memory for the set of control structures */
Douglas Thompson52490c82007-07-19 01:50:20 -0700133 dev_ctl = kzalloc(total_size, GFP_KERNEL);
134 if (dev_ctl == NULL)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700135 return NULL;
136
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700137 /* 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.
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700143 */
144 dev_inst = (struct edac_device_instance *)
Douglas Thompson052dfb42007-07-19 01:50:13 -0700145 (((char *)dev_ctl) + ((unsigned long)dev_inst));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700146 dev_blk = (struct edac_device_block *)
Douglas Thompson052dfb42007-07-19 01:50:13 -0700147 (((char *)dev_ctl) + ((unsigned long)dev_blk));
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700148 dev_attrib = (struct edac_dev_sysfs_block_attribute *)
Douglas Thompson052dfb42007-07-19 01:50:13 -0700149 (((char *)dev_ctl) + ((unsigned long)dev_attrib));
Douglas Thompson079708b2007-07-19 01:49:58 -0700150 pvt = sz_private ? (((char *)dev_ctl) + ((unsigned long)pvt)) : NULL;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700151
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700152 /* Begin storing the information into the control info structure */
Doug Thompsond45e7822007-07-19 01:50:27 -0700153 dev_ctl->dev_idx = device_index;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700154 dev_ctl->nr_instances = nr_instances;
155 dev_ctl->instances = dev_inst;
156 dev_ctl->pvt_info = pvt;
157
Doug Thompson56e61a92008-02-07 00:14:51 -0800158 /* Default logging of CEs and UEs */
159 dev_ctl->log_ce = 1;
160 dev_ctl->log_ue = 1;
161
Douglas Thompson52490c82007-07-19 01:50:20 -0700162 /* Name of this edac device */
163 snprintf(dev_ctl->name,sizeof(dev_ctl->name),"%s",edac_device_name);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700164
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700165 debugf4("%s() edac_dev=%p next after end=%p\n",
166 __func__, dev_ctl, pvt + sz_private );
167
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700168 /* Initialize every Instance */
169 for (instance = 0; instance < nr_instances; instance++) {
170 inst = &dev_inst[instance];
171 inst->ctl = dev_ctl;
172 inst->nr_blocks = nr_blocks;
173 blk_p = &dev_blk[instance * nr_blocks];
174 inst->blocks = blk_p;
175
176 /* name of this instance */
177 snprintf(inst->name, sizeof(inst->name),
Douglas Thompson079708b2007-07-19 01:49:58 -0700178 "%s%u", edac_device_name, instance);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700179
180 /* Initialize every block in each instance */
Douglas Thompson079708b2007-07-19 01:49:58 -0700181 for (block = 0; block < nr_blocks; block++) {
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700182 blk = &blk_p[block];
183 blk->instance = inst;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700184 snprintf(blk->name, sizeof(blk->name),
Douglas Thompsond391a7b2007-07-19 01:50:11 -0700185 "%s%d", edac_block_name, block+offset_value);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700186
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700187 debugf4("%s() instance=%d inst_p=%p block=#%d "
188 "block_p=%p name='%s'\n",
189 __func__, instance, inst, block,
190 blk, blk->name);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700191
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700192 /* if there are NO attributes OR no attribute pointer
193 * then continue on to next block iteration
194 */
195 if ((nr_attrib == 0) || (attrib_spec == NULL))
196 continue;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700197
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700198 /* setup the attribute array for this block */
199 blk->nr_attribs = nr_attrib;
200 attrib_p = &dev_attrib[block*nr_instances*nr_attrib];
201 blk->block_attributes = attrib_p;
202
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700203 debugf4("%s() THIS BLOCK_ATTRIB=%p\n",
204 __func__, blk->block_attributes);
205
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700206 /* Initialize every user specified attribute in this
207 * block with the data the caller passed in
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700208 * Each block gets its own copy of pointers,
209 * and its unique 'value'
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700210 */
211 for (attr = 0; attr < nr_attrib; attr++) {
212 attrib = &attrib_p[attr];
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700213
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700214 /* populate the unique per attrib
215 * with the code pointers and info
216 */
217 attrib->attr = attrib_spec[attr].attr;
218 attrib->show = attrib_spec[attr].show;
219 attrib->store = attrib_spec[attr].store;
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700220
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700221 attrib->block = blk; /* up link */
222
223 debugf4("%s() alloc-attrib=%p attrib_name='%s' "
224 "attrib-spec=%p spec-name=%s\n",
225 __func__, attrib, attrib->attr.name,
226 &attrib_spec[attr],
227 attrib_spec[attr].attr.name
228 );
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700229 }
230 }
231 }
232
233 /* Mark this instance as merely ALLOCATED */
234 dev_ctl->op_state = OP_ALLOC;
235
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700236 /*
237 * Initialize the 'root' kobj for the edac_device controller
238 */
239 err = edac_device_register_sysfs_main_kobj(dev_ctl);
240 if (err) {
241 kfree(dev_ctl);
242 return NULL;
243 }
244
245 /* at this point, the root kobj is valid, and in order to
246 * 'free' the object, then the function:
247 * edac_device_unregister_sysfs_main_kobj() must be called
248 * which will perform kobj unregistration and the actual free
249 * will occur during the kobject callback operation
250 */
251
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700252 return dev_ctl;
253}
254EXPORT_SYMBOL_GPL(edac_device_alloc_ctl_info);
255
256/*
257 * edac_device_free_ctl_info()
258 * frees the memory allocated by the edac_device_alloc_ctl_info()
259 * function
260 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700261void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info)
262{
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700263 edac_device_unregister_sysfs_main_kobj(ctl_info);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700264}
265EXPORT_SYMBOL_GPL(edac_device_free_ctl_info);
266
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700267/*
268 * find_edac_device_by_dev
269 * scans the edac_device list for a specific 'struct device *'
Douglas Thompson52490c82007-07-19 01:50:20 -0700270 *
271 * lock to be held prior to call: device_ctls_mutex
272 *
273 * Return:
274 * pointer to control structure managing 'dev'
275 * NULL if not found on list
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700276 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700277static struct edac_device_ctl_info *find_edac_device_by_dev(struct device *dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700278{
279 struct edac_device_ctl_info *edac_dev;
280 struct list_head *item;
281
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700282 debugf0("%s()\n", __func__);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700283
284 list_for_each(item, &edac_device_list) {
285 edac_dev = list_entry(item, struct edac_device_ctl_info, link);
286
287 if (edac_dev->dev == dev)
288 return edac_dev;
289 }
290
291 return NULL;
292}
293
294/*
295 * add_edac_dev_to_global_list
296 * Before calling this function, caller must
297 * assign a unique value to edac_dev->dev_idx.
Douglas Thompson52490c82007-07-19 01:50:20 -0700298 *
299 * lock to be held prior to call: device_ctls_mutex
300 *
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700301 * Return:
302 * 0 on success
303 * 1 on failure.
304 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700305static int add_edac_dev_to_global_list(struct edac_device_ctl_info *edac_dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700306{
307 struct list_head *item, *insert_before;
308 struct edac_device_ctl_info *rover;
309
310 insert_before = &edac_device_list;
311
312 /* Determine if already on the list */
Douglas Thompson52490c82007-07-19 01:50:20 -0700313 rover = find_edac_device_by_dev(edac_dev->dev);
314 if (unlikely(rover != NULL))
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700315 goto fail0;
316
317 /* Insert in ascending order by 'dev_idx', so find position */
318 list_for_each(item, &edac_device_list) {
319 rover = list_entry(item, struct edac_device_ctl_info, link);
320
321 if (rover->dev_idx >= edac_dev->dev_idx) {
322 if (unlikely(rover->dev_idx == edac_dev->dev_idx))
323 goto fail1;
324
325 insert_before = item;
326 break;
327 }
328 }
329
330 list_add_tail_rcu(&edac_dev->link, insert_before);
331 return 0;
332
Douglas Thompson052dfb42007-07-19 01:50:13 -0700333fail0:
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700334 edac_printk(KERN_WARNING, EDAC_MC,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700335 "%s (%s) %s %s already assigned %d\n",
Kay Sievers281efb12009-01-06 14:42:57 -0800336 dev_name(rover->dev), edac_dev_name(rover),
Douglas Thompson052dfb42007-07-19 01:50:13 -0700337 rover->mod_name, rover->ctl_name, rover->dev_idx);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700338 return 1;
339
Douglas Thompson052dfb42007-07-19 01:50:13 -0700340fail1:
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700341 edac_printk(KERN_WARNING, EDAC_MC,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700342 "bug in low-level driver: attempt to assign\n"
343 " duplicate dev_idx %d in %s()\n", rover->dev_idx,
344 __func__);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700345 return 1;
346}
347
348/*
349 * complete_edac_device_list_del
Douglas Thompson52490c82007-07-19 01:50:20 -0700350 *
351 * callback function when reference count is zero
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700352 */
353static void complete_edac_device_list_del(struct rcu_head *head)
354{
355 struct edac_device_ctl_info *edac_dev;
356
357 edac_dev = container_of(head, struct edac_device_ctl_info, rcu);
358 INIT_LIST_HEAD(&edac_dev->link);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700359 complete(&edac_dev->removal_complete);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700360}
361
362/*
363 * del_edac_device_from_global_list
Douglas Thompson52490c82007-07-19 01:50:20 -0700364 *
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700365 * remove the RCU, setup for a callback call,
366 * then wait for the callback to occur
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700367 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700368static void del_edac_device_from_global_list(struct edac_device_ctl_info
Douglas Thompson052dfb42007-07-19 01:50:13 -0700369 *edac_device)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700370{
371 list_del_rcu(&edac_device->link);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700372
373 init_completion(&edac_device->removal_complete);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700374 call_rcu(&edac_device->rcu, complete_edac_device_list_del);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700375 wait_for_completion(&edac_device->removal_complete);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700376}
377
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700378/*
Dave Jiang81d87cb2007-07-19 01:49:52 -0700379 * edac_device_workq_function
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700380 * performs the operation scheduled by a workq request
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700381 *
382 * this workq is embedded within an edac_device_ctl_info
383 * structure, that needs to be polled for possible error events.
384 *
385 * This operation is to acquire the list mutex lock
386 * (thus preventing insertation or deletion)
387 * and then call the device's poll function IFF this device is
388 * running polled and there is a poll function defined.
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700389 */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700390static void edac_device_workq_function(struct work_struct *work_req)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700391{
Douglas Thompson079708b2007-07-19 01:49:58 -0700392 struct delayed_work *d_work = (struct delayed_work *)work_req;
393 struct edac_device_ctl_info *edac_dev = to_edac_device_ctl_work(d_work);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700394
Doug Thompson0ca84762007-07-19 01:50:22 -0700395 mutex_lock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700396
Harry Ciaod519c8d2008-12-23 13:57:16 -0800397 /* If we are being removed, bail out immediately */
398 if (edac_dev->op_state == OP_OFFLINE) {
399 mutex_unlock(&device_ctls_mutex);
400 return;
401 }
402
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700403 /* Only poll controllers that are running polled and have a check */
404 if ((edac_dev->op_state == OP_RUNNING_POLL) &&
Douglas Thompson052dfb42007-07-19 01:50:13 -0700405 (edac_dev->edac_check != NULL)) {
406 edac_dev->edac_check(edac_dev);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700407 }
408
Doug Thompson0ca84762007-07-19 01:50:22 -0700409 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700410
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700411 /* Reschedule the workq for the next time period to start again
412 * if the number of msec is for 1 sec, then adjust to the next
413 * whole one second to save timers fireing all over the period
414 * between integral seconds
415 */
416 if (edac_dev->poll_msec == 1000)
417 queue_delayed_work(edac_workqueue, &edac_dev->work,
Anton Blanchardc2ae24c2008-02-07 00:14:51 -0800418 round_jiffies_relative(edac_dev->delay));
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700419 else
420 queue_delayed_work(edac_workqueue, &edac_dev->work,
421 edac_dev->delay);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700422}
423
424/*
Dave Jiang81d87cb2007-07-19 01:49:52 -0700425 * edac_device_workq_setup
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700426 * initialize a workq item for this edac_device instance
427 * passing in the new delay period in msec
428 */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700429void edac_device_workq_setup(struct edac_device_ctl_info *edac_dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700430 unsigned msec)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700431{
432 debugf0("%s()\n", __func__);
433
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700434 /* take the arg 'msec' and set it into the control structure
435 * to used in the time period calculation
436 * then calc the number of jiffies that represents
437 */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700438 edac_dev->poll_msec = msec;
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700439 edac_dev->delay = msecs_to_jiffies(msec);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700440
Dave Jiang81d87cb2007-07-19 01:49:52 -0700441 INIT_DELAYED_WORK(&edac_dev->work, edac_device_workq_function);
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700442
443 /* optimize here for the 1 second case, which will be normal value, to
444 * fire ON the 1 second time event. This helps reduce all sorts of
445 * timers firing on sub-second basis, while they are happy
446 * to fire together on the 1 second exactly
447 */
448 if (edac_dev->poll_msec == 1000)
449 queue_delayed_work(edac_workqueue, &edac_dev->work,
Anton Blanchardc2ae24c2008-02-07 00:14:51 -0800450 round_jiffies_relative(edac_dev->delay));
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700451 else
452 queue_delayed_work(edac_workqueue, &edac_dev->work,
453 edac_dev->delay);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700454}
455
456/*
Dave Jiang81d87cb2007-07-19 01:49:52 -0700457 * edac_device_workq_teardown
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700458 * stop the workq processing on this edac_dev
459 */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700460void edac_device_workq_teardown(struct edac_device_ctl_info *edac_dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700461{
462 int status;
463
464 status = cancel_delayed_work(&edac_dev->work);
465 if (status == 0) {
466 /* workq instance might be running, wait for it */
467 flush_workqueue(edac_workqueue);
468 }
469}
470
471/*
472 * edac_device_reset_delay_period
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700473 *
474 * need to stop any outstanding workq queued up at this time
475 * because we will be resetting the sleep time.
476 * Then restart the workq on the new delay
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700477 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700478void edac_device_reset_delay_period(struct edac_device_ctl_info *edac_dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700479 unsigned long value)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700480{
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700481 /* cancel the current workq request, without the mutex lock */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700482 edac_device_workq_teardown(edac_dev);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700483
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700484 /* acquire the mutex before doing the workq setup */
485 mutex_lock(&device_ctls_mutex);
486
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700487 /* restart the workq request, with new delay value */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700488 edac_device_workq_setup(edac_dev, value);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700489
Doug Thompson0ca84762007-07-19 01:50:22 -0700490 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700491}
492
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700493/**
494 * edac_device_add_device: Insert the 'edac_dev' structure into the
495 * edac_device global list and create sysfs entries associated with
496 * edac_device structure.
497 * @edac_device: pointer to the edac_device structure to be added to the list
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700498 * 'edac_device' structure.
499 *
500 * Return:
501 * 0 Success
502 * !0 Failure
503 */
Doug Thompsond45e7822007-07-19 01:50:27 -0700504int edac_device_add_device(struct edac_device_ctl_info *edac_dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700505{
506 debugf0("%s()\n", __func__);
507
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700508#ifdef CONFIG_EDAC_DEBUG
509 if (edac_debug_level >= 3)
510 edac_device_dump_device(edac_dev);
511#endif
Doug Thompson0ca84762007-07-19 01:50:22 -0700512 mutex_lock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700513
514 if (add_edac_dev_to_global_list(edac_dev))
515 goto fail0;
516
517 /* set load time so that error rate can be tracked */
518 edac_dev->start_time = jiffies;
519
520 /* create this instance's sysfs entries */
521 if (edac_device_create_sysfs(edac_dev)) {
522 edac_device_printk(edac_dev, KERN_WARNING,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700523 "failed to create sysfs device\n");
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700524 goto fail1;
525 }
526
527 /* If there IS a check routine, then we are running POLLED */
528 if (edac_dev->edac_check != NULL) {
529 /* This instance is NOW RUNNING */
530 edac_dev->op_state = OP_RUNNING_POLL;
531
Dave Jiang81d87cb2007-07-19 01:49:52 -0700532 /*
533 * enable workq processing on this instance,
534 * default = 1000 msec
535 */
536 edac_device_workq_setup(edac_dev, 1000);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700537 } else {
538 edac_dev->op_state = OP_RUNNING_INTERRUPT;
539 }
540
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700541 /* Report action taken */
542 edac_device_printk(edac_dev, KERN_INFO,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700543 "Giving out device to module '%s' controller "
544 "'%s': DEV '%s' (%s)\n",
545 edac_dev->mod_name,
546 edac_dev->ctl_name,
Stephen Rothwell17aa7e02008-05-05 13:54:19 +1000547 edac_dev_name(edac_dev),
Douglas Thompson494d0d52007-07-19 01:50:21 -0700548 edac_op_state_to_string(edac_dev->op_state));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700549
Doug Thompson0ca84762007-07-19 01:50:22 -0700550 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700551 return 0;
552
Douglas Thompson052dfb42007-07-19 01:50:13 -0700553fail1:
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700554 /* Some error, so remove the entry from the lsit */
555 del_edac_device_from_global_list(edac_dev);
556
Douglas Thompson052dfb42007-07-19 01:50:13 -0700557fail0:
Doug Thompson0ca84762007-07-19 01:50:22 -0700558 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700559 return 1;
560}
561EXPORT_SYMBOL_GPL(edac_device_add_device);
562
563/**
564 * edac_device_del_device:
565 * Remove sysfs entries for specified edac_device structure and
566 * then remove edac_device structure from global list
567 *
568 * @pdev:
569 * Pointer to 'struct device' representing edac_device
570 * structure to remove.
571 *
572 * Return:
573 * Pointer to removed edac_device structure,
574 * OR NULL if device not found.
575 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700576struct edac_device_ctl_info *edac_device_del_device(struct device *dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700577{
578 struct edac_device_ctl_info *edac_dev;
579
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700580 debugf0("%s()\n", __func__);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700581
Doug Thompson0ca84762007-07-19 01:50:22 -0700582 mutex_lock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700583
Douglas Thompson52490c82007-07-19 01:50:20 -0700584 /* Find the structure on the list, if not there, then leave */
585 edac_dev = find_edac_device_by_dev(dev);
586 if (edac_dev == NULL) {
Doug Thompson0ca84762007-07-19 01:50:22 -0700587 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700588 return NULL;
589 }
590
591 /* mark this instance as OFFLINE */
592 edac_dev->op_state = OP_OFFLINE;
593
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700594 /* deregister from global list */
595 del_edac_device_from_global_list(edac_dev);
596
Doug Thompson0ca84762007-07-19 01:50:22 -0700597 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700598
Harry Ciaod519c8d2008-12-23 13:57:16 -0800599 /* clear workq processing on this instance */
600 edac_device_workq_teardown(edac_dev);
601
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700602 /* Tear down the sysfs entries for this instance */
603 edac_device_remove_sysfs(edac_dev);
604
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700605 edac_printk(KERN_INFO, EDAC_MC,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700606 "Removed device %d for %s %s: DEV %s\n",
607 edac_dev->dev_idx,
Stephen Rothwell17aa7e02008-05-05 13:54:19 +1000608 edac_dev->mod_name, edac_dev->ctl_name, edac_dev_name(edac_dev));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700609
610 return edac_dev;
611}
Douglas Thompson079708b2007-07-19 01:49:58 -0700612EXPORT_SYMBOL_GPL(edac_device_del_device);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700613
614static inline int edac_device_get_log_ce(struct edac_device_ctl_info *edac_dev)
615{
616 return edac_dev->log_ce;
617}
618
619static inline int edac_device_get_log_ue(struct edac_device_ctl_info *edac_dev)
620{
621 return edac_dev->log_ue;
622}
623
Douglas Thompson079708b2007-07-19 01:49:58 -0700624static inline int edac_device_get_panic_on_ue(struct edac_device_ctl_info
Douglas Thompson052dfb42007-07-19 01:50:13 -0700625 *edac_dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700626{
627 return edac_dev->panic_on_ue;
628}
629
630/*
631 * edac_device_handle_ce
632 * perform a common output and handling of an 'edac_dev' CE event
633 */
634void edac_device_handle_ce(struct edac_device_ctl_info *edac_dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700635 int inst_nr, int block_nr, const char *msg)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700636{
637 struct edac_device_instance *instance;
638 struct edac_device_block *block = NULL;
639
640 if ((inst_nr >= edac_dev->nr_instances) || (inst_nr < 0)) {
641 edac_device_printk(edac_dev, KERN_ERR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700642 "INTERNAL ERROR: 'instance' out of range "
643 "(%d >= %d)\n", inst_nr,
644 edac_dev->nr_instances);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700645 return;
646 }
647
648 instance = edac_dev->instances + inst_nr;
649
650 if ((block_nr >= instance->nr_blocks) || (block_nr < 0)) {
651 edac_device_printk(edac_dev, KERN_ERR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700652 "INTERNAL ERROR: instance %d 'block' "
653 "out of range (%d >= %d)\n",
654 inst_nr, block_nr,
655 instance->nr_blocks);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700656 return;
657 }
658
659 if (instance->nr_blocks > 0) {
660 block = instance->blocks + block_nr;
661 block->counters.ce_count++;
662 }
663
664 /* Propogate the count up the 'totals' tree */
665 instance->counters.ce_count++;
666 edac_dev->counters.ce_count++;
667
668 if (edac_device_get_log_ce(edac_dev))
669 edac_device_printk(edac_dev, KERN_WARNING,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700670 "CE: %s instance: %s block: %s '%s'\n",
671 edac_dev->ctl_name, instance->name,
672 block ? block->name : "N/A", msg);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700673}
674EXPORT_SYMBOL_GPL(edac_device_handle_ce);
675
676/*
677 * edac_device_handle_ue
678 * perform a common output and handling of an 'edac_dev' UE event
679 */
680void edac_device_handle_ue(struct edac_device_ctl_info *edac_dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700681 int inst_nr, int block_nr, const char *msg)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700682{
683 struct edac_device_instance *instance;
684 struct edac_device_block *block = NULL;
685
686 if ((inst_nr >= edac_dev->nr_instances) || (inst_nr < 0)) {
687 edac_device_printk(edac_dev, KERN_ERR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700688 "INTERNAL ERROR: 'instance' out of range "
689 "(%d >= %d)\n", inst_nr,
690 edac_dev->nr_instances);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700691 return;
692 }
693
694 instance = edac_dev->instances + inst_nr;
695
696 if ((block_nr >= instance->nr_blocks) || (block_nr < 0)) {
697 edac_device_printk(edac_dev, KERN_ERR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700698 "INTERNAL ERROR: instance %d 'block' "
699 "out of range (%d >= %d)\n",
700 inst_nr, block_nr,
701 instance->nr_blocks);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700702 return;
703 }
704
705 if (instance->nr_blocks > 0) {
706 block = instance->blocks + block_nr;
707 block->counters.ue_count++;
708 }
709
710 /* Propogate the count up the 'totals' tree */
711 instance->counters.ue_count++;
712 edac_dev->counters.ue_count++;
713
714 if (edac_device_get_log_ue(edac_dev))
715 edac_device_printk(edac_dev, KERN_EMERG,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700716 "UE: %s instance: %s block: %s '%s'\n",
717 edac_dev->ctl_name, instance->name,
718 block ? block->name : "N/A", msg);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700719
720 if (edac_device_get_panic_on_ue(edac_dev))
Douglas Thompsond391a7b2007-07-19 01:50:11 -0700721 panic("EDAC %s: UE instance: %s block %s '%s'\n",
Douglas Thompson052dfb42007-07-19 01:50:13 -0700722 edac_dev->ctl_name, instance->name,
723 block ? block->name : "N/A", msg);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700724}
Douglas Thompson079708b2007-07-19 01:49:58 -0700725EXPORT_SYMBOL_GPL(edac_device_handle_ue);