zephyr/subsys/console/getchar.c
Gerard Marull-Paretas 79e6b0e0f6 includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h>
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>.
This patch proposes to then include <zephyr/kernel.h> instead of
<zephyr/zephyr.h> since it is more clear that you are including the
Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a
catch-all header that may be confusing. Most applications need to
include a bunch of other things to compile, e.g. driver headers or
subsystem headers like BT, logging, etc.

The idea of a catch-all header in Zephyr is probably not feasible
anyway. Reason is that Zephyr is not a library, like it could be for
example `libpython`. Zephyr provides many utilities nowadays: a kernel,
drivers, subsystems, etc and things will likely grow. A catch-all header
would be massive, difficult to keep up-to-date. It is also likely that
an application will only build a small subset. Note that subsystem-level
headers may use a catch-all approach to make things easier, though.

NOTE: This patch is **NOT** removing the header, just removing its usage
in-tree. I'd advocate for its deprecation (add a #warning on it), but I
understand many people will have concerns.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-09-05 16:31:47 +02:00

80 lines
1.6 KiB
C

/*
* Copyright (c) 2017 Linaro Limited.
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <zephyr/console/console.h>
#include <zephyr/console/tty.h>
#include <zephyr/drivers/uart.h>
static struct tty_serial console_serial;
static uint8_t console_rxbuf[CONFIG_CONSOLE_GETCHAR_BUFSIZE];
static uint8_t console_txbuf[CONFIG_CONSOLE_PUTCHAR_BUFSIZE];
ssize_t console_write(void *dummy, const void *buf, size_t size)
{
ARG_UNUSED(dummy);
return tty_write(&console_serial, buf, size);
}
ssize_t console_read(void *dummy, void *buf, size_t size)
{
ARG_UNUSED(dummy);
return tty_read(&console_serial, buf, size);
}
int console_putchar(char c)
{
return tty_write(&console_serial, &c, 1);
}
int console_getchar(void)
{
uint8_t c;
int res;
res = tty_read(&console_serial, &c, 1);
if (res < 0) {
return res;
}
return c;
}
int console_init(void)
{
const struct device *uart_dev;
int ret;
uart_dev = DEVICE_DT_GET(DT_CHOSEN(zephyr_console));
if (!device_is_ready(uart_dev)) {
return -ENODEV;
}
ret = tty_init(&console_serial, uart_dev);
if (ret) {
return ret;
}
/* Checks device driver supports for interrupt driven data transfers. */
if (CONFIG_CONSOLE_GETCHAR_BUFSIZE + CONFIG_CONSOLE_PUTCHAR_BUFSIZE) {
const struct uart_driver_api *api =
(const struct uart_driver_api *)uart_dev->api;
if (!api->irq_callback_set) {
return -ENOTSUP;
}
}
tty_set_tx_buf(&console_serial, console_txbuf, sizeof(console_txbuf));
tty_set_rx_buf(&console_serial, console_rxbuf, sizeof(console_rxbuf));
return 0;
}