RIOT/sys/Kconfig.stdio

# Copyright (c) 2020 HAW Hamburg
#
# This file is subject to the terms and conditions of the GNU Lesser
# General Public License v2.1. See the file LICENSE in the top level
# directory for more details.
#

menu "Standard Input/Output (STDIO)"
    depends on TEST_KCONFIG

config FORCE_USB_STDIO
    bool "Force a USB based STDIO"
    depends on HAS_PERIPH_USBDEV || HAS_TINYUSB_DEVICE
    select KCONFIG_USB
    select REQUIRES_USB_STDIO
    help
        To prevent a circular dependency, can force the USB modules to that
        STDIO will select some sort of USB based STDIO backend.

choice STDIO_IMPLEMENTATION
    bool "STDIO implementation"
    default MODULE_STDIO_NATIVE if CPU_ARCH_NATIVE
    default MODULE_STDIO_CDC_ACM if MODULE_USBUS && REQUIRES_USB_STDIO
    default MODULE_STDIO_TINYUSB_CDC_ACM if MODULE_TINYUSB_DEVICE && REQUIRES_USB_STDIO
    default MODULE_STDIO_UART

config MODULE_STDIO_RTT
    bool "JLink RTT"
    select MODULE_ZTIMER
    select MODULE_ZTIMER_MSEC

config MODULE_STDIO_SEMIHOSTING
    bool "ARM and RISC-V Semihosting"
    depends on HAS_ARCH_ARM || HAS_ARCH_RISCV
    select MODULE_ZTIMER
    select MODULE_ZTIMER_MSEC
    select USE_STDOUT_BUFFERED

config MODULE_SLIPDEV_STDIO
    bool "SLIP network device"
    depends on MODULE_SLIPDEV
    select USE_STDOUT_BUFFERED
    select MODULE_ISRPIPE

config MODULE_STDIO_NULL
    bool "Null"
    help
        Empty implementation.

config MODULE_STDIO_UART
    bool "UART"
    depends on HAS_PERIPH_UART
    select MODULE_PERIPH_UART

config MODULE_STDIO_UART_ONLCR
    bool "Emit DOS line endings for STDIO output via UART"
    depends on MODULE_STDIO_UART

config MODULE_STDIO_NATIVE
    bool "Native"
    depends on CPU_ARCH_NATIVE

config MODULE_STDIO_ETHOS
    bool "ETHOS"
    depends on MODULE_ETHOS
    select MODULE_STDIN
    select MODULE_ETHOS_STDIO
    select USE_STDOUT_BUFFERED

endchoice

config MODULE_STDIN
    bool "Standard Input"

config MODULE_STDIO_UART_RX
    bool
    depends on MODULE_STDIO_UART
    select MODULE_ISRPIPE
    select MODULE_STDIO_AVAILABLE
    default y if MODULE_STDIN
    help
        Reception when using UART-based STDIO needs to be enabled.

config MODULE_STDIO_USB_SERIAL_JTAG_RX
    bool
    depends on MODULE_STDIO_USB_SERIAL_JTAG
    select MODULE_ISRPIPE
    select MODULE_STDIO_AVAILABLE
    default y if MODULE_STDIN
    help
        Reception when using ESP32 USB Serial/JTAG STDIO needs to be enabled.

config MODULE_STDIO_AVAILABLE
    bool
    help
        Indicates that the implementation supports function stdio_available

config MODULE_PRINTF_FLOAT
    bool "Float support in printf"

config USE_STDOUT_BUFFERED
    bool
    help
        Select this to prefer buffered standard output if provided by the implementation.

config REQUIRES_USB_STDIO
    bool
    help
        Indicates that the STDIO requires some USB implementation to be enabled.

endmenu # Standard Input/Output (STDIO)
sys/stdio: add module to Kconfig 2020-07-27 17:40:05 +02:00			`# Copyright (c) 2020 HAW Hamburg`
			`#`
			`# This file is subject to the terms and conditions of the GNU Lesser`
			`# General Public License v2.1. See the file LICENSE in the top level`
			`# directory for more details.`
			`#`

