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

23 lines
566 B
Plaintext
Raw Normal View History

lib: smf: Add State Machine Framework Add an application agnostic State Machine Framework library to Zephyr that provides an easy way for developers to integrate state machines into their application. Twister passed: twister -T tests/lib/smf/ Signed-off-by: Sam Hurst <sbh1187@gmail.com>
2021-08-29 12:44:17 +08:00
# Copyright 2021 The Chromium OS Authors
# SPDX-License-Identifier: Apache-2.0
config SMF
kconfig: remove Enable from boolean prompts According to Kconfig guidelines, boolean prompts must not start with "Enable...". The following command has been used to automate the changes in this patch: sed -i "s/bool \"[Ee]nables\? \(\w\)/bool \"\U\1/g" **/Kconfig* Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-09 19:05:12 +08:00
bool "Hierarchical State Machine"
lib: smf: Add State Machine Framework Add an application agnostic State Machine Framework library to Zephyr that provides an easy way for developers to integrate state machines into their application. Twister passed: twister -T tests/lib/smf/ Signed-off-by: Sam Hurst <sbh1187@gmail.com>
2021-08-29 12:44:17 +08:00
help
This option enables the Hierarchical State Machine library
if SMF
config SMF_ANCESTOR_SUPPORT
kconfig: remove Enable from boolean prompts According to Kconfig guidelines, boolean prompts must not start with "Enable...". The following command has been used to automate the changes in this patch: sed -i "s/bool \"[Ee]nables\? \(\w\)/bool \"\U\1/g" **/Kconfig* Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-09 19:05:12 +08:00
bool "States to have 1 or more ancestors"
lib: smf: Add State Machine Framework Add an application agnostic State Machine Framework library to Zephyr that provides an easy way for developers to integrate state machines into their application. Twister passed: twister -T tests/lib/smf/ Signed-off-by: Sam Hurst <sbh1187@gmail.com>
2021-08-29 12:44:17 +08:00
help
If y, then the state machine framework includes ancestor state support
Lib: SMF: Add initial transition and smf_set_handled() Brings SMF framework closer into alignment with accepted Hierarchical State Machine operation by: 1. Allowing 'programming by difference' by having some child states handle events and prevent propagation up to the parent run actions while others propagate events up to a common handler in a parent state. 2. Optionally allow initial transitions within a parent state to determine the most nested child state to transition to. 3. Adding a test case for `CONFIG_SMF_INITIAL_TRANSITION` and `smf_set_handled()` 4. Updating documentation for the new API (and fixing some references) There was discussion in https://github.com/zephyrproject-rtos/zephyr/issues/55344 about not making the initial transition a Kconfig option, but I'm not sure of any way else of doing it without permanently adding a pointer to each `smf_state` entry, which is a problem for resource-constrained devices. This does not fix https://github.com/zephyrproject-rtos/zephyr/issues/66341 but documentation has been updated to warn users of the issue. Signed-off-by: Glenn Andrews <glenn.andrews.42@gmail.com>
2023-12-22 00:12:10 +08:00
config SMF_INITIAL_TRANSITION
depends on SMF_ANCESTOR_SUPPORT
bool "Support initial transitions for ancestor states"
help
If y, then each state can have an initial transition to a sub-state
lib: smf: Add State Machine Framework Add an application agnostic State Machine Framework library to Zephyr that provides an easy way for developers to integrate state machines into their application. Twister passed: twister -T tests/lib/smf/ Signed-off-by: Sam Hurst <sbh1187@gmail.com>
2021-08-29 12:44:17 +08:00
endif # SMF