console.h 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * (C) Copyright 2000-2009
  4. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  5. */
  6. #ifndef __CONSOLE_H
  7. #define __CONSOLE_H
  8. #include <stdbool.h>
  9. #include <linux/errno.h>
  10. extern char console_buffer[];
  11. /* common/console.c */
  12. int console_init_f(void); /* Before relocation; uses the serial stuff */
  13. int console_init_r(void); /* After relocation; uses the console stuff */
  14. int console_assign(int file, const char *devname); /* Assign the console */
  15. int ctrlc(void);
  16. int had_ctrlc(void); /* have we had a Control-C since last clear? */
  17. void clear_ctrlc(void); /* clear the Control-C condition */
  18. int disable_ctrlc(int); /* 1 to disable, 0 to enable Control-C detect */
  19. int confirm_yesno(void); /* 1 if input is "y", "Y", "yes" or "YES" */
  20. #ifdef CONFIG_CONSOLE_RECORD
  21. /**
  22. * console_record_init() - set up the console recording buffers
  23. *
  24. * This should be called as soon as malloc() is available so that the maximum
  25. * amount of console output can be recorded.
  26. *
  27. * @return 0 if OK, -ENOMEM if out of memory
  28. */
  29. int console_record_init(void);
  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. * console_record_reset_enable() - reset and enable the console buffers
  38. *
  39. * This should be called to enable the console buffer.
  40. *
  41. * @return 0 (always)
  42. */
  43. int console_record_reset_enable(void);
  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. * console_record_avail() - Get the number of available bytes in console output
  57. *
  58. * @return available bytes (0 if empty)
  59. */
  60. int console_record_avail(void);
  61. #else
  62. static inline int console_record_init(void)
  63. {
  64. /* Always succeed, since it is not enabled */
  65. return 0;
  66. }
  67. static inline void console_record_reset(void)
  68. {
  69. /* Nothing to do here */
  70. }
  71. static inline int console_record_reset_enable(void)
  72. {
  73. /* Cannot enable it as it is not supported */
  74. return -ENOSYS;
  75. }
  76. static inline int console_record_readline(char *str, int maxlen)
  77. {
  78. /* Nothing to read */
  79. return 0;
  80. }
  81. static inline int console_record_avail(void)
  82. {
  83. /* There is never anything available */
  84. return 0;
  85. }
  86. #endif /* !CONFIG_CONSOLE_RECORD */
  87. /**
  88. * console_announce_r() - print a U-Boot console on non-serial consoles
  89. *
  90. * When U-Boot starts up with a display it generally does not announce itself
  91. * on the display. The banner is instead emitted on the UART before relocation.
  92. * This function prints a banner on devices which (we assume) did not receive
  93. * it before relocation.
  94. *
  95. * @return 0 (meaning no errors)
  96. */
  97. int console_announce_r(void);
  98. /**
  99. * console_puts_select_stderr() - Output a string to selected console devices
  100. *
  101. * This writes to stderr only. It is useful for outputting errors
  102. *
  103. * @serial_only: true to output only to serial, false to output to everything
  104. * else
  105. * @s: String to output
  106. */
  107. void console_puts_select_stderr(bool serial_only, const char *s);
  108. /*
  109. * CONSOLE multiplexing.
  110. */
  111. #ifdef CONFIG_CONSOLE_MUX
  112. #include <iomux.h>
  113. #endif
  114. #endif