sys/stdio: add stdin and stdio_uart_rx modules to Kconfig 2020-08-17 16:55:30 +02:00			`menu "Standard Input/Output (STDIO)"`
sys/stdio: add module to Kconfig 2020-07-27 17:40:05 +02:00			`depends on TEST_KCONFIG`

sys/Kconfig.stdio: Add FORCE_ and REQUIRES_ USB 2023-04-05 15:04:48 +02:00			`config FORCE_USB_STDIO`
			`bool "Force a USB based STDIO"`
			`depends on HAS_PERIPH_USBDEV \|\| HAS_TINYUSB_DEVICE`
			`select KCONFIG_USB`
			`select REQUIRES_USB_STDIO`
			`help`
			`To prevent a circular dependency, can force the USB modules to that`
			`STDIO will select some sort of USB based STDIO backend.`

sys/stdio/kconfig: associate symbol to implementation 2021-09-30 13:39:03 +02:00			`choice STDIO_IMPLEMENTATION`
sys/stdio: add module to Kconfig 2020-07-27 17:40:05 +02:00			`bool "STDIO implementation"`
sys/stdio: add stdio_native module to Kconfig 2020-07-23 08:29:34 +02:00			`default MODULE_STDIO_NATIVE if CPU_ARCH_NATIVE`
sys/sydio: Kconfig fallback to usb stdio 2023-04-06 09:19:09 +02:00			`default MODULE_STDIO_CDC_ACM if MODULE_USBUS && REQUIRES_USB_STDIO`
			`default MODULE_STDIO_TINYUSB_CDC_ACM if MODULE_TINYUSB_DEVICE && REQUIRES_USB_STDIO`
treewide: change Kconfig prefix for module symbols This changes the prefix used for the symbols that reprensent modules (not the ones generated from USEMODULE). MOD_ => MODULE_ 2020-08-31 09:57:28 +02:00			`default MODULE_STDIO_UART`
sys/stdio: add module to Kconfig 2020-07-27 17:40:05 +02:00
sys/Kconfig.stdio: add stdio_rtt 2021-11-30 14:40:17 +01:00			`config MODULE_STDIO_RTT`
			`bool "JLink RTT"`
			`select MODULE_ZTIMER`
			`select MODULE_ZTIMER_MSEC`
drivers/slipdev: add modules to Kconfig 2021-01-05 19:19:08 +01:00
sys/Kconfig.stdio: model stdio_semihosting in Kconfig 2023-05-23 10:47:53 +02:00			`config MODULE_STDIO_SEMIHOSTING`
			`bool "ARM and RISC-V Semihosting"`
			`depends on HAS_ARCH_ARM \|\| HAS_ARCH_RISCV`
			`select MODULE_ZTIMER`
			`select MODULE_ZTIMER_MSEC`
pkg/tinyusb: sys: fix stdio buffered inclusion in Kconfig 2023-06-17 15:12:31 +02:00			`select USE_STDOUT_BUFFERED`
sys/Kconfig.stdio: model stdio_semihosting in Kconfig 2023-05-23 10:47:53 +02:00
drivers/slipdev: add modules to Kconfig 2021-01-05 19:19:08 +01:00			`config MODULE_SLIPDEV_STDIO`
			`bool "SLIP network device"`
			`depends on MODULE_SLIPDEV`
sys/libc: model Kconfig 2021-09-22 10:39:37 +02:00			`select USE_STDOUT_BUFFERED`
drivers/slipdev: add modules to Kconfig 2021-01-05 19:19:08 +01:00			`select MODULE_ISRPIPE`
sys/stdio: add module to Kconfig 2020-07-27 17:40:05 +02:00
treewide: change Kconfig prefix for module symbols This changes the prefix used for the symbols that reprensent modules (not the ones generated from USEMODULE). MOD_ => MODULE_ 2020-08-31 09:57:28 +02:00			`config MODULE_STDIO_NULL`
sys/stdio: add module to Kconfig 2020-07-27 17:40:05 +02:00			`bool "Null"`
			`help`
			`Empty implementation.`

treewide: change Kconfig prefix for module symbols This changes the prefix used for the symbols that reprensent modules (not the ones generated from USEMODULE). MOD_ => MODULE_ 2020-08-31 09:57:28 +02:00			`config MODULE_STDIO_UART`
sys/stdio: add module to Kconfig 2020-07-27 17:40:05 +02:00			`bool "UART"`
			`depends on HAS_PERIPH_UART`
