zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix: allow kscan-composite to wake up device. (#2682) 

* include kscan.yaml so we can set kscan-composite as a wakeup source
* modify enable and disable callback to check for wakeup capabilities of
composite and children
* disable children wakeup source

The disable function is only called
when the composite is not an enabled wakeup source.
In that case the children should also not be an enabled
wakeup source, so they can get suspended
This commit is contained in:
svek1 2024-12-11 20:46:22 +01:00 committed by GitHub
parent 84baf929c9
commit a8f5ab67b5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
app/dts/bindings/zmk,kscan-composite.yaml
View File

@ -3,6 +3,8 @@ description: |
compatible: "zmk,kscan-composite"
include: kscan.yaml
properties:
label:
type: string

15
app/module/drivers/kscan/kscan_composite.c
View File

@ -44,6 +44,13 @@ static int kscan_composite_enable_callback(const struct device *dev) {
for (int i = 0; i < cfg->children_len; i++) {
const struct kscan_composite_child_config *child_cfg = &cfg->children[i];
#if IS_ENABLED(CONFIG_PM_DEVICE_RUNTIME) || IS_ENABLED(CONFIG_PM_DEVICE)
if (pm_device_wakeup_is_enabled(dev) && pm_device_wakeup_is_capable(child_cfg->child) &&
!pm_device_wakeup_enable(child_cfg->child, true)) {
LOG_ERR("Failed to enable wakeup for %s", child_cfg->child->name);
}
#endif // IS_ENABLED(CONFIG_PM_DEVICE_RUNTIME) || IS_ENABLED(CONFIG_PM_DEVICE)
#if IS_ENABLED(CONFIG_PM_DEVICE_RUNTIME)
if (!pm_device_runtime_is_enabled(dev) && pm_device_runtime_is_enabled(child_cfg->child)) {
pm_device_runtime_get(child_cfg->child);
@ -62,6 +69,14 @@ static int kscan_composite_disable_callback(const struct device *dev) {
for (int i = 0; i < cfg->children_len; i++) {
const struct kscan_composite_child_config *child_cfg = &cfg->children[i];
#if IS_ENABLED(CONFIG_PM_DEVICE_RUNTIME) || IS_ENABLED(CONFIG_PM_DEVICE)
if (pm_device_wakeup_is_capable(child_cfg->child) &&
pm_device_wakeup_is_enabled(child_cfg->child) &&
!pm_device_wakeup_enable(child_cfg->child, false)) {
LOG_ERR("Failed to disable wakeup for %s", child_cfg->child->name);
}
#endif // IS_ENABLED(CONFIG_PM_DEVICE_RUNTIME) || IS_ENABLED(CONFIG_PM_DEVICE)
kscan_disable_callback(child_cfg->child);
#if IS_ENABLED(CONFIG_PM_DEVICE_RUNTIME)

11
docs/docs/config/kscan.md
View File

@ -223,11 +223,12 @@ Definition file: [zmk/app/dts/bindings/zmk,kscan-composite.yaml](https://github.
The `zmk,kscan-composite` node should have one child node per keyboard scan driver that should be composited. Each child node can have the following properties:
| Property | Type | Description | Default |
| ------------ | ------- | ------------------------------------------------------------------------------ | ------- |
| `kscan` | phandle | Label of the kscan driver to include | |
| `row-offset` | int | Shifts row 0 of the included driver to a new row in the composite matrix | 0 |
| `col-offset` | int | Shifts column 0 of the included driver to a new column in the composite matrix | 0 |
| Property | Type | Description | Default |
| --------------- | ------- | ------------------------------------------------------------------------------ | ------- |
| `kscan` | phandle | Label of the kscan driver to include | |
| `row-offset` | int | Shifts row 0 of the included driver to a new row in the composite matrix | 0 |
| `col-offset` | int | Shifts column 0 of the included driver to a new column in the composite matrix | 0 |
| `wakeup-source` | bool | Mark this kscan instance as able to wake the keyboard | n |
### Example Configuration