mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-01 15:16:04 +00:00
542c2b93d0
This change introduces console_getchar() and console_getline() API calls which can be used to get pending console input (either one char or whole line), or block waiting for one. In this regard, they are similar to well-known ANSI C function getchar/gets/fgets, and are intended to ease porting of existing applications to Zephyr, and indeed, these functions (shaped as an external module) are already used by few applications. The implementation of the functions is structured as a new "console" subsystem. The intention is that further generic console code may be pulled there instead of being in drivers/console/. Besides the functions themselves, initialization code and sample applications are included. At this time, there're may limitations of how these functions can be used. For example, console_getchar() and console_getline() are mutually exclusive, and both are incompatible with callback (push-style) console API (and e.g. with console shell subsystem which uses this API). Again, the intention is to make a first step towards refactoring console subsystem to allow more flexible real-world usage, better reusability and composability. Change-Id: I3f4015bb5b26e0656f82f428b11ba30e980d25a0 Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
47 lines
1.0 KiB
C
47 lines
1.0 KiB
C
/*
|
|
* Copyright (c) 2017 Linaro Limited.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#include <zephyr.h>
|
|
#include <uart.h>
|
|
#include <drivers/console/console.h>
|
|
#include <drivers/console/uart_console.h>
|
|
|
|
/* While app processes one input line, Zephyr will have another line
|
|
* buffer to accumulate more console input.
|
|
*/
|
|
static struct console_input line_bufs[2];
|
|
|
|
static K_FIFO_DEFINE(free_queue);
|
|
static K_FIFO_DEFINE(used_queue);
|
|
|
|
char *console_getline(void)
|
|
{
|
|
static struct console_input *cmd;
|
|
|
|
/* Recycle cmd buffer returned previous time */
|
|
if (cmd != NULL) {
|
|
k_fifo_put(&free_queue, cmd);
|
|
}
|
|
|
|
cmd = k_fifo_get(&used_queue, K_FOREVER);
|
|
return cmd->line;
|
|
}
|
|
|
|
void console_getline_init(void)
|
|
{
|
|
int i;
|
|
|
|
for (i = 0; i < sizeof(line_bufs) / sizeof(*line_bufs); i++) {
|
|
k_fifo_put(&free_queue, &line_bufs[i]);
|
|
}
|
|
|
|
/* Zephyr UART handler takes an empty buffer from free_queue,
|
|
* stores UART input in it until EOL, and then puts it into
|
|
* used_queue.
|
|
*/
|
|
uart_register_input(&free_queue, &used_queue, NULL);
|
|
}
|