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
  12 extern char console_buffer[];
  13
  14 /* common/console.c */
  15 int console_init_f(void);       /* Before relocation; uses the serial  stuff */
  16 int console_init_r(void);       /* After  relocation; uses the console stuff */
  17 int console_assign(int file, const char *devname);      /* Assign the console */
  18 int ctrlc(void);
  19 int had_ctrlc(void);    /* have we had a Control-C since last clear? */
  20 void clear_ctrlc(void); /* clear the Control-C condition */
  21 int disable_ctrlc(int); /* 1 to disable, 0 to enable Control-C detect */
  22 int confirm_yesno(void);        /*  1 if input is "y", "Y", "yes" or "YES" */
  23
  24 /**
  25  * console_record_init() - set up the console recording buffers
  26  *
  27  * This should be called as soon as malloc() is available so that the maximum
  28  * amount of console output can be recorded.
  29  */
  30 int console_record_init(void);
  31
  32 /**
  33  * console_record_reset() - reset the console recording buffers
  34  *
  35  * Removes any data in the buffers
  36  */
  37 void console_record_reset(void);
  38
  39 /**
  40  * console_record_reset_enable() - reset and enable the console buffers
  41  *
  42  * This should be called to enable the console buffer.
  43  */
  44 void console_record_reset_enable(void);
  45
  46 /**
  47  * console_record_readline() - Read a line from the console output
  48  *
  49  * This reads the next available line from the console output previously
  50  * recorded.
  51  *
  52  * @str: Place to put string
  53  * @maxlen: Maximum length of @str including nul terminator
  54  * @return length of string returned
  55  */
  56 int console_record_readline(char *str, int maxlen);
  57
  58 /**
  59  * console_record_avail() - Get the number of available bytes in console output
  60  *
  61  * @return available bytes (0 if empty)
  62  */
  63 int console_record_avail(void);
  64
  65 /**
  66  * console_announce_r() - print a U-Boot console on non-serial consoles
  67  *
  68  * When U-Boot starts up with a display it generally does not announce itself
  69  * on the display. The banner is instead emitted on the UART before relocation.
  70  * This function prints a banner on devices which (we assume) did not receive
  71  * it before relocation.
  72  *
  73  * @return 0 (meaning no errors)
  74  */
  75 int console_announce_r(void);
  76
  77 /**
  78  * console_puts_select_stderr() - Output a string to selected console devices
  79  *
  80  * This writes to stderr only. It is useful for outputting errors
  81  *
  82  * @serial_only: true to output only to serial, false to output to everything
  83  *      else
  84  * @s: String to output
  85  */
  86 void console_puts_select_stderr(bool serial_only, const char *s);
  87
  88 /*
  89  * CONSOLE multiplexing.
  90  */
  91 #ifdef CONFIG_CONSOLE_MUX
  92 #include <iomux.h>
  93 #endif
  94
  95 #endif