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

[Julius Werner (Code Review)]

Julius Werner has submitted this change and it was merged. ( https://review.coreboot.org/19439 )

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>
Reviewed-on: https://review.coreboot.org/19439
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter at users.sourceforge.net>
Reviewed-by: Aaron Durbin <adurbin at chromium.org>
---
M src/lib/cbmem_console.c
1 file changed, 10 insertions(+), 0 deletions(-)

Approvals:
  Aaron Durbin: Looks good to me, approved
  Paul Menzel: Looks good to me, but someone else must approve
  build bot (Jenkins): Verified



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: merged
Gerrit-Change-Id: Ia3d6a87230f5bfdde9d812bc7154e22880c1377a
Gerrit-PatchSet: 2
Gerrit-Project: coreboot
Gerrit-Branch: master
Gerrit-Owner: Julius Werner <jwerner at chromium.org>
Gerrit-Reviewer: Aaron Durbin <adurbin at chromium.org>
Gerrit-Reviewer: Gerd Hoffmann <kraxel at redhat.com>
Gerrit-Reviewer: Julius Werner <jwerner at chromium.org>
Gerrit-Reviewer: Kevin O'Connor <kevin at koconnor.net>
Gerrit-Reviewer: Paul Menzel <paulepanter at users.sourceforge.net>
Gerrit-Reviewer: Philippe Mathieu-Daudé <philippe.mathieu.daude at gmail.com>
Gerrit-Reviewer: Vladimir Serbinenko <phcoder at gmail.com>
Gerrit-Reviewer: build bot (Jenkins)