[virtcon] Add and display ascii logo

It is difficult to see if the display is on when virtcon is
showing an empty shell. Add a logo for fun.

The existing terminal and logs are still available by
hitting ctl-tab.

Change-Id: I5b8dc804f8190337cda7b086060b4c13b295d7c2
Reviewed-on: https://fuchsia-review.googlesource.com/c/fuchsia/+/1195478
Reviewed-by: Aaron Wood <[email protected]>
Reviewed-by: Craig Stout <[email protected]>
Reviewed-by: Alice Neels <[email protected]>
Commit-Queue: David Gilhooley <[email protected]>

Author: gilhooleyd

src/bringup/bin/virtcon/BUILD.gn

@@ -76,6 +76,7 @@ rustc_library("lib") {
     "src/colors.rs",
     "src/lib.rs",
     "src/log.rs",
+    "src/logo.rs",
     "src/session_manager.rs",
     "src/terminal.rs",
     "src/text_grid.rs",

src/bringup/bin/virtcon/meta/virtual-console.cml

@@ -71,6 +71,13 @@
             max_size: 10,
             default: "16.0",
         },
+        {
+            config: "fuchsia.virtcon.ShowLogo",
+            key: "show_logo",
+            availability: "optional",
+            type: "bool",
+            default: false,
+        },
         {
             config: "fuchsia.virtcon.KeepLogVisible",
             key: "keep_log_visible",

src/bringup/bin/virtcon/meta/virtual-console.shard.cml

@@ -23,6 +23,7 @@
                 "fuchsia.virtcon.KeyRepeat",
                 "fuchsia.virtcon.RoundedCorners",
                 "fuchsia.virtcon.ScrollbackRows",
+                "fuchsia.virtcon.ShowLogo",
             ],
             from: "parent",
             to: "#virtual_console",

src/bringup/bin/virtcon/src/app.rs

@@ -5,6 +5,7 @@
 use crate::args::VirtualConsoleArgs;
 use crate::colors::ColorScheme;
 use crate::log::{Log, LogClient};
+use crate::logo::Logo;
 use crate::session_manager::{SessionManager, SessionManagerClient};
 use crate::terminal::Terminal;
 use crate::view::{ViewMessages, VirtualConsoleViewAssistant};
@@ -20,7 +21,8 @@ use std::collections::BTreeMap;
 use term_model::event::{Event, EventListener};
 
 const DEBUGLOG_ID: u32 = 0;
