blob: 1705271653749ba8ae1a9918dbf68c69b9f122cf [file] [log] [blame]
Douglas Thompsone27e3da2007-07-19 01:49:36 -07001/*
Kay Sieversfe5ff8b2011-12-14 15:21:07 -08002 * file for managing the edac_device subsystem of devices for EDAC
Douglas Thompsone27e3da2007-07-19 01:49:36 -07003 *
Justin P. Mattock631dd1a2010-10-18 11:03:14 +02004 * (C) 2007 SoftwareBitMaker
Douglas Thompson1c3631f2007-07-19 01:50:29 -07005 *
Douglas Thompsone27e3da2007-07-19 01:49:36 -07006 * 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
Douglas Thompsone27e3da2007-07-19 01:49:36 -070013#include <linux/ctype.h>
Douglas Thompson1c3631f2007-07-19 01:50:29 -070014#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090015#include <linux/slab.h>
Borislav Petkov30e1f7a2010-09-02 17:26:48 +020016#include <linux/edac.h>
Douglas Thompsone27e3da2007-07-19 01:49:36 -070017
18#include "edac_core.h"
19#include "edac_module.h"
20
Douglas Thompsone27e3da2007-07-19 01:49:36 -070021#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
Douglas Thompsone27e3da2007-07-19 01:49:36 -070026
27/*
28 * Set of edac_device_ctl_info attribute store/show functions
29 */
30
31/* 'log_ue' */
Douglas Thompson079708b2007-07-19 01:49:58 -070032static ssize_t edac_device_ctl_log_ue_show(struct edac_device_ctl_info
Douglas Thompson052dfb42007-07-19 01:50:13 -070033 *ctl_info, char *data)
Douglas Thompsone27e3da2007-07-19 01:49:36 -070034{
Douglas Thompson079708b2007-07-19 01:49:58 -070035 return sprintf(data, "%u\n", ctl_info->log_ue);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070036}
37
Douglas Thompson079708b2007-07-19 01:49:58 -070038static ssize_t edac_device_ctl_log_ue_store(struct edac_device_ctl_info
Douglas Thompson052dfb42007-07-19 01:50:13 -070039 *ctl_info, const char *data,
40 size_t count)
Douglas Thompsone27e3da2007-07-19 01:49:36 -070041{
42 /* if parameter is zero, turn off flag, if non-zero turn on flag */
Douglas Thompson079708b2007-07-19 01:49:58 -070043 ctl_info->log_ue = (simple_strtoul(data, NULL, 0) != 0);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070044
Douglas Thompson079708b2007-07-19 01:49:58 -070045 return count;
Douglas Thompsone27e3da2007-07-19 01:49:36 -070046}
47
48/* 'log_ce' */
Douglas Thompson079708b2007-07-19 01:49:58 -070049static ssize_t edac_device_ctl_log_ce_show(struct edac_device_ctl_info
Douglas Thompson052dfb42007-07-19 01:50:13 -070050 *ctl_info, char *data)
Douglas Thompsone27e3da2007-07-19 01:49:36 -070051{
Douglas Thompson079708b2007-07-19 01:49:58 -070052 return sprintf(data, "%u\n", ctl_info->log_ce);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070053}
54
Douglas Thompson079708b2007-07-19 01:49:58 -070055static ssize_t edac_device_ctl_log_ce_store(struct edac_device_ctl_info
Douglas Thompson052dfb42007-07-19 01:50:13 -070056 *ctl_info, const char *data,
57 size_t count)
Douglas Thompsone27e3da2007-07-19 01:49:36 -070058{
59 /* if parameter is zero, turn off flag, if non-zero turn on flag */
Douglas Thompson079708b2007-07-19 01:49:58 -070060 ctl_info->log_ce = (simple_strtoul(data, NULL, 0) != 0);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070061
Douglas Thompson079708b2007-07-19 01:49:58 -070062 return count;
Douglas Thompsone27e3da2007-07-19 01:49:36 -070063}
64
Douglas Thompsone27e3da2007-07-19 01:49:36 -070065/* 'panic_on_ue' */
Douglas Thompson079708b2007-07-19 01:49:58 -070066static ssize_t edac_device_ctl_panic_on_ue_show(struct edac_device_ctl_info
67 *ctl_info, char *data)
Douglas Thompsone27e3da2007-07-19 01:49:36 -070068{
Douglas Thompson079708b2007-07-19 01:49:58 -070069 return sprintf(data, "%u\n", ctl_info->panic_on_ue);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070070}
71
Douglas Thompson079708b2007-07-19 01:49:58 -070072static ssize_t edac_device_ctl_panic_on_ue_store(struct edac_device_ctl_info
73 *ctl_info, const char *data,
74 size_t count)
Douglas Thompsone27e3da2007-07-19 01:49:36 -070075{
76 /* if parameter is zero, turn off flag, if non-zero turn on flag */
Douglas Thompson079708b2007-07-19 01:49:58 -070077 ctl_info->panic_on_ue = (simple_strtoul(data, NULL, 0) != 0);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070078
79 return count;
80}
81
82/* 'poll_msec' show and store functions*/
Douglas Thompson079708b2007-07-19 01:49:58 -070083static ssize_t edac_device_ctl_poll_msec_show(struct edac_device_ctl_info
Douglas Thompson052dfb42007-07-19 01:50:13 -070084 *ctl_info, char *data)
Douglas Thompsone27e3da2007-07-19 01:49:36 -070085{
Douglas Thompson079708b2007-07-19 01:49:58 -070086 return sprintf(data, "%u\n", ctl_info->poll_msec);
Douglas Thompsone27e3da2007-07-19 01:49:36 -070087}
88
Douglas Thompson079708b2007-07-19 01:49:58 -070089static ssize_t edac_device_ctl_poll_msec_store(struct edac_device_ctl_info
Douglas Thompson052dfb42007-07-19 01:50:13 -070090 *ctl_info, const char *data,
91 size_t count)
Douglas Thompsone27e3da2007-07-19 01:49:36 -070092{
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 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700100 value = simple_strtoul(data, NULL, 0);
101 edac_device_reset_delay_period(ctl_info, value);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700102
Douglas Thompson079708b2007-07-19 01:49:58 -0700103 return count;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700104}
105
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700106/* edac_device_ctl_info specific attribute structure */
107struct ctl_info_attribute {
Douglas Thompson079708b2007-07-19 01:49:58 -0700108 struct attribute attr;
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700109 ssize_t(*show) (struct edac_device_ctl_info *, char *);
110 ssize_t(*store) (struct edac_device_ctl_info *, const char *, size_t);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700111};
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 */
117static ssize_t edac_dev_ctl_info_show(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700118 struct attribute *attr, char *buffer)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700119{
Douglas Thompson079708b2007-07-19 01:49:58 -0700120 struct edac_device_ctl_info *edac_dev = to_ctl_info(kobj);
121 struct ctl_info_attribute *ctl_info_attr = to_ctl_info_attr(attr);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700122
Douglas Thompson079708b2007-07-19 01:49:58 -0700123 if (ctl_info_attr->show)
124 return ctl_info_attr->show(edac_dev, buffer);
125 return -EIO;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700126}
127
128/* Function to 'store' fields into the edac_dev 'ctl_info' structure */
129static ssize_t edac_dev_ctl_info_store(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700130 struct attribute *attr,
131 const char *buffer, size_t count)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700132{
Douglas Thompson079708b2007-07-19 01:49:58 -0700133 struct edac_device_ctl_info *edac_dev = to_ctl_info(kobj);
134 struct ctl_info_attribute *ctl_info_attr = to_ctl_info_attr(attr);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700135
Douglas Thompson079708b2007-07-19 01:49:58 -0700136 if (ctl_info_attr->store)
137 return ctl_info_attr->store(edac_dev, buffer, count);
138 return -EIO;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700139}
140
141/* edac_dev file operations for an 'ctl_info' */
Emese Revfy52cf25d2010-01-19 02:58:23 +0100142static const struct sysfs_ops device_ctl_info_ops = {
Douglas Thompson079708b2007-07-19 01:49:58 -0700143 .show = edac_dev_ctl_info_show,
144 .store = edac_dev_ctl_info_store
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700145};
146
147#define CTL_INFO_ATTR(_name,_mode,_show,_store) \
148static struct ctl_info_attribute attr_ctl_info_##_name = { \
Douglas Thompson052dfb42007-07-19 01:50:13 -0700149 .attr = {.name = __stringify(_name), .mode = _mode }, \
150 .show = _show, \
151 .store = _store, \
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700152};
153
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700154/* Declare the various ctl_info attributes here and their respective ops */
Douglas Thompson079708b2007-07-19 01:49:58 -0700155CTL_INFO_ATTR(log_ue, S_IRUGO | S_IWUSR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700156 edac_device_ctl_log_ue_show, edac_device_ctl_log_ue_store);
Douglas Thompson079708b2007-07-19 01:49:58 -0700157CTL_INFO_ATTR(log_ce, S_IRUGO | S_IWUSR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700158 edac_device_ctl_log_ce_show, edac_device_ctl_log_ce_store);
Douglas Thompson079708b2007-07-19 01:49:58 -0700159CTL_INFO_ATTR(panic_on_ue, S_IRUGO | S_IWUSR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700160 edac_device_ctl_panic_on_ue_show,
161 edac_device_ctl_panic_on_ue_store);
Douglas Thompson079708b2007-07-19 01:49:58 -0700162CTL_INFO_ATTR(poll_msec, S_IRUGO | S_IWUSR,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700163 edac_device_ctl_poll_msec_show, edac_device_ctl_poll_msec_store);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700164
165/* Base Attributes of the EDAC_DEVICE ECC object */
166static 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
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700174/*
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 */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700201static void edac_device_ctrl_master_release(struct kobject *kobj)
202{
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700203 struct edac_device_ctl_info *edac_dev = to_edacdev(kobj);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700204
Joe Perches956b9ba12012-04-29 17:08:39 -0300205 edac_dbg(4, "control index=%d\n", edac_dev->dev_idx);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700206
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700207 /* 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);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700214}
215
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700216/* ktype for the main (master) kobject */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700217static struct kobj_type ktype_device_ctrl = {
218 .release = edac_device_ctrl_master_release,
219 .sysfs_ops = &device_ctl_info_ops,
Douglas Thompson079708b2007-07-19 01:49:58 -0700220 .default_attrs = (struct attribute **)device_ctrl_attr,
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700221};
222
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700223/*
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700224 * edac_device_register_sysfs_main_kobj
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700225 *
226 * perform the high level setup for the new edac_device instance
227 *
228 * Return: 0 SUCCESS
229 * !0 FAILURE
230 */
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700231int edac_device_register_sysfs_main_kobj(struct edac_device_ctl_info *edac_dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700232{
Kay Sieversfe5ff8b2011-12-14 15:21:07 -0800233 struct bus_type *edac_subsys;
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700234 int err;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700235
Joe Perches956b9ba12012-04-29 17:08:39 -0300236 edac_dbg(1, "\n");
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700237
Douglas Thompson079708b2007-07-19 01:49:58 -0700238 /* get the /sys/devices/system/edac reference */
Kay Sieversfe5ff8b2011-12-14 15:21:07 -0800239 edac_subsys = edac_get_sysfs_subsys();
240 if (edac_subsys == NULL) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300241 edac_dbg(1, "no edac_subsys error\n");
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700242 err = -ENODEV;
243 goto err_out;
Douglas Thompson079708b2007-07-19 01:49:58 -0700244 }
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700245
Kay Sieversfe5ff8b2011-12-14 15:21:07 -0800246 /* Point to the 'edac_subsys' this instance 'reports' to */
247 edac_dev->edac_subsys = edac_subsys;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700248
249 /* Init the devices's kobject */
Douglas Thompson079708b2007-07-19 01:49:58 -0700250 memset(&edac_dev->kobj, 0, sizeof(struct kobject));
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700251
252 /* Record which module 'owns' this control structure
253 * and bump the ref count of the module
254 */
255 edac_dev->owner = THIS_MODULE;
256
257 if (!try_module_get(edac_dev->owner)) {
258 err = -ENODEV;
Borislav Petkov733476c2015-11-27 11:40:43 +0100259 goto err_out;
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700260 }
261
262 /* register */
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400263 err = kobject_init_and_add(&edac_dev->kobj, &ktype_device_ctrl,
Kay Sieversfe5ff8b2011-12-14 15:21:07 -0800264 &edac_subsys->dev_root->kobj,
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400265 "%s", edac_dev->name);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700266 if (err) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300267 edac_dbg(1, "Failed to register '.../edac/%s'\n",
268 edac_dev->name);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700269 goto err_kobj_reg;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700270 }
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400271 kobject_uevent(&edac_dev->kobj, KOBJ_ADD);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700272
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700273 /* At this point, to 'free' the control struct,
274 * edac_device_unregister_sysfs_main_kobj() must be used
275 */
276
Joe Perches956b9ba12012-04-29 17:08:39 -0300277 edac_dbg(4, "Registered '.../edac/%s' kobject\n", edac_dev->name);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700278
279 return 0;
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700280
281 /* Error exit stack */
282err_kobj_reg:
283 module_put(edac_dev->owner);
284
285err_out:
286 return err;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700287}
288
289/*
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700290 * edac_device_unregister_sysfs_main_kobj:
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700291 * the '..../edac/<name>' kobject
292 */
Borislav Petkov30e1f7a2010-09-02 17:26:48 +0200293void edac_device_unregister_sysfs_main_kobj(struct edac_device_ctl_info *dev)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700294{
Joe Perches956b9ba12012-04-29 17:08:39 -0300295 edac_dbg(0, "\n");
296 edac_dbg(4, "name of kobject is: %s\n", kobject_name(&dev->kobj));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700297
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700298 /*
299 * Unregister the edac device's kobject and
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700300 * allow for reference count to reach 0 at which point
301 * the callback will be called to:
302 * a) module_put() this module
303 * b) 'kfree' the memory
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700304 */
Borislav Petkov30e1f7a2010-09-02 17:26:48 +0200305 kobject_put(&dev->kobj);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700306}
307
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700308/* edac_dev -> instance information */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700309
310/*
311 * Set of low-level instance attribute show functions
312 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700313static ssize_t instance_ue_count_show(struct edac_device_instance *instance,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700314 char *data)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700315{
Douglas Thompson079708b2007-07-19 01:49:58 -0700316 return sprintf(data, "%u\n", instance->counters.ue_count);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700317}
318
Douglas Thompson079708b2007-07-19 01:49:58 -0700319static ssize_t instance_ce_count_show(struct edac_device_instance *instance,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700320 char *data)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700321{
Douglas Thompson079708b2007-07-19 01:49:58 -0700322 return sprintf(data, "%u\n", instance->counters.ce_count);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700323}
324
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700325#define to_instance(k) container_of(k, struct edac_device_instance, kobj)
326#define to_instance_attr(a) container_of(a,struct instance_attribute,attr)
327
328/* DEVICE instance kobject release() function */
329static void edac_device_ctrl_instance_release(struct kobject *kobj)
330{
331 struct edac_device_instance *instance;
332
Joe Perches956b9ba12012-04-29 17:08:39 -0300333 edac_dbg(1, "\n");
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700334
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700335 /* map from this kobj to the main control struct
336 * and then dec the main kobj count
337 */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700338 instance = to_instance(kobj);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700339 kobject_put(&instance->ctl->kobj);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700340}
341
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700342/* instance specific attribute structure */
343struct instance_attribute {
Douglas Thompson079708b2007-07-19 01:49:58 -0700344 struct attribute attr;
Douglas Thompson52490c82007-07-19 01:50:20 -0700345 ssize_t(*show) (struct edac_device_instance *, char *);
346 ssize_t(*store) (struct edac_device_instance *, const char *, size_t);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700347};
348
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700349/* Function to 'show' fields from the edac_dev 'instance' structure */
350static ssize_t edac_dev_instance_show(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700351 struct attribute *attr, char *buffer)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700352{
Douglas Thompson079708b2007-07-19 01:49:58 -0700353 struct edac_device_instance *instance = to_instance(kobj);
354 struct instance_attribute *instance_attr = to_instance_attr(attr);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700355
Douglas Thompson079708b2007-07-19 01:49:58 -0700356 if (instance_attr->show)
357 return instance_attr->show(instance, buffer);
358 return -EIO;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700359}
360
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700361/* Function to 'store' fields into the edac_dev 'instance' structure */
362static ssize_t edac_dev_instance_store(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700363 struct attribute *attr,
364 const char *buffer, size_t count)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700365{
Douglas Thompson079708b2007-07-19 01:49:58 -0700366 struct edac_device_instance *instance = to_instance(kobj);
367 struct instance_attribute *instance_attr = to_instance_attr(attr);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700368
Douglas Thompson079708b2007-07-19 01:49:58 -0700369 if (instance_attr->store)
370 return instance_attr->store(instance, buffer, count);
371 return -EIO;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700372}
373
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700374/* edac_dev file operations for an 'instance' */
Emese Revfy52cf25d2010-01-19 02:58:23 +0100375static const struct sysfs_ops device_instance_ops = {
Douglas Thompson079708b2007-07-19 01:49:58 -0700376 .show = edac_dev_instance_show,
377 .store = edac_dev_instance_store
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700378};
379
380#define INSTANCE_ATTR(_name,_mode,_show,_store) \
381static struct instance_attribute attr_instance_##_name = { \
Douglas Thompson052dfb42007-07-19 01:50:13 -0700382 .attr = {.name = __stringify(_name), .mode = _mode }, \
383 .show = _show, \
384 .store = _store, \
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700385};
386
387/*
388 * Define attributes visible for the edac_device instance object
389 * Each contains a pointer to a show and an optional set
390 * function pointer that does the low level output/input
391 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700392INSTANCE_ATTR(ce_count, S_IRUGO, instance_ce_count_show, NULL);
393INSTANCE_ATTR(ue_count, S_IRUGO, instance_ue_count_show, NULL);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700394
395/* list of edac_dev 'instance' attributes */
396static struct instance_attribute *device_instance_attr[] = {
397 &attr_instance_ce_count,
398 &attr_instance_ue_count,
399 NULL,
400};
401
402/* The 'ktype' for each edac_dev 'instance' */
403static struct kobj_type ktype_instance_ctrl = {
404 .release = edac_device_ctrl_instance_release,
405 .sysfs_ops = &device_instance_ops,
Douglas Thompson079708b2007-07-19 01:49:58 -0700406 .default_attrs = (struct attribute **)device_instance_attr,
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700407};
408
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700409/* edac_dev -> instance -> block information */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700410
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700411#define to_block(k) container_of(k, struct edac_device_block, kobj)
412#define to_block_attr(a) \
413 container_of(a, struct edac_dev_sysfs_block_attribute, attr)
414
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700415/*
416 * Set of low-level block attribute show functions
417 */
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700418static ssize_t block_ue_count_show(struct kobject *kobj,
419 struct attribute *attr, char *data)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700420{
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700421 struct edac_device_block *block = to_block(kobj);
422
Douglas Thompson079708b2007-07-19 01:49:58 -0700423 return sprintf(data, "%u\n", block->counters.ue_count);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700424}
425
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700426static ssize_t block_ce_count_show(struct kobject *kobj,
427 struct attribute *attr, char *data)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700428{
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700429 struct edac_device_block *block = to_block(kobj);
430
Douglas Thompson079708b2007-07-19 01:49:58 -0700431 return sprintf(data, "%u\n", block->counters.ce_count);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700432}
433
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700434/* DEVICE block kobject release() function */
435static void edac_device_ctrl_block_release(struct kobject *kobj)
436{
437 struct edac_device_block *block;
438
Joe Perches956b9ba12012-04-29 17:08:39 -0300439 edac_dbg(1, "\n");
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700440
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700441 /* get the container of the kobj */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700442 block = to_block(kobj);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700443
444 /* map from 'block kobj' to 'block->instance->controller->main_kobj'
445 * now 'release' the block kobject
446 */
447 kobject_put(&block->instance->ctl->kobj);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700448}
449
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700450
451/* Function to 'show' fields from the edac_dev 'block' structure */
452static ssize_t edac_dev_block_show(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700453 struct attribute *attr, char *buffer)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700454{
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700455 struct edac_dev_sysfs_block_attribute *block_attr =
456 to_block_attr(attr);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700457
Douglas Thompson079708b2007-07-19 01:49:58 -0700458 if (block_attr->show)
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700459 return block_attr->show(kobj, attr, buffer);
Douglas Thompson079708b2007-07-19 01:49:58 -0700460 return -EIO;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700461}
462
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700463/* Function to 'store' fields into the edac_dev 'block' structure */
464static ssize_t edac_dev_block_store(struct kobject *kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700465 struct attribute *attr,
466 const char *buffer, size_t count)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700467{
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700468 struct edac_dev_sysfs_block_attribute *block_attr;
469
470 block_attr = to_block_attr(attr);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700471
Douglas Thompson079708b2007-07-19 01:49:58 -0700472 if (block_attr->store)
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700473 return block_attr->store(kobj, attr, buffer, count);
Douglas Thompson079708b2007-07-19 01:49:58 -0700474 return -EIO;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700475}
476
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700477/* edac_dev file operations for a 'block' */
Emese Revfy52cf25d2010-01-19 02:58:23 +0100478static const struct sysfs_ops device_block_ops = {
Douglas Thompson079708b2007-07-19 01:49:58 -0700479 .show = edac_dev_block_show,
480 .store = edac_dev_block_store
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700481};
482
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700483#define BLOCK_ATTR(_name,_mode,_show,_store) \
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700484static struct edac_dev_sysfs_block_attribute attr_block_##_name = { \
Douglas Thompson052dfb42007-07-19 01:50:13 -0700485 .attr = {.name = __stringify(_name), .mode = _mode }, \
486 .show = _show, \
487 .store = _store, \
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700488};
489
Douglas Thompson079708b2007-07-19 01:49:58 -0700490BLOCK_ATTR(ce_count, S_IRUGO, block_ce_count_show, NULL);
491BLOCK_ATTR(ue_count, S_IRUGO, block_ue_count_show, NULL);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700492
493/* list of edac_dev 'block' attributes */
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700494static struct edac_dev_sysfs_block_attribute *device_block_attr[] = {
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700495 &attr_block_ce_count,
496 &attr_block_ue_count,
497 NULL,
498};
499
500/* The 'ktype' for each edac_dev 'block' */
501static struct kobj_type ktype_block_ctrl = {
502 .release = edac_device_ctrl_block_release,
503 .sysfs_ops = &device_block_ops,
Douglas Thompson079708b2007-07-19 01:49:58 -0700504 .default_attrs = (struct attribute **)device_block_attr,
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700505};
506
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700507/* block ctor/dtor code */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700508
509/*
510 * edac_device_create_block
511 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700512static int edac_device_create_block(struct edac_device_ctl_info *edac_dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700513 struct edac_device_instance *instance,
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700514 struct edac_device_block *block)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700515{
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700516 int i;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700517 int err;
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700518 struct edac_dev_sysfs_block_attribute *sysfs_attrib;
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700519 struct kobject *main_kobj;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700520
Joe Perches956b9ba12012-04-29 17:08:39 -0300521 edac_dbg(4, "Instance '%s' inst_p=%p block '%s' block_p=%p\n",
522 instance->name, instance, block->name, block);
523 edac_dbg(4, "block kobj=%p block kobj->parent=%p\n",
524 &block->kobj, &block->kobj.parent);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700525
526 /* init this block's kobject */
Douglas Thompson079708b2007-07-19 01:49:58 -0700527 memset(&block->kobj, 0, sizeof(struct kobject));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700528
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700529 /* bump the main kobject's reference count for this controller
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300530 * and this instance is dependent on the main
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700531 */
532 main_kobj = kobject_get(&edac_dev->kobj);
533 if (!main_kobj) {
534 err = -ENODEV;
535 goto err_out;
536 }
537
538 /* Add this block's kobject */
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400539 err = kobject_init_and_add(&block->kobj, &ktype_block_ctrl,
540 &instance->kobj,
541 "%s", block->name);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700542 if (err) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300543 edac_dbg(1, "Failed to register instance '%s'\n", block->name);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700544 kobject_put(main_kobj);
545 err = -ENODEV;
546 goto err_out;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700547 }
548
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700549 /* If there are driver level block attributes, then added them
550 * to the block kobject
551 */
552 sysfs_attrib = block->block_attributes;
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700553 if (sysfs_attrib && block->nr_attribs) {
554 for (i = 0; i < block->nr_attribs; i++, sysfs_attrib++) {
555
Joe Perches956b9ba12012-04-29 17:08:39 -0300556 edac_dbg(4, "creating block attrib='%s' attrib->%p to kobj=%p\n",
557 sysfs_attrib->attr.name,
558 sysfs_attrib, &block->kobj);
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700559
560 /* Create each block_attribute file */
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700561 err = sysfs_create_file(&block->kobj,
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700562 &sysfs_attrib->attr);
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700563 if (err)
564 goto err_on_attrib;
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700565 }
566 }
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400567 kobject_uevent(&block->kobj, KOBJ_ADD);
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700568
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700569 return 0;
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700570
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700571 /* Error unwind stack */
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700572err_on_attrib:
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800573 kobject_put(&block->kobj);
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700574
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700575err_out:
Douglas Thompsonfd309a9d2007-07-19 01:50:25 -0700576 return err;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700577}
578
579/*
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700580 * edac_device_delete_block(edac_dev,block);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700581 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700582static void edac_device_delete_block(struct edac_device_ctl_info *edac_dev,
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700583 struct edac_device_block *block)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700584{
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700585 struct edac_dev_sysfs_block_attribute *sysfs_attrib;
586 int i;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700587
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700588 /* if this block has 'attributes' then we need to iterate over the list
589 * and 'remove' the attributes on this block
590 */
591 sysfs_attrib = block->block_attributes;
592 if (sysfs_attrib && block->nr_attribs) {
Doug Thompsonb2a4ac02007-07-19 01:50:33 -0700593 for (i = 0; i < block->nr_attribs; i++, sysfs_attrib++) {
594
595 /* remove each block_attrib file */
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700596 sysfs_remove_file(&block->kobj,
597 (struct attribute *) sysfs_attrib);
598 }
599 }
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700600
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700601 /* unregister this block's kobject, SEE:
602 * edac_device_ctrl_block_release() callback operation
603 */
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800604 kobject_put(&block->kobj);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700605}
606
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700607/* instance ctor/dtor code */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700608
609/*
610 * edac_device_create_instance
611 * create just one instance of an edac_device 'instance'
612 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700613static int edac_device_create_instance(struct edac_device_ctl_info *edac_dev,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700614 int idx)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700615{
616 int i, j;
617 int err;
618 struct edac_device_instance *instance;
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700619 struct kobject *main_kobj;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700620
621 instance = &edac_dev->instances[idx];
622
623 /* Init the instance's kobject */
Douglas Thompson079708b2007-07-19 01:49:58 -0700624 memset(&instance->kobj, 0, sizeof(struct kobject));
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700625
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700626 instance->ctl = edac_dev;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700627
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700628 /* bump the main kobject's reference count for this controller
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300629 * and this instance is dependent on the main
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700630 */
631 main_kobj = kobject_get(&edac_dev->kobj);
632 if (!main_kobj) {
633 err = -ENODEV;
634 goto err_out;
635 }
636
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400637 /* Formally register this instance's kobject under the edac_device */
638 err = kobject_init_and_add(&instance->kobj, &ktype_instance_ctrl,
639 &edac_dev->kobj, "%s", instance->name);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700640 if (err != 0) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300641 edac_dbg(2, "Failed to register instance '%s'\n",
642 instance->name);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700643 kobject_put(main_kobj);
644 goto err_out;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700645 }
646
Joe Perches956b9ba12012-04-29 17:08:39 -0300647 edac_dbg(4, "now register '%d' blocks for instance %d\n",
648 instance->nr_blocks, idx);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700649
650 /* register all blocks of this instance */
Douglas Thompson079708b2007-07-19 01:49:58 -0700651 for (i = 0; i < instance->nr_blocks; i++) {
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700652 err = edac_device_create_block(edac_dev, instance,
653 &instance->blocks[i]);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700654 if (err) {
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700655 /* If any fail, remove all previous ones */
Douglas Thompson52490c82007-07-19 01:50:20 -0700656 for (j = 0; j < i; j++)
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700657 edac_device_delete_block(edac_dev,
658 &instance->blocks[j]);
659 goto err_release_instance_kobj;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700660 }
661 }
Greg Kroah-Hartmanb2ed2152007-12-17 15:54:39 -0400662 kobject_uevent(&instance->kobj, KOBJ_ADD);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700663
Joe Perches956b9ba12012-04-29 17:08:39 -0300664 edac_dbg(4, "Registered instance %d '%s' kobject\n",
665 idx, instance->name);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700666
667 return 0;
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700668
669 /* error unwind stack */
670err_release_instance_kobj:
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800671 kobject_put(&instance->kobj);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700672
673err_out:
674 return err;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700675}
676
677/*
678 * edac_device_remove_instance
679 * remove an edac_device instance
680 */
Douglas Thompson079708b2007-07-19 01:49:58 -0700681static void edac_device_delete_instance(struct edac_device_ctl_info *edac_dev,
682 int idx)
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700683{
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700684 struct edac_device_instance *instance;
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700685 int i;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700686
687 instance = &edac_dev->instances[idx];
688
689 /* unregister all blocks in this instance */
Douglas Thompson52490c82007-07-19 01:50:20 -0700690 for (i = 0; i < instance->nr_blocks; i++)
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700691 edac_device_delete_block(edac_dev, &instance->blocks[i]);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700692
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700693 /* unregister this instance's kobject, SEE:
694 * edac_device_ctrl_instance_release() for callback operation
695 */
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800696 kobject_put(&instance->kobj);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700697}
698
699/*
700 * edac_device_create_instances
701 * create the first level of 'instances' for this device
702 * (ie 'cache' might have 'cache0', 'cache1', 'cache2', etc
703 */
704static int edac_device_create_instances(struct edac_device_ctl_info *edac_dev)
705{
706 int i, j;
707 int err;
708
Joe Perches956b9ba12012-04-29 17:08:39 -0300709 edac_dbg(0, "\n");
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700710
711 /* iterate over creation of the instances */
Douglas Thompson079708b2007-07-19 01:49:58 -0700712 for (i = 0; i < edac_dev->nr_instances; i++) {
713 err = edac_device_create_instance(edac_dev, i);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700714 if (err) {
715 /* unwind previous instances on error */
Douglas Thompson52490c82007-07-19 01:50:20 -0700716 for (j = 0; j < i; j++)
Douglas Thompson079708b2007-07-19 01:49:58 -0700717 edac_device_delete_instance(edac_dev, j);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700718 return err;
719 }
720 }
721
722 return 0;
723}
724
725/*
726 * edac_device_delete_instances(edac_dev);
727 * unregister all the kobjects of the instances
728 */
729static void edac_device_delete_instances(struct edac_device_ctl_info *edac_dev)
730{
731 int i;
732
733 /* iterate over creation of the instances */
Douglas Thompson52490c82007-07-19 01:50:20 -0700734 for (i = 0; i < edac_dev->nr_instances; i++)
Douglas Thompson079708b2007-07-19 01:49:58 -0700735 edac_device_delete_instance(edac_dev, i);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700736}
737
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700738/* edac_dev sysfs ctor/dtor code */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700739
740/*
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700741 * edac_device_add_main_sysfs_attributes
Douglas Thompson42a8e392007-07-19 01:50:10 -0700742 * add some attributes to this instance's main kobject
743 */
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700744static int edac_device_add_main_sysfs_attributes(
Douglas Thompson42a8e392007-07-19 01:50:10 -0700745 struct edac_device_ctl_info *edac_dev)
746{
Douglas Thompson052dfb42007-07-19 01:50:13 -0700747 struct edac_dev_sysfs_attribute *sysfs_attrib;
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700748 int err = 0;
Douglas Thompson42a8e392007-07-19 01:50:10 -0700749
Douglas Thompson052dfb42007-07-19 01:50:13 -0700750 sysfs_attrib = edac_dev->sysfs_attributes;
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700751 if (sysfs_attrib) {
752 /* iterate over the array and create an attribute for each
753 * entry in the list
754 */
755 while (sysfs_attrib->attr.name != NULL) {
756 err = sysfs_create_file(&edac_dev->kobj,
Douglas Thompson052dfb42007-07-19 01:50:13 -0700757 (struct attribute*) sysfs_attrib);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700758 if (err)
759 goto err_out;
Douglas Thompson42a8e392007-07-19 01:50:10 -0700760
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700761 sysfs_attrib++;
762 }
Douglas Thompson052dfb42007-07-19 01:50:13 -0700763 }
Douglas Thompson42a8e392007-07-19 01:50:10 -0700764
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700765err_out:
766 return err;
767}
768
769/*
770 * edac_device_remove_main_sysfs_attributes
771 * remove any attributes to this instance's main kobject
772 */
773static void edac_device_remove_main_sysfs_attributes(
774 struct edac_device_ctl_info *edac_dev)
775{
776 struct edac_dev_sysfs_attribute *sysfs_attrib;
777
778 /* if there are main attributes, defined, remove them. First,
779 * point to the start of the array and iterate over it
780 * removing each attribute listed from this device's instance's kobject
781 */
782 sysfs_attrib = edac_dev->sysfs_attributes;
783 if (sysfs_attrib) {
784 while (sysfs_attrib->attr.name != NULL) {
785 sysfs_remove_file(&edac_dev->kobj,
786 (struct attribute *) sysfs_attrib);
787 sysfs_attrib++;
788 }
789 }
Douglas Thompson42a8e392007-07-19 01:50:10 -0700790}
791
792/*
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700793 * edac_device_create_sysfs() Constructor
794 *
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700795 * accept a created edac_device control structure
796 * and 'export' it to sysfs. The 'main' kobj should already have been
797 * created. 'instance' and 'block' kobjects should be registered
798 * along with any 'block' attributes from the low driver. In addition,
799 * the main attributes (if any) are connected to the main kobject of
800 * the control structure.
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700801 *
802 * Return:
803 * 0 Success
804 * !0 Failure
805 */
806int edac_device_create_sysfs(struct edac_device_ctl_info *edac_dev)
807{
808 int err;
Douglas Thompson079708b2007-07-19 01:49:58 -0700809 struct kobject *edac_kobj = &edac_dev->kobj;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700810
Joe Perches956b9ba12012-04-29 17:08:39 -0300811 edac_dbg(0, "idx=%d\n", edac_dev->dev_idx);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700812
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700813 /* go create any main attributes callers wants */
814 err = edac_device_add_main_sysfs_attributes(edac_dev);
815 if (err) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300816 edac_dbg(0, "failed to add sysfs attribs\n");
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700817 goto err_out;
Douglas Thompson42a8e392007-07-19 01:50:10 -0700818 }
819
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700820 /* create a symlink from the edac device
821 * to the platform 'device' being used for this
822 */
823 err = sysfs_create_link(edac_kobj,
Douglas Thompson079708b2007-07-19 01:49:58 -0700824 &edac_dev->dev->kobj, EDAC_DEVICE_SYMLINK);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700825 if (err) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300826 edac_dbg(0, "sysfs_create_link() returned err= %d\n", err);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700827 goto err_remove_main_attribs;
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700828 }
829
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700830 /* Create the first level instance directories
831 * In turn, the nested blocks beneath the instances will
832 * be registered as well
833 */
834 err = edac_device_create_instances(edac_dev);
835 if (err) {
Joe Perches956b9ba12012-04-29 17:08:39 -0300836 edac_dbg(0, "edac_device_create_instances() returned err= %d\n",
837 err);
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700838 goto err_remove_link;
839 }
840
841
Joe Perches956b9ba12012-04-29 17:08:39 -0300842 edac_dbg(4, "create-instances done, idx=%d\n", edac_dev->dev_idx);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700843
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700844 return 0;
845
846 /* Error unwind stack */
Douglas Thompson42a8e392007-07-19 01:50:10 -0700847err_remove_link:
848 /* remove the sym link */
849 sysfs_remove_link(&edac_dev->kobj, EDAC_DEVICE_SYMLINK);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700850
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700851err_remove_main_attribs:
852 edac_device_remove_main_sysfs_attributes(edac_dev);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700853
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700854err_out:
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700855 return err;
856}
857
858/*
859 * edac_device_remove_sysfs() destructor
860 *
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700861 * given an edac_device struct, tear down the kobject resources
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700862 */
863void edac_device_remove_sysfs(struct edac_device_ctl_info *edac_dev)
864{
Joe Perches956b9ba12012-04-29 17:08:39 -0300865 edac_dbg(0, "\n");
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700866
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700867 /* remove any main attributes for this device */
868 edac_device_remove_main_sysfs_attributes(edac_dev);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700869
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700870 /* remove the device sym link */
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700871 sysfs_remove_link(&edac_dev->kobj, EDAC_DEVICE_SYMLINK);
872
Douglas Thompson1c3631f2007-07-19 01:50:29 -0700873 /* walk the instance/block kobject tree, deconstructing it */
874 edac_device_delete_instances(edac_dev);
Douglas Thompsone27e3da2007-07-19 01:49:36 -0700875}