diff mbox series

[v4,1/2] dt-bindings: input: cros-ec-keyb: Add a new property

Message ID 20210107154200.v4.1.I025fb861cd5fa0ef5286b7dce514728e9df7ae74@changeid (mailing list archive)
State Superseded
Headers show
Series [v4,1/2] dt-bindings: input: cros-ec-keyb: Add a new property | expand

Commit Message

Philip Chen Jan. 7, 2021, 11:42 p.m. UTC
This patch adds a new property `function-row-physmap` to the
device tree for the custom keyboard top row design.

The property describes the rows/columns of the top row keys
from left to right.

Signed-off-by: Philip Chen <philipchen@chromium.org>
---

(no changes since v2)

Changes in v2:
- add `function-row-physmap` instead of `google,custom-keyb-top-row`

 .../devicetree/bindings/input/google,cros-ec-keyb.yaml | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Stephen Boyd Jan. 12, 2021, 2:10 a.m. UTC | #1
Quoting Philip Chen (2021-01-07 15:42:08)
> This patch adds a new property `function-row-physmap` to the

From Documentation/process/submitting-patches.rst

Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
to do frotz", as if you are giving orders to the codebase to change
its behaviour.

> device tree for the custom keyboard top row design.
> 
> The property describes the rows/columns of the top row keys
> from left to right.
> 
> Signed-off-by: Philip Chen <philipchen@chromium.org>
> ---
> diff --git a/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml b/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
> index 8e50c14a9d778..7acdb33781d30 100644
> --- a/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
> +++ b/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
> @@ -31,6 +31,16 @@ properties:
>        if the EC does not have its own logic or hardware for this.
>      type: boolean
>  
> +  function-row-physmap:

Is there any minimum/maximum number of elements possible?

> +    $ref: '/schemas/types.yaml#/definitions/uint32-array'
> +    description: |
> +      An ordered u32 array describing the rows/columns (in the scan matrix)
> +      of top row keys from physical left (KEY_F1) to right. Each entry
> +      encodes the row/column as:
> +      (((row) & 0xFF) << 24) | (((column) & 0xFF) << 16)
> +      where the lower 16 bits are reserved. This property is specified only
> +      when the keyboard has a custom design for the top row keys.
> +
Philip Chen Jan. 12, 2021, 11:29 p.m. UTC | #2
On Mon, Jan 11, 2021 at 6:10 PM Stephen Boyd <swboyd@chromium.org> wrote:
>
> Quoting Philip Chen (2021-01-07 15:42:08)
> > This patch adds a new property `function-row-physmap` to the
>
> From Documentation/process/submitting-patches.rst
>
> Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
> instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
> to do frotz", as if you are giving orders to the codebase to change
> its behaviour.
I was aware of this guideline, but I thought it only applies to the
summary line.
I'll apply the guideline to the whole description.
Thanks!
>
> > device tree for the custom keyboard top row design.
> >
> > The property describes the rows/columns of the top row keys
> > from left to right.
> >
> > Signed-off-by: Philip Chen <philipchen@chromium.org>
> > ---
> > diff --git a/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml b/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
> > index 8e50c14a9d778..7acdb33781d30 100644
> > --- a/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
> > +++ b/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
> > @@ -31,6 +31,16 @@ properties:
> >        if the EC does not have its own logic or hardware for this.
> >      type: boolean
> >
> > +  function-row-physmap:
>
> Is there any minimum/maximum number of elements possible?
The maximum is 15.
There is no definition for the minimum - we can probably say the minimum is 1.
>
> > +    $ref: '/schemas/types.yaml#/definitions/uint32-array'
> > +    description: |
> > +      An ordered u32 array describing the rows/columns (in the scan matrix)
> > +      of top row keys from physical left (KEY_F1) to right. Each entry
> > +      encodes the row/column as:
> > +      (((row) & 0xFF) << 24) | (((column) & 0xFF) << 16)
> > +      where the lower 16 bits are reserved. This property is specified only
> > +      when the keyboard has a custom design for the top row keys.
> > +
Stephen Boyd Jan. 13, 2021, 6:52 a.m. UTC | #3
Quoting Philip Chen (2021-01-12 15:29:11)
> On Mon, Jan 11, 2021 at 6:10 PM Stephen Boyd <swboyd@chromium.org> wrote:
> > Quoting Philip Chen (2021-01-07 15:42:08)
> > > ---
> > > diff --git a/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml b/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
> > > index 8e50c14a9d778..7acdb33781d30 100644
> > > --- a/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
> > > +++ b/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
> > > @@ -31,6 +31,16 @@ properties:
> > >        if the EC does not have its own logic or hardware for this.
> > >      type: boolean
> > >
> > > +  function-row-physmap:
> >
> > Is there any minimum/maximum number of elements possible?
> The maximum is 15.
> There is no definition for the minimum - we can probably say the minimum is 1.

Ok cool. Please add min/max of 1 to 15 to the binding.

> >
> > > +    $ref: '/schemas/types.yaml#/definitions/uint32-array'
> > > +    description: |
> > > +      An ordered u32 array describing the rows/columns (in the scan matrix)
> > > +      of top row keys from physical left (KEY_F1) to right. Each entry
> > > +      encodes the row/column as:
> > > +      (((row) & 0xFF) << 24) | (((column) & 0xFF) << 16)
> > > +      where the lower 16 bits are reserved. This property is specified only
> > > +      when the keyboard has a custom design for the top row keys.
> > > +
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml b/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
index 8e50c14a9d778..7acdb33781d30 100644
--- a/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
+++ b/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml
@@ -31,6 +31,16 @@  properties:
       if the EC does not have its own logic or hardware for this.
     type: boolean
 
+  function-row-physmap:
+    $ref: '/schemas/types.yaml#/definitions/uint32-array'
+    description: |
+      An ordered u32 array describing the rows/columns (in the scan matrix)
+      of top row keys from physical left (KEY_F1) to right. Each entry
+      encodes the row/column as:
+      (((row) & 0xFF) << 24) | (((column) & 0xFF) << 16)
+      where the lower 16 bits are reserved. This property is specified only
+      when the keyboard has a custom design for the top row keys.
+
 required:
   - compatible