Skip to contentSkip to conversation

iio: core: Consolidate iio_format_avail_{list,range}()

PATCH In review Lars-Peter Clausen 2 participants 3 messages Nov 14, 2020 – Nov 28, 2020 IIO

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 iio: core: Consolidate iio_format_avail_{list,range}()

The iio_format_avail_list() and iio_format_avail_range() functions are almost identical. The only differences are that iio_format_avail_range() expects a fixed amount of items and adds brackets "[ ]" around the output.

Refactor them into a common helper function. This improves the maintainability of the code as it makes it easier to modify the implementation of these functions.

---
 drivers/iio/industrialio-core.c | 57 ++++++++-------------------------
 1 file changed, 14 insertions(+), 43 deletions(-)
drivers/iio/industrialio-core.c +14 -43
index 9955672fc16a..3e71fcab7cbd 100644
@@ -698,11 +698,13 @@ static ssize_t iio_read_channel_info(struct device *dev,
 	return iio_format_value(buf, ret, val_len, vals);
 }
 
-static ssize_t iio_format_avail_list(char *buf, const int *vals,
-				     int type, int length)
+static ssize_t iio_format_list(char *buf, const int *vals, int type, int length,
+			       const char *prefix, const char *suffix)
 {
+	ssize_t len;
 	int i;
-	ssize_t len = 0;
+
+	len = scnprintf(buf, PAGE_SIZE, prefix);
 
 	switch (type) {
 	case IIO_VAL_INT:
@@ -716,7 +718,7 @@ static ssize_t iio_format_avail_list(char *buf, const int *vals,
 						" ");
 			else
 				len += scnprintf(buf + len, PAGE_SIZE - len,
-						"\n");
+						"%s\n", suffix);
 			if (len >= PAGE_SIZE)
 				return -EFBIG;
 		}
@@ -732,7 +734,7 @@ static ssize_t iio_format_avail_list(char *buf, const int *vals,
 						" ");
 			else
 				len += scnprintf(buf + len, PAGE_SIZE - len,
-						"\n");
+						"%s\n", suffix);
 			if (len >= PAGE_SIZE)
 				return -EFBIG;
 		}
@@ -741,47 +743,16 @@ static ssize_t iio_format_avail_list(char *buf, const int *vals,
 	return len;
 }
 
-static ssize_t iio_format_avail_range(char *buf, const int *vals, int type)
+static ssize_t iio_format_avail_list(char *buf, const int *vals,
+				     int type, int length)
 {
-	int i;
-	ssize_t len;
 
-	len = snprintf(buf, PAGE_SIZE, "[");
-	switch (type) {
-	case IIO_VAL_INT:
-		for (i = 0; i < 3; i++) {
-			len += __iio_format_value(buf + len, PAGE_SIZE - len,
-						  type, 1, &vals[i]);
-			if (len >= PAGE_SIZE)
-				return -EFBIG;
-			if (i < 2)
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						" ");
-			else
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						"]\n");
-			if (len >= PAGE_SIZE)
-				return -EFBIG;
-		}
-		break;
-	default:
-		for (i = 0; i < 3; i++) {
-			len += __iio_format_value(buf + len, PAGE_SIZE - len,
-						  type, 2, &vals[i * 2]);
-			if (len >= PAGE_SIZE)
-				return -EFBIG;
-			if (i < 2)
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						" ");
-			else
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						"]\n");
-			if (len >= PAGE_SIZE)
-				return -EFBIG;
-		}
-	}
+	return iio_format_list(buf, vals, type, length, "", "");
+}
 
-	return len;
+static ssize_t iio_format_avail_range(char *buf, const int *vals, int type)
+{
+	return iio_format_list(buf, vals, type, 3, "[", "]");
 }
 
 static ssize_t iio_read_channel_info_avail(struct device *dev,
Signature · 1 line
2.20.1
#1 lore raw

PATCH 2/2 iio: core: Simplify iio_format_list()

iio_format_list() has two branches in a switch statement that are almost identical. They only differ in the stride that is used to iterate through the item list.

Consolidate this into a common code path to simplify the code.

---
 drivers/iio/industrialio-core.c | 45 +++++++++++++--------------------
 1 file changed, 18 insertions(+), 27 deletions(-)
drivers/iio/industrialio-core.c +18 -27
index 3e71fcab7cbd..0a0d27a8d996 100644
@@ -702,44 +702,35 @@ static ssize_t iio_format_list(char *buf, const int *vals, int type, int length,
 			       const char *prefix, const char *suffix)
 {
 	ssize_t len;
+	int stride;
 	int i;
 
-	len = scnprintf(buf, PAGE_SIZE, prefix);
-
 	switch (type) {
 	case IIO_VAL_INT:
-		for (i = 0; i < length; i++) {
-			len += __iio_format_value(buf + len, PAGE_SIZE - len,
-						  type, 1, &vals[i]);
-			if (len >= PAGE_SIZE)
-				return -EFBIG;
-			if (i < length - 1)
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						" ");
-			else
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						"%s\n", suffix);
-			if (len >= PAGE_SIZE)
-				return -EFBIG;
-		}
+		stride = 1;
 		break;
 	default:
-		for (i = 0; i < length / 2; i++) {
-			len += __iio_format_value(buf + len, PAGE_SIZE - len,
-						  type, 2, &vals[i * 2]);
-			if (len >= PAGE_SIZE)
-				return -EFBIG;
-			if (i < length / 2 - 1)
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						" ");
-			else
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						"%s\n", suffix);
+		stride = 2;
+		break;
+	}
+
+	len = scnprintf(buf, PAGE_SIZE, prefix);
+
+	for (i = 0; i <= length - stride; i += stride) {
+		if (i != 0) {
+			len += scnprintf(buf + len, PAGE_SIZE - len, " ");
 			if (len >= PAGE_SIZE)
 				return -EFBIG;
 		}
+
+		len += __iio_format_value(buf + len, PAGE_SIZE - len, type,
+					  stride, &vals[i]);
+		if (len >= PAGE_SIZE)
+			return -EFBIG;
 	}
 
+	len += scnprintf(buf + len, PAGE_SIZE - len, "%s\n", suffix);
+
 	return len;
 }
 
Signature · 1 line
2.20.1
maintainer
#2 lore raw
In reply to Lars-Peter Clausen
Quoted 9 lines · On Sat, 14 Nov 2020 12:59:59 +0100 Lars-Peter Clausen <[email protected]> wrote:

The iio_format_avail_list() and iio_format_avail_range() functions are almost identical. The only differences are that iio_format_avail_range() expects a fixed amount of items and adds brackets "[ ]" around the output.

Refactor them into a common helper function. This improves the maintainability of the code as it makes it easier to modify the implementation of these functions.

Nice little cleanup. Series applied to the togreg branch of iio.git and pushed out as testing for the autobuilders to poke at it.

Thanks,

Jonathan

Quoted 98 lines
---
 drivers/iio/industrialio-core.c | 57 ++++++++-------------------------
 1 file changed, 14 insertions(+), 43 deletions(-)
drivers/iio/industrialio-core.c +14 -43
index 9955672fc16a..3e71fcab7cbd 100644
@@ -698,11 +698,13 @@ static ssize_t iio_read_channel_info(struct device *dev,
 	return iio_format_value(buf, ret, val_len, vals);
 }
 
-static ssize_t iio_format_avail_list(char *buf, const int *vals,
-				     int type, int length)
+static ssize_t iio_format_list(char *buf, const int *vals, int type, int length,
+			       const char *prefix, const char *suffix)
 {
+	ssize_t len;
 	int i;
-	ssize_t len = 0;
+
+	len = scnprintf(buf, PAGE_SIZE, prefix);
 
 	switch (type) {
 	case IIO_VAL_INT:
@@ -716,7 +718,7 @@ static ssize_t iio_format_avail_list(char *buf, const int *vals,
 						" ");
 			else
 				len += scnprintf(buf + len, PAGE_SIZE - len,
-						"\n");
+						"%s\n", suffix);
 			if (len >= PAGE_SIZE)
 				return -EFBIG;
 		}
@@ -732,7 +734,7 @@ static ssize_t iio_format_avail_list(char *buf, const int *vals,
 						" ");
 			else
 				len += scnprintf(buf + len, PAGE_SIZE - len,
-						"\n");
+						"%s\n", suffix);
 			if (len >= PAGE_SIZE)
 				return -EFBIG;
 		}
@@ -741,47 +743,16 @@ static ssize_t iio_format_avail_list(char *buf, const int *vals,
 	return len;
 }
 
-static ssize_t iio_format_avail_range(char *buf, const int *vals, int type)
+static ssize_t iio_format_avail_list(char *buf, const int *vals,
+				     int type, int length)
 {
-	int i;
-	ssize_t len;
 
-	len = snprintf(buf, PAGE_SIZE, "[");
-	switch (type) {
-	case IIO_VAL_INT:
-		for (i = 0; i < 3; i++) {
-			len += __iio_format_value(buf + len, PAGE_SIZE - len,
-						  type, 1, &vals[i]);
-			if (len >= PAGE_SIZE)
-				return -EFBIG;
-			if (i < 2)
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						" ");
-			else
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						"]\n");
-			if (len >= PAGE_SIZE)
-				return -EFBIG;
-		}
-		break;
-	default:
-		for (i = 0; i < 3; i++) {
-			len += __iio_format_value(buf + len, PAGE_SIZE - len,
-						  type, 2, &vals[i * 2]);
-			if (len >= PAGE_SIZE)
-				return -EFBIG;
-			if (i < 2)
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						" ");
-			else
-				len += scnprintf(buf + len, PAGE_SIZE - len,
-						"]\n");
-			if (len >= PAGE_SIZE)
-				return -EFBIG;
-		}
-	}
+	return iio_format_list(buf, vals, type, length, "", "");
+}
 
-	return len;
+static ssize_t iio_format_avail_range(char *buf, const int *vals, int type)
+{
+	return iio_format_list(buf, vals, type, 3, "[", "]");
 }
 
 static ssize_t iio_read_channel_info_avail(struct device *dev,