Commit | Line | Data |
---|---|---|
e27e3dac DT |
1 | |
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> | |
52490c8d | 23 | #include <linux/jiffies.h> |
e27e3dac DT |
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> | |
30 | #include <asm/page.h> | |
31 | ||
32 | #include "edac_core.h" | |
33 | #include "edac_module.h" | |
34 | ||
bf52fa4a DT |
35 | /* lock for the list: 'edac_device_list', manipulation of this list |
36 | * is protected by the 'device_ctls_mutex' lock | |
37 | */ | |
0ca84761 | 38 | static DEFINE_MUTEX(device_ctls_mutex); |
ff6ac2a6 | 39 | static LIST_HEAD(edac_device_list); |
e27e3dac | 40 | |
e27e3dac DT |
41 | #ifdef CONFIG_EDAC_DEBUG |
42 | static void edac_device_dump_device(struct edac_device_ctl_info *edac_dev) | |
43 | { | |
079708b9 | 44 | debugf3("\tedac_dev = %p dev_idx=%d \n", edac_dev, edac_dev->dev_idx); |
e27e3dac DT |
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); | |
50 | } | |
079708b9 | 51 | #endif /* CONFIG_EDAC_DEBUG */ |
e27e3dac | 52 | |
1c3631ff | 53 | |
e27e3dac | 54 | /* |
52490c8d DT |
55 | * 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 | |
e27e3dac DT |
67 | */ |
68 | struct edac_device_ctl_info *edac_device_alloc_ctl_info( | |
69 | unsigned sz_private, | |
52490c8d DT |
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 */ | |
d45e7823 DT |
73 | struct edac_dev_sysfs_block_attribute *attrib_spec, unsigned nr_attrib, |
74 | int device_index) | |
e27e3dac DT |
75 | { |
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; | |
fd309a9d | 79 | struct edac_dev_sysfs_block_attribute *dev_attrib, *attrib_p, *attrib; |
e27e3dac DT |
80 | unsigned total_size; |
81 | unsigned count; | |
82 | unsigned instance, block, attr; | |
83 | void *pvt; | |
1c3631ff | 84 | int err; |
e27e3dac | 85 | |
b2a4ac0c | 86 | debugf4("%s() instances=%d blocks=%d\n", |
079708b9 | 87 | __func__, nr_instances, nr_blocks); |
e27e3dac | 88 | |
fd309a9d DT |
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) | |
e27e3dac DT |
93 | * to be at least as stringent as what the compiler would |
94 | * provide if we could simply hardcode everything into a single struct. | |
95 | */ | |
52490c8d | 96 | dev_ctl = (struct edac_device_ctl_info *)NULL; |
e27e3dac | 97 | |
fd309a9d DT |
98 | /* Calc the 'end' offset past end of ONE ctl_info structure |
99 | * which will become the start of the 'instance' array | |
100 | */ | |
7391c6dc | 101 | dev_inst = edac_align_ptr(&dev_ctl[1], sizeof(*dev_inst)); |
e27e3dac | 102 | |
fd309a9d DT |
103 | /* Calc the 'end' offset past the instance array within the ctl_info |
104 | * which will become the start of the block array | |
105 | */ | |
7391c6dc | 106 | dev_blk = edac_align_ptr(&dev_inst[nr_instances], sizeof(*dev_blk)); |
e27e3dac | 107 | |
fd309a9d DT |
108 | /* Calc the 'end' offset past the dev_blk array |
109 | * which will become the start of the attrib array, if any. | |
110 | */ | |
e27e3dac | 111 | count = nr_instances * nr_blocks; |
7391c6dc | 112 | dev_attrib = edac_align_ptr(&dev_blk[count], sizeof(*dev_attrib)); |
e27e3dac | 113 | |
fd309a9d DT |
114 | /* 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; | |
e27e3dac | 118 | |
fd309a9d DT |
119 | /* 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 | */ | |
079708b9 | 130 | total_size = ((unsigned long)pvt) + sz_private; |
e27e3dac DT |
131 | |
132 | /* Allocate the amount of memory for the set of control structures */ | |
52490c8d DT |
133 | dev_ctl = kzalloc(total_size, GFP_KERNEL); |
134 | if (dev_ctl == NULL) | |
e27e3dac DT |
135 | return NULL; |
136 | ||
fd309a9d DT |
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. | |
e27e3dac DT |
143 | */ |
144 | dev_inst = (struct edac_device_instance *) | |
052dfb45 | 145 | (((char *)dev_ctl) + ((unsigned long)dev_inst)); |
e27e3dac | 146 | dev_blk = (struct edac_device_block *) |
052dfb45 | 147 | (((char *)dev_ctl) + ((unsigned long)dev_blk)); |
fd309a9d | 148 | dev_attrib = (struct edac_dev_sysfs_block_attribute *) |
052dfb45 | 149 | (((char *)dev_ctl) + ((unsigned long)dev_attrib)); |
079708b9 | 150 | pvt = sz_private ? (((char *)dev_ctl) + ((unsigned long)pvt)) : NULL; |
e27e3dac | 151 | |
fd309a9d | 152 | /* Begin storing the information into the control info structure */ |
d45e7823 | 153 | dev_ctl->dev_idx = device_index; |
e27e3dac DT |
154 | dev_ctl->nr_instances = nr_instances; |
155 | dev_ctl->instances = dev_inst; | |
156 | dev_ctl->pvt_info = pvt; | |
157 | ||
56e61a9c DT |
158 | /* Default logging of CEs and UEs */ |
159 | dev_ctl->log_ce = 1; | |
160 | dev_ctl->log_ue = 1; | |
161 | ||
52490c8d DT |
162 | /* Name of this edac device */ |
163 | snprintf(dev_ctl->name,sizeof(dev_ctl->name),"%s",edac_device_name); | |
e27e3dac | 164 | |
b2a4ac0c DT |
165 | debugf4("%s() edac_dev=%p next after end=%p\n", |
166 | __func__, dev_ctl, pvt + sz_private ); | |
167 | ||
e27e3dac DT |
168 | /* 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), | |
079708b9 | 178 | "%s%u", edac_device_name, instance); |
e27e3dac DT |
179 | |
180 | /* Initialize every block in each instance */ | |
079708b9 | 181 | for (block = 0; block < nr_blocks; block++) { |
e27e3dac DT |
182 | blk = &blk_p[block]; |
183 | blk->instance = inst; | |
e27e3dac | 184 | snprintf(blk->name, sizeof(blk->name), |
d391a7b8 | 185 | "%s%d", edac_block_name, block+offset_value); |
e27e3dac | 186 | |
b2a4ac0c DT |
187 | 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); | |
e27e3dac | 191 | |
fd309a9d DT |
192 | /* 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; | |
197 | ||
198 | /* 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 | ||
b2a4ac0c DT |
203 | debugf4("%s() THIS BLOCK_ATTRIB=%p\n", |
204 | __func__, blk->block_attributes); | |
205 | ||
fd309a9d DT |
206 | /* Initialize every user specified attribute in this |
207 | * block with the data the caller passed in | |
b2a4ac0c DT |
208 | * Each block gets its own copy of pointers, |
209 | * and its unique 'value' | |
fd309a9d DT |
210 | */ |
211 | for (attr = 0; attr < nr_attrib; attr++) { | |
212 | attrib = &attrib_p[attr]; | |
fd309a9d | 213 | |
b2a4ac0c DT |
214 | /* 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; | |
220 | ||
221 | 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 | ); | |
e27e3dac DT |
229 | } |
230 | } | |
231 | } | |
232 | ||
233 | /* Mark this instance as merely ALLOCATED */ | |
234 | dev_ctl->op_state = OP_ALLOC; | |
235 | ||
1c3631ff DT |
236 | /* |
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 | ||
e27e3dac DT |
252 | return dev_ctl; |
253 | } | |
254 | EXPORT_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 | */ | |
079708b9 DT |
261 | void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info) |
262 | { | |
1c3631ff | 263 | edac_device_unregister_sysfs_main_kobj(ctl_info); |
e27e3dac | 264 | } |
079708b9 | 265 | EXPORT_SYMBOL_GPL(edac_device_free_ctl_info); |
e27e3dac DT |
266 | |
267 | /* | |
268 | * find_edac_device_by_dev | |
269 | * scans the edac_device list for a specific 'struct device *' | |
52490c8d DT |
270 | * |
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 | |
e27e3dac | 276 | */ |
079708b9 | 277 | static struct edac_device_ctl_info *find_edac_device_by_dev(struct device *dev) |
e27e3dac DT |
278 | { |
279 | struct edac_device_ctl_info *edac_dev; | |
280 | struct list_head *item; | |
281 | ||
b2a4ac0c | 282 | debugf0("%s()\n", __func__); |
e27e3dac DT |
283 | |
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. | |
52490c8d DT |
298 | * |
299 | * lock to be held prior to call: device_ctls_mutex | |
300 | * | |
e27e3dac DT |
301 | * Return: |
302 | * 0 on success | |
303 | * 1 on failure. | |
304 | */ | |
079708b9 | 305 | static int add_edac_dev_to_global_list(struct edac_device_ctl_info *edac_dev) |
e27e3dac DT |
306 | { |
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 */ | |
52490c8d DT |
313 | rover = find_edac_device_by_dev(edac_dev->dev); |
314 | if (unlikely(rover != NULL)) | |
e27e3dac DT |
315 | 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 | ||
052dfb45 | 333 | fail0: |
e27e3dac | 334 | edac_printk(KERN_WARNING, EDAC_MC, |
052dfb45 | 335 | "%s (%s) %s %s already assigned %d\n", |
17aa7e03 | 336 | rover->dev->bus_id, edac_dev_name(rover), |
052dfb45 | 337 | rover->mod_name, rover->ctl_name, rover->dev_idx); |
e27e3dac DT |
338 | return 1; |
339 | ||
052dfb45 | 340 | fail1: |
e27e3dac | 341 | edac_printk(KERN_WARNING, EDAC_MC, |
052dfb45 DT |
342 | "bug in low-level driver: attempt to assign\n" |
343 | " duplicate dev_idx %d in %s()\n", rover->dev_idx, | |
344 | __func__); | |
e27e3dac DT |
345 | return 1; |
346 | } | |
347 | ||
348 | /* | |
349 | * complete_edac_device_list_del | |
52490c8d DT |
350 | * |
351 | * callback function when reference count is zero | |
e27e3dac DT |
352 | */ |
353 | static 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); | |
1c3631ff | 359 | complete(&edac_dev->removal_complete); |
e27e3dac DT |
360 | } |
361 | ||
362 | /* | |
363 | * del_edac_device_from_global_list | |
52490c8d | 364 | * |
1c3631ff DT |
365 | * remove the RCU, setup for a callback call, |
366 | * then wait for the callback to occur | |
e27e3dac | 367 | */ |
079708b9 | 368 | static void del_edac_device_from_global_list(struct edac_device_ctl_info |
052dfb45 | 369 | *edac_device) |
e27e3dac DT |
370 | { |
371 | list_del_rcu(&edac_device->link); | |
1c3631ff DT |
372 | |
373 | init_completion(&edac_device->removal_complete); | |
e27e3dac | 374 | call_rcu(&edac_device->rcu, complete_edac_device_list_del); |
1c3631ff | 375 | wait_for_completion(&edac_device->removal_complete); |
e27e3dac DT |
376 | } |
377 | ||
e27e3dac | 378 | /* |
81d87cb1 | 379 | * edac_device_workq_function |
e27e3dac | 380 | * performs the operation scheduled by a workq request |
bf52fa4a DT |
381 | * |
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. | |
e27e3dac | 389 | */ |
81d87cb1 | 390 | static void edac_device_workq_function(struct work_struct *work_req) |
e27e3dac | 391 | { |
079708b9 DT |
392 | 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); | |
e27e3dac | 394 | |
0ca84761 | 395 | mutex_lock(&device_ctls_mutex); |
e27e3dac DT |
396 | |
397 | /* Only poll controllers that are running polled and have a check */ | |
398 | if ((edac_dev->op_state == OP_RUNNING_POLL) && | |
052dfb45 DT |
399 | (edac_dev->edac_check != NULL)) { |
400 | edac_dev->edac_check(edac_dev); | |
e27e3dac DT |
401 | } |
402 | ||
0ca84761 | 403 | mutex_unlock(&device_ctls_mutex); |
e27e3dac | 404 | |
bf52fa4a DT |
405 | /* Reschedule the workq for the next time period to start again |
406 | * if the number of msec is for 1 sec, then adjust to the next | |
407 | * whole one second to save timers fireing all over the period | |
408 | * between integral seconds | |
409 | */ | |
410 | if (edac_dev->poll_msec == 1000) | |
411 | queue_delayed_work(edac_workqueue, &edac_dev->work, | |
c2ae24cf | 412 | round_jiffies_relative(edac_dev->delay)); |
bf52fa4a DT |
413 | else |
414 | queue_delayed_work(edac_workqueue, &edac_dev->work, | |
415 | edac_dev->delay); | |
e27e3dac DT |
416 | } |
417 | ||
418 | /* | |
81d87cb1 | 419 | * edac_device_workq_setup |
e27e3dac DT |
420 | * initialize a workq item for this edac_device instance |
421 | * passing in the new delay period in msec | |
422 | */ | |
81d87cb1 | 423 | void edac_device_workq_setup(struct edac_device_ctl_info *edac_dev, |
052dfb45 | 424 | unsigned msec) |
e27e3dac DT |
425 | { |
426 | debugf0("%s()\n", __func__); | |
427 | ||
bf52fa4a DT |
428 | /* take the arg 'msec' and set it into the control structure |
429 | * to used in the time period calculation | |
430 | * then calc the number of jiffies that represents | |
431 | */ | |
e27e3dac | 432 | edac_dev->poll_msec = msec; |
bf52fa4a | 433 | edac_dev->delay = msecs_to_jiffies(msec); |
e27e3dac | 434 | |
81d87cb1 | 435 | INIT_DELAYED_WORK(&edac_dev->work, edac_device_workq_function); |
bf52fa4a DT |
436 | |
437 | /* optimize here for the 1 second case, which will be normal value, to | |
438 | * fire ON the 1 second time event. This helps reduce all sorts of | |
439 | * timers firing on sub-second basis, while they are happy | |
440 | * to fire together on the 1 second exactly | |
441 | */ | |
442 | if (edac_dev->poll_msec == 1000) | |
443 | queue_delayed_work(edac_workqueue, &edac_dev->work, | |
c2ae24cf | 444 | round_jiffies_relative(edac_dev->delay)); |
bf52fa4a DT |
445 | else |
446 | queue_delayed_work(edac_workqueue, &edac_dev->work, | |
447 | edac_dev->delay); | |
e27e3dac DT |
448 | } |
449 | ||
450 | /* | |
81d87cb1 | 451 | * edac_device_workq_teardown |
e27e3dac DT |
452 | * stop the workq processing on this edac_dev |
453 | */ | |
81d87cb1 | 454 | void edac_device_workq_teardown(struct edac_device_ctl_info *edac_dev) |
e27e3dac DT |
455 | { |
456 | int status; | |
457 | ||
458 | status = cancel_delayed_work(&edac_dev->work); | |
459 | if (status == 0) { | |
460 | /* workq instance might be running, wait for it */ | |
461 | flush_workqueue(edac_workqueue); | |
462 | } | |
463 | } | |
464 | ||
465 | /* | |
466 | * edac_device_reset_delay_period | |
bf52fa4a DT |
467 | * |
468 | * need to stop any outstanding workq queued up at this time | |
469 | * because we will be resetting the sleep time. | |
470 | * Then restart the workq on the new delay | |
e27e3dac | 471 | */ |
079708b9 | 472 | void edac_device_reset_delay_period(struct edac_device_ctl_info *edac_dev, |
052dfb45 | 473 | unsigned long value) |
e27e3dac | 474 | { |
bf52fa4a | 475 | /* cancel the current workq request, without the mutex lock */ |
81d87cb1 | 476 | edac_device_workq_teardown(edac_dev); |
e27e3dac | 477 | |
bf52fa4a DT |
478 | /* acquire the mutex before doing the workq setup */ |
479 | mutex_lock(&device_ctls_mutex); | |
480 | ||
e27e3dac | 481 | /* restart the workq request, with new delay value */ |
81d87cb1 | 482 | edac_device_workq_setup(edac_dev, value); |
e27e3dac | 483 | |
0ca84761 | 484 | mutex_unlock(&device_ctls_mutex); |
e27e3dac DT |
485 | } |
486 | ||
e27e3dac DT |
487 | /** |
488 | * edac_device_add_device: Insert the 'edac_dev' structure into the | |
489 | * edac_device global list and create sysfs entries associated with | |
490 | * edac_device structure. | |
491 | * @edac_device: pointer to the edac_device structure to be added to the list | |
e27e3dac DT |
492 | * 'edac_device' structure. |
493 | * | |
494 | * Return: | |
495 | * 0 Success | |
496 | * !0 Failure | |
497 | */ | |
d45e7823 | 498 | int edac_device_add_device(struct edac_device_ctl_info *edac_dev) |
e27e3dac DT |
499 | { |
500 | debugf0("%s()\n", __func__); | |
501 | ||
e27e3dac DT |
502 | #ifdef CONFIG_EDAC_DEBUG |
503 | if (edac_debug_level >= 3) | |
504 | edac_device_dump_device(edac_dev); | |
505 | #endif | |
0ca84761 | 506 | mutex_lock(&device_ctls_mutex); |
e27e3dac DT |
507 | |
508 | if (add_edac_dev_to_global_list(edac_dev)) | |
509 | goto fail0; | |
510 | ||
511 | /* set load time so that error rate can be tracked */ | |
512 | edac_dev->start_time = jiffies; | |
513 | ||
514 | /* create this instance's sysfs entries */ | |
515 | if (edac_device_create_sysfs(edac_dev)) { | |
516 | edac_device_printk(edac_dev, KERN_WARNING, | |
052dfb45 | 517 | "failed to create sysfs device\n"); |
e27e3dac DT |
518 | goto fail1; |
519 | } | |
520 | ||
521 | /* If there IS a check routine, then we are running POLLED */ | |
522 | if (edac_dev->edac_check != NULL) { | |
523 | /* This instance is NOW RUNNING */ | |
524 | edac_dev->op_state = OP_RUNNING_POLL; | |
525 | ||
81d87cb1 DJ |
526 | /* |
527 | * enable workq processing on this instance, | |
528 | * default = 1000 msec | |
529 | */ | |
530 | edac_device_workq_setup(edac_dev, 1000); | |
e27e3dac DT |
531 | } else { |
532 | edac_dev->op_state = OP_RUNNING_INTERRUPT; | |
533 | } | |
534 | ||
e27e3dac DT |
535 | /* Report action taken */ |
536 | edac_device_printk(edac_dev, KERN_INFO, | |
052dfb45 DT |
537 | "Giving out device to module '%s' controller " |
538 | "'%s': DEV '%s' (%s)\n", | |
539 | edac_dev->mod_name, | |
540 | edac_dev->ctl_name, | |
17aa7e03 | 541 | edac_dev_name(edac_dev), |
494d0d55 | 542 | edac_op_state_to_string(edac_dev->op_state)); |
e27e3dac | 543 | |
0ca84761 | 544 | mutex_unlock(&device_ctls_mutex); |
e27e3dac DT |
545 | return 0; |
546 | ||
052dfb45 | 547 | fail1: |
e27e3dac DT |
548 | /* Some error, so remove the entry from the lsit */ |
549 | del_edac_device_from_global_list(edac_dev); | |
550 | ||
052dfb45 | 551 | fail0: |
0ca84761 | 552 | mutex_unlock(&device_ctls_mutex); |
e27e3dac DT |
553 | return 1; |
554 | } | |
555 | EXPORT_SYMBOL_GPL(edac_device_add_device); | |
556 | ||
557 | /** | |
558 | * edac_device_del_device: | |
559 | * Remove sysfs entries for specified edac_device structure and | |
560 | * then remove edac_device structure from global list | |
561 | * | |
562 | * @pdev: | |
563 | * Pointer to 'struct device' representing edac_device | |
564 | * structure to remove. | |
565 | * | |
566 | * Return: | |
567 | * Pointer to removed edac_device structure, | |
568 | * OR NULL if device not found. | |
569 | */ | |
079708b9 | 570 | struct edac_device_ctl_info *edac_device_del_device(struct device *dev) |
e27e3dac DT |
571 | { |
572 | struct edac_device_ctl_info *edac_dev; | |
573 | ||
b2a4ac0c | 574 | debugf0("%s()\n", __func__); |
e27e3dac | 575 | |
0ca84761 | 576 | mutex_lock(&device_ctls_mutex); |
e27e3dac | 577 | |
52490c8d DT |
578 | /* Find the structure on the list, if not there, then leave */ |
579 | edac_dev = find_edac_device_by_dev(dev); | |
580 | if (edac_dev == NULL) { | |
0ca84761 | 581 | mutex_unlock(&device_ctls_mutex); |
e27e3dac DT |
582 | return NULL; |
583 | } | |
584 | ||
585 | /* mark this instance as OFFLINE */ | |
586 | edac_dev->op_state = OP_OFFLINE; | |
587 | ||
588 | /* clear workq processing on this instance */ | |
81d87cb1 | 589 | edac_device_workq_teardown(edac_dev); |
e27e3dac | 590 | |
e27e3dac DT |
591 | /* deregister from global list */ |
592 | del_edac_device_from_global_list(edac_dev); | |
593 | ||
0ca84761 | 594 | mutex_unlock(&device_ctls_mutex); |
e27e3dac | 595 | |
1c3631ff DT |
596 | /* Tear down the sysfs entries for this instance */ |
597 | edac_device_remove_sysfs(edac_dev); | |
598 | ||
e27e3dac | 599 | edac_printk(KERN_INFO, EDAC_MC, |
052dfb45 DT |
600 | "Removed device %d for %s %s: DEV %s\n", |
601 | edac_dev->dev_idx, | |
17aa7e03 | 602 | edac_dev->mod_name, edac_dev->ctl_name, edac_dev_name(edac_dev)); |
e27e3dac DT |
603 | |
604 | return edac_dev; | |
605 | } | |
079708b9 | 606 | EXPORT_SYMBOL_GPL(edac_device_del_device); |
e27e3dac DT |
607 | |
608 | static inline int edac_device_get_log_ce(struct edac_device_ctl_info *edac_dev) | |
609 | { | |
610 | return edac_dev->log_ce; | |
611 | } | |
612 | ||
613 | static inline int edac_device_get_log_ue(struct edac_device_ctl_info *edac_dev) | |
614 | { | |
615 | return edac_dev->log_ue; | |
616 | } | |
617 | ||
079708b9 | 618 | static inline int edac_device_get_panic_on_ue(struct edac_device_ctl_info |
052dfb45 | 619 | *edac_dev) |
e27e3dac DT |
620 | { |
621 | return edac_dev->panic_on_ue; | |
622 | } | |
623 | ||
624 | /* | |
625 | * edac_device_handle_ce | |
626 | * perform a common output and handling of an 'edac_dev' CE event | |
627 | */ | |
628 | void edac_device_handle_ce(struct edac_device_ctl_info *edac_dev, | |
052dfb45 | 629 | int inst_nr, int block_nr, const char *msg) |
e27e3dac DT |
630 | { |
631 | struct edac_device_instance *instance; | |
632 | struct edac_device_block *block = NULL; | |
633 | ||
634 | if ((inst_nr >= edac_dev->nr_instances) || (inst_nr < 0)) { | |
635 | edac_device_printk(edac_dev, KERN_ERR, | |
052dfb45 DT |
636 | "INTERNAL ERROR: 'instance' out of range " |
637 | "(%d >= %d)\n", inst_nr, | |
638 | edac_dev->nr_instances); | |
e27e3dac DT |
639 | return; |
640 | } | |
641 | ||
642 | instance = edac_dev->instances + inst_nr; | |
643 | ||
644 | if ((block_nr >= instance->nr_blocks) || (block_nr < 0)) { | |
645 | edac_device_printk(edac_dev, KERN_ERR, | |
052dfb45 DT |
646 | "INTERNAL ERROR: instance %d 'block' " |
647 | "out of range (%d >= %d)\n", | |
648 | inst_nr, block_nr, | |
649 | instance->nr_blocks); | |
e27e3dac DT |
650 | return; |
651 | } | |
652 | ||
653 | if (instance->nr_blocks > 0) { | |
654 | block = instance->blocks + block_nr; | |
655 | block->counters.ce_count++; | |
656 | } | |
657 | ||
658 | /* Propogate the count up the 'totals' tree */ | |
659 | instance->counters.ce_count++; | |
660 | edac_dev->counters.ce_count++; | |
661 | ||
662 | if (edac_device_get_log_ce(edac_dev)) | |
663 | edac_device_printk(edac_dev, KERN_WARNING, | |
052dfb45 DT |
664 | "CE: %s instance: %s block: %s '%s'\n", |
665 | edac_dev->ctl_name, instance->name, | |
666 | block ? block->name : "N/A", msg); | |
e27e3dac DT |
667 | } |
668 | EXPORT_SYMBOL_GPL(edac_device_handle_ce); | |
669 | ||
670 | /* | |
671 | * edac_device_handle_ue | |
672 | * perform a common output and handling of an 'edac_dev' UE event | |
673 | */ | |
674 | void edac_device_handle_ue(struct edac_device_ctl_info *edac_dev, | |
052dfb45 | 675 | int inst_nr, int block_nr, const char *msg) |
e27e3dac DT |
676 | { |
677 | struct edac_device_instance *instance; | |
678 | struct edac_device_block *block = NULL; | |
679 | ||
680 | if ((inst_nr >= edac_dev->nr_instances) || (inst_nr < 0)) { | |
681 | edac_device_printk(edac_dev, KERN_ERR, | |
052dfb45 DT |
682 | "INTERNAL ERROR: 'instance' out of range " |
683 | "(%d >= %d)\n", inst_nr, | |
684 | edac_dev->nr_instances); | |
e27e3dac DT |
685 | return; |
686 | } | |
687 | ||
688 | instance = edac_dev->instances + inst_nr; | |
689 | ||
690 | if ((block_nr >= instance->nr_blocks) || (block_nr < 0)) { | |
691 | edac_device_printk(edac_dev, KERN_ERR, | |
052dfb45 DT |
692 | "INTERNAL ERROR: instance %d 'block' " |
693 | "out of range (%d >= %d)\n", | |
694 | inst_nr, block_nr, | |
695 | instance->nr_blocks); | |
e27e3dac DT |
696 | return; |
697 | } | |
698 | ||
699 | if (instance->nr_blocks > 0) { | |
700 | block = instance->blocks + block_nr; | |
701 | block->counters.ue_count++; | |
702 | } | |
703 | ||
704 | /* Propogate the count up the 'totals' tree */ | |
705 | instance->counters.ue_count++; | |
706 | edac_dev->counters.ue_count++; | |
707 | ||
708 | if (edac_device_get_log_ue(edac_dev)) | |
709 | edac_device_printk(edac_dev, KERN_EMERG, | |
052dfb45 DT |
710 | "UE: %s instance: %s block: %s '%s'\n", |
711 | edac_dev->ctl_name, instance->name, | |
712 | block ? block->name : "N/A", msg); | |
e27e3dac DT |
713 | |
714 | if (edac_device_get_panic_on_ue(edac_dev)) | |
d391a7b8 | 715 | panic("EDAC %s: UE instance: %s block %s '%s'\n", |
052dfb45 DT |
716 | edac_dev->ctl_name, instance->name, |
717 | block ? block->name : "N/A", msg); | |
e27e3dac | 718 | } |
079708b9 | 719 | EXPORT_SYMBOL_GPL(edac_device_handle_ue); |