Commit | Line | Data |
---|---|---|
e27e3dac DT |
1 | /* |
2 | * file for managing the edac_device class of devices for EDAC | |
3 | * | |
1c3631ff DT |
4 | * (C) 2007 SoftwareBitMaker (http://www.softwarebitmaker.com) |
5 | * | |
e27e3dac DT |
6 | * This file may be distributed under the terms of the |
7 | * GNU General Public License. | |
8 | * | |
9 | * Written Doug Thompson <norsk5@xmission.com> | |
10 | * | |
11 | */ | |
12 | ||
e27e3dac | 13 | #include <linux/ctype.h> |
1c3631ff | 14 | #include <linux/module.h> |
e27e3dac DT |
15 | |
16 | #include "edac_core.h" | |
17 | #include "edac_module.h" | |
18 | ||
e27e3dac DT |
19 | #define EDAC_DEVICE_SYMLINK "device" |
20 | ||
21 | #define to_edacdev(k) container_of(k, struct edac_device_ctl_info, kobj) | |
22 | #define to_edacdev_attr(a) container_of(a, struct edacdev_attribute, attr) | |
23 | ||
e27e3dac DT |
24 | |
25 | /* | |
26 | * Set of edac_device_ctl_info attribute store/show functions | |
27 | */ | |
28 | ||
29 | /* 'log_ue' */ | |
079708b9 | 30 | static ssize_t edac_device_ctl_log_ue_show(struct edac_device_ctl_info |
052dfb45 | 31 | *ctl_info, char *data) |
e27e3dac | 32 | { |
079708b9 | 33 | return sprintf(data, "%u\n", ctl_info->log_ue); |
e27e3dac DT |
34 | } |
35 | ||
079708b9 | 36 | static ssize_t edac_device_ctl_log_ue_store(struct edac_device_ctl_info |
052dfb45 DT |
37 | *ctl_info, const char *data, |
38 | size_t count) | |
e27e3dac DT |
39 | { |
40 | /* if parameter is zero, turn off flag, if non-zero turn on flag */ | |
079708b9 | 41 | ctl_info->log_ue = (simple_strtoul(data, NULL, 0) != 0); |
e27e3dac | 42 | |
079708b9 | 43 | return count; |
e27e3dac DT |
44 | } |
45 | ||
46 | /* 'log_ce' */ | |
079708b9 | 47 | static ssize_t edac_device_ctl_log_ce_show(struct edac_device_ctl_info |
052dfb45 | 48 | *ctl_info, char *data) |
e27e3dac | 49 | { |
079708b9 | 50 | return sprintf(data, "%u\n", ctl_info->log_ce); |
e27e3dac DT |
51 | } |
52 | ||
079708b9 | 53 | static ssize_t edac_device_ctl_log_ce_store(struct edac_device_ctl_info |
052dfb45 DT |
54 | *ctl_info, const char *data, |
55 | size_t count) | |
e27e3dac DT |
56 | { |
57 | /* if parameter is zero, turn off flag, if non-zero turn on flag */ | |
079708b9 | 58 | ctl_info->log_ce = (simple_strtoul(data, NULL, 0) != 0); |
e27e3dac | 59 | |
079708b9 | 60 | return count; |
e27e3dac DT |
61 | } |
62 | ||
e27e3dac | 63 | /* 'panic_on_ue' */ |
079708b9 DT |
64 | static ssize_t edac_device_ctl_panic_on_ue_show(struct edac_device_ctl_info |
65 | *ctl_info, char *data) | |
e27e3dac | 66 | { |
079708b9 | 67 | return sprintf(data, "%u\n", ctl_info->panic_on_ue); |
e27e3dac DT |
68 | } |
69 | ||
079708b9 DT |
70 | static ssize_t edac_device_ctl_panic_on_ue_store(struct edac_device_ctl_info |
71 | *ctl_info, const char *data, | |
72 | size_t count) | |
e27e3dac DT |
73 | { |
74 | /* if parameter is zero, turn off flag, if non-zero turn on flag */ | |
079708b9 | 75 | ctl_info->panic_on_ue = (simple_strtoul(data, NULL, 0) != 0); |
e27e3dac DT |
76 | |
77 | return count; | |
78 | } | |
79 | ||
80 | /* 'poll_msec' show and store functions*/ | |
079708b9 | 81 | static ssize_t edac_device_ctl_poll_msec_show(struct edac_device_ctl_info |
052dfb45 | 82 | *ctl_info, char *data) |
e27e3dac | 83 | { |
079708b9 | 84 | return sprintf(data, "%u\n", ctl_info->poll_msec); |
e27e3dac DT |
85 | } |
86 | ||
079708b9 | 87 | static ssize_t edac_device_ctl_poll_msec_store(struct edac_device_ctl_info |
052dfb45 DT |
88 | *ctl_info, const char *data, |
89 | size_t count) | |
e27e3dac DT |
90 | { |
91 | unsigned long value; | |
92 | ||
93 | /* get the value and enforce that it is non-zero, must be at least | |
94 | * one millisecond for the delay period, between scans | |
95 | * Then cancel last outstanding delay for the work request | |
96 | * and set a new one. | |
97 | */ | |
079708b9 DT |
98 | value = simple_strtoul(data, NULL, 0); |
99 | edac_device_reset_delay_period(ctl_info, value); | |
e27e3dac | 100 | |
079708b9 | 101 | return count; |
e27e3dac DT |
102 | } |
103 | ||
e27e3dac DT |
104 | /* edac_device_ctl_info specific attribute structure */ |
105 | struct ctl_info_attribute { | |
079708b9 | 106 | struct attribute attr; |
1c3631ff DT |
107 | ssize_t(*show) (struct edac_device_ctl_info *, char *); |
108 | ssize_t(*store) (struct edac_device_ctl_info *, const char *, size_t); | |
e27e3dac DT |
109 | }; |
110 | ||
111 | #define to_ctl_info(k) container_of(k, struct edac_device_ctl_info, kobj) | |
112 | #define to_ctl_info_attr(a) container_of(a,struct ctl_info_attribute,attr) | |
113 | ||
114 | /* Function to 'show' fields from the edac_dev 'ctl_info' structure */ | |
115 | static ssize_t edac_dev_ctl_info_show(struct kobject *kobj, | |
052dfb45 | 116 | struct attribute *attr, char *buffer) |
e27e3dac | 117 | { |
079708b9 DT |
118 | struct edac_device_ctl_info *edac_dev = to_ctl_info(kobj); |
119 | struct ctl_info_attribute *ctl_info_attr = to_ctl_info_attr(attr); | |
e27e3dac | 120 | |
079708b9 DT |
121 | if (ctl_info_attr->show) |
122 | return ctl_info_attr->show(edac_dev, buffer); | |
123 | return -EIO; | |
e27e3dac DT |
124 | } |
125 | ||
126 | /* Function to 'store' fields into the edac_dev 'ctl_info' structure */ | |
127 | static ssize_t edac_dev_ctl_info_store(struct kobject *kobj, | |
052dfb45 DT |
128 | struct attribute *attr, |
129 | const char *buffer, size_t count) | |
e27e3dac | 130 | { |
079708b9 DT |
131 | struct edac_device_ctl_info *edac_dev = to_ctl_info(kobj); |
132 | struct ctl_info_attribute *ctl_info_attr = to_ctl_info_attr(attr); | |
e27e3dac | 133 | |
079708b9 DT |
134 | if (ctl_info_attr->store) |
135 | return ctl_info_attr->store(edac_dev, buffer, count); | |
136 | return -EIO; | |
e27e3dac DT |
137 | } |
138 | ||
139 | /* edac_dev file operations for an 'ctl_info' */ | |
140 | static struct sysfs_ops device_ctl_info_ops = { | |
079708b9 DT |
141 | .show = edac_dev_ctl_info_show, |
142 | .store = edac_dev_ctl_info_store | |
e27e3dac DT |
143 | }; |
144 | ||
145 | #define CTL_INFO_ATTR(_name,_mode,_show,_store) \ | |
146 | static struct ctl_info_attribute attr_ctl_info_##_name = { \ | |
052dfb45 DT |
147 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
148 | .show = _show, \ | |
149 | .store = _store, \ | |
e27e3dac DT |
150 | }; |
151 | ||
e27e3dac | 152 | /* Declare the various ctl_info attributes here and their respective ops */ |
079708b9 | 153 | CTL_INFO_ATTR(log_ue, S_IRUGO | S_IWUSR, |
052dfb45 | 154 | edac_device_ctl_log_ue_show, edac_device_ctl_log_ue_store); |
079708b9 | 155 | CTL_INFO_ATTR(log_ce, S_IRUGO | S_IWUSR, |
052dfb45 | 156 | edac_device_ctl_log_ce_show, edac_device_ctl_log_ce_store); |
079708b9 | 157 | CTL_INFO_ATTR(panic_on_ue, S_IRUGO | S_IWUSR, |
052dfb45 DT |
158 | edac_device_ctl_panic_on_ue_show, |
159 | edac_device_ctl_panic_on_ue_store); | |
079708b9 | 160 | CTL_INFO_ATTR(poll_msec, S_IRUGO | S_IWUSR, |
052dfb45 | 161 | edac_device_ctl_poll_msec_show, edac_device_ctl_poll_msec_store); |
e27e3dac DT |
162 | |
163 | /* Base Attributes of the EDAC_DEVICE ECC object */ | |
164 | static struct ctl_info_attribute *device_ctrl_attr[] = { | |
165 | &attr_ctl_info_panic_on_ue, | |
166 | &attr_ctl_info_log_ue, | |
167 | &attr_ctl_info_log_ce, | |
168 | &attr_ctl_info_poll_msec, | |
169 | NULL, | |
170 | }; | |
171 | ||
1c3631ff DT |
172 | /* |
173 | * edac_device_ctrl_master_release | |
174 | * | |
175 | * called when the reference count for the 'main' kobj | |
176 | * for a edac_device control struct reaches zero | |
177 | * | |
178 | * Reference count model: | |
179 | * One 'main' kobject for each control structure allocated. | |
180 | * That main kobj is initially set to one AND | |
181 | * the reference count for the EDAC 'core' module is | |
182 | * bumped by one, thus added 'keep in memory' dependency. | |
183 | * | |
184 | * Each new internal kobj (in instances and blocks) then | |
185 | * bumps the 'main' kobject. | |
186 | * | |
187 | * When they are released their release functions decrement | |
188 | * the 'main' kobj. | |
189 | * | |
190 | * When the main kobj reaches zero (0) then THIS function | |
191 | * is called which then decrements the EDAC 'core' module. | |
192 | * When the module reference count reaches zero then the | |
193 | * module no longer has dependency on keeping the release | |
194 | * function code in memory and module can be unloaded. | |
195 | * | |
196 | * This will support several control objects as well, each | |
197 | * with its own 'main' kobj. | |
198 | */ | |
e27e3dac DT |
199 | static void edac_device_ctrl_master_release(struct kobject *kobj) |
200 | { | |
1c3631ff | 201 | struct edac_device_ctl_info *edac_dev = to_edacdev(kobj); |
e27e3dac | 202 | |
1c3631ff | 203 | debugf1("%s() control index=%d\n", __func__, edac_dev->dev_idx); |
e27e3dac | 204 | |
1c3631ff DT |
205 | /* decrement the EDAC CORE module ref count */ |
206 | module_put(edac_dev->owner); | |
207 | ||
208 | /* free the control struct containing the 'main' kobj | |
209 | * passed in to this routine | |
210 | */ | |
211 | kfree(edac_dev); | |
e27e3dac DT |
212 | } |
213 | ||
1c3631ff | 214 | /* ktype for the main (master) kobject */ |
e27e3dac DT |
215 | static struct kobj_type ktype_device_ctrl = { |
216 | .release = edac_device_ctrl_master_release, | |
217 | .sysfs_ops = &device_ctl_info_ops, | |
079708b9 | 218 | .default_attrs = (struct attribute **)device_ctrl_attr, |
e27e3dac DT |
219 | }; |
220 | ||
e27e3dac | 221 | /* |
1c3631ff | 222 | * edac_device_register_sysfs_main_kobj |
e27e3dac DT |
223 | * |
224 | * perform the high level setup for the new edac_device instance | |
225 | * | |
226 | * Return: 0 SUCCESS | |
227 | * !0 FAILURE | |
228 | */ | |
1c3631ff | 229 | int edac_device_register_sysfs_main_kobj(struct edac_device_ctl_info *edac_dev) |
e27e3dac | 230 | { |
e27e3dac | 231 | struct sysdev_class *edac_class; |
1c3631ff | 232 | int err; |
e27e3dac DT |
233 | |
234 | debugf1("%s()\n", __func__); | |
235 | ||
079708b9 DT |
236 | /* get the /sys/devices/system/edac reference */ |
237 | edac_class = edac_get_edac_class(); | |
238 | if (edac_class == NULL) { | |
1c3631ff DT |
239 | debugf1("%s() no edac_class error\n", __func__); |
240 | err = -ENODEV; | |
241 | goto err_out; | |
079708b9 | 242 | } |
e27e3dac DT |
243 | |
244 | /* Point to the 'edac_class' this instance 'reports' to */ | |
245 | edac_dev->edac_class = edac_class; | |
246 | ||
247 | /* Init the devices's kobject */ | |
079708b9 | 248 | memset(&edac_dev->kobj, 0, sizeof(struct kobject)); |
e27e3dac DT |
249 | edac_dev->kobj.ktype = &ktype_device_ctrl; |
250 | ||
251 | /* set this new device under the edac_class kobject */ | |
252 | edac_dev->kobj.parent = &edac_class->kset.kobj; | |
253 | ||
254 | /* generate sysfs "..../edac/<name>" */ | |
079708b9 DT |
255 | debugf1("%s() set name of kobject to: %s\n", __func__, edac_dev->name); |
256 | err = kobject_set_name(&edac_dev->kobj, "%s", edac_dev->name); | |
e27e3dac | 257 | if (err) |
1c3631ff DT |
258 | goto err_out; |
259 | ||
260 | /* Record which module 'owns' this control structure | |
261 | * and bump the ref count of the module | |
262 | */ | |
263 | edac_dev->owner = THIS_MODULE; | |
264 | ||
265 | if (!try_module_get(edac_dev->owner)) { | |
266 | err = -ENODEV; | |
267 | goto err_out; | |
268 | } | |
269 | ||
270 | /* register */ | |
e27e3dac DT |
271 | err = kobject_register(&edac_dev->kobj); |
272 | if (err) { | |
273 | debugf1("%s()Failed to register '.../edac/%s'\n", | |
079708b9 | 274 | __func__, edac_dev->name); |
1c3631ff | 275 | goto err_kobj_reg; |
e27e3dac DT |
276 | } |
277 | ||
1c3631ff DT |
278 | /* At this point, to 'free' the control struct, |
279 | * edac_device_unregister_sysfs_main_kobj() must be used | |
280 | */ | |
281 | ||
e27e3dac DT |
282 | debugf1("%s() Registered '.../edac/%s' kobject\n", |
283 | __func__, edac_dev->name); | |
284 | ||
285 | return 0; | |
1c3631ff DT |
286 | |
287 | /* Error exit stack */ | |
288 | err_kobj_reg: | |
289 | module_put(edac_dev->owner); | |
290 | ||
291 | err_out: | |
292 | return err; | |
e27e3dac DT |
293 | } |
294 | ||
295 | /* | |
1c3631ff | 296 | * edac_device_unregister_sysfs_main_kobj: |
e27e3dac DT |
297 | * the '..../edac/<name>' kobject |
298 | */ | |
1c3631ff DT |
299 | void edac_device_unregister_sysfs_main_kobj( |
300 | struct edac_device_ctl_info *edac_dev) | |
e27e3dac DT |
301 | { |
302 | debugf0("%s()\n", __func__); | |
303 | debugf1("%s() name of kobject is: %s\n", | |
304 | __func__, kobject_name(&edac_dev->kobj)); | |
305 | ||
e27e3dac DT |
306 | /* |
307 | * Unregister the edac device's kobject and | |
1c3631ff DT |
308 | * allow for reference count to reach 0 at which point |
309 | * the callback will be called to: | |
310 | * a) module_put() this module | |
311 | * b) 'kfree' the memory | |
e27e3dac DT |
312 | */ |
313 | kobject_unregister(&edac_dev->kobj); | |
e27e3dac DT |
314 | } |
315 | ||
1c3631ff | 316 | /* edac_dev -> instance information */ |
e27e3dac DT |
317 | |
318 | /* | |
319 | * Set of low-level instance attribute show functions | |
320 | */ | |
079708b9 | 321 | static ssize_t instance_ue_count_show(struct edac_device_instance *instance, |
052dfb45 | 322 | char *data) |
e27e3dac | 323 | { |
079708b9 | 324 | return sprintf(data, "%u\n", instance->counters.ue_count); |
e27e3dac DT |
325 | } |
326 | ||
079708b9 | 327 | static ssize_t instance_ce_count_show(struct edac_device_instance *instance, |
052dfb45 | 328 | char *data) |
e27e3dac | 329 | { |
079708b9 | 330 | return sprintf(data, "%u\n", instance->counters.ce_count); |
e27e3dac DT |
331 | } |
332 | ||
e27e3dac DT |
333 | #define to_instance(k) container_of(k, struct edac_device_instance, kobj) |
334 | #define to_instance_attr(a) container_of(a,struct instance_attribute,attr) | |
335 | ||
336 | /* DEVICE instance kobject release() function */ | |
337 | static void edac_device_ctrl_instance_release(struct kobject *kobj) | |
338 | { | |
339 | struct edac_device_instance *instance; | |
340 | ||
341 | debugf1("%s()\n", __func__); | |
342 | ||
1c3631ff DT |
343 | /* map from this kobj to the main control struct |
344 | * and then dec the main kobj count | |
345 | */ | |
e27e3dac | 346 | instance = to_instance(kobj); |
1c3631ff | 347 | kobject_put(&instance->ctl->kobj); |
e27e3dac DT |
348 | } |
349 | ||
e27e3dac DT |
350 | /* instance specific attribute structure */ |
351 | struct instance_attribute { | |
079708b9 | 352 | struct attribute attr; |
52490c8d DT |
353 | ssize_t(*show) (struct edac_device_instance *, char *); |
354 | ssize_t(*store) (struct edac_device_instance *, const char *, size_t); | |
e27e3dac DT |
355 | }; |
356 | ||
e27e3dac DT |
357 | /* Function to 'show' fields from the edac_dev 'instance' structure */ |
358 | static ssize_t edac_dev_instance_show(struct kobject *kobj, | |
052dfb45 | 359 | struct attribute *attr, char *buffer) |
e27e3dac | 360 | { |
079708b9 DT |
361 | struct edac_device_instance *instance = to_instance(kobj); |
362 | struct instance_attribute *instance_attr = to_instance_attr(attr); | |
e27e3dac | 363 | |
079708b9 DT |
364 | if (instance_attr->show) |
365 | return instance_attr->show(instance, buffer); | |
366 | return -EIO; | |
e27e3dac DT |
367 | } |
368 | ||
e27e3dac DT |
369 | /* Function to 'store' fields into the edac_dev 'instance' structure */ |
370 | static ssize_t edac_dev_instance_store(struct kobject *kobj, | |
052dfb45 DT |
371 | struct attribute *attr, |
372 | const char *buffer, size_t count) | |
e27e3dac | 373 | { |
079708b9 DT |
374 | struct edac_device_instance *instance = to_instance(kobj); |
375 | struct instance_attribute *instance_attr = to_instance_attr(attr); | |
e27e3dac | 376 | |
079708b9 DT |
377 | if (instance_attr->store) |
378 | return instance_attr->store(instance, buffer, count); | |
379 | return -EIO; | |
e27e3dac DT |
380 | } |
381 | ||
e27e3dac DT |
382 | /* edac_dev file operations for an 'instance' */ |
383 | static struct sysfs_ops device_instance_ops = { | |
079708b9 DT |
384 | .show = edac_dev_instance_show, |
385 | .store = edac_dev_instance_store | |
e27e3dac DT |
386 | }; |
387 | ||
388 | #define INSTANCE_ATTR(_name,_mode,_show,_store) \ | |
389 | static struct instance_attribute attr_instance_##_name = { \ | |
052dfb45 DT |
390 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
391 | .show = _show, \ | |
392 | .store = _store, \ | |
e27e3dac DT |
393 | }; |
394 | ||
395 | /* | |
396 | * Define attributes visible for the edac_device instance object | |
397 | * Each contains a pointer to a show and an optional set | |
398 | * function pointer that does the low level output/input | |
399 | */ | |
079708b9 DT |
400 | INSTANCE_ATTR(ce_count, S_IRUGO, instance_ce_count_show, NULL); |
401 | INSTANCE_ATTR(ue_count, S_IRUGO, instance_ue_count_show, NULL); | |
e27e3dac DT |
402 | |
403 | /* list of edac_dev 'instance' attributes */ | |
404 | static struct instance_attribute *device_instance_attr[] = { | |
405 | &attr_instance_ce_count, | |
406 | &attr_instance_ue_count, | |
407 | NULL, | |
408 | }; | |
409 | ||
410 | /* The 'ktype' for each edac_dev 'instance' */ | |
411 | static struct kobj_type ktype_instance_ctrl = { | |
412 | .release = edac_device_ctrl_instance_release, | |
413 | .sysfs_ops = &device_instance_ops, | |
079708b9 | 414 | .default_attrs = (struct attribute **)device_instance_attr, |
e27e3dac DT |
415 | }; |
416 | ||
1c3631ff | 417 | /* edac_dev -> instance -> block information */ |
e27e3dac DT |
418 | |
419 | /* | |
420 | * Set of low-level block attribute show functions | |
421 | */ | |
079708b9 | 422 | static ssize_t block_ue_count_show(struct edac_device_block *block, char *data) |
e27e3dac | 423 | { |
079708b9 | 424 | return sprintf(data, "%u\n", block->counters.ue_count); |
e27e3dac DT |
425 | } |
426 | ||
079708b9 | 427 | static ssize_t block_ce_count_show(struct edac_device_block *block, char *data) |
e27e3dac | 428 | { |
079708b9 | 429 | return sprintf(data, "%u\n", block->counters.ce_count); |
e27e3dac DT |
430 | } |
431 | ||
e27e3dac DT |
432 | #define to_block(k) container_of(k, struct edac_device_block, kobj) |
433 | #define to_block_attr(a) container_of(a,struct block_attribute,attr) | |
434 | ||
435 | /* DEVICE block kobject release() function */ | |
436 | static void edac_device_ctrl_block_release(struct kobject *kobj) | |
437 | { | |
438 | struct edac_device_block *block; | |
439 | ||
440 | debugf1("%s()\n", __func__); | |
441 | ||
1c3631ff | 442 | /* get the container of the kobj */ |
e27e3dac | 443 | block = to_block(kobj); |
1c3631ff DT |
444 | |
445 | /* map from 'block kobj' to 'block->instance->controller->main_kobj' | |
446 | * now 'release' the block kobject | |
447 | */ | |
448 | kobject_put(&block->instance->ctl->kobj); | |
e27e3dac DT |
449 | } |
450 | ||
451 | /* block specific attribute structure */ | |
452 | struct block_attribute { | |
079708b9 DT |
453 | struct attribute attr; |
454 | ssize_t(*show) (struct edac_device_block *, char *); | |
455 | ssize_t(*store) (struct edac_device_block *, const char *, size_t); | |
e27e3dac DT |
456 | }; |
457 | ||
458 | /* Function to 'show' fields from the edac_dev 'block' structure */ | |
459 | static ssize_t edac_dev_block_show(struct kobject *kobj, | |
052dfb45 | 460 | struct attribute *attr, char *buffer) |
e27e3dac | 461 | { |
079708b9 DT |
462 | struct edac_device_block *block = to_block(kobj); |
463 | struct block_attribute *block_attr = to_block_attr(attr); | |
e27e3dac | 464 | |
079708b9 DT |
465 | if (block_attr->show) |
466 | return block_attr->show(block, buffer); | |
467 | return -EIO; | |
e27e3dac DT |
468 | } |
469 | ||
e27e3dac DT |
470 | /* Function to 'store' fields into the edac_dev 'block' structure */ |
471 | static ssize_t edac_dev_block_store(struct kobject *kobj, | |
052dfb45 DT |
472 | struct attribute *attr, |
473 | const char *buffer, size_t count) | |
e27e3dac | 474 | { |
079708b9 DT |
475 | struct edac_device_block *block = to_block(kobj); |
476 | struct block_attribute *block_attr = to_block_attr(attr); | |
e27e3dac | 477 | |
079708b9 DT |
478 | if (block_attr->store) |
479 | return block_attr->store(block, buffer, count); | |
480 | return -EIO; | |
e27e3dac DT |
481 | } |
482 | ||
e27e3dac DT |
483 | /* edac_dev file operations for a 'block' */ |
484 | static struct sysfs_ops device_block_ops = { | |
079708b9 DT |
485 | .show = edac_dev_block_show, |
486 | .store = edac_dev_block_store | |
e27e3dac DT |
487 | }; |
488 | ||
e27e3dac DT |
489 | #define BLOCK_ATTR(_name,_mode,_show,_store) \ |
490 | static struct block_attribute attr_block_##_name = { \ | |
052dfb45 DT |
491 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
492 | .show = _show, \ | |
493 | .store = _store, \ | |
e27e3dac DT |
494 | }; |
495 | ||
079708b9 DT |
496 | BLOCK_ATTR(ce_count, S_IRUGO, block_ce_count_show, NULL); |
497 | BLOCK_ATTR(ue_count, S_IRUGO, block_ue_count_show, NULL); | |
e27e3dac DT |
498 | |
499 | /* list of edac_dev 'block' attributes */ | |
500 | static struct block_attribute *device_block_attr[] = { | |
501 | &attr_block_ce_count, | |
502 | &attr_block_ue_count, | |
503 | NULL, | |
504 | }; | |
505 | ||
506 | /* The 'ktype' for each edac_dev 'block' */ | |
507 | static struct kobj_type ktype_block_ctrl = { | |
508 | .release = edac_device_ctrl_block_release, | |
509 | .sysfs_ops = &device_block_ops, | |
079708b9 | 510 | .default_attrs = (struct attribute **)device_block_attr, |
e27e3dac DT |
511 | }; |
512 | ||
1c3631ff | 513 | /* block ctor/dtor code */ |
e27e3dac DT |
514 | |
515 | /* | |
516 | * edac_device_create_block | |
517 | */ | |
079708b9 | 518 | static int edac_device_create_block(struct edac_device_ctl_info *edac_dev, |
052dfb45 | 519 | struct edac_device_instance *instance, |
1c3631ff | 520 | struct edac_device_block *block) |
e27e3dac | 521 | { |
fd309a9d | 522 | int i; |
e27e3dac | 523 | int err; |
fd309a9d | 524 | struct edac_dev_sysfs_block_attribute *sysfs_attrib; |
1c3631ff | 525 | struct kobject *main_kobj; |
e27e3dac | 526 | |
1c3631ff DT |
527 | debugf1("%s() Instance '%s' block '%s'\n", |
528 | __func__, instance->name, block->name); | |
e27e3dac DT |
529 | |
530 | /* init this block's kobject */ | |
079708b9 | 531 | memset(&block->kobj, 0, sizeof(struct kobject)); |
e27e3dac DT |
532 | block->kobj.parent = &instance->kobj; |
533 | block->kobj.ktype = &ktype_block_ctrl; | |
1c3631ff | 534 | block->instance = instance; |
e27e3dac | 535 | |
079708b9 | 536 | err = kobject_set_name(&block->kobj, "%s", block->name); |
e27e3dac DT |
537 | if (err) |
538 | return err; | |
539 | ||
1c3631ff DT |
540 | /* bump the main kobject's reference count for this controller |
541 | * and this instance is dependant on the main | |
542 | */ | |
543 | main_kobj = kobject_get(&edac_dev->kobj); | |
544 | if (!main_kobj) { | |
545 | err = -ENODEV; | |
546 | goto err_out; | |
547 | } | |
548 | ||
549 | /* Add this block's kobject */ | |
e27e3dac DT |
550 | err = kobject_register(&block->kobj); |
551 | if (err) { | |
1c3631ff | 552 | debugf1("%s() Failed to register instance '%s'\n", |
079708b9 | 553 | __func__, block->name); |
1c3631ff DT |
554 | kobject_put(main_kobj); |
555 | err = -ENODEV; | |
556 | goto err_out; | |
e27e3dac DT |
557 | } |
558 | ||
fd309a9d DT |
559 | /* If there are driver level block attributes, then added them |
560 | * to the block kobject | |
561 | */ | |
562 | sysfs_attrib = block->block_attributes; | |
1c3631ff | 563 | if (sysfs_attrib) { |
fd309a9d DT |
564 | for (i = 0; i < block->nr_attribs; i++) { |
565 | err = sysfs_create_file(&block->kobj, | |
1c3631ff | 566 | (struct attribute *) sysfs_attrib); |
fd309a9d DT |
567 | if (err) |
568 | goto err_on_attrib; | |
569 | ||
570 | sysfs_attrib++; | |
571 | } | |
572 | } | |
573 | ||
e27e3dac | 574 | return 0; |
fd309a9d | 575 | |
1c3631ff | 576 | /* Error unwind stack */ |
fd309a9d DT |
577 | err_on_attrib: |
578 | kobject_unregister(&block->kobj); | |
579 | ||
1c3631ff | 580 | err_out: |
fd309a9d | 581 | return err; |
e27e3dac DT |
582 | } |
583 | ||
584 | /* | |
1c3631ff | 585 | * edac_device_delete_block(edac_dev,block); |
e27e3dac | 586 | */ |
079708b9 | 587 | static void edac_device_delete_block(struct edac_device_ctl_info *edac_dev, |
1c3631ff | 588 | struct edac_device_block *block) |
e27e3dac | 589 | { |
1c3631ff DT |
590 | struct edac_dev_sysfs_block_attribute *sysfs_attrib; |
591 | int i; | |
e27e3dac | 592 | |
1c3631ff DT |
593 | /* if this block has 'attributes' then we need to iterate over the list |
594 | * and 'remove' the attributes on this block | |
595 | */ | |
596 | sysfs_attrib = block->block_attributes; | |
597 | if (sysfs_attrib && block->nr_attribs) { | |
598 | for (i = 0; i < block->nr_attribs; i++) { | |
599 | sysfs_remove_file(&block->kobj, | |
600 | (struct attribute *) sysfs_attrib); | |
601 | } | |
602 | } | |
e27e3dac | 603 | |
1c3631ff DT |
604 | /* unregister this block's kobject, SEE: |
605 | * edac_device_ctrl_block_release() callback operation | |
606 | */ | |
e27e3dac | 607 | kobject_unregister(&block->kobj); |
e27e3dac DT |
608 | } |
609 | ||
1c3631ff | 610 | /* instance ctor/dtor code */ |
e27e3dac DT |
611 | |
612 | /* | |
613 | * edac_device_create_instance | |
614 | * create just one instance of an edac_device 'instance' | |
615 | */ | |
079708b9 | 616 | static int edac_device_create_instance(struct edac_device_ctl_info *edac_dev, |
052dfb45 | 617 | int idx) |
e27e3dac DT |
618 | { |
619 | int i, j; | |
620 | int err; | |
621 | struct edac_device_instance *instance; | |
1c3631ff | 622 | struct kobject *main_kobj; |
e27e3dac DT |
623 | |
624 | instance = &edac_dev->instances[idx]; | |
625 | ||
626 | /* Init the instance's kobject */ | |
079708b9 | 627 | memset(&instance->kobj, 0, sizeof(struct kobject)); |
e27e3dac DT |
628 | |
629 | /* set this new device under the edac_device main kobject */ | |
630 | instance->kobj.parent = &edac_dev->kobj; | |
631 | instance->kobj.ktype = &ktype_instance_ctrl; | |
1c3631ff | 632 | instance->ctl = edac_dev; |
e27e3dac | 633 | |
079708b9 | 634 | err = kobject_set_name(&instance->kobj, "%s", instance->name); |
e27e3dac | 635 | if (err) |
1c3631ff DT |
636 | goto err_out; |
637 | ||
638 | /* bump the main kobject's reference count for this controller | |
639 | * and this instance is dependant on the main | |
640 | */ | |
641 | main_kobj = kobject_get(&edac_dev->kobj); | |
642 | if (!main_kobj) { | |
643 | err = -ENODEV; | |
644 | goto err_out; | |
645 | } | |
e27e3dac | 646 | |
1c3631ff | 647 | /* Formally register this instance's kobject */ |
e27e3dac DT |
648 | err = kobject_register(&instance->kobj); |
649 | if (err != 0) { | |
650 | debugf2("%s() Failed to register instance '%s'\n", | |
079708b9 | 651 | __func__, instance->name); |
1c3631ff DT |
652 | kobject_put(main_kobj); |
653 | goto err_out; | |
e27e3dac DT |
654 | } |
655 | ||
656 | debugf1("%s() now register '%d' blocks for instance %d\n", | |
079708b9 | 657 | __func__, instance->nr_blocks, idx); |
e27e3dac DT |
658 | |
659 | /* register all blocks of this instance */ | |
079708b9 | 660 | for (i = 0; i < instance->nr_blocks; i++) { |
1c3631ff DT |
661 | err = edac_device_create_block(edac_dev, instance, |
662 | &instance->blocks[i]); | |
e27e3dac | 663 | if (err) { |
1c3631ff | 664 | /* If any fail, remove all previous ones */ |
52490c8d | 665 | for (j = 0; j < i; j++) |
1c3631ff DT |
666 | edac_device_delete_block(edac_dev, |
667 | &instance->blocks[j]); | |
668 | goto err_release_instance_kobj; | |
e27e3dac DT |
669 | } |
670 | } | |
671 | ||
672 | debugf1("%s() Registered instance %d '%s' kobject\n", | |
673 | __func__, idx, instance->name); | |
674 | ||
675 | return 0; | |
1c3631ff DT |
676 | |
677 | /* error unwind stack */ | |
678 | err_release_instance_kobj: | |
679 | kobject_unregister(&instance->kobj); | |
680 | ||
681 | err_out: | |
682 | return err; | |
e27e3dac DT |
683 | } |
684 | ||
685 | /* | |
686 | * edac_device_remove_instance | |
687 | * remove an edac_device instance | |
688 | */ | |
079708b9 DT |
689 | static void edac_device_delete_instance(struct edac_device_ctl_info *edac_dev, |
690 | int idx) | |
e27e3dac | 691 | { |
e27e3dac | 692 | struct edac_device_instance *instance; |
1c3631ff | 693 | int i; |
e27e3dac DT |
694 | |
695 | instance = &edac_dev->instances[idx]; | |
696 | ||
697 | /* unregister all blocks in this instance */ | |
52490c8d | 698 | for (i = 0; i < instance->nr_blocks; i++) |
1c3631ff | 699 | edac_device_delete_block(edac_dev, &instance->blocks[i]); |
e27e3dac | 700 | |
1c3631ff DT |
701 | /* unregister this instance's kobject, SEE: |
702 | * edac_device_ctrl_instance_release() for callback operation | |
703 | */ | |
e27e3dac | 704 | kobject_unregister(&instance->kobj); |
e27e3dac DT |
705 | } |
706 | ||
707 | /* | |
708 | * edac_device_create_instances | |
709 | * create the first level of 'instances' for this device | |
710 | * (ie 'cache' might have 'cache0', 'cache1', 'cache2', etc | |
711 | */ | |
712 | static int edac_device_create_instances(struct edac_device_ctl_info *edac_dev) | |
713 | { | |
714 | int i, j; | |
715 | int err; | |
716 | ||
717 | debugf0("%s()\n", __func__); | |
718 | ||
719 | /* iterate over creation of the instances */ | |
079708b9 DT |
720 | for (i = 0; i < edac_dev->nr_instances; i++) { |
721 | err = edac_device_create_instance(edac_dev, i); | |
e27e3dac DT |
722 | if (err) { |
723 | /* unwind previous instances on error */ | |
52490c8d | 724 | for (j = 0; j < i; j++) |
079708b9 | 725 | edac_device_delete_instance(edac_dev, j); |
e27e3dac DT |
726 | return err; |
727 | } | |
728 | } | |
729 | ||
730 | return 0; | |
731 | } | |
732 | ||
733 | /* | |
734 | * edac_device_delete_instances(edac_dev); | |
735 | * unregister all the kobjects of the instances | |
736 | */ | |
737 | static void edac_device_delete_instances(struct edac_device_ctl_info *edac_dev) | |
738 | { | |
739 | int i; | |
740 | ||
741 | /* iterate over creation of the instances */ | |
52490c8d | 742 | for (i = 0; i < edac_dev->nr_instances; i++) |
079708b9 | 743 | edac_device_delete_instance(edac_dev, i); |
e27e3dac DT |
744 | } |
745 | ||
1c3631ff | 746 | /* edac_dev sysfs ctor/dtor code */ |
e27e3dac | 747 | |
42a8e397 | 748 | /* |
1c3631ff | 749 | * edac_device_add_main_sysfs_attributes |
42a8e397 DT |
750 | * add some attributes to this instance's main kobject |
751 | */ | |
1c3631ff | 752 | static int edac_device_add_main_sysfs_attributes( |
42a8e397 DT |
753 | struct edac_device_ctl_info *edac_dev) |
754 | { | |
052dfb45 | 755 | struct edac_dev_sysfs_attribute *sysfs_attrib; |
1c3631ff | 756 | int err = 0; |
052dfb45 | 757 | |
052dfb45 | 758 | sysfs_attrib = edac_dev->sysfs_attributes; |
1c3631ff DT |
759 | if (sysfs_attrib) { |
760 | /* iterate over the array and create an attribute for each | |
761 | * entry in the list | |
762 | */ | |
763 | while (sysfs_attrib->attr.name != NULL) { | |
764 | err = sysfs_create_file(&edac_dev->kobj, | |
052dfb45 | 765 | (struct attribute*) sysfs_attrib); |
1c3631ff DT |
766 | if (err) |
767 | goto err_out; | |
052dfb45 | 768 | |
1c3631ff DT |
769 | sysfs_attrib++; |
770 | } | |
052dfb45 | 771 | } |
42a8e397 | 772 | |
1c3631ff DT |
773 | err_out: |
774 | return err; | |
775 | } | |
776 | ||
777 | /* | |
778 | * edac_device_remove_main_sysfs_attributes | |
779 | * remove any attributes to this instance's main kobject | |
780 | */ | |
781 | static void edac_device_remove_main_sysfs_attributes( | |
782 | struct edac_device_ctl_info *edac_dev) | |
783 | { | |
784 | struct edac_dev_sysfs_attribute *sysfs_attrib; | |
785 | ||
786 | /* if there are main attributes, defined, remove them. First, | |
787 | * point to the start of the array and iterate over it | |
788 | * removing each attribute listed from this device's instance's kobject | |
789 | */ | |
790 | sysfs_attrib = edac_dev->sysfs_attributes; | |
791 | if (sysfs_attrib) { | |
792 | while (sysfs_attrib->attr.name != NULL) { | |
793 | sysfs_remove_file(&edac_dev->kobj, | |
794 | (struct attribute *) sysfs_attrib); | |
795 | sysfs_attrib++; | |
796 | } | |
797 | } | |
42a8e397 DT |
798 | } |
799 | ||
e27e3dac DT |
800 | /* |
801 | * edac_device_create_sysfs() Constructor | |
802 | * | |
1c3631ff DT |
803 | * accept a created edac_device control structure |
804 | * and 'export' it to sysfs. The 'main' kobj should already have been | |
805 | * created. 'instance' and 'block' kobjects should be registered | |
806 | * along with any 'block' attributes from the low driver. In addition, | |
807 | * the main attributes (if any) are connected to the main kobject of | |
808 | * the control structure. | |
e27e3dac DT |
809 | * |
810 | * Return: | |
811 | * 0 Success | |
812 | * !0 Failure | |
813 | */ | |
814 | int edac_device_create_sysfs(struct edac_device_ctl_info *edac_dev) | |
815 | { | |
816 | int err; | |
079708b9 | 817 | struct kobject *edac_kobj = &edac_dev->kobj; |
e27e3dac | 818 | |
e27e3dac DT |
819 | debugf0("%s() idx=%d\n", __func__, edac_dev->dev_idx); |
820 | ||
1c3631ff DT |
821 | /* go create any main attributes callers wants */ |
822 | err = edac_device_add_main_sysfs_attributes(edac_dev); | |
823 | if (err) { | |
824 | debugf0("%s() failed to add sysfs attribs\n", __func__); | |
825 | goto err_out; | |
42a8e397 DT |
826 | } |
827 | ||
e27e3dac DT |
828 | /* create a symlink from the edac device |
829 | * to the platform 'device' being used for this | |
830 | */ | |
831 | err = sysfs_create_link(edac_kobj, | |
079708b9 | 832 | &edac_dev->dev->kobj, EDAC_DEVICE_SYMLINK); |
e27e3dac DT |
833 | if (err) { |
834 | debugf0("%s() sysfs_create_link() returned err= %d\n", | |
835 | __func__, err); | |
1c3631ff | 836 | goto err_remove_main_attribs; |
e27e3dac DT |
837 | } |
838 | ||
1c3631ff DT |
839 | /* Create the first level instance directories |
840 | * In turn, the nested blocks beneath the instances will | |
841 | * be registered as well | |
842 | */ | |
e27e3dac | 843 | err = edac_device_create_instances(edac_dev); |
1c3631ff DT |
844 | if (err) { |
845 | debugf0("%s() edac_device_create_instances() " | |
846 | "returned err= %d\n", __func__, err); | |
42a8e397 | 847 | goto err_remove_link; |
1c3631ff DT |
848 | } |
849 | ||
850 | ||
851 | debugf0("%s() calling create-instances, idx=%d\n", | |
852 | __func__, edac_dev->dev_idx); | |
e27e3dac DT |
853 | |
854 | return 0; | |
855 | ||
856 | /* Error unwind stack */ | |
42a8e397 DT |
857 | err_remove_link: |
858 | /* remove the sym link */ | |
859 | sysfs_remove_link(&edac_dev->kobj, EDAC_DEVICE_SYMLINK); | |
e27e3dac | 860 | |
1c3631ff DT |
861 | err_remove_main_attribs: |
862 | edac_device_remove_main_sysfs_attributes(edac_dev); | |
e27e3dac | 863 | |
1c3631ff | 864 | err_out: |
e27e3dac DT |
865 | return err; |
866 | } | |
867 | ||
868 | /* | |
869 | * edac_device_remove_sysfs() destructor | |
870 | * | |
1c3631ff | 871 | * given an edac_device struct, tear down the kobject resources |
e27e3dac DT |
872 | */ |
873 | void edac_device_remove_sysfs(struct edac_device_ctl_info *edac_dev) | |
874 | { | |
875 | debugf0("%s()\n", __func__); | |
876 | ||
1c3631ff DT |
877 | /* remove any main attributes for this device */ |
878 | edac_device_remove_main_sysfs_attributes(edac_dev); | |
e27e3dac | 879 | |
1c3631ff | 880 | /* remove the device sym link */ |
e27e3dac DT |
881 | sysfs_remove_link(&edac_dev->kobj, EDAC_DEVICE_SYMLINK); |
882 | ||
1c3631ff DT |
883 | /* walk the instance/block kobject tree, deconstructing it */ |
884 | edac_device_delete_instances(edac_dev); | |
e27e3dac | 885 | } |