console.h 4.3 KB

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