video: Add a note about the broken implementation

The cls command is broken. Previous discussion about this was at [1] and
[2]. For now, add a note to the source code.

[1] https://patchwork.ozlabs.org/project/uboot/patch/
       20221022092058.106052-1-heinrich.schuchardt@canonical.com/
[2] https://patchwork.ozlabs.org/project/uboot/patch/
       20230106145243.411626-12-sjg@chromium.org/

Signed-off-by: Simon Glass <sjg@chromium.org>

diff --git a/cmd/cls.c b/cmd/cls.c
index 073ba5a6c8670b6906d7bb0331ab48f7f3d8a735..1125a3f81bbbab1959790bbe9ae45a8ec6d9ef4f 100644 (file)
--- a/cmd/cls.c
+++ b/cmd/cls.c
@@ -17,7 +17,13 @@ static int do_video_clear(struct cmd_tbl *cmdtp, int flag, int argc,
 {
        __maybe_unused struct udevice *dev;
 
-       /*  Send clear screen and home */
+       /*
+        * Send clear screen and home
+        *
+        * FIXME(Heinrich Schuchardt <xypron.glpk@gmx.de>): This should go
+        * through an API and only be written to serial terminals, not video
+        * displays
+        */
        printf(CSI "2J" CSI "1;1H");
        if (IS_ENABLED(CONFIG_VIDEO_ANSI))
                return 0;