aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJoel Spadin <[email protected]>2024-11-09 20:44:39 -0600
committerPete Johanson <[email protected]>2024-11-12 09:07:25 -0700
commitc7473fc32557d2d384ab78d3acf51a05488f0214 (patch)
treee90864614cf19c432ae89f05d208b73b79b594f4
parent9320271dde53fa98baf0007187149a747dfa6954 (diff)
downloadzmk-c7473fc32557d2d384ab78d3acf51a05488f0214.tar.gz
zmk-c7473fc32557d2d384ab78d3acf51a05488f0214.zip
fix: Fix inconsistent column offset property
Renamed the composite kscan's column-offset property to col-offset for consistency with other properties such as matrix transform's col-offset and matrix kscan's col-gpios.
-rw-r--r--app/boards/arm/ferris/ferris_rev02.dts2
-rw-r--r--app/boards/shields/snap/snap_right.overlay2
-rw-r--r--app/dts/bindings/zmk,kscan-composite.yaml5
-rw-r--r--app/module/drivers/kscan/kscan_composite.c2
-rw-r--r--docs/docs/config/kscan.md10
5 files changed, 13 insertions, 8 deletions
diff --git a/app/boards/arm/ferris/ferris_rev02.dts b/app/boards/arm/ferris/ferris_rev02.dts
index b649129b20..1ec9a8043e 100644
--- a/app/boards/arm/ferris/ferris_rev02.dts
+++ b/app/boards/arm/ferris/ferris_rev02.dts
@@ -54,7 +54,7 @@
right {
kscan = <&kscan_right>;
- column-offset = <5>;
+ col-offset = <5>;
};
};
diff --git a/app/boards/shields/snap/snap_right.overlay b/app/boards/shields/snap/snap_right.overlay
index b303316a90..27955de2b0 100644
--- a/app/boards/shields/snap/snap_right.overlay
+++ b/app/boards/shields/snap/snap_right.overlay
@@ -23,7 +23,7 @@ kscan_direct: kscan_direct {
direct {
kscan = <&kscan_direct>;
row-offset = <1>;
- column-offset = <8>;
+ col-offset = <8>;
};
};
diff --git a/app/dts/bindings/zmk,kscan-composite.yaml b/app/dts/bindings/zmk,kscan-composite.yaml
index 857ef34fa4..ea6cc41619 100644
--- a/app/dts/bindings/zmk,kscan-composite.yaml
+++ b/app/dts/bindings/zmk,kscan-composite.yaml
@@ -26,6 +26,11 @@ child-binding:
row-offset:
type: int
default: 0
+ col-offset:
+ type: int
+ default: 0
+
column-offset:
type: int
default: 0
+ deprecated: true
diff --git a/app/module/drivers/kscan/kscan_composite.c b/app/module/drivers/kscan/kscan_composite.c
index a064903a74..5b809d1721 100644
--- a/app/module/drivers/kscan/kscan_composite.c
+++ b/app/module/drivers/kscan/kscan_composite.c
@@ -25,7 +25,7 @@ struct kscan_composite_child_config {
#define CHILD_CONFIG(inst) \
{.child = DEVICE_DT_GET(DT_PHANDLE(inst, kscan)), \
.row_offset = DT_PROP(inst, row_offset), \
- .column_offset = DT_PROP(inst, column_offset)},
+ .column_offset = DT_PROP_OR(inst, col_offset, DT_PROP(inst, column_offset))},
struct kscan_composite_config {
const struct kscan_composite_child_config *children;
diff --git a/docs/docs/config/kscan.md b/docs/docs/config/kscan.md
index f61812e461..6e9aab02ab 100644
--- a/docs/docs/config/kscan.md
+++ b/docs/docs/config/kscan.md
@@ -223,11 +223,11 @@ 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 |
-| `column-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 |
### Example Configuration