[coreboot-gerrit] Change in coreboot[master]: libpayload: Implement reading from CBMEM console

[Patrick Georgi (Code Review)]

Patrick Georgi has submitted this change. ( https://review.coreboot.org/c/coreboot/+/37667 )

Change subject: libpayload: Implement reading from CBMEM console
......................................................................

libpayload: Implement reading from CBMEM console

To support showing CBMEM logs on recovery screen, add a function
cbmem_console_snapshot() to copy the CBMEM console to an allocated
buffer. Non-printable characters are automatically replaced with '?' to
ensure the returned string is printable.

BRANCH=none
BUG=b:146105976
TEST=emerge-nami libpayload

Change-Id: Ie324055f5fd8276f1d833fc9d04f60a792dbb9f6
Signed-off-by: Yu-Ping Wu 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/37667
Tested-by: build bot (Jenkins) 
Reviewed-by: Hung-Te Lin 
---
M payloads/libpayload/drivers/cbmem_console.c
M payloads/libpayload/include/libpayload.h
2 files changed, 53 insertions(+), 0 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Hung-Te Lin: Looks good to me, approved

diff --git a/payloads/libpayload/drivers/cbmem_console.c b/payloads/libpayload/drivers/cbmem_console.c
index 9435e1c..62aabfb 100644
--- a/payloads/libpayload/drivers/cbmem_console.c
+++ b/payloads/libpayload/drivers/cbmem_console.c
@@ -75,3 +75,49 @@

do_write(buffer, count);
 }
+
+char *cbmem_console_snapshot(void)
+{
+	const struct cbmem_console *console_p = cbmem_console_p;
+	char *console_c;
+	uint32_t size, cursor, overflow;
+
+	if (!console_p) {
+		printf("ERROR: No cbmem console found in coreboot table\n");
+		return NULL;
+	}
+
+	cursor = console_p->cursor & CURSOR_MASK;
+	overflow = console_p->cursor & OVERFLOW;
+	if (!overflow && cursor < console_p->size)
+		size = cursor;
+	else
+		size = console_p->size;
+
+	console_c = malloc(size + 1);
+	if (!console_c) {
+		printf("ERROR: Not enough memory for console (size = %u)\n",
+		       size);
+		return NULL;
+	}
+	console_c[size] = '\0';
+
+	if (overflow) {
+		if (cursor >= size) {
+			printf("ERROR: CBMEM console struct is corrupted\n");
+			return NULL;
+		}
+		memcpy(console_c, console_p->body + cursor, size - cursor);
+		memcpy(console_c + size - cursor, console_p->body, cursor);
+	} else {
+		memcpy(console_c, console_p->body, size);
+	}
+
+	/* Slight memory corruption may occur between reboots and give us a few
+	   unprintable characters like '\0'. Replace them with '?' on output. */
+	for (cursor = 0; cursor < size; cursor++)
+		if (!isprint(console_c[cursor]) && !isspace(console_c[cursor]))
+			console_c[cursor] = '?';
+
+	return console_c;
+}
diff --git a/payloads/libpayload/include/libpayload.h b/payloads/libpayload/include/libpayload.h
index 934c368..4b6a250 100644
--- a/payloads/libpayload/include/libpayload.h
+++ b/payloads/libpayload/include/libpayload.h
@@ -313,6 +313,13 @@
  */
 void cbmem_console_init(void);
 void cbmem_console_write(const void *buffer, size_t count);
+/**
+ * Take a snapshot of the CBMEM memory console. This function will allocate a
+ * range of memory. Callers must free the returned buffer by themselves.
+ *
+ * @return The allocated buffer on success, NULL on failure.
+ */
+char *cbmem_console_snapshot(void);
 /** @} */

/* drivers/option.c */