include/console.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2000-2009
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  */
   6
   7 #ifndef __CONSOLE_H
   8 #define __CONSOLE_H
   9
  10 #include <stdbool.h>
  11 #include <stdio_dev.h>
  12 #include <linux/errno.h>
  13
  14 extern char console_buffer[];
  15
  16 /* common/console.c */
  17 int console_init_f(void);       /* Before relocation; uses the serial  stuff */
  18 int console_init_r(void);       /* After  relocation; uses the console stuff */
  19 int console_start(int file, struct stdio_dev *sdev);    /* Start a console device */
  20 void console_stop(int file, struct stdio_dev *sdev);    /* Stop a console device */
  21 int console_assign(int file, const char *devname);      /* Assign the console */
  22 int ctrlc(void);
  23 int had_ctrlc(void);    /* have we had a Control-C since last clear? */
  24 void clear_ctrlc(void); /* clear the Control-C condition */
  25 int disable_ctrlc(int); /* 1 to disable, 0 to enable Control-C detect */
  26 int confirm_yesno(void);        /*  1 if input is "y", "Y", "yes" or "YES" */
  27
  28 /**
  29  * console_search_dev() - search for stdio device with given flags and name
  30  * @flags: device flags as per input/output/system
  31  * @name: device name
  32  *
  33  * Iterates over registered STDIO devices and match them with given @flags
  34  * and @name.
  35  *
  36  * Return: pointer to the &struct stdio_dev if found, or NULL otherwise
  37  */
  38 struct stdio_dev *console_search_dev(int flags, const char *name);
  39
  40 #ifdef CONFIG_CONSOLE_RECORD
  41 /**
  42  * console_record_init() - set up the console recording buffers
  43  *
  44  * This should be called as soon as malloc() is available so that the maximum
  45  * amount of console output can be recorded.
  46  *
  47  * Return: 0 if OK, -ENOMEM if out of memory
  48  */
  49 int console_record_init(void);
  50
  51 /**
  52  * console_record_reset() - reset the console recording buffers
  53  *
  54  * Removes any data in the buffers
  55  */
  56 void console_record_reset(void);
  57
  58 /**
  59  * console_record_reset_enable() - reset and enable the console buffers
  60  *
  61  * This should be called to enable the console buffer.
  62  *
  63  * Return: 0 (always)
  64  */
  65 int console_record_reset_enable(void);
  66
  67 /**
  68  * console_record_readline() - Read a line from the console output
  69  *
  70  * This reads the next available line from the console output previously
  71  * recorded.
  72  *
  73  * @str: Place to put string
  74  * @maxlen: Maximum length of @str including nul terminator
  75  * Return: length of string returned, or -ENOSPC if the console buffer was
  76  *      overflowed by the output
  77  */
  78 int console_record_readline(char *str, int maxlen);
  79
  80 /**
  81  * console_record_avail() - Get the number of available bytes in console output
  82  *
  83  * Return: available bytes (0 if empty)
  84  */
  85 int console_record_avail(void);
  86
  87 /**
  88  * console_record_isempty() - Returns if console output is empty
  89  *
  90  * Return: true if empty
  91  */
  92 bool console_record_isempty(void);
  93
  94 /**
  95  * console_in_puts() - Write a string to the console input buffer
  96  *
  97  * This writes the given string to the console_in buffer which will then be
  98  * returned if a function calls e.g. `getc()`
  99  *
 100  * @str: the string to write
 101  * Return:  the number of bytes added
 102  */
 103 int console_in_puts(const char *str);
 104 #else
 105 static inline int console_record_init(void)
 106 {
 107         /* Always succeed, since it is not enabled */
 108
 109         return 0;
 110 }
 111
 112 static inline void console_record_reset(void)
 113 {
 114         /* Nothing to do here */
 115 }
 116
 117 static inline int console_record_reset_enable(void)
 118 {
 119         /* Cannot enable it as it is not supported */
 120         return -ENOSYS;
 121 }
 122
 123 static inline int console_record_readline(char *str, int maxlen)
 124 {
 125         /* Nothing to read */
 126         return 0;
 127 }
 128
 129 static inline int console_record_avail(void)
 130 {
 131         /* There is never anything available */
 132         return 0;
 133 }
 134
 135 static inline int console_in_puts(const char *str)
 136 {
 137         /* There is never anything written */
 138         return 0;
 139 }
 140
 141 static inline bool console_record_isempty(void)
 142 {
 143         /* Always empty */
 144         return true;
 145 }
 146
 147 #endif /* !CONFIG_CONSOLE_RECORD */
 148
 149 /**
 150  * console_announce_r() - print a U-Boot console on non-serial consoles
 151  *
 152  * When U-Boot starts up with a display it generally does not announce itself
 153  * on the display. The banner is instead emitted on the UART before relocation.
 154  * This function prints a banner on devices which (we assume) did not receive
 155  * it before relocation.
 156  *
 157  * Return: 0 (meaning no errors)
 158  */
 159 int console_announce_r(void);
 160
 161 /**
 162  * console_puts_select_stderr() - Output a string to selected console devices
 163  *
 164  * This writes to stderr only. It is useful for outputting errors
 165  *
 166  * @serial_only: true to output only to serial, false to output to everything
 167  *      else
 168  * @s: String to output
 169  */
 170 void console_puts_select_stderr(bool serial_only, const char *s);
 171
 172 /**
 173  * console_clear() - Clear the console
 174  *
 175  * Uses an ANSI sequence to clear the display, failing back to clearing the
 176  * video display directly if !CONFIG_VIDEO_ANSI
 177  *
 178  * Return: 0 if OK, -ve on error
 179  */
 180 int console_clear(void);
 181
 182 /*
 183  * CONSOLE multiplexing.
 184  */
 185 #ifdef CONFIG_CONSOLE_MUX
 186 #include <iomux.h>
 187 #endif
 188
 189 #endif