-const FIRST_SESSION_ID: u32 = 1;
+const LOGO_ID: u32 = 1;
+const FIRST_SESSION_ID: u32 = 2;
 
 pub struct EventProxy {
     app_sender: AppSender,
@@ -90,7 +92,7 @@ impl LogClient for VirtualConsoleClient {
     type Listener = EventProxy;
 
     fn create_terminal(&self, id: u32, title: String) -> Result<Terminal<Self::Listener>, Error> {
-        VirtualConsoleClient::create_terminal(self, id, title, false, None)
+        VirtualConsoleClient::create_terminal(self, id, title, true, None)
     }
 
     fn request_update(&self, id: u32) {
@@ -132,7 +134,8 @@ impl VirtualConsoleAppAssistant {
         read_only_debuglog: Option<zx::DebugLog>,
     ) -> Result<VirtualConsoleAppAssistant, Error> {
         let app_sender = app_sender.clone();
-        let session_manager = SessionManager::new(args.keep_log_visible, FIRST_SESSION_ID);
+        let session_manager =
+            SessionManager::new(args.keep_log_visible || args.show_logo, FIRST_SESSION_ID);
         let terminals = BTreeMap::new();
 
         Ok(VirtualConsoleAppAssistant {
@@ -153,6 +156,14 @@ impl VirtualConsoleAppAssistant {
         Log::start(read_only_debuglog, &client, DEBUGLOG_ID)
     }
 
+    fn start_logo(&self) {
+        let app_sender = self.app_sender.clone();
+        let color_scheme = self.args.color_scheme;
+        let scrollback_rows = self.args.scrollback_rows;
+        let client = VirtualConsoleClient { app_sender, color_scheme, scrollback_rows };
+        Logo::start(&client, LOGO_ID).unwrap();
+    }
+
     #[cfg(test)]
     fn new_for_test() -> Result<VirtualConsoleAppAssistant, Error> {
         let app_sender = AppSender::new_for_testing_purposes_only();
@@ -165,6 +176,10 @@ impl AppAssistant for VirtualConsoleAppAssistant {
         if let Some(read_only_debuglog) = self.read_only_debuglog.take() {
             self.start_log(read_only_debuglog).expect("failed to start debuglog");
         }
+        if self.args.show_logo {
+            self.start_logo();
+        }
+
         Ok(())
     }
 

src/bringup/bin/virtcon/src/args.rs

@@ -16,6 +16,7 @@ pub const MAX_FONT_SIZE: f32 = 160.0;
 pub struct VirtualConsoleArgs {
     pub disable: bool,
     pub keep_log_visible: bool,
+    pub show_logo: bool,
     pub keyrepeat: bool,
     pub rounded_corners: bool,
     pub boot_animation: bool,
@@ -43,6 +44,7 @@ impl TryFrom<Config> for VirtualConsoleArgs {
         Ok(VirtualConsoleArgs {
             disable: config.disable,
             keep_log_visible: config.keep_log_visible,
+            show_logo: config.show_logo,
             keyrepeat: config.keyrepeat,
             rounded_corners: config.rounded_corners,
             boot_animation: config.boot_animation,
@@ -73,6 +75,7 @@ mod tests {
             dpi: vec![],
             font_size: "16.0".into(),
             keep_log_visible: false,
+            show_logo: false,
             keyrepeat: false,
             key_map: "qwerty".into(),
             rounded_corners: false,
@@ -106,6 +109,19 @@ mod tests {
         Ok(())
     }
 
+    #[test]
+    fn check_show_logo() -> Result<(), Error> {
+        let config = Config { show_logo: true, ..new_config() };
+        let args = VirtualConsoleArgs::try_from(config)?;
+        assert_eq!(args.show_logo, true);
+
+        let config = Config { show_logo: false, ..new_config() };
+        let args = VirtualConsoleArgs::try_from(config)?;
+        assert_eq!(args.show_logo, false);
+
+        Ok(())
+    }
+
     #[test]
     fn check_keyrepeat() -> Result<(), Error> {
         let config = Config { keyrepeat: true, ..new_config() };

src/bringup/bin/virtcon/src/lib.rs

@@ -8,6 +8,7 @@ mod app;
 mod args;
 mod colors;
 mod log;
+mod logo;
 mod session_manager;
 mod terminal;
 mod text_grid;

src/bringup/bin/virtcon/src/logo.rs

@@ -0,0 +1,100 @@
+// Copyright 2025 The Fuchsia Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+use crate::log::LogClient;
+use anyhow::Error;
+use std::io::sink;
+use term_model::ansi::Processor;
+use term_model::event::EventListener;
+
+const LOGO_TEXT: &str = "
+\r
+                                      ff    ff  ff\r
+                                   ff  fffffffffff ff\r
+                                  f ffffffffffffffff f\r
+                                ff ffffffffffffffffffff\r
+                                f fffffffff        ffff\r
+                               f ffffffff            ff\r
+                               f fffffff              f\r
+                              ff fffffff\r
+                              f  ffffff\r
+                               fffffffff             f\r
+                        fffffff                    fff\r
+                    ffffffffffffffffffffffff   ffffff\r
+                 ffffffffffffffffffffffffffffffffff\r
+                ffffff   fffffff         ffffff\r
+               fffff  fff      ffffffffff\r
+              fffff ff         fffffff  f\r
+              ffff fff         fffffff ff\r
+             fffff ff         ffffffff f\r
+              ffff fff       ffffffff  f\r
+              ffff ffffffffffffffffff f\r
+               ffff fffffffffffffff  f\r
+                fffff  ffffffffff  ff\r
+                  fffff         fff\r
+                    fffffffffffff\r
+";
+
+pub struct Logo;
+impl Logo {
+    pub fn start<T: LogClient>(client: &T, id: u32) -> Result<(), Error>
+    where
+        <T as LogClient>::Listener: EventListener,
+    {
+        let client = client.clone();
+        let terminal =
+            client.create_terminal(id, "logo".to_string()).expect("failed to create terminal");
+        let term = terminal.clone_term();
+
+        let mut sink = sink();
+        let mut parser = Processor::new();
+        {
+            let mut term = term.borrow_mut();
+            for byte in LOGO_TEXT.as_bytes() {
+                parser.advance(&mut *term, *byte, &mut sink);
+            }
+            client.request_update(id);
+        }
+        Ok(())
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::colors::ColorScheme;
+    use crate::terminal::Terminal;
+    use fuchsia_async as fasync;
+    use term_model::event::Event;
+
+    #[derive(Default)]
+    struct TestListener;
+
+    impl EventListener for TestListener {
+        fn send_event(&self, _event: Event) {}
+    }
+
+    #[derive(Default, Clone)]
+    struct TestLogClient;
+
+    impl LogClient for TestLogClient {
+        type Listener = TestListener;
+
+        fn create_terminal(
+            &self,
+            _id: u32,
+            title: String,
+        ) -> Result<Terminal<Self::Listener>, Error> {
+            Ok(Terminal::new(TestListener::default(), title, ColorScheme::default(), 1024, None))
+        }
+        fn request_update(&self, _id: u32) {}
+    }
+
+    #[fasync::run_singlethreaded(test)]
+    async fn can_start_logo() -> Result<(), Error> {
+        let client = TestLogClient::default();
+        let _ = Logo::start(&client, 0)?;
+        Ok(())
+    }
+}

src/lib/assembly/platform_configuration/src/subsystems/graphics.rs

@@ -74,7 +74,7 @@ impl DefineSubsystemConfiguration<GraphicsConfig> for GraphicsSubsystemConfig {
 
         builder.set_config_capability("fuchsia.virtcon.FontSize", Config::new_void())?;
         builder.set_config_capability("fuchsia.virtcon.KeepLogVisible", Config::new_void())?;
-
+        builder.set_config_capability("fuchsia.virtcon.ShowLogo", Config::new_bool(true))?;
         if let Some(keymap) = &virtcon_config.keymap {
             builder.set_config_capability(
                 "fuchsia.virtcon.KeyMap",

src/sys/root/root.cml

@@ -110,6 +110,7 @@
                 "fuchsia.virtcon.KeyRepeat",
                 "fuchsia.virtcon.RoundedCorners",
                 "fuchsia.virtcon.ScrollbackRows",
+                "fuchsia.virtcon.ShowLogo",
             ],
             from: "#config",
             to: "#bootstrap",