[v3,1/3] dt-bindings: chrome: Add ChromeOS fingerprint binding

Commit Message

Stephen Boyd March 18, 2022, 1:54 a.m. UTC

Add a binding to describe the fingerprint processor found on Chromebooks
with a fingerprint sensor.

Cc: Rob Herring <[e-mail]>
Cc: <[e-mail]>
Cc: Guenter Roeck <[e-mail]>
Cc: Douglas Anderson <[e-mail]>
Cc: Craig Hesling <[e-mail]>
Cc: Tom Hughes <[e-mail]>
Cc: Alexandru M Stan <[e-mail]>
Cc: Tzung-Bi Shih <[e-mail]>
Cc: Matthias Kaehlcke <[e-mail]>
Signed-off-by: Stephen Boyd <[e-mail]>
---
 .../bindings/chrome/google,cros-ec-fp.yaml    | 66 +++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/chrome/google,cros-ec-fp.yaml

Comments

Doug Anderson March 18, 2022, 8:49 p.m. UTC | #1

Hi,

On Thu, Mar 17, 2022 at 6:54 PM Stephen Boyd <[e-mail]> wrote:
>
> Add a binding to describe the fingerprint processor found on Chromebooks
> with a fingerprint sensor.

It might be worth mentioning that previously these fingerprint devices
were described using "google,cros-ec-spi" just to provide context?


> Cc: Rob Herring <[e-mail]>
> Cc: <[e-mail]>
> Cc: Guenter Roeck <[e-mail]>
> Cc: Douglas Anderson <[e-mail]>
> Cc: Craig Hesling <[e-mail]>
> Cc: Tom Hughes <[e-mail]>
> Cc: Alexandru M Stan <[e-mail]>
> Cc: Tzung-Bi Shih <[e-mail]>
> Cc: Matthias Kaehlcke <[e-mail]>
> Signed-off-by: Stephen Boyd <[e-mail]>
> ---
>  .../bindings/chrome/google,cros-ec-fp.yaml    | 66 +++++++++++++++++++
>  1 file changed, 66 insertions(+)
>  create mode 100644 Documentation/

Reviewed-by: Douglas Anderson <[e-mail]>

Stephen Boyd March 18, 2022, 9:12 p.m. UTC | #2

Quoting Doug Anderson (2022-03-18 13:49:05)
> Hi,
>
> On Thu, Mar 17, 2022 at 6:54 PM Stephen Boyd <[e-mail]> wrote:
> >
> > Add a binding to describe the fingerprint processor found on Chromebooks
> > with a fingerprint sensor.
>
> It might be worth mentioning that previously these fingerprint devices
> were described using "google,cros-ec-spi" just to provide context?

Sure I squashed it in.

>
>
> > Cc: Rob Herring <[e-mail]>
> > Cc: <[e-mail]>
> > Cc: Guenter Roeck <[e-mail]>
> > Cc: Douglas Anderson <[e-mail]>
> > Cc: Craig Hesling <[e-mail]>
> > Cc: Tom Hughes <[e-mail]>
> > Cc: Alexandru M Stan <[e-mail]>
> > Cc: Tzung-Bi Shih <[e-mail]>
> > Cc: Matthias Kaehlcke <[e-mail]>
> > Signed-off-by: Stephen Boyd <[e-mail]>
> > ---
> >  .../bindings/chrome/google,cros-ec-fp.yaml    | 66 +++++++++++++++++++
> >  1 file changed, 66 insertions(+)
> >  create mode 100644 Documentation/
>
> Reviewed-by: Douglas Anderson <[e-mail]>

Patch

diff --git a/Documentation/devicetree/bindings/chrome/google,cros-ec-fp.yaml b/Documentation/devicetree/bindings/chrome/google,cros-ec-fp.yaml
new file mode 100644
index 000000000000..b7fbaaa94d65
--- /dev/null
+++ b/Documentation/devicetree/bindings/chrome/google,cros-ec-fp.yaml
@@ -0,0 +1,66 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/chrome/google,cros-ec-fp.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ChromeOS Embedded Fingerprint Controller
+
+description:
+  Google's ChromeOS embedded fingerprint controller is a device which
+  implements fingerprint functionality such as unlocking a Chromebook
+  without typing a password.
+
+maintainers:
+  - Tom Hughes <[e-mail]>
+
+properties:
+  compatible:
+    const: google,cros-ec-fp
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency:
+    maximum: 3000000
+
+  interrupts:
+    maxItems: 1
+
+  reset-gpios: true
+  boot0-gpios:
+    maxItems: 1
+    description: Assert for bootloader mode.
+
+  vdd-supply: true
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - reset-gpios
+  - boot0-gpios
+  - vdd-supply
+  - spi-max-frequency
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/gpio/gpio.h>
+    spi {
+      #address-cells = <0x1>;
+      #size-cells = <0x0>;
+      ec@0 {
+        compatible = "google,cros-ec-fp";
+        reg = <0>;
+        interrupt-parent = <&gpio_controller>;
+        interrupts = <4 IRQ_TYPE_LEVEL_LOW>;
+        spi-max-frequency = <3000000>;
+        reset-gpios = <&gpio_controller 5 GPIO_ACTIVE_LOW>;
+        boot0-gpios = <&gpio_controller 10 GPIO_ACTIVE_HIGH>;
+        vdd-supply = <&pp3300_fp_mcu>;
+      };
+    };
+...