blob: 592af5f0cf391d292e05fd5c3a94b5589c7cb684 [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>
Douglas Thompsone27e3da2007-07-19 01:49:36 -070026#include <linux/ctype.h>
27#include <linux/workqueue.h>
28#include <asm/uaccess.h>
29#include <asm/page.h>
30
31#include "edac_core.h"
32#include "edac_module.h"
33
Doug Thompsonbf52fa42007-07-19 01:50:30 -070034/* lock for the list: 'edac_device_list', manipulation of this list
35 * is protected by the 'device_ctls_mutex' lock
36 */
Doug Thompson0ca84762007-07-19 01:50:22 -070037static DEFINE_MUTEX(device_ctls_mutex);
Robert P. J. Dayff6ac2a2008-04-29 01:03:17 -070038static LIST_HEAD(edac_device_list);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070039
Douglas Thompsone27e3da2007-07-19 01:49:36 -070040#ifdef CONFIG_EDAC_DEBUG
41static void edac_device_dump_device(struct edac_device_ctl_info *edac_dev)
42{
Joe Perches956b9ba2012-04-29 17:08:39 -030043 edac_dbg(3, "\tedac_dev = %p dev_idx=%d\n",
44 edac_dev, edac_dev->dev_idx);
45 edac_dbg(4, "\tedac_dev->edac_check = %p\n", edac_dev->edac_check);
46 edac_dbg(3, "\tdev = %p\n", edac_dev->dev);
47 edac_dbg(3, "\tmod_name:ctl_name = %s:%s\n",
48 edac_dev->mod_name, edac_dev->ctl_name);
49 edac_dbg(3, "\tpvt_info = %p\n\n", edac_dev->pvt_info);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070050}
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
David Mackey15ed1032012-04-17 11:30:52 -070060 * various objects that compose the structure
Douglas Thompson52490c82007-07-19 01:50:20 -070061 *
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;
Mauro Carvalho Chehab93e4fe62012-04-16 10:18:12 -030083 void *pvt, *p;
Douglas Thompson1c3631f2007-07-19 01:50:29 -070084 int err;
Douglas Thompsone27e3da2007-07-19 01:49:36 -070085
Joe Perches956b9ba2012-04-29 17:08:39 -030086 edac_dbg(4, "instances=%d blocks=%d\n", nr_instances, nr_blocks);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070087
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -070088 /* Calculate the size of memory we need to allocate AND
89 * determine the offsets of the various item arrays
90 * (instance,block,attrib) from the start of an allocated structure.
91 * We want the alignment of each item (instance,block,attrib)
Douglas Thompsone27e3da2007-07-19 01:49:36 -070092 * to be at least as stringent as what the compiler would
93 * provide if we could simply hardcode everything into a single struct.
94 */
Mauro Carvalho Chehab93e4fe62012-04-16 10:18:12 -030095 p = NULL;
96 dev_ctl = edac_align_ptr(&p, sizeof(*dev_ctl), 1);
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 */
Mauro Carvalho Chehab93e4fe62012-04-16 10:18:12 -0300101 dev_inst = edac_align_ptr(&p, sizeof(*dev_inst), nr_instances);
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 */
Mauro Carvalho Chehab93e4fe62012-04-16 10:18:12 -0300106 count = nr_instances * nr_blocks;
107 dev_blk = edac_align_ptr(&p, sizeof(*dev_blk), count);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700108
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700109 /* Calc the 'end' offset past the dev_blk array
110 * which will become the start of the attrib array, if any.
111 */
Mauro Carvalho Chehab93e4fe62012-04-16 10:18:12 -0300112 /* calc how many nr_attrib we need */
113 if (nr_attrib > 0)
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700114 count *= nr_attrib;
Mauro Carvalho Chehab93e4fe62012-04-16 10:18:12 -0300115 dev_attrib = edac_align_ptr(&p, sizeof(*dev_attrib), count);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700116
Mauro Carvalho Chehab93e4fe62012-04-16 10:18:12 -0300117 /* Calc the 'end' offset past the attributes array */
118 pvt = edac_align_ptr(&p, sz_private, 1);
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700119
120 /* 'pvt' now points to where the private data area is.
121 * At this point 'pvt' (like dev_inst,dev_blk and dev_attrib)
122 * is baselined at ZERO
123 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700124 total_size = ((unsigned long)pvt) + sz_private;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700125
126 /* Allocate the amount of memory for the set of control structures */
Douglas Thompson52490c82007-07-19 01:50:20 -0700127 dev_ctl = kzalloc(total_size, GFP_KERNEL);
128 if (dev_ctl == NULL)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700129 return NULL;
130
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700131 /* Adjust pointers so they point within the actual memory we
132 * just allocated rather than an imaginary chunk of memory
133 * located at address 0.
134 * 'dev_ctl' points to REAL memory, while the others are
135 * ZERO based and thus need to be adjusted to point within
136 * the allocated memory.
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700137 */
138 dev_inst = (struct edac_device_instance *)
Douglas Thompson052dfb42007-07-19 01:50:13 -0700139 (((char *)dev_ctl) + ((unsigned long)dev_inst));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700140 dev_blk = (struct edac_device_block *)
Douglas Thompson052dfb42007-07-19 01:50:13 -0700141 (((char *)dev_ctl) + ((unsigned long)dev_blk));
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700142 dev_attrib = (struct edac_dev_sysfs_block_attribute *)
Douglas Thompson052dfb42007-07-19 01:50:13 -0700143 (((char *)dev_ctl) + ((unsigned long)dev_attrib));
Douglas Thompson079708b2007-07-19 01:49:58 -0700144 pvt = sz_private ? (((char *)dev_ctl) + ((unsigned long)pvt)) : NULL;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700145
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700146 /* Begin storing the information into the control info structure */
Doug Thompsond45e7822007-07-19 01:50:27 -0700147 dev_ctl->dev_idx = device_index;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700148 dev_ctl->nr_instances = nr_instances;
149 dev_ctl->instances = dev_inst;
150 dev_ctl->pvt_info = pvt;
151
Doug Thompson56e61a92008-02-07 00:14:51 -0800152 /* Default logging of CEs and UEs */
153 dev_ctl->log_ce = 1;
154 dev_ctl->log_ue = 1;
155
Douglas Thompson52490c82007-07-19 01:50:20 -0700156 /* Name of this edac device */
157 snprintf(dev_ctl->name,sizeof(dev_ctl->name),"%s",edac_device_name);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700158
Joe Perches956b9ba2012-04-29 17:08:39 -0300159 edac_dbg(4, "edac_dev=%p next after end=%p\n",
160 dev_ctl, pvt + sz_private);
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700161
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700162 /* Initialize every Instance */
163 for (instance = 0; instance < nr_instances; instance++) {
164 inst = &dev_inst[instance];
165 inst->ctl = dev_ctl;
166 inst->nr_blocks = nr_blocks;
167 blk_p = &dev_blk[instance * nr_blocks];
168 inst->blocks = blk_p;
169
170 /* name of this instance */
171 snprintf(inst->name, sizeof(inst->name),
Douglas Thompson079708b2007-07-19 01:49:58 -0700172 "%s%u", edac_device_name, instance);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700173
174 /* Initialize every block in each instance */
Douglas Thompson079708b2007-07-19 01:49:58 -0700175 for (block = 0; block < nr_blocks; block++) {
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700176 blk = &blk_p[block];
177 blk->instance = inst;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700178 snprintf(blk->name, sizeof(blk->name),
Douglas Thompsond391a7b2007-07-19 01:50:11 -0700179 "%s%d", edac_block_name, block+offset_value);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700180
Joe Perches956b9ba2012-04-29 17:08:39 -0300181 edac_dbg(4, "instance=%d inst_p=%p block=#%d block_p=%p name='%s'\n",
182 instance, inst, block, blk, blk->name);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700183
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700184 /* if there are NO attributes OR no attribute pointer
185 * then continue on to next block iteration
186 */
187 if ((nr_attrib == 0) || (attrib_spec == NULL))
188 continue;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700189
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700190 /* setup the attribute array for this block */
191 blk->nr_attribs = nr_attrib;
192 attrib_p = &dev_attrib[block*nr_instances*nr_attrib];
193 blk->block_attributes = attrib_p;
194
Joe Perches956b9ba2012-04-29 17:08:39 -0300195 edac_dbg(4, "THIS BLOCK_ATTRIB=%p\n",
196 blk->block_attributes);
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700197
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700198 /* Initialize every user specified attribute in this
199 * block with the data the caller passed in
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700200 * Each block gets its own copy of pointers,
201 * and its unique 'value'
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700202 */
203 for (attr = 0; attr < nr_attrib; attr++) {
204 attrib = &attrib_p[attr];
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700205
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700206 /* populate the unique per attrib
207 * with the code pointers and info
208 */
209 attrib->attr = attrib_spec[attr].attr;
210 attrib->show = attrib_spec[attr].show;
211 attrib->store = attrib_spec[attr].store;
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700212
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700213 attrib->block = blk; /* up link */
214
Joe Perches956b9ba2012-04-29 17:08:39 -0300215 edac_dbg(4, "alloc-attrib=%p attrib_name='%s' attrib-spec=%p spec-name=%s\n",
216 attrib, attrib->attr.name,
217 &attrib_spec[attr],
218 attrib_spec[attr].attr.name
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700219 );
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700220 }
221 }
222 }
223
224 /* Mark this instance as merely ALLOCATED */
225 dev_ctl->op_state = OP_ALLOC;
226
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700227 /*
228 * Initialize the 'root' kobj for the edac_device controller
229 */
230 err = edac_device_register_sysfs_main_kobj(dev_ctl);
231 if (err) {
232 kfree(dev_ctl);
233 return NULL;
234 }
235
236 /* at this point, the root kobj is valid, and in order to
237 * 'free' the object, then the function:
238 * edac_device_unregister_sysfs_main_kobj() must be called
239 * which will perform kobj unregistration and the actual free
240 * will occur during the kobject callback operation
241 */
242
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700243 return dev_ctl;
244}
245EXPORT_SYMBOL_GPL(edac_device_alloc_ctl_info);
246
247/*
248 * edac_device_free_ctl_info()
249 * frees the memory allocated by the edac_device_alloc_ctl_info()
250 * function
251 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700252void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info)
253{
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700254 edac_device_unregister_sysfs_main_kobj(ctl_info);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700255}
256EXPORT_SYMBOL_GPL(edac_device_free_ctl_info);
257
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700258/*
259 * find_edac_device_by_dev
260 * scans the edac_device list for a specific 'struct device *'
Douglas Thompson52490c82007-07-19 01:50:20 -0700261 *
262 * lock to be held prior to call: device_ctls_mutex
263 *
264 * Return:
265 * pointer to control structure managing 'dev'
266 * NULL if not found on list
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700267 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700268static struct edac_device_ctl_info *find_edac_device_by_dev(struct device *dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700269{
270 struct edac_device_ctl_info *edac_dev;
271 struct list_head *item;
272
Joe Perches956b9ba2012-04-29 17:08:39 -0300273 edac_dbg(0, "\n");
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700274
275 list_for_each(item, &edac_device_list) {
276 edac_dev = list_entry(item, struct edac_device_ctl_info, link);
277
278 if (edac_dev->dev == dev)
279 return edac_dev;
280 }
281
282 return NULL;
283}
284
285/*
286 * add_edac_dev_to_global_list
287 * Before calling this function, caller must
288 * assign a unique value to edac_dev->dev_idx.
Douglas Thompson52490c82007-07-19 01:50:20 -0700289 *
290 * lock to be held prior to call: device_ctls_mutex
291 *
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700292 * Return:
293 * 0 on success
294 * 1 on failure.
295 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700296static int add_edac_dev_to_global_list(struct edac_device_ctl_info *edac_dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700297{
298 struct list_head *item, *insert_before;
299 struct edac_device_ctl_info *rover;
300
301 insert_before = &edac_device_list;
302
303 /* Determine if already on the list */
Douglas Thompson52490c82007-07-19 01:50:20 -0700304 rover = find_edac_device_by_dev(edac_dev->dev);
305 if (unlikely(rover != NULL))
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700306 goto fail0;
307
308 /* Insert in ascending order by 'dev_idx', so find position */
309 list_for_each(item, &edac_device_list) {
310 rover = list_entry(item, struct edac_device_ctl_info, link);
311
312 if (rover->dev_idx >= edac_dev->dev_idx) {
313 if (unlikely(rover->dev_idx == edac_dev->dev_idx))
314 goto fail1;
315
316 insert_before = item;
317 break;
318 }
319 }
320
321 list_add_tail_rcu(&edac_dev->link, insert_before);
322 return 0;
323
Douglas Thompson052dfb42007-07-19 01:50:13 -0700324fail0:
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700325 edac_printk(KERN_WARNING, EDAC_MC,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700326 "%s (%s) %s %s already assigned %d\n",
Kay Sievers281efb12009-01-06 14:42:57 -0800327 dev_name(rover->dev), edac_dev_name(rover),
Douglas Thompson052dfb42007-07-19 01:50:13 -0700328 rover->mod_name, rover->ctl_name, rover->dev_idx);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700329 return 1;
330
Douglas Thompson052dfb42007-07-19 01:50:13 -0700331fail1:
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700332 edac_printk(KERN_WARNING, EDAC_MC,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700333 "bug in low-level driver: attempt to assign\n"
334 " duplicate dev_idx %d in %s()\n", rover->dev_idx,
335 __func__);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700336 return 1;
337}
338
339/*
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700340 * del_edac_device_from_global_list
341 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700342static void del_edac_device_from_global_list(struct edac_device_ctl_info
Douglas Thompson052dfb42007-07-19 01:50:13 -0700343 *edac_device)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700344{
345 list_del_rcu(&edac_device->link);
Lai Jiangshane2e77092011-05-26 16:25:58 -0700346
347 /* these are for safe removal of devices from global list while
348 * NMI handlers may be traversing list
349 */
350 synchronize_rcu();
351 INIT_LIST_HEAD(&edac_device->link);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700352}
353
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700354/*
Dave Jiang81d87cb2007-07-19 01:49:52 -0700355 * edac_device_workq_function
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700356 * performs the operation scheduled by a workq request
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700357 *
358 * this workq is embedded within an edac_device_ctl_info
359 * structure, that needs to be polled for possible error events.
360 *
361 * This operation is to acquire the list mutex lock
Jiri Kosinaf70d4a92012-05-22 10:56:21 +0200362 * (thus preventing insertation or deletion)
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700363 * and then call the device's poll function IFF this device is
364 * running polled and there is a poll function defined.
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700365 */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700366static void edac_device_workq_function(struct work_struct *work_req)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700367{
Jean Delvarefbeb4382009-04-13 14:40:21 -0700368 struct delayed_work *d_work = to_delayed_work(work_req);
Douglas Thompson079708b2007-07-19 01:49:58 -0700369 struct edac_device_ctl_info *edac_dev = to_edac_device_ctl_work(d_work);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700370
Doug Thompson0ca84762007-07-19 01:50:22 -0700371 mutex_lock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700372
Harry Ciaod519c8d2008-12-23 13:57:16 -0800373 /* If we are being removed, bail out immediately */
374 if (edac_dev->op_state == OP_OFFLINE) {
375 mutex_unlock(&device_ctls_mutex);
376 return;
377 }
378
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700379 /* Only poll controllers that are running polled and have a check */
380 if ((edac_dev->op_state == OP_RUNNING_POLL) &&
Douglas Thompson052dfb42007-07-19 01:50:13 -0700381 (edac_dev->edac_check != NULL)) {
382 edac_dev->edac_check(edac_dev);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700383 }
384
Doug Thompson0ca84762007-07-19 01:50:22 -0700385 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700386
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700387 /* Reschedule the workq for the next time period to start again
388 * if the number of msec is for 1 sec, then adjust to the next
David Mackey15ed1032012-04-17 11:30:52 -0700389 * whole one second to save timers firing all over the period
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700390 * between integral seconds
391 */
392 if (edac_dev->poll_msec == 1000)
393 queue_delayed_work(edac_workqueue, &edac_dev->work,
Anton Blanchardc2ae24c2008-02-07 00:14:51 -0800394 round_jiffies_relative(edac_dev->delay));
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700395 else
396 queue_delayed_work(edac_workqueue, &edac_dev->work,
397 edac_dev->delay);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700398}
399
400/*
Dave Jiang81d87cb2007-07-19 01:49:52 -0700401 * edac_device_workq_setup
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700402 * initialize a workq item for this edac_device instance
403 * passing in the new delay period in msec
404 */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700405void edac_device_workq_setup(struct edac_device_ctl_info *edac_dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700406 unsigned msec)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700407{
Joe Perches956b9ba2012-04-29 17:08:39 -0300408 edac_dbg(0, "\n");
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700409
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700410 /* take the arg 'msec' and set it into the control structure
411 * to used in the time period calculation
412 * then calc the number of jiffies that represents
413 */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700414 edac_dev->poll_msec = msec;
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700415 edac_dev->delay = msecs_to_jiffies(msec);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700416
Dave Jiang81d87cb2007-07-19 01:49:52 -0700417 INIT_DELAYED_WORK(&edac_dev->work, edac_device_workq_function);
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700418
419 /* optimize here for the 1 second case, which will be normal value, to
420 * fire ON the 1 second time event. This helps reduce all sorts of
421 * timers firing on sub-second basis, while they are happy
422 * to fire together on the 1 second exactly
423 */
424 if (edac_dev->poll_msec == 1000)
425 queue_delayed_work(edac_workqueue, &edac_dev->work,
Anton Blanchardc2ae24c2008-02-07 00:14:51 -0800426 round_jiffies_relative(edac_dev->delay));
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700427 else
428 queue_delayed_work(edac_workqueue, &edac_dev->work,
429 edac_dev->delay);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700430}
431
432/*
Dave Jiang81d87cb2007-07-19 01:49:52 -0700433 * edac_device_workq_teardown
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700434 * stop the workq processing on this edac_dev
435 */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700436void edac_device_workq_teardown(struct edac_device_ctl_info *edac_dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700437{
438 int status;
439
Stephen Boyd881f0fc2013-12-30 12:14:12 -0800440 if (!edac_dev->edac_check)
441 return;
442
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700443 status = cancel_delayed_work(&edac_dev->work);
444 if (status == 0) {
445 /* workq instance might be running, wait for it */
446 flush_workqueue(edac_workqueue);
447 }
448}
449
450/*
451 * edac_device_reset_delay_period
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700452 *
453 * need to stop any outstanding workq queued up at this time
454 * because we will be resetting the sleep time.
455 * Then restart the workq on the new delay
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700456 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700457void edac_device_reset_delay_period(struct edac_device_ctl_info *edac_dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700458 unsigned long value)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700459{
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700460 /* cancel the current workq request, without the mutex lock */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700461 edac_device_workq_teardown(edac_dev);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700462
Doug Thompsonbf52fa42007-07-19 01:50:30 -0700463 /* acquire the mutex before doing the workq setup */
464 mutex_lock(&device_ctls_mutex);
465
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700466 /* restart the workq request, with new delay value */
Dave Jiang81d87cb2007-07-19 01:49:52 -0700467 edac_device_workq_setup(edac_dev, value);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700468
Doug Thompson0ca84762007-07-19 01:50:22 -0700469 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700470}
471
Harry Ciao1dc9b702009-06-17 16:27:59 -0700472/*
473 * edac_device_alloc_index: Allocate a unique device index number
474 *
475 * Return:
476 * allocated index number
477 */
478int edac_device_alloc_index(void)
479{
480 static atomic_t device_indexes = ATOMIC_INIT(0);
481
482 return atomic_inc_return(&device_indexes) - 1;
483}
484EXPORT_SYMBOL_GPL(edac_device_alloc_index);
485
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700486/**
487 * edac_device_add_device: Insert the 'edac_dev' structure into the
488 * edac_device global list and create sysfs entries associated with
489 * edac_device structure.
490 * @edac_device: pointer to the edac_device structure to be added to the list
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700491 * 'edac_device' structure.
492 *
493 * Return:
494 * 0 Success
495 * !0 Failure
496 */
Doug Thompsond45e7822007-07-19 01:50:27 -0700497int edac_device_add_device(struct edac_device_ctl_info *edac_dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700498{
Joe Perches956b9ba2012-04-29 17:08:39 -0300499 edac_dbg(0, "\n");
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700500
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700501#ifdef CONFIG_EDAC_DEBUG
502 if (edac_debug_level >= 3)
503 edac_device_dump_device(edac_dev);
504#endif
Doug Thompson0ca84762007-07-19 01:50:22 -0700505 mutex_lock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700506
507 if (add_edac_dev_to_global_list(edac_dev))
508 goto fail0;
509
510 /* set load time so that error rate can be tracked */
511 edac_dev->start_time = jiffies;
512
513 /* create this instance's sysfs entries */
514 if (edac_device_create_sysfs(edac_dev)) {
515 edac_device_printk(edac_dev, KERN_WARNING,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700516 "failed to create sysfs device\n");
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700517 goto fail1;
518 }
519
520 /* If there IS a check routine, then we are running POLLED */
521 if (edac_dev->edac_check != NULL) {
522 /* This instance is NOW RUNNING */
523 edac_dev->op_state = OP_RUNNING_POLL;
524
Dave Jiang81d87cb2007-07-19 01:49:52 -0700525 /*
526 * enable workq processing on this instance,
527 * default = 1000 msec
528 */
529 edac_device_workq_setup(edac_dev, 1000);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700530 } else {
531 edac_dev->op_state = OP_RUNNING_INTERRUPT;
532 }
533
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700534 /* Report action taken */
535 edac_device_printk(edac_dev, KERN_INFO,
Robert Richter7270a602013-10-10 18:22:36 +0200536 "Giving out device to module %s controller %s: DEV %s (%s)\n",
537 edac_dev->mod_name, edac_dev->ctl_name, edac_dev->dev_name,
538 edac_op_state_to_string(edac_dev->op_state));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700539
Doug Thompson0ca84762007-07-19 01:50:22 -0700540 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700541 return 0;
542
Douglas Thompson052dfb42007-07-19 01:50:13 -0700543fail1:
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700544 /* Some error, so remove the entry from the lsit */
545 del_edac_device_from_global_list(edac_dev);
546
Douglas Thompson052dfb42007-07-19 01:50:13 -0700547fail0:
Doug Thompson0ca84762007-07-19 01:50:22 -0700548 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700549 return 1;
550}
551EXPORT_SYMBOL_GPL(edac_device_add_device);
552
553/**
554 * edac_device_del_device:
555 * Remove sysfs entries for specified edac_device structure and
556 * then remove edac_device structure from global list
557 *
David Mackey15ed1032012-04-17 11:30:52 -0700558 * @dev:
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700559 * Pointer to 'struct device' representing edac_device
560 * structure to remove.
561 *
562 * Return:
563 * Pointer to removed edac_device structure,
564 * OR NULL if device not found.
565 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700566struct edac_device_ctl_info *edac_device_del_device(struct device *dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700567{
568 struct edac_device_ctl_info *edac_dev;
569
Joe Perches956b9ba2012-04-29 17:08:39 -0300570 edac_dbg(0, "\n");
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700571
Doug Thompson0ca84762007-07-19 01:50:22 -0700572 mutex_lock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700573
Douglas Thompson52490c82007-07-19 01:50:20 -0700574 /* Find the structure on the list, if not there, then leave */
575 edac_dev = find_edac_device_by_dev(dev);
576 if (edac_dev == NULL) {
Doug Thompson0ca84762007-07-19 01:50:22 -0700577 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700578 return NULL;
579 }
580
581 /* mark this instance as OFFLINE */
582 edac_dev->op_state = OP_OFFLINE;
583
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700584 /* deregister from global list */
585 del_edac_device_from_global_list(edac_dev);
586
Doug Thompson0ca84762007-07-19 01:50:22 -0700587 mutex_unlock(&device_ctls_mutex);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700588
Harry Ciaod519c8d2008-12-23 13:57:16 -0800589 /* clear workq processing on this instance */
590 edac_device_workq_teardown(edac_dev);
591
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700592 /* Tear down the sysfs entries for this instance */
593 edac_device_remove_sysfs(edac_dev);
594
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700595 edac_printk(KERN_INFO, EDAC_MC,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700596 "Removed device %d for %s %s: DEV %s\n",
597 edac_dev->dev_idx,
Stephen Rothwell17aa7e02008-05-05 13:54:19 +1000598 edac_dev->mod_name, edac_dev->ctl_name, edac_dev_name(edac_dev));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700599
600 return edac_dev;
601}
Douglas Thompson079708b2007-07-19 01:49:58 -0700602EXPORT_SYMBOL_GPL(edac_device_del_device);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700603
604static inline int edac_device_get_log_ce(struct edac_device_ctl_info *edac_dev)
605{
606 return edac_dev->log_ce;
607}
608
609static inline int edac_device_get_log_ue(struct edac_device_ctl_info *edac_dev)
610{
611 return edac_dev->log_ue;
612}
613
Douglas Thompson079708b2007-07-19 01:49:58 -0700614static inline int edac_device_get_panic_on_ue(struct edac_device_ctl_info
Douglas Thompson052dfb42007-07-19 01:50:13 -0700615 *edac_dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700616{
617 return edac_dev->panic_on_ue;
618}
619
620/*
621 * edac_device_handle_ce
622 * perform a common output and handling of an 'edac_dev' CE event
623 */
624void edac_device_handle_ce(struct edac_device_ctl_info *edac_dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700625 int inst_nr, int block_nr, const char *msg)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700626{
627 struct edac_device_instance *instance;
628 struct edac_device_block *block = NULL;
629
630 if ((inst_nr >= edac_dev->nr_instances) || (inst_nr < 0)) {
631 edac_device_printk(edac_dev, KERN_ERR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700632 "INTERNAL ERROR: 'instance' out of range "
633 "(%d >= %d)\n", inst_nr,
634 edac_dev->nr_instances);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700635 return;
636 }
637
638 instance = edac_dev->instances + inst_nr;
639
640 if ((block_nr >= instance->nr_blocks) || (block_nr < 0)) {
641 edac_device_printk(edac_dev, KERN_ERR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700642 "INTERNAL ERROR: instance %d 'block' "
643 "out of range (%d >= %d)\n",
644 inst_nr, block_nr,
645 instance->nr_blocks);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700646 return;
647 }
648
649 if (instance->nr_blocks > 0) {
650 block = instance->blocks + block_nr;
651 block->counters.ce_count++;
652 }
653
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300654 /* Propagate the count up the 'totals' tree */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700655 instance->counters.ce_count++;
656 edac_dev->counters.ce_count++;
657
658 if (edac_device_get_log_ce(edac_dev))
659 edac_device_printk(edac_dev, KERN_WARNING,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700660 "CE: %s instance: %s block: %s '%s'\n",
661 edac_dev->ctl_name, instance->name,
662 block ? block->name : "N/A", msg);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700663}
664EXPORT_SYMBOL_GPL(edac_device_handle_ce);
665
666/*
667 * edac_device_handle_ue
668 * perform a common output and handling of an 'edac_dev' UE event
669 */
670void edac_device_handle_ue(struct edac_device_ctl_info *edac_dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700671 int inst_nr, int block_nr, const char *msg)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700672{
673 struct edac_device_instance *instance;
674 struct edac_device_block *block = NULL;
675
676 if ((inst_nr >= edac_dev->nr_instances) || (inst_nr < 0)) {
677 edac_device_printk(edac_dev, KERN_ERR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700678 "INTERNAL ERROR: 'instance' out of range "
679 "(%d >= %d)\n", inst_nr,
680 edac_dev->nr_instances);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700681 return;
682 }
683
684 instance = edac_dev->instances + inst_nr;
685
686 if ((block_nr >= instance->nr_blocks) || (block_nr < 0)) {
687 edac_device_printk(edac_dev, KERN_ERR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700688 "INTERNAL ERROR: instance %d 'block' "
689 "out of range (%d >= %d)\n",
690 inst_nr, block_nr,
691 instance->nr_blocks);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700692 return;
693 }
694
695 if (instance->nr_blocks > 0) {
696 block = instance->blocks + block_nr;
697 block->counters.ue_count++;
698 }
699
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300700 /* Propagate the count up the 'totals' tree */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700701 instance->counters.ue_count++;
702 edac_dev->counters.ue_count++;
703
704 if (edac_device_get_log_ue(edac_dev))
705 edac_device_printk(edac_dev, KERN_EMERG,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700706 "UE: %s instance: %s block: %s '%s'\n",
707 edac_dev->ctl_name, instance->name,
708 block ? block->name : "N/A", msg);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700709
710 if (edac_device_get_panic_on_ue(edac_dev))
Douglas Thompsond391a7b2007-07-19 01:50:11 -0700711 panic("EDAC %s: UE instance: %s block %s '%s'\n",
Douglas Thompson052dfb42007-07-19 01:50:13 -0700712 edac_dev->ctl_name, instance->name,
713 block ? block->name : "N/A", msg);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700714}
Douglas Thompson079708b2007-07-19 01:49:58 -0700715EXPORT_SYMBOL_GPL(edac_device_handle_ue);