[coreboot-gerrit] Change in coreboot[master]: cbmem_console: Document known reimpementations of console st...

[Julius Werner (Code Review)]

Hello Paul Menzel,

I'd like you to do a code review.  Please visit

    https://review.coreboot.org/19439

to review the following change.


Change subject: cbmem_console: Document known reimpementations of console structure/API
......................................................................

cbmem_console: Document known reimpementations of console structure/API

It turns out that there are quite a few other projects that can access
the CBMEM console by now. If we ever want to make another structural or
behavioral change to it, we need to know where these implementations are
so we can make sure they're all getting updated. Let's try to build a
comprehensive list in the file that should be the source of truth for
all (coreboot's own implementation).

Change-Id: Ia3d6a87230f5bfdde9d812bc7154e22880c1377a
Signed-off-by: Julius Werner <jwerner at chromium.org>
---
M src/lib/cbmem_console.c
1 file changed, 10 insertions(+), 0 deletions(-)


  git pull ssh://review.coreboot.org:29418/coreboot refs/changes/39/19439/1

diff --git a/src/lib/cbmem_console.c b/src/lib/cbmem_console.c
index d570bba..eb0cc93 100644
--- a/src/lib/cbmem_console.c
+++ b/src/lib/cbmem_console.c
@@ -28,6 +28,16 @@
  * cursor field gets set to indicate that this happened. If the underlying
  * storage allows this, the buffer will persist across multiple boots and append
  * to the previous log.
+ *
+ * NOTE: These are known implementations accessing this console that need to be
+ * updated in case of structure/API changes:
+ *
+ * cbmem:	[coreboot]/src/util/cbmem/cbmem.c
+ * libpayload:	[coreboot]/payloads/libpayload/drivers/cbmem_console.c
+ * coreinfo:	[coreboot]/payloads/coreinfo/bootlog_module.c
+ * Linux:	drivers/firmware/google/memconsole-coreboot.c
+ * SeaBIOS:	src/firmware/coreboot.c
+ * GRUB:	grub-core/term/i386/coreboot/cbmemc.c
  */
 struct cbmem_console {
 	u32 size;

-- 
To view, visit https://review.coreboot.org/19439
To unsubscribe, visit https://review.coreboot.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ia3d6a87230f5bfdde9d812bc7154e22880c1377a
Gerrit-PatchSet: 1
Gerrit-Project: coreboot
Gerrit-Branch: master
Gerrit-Owner: Julius Werner <jwerner at chromium.org>
Gerrit-Reviewer: Paul Menzel <paulepanter at users.sourceforge.net>