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 struct stdio_dev *console_search_dev(int flags, const char *name);
  29
  30 #ifdef CONFIG_CONSOLE_RECORD
  31 /**
  32  * console_record_init() - set up the console recording buffers
  33  *
  34  * This should be called as soon as malloc() is available so that the maximum
  35  * amount of console output can be recorded.
  36  *
  37  * @return 0 if OK, -ENOMEM if out of memory
  38  */
  39 int console_record_init(void);
  40
  41 /**
  42  * console_record_reset() - reset the console recording buffers
  43  *
  44  * Removes any data in the buffers
  45  */
  46 void console_record_reset(void);
  47
  48 /**
  49  * console_record_reset_enable() - reset and enable the console buffers
  50  *
  51  * This should be called to enable the console buffer.
  52  *
  53  * @return 0 (always)
  54  */
  55 int console_record_reset_enable(void);
  56
  57 /**
  58  * console_record_readline() - Read a line from the console output
  59  *
  60  * This reads the next available line from the console output previously
  61  * recorded.
  62  *
  63  * @str: Place to put string
  64  * @maxlen: Maximum length of @str including nul terminator
  65  * @return length of string returned
  66  */
  67 int console_record_readline(char *str, int maxlen);
  68
  69 /**
  70  * console_record_avail() - Get the number of available bytes in console output
  71  *
  72  * @return available bytes (0 if empty)
  73  */
  74 int console_record_avail(void);
  75 #else
  76 static inline int console_record_init(void)
  77 {
  78         /* Always succeed, since it is not enabled */
  79
  80         return 0;
  81 }
  82
  83 static inline void console_record_reset(void)
  84 {
  85         /* Nothing to do here */
  86 }
  87
  88 static inline int console_record_reset_enable(void)
  89 {
  90         /* Cannot enable it as it is not supported */
  91         return -ENOSYS;
  92 }
  93
  94 static inline int console_record_readline(char *str, int maxlen)
  95 {
  96         /* Nothing to read */
  97         return 0;
  98 }
  99
 100 static inline int console_record_avail(void)
 101 {
 102         /* There is never anything available */
 103         return 0;
 104 }
 105
 106 #endif /* !CONFIG_CONSOLE_RECORD */
 107
 108 /**
 109  * console_announce_r() - print a U-Boot console on non-serial consoles
 110  *
 111  * When U-Boot starts up with a display it generally does not announce itself
 112  * on the display. The banner is instead emitted on the UART before relocation.
 113  * This function prints a banner on devices which (we assume) did not receive
 114  * it before relocation.
 115  *
 116  * @return 0 (meaning no errors)
 117  */
 118 int console_announce_r(void);
 119
 120 /**
 121  * console_puts_select_stderr() - Output a string to selected console devices
 122  *
 123  * This writes to stderr only. It is useful for outputting errors
 124  *
 125  * @serial_only: true to output only to serial, false to output to everything
 126  *      else
 127  * @s: String to output
 128  */
 129 void console_puts_select_stderr(bool serial_only, const char *s);
 130
 131 /*
 132  * CONSOLE multiplexing.
 133  */
 134 #ifdef CONFIG_CONSOLE_MUX
 135 #include <iomux.h>
 136 #endif
 137
 138 #endif