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