treewide: change Kconfig prefix for module symbols This changes the prefix used for the symbols that reprensent modules (not the ones generated from USEMODULE). MOD_ => MODULE_ 2020-08-31 09:57:28 +02:00			`select MODULE_PERIPH_UART`
sys/stdio: add module to Kconfig 2020-07-27 17:40:05 +02:00
sys/stdio_uart: add stdio_uart_onlcr (pseudo-) module Add USE_MODULE += "stdio_uart_onlcr" to enable it. This is named after the "onlcr" stty flag, which does the same thing. Co-authored-by: Marian Buschsieweke <marian.buschsieweke@ovgu.de> 2020-08-31 22:18:35 +02:00			`config MODULE_STDIO_UART_ONLCR`
			`bool "Emit DOS line endings for STDIO output via UART"`
			`depends on MODULE_STDIO_UART`

sys/stdio: add stdio_native module to Kconfig 2020-07-23 08:29:34 +02:00			`config MODULE_STDIO_NATIVE`
			`bool "Native"`
			`depends on CPU_ARCH_NATIVE`

drivers/ethos: model in Kconfig 2022-03-02 11:14:15 +01:00			`config MODULE_STDIO_ETHOS`
			`bool "ETHOS"`
			`depends on MODULE_ETHOS`
			`select MODULE_STDIN`
			`select MODULE_ETHOS_STDIO`
			`select USE_STDOUT_BUFFERED`

sys/stdio: add module to Kconfig 2020-07-27 17:40:05 +02:00			`endchoice`

sys/stdio: add stdin and stdio_uart_rx modules to Kconfig 2020-08-17 16:55:30 +02:00			`config MODULE_STDIN`
			`bool "Standard Input"`

			`config MODULE_STDIO_UART_RX`
			`bool`
			`depends on MODULE_STDIO_UART`
			`select MODULE_ISRPIPE`
sys/stdio_uart: implementation of stdio_available 2021-12-25 13:09:45 +01:00			`select MODULE_STDIO_AVAILABLE`
sys/stdio: add stdin and stdio_uart_rx modules to Kconfig 2020-08-17 16:55:30 +02:00			`default y if MODULE_STDIN`
			`help`
			`Reception when using UART-based STDIO needs to be enabled.`

cpu/esp32: add stdio_usb_serial_jtag 2022-12-29 00:35:41 +01:00			`config MODULE_STDIO_USB_SERIAL_JTAG_RX`
			`bool`
			`depends on MODULE_STDIO_USB_SERIAL_JTAG`
			`select MODULE_ISRPIPE`
			`select MODULE_STDIO_AVAILABLE`
			`default y if MODULE_STDIN`
			`help`
			`Reception when using ESP32 USB Serial/JTAG STDIO needs to be enabled.`

sys/stdio_base: add optional function stdio_available A couple of `stdio` backend implementations allow to check for the number of available bytes for reading before the blocking `stdio_read` is called. This helps to implement non-blocking functionalities while waiting for `stdin`. 2021-12-25 13:08:33 +01:00			`config MODULE_STDIO_AVAILABLE`
			`bool`
			`help`
			`Indicates that the implementation supports function stdio_available`

sys/Kconfig.stdio: add printf_float module 2020-11-19 10:02:04 +01:00			`config MODULE_PRINTF_FLOAT`
			`bool "Float support in printf"`

sys/libc: model Kconfig 2021-09-22 10:39:37 +02:00			`config USE_STDOUT_BUFFERED`
			`bool`
			`help`
			`Select this to prefer buffered standard output if provided by the implementation.`

sys/Kconfig.stdio: Add FORCE_ and REQUIRES_ USB 2023-04-05 15:04:48 +02:00			`config REQUIRES_USB_STDIO`
			`bool`
			`help`
			`Indicates that the STDIO requires some USB implementation to be enabled.`

sys/stdio: add stdin and stdio_uart_rx modules to Kconfig 2020-08-17 16:55:30 +02:00			`endmenu # Standard Input/Output (STDIO)`