most: core: Use sysfs_emit in show function callsbacks

Message ID Y6X92vLgEu7DKxLl@qemulion
State New
Headers
Series most: core: Use sysfs_emit in show function callsbacks |

Commit Message

Deepak R Varma Dec. 23, 2022, 7:13 p.m. UTC
  According to Documentation/filesystems/sysfs.rst, the show() callback
function of kobject attributes should strictly use sysfs_emit instead
of sprintf family functions.

Issue identified using the coccinelle device_attr_show.cocci script.

Signed-off-by: Deepak R Varma <drv@mailo.com>
---
 drivers/most/core.c | 61 ++++++++++++++++++++++-----------------------
 1 file changed, 30 insertions(+), 31 deletions(-)

--
2.34.1
  

Comments

Deepak R Varma Jan. 7, 2023, 8:24 p.m. UTC | #1
On Sat, Dec 24, 2022 at 12:43:30AM +0530, Deepak R Varma wrote:
> According to Documentation/filesystems/sysfs.rst, the show() callback
> function of kobject attributes should strictly use sysfs_emit instead
> of sprintf family functions.
>
> Issue identified using the coccinelle device_attr_show.cocci script.
>
> Signed-off-by: Deepak R Varma <drv@mailo.com>
> ---

Hello,
May I please request a review and comment on this patch proposal? Also, let me
know if I am missing a maintainer(s) in my request.

Thank you,
./drv

>  drivers/most/core.c | 61 ++++++++++++++++++++++-----------------------
>  1 file changed, 30 insertions(+), 31 deletions(-)
>
> diff --git a/drivers/most/core.c b/drivers/most/core.c
> index e4412c7d25b0..f9ca6a7d885c 100644
> --- a/drivers/most/core.c
> +++ b/drivers/most/core.c
> @@ -208,8 +208,8 @@ static ssize_t number_of_packet_buffers_show(struct device *dev,
>  	struct most_channel *c = to_channel(dev);
>  	unsigned int i = c->channel_id;
>
> -	return snprintf(buf, PAGE_SIZE, "%d\n",
> -			c->iface->channel_vector[i].num_buffers_packet);
> +	return sysfs_emit(buf, "%d\n",
> +			  c->iface->channel_vector[i].num_buffers_packet);
>  }
>
>  static ssize_t number_of_stream_buffers_show(struct device *dev,
> @@ -219,8 +219,8 @@ static ssize_t number_of_stream_buffers_show(struct device *dev,
>  	struct most_channel *c = to_channel(dev);
>  	unsigned int i = c->channel_id;
>
> -	return snprintf(buf, PAGE_SIZE, "%d\n",
> -			c->iface->channel_vector[i].num_buffers_streaming);
> +	return sysfs_emit(buf, "%d\n",
> +			  c->iface->channel_vector[i].num_buffers_streaming);
>  }
>
>  static ssize_t size_of_packet_buffer_show(struct device *dev,
> @@ -230,8 +230,8 @@ static ssize_t size_of_packet_buffer_show(struct device *dev,
>  	struct most_channel *c = to_channel(dev);
>  	unsigned int i = c->channel_id;
>
> -	return snprintf(buf, PAGE_SIZE, "%d\n",
> -			c->iface->channel_vector[i].buffer_size_packet);
> +	return sysfs_emit(buf, "%d\n",
> +			  c->iface->channel_vector[i].buffer_size_packet);
>  }
>
>  static ssize_t size_of_stream_buffer_show(struct device *dev,
> @@ -241,8 +241,8 @@ static ssize_t size_of_stream_buffer_show(struct device *dev,
>  	struct most_channel *c = to_channel(dev);
>  	unsigned int i = c->channel_id;
>
> -	return snprintf(buf, PAGE_SIZE, "%d\n",
> -			c->iface->channel_vector[i].buffer_size_streaming);
> +	return sysfs_emit(buf, "%d\n",
> +			  c->iface->channel_vector[i].buffer_size_streaming);
>  }
>
>  static ssize_t channel_starving_show(struct device *dev,
> @@ -251,7 +251,7 @@ static ssize_t channel_starving_show(struct device *dev,
>  {
>  	struct most_channel *c = to_channel(dev);
>
> -	return snprintf(buf, PAGE_SIZE, "%d\n", c->is_starving);
> +	return sysfs_emit(buf, "%d\n", c->is_starving);
>  }
>
>  static ssize_t set_number_of_buffers_show(struct device *dev,
> @@ -260,7 +260,7 @@ static ssize_t set_number_of_buffers_show(struct device *dev,
>  {
>  	struct most_channel *c = to_channel(dev);
>
> -	return snprintf(buf, PAGE_SIZE, "%d\n", c->cfg.num_buffers);
> +	return sysfs_emit(buf, "%d\n", c->cfg.num_buffers);
>  }
>
>  static ssize_t set_buffer_size_show(struct device *dev,
> @@ -269,7 +269,7 @@ static ssize_t set_buffer_size_show(struct device *dev,
>  {
>  	struct most_channel *c = to_channel(dev);
>
> -	return snprintf(buf, PAGE_SIZE, "%d\n", c->cfg.buffer_size);
> +	return sysfs_emit(buf, "%d\n", c->cfg.buffer_size);
>  }
>
>  static ssize_t set_direction_show(struct device *dev,
> @@ -279,10 +279,10 @@ static ssize_t set_direction_show(struct device *dev,
>  	struct most_channel *c = to_channel(dev);
>
>  	if (c->cfg.direction & MOST_CH_TX)
> -		return snprintf(buf, PAGE_SIZE, "tx\n");
> +		return sysfs_emit(buf, "tx\n");
>  	else if (c->cfg.direction & MOST_CH_RX)
> -		return snprintf(buf, PAGE_SIZE, "rx\n");
> -	return snprintf(buf, PAGE_SIZE, "unconfigured\n");
> +		return sysfs_emit(buf, "rx\n");
> +	return sysfs_emit(buf, "unconfigured\n");
>  }
>
>  static ssize_t set_datatype_show(struct device *dev,
> @@ -294,10 +294,9 @@ static ssize_t set_datatype_show(struct device *dev,
>
>  	for (i = 0; i < ARRAY_SIZE(ch_data_type); i++) {
>  		if (c->cfg.data_type & ch_data_type[i].most_ch_data_type)
> -			return snprintf(buf, PAGE_SIZE, "%s",
> -					ch_data_type[i].name);
> +			return sysfs_emit(buf, "%s", ch_data_type[i].name);
>  	}
> -	return snprintf(buf, PAGE_SIZE, "unconfigured\n");
> +	return sysfs_emit(buf, "unconfigured\n");
>  }
>
>  static ssize_t set_subbuffer_size_show(struct device *dev,
> @@ -306,7 +305,7 @@ static ssize_t set_subbuffer_size_show(struct device *dev,
>  {
>  	struct most_channel *c = to_channel(dev);
>
> -	return snprintf(buf, PAGE_SIZE, "%d\n", c->cfg.subbuffer_size);
> +	return sysfs_emit(buf, "%d\n", c->cfg.subbuffer_size);
>  }
>
>  static ssize_t set_packets_per_xact_show(struct device *dev,
> @@ -315,7 +314,7 @@ static ssize_t set_packets_per_xact_show(struct device *dev,
>  {
>  	struct most_channel *c = to_channel(dev);
>
> -	return snprintf(buf, PAGE_SIZE, "%d\n", c->cfg.packets_per_xact);
> +	return sysfs_emit(buf, "%d\n", c->cfg.packets_per_xact);
>  }
>
>  static ssize_t set_dbr_size_show(struct device *dev,
> @@ -323,7 +322,7 @@ static ssize_t set_dbr_size_show(struct device *dev,
>  {
>  	struct most_channel *c = to_channel(dev);
>
> -	return snprintf(buf, PAGE_SIZE, "%d\n", c->cfg.dbr_size);
> +	return sysfs_emit(buf, "%d\n", c->cfg.dbr_size);
>  }
>
>  #define to_dev_attr(a) container_of(a, struct device_attribute, attr)
> @@ -395,7 +394,7 @@ static ssize_t description_show(struct device *dev,
>  {
>  	struct most_interface *iface = dev_get_drvdata(dev);
>
> -	return snprintf(buf, PAGE_SIZE, "%s\n", iface->description);
> +	return sysfs_emit(buf, "%s\n", iface->description);
>  }
>
>  static ssize_t interface_show(struct device *dev,
> @@ -406,25 +405,25 @@ static ssize_t interface_show(struct device *dev,
>
>  	switch (iface->interface) {
>  	case ITYPE_LOOPBACK:
> -		return snprintf(buf, PAGE_SIZE, "loopback\n");
> +		return sysfs_emit(buf, "loopback\n");
>  	case ITYPE_I2C:
> -		return snprintf(buf, PAGE_SIZE, "i2c\n");
> +		return sysfs_emit(buf, "i2c\n");
>  	case ITYPE_I2S:
> -		return snprintf(buf, PAGE_SIZE, "i2s\n");
> +		return sysfs_emit(buf, "i2s\n");
>  	case ITYPE_TSI:
> -		return snprintf(buf, PAGE_SIZE, "tsi\n");
> +		return sysfs_emit(buf, "tsi\n");
>  	case ITYPE_HBI:
> -		return snprintf(buf, PAGE_SIZE, "hbi\n");
> +		return sysfs_emit(buf, "hbi\n");
>  	case ITYPE_MEDIALB_DIM:
> -		return snprintf(buf, PAGE_SIZE, "mlb_dim\n");
> +		return sysfs_emit(buf, "mlb_dim\n");
>  	case ITYPE_MEDIALB_DIM2:
> -		return snprintf(buf, PAGE_SIZE, "mlb_dim2\n");
> +		return sysfs_emit(buf, "mlb_dim2\n");
>  	case ITYPE_USB:
> -		return snprintf(buf, PAGE_SIZE, "usb\n");
> +		return sysfs_emit(buf, "usb\n");
>  	case ITYPE_PCIE:
> -		return snprintf(buf, PAGE_SIZE, "pcie\n");
> +		return sysfs_emit(buf, "pcie\n");
>  	}
> -	return snprintf(buf, PAGE_SIZE, "unknown\n");
> +	return sysfs_emit(buf, "unknown\n");
>  }
>
>  static DEVICE_ATTR_RO(description);
> --
> 2.34.1
>
  

Patch

diff --git a/drivers/most/core.c b/drivers/most/core.c
index e4412c7d25b0..f9ca6a7d885c 100644
--- a/drivers/most/core.c
+++ b/drivers/most/core.c
@@ -208,8 +208,8 @@  static ssize_t number_of_packet_buffers_show(struct device *dev,
 	struct most_channel *c = to_channel(dev);
 	unsigned int i = c->channel_id;

-	return snprintf(buf, PAGE_SIZE, "%d\n",
-			c->iface->channel_vector[i].num_buffers_packet);
+	return sysfs_emit(buf, "%d\n",
+			  c->iface->channel_vector[i].num_buffers_packet);
 }

 static ssize_t number_of_stream_buffers_show(struct device *dev,
@@ -219,8 +219,8 @@  static ssize_t number_of_stream_buffers_show(struct device *dev,
 	struct most_channel *c = to_channel(dev);
 	unsigned int i = c->channel_id;

-	return snprintf(buf, PAGE_SIZE, "%d\n",
-			c->iface->channel_vector[i].num_buffers_streaming);
+	return sysfs_emit(buf, "%d\n",
+			  c->iface->channel_vector[i].num_buffers_streaming);
 }

 static ssize_t size_of_packet_buffer_show(struct device *dev,
@@ -230,8 +230,8 @@  static ssize_t size_of_packet_buffer_show(struct device *dev,
 	struct most_channel *c = to_channel(dev);
 	unsigned int i = c->channel_id;

-	return snprintf(buf, PAGE_SIZE, "%d\n",
-			c->iface->channel_vector[i].buffer_size_packet);
+	return sysfs_emit(buf, "%d\n",
+			  c->iface->channel_vector[i].buffer_size_packet);
 }

 static ssize_t size_of_stream_buffer_show(struct device *dev,
@@ -241,8 +241,8 @@  static ssize_t size_of_stream_buffer_show(struct device *dev,
 	struct most_channel *c = to_channel(dev);
 	unsigned int i = c->channel_id;

-	return snprintf(buf, PAGE_SIZE, "%d\n",
-			c->iface->channel_vector[i].buffer_size_streaming);
+	return sysfs_emit(buf, "%d\n",
+			  c->iface->channel_vector[i].buffer_size_streaming);
 }

 static ssize_t channel_starving_show(struct device *dev,
@@ -251,7 +251,7 @@  static ssize_t channel_starving_show(struct device *dev,
 {
 	struct most_channel *c = to_channel(dev);

-	return snprintf(buf, PAGE_SIZE, "%d\n", c->is_starving);
+	return sysfs_emit(buf, "%d\n", c->is_starving);
 }

 static ssize_t set_number_of_buffers_show(struct device *dev,
@@ -260,7 +260,7 @@  static ssize_t set_number_of_buffers_show(struct device *dev,
 {
 	struct most_channel *c = to_channel(dev);

-	return snprintf(buf, PAGE_SIZE, "%d\n", c->cfg.num_buffers);
+	return sysfs_emit(buf, "%d\n", c->cfg.num_buffers);
 }

 static ssize_t set_buffer_size_show(struct device *dev,
@@ -269,7 +269,7 @@  static ssize_t set_buffer_size_show(struct device *dev,
 {
 	struct most_channel *c = to_channel(dev);

-	return snprintf(buf, PAGE_SIZE, "%d\n", c->cfg.buffer_size);
+	return sysfs_emit(buf, "%d\n", c->cfg.buffer_size);
 }

 static ssize_t set_direction_show(struct device *dev,
@@ -279,10 +279,10 @@  static ssize_t set_direction_show(struct device *dev,
 	struct most_channel *c = to_channel(dev);

 	if (c->cfg.direction & MOST_CH_TX)
-		return snprintf(buf, PAGE_SIZE, "tx\n");
+		return sysfs_emit(buf, "tx\n");
 	else if (c->cfg.direction & MOST_CH_RX)
-		return snprintf(buf, PAGE_SIZE, "rx\n");
-	return snprintf(buf, PAGE_SIZE, "unconfigured\n");
+		return sysfs_emit(buf, "rx\n");
+	return sysfs_emit(buf, "unconfigured\n");
 }

 static ssize_t set_datatype_show(struct device *dev,
@@ -294,10 +294,9 @@  static ssize_t set_datatype_show(struct device *dev,

 	for (i = 0; i < ARRAY_SIZE(ch_data_type); i++) {
 		if (c->cfg.data_type & ch_data_type[i].most_ch_data_type)
-			return snprintf(buf, PAGE_SIZE, "%s",
-					ch_data_type[i].name);
+			return sysfs_emit(buf, "%s", ch_data_type[i].name);
 	}
-	return snprintf(buf, PAGE_SIZE, "unconfigured\n");
+	return sysfs_emit(buf, "unconfigured\n");
 }

 static ssize_t set_subbuffer_size_show(struct device *dev,
@@ -306,7 +305,7 @@  static ssize_t set_subbuffer_size_show(struct device *dev,
 {
 	struct most_channel *c = to_channel(dev);

-	return snprintf(buf, PAGE_SIZE, "%d\n", c->cfg.subbuffer_size);
+	return sysfs_emit(buf, "%d\n", c->cfg.subbuffer_size);
 }

 static ssize_t set_packets_per_xact_show(struct device *dev,
@@ -315,7 +314,7 @@  static ssize_t set_packets_per_xact_show(struct device *dev,
 {
 	struct most_channel *c = to_channel(dev);

-	return snprintf(buf, PAGE_SIZE, "%d\n", c->cfg.packets_per_xact);
+	return sysfs_emit(buf, "%d\n", c->cfg.packets_per_xact);
 }

 static ssize_t set_dbr_size_show(struct device *dev,
@@ -323,7 +322,7 @@  static ssize_t set_dbr_size_show(struct device *dev,
 {
 	struct most_channel *c = to_channel(dev);

-	return snprintf(buf, PAGE_SIZE, "%d\n", c->cfg.dbr_size);
+	return sysfs_emit(buf, "%d\n", c->cfg.dbr_size);
 }

 #define to_dev_attr(a) container_of(a, struct device_attribute, attr)
@@ -395,7 +394,7 @@  static ssize_t description_show(struct device *dev,
 {
 	struct most_interface *iface = dev_get_drvdata(dev);

-	return snprintf(buf, PAGE_SIZE, "%s\n", iface->description);
+	return sysfs_emit(buf, "%s\n", iface->description);
 }

 static ssize_t interface_show(struct device *dev,
@@ -406,25 +405,25 @@  static ssize_t interface_show(struct device *dev,

 	switch (iface->interface) {
 	case ITYPE_LOOPBACK:
-		return snprintf(buf, PAGE_SIZE, "loopback\n");
+		return sysfs_emit(buf, "loopback\n");
 	case ITYPE_I2C:
-		return snprintf(buf, PAGE_SIZE, "i2c\n");
+		return sysfs_emit(buf, "i2c\n");
 	case ITYPE_I2S:
-		return snprintf(buf, PAGE_SIZE, "i2s\n");
+		return sysfs_emit(buf, "i2s\n");
 	case ITYPE_TSI:
-		return snprintf(buf, PAGE_SIZE, "tsi\n");
+		return sysfs_emit(buf, "tsi\n");
 	case ITYPE_HBI:
-		return snprintf(buf, PAGE_SIZE, "hbi\n");
+		return sysfs_emit(buf, "hbi\n");
 	case ITYPE_MEDIALB_DIM:
-		return snprintf(buf, PAGE_SIZE, "mlb_dim\n");
+		return sysfs_emit(buf, "mlb_dim\n");
 	case ITYPE_MEDIALB_DIM2:
-		return snprintf(buf, PAGE_SIZE, "mlb_dim2\n");
+		return sysfs_emit(buf, "mlb_dim2\n");
 	case ITYPE_USB:
-		return snprintf(buf, PAGE_SIZE, "usb\n");
+		return sysfs_emit(buf, "usb\n");
 	case ITYPE_PCIE:
-		return snprintf(buf, PAGE_SIZE, "pcie\n");
+		return sysfs_emit(buf, "pcie\n");
 	}
-	return snprintf(buf, PAGE_SIZE, "unknown\n");
+	return sysfs_emit(buf, "unknown\n");
 }

 static DEVICE_ATTR_RO(description);