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