OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/subsys/console/Kconfig

50 lines
1.2 KiB
Plaintext
Raw Normal View History

subsys: console: Add pull-style console API support. 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>
2017-03-24 18:50:16 +08:00
# Copyright (c) 2017 Linaro Limited
# SPDX-License-Identifier: Apache-2.0
console: kconfig: Put 'menuconfig CONSOLE_SUBSYS' in top-level menu The 'Console' menu contains just 'config CONSOLE_SUBSYS' and its indented children. Remove one menu level by removing the 'Console' menu and turning CONSOLE_SUBSYS into a 'menuconfig' symbol. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-05-14 05:23:31 +08:00
menuconfig CONSOLE_SUBSYS
subsys: console: Mark as EXPERIMENTAL. This subsys is in the process of collecting requirements/usecases, the API is subject to change. (Should have been marked experimental from the beginning.) Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2018-08-07 22:16:47 +08:00
bool "Console subsystem/support routines [EXPERIMENTAL]"
subsys: console: Add pull-style console API support. 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>
2017-03-24 18:50:16 +08:00
help
subsys: console: Factor out fifo-based console input abstraction Console subsystem is intended to be a layer between console drivers and console clients, like e.g. shell. This change factors out code from shell which dealed with individial console drivers and moves it to console subsystem, under the name console_register_line_input(). To accommodate for this change, older console subsys Kconfig symbol is changed from CONFIG_CONSOLE_PULL to CONFIG_CONSOLE_SUBSYS (CONFIG_CONSOLE is already used by console drivers). This signifies that console subsystem is intended to deal with all of console aspects in Zephyr (existing and new), not just provide some "new" functionality on top of raw console drivers, like it initially started. Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2018-06-08 03:30:21 +08:00
Console subsystem and helper functions
subsys: console: Add pull-style console API support. 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>
2017-03-24 18:50:16 +08:00
subsys: console: Factor out fifo-based console input abstraction Console subsystem is intended to be a layer between console drivers and console clients, like e.g. shell. This change factors out code from shell which dealed with individial console drivers and moves it to console subsystem, under the name console_register_line_input(). To accommodate for this change, older console subsys Kconfig symbol is changed from CONFIG_CONSOLE_PULL to CONFIG_CONSOLE_SUBSYS (CONFIG_CONSOLE is already used by console drivers). This signifies that console subsystem is intended to deal with all of console aspects in Zephyr (existing and new), not just provide some "new" functionality on top of raw console drivers, like it initially started. Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2018-06-08 03:30:21 +08:00
if CONSOLE_SUBSYS
console: kconfig: Put 'menuconfig CONSOLE_SUBSYS' in top-level menu The 'Console' menu contains just 'config CONSOLE_SUBSYS' and its indented children. Remove one menu level by removing the 'Console' menu and turning CONSOLE_SUBSYS into a 'menuconfig' symbol. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-05-14 05:23:31 +08:00
subsys: console: Add pull-style console API support. 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>
2017-03-24 18:50:16 +08:00
choice
prompt "Console 'get' function selection"
subsys: console: Make CONSOLE_GETCHAR and *_GETLINE optional It should be possible to make both these options off, and that should be default, otherwise targets not supporting them yet, e.g. native_posix, have build issues. Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2018-06-18 23:38:01 +08:00
optional
console: kconfig: Have CONSOLE_{GETCHAR,GETLINE} depend on UART_CONSOLE CONSOLE_GETCHAR and CONSOLE_GETLINE select CONSOLE_HANDLER and UART_CONSOLE_DEBUG_SERVER_HOOKS, which depend on UART_CONSOLE, but UART_CONSOLE is n for some boards, giving a select with unsatisfied dependencies and a warning. Triggers in CI. Looking at the code, CONSOLE_{GETCHAR,GETLINE} also depend on UART_CONSOLE there. Add a 'depends on UART_CONSOLE' to the 'choice' that contains them. Maybe the samples/subsys/console/{echo,getchar}/ samples shouldn't be run on some boards that they're currently run on, but there's still the issue that CONSOLE_{GETCHAR,GETLINE} shouldn't be shown in menuconfig when they don't apply. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2020-01-23 02:21:48 +08:00
depends on UART_CONSOLE
subsys: console: Add pull-style console API support. 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>
2017-03-24 18:50:16 +08:00
config CONSOLE_GETCHAR
subsys: console: Add buffered output support to console subsystem Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2017-04-10 15:47:28 +08:00
bool "Character by character input and output"
subsys: console: Add pull-style console API support. 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>
2017-03-24 18:50:16 +08:00
select UART_CONSOLE_DEBUG_SERVER_HOOKS
select CONSOLE_HANDLER
config CONSOLE_GETLINE
bool "Line by line input"
select CONSOLE_HANDLER
endchoice
if CONSOLE_GETCHAR
config CONSOLE_GETCHAR_BUFSIZE
int "console_getchar() buffer size"
default 16
help
console: Kconfig: Update for recent changes Buffer sizes aren't required to be power of 2 for a while. Describe that by setting buffers sizes to 0, one can get non interrupt driven operation. Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2018-12-14 16:56:10 +08:00
Buffer size for console_getchar(). The default is optimized
to save RAM. You may need to increase it e.g. to support
large host-side clipboard pastes. Set to 0 to disable
interrupt-driven operation and use busy-polling.
subsys: console: Add pull-style console API support. 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>
2017-03-24 18:50:16 +08:00
subsys: console: Add buffered output support to console subsystem Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2017-04-10 15:47:28 +08:00
config CONSOLE_PUTCHAR_BUFSIZE
int "console_putchar() buffer size"
default 16
help
console: Kconfig: Update for recent changes Buffer sizes aren't required to be power of 2 for a while. Describe that by setting buffers sizes to 0, one can get non interrupt driven operation. Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2018-12-14 16:56:10 +08:00
Buffer size for console_putchar(). The default is optimized
to save RAM. You may need to increase it e.g. to support
large host-side clipboard pastes. Set to 0 to disable
interrupt-driven operation and use busy-polling.
subsys: console: Add buffered output support to console subsystem Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2017-04-10 15:47:28 +08:00
subsys: console: Add pull-style console API support. 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>
2017-03-24 18:50:16 +08:00
endif # CONSOLE_GETCHAR
subsys: console: Factor out fifo-based console input abstraction Console subsystem is intended to be a layer between console drivers and console clients, like e.g. shell. This change factors out code from shell which dealed with individial console drivers and moves it to console subsystem, under the name console_register_line_input(). To accommodate for this change, older console subsys Kconfig symbol is changed from CONFIG_CONSOLE_PULL to CONFIG_CONSOLE_SUBSYS (CONFIG_CONSOLE is already used by console drivers). This signifies that console subsystem is intended to deal with all of console aspects in Zephyr (existing and new), not just provide some "new" functionality on top of raw console drivers, like it initially started. Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2018-06-08 03:30:21 +08:00
endif # CONSOLE_SUBSYS