diff mbox series

[v3,3/4] console: remove #ifdef CONFIG_CONSOLE_RECORD

Message ID 20201218124642.v3.3.I3e15d39becc5c180a3be52571bb570e29c6b4cd0@changeid
State Accepted
Commit 1e993710e8b99510a37f91fa97d9b783c6e5f32d
Delegated to: Tom Rini
Headers show
Series console: remove #ifdef CONFIG when it is possible | expand

Commit Message

Patrick Delaunay Dec. 18, 2020, 11:46 a.m. UTC
From: Patrick Delaunay <patrick.delaunay@st.com>

Add helper functions to access to gd->console_out and gd->console_in
with membuff API and replace the #ifdef CONFIG_CONSOLE_RECORD test
by if (IS_ENABLED(CONFIG_CONSOLE_RECORD)) to respect the U-Boot
coding rule.

Signed-off-by: Patrick Delaunay <patrick.delaunay@st.com>
Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
---

(no changes since v2)

Changes in v2:
- move the tests on gd->flags & GD_FLG_RECORD in helper functions
- remove test on IS_ENABLED(CONFIG_CONSOLE_RECORD)
  before to call helper functions

 common/console.c | 95 +++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 73 insertions(+), 22 deletions(-)

Comments

Simon Glass Dec. 19, 2020, 3:34 a.m. UTC | #1
On Fri, 18 Dec 2020 at 04:46, Patrick Delaunay
<patrick.delaunay@foss.st.com> wrote:
>
> From: Patrick Delaunay <patrick.delaunay@st.com>
>
> Add helper functions to access to gd->console_out and gd->console_in

I don't see those in this patch

> with membuff API and replace the #ifdef CONFIG_CONSOLE_RECORD test
> by if (IS_ENABLED(CONFIG_CONSOLE_RECORD)) to respect the U-Boot
> coding rule.
>
> Signed-off-by: Patrick Delaunay <patrick.delaunay@st.com>
> Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
> ---
>
> (no changes since v2)
>
> Changes in v2:
> - move the tests on gd->flags & GD_FLG_RECORD in helper functions
> - remove test on IS_ENABLED(CONFIG_CONSOLE_RECORD)
>   before to call helper functions
>
>  common/console.c | 95 +++++++++++++++++++++++++++++++++++++-----------
>  1 file changed, 73 insertions(+), 22 deletions(-)
>

Reviewed-by: Simon Glass <sjg@chromium.org>
Patrick Delaunay Jan. 4, 2021, 1:18 p.m. UTC | #2
On 12/19/20 4:34 AM, Simon Glass wrote:
> On Fri, 18 Dec 2020 at 04:46, Patrick Delaunay
> <patrick.delaunay@foss.st.com> wrote:
>> From: Patrick Delaunay <patrick.delaunay@st.com>
>>
>> Add helper functions to access to gd->console_out and gd->console_in
> I don't see those in this patch

These helper function are console_record_putc() / _puts()  / _getc() / 
_tstc();

they use "gd->console_out" and "gd->console_in" only if 
CONFIG_CONSOLE_RECORD is defined:

diff --git a/common/console.c b/common/console.c index 
036dd0358a..295c10f242 100644

--- a/common/console.c

+++ b/common/console.c

