[PATCH 1/3] HID: roccat: Convert snprintf() to sysfs_emit()

[PATCH 1/3] HID: roccat: Convert snprintf() to sysfs_emit()

[Jules Irenge]

Coccinnelle reports a warning
Warning: Use scnprintf or sprintf

Following the advice on kernel documentation
https://www.kernel.org/doc/html/latest/filesystems/sysfs.html

For show(device *...) functions we should only use sysfs_emit() or sysfs_emit_at()
especially when formatting the value to be returned to user space.

Convert snprintf() to sysfs_emit()

Signed-off-by: Jules Irenge <jules.irenge@postgrad.manchester.ac.uk>
---
 drivers/hid/hid-roccat-kone.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/drivers/hid/hid-roccat-kone.c b/drivers/hid/hid-roccat-kone.c
index 76da04801ca9..f0c35c05e702 100644
--- a/drivers/hid/hid-roccat-kone.c
+++ b/drivers/hid/hid-roccat-kone.c
@@ -403,7 +403,7 @@ static ssize_t kone_sysfs_show_actual_profile(struct device *dev,
 {
 	struct kone_device *kone =
 			hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
-	return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_profile);
+	return sysfs_emit(buf, "%d\n", kone->actual_profile);
 }
 static DEVICE_ATTR(actual_profile, 0440, kone_sysfs_show_actual_profile, NULL);
 
@@ -412,7 +412,7 @@ static ssize_t kone_sysfs_show_actual_dpi(struct device *dev,
 {
 	struct kone_device *kone =
 			hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
-	return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_dpi);
+	return sysfs_emit(buf, "%d\n", kone->actual_dpi);
 }
 static DEVICE_ATTR(actual_dpi, 0440, kone_sysfs_show_actual_dpi, NULL);
 
@@ -435,7 +435,7 @@ static ssize_t kone_sysfs_show_weight(struct device *dev,
 
 	if (retval)
 		return retval;
-	return snprintf(buf, PAGE_SIZE, "%d\n", weight);
+	return sysfs_emit(buf, "%d\n", weight);
 }
 static DEVICE_ATTR(weight, 0440, kone_sysfs_show_weight, NULL);
 
@@ -444,7 +444,7 @@ static ssize_t kone_sysfs_show_firmware_version(struct device *dev,
 {
 	struct kone_device *kone =
 			hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
-	return snprintf(buf, PAGE_SIZE, "%d\n", kone->firmware_version);
+	return sysfs_emit(buf, "%d\n", kone->firmware_version);
 }
 static DEVICE_ATTR(firmware_version, 0440, kone_sysfs_show_firmware_version,
 		   NULL);
@@ -454,7 +454,7 @@ static ssize_t kone_sysfs_show_tcu(struct device *dev,
 {
 	struct kone_device *kone =
 			hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
-	return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.tcu);
+	return sysfs_emit(buf, "%d\n", kone->settings.tcu);
 }
 
 static int kone_tcu_command(struct usb_device *usb_dev, int number)
@@ -556,7 +556,7 @@ static ssize_t kone_sysfs_show_startup_profile(struct device *dev,
 {
 	struct kone_device *kone =
 			hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
-	return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.startup_profile);
+	return sysfs_emit(buf, "%d\n", kone->settings.startup_profile);
 }
 
 static ssize_t kone_sysfs_set_startup_profile(struct device *dev,
-- 
2.37.3

Re: [PATCH 1/3] HID: roccat: Convert snprintf() to sysfs_emit()

[Benjamin Tissoires]

Hi Jules,

On Sat, Oct 8, 2022 at 9:11 PM Jules Irenge <jbi.octave@gmail.com> wrote:
>
> Coccinnelle reports a warning
> Warning: Use scnprintf or sprintf
>
> Following the advice on kernel documentation
> https://www.kernel.org/doc/html/latest/filesystems/sysfs.html
>
> For show(device *...) functions we should only use sysfs_emit() or sysfs_emit_at()
> especially when formatting the value to be returned to user space.
>
> Convert snprintf() to sysfs_emit()
>
> Signed-off-by: Jules Irenge <jules.irenge@postgrad.manchester.ac.uk>

Thanks for the submission, however I see that you sent 5 different
patches with the exact same commit messages, touching 4 different
files.
I suspect 3/3 and 2/2 are the same, so I am a little bit puzzled...

Would you mind sending a v2 with everything squashed into just one
patch targeting all of hid-roccat-*?

I think I'll empty the queue regarding all of those sysfs_emit
conversions in 6.2.

But please be aware that I can not apply anything 6.2 related right
now, we are in the merge window of 6.1 and I can not push anything to
for-next that is 6.2.

Cheers,
Benjamin

> ---
>  drivers/hid/hid-roccat-kone.c | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/drivers/hid/hid-roccat-kone.c b/drivers/hid/hid-roccat-kone.c
> index 76da04801ca9..f0c35c05e702 100644
> --- a/drivers/hid/hid-roccat-kone.c
> +++ b/drivers/hid/hid-roccat-kone.c
> @@ -403,7 +403,7 @@ static ssize_t kone_sysfs_show_actual_profile(struct device *dev,
>  {
>         struct kone_device *kone =
>                         hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
> -       return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_profile);
> +       return sysfs_emit(buf, "%d\n", kone->actual_profile);
>  }
>  static DEVICE_ATTR(actual_profile, 0440, kone_sysfs_show_actual_profile, NULL);
>
> @@ -412,7 +412,7 @@ static ssize_t kone_sysfs_show_actual_dpi(struct device *dev,
>  {
>         struct kone_device *kone =
>                         hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
> -       return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_dpi);
> +       return sysfs_emit(buf, "%d\n", kone->actual_dpi);
>  }
>  static DEVICE_ATTR(actual_dpi, 0440, kone_sysfs_show_actual_dpi, NULL);
>
> @@ -435,7 +435,7 @@ static ssize_t kone_sysfs_show_weight(struct device *dev,
>
>         if (retval)
>                 return retval;
> -       return snprintf(buf, PAGE_SIZE, "%d\n", weight);
> +       return sysfs_emit(buf, "%d\n", weight);
>  }
>  static DEVICE_ATTR(weight, 0440, kone_sysfs_show_weight, NULL);
>
> @@ -444,7 +444,7 @@ static ssize_t kone_sysfs_show_firmware_version(struct device *dev,
>  {
>         struct kone_device *kone =
>                         hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
> -       return snprintf(buf, PAGE_SIZE, "%d\n", kone->firmware_version);
> +       return sysfs_emit(buf, "%d\n", kone->firmware_version);
>  }
>  static DEVICE_ATTR(firmware_version, 0440, kone_sysfs_show_firmware_version,
>                    NULL);
> @@ -454,7 +454,7 @@ static ssize_t kone_sysfs_show_tcu(struct device *dev,
>  {
>         struct kone_device *kone =
>                         hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
> -       return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.tcu);
> +       return sysfs_emit(buf, "%d\n", kone->settings.tcu);
>  }
>
>  static int kone_tcu_command(struct usb_device *usb_dev, int number)
> @@ -556,7 +556,7 @@ static ssize_t kone_sysfs_show_startup_profile(struct device *dev,
>  {
>         struct kone_device *kone =
>                         hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
> -       return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.startup_profile);
> +       return sysfs_emit(buf, "%d\n", kone->settings.startup_profile);
>  }
>
>  static ssize_t kone_sysfs_set_startup_profile(struct device *dev,
> --
> 2.37.3
>