From ff90c8ad54ebba9d1be5e137009e00ae0734424d Mon Sep 17 00:00:00 2001
From: Peter Hoyes <Peter.Hoyes@arm.com>
Date: Tue, 12 Jul 2022 11:28:28 +0100
Subject: [PATCH] arm/classes: Change FVP_CONSOLE to FVP_CONSOLES in fvpconf

So that the test target can connect to the desired console(s) as soon
as they appear in the FVP stdout, add the variable FVP_CONSOLES to the
fvpconf as a replcaement for FVP_CONSOLE. The varflags of this variable
define a mapping between FVP console names (e.g. terminal_0) and console
names in the tests (e.g. 'zephyr'). The console defined in
FVP_CONSOLE is automatically mapped as 'default' for backwards
compatibility.

This also enables greater reuse of test cases, as the "default" console
name can be remapped on a per-machine basis.

Issue-Id: SCM-4957
Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com>
Change-Id: I9d88b172bfc5a5459b9f5132f287c70816d7fb55
Signed-off-by: Jon Mason <jon.mason@arm.com>
---
 meta-arm/classes/fvpboot.bbclass           | 5 ++++-
 meta-arm/lib/fvp/conffile.py               | 2 +-
 meta-arm/lib/oeqa/selftest/cases/runfvp.py | 2 +-
 scripts/runfvp                             | 2 +-
 4 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/meta-arm/classes/fvpboot.bbclass b/meta-arm/classes/fvpboot.bbclass
index d02742db..ec9d4f5b 100644
--- a/meta-arm/classes/fvpboot.bbclass
+++ b/meta-arm/classes/fvpboot.bbclass
@@ -18,6 +18,9 @@ FVP_APPLICATIONS ?= ""
 FVP_TERMINALS ?= ""
 # What terminal should be considered the primary console
 FVP_CONSOLE ?= ""
+# Flags for console names, as they appear in the FVP output. Flag name is an
+# application-specific id for the console for use in test cases
+FVP_CONSOLES[default] ?= "${FVP_CONSOLE}"
 # Arbitrary extra arguments
 FVP_EXTRA_ARGS ?= ""
 
@@ -59,7 +62,7 @@ python do_write_fvpboot_conf() {
     data["parameters"] = getFlags("FVP_CONFIG")
     data["data"] = shlex.split(d.getVar("FVP_DATA") or "")
     data["applications"] = getFlags("FVP_APPLICATIONS")
-    data["console"] = d.getVar("FVP_CONSOLE")
+    data["consoles"] = getFlags("FVP_CONSOLES")
     data["terminals"] = getFlags("FVP_TERMINALS")
     data["args"] = shlex.split(d.getVar("FVP_EXTRA_ARGS") or "")
 
diff --git a/meta-arm/lib/fvp/conffile.py b/meta-arm/lib/fvp/conffile.py
index 77afca19..acede40e 100644
--- a/meta-arm/lib/fvp/conffile.py
+++ b/meta-arm/lib/fvp/conffile.py
@@ -50,7 +50,7 @@ def load(config_file):
     sanitise("applications", {})
     sanitise("terminals", {})
     sanitise("args", [])
-    sanitise("console", "")
+    sanitise("consoles", {})
 
     if not config["exe"]:
         raise ValueError("Required value FVP_EXE not set in machine configuration")
diff --git a/meta-arm/lib/oeqa/selftest/cases/runfvp.py b/meta-arm/lib/oeqa/selftest/cases/runfvp.py
index aabd0b7e..d1e452f6 100644
--- a/meta-arm/lib/oeqa/selftest/cases/runfvp.py
+++ b/meta-arm/lib/oeqa/selftest/cases/runfvp.py
@@ -78,7 +78,7 @@ class ConfFileTests(OESelftestTestCase):
             self.assertTrue("applications" in conf)
             self.assertTrue("terminals" in conf)
             self.assertTrue("args" in conf)
-            self.assertTrue("console" in conf)
+            self.assertTrue("consoles" in conf)
 
 
 class RunnerTests(OESelftestTestCase):
diff --git a/scripts/runfvp b/scripts/runfvp
index 30eae40e..9fb77d38 100755
--- a/scripts/runfvp
+++ b/scripts/runfvp
@@ -55,7 +55,7 @@ async def start_fvp(args, config, extra_args):
 
         if args.console:
             fvp.add_line_callback(lambda line: logger.debug(f"FVP output: {line}"))
-            expected_terminal = config["console"]
+            expected_terminal = config["consoles"]["default"]
             if not expected_terminal:
                 logger.error("--console used but FVP_CONSOLE not set in machine configuration")
                 return 1