Skip to contentSkip to conversation

staging: fbtft: convert sysfs attributes to use attribute_group

PATCH In review Harshit Shaw 3 participants 3 messages May 12

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 staging: fbtft: convert sysfs attributes to use attribute_group

Replace direct device_create_file() and device_remove_file() calls with the correct attribute_group API using sysfs_create_group() and sysfs_remove_group(). This is the proper way to register sysfs attributes in kernel drivers.

---
 drivers/staging/fbtft/fbtft-sysfs.c | 83 ++++++++++++++++++-----------
 1 file changed, 52 insertions(+), 31 deletions(-)
drivers/staging/fbtft/fbtft-sysfs.c +52 -31
index d05599d80011..8d3c4e49b68e 100644
@@ -142,9 +142,30 @@ static ssize_t show_gamma_curve(struct device *device,
 	return sprintf_gamma(par, par->gamma.curves, buf);
 }
 
-static struct device_attribute gamma_device_attrs[] = {
-	__ATTR(gamma, 0660, show_gamma_curve, store_gamma_curve),
-};
+static ssize_t store_debug(struct device *device,
+			   struct device_attribute *attr,
+			   const char *buf, size_t count)
+{
+	struct fb_info *fb_info = dev_get_drvdata(device);
+	struct fbtft_par *par = fb_info->par;
+	int ret;
+
+	ret = kstrtoul(buf, 10, &par->debug);
+	if (ret)
+		return ret;
+	fbtft_expand_debug_value(&par->debug);
+
+	return count;
+}
+
+static ssize_t show_debug(struct device *device,
+			  struct device_attribute *attr, char *buf)
+{
+	struct fb_info *fb_info = dev_get_drvdata(device);
+	struct fbtft_par *par = fb_info->par;
+
+	return sysfs_emit(buf, "%lu\n", par->debug);
+}
 
 void fbtft_expand_debug_value(unsigned long *debug)
 {
@@ -173,45 +194,45 @@ void fbtft_expand_debug_value(unsigned long *debug)
 	}
 }
 
-static ssize_t store_debug(struct device *device,
-			   struct device_attribute *attr,
-			   const char *buf, size_t count)
-{
-	struct fb_info *fb_info = dev_get_drvdata(device);
-	struct fbtft_par *par = fb_info->par;
-	int ret;
-
-	ret = kstrtoul(buf, 10, &par->debug);
-	if (ret)
-		return ret;
-	fbtft_expand_debug_value(&par->debug);
+static DEVICE_ATTR(gamma, 0644, show_gamma_curve, store_gamma_curve);
+static DEVICE_ATTR(debug, 0644, show_debug, store_debug);
 
-	return count;
-}
+static struct attribute *fbtft_attrs[] = {
+	&dev_attr_debug.attr,
+	NULL,
+};
 
-static ssize_t show_debug(struct device *device,
-			  struct device_attribute *attr, char *buf)
-{
-	struct fb_info *fb_info = dev_get_drvdata(device);
-	struct fbtft_par *par = fb_info->par;
+static struct attribute *fbtft_gamma_attrs[] = {
+	&dev_attr_gamma.attr,
+	NULL,
+};
 
-	return sysfs_emit(buf, "%lu\n", par->debug);
-}
+static const struct attribute_group fbtft_attr_group = {
+	.attrs = fbtft_attrs,
+};
 
-static struct device_attribute debug_device_attr =
-	__ATTR(debug, 0660, show_debug, store_debug);
+static const struct attribute_group fbtft_gamma_attr_group = {
+	.attrs = fbtft_gamma_attrs,
+};
 
 void fbtft_sysfs_init(struct fbtft_par *par)
 {
 	struct device *dev;
+	int ret;
 
 	dev = dev_of_fbinfo(par->info);
 	if (!dev)
 		return;
 
-	device_create_file(dev, &debug_device_attr);
-	if (par->gamma.curves && par->fbtftops.set_gamma)
-		device_create_file(dev, &gamma_device_attrs[0]);
+	ret = sysfs_create_group(&dev->kobj, &fbtft_attr_group);
+	if (ret)
+		dev_warn(dev, "failed to create debug sysfs entry\n");
+
+	if (par->gamma.curves && par->fbtftops.set_gamma) {
+		ret = sysfs_create_group(&dev->kobj, &fbtft_gamma_attr_group);
+		if (ret)
+			dev_warn(dev, "failed to create gamma sysfs entry\n");
+	}
 }
 
 void fbtft_sysfs_exit(struct fbtft_par *par)
@@ -222,7 +243,7 @@ void fbtft_sysfs_exit(struct fbtft_par *par)
 	if (!dev)
 		return;
 
-	device_remove_file(dev, &debug_device_attr);
+	sysfs_remove_group(&dev->kobj, &fbtft_attr_group);
 	if (par->gamma.curves && par->fbtftops.set_gamma)
-		device_remove_file(dev, &gamma_device_attrs[0]);
+		sysfs_remove_group(&dev->kobj, &fbtft_gamma_attr_group);
 }
Signature · 1 line
2.53.0
maintainer
#1 lore raw
Quoted 85 lines · Harshit Shaw

Replace direct device_create_file() and device_remove_file() calls with the correct attribute_group API using sysfs_create_group() and sysfs_remove_group(). This is the proper way to register sysfs attributes in kernel drivers.

---
 drivers/staging/fbtft/fbtft-sysfs.c | 83 ++++++++++++++++++-----------
 1 file changed, 52 insertions(+), 31 deletions(-)
drivers/staging/fbtft/fbtft-sysfs.c +34 -23
index d05599d80011..8d3c4e49b68e 100644
@@ -142,9 +142,30 @@ static ssize_t show_gamma_curve(struct device *device,
 	return sprintf_gamma(par, par->gamma.curves, buf);
 }
 