@@ -88,6 +88,64 @@ static int on_silent(const char *name, const char 
*value, enum env_op op, U_BOOT_ENV_CALLBACK(silent, on_silent); #endif

+#ifdef CONFIG_CONSOLE_RECORD

+/* helper function: access to gd->console_out and gd->console_in */

...

+#else

... stubs => do nothings

+#endif

>
>> with membuff API and replace the #ifdef CONFIG_CONSOLE_RECORD test
>> by if (IS_ENABLED(CONFIG_CONSOLE_RECORD)) to respect the U-Boot
>> coding rule.
>>
>> Signed-off-by: Patrick Delaunay <patrick.delaunay@st.com>
>> Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
>> ---
>>
>> (no changes since v2)
>>
>> Changes in v2:
>> - move the tests on gd->flags & GD_FLG_RECORD in helper functions
>> - remove test on IS_ENABLED(CONFIG_CONSOLE_RECORD)
>>    before to call helper functions
>>
>>   common/console.c | 95 +++++++++++++++++++++++++++++++++++++-----------
>>   1 file changed, 73 insertions(+), 22 deletions(-)
>>
> Reviewed-by: Simon Glass <sjg@chromium.org>


Regards

Patrick
Tom Rini Jan. 16, 2021, 4:24 p.m. UTC | #3
On Fri, Dec 18, 2020 at 12:46:45PM +0100, Patrick Delaunay wrote:

> From: Patrick Delaunay <patrick.delaunay@st.com>
> 
> Add helper functions to access to gd->console_out and gd->console_in
> with membuff API and replace the #ifdef CONFIG_CONSOLE_RECORD test
> by if (IS_ENABLED(CONFIG_CONSOLE_RECORD)) to respect the U-Boot
> coding rule.
> 
> Signed-off-by: Patrick Delaunay <patrick.delaunay@st.com>
> Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
> Reviewed-by: Simon Glass <sjg@chromium.org>

Applied to u-boot/master, thanks!
diff mbox series

Patch

diff --git a/common/console.c b/common/console.c
index 036dd0358a..295c10f242 100644
--- a/common/console.c
+++ b/common/console.c
@@ -88,6 +88,64 @@  static int on_silent(const char *name, const char *value, enum env_op op,
 U_BOOT_ENV_CALLBACK(silent, on_silent);
 #endif
 
+#ifdef CONFIG_CONSOLE_RECORD
+/* helper function: access to gd->console_out and gd->console_in */
+static void console_record_putc(const char c)
+{
+	if (!(gd->flags & GD_FLG_RECORD))
+		return;
+	if  (gd->console_out.start)
+		membuff_putbyte((struct membuff *)&gd->console_out, c);
+}
+
+static void console_record_puts(const char *s)
+{
+	if (!(gd->flags & GD_FLG_RECORD))
+		return;
+	if  (gd->console_out.start)
+		membuff_put((struct membuff *)&gd->console_out, s, strlen(s));
+}
+
+static int console_record_getc(void)
+{
+	if (!(gd->flags & GD_FLG_RECORD))
+		return -1;
+	if (!gd->console_in.start)
+		return -1;
+
+	return membuff_getbyte((struct membuff *)&gd->console_in);
+}
+
+static int console_record_tstc(void)
+{
+	if (!(gd->flags & GD_FLG_RECORD))
+		return 0;
+	if (gd->console_in.start) {
+		if (membuff_peekbyte((struct membuff *)&gd->console_in) != -1)
+			return 1;
+	}
+	return 0;
+}
+#else
+static void console_record_putc(char c)
+{
+}
+
+static void console_record_puts(const char *s)
+{
+}
+
+static int console_record_getc(void)
+{
+	return -1;
+}
+
+static int console_record_tstc(void)
+{
+	return 0;
+}
+#endif
+
 #if CONFIG_IS_ENABLED(SYS_CONSOLE_IS_IN_ENV)
 /*
  * if overwrite_console returns 1, the stdin, stderr and stdout
@@ -414,21 +472,18 @@  int fprintf(int file, const char *fmt, ...)
 
 int getchar(void)
 {
+	int ch;
+
 	if (IS_ENABLED(CONFIG_DISABLE_CONSOLE) && (gd->flags & GD_FLG_DISABLE_CONSOLE))
 		return 0;
 
 	if (!gd->have_console)
 		return 0;
 
-#ifdef CONFIG_CONSOLE_RECORD
-	if (gd->console_in.start) {
-		int ch;
+	ch = console_record_getc();
+	if (ch != -1)
+		return ch;
 
-		ch = membuff_getbyte((struct membuff *)&gd->console_in);
-		if (ch != -1)
-			return 1;
-	}
-#endif
 	if (gd->flags & GD_FLG_DEVINIT) {
 		/* Get from the standard input */
 		return fgetc(stdin);
@@ -445,12 +500,10 @@  int tstc(void)
 
 	if (!gd->have_console)
 		return 0;
-#ifdef CONFIG_CONSOLE_RECORD
-	if (gd->console_in.start) {
-		if (membuff_peekbyte((struct membuff *)&gd->console_in) != -1)
-			return 1;
-	}
-#endif
+
+	if (console_record_tstc())
+		return 1;
+
 	if (gd->flags & GD_FLG_DEVINIT) {
 		/* Test the standard input */
 		return ftstc(stdin);
@@ -521,10 +574,9 @@  void putc(const char c)
 {
 	if (!gd)
 		return;
-#ifdef CONFIG_CONSOLE_RECORD
-	if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
-		membuff_putbyte((struct membuff *)&gd->console_out, c);
-#endif
+
+	console_record_putc(c);
+
 	/* sandbox can send characters to stdout before it has a console */
 	if (IS_ENABLED(CONFIG_SANDBOX) && !(gd->flags & GD_FLG_SERIAL_READY)) {
 		os_putc(c);
@@ -563,10 +615,9 @@  void puts(const char *s)
 {
 	if (!gd)
 		return;
-#ifdef CONFIG_CONSOLE_RECORD
-	if ((gd->flags & GD_FLG_RECORD) && gd->console_out.start)
-		membuff_put((struct membuff *)&gd->console_out, s, strlen(s));
-#endif
+
+	console_record_puts(s);
+
 	/* sandbox can send characters to stdout before it has a console */
 	if (IS_ENABLED(CONFIG_SANDBOX) && !(gd->flags & GD_FLG_SERIAL_READY)) {
 		os_puts(s);