[PATCH 04/27] console: Reconcile 3 different puts() implementations

[Andrey Smirnov <andrew.smirnov@gmail.com>]

PBL, CONSOLE_FULL and CONSOLE_SIMPLE contain almost identical puts()
implementations some of which also perform additional '\n' -> '\n\r'
compensation.

Move all of that code into a central location and share as much of it
as possible.

Signed-off-by: Andrey Smirnov <andrew.smirnov@gmail.com>
---
 common/console.c        | 16 ----------
 common/console_simple.c | 17 -----------
 include/console.h       |  3 +-
 lib/console.c           | 67 +++++++++++++++++++++++++++++++++++++++--
 pbl/console.c           | 13 --------
 5 files changed, 67 insertions(+), 49 deletions(-)

diff --git a/common/console.c b/common/console.c
index ab3d4d397..d64a7be25 100644
--- a/common/console.c
+++ b/common/console.c
@@ -253,22 +253,6 @@ static void console_set_stdoutpath(struct console_device *cdev)
 	free(str);
 }
 
-static int __console_puts(struct console_device *cdev, const char *s)
-{
-	int n = 0;
-
-	while (*s) {
-		if (*s == '\n') {
-			cdev->putc(cdev, '\r');
-			n++;
-		}
-		cdev->putc(cdev, *s);
-		n++;
-		s++;
-	}
-	return n;
-}
-
 static int fops_open(struct cdev *cdev, unsigned long flags)
 {
 	struct console_device *priv = cdev->priv;
diff --git a/common/console_simple.c b/common/console_simple.c
index d560f8534..898f68a48 100644
--- a/common/console_simple.c
+++ b/common/console_simple.c
@@ -9,23 +9,6 @@ LIST_HEAD(console_list);
 EXPORT_SYMBOL(console_list);
 extern struct console_device *console;
 
-int console_puts(unsigned int ch, const char *str)
-{
-	const char *s = str;
-	int i = 0;
-
-	while (*s) {
-		console_putc(ch, *s);
-		if (*s == '\n')
-			console_putc(ch, '\r');
-		s++;
-		i++;
-	}
-
-	return i;
-}
-EXPORT_SYMBOL(console_puts);
-
 int tstc(void)
 {
 	if (!console)
diff --git a/include/console.h b/include/console.h
index b3001ad16..81a5a5534 100644
--- a/include/console.h
+++ b/include/console.h
@@ -211,7 +211,8 @@ static inline void pbl_set_putc(putc_func_t putcf, void *ctx) {}
 bool console_allow_color(void);
 
 void __cdev_putc(struct console_device *cdev, char c);
-void __console_putc(struct console_device *cdev, char c);
+int __console_putc(struct console_device *cdev, char c);
+int __console_puts(struct console_device *cdev, const char *str);
 
 struct console_device *__console_get_default(void);
 void __console_set_putc(struct console_device *cdev,
diff --git a/lib/console.c b/lib/console.c
index 94c20dada..9f0fa9fc9 100644
--- a/lib/console.c
+++ b/lib/console.c
@@ -121,15 +121,78 @@ void __cdev_putc(struct console_device *cdev, char c)
  *
  * Internal high-level putc() implementation based on __cdev_putc()
  * that performs correct '\n' -> '\n\r' substitution.
+ *
+ * Function returns number of printed characters
  */
-void __console_putc(struct console_device *cdev, char c)
+int __console_putc(struct console_device *cdev, char c)
 {
+	int n = 0;
+
 	__cdev_putc(cdev, c);
-	if (c == '\n')
+	n++;
+	if (c == '\n') {
 		__cdev_putc(cdev, '\r');
+		n++;
+	}
+
+	return n;
 }
 
+/**
+ * console_putc - Default console_putc() implementation
+ *
+ * @cdev:	Console device to use
+ * @c:		Character to print
+ *
+ * This is default console_putc() implementation used as is by PBL and
+ * CONSOLE_SIMPLE. Declared as __weak in order to allow other
+ * implementation to override it.
+ */
 __weak void console_putc(unsigned int ch, char c)
 {
 	__console_putc(__console_get_default(), c);
 }
+
+/**
+ * __console_puts - Default console device .puts() implementation
+ *
+ * @cdev:	Console device to use
+ * @str:	String to print
+ *
+ * This is default implementation of .puts() callback used:
+ *
+ * a) In PBL and CONSOLE_SIMPLE to implement console_puts() API (see
+ *    below)
+ *
+ * b) In CONSOLE_FULL as a default .puts() implementation when no
+ *    altenative implementation was provided by underlying low-level
+ *    driver
+ *
+ * Function returns number of printed characters
+ */
+int __console_puts(struct console_device *cdev, const char *str)
+{
+	int n = 0;
+
+	while (*str) {
+		n += __console_putc(cdev, *str);
+		str++;
+	}
+
+	return n;
+}
+
+/**
+ * console_puts - Default console_puts() implementation
+ *
+ * @cdev:	Console device to use
+ * @str:	String to print
+ *
+ * This is default console_puts() implementation used as is by PBL and
+ * CONSOLE_SIMPLE. Declared as __weak in order to allow other
+ * implementation to override it.
+ */
+__weak int console_puts(unsigned int ch, const char *str)
+{
+	return __console_puts(__console_get_default(), str);
+}
\ No newline at end of file
diff --git a/pbl/console.c b/pbl/console.c
index b76c8cd75..e9194b480 100644
--- a/pbl/console.c
+++ b/pbl/console.c
@@ -17,19 +17,6 @@ void pbl_set_putc(putc_func_t putcf, void *ctx)
 	__console_set_putc(&console_ll, putcf, ctx);
 }
 
-int console_puts(unsigned int ch, const char *str)
-{
-	int n = 0;
-
-	while (*str) {
-		console_putc(CONSOLE_STDOUT, *str);
-		str++;
-		n++;
-	}
-
-	return n;
-}
-
 int printf(const char *fmt, ...)
 {
 	va_list args;
-- 
2.17.0


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox