diff options
| author | Michał Barnaś <mb@semihalf.com> | 2022-03-25 11:51:02 +0100 |
|---|---|---|
| committer | Chromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2022-03-29 12:51:59 +0000 |
| commit | 5fd9a0feb416699b61169ebabb339b1b34d8895c (patch) | |
| tree | 1496f92660c0ebc1ca0b6a5e2ec19cf9d6e5d941 | |
| parent | 4d4d4bb1b1b35d8c69439fcb096c4ca6d807fcae (diff) | |
| download | chrome-ec-5fd9a0feb416699b61169ebabb339b1b34d8895c.tar.gz | |
zephyr: update documentation after removing prompt for mkbp masks
Remove the sentences that reference the mkbp wake-up masks Kconfigs
and write that the Kconfigs are automatically selected.
BRANCH=main
BUG=b:222689734
TEST=read the doc
Change-Id: I93424494f4e25c7ea22f9208106440b92c1568a6
Signed-off-by: Michał Barnaś <mb@semihalf.com>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3550277
Reviewed-by: Keith Short <keithshort@chromium.org>
| -rw-r--r-- | docs/zephyr/zephyr_mkbp.md | 15 |
1 files changed, 3 insertions, 12 deletions
diff --git a/docs/zephyr/zephyr_mkbp.md b/docs/zephyr/zephyr_mkbp.md index 3908b8e217..bedc550f7d 100644 --- a/docs/zephyr/zephyr_mkbp.md +++ b/docs/zephyr/zephyr_mkbp.md @@ -41,13 +41,9 @@ into account. ### Kconfigs -The following options must be enabled to use respective masks specified in -device tree. See [Device Tree nodes](#device-tree-nodes) paragraph for details. - -Kconfig sub-options | Default | Documentation -:---------------------------------------------- | :---------: | :------------ -`CONFIG_PLATFORM_EC_MKBP_EVENT_WAKEUP_MASK` | n | [MKBP event wake-up mask] -`CONFIG_PLATFORM_EC_MKBP_HOST_EVENT_WAKEUP_MASK`| n | [MKBP host event wake-up mask] +The Kconfigs responsible for enabling the wake-up masks are automatically +selected if the device tree nodes are specified. +See [Device Tree nodes](#device-tree-nodes) paragraph for details. ### Device Tree nodes @@ -80,8 +76,6 @@ Possible enums to use in these nodes are specified in file: [MKBP event mask enu ## Examples -[Lazor MKBP Kconfig](https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/projects/trogdor/lazor/prj.conf?q=CONFIG_PLATFORM_EC_MKBP_EVENT_WAKEUP_MASK) - [Lazor wake-up masks](https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/projects/trogdor/lazor/gpio.dts?q=ec-mkbp-host-event-wakeup-mask) For detailed descriptions of the MKBP and host event types, please see @@ -96,9 +90,6 @@ Links to the documentation [MKBP input devices]:https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/Kconfig?q=%22config%20PLATFORM_EC_MKBP_INPUT_DEVICES%22 [MKBP event]:https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/Kconfig?q=%22config%20PLATFORM_EC_MKBP_EVENT%22 -[MKBP event wake-up mask]:https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/Kconfig?q=%22config%20PLATFORM_EC_MKBP_EVENT_WAKEUP_MASK%22 -[MKBP host event wake-up mask]:https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/Kconfig?q=%22config%20PLATFORM_EC_MKBP_HOST_EVENT_WAKEUP_MASK%22 - [MKBP gpio]:https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/Kconfig.mkbp_event?q=%22config%20PLATFORM_EC_MKBP_USE_GPIO%22 [MKBP host event]:https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/Kconfig.mkbp_event?q=%22config%20PLATFORM_EC_MKBP_USE_HOST_EVENT%22 [MKBP gpio and host event]:https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform/ec/zephyr/Kconfig.mkbp_event?q=%22config%20PLATFORM_EC_MKBP_USE_GPIO_AND_HOST_EVENT%22 |