* Iterates over registered STDIO devices and match them with given @flags
* and @name.
*
- * @return pointer to the &struct stdio_dev if found, or NULL otherwise
+ * Return: pointer to the &struct stdio_dev if found, or NULL otherwise
*/
struct stdio_dev *console_search_dev(int flags, const char *name);
* This should be called as soon as malloc() is available so that the maximum
* amount of console output can be recorded.
*
- * @return 0 if OK, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOMEM if out of memory
*/
int console_record_init(void);
*
* This should be called to enable the console buffer.
*
- * @return 0 (always)
+ * Return: 0 (always)
*/
int console_record_reset_enable(void);
*
* @str: Place to put string
* @maxlen: Maximum length of @str including nul terminator
- * @return length of string returned
+ * Return: length of string returned, or -ENOSPC if the console buffer was
+ * overflowed by the output
*/
int console_record_readline(char *str, int maxlen);
/**
* console_record_avail() - Get the number of available bytes in console output
*
- * @return available bytes (0 if empty)
+ * Return: available bytes (0 if empty)
*/
int console_record_avail(void);
+
+/**
+ * console_in_puts() - Write a string to the console input buffer
+ *
+ * This writes the given string to the console_in buffer which will then be
+ * returned if a function calls e.g. `getc()`
+ *
+ * @str: the string to write
+ * Return: the number of bytes added
+ */
+int console_in_puts(const char *str);
#else
static inline int console_record_init(void)
{
return 0;
}
+static inline int console_in_puts(const char *str)
+{
+ /* There is never anything written */
+ return 0;
+}
+
#endif /* !CONFIG_CONSOLE_RECORD */
/**
* This function prints a banner on devices which (we assume) did not receive
* it before relocation.
*
- * @return 0 (meaning no errors)
+ * Return: 0 (meaning no errors)
*/
int console_announce_r(void);