-static struct device_attribute gamma_device_attrs[] = {
-	__ATTR(gamma, 0660, show_gamma_curve, store_gamma_curve),
-};
+static ssize_t store_debug(struct device *device,
+			   struct device_attribute *attr,
+			   const char *buf, size_t count)
+{
+	struct fb_info *fb_info = dev_get_drvdata(device);
+	struct fbtft_par *par = fb_info->par;
+	int ret;
+
+	ret = kstrtoul(buf, 10, &par->debug);
+	if (ret)
+		return ret;
+	fbtft_expand_debug_value(&par->debug);
+
+	return count;
+}
+
+static ssize_t show_debug(struct device *device,
+			  struct device_attribute *attr, char *buf)
+{
+	struct fb_info *fb_info = dev_get_drvdata(device);
+	struct fbtft_par *par = fb_info->par;
+
+	return sysfs_emit(buf, "%lu\n", par->debug);
+}
 
 void fbtft_expand_debug_value(unsigned long *debug)
 {
@@ -173,45 +194,45 @@ void fbtft_expand_debug_value(unsigned long *debug)
 	}
 }
 
-static ssize_t store_debug(struct device *device,
-			   struct device_attribute *attr,
-			   const char *buf, size_t count)
-{
-	struct fb_info *fb_info = dev_get_drvdata(device);
-	struct fbtft_par *par = fb_info->par;
-	int ret;
-
-	ret = kstrtoul(buf, 10, &par->debug);
-	if (ret)
-		return ret;
-	fbtft_expand_debug_value(&par->debug);
+static DEVICE_ATTR(gamma, 0644, show_gamma_curve, store_gamma_curve);
+static DEVICE_ATTR(debug, 0644, show_debug, store_debug);
 
-	return count;
-}
+static struct attribute *fbtft_attrs[] = {
+	&dev_attr_debug.attr,
+	NULL,
+};
 
-static ssize_t show_debug(struct device *device,
-			  struct device_attribute *attr, char *buf)
-{
-	struct fb_info *fb_info = dev_get_drvdata(device);
-	struct fbtft_par *par = fb_info->par;
+static struct attribute *fbtft_gamma_attrs[] = {
+	&dev_attr_gamma.attr,
+	NULL,
+};
 
-	return sysfs_emit(buf, "%lu\n", par->debug);

drivers/staging/fbtft/fbtft-sysfs.c void fbtft_expand_debug_value(unsigned long *debug) · line 216

Quoted 10 lines
drivers/staging/fbtft/fbtft-sysfs.c +6 -3
-}
+static const struct attribute_group fbtft_attr_group = {
+	.attrs = fbtft_attrs,
+};
 
-static struct device_attribute debug_device_attr =
-	__ATTR(debug, 0660, show_debug, store_debug);
+static const struct attribute_group fbtft_gamma_attr_group = {
+	.attrs = fbtft_gamma_attrs,
+};

Why not use the ATTRIBUTE_GROUPS() macro instead? That's what it is there for :)

drivers/staging/fbtft/fbtft-sysfs.c void fbtft_expand_debug_value(unsigned long *debug) · line 227

Quoted 13 lines
drivers/staging/fbtft/fbtft-sysfs.c +2 -3
 void fbtft_sysfs_init(struct fbtft_par *par)
 {
 	struct device *dev;
+	int ret;
 
 	dev = dev_of_fbinfo(par->info);
 	if (!dev)
 		return;
 
-	device_create_file(dev, &debug_device_attr);
-	if (par->gamma.curves && par->fbtftops.set_gamma)
-		device_create_file(dev, &gamma_device_attrs[0]);
+	ret = sysfs_create_group(&dev->kobj, &fbtft_attr_group);

Close, but if you ever find a driver calling a "raw" sysfs_* function, something is really wrong.

This group needs to be added to the driver itself, as a default group pointer, and then the driver core will add/remove the group automatically for you when a device is bound/unbound from the driver. No need to ever do this on its own.

thanks,

greg k-h

#2 lore raw
In reply to Harshit Shaw
Quoted 4 lines · Harshit Shaw

Replace direct device_create_file() and device_remove_file() calls with the correct attribute_group API using sysfs_create_group() and sysfs_remove_group(). This is the proper way to register sysfs attributes in kernel drivers.

...

drivers/staging/fbtft/fbtft-sysfs.c void fbtft_expand_debug_value(unsigned long *debug) · line 198

Quoted 2 lines
drivers/staging/fbtft/fbtft-sysfs.c +2 -0
+static DEVICE_ATTR(gamma, 0644, show_gamma_curve, store_gamma_curve);
+static DEVICE_ATTR(debug, 0644, show_debug, store_debug);

Move each of them closer to the used callbacks. Also there is DEVICE_ATTR_RW() macro.

...

drivers/staging/fbtft/fbtft-sysfs.c void fbtft_expand_debug_value(unsigned long *debug) · line 202

Quoted 3 lines
drivers/staging/fbtft/fbtft-sysfs.c +3 -0
+static struct attribute *fbtft_attrs[] = {
+	&dev_attr_debug.attr,
+	NULL,

Don't put trailing commas in terminator entries.

Quoted 1 line

+};

...

drivers/staging/fbtft/fbtft-sysfs.c void fbtft_expand_debug_value(unsigned long *debug) · line 207

Quoted 3 lines
drivers/staging/fbtft/fbtft-sysfs.c +3 -0
+static struct attribute *fbtft_gamma_attrs[] = {
+	&dev_attr_gamma.attr,
+	NULL,

Ditto.

Quoted 1 line

+};

...

Also these definitions should be moved closer to the related initialisers.

Signature · 2 lines
With Best Regards,
Andy Shevchenko