[Skiboot] [PATCH 06/14] console: document the dummy console

[Oliver O'Halloran]

The OPAL console is normally completely independent to the internal
skiboot console. The dummy console is atypical compared to the FSP and
UART backends as it interacts with both consoles. This patch just adds
a few comments to clarify the situation.

Signed-off-by: Oliver O'Halloran <oohall at gmail.com>
---
 core/console.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/core/console.c b/core/console.c
index bb0bdef13f7d..be5aa6211ce4 100644
--- a/core/console.c
+++ b/core/console.c
@@ -319,7 +319,12 @@ void memcons_add_properties(void)
 }
 
 /*
- * Default OPAL console provided if nothing else overrides it
+ * The default OPAL console.
+ *
+ * In the absence of a "real" OPAL console driver we handle the OPAL_CONSOLE_*
+ * calls by writing into the skiboot log buffer. Reads are a little more
+ * complicated since they can come from the in-memory console (BML) or from the
+ * internal skiboot console driver.
  */
 static int64_t dummy_console_write(int64_t term_number, int64_t *length,
 				   const uint8_t *buffer)
-- 
2.5.5