diff mbox series

[v4,1/2] dt-bindings: input: touchscreen: ilitek_ts_i2c: Add bindings

Message ID 20210302085130.2558297-1-joe_hung@ilitek.com
State Superseded
Headers show
Series [v4,1/2] dt-bindings: input: touchscreen: ilitek_ts_i2c: Add bindings | expand

Commit Message

Joe Hung March 2, 2021, 8:51 a.m. UTC
Add binding documentation for ILITEK touch devices.

Signed-off-by: Joe Hung <joe_hung@ilitek.com>
---
Changes in v4:
  - Change IRQ flag to level interrupt
  - Add support for common touchscreen-related properties
  - Modify reset gpio to active low
  - Modify irq type to LEVEL_LOW
  - Add compatible for Lego series ICs

Changes in v3:
  - Add include header in examples, and pass the dt binding check

Changes in v2:
  - Convert to DT schema format
  - Using interrupts instead of irq-gpios

 .../input/touchscreen/ilitek_ts_i2c.yaml      | 68 +++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml

--
2.25.1

Comments

Rob Herring (Arm) March 3, 2021, 11:14 p.m. UTC | #1
On Tue, 02 Mar 2021 16:51:29 +0800, Joe Hung wrote:
> Add binding documentation for ILITEK touch devices.

> 

> Signed-off-by: Joe Hung <joe_hung@ilitek.com>

> ---

> Changes in v4:

>   - Change IRQ flag to level interrupt

>   - Add support for common touchscreen-related properties

>   - Modify reset gpio to active low

>   - Modify irq type to LEVEL_LOW

>   - Add compatible for Lego series ICs

> 

> Changes in v3:

>   - Add include header in examples, and pass the dt binding check

> 

> Changes in v2:

>   - Convert to DT schema format

>   - Using interrupts instead of irq-gpios

> 

>  .../input/touchscreen/ilitek_ts_i2c.yaml      | 68 +++++++++++++++++++

>  1 file changed, 68 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml

> 


My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:
./Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml:60:1: [error] syntax error: found character '\t' that cannot start any token (syntax)

dtschema/dtc warnings/errors:
make[1]: *** Deleting file 'Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.example.dts'
Traceback (most recent call last):
  File "/usr/local/bin/dt-extract-example", line 45, in <module>
    binding = yaml.load(open(args.yamlfile, encoding='utf-8').read())
  File "/usr/local/lib/python3.8/dist-packages/ruamel/yaml/main.py", line 343, in load
    return constructor.get_single_data()
  File "/usr/local/lib/python3.8/dist-packages/ruamel/yaml/constructor.py", line 111, in get_single_data
    node = self.composer.get_single_node()
  File "_ruamel_yaml.pyx", line 706, in _ruamel_yaml.CParser.get_single_node
  File "_ruamel_yaml.pyx", line 724, in _ruamel_yaml.CParser._compose_document
  File "_ruamel_yaml.pyx", line 775, in _ruamel_yaml.CParser._compose_node
  File "_ruamel_yaml.pyx", line 889, in _ruamel_yaml.CParser._compose_mapping_node
  File "_ruamel_yaml.pyx", line 773, in _ruamel_yaml.CParser._compose_node
  File "_ruamel_yaml.pyx", line 848, in _ruamel_yaml.CParser._compose_sequence_node
  File "_ruamel_yaml.pyx", line 904, in _ruamel_yaml.CParser._parse_next_event
ruamel.yaml.scanner.ScannerError: while scanning a block scalar
  in "<unicode string>", line 53, column 5
found a tab character where an indentation space is expected
  in "<unicode string>", line 60, column 1
make[1]: *** [Documentation/devicetree/bindings/Makefile:20: Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.example.dts] Error 1
make[1]: *** Waiting for unfinished jobs....
./Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml:  while scanning a block scalar
  in "<unicode string>", line 53, column 5
found a tab character where an indentation space is expected
  in "<unicode string>", line 60, column 1
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml: ignoring, error parsing file
warning: no schema found in file: ./Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml
make: *** [Makefile:1380: dt_binding_check] Error 2

See https://patchwork.ozlabs.org/patch/1446274

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.
Joe Hung March 4, 2021, 3:54 a.m. UTC | #2
Hello Rob,

Sorry, I think I ran dt_bindin_check mistakenly.
Error should be corrected in v5 shortly.

On Wed, 03 Mar 2021 17:14:36 -0600, Rob Herring wrote:
> On Tue, 02 Mar 2021 16:51:29 +0800, Joe Hung wrote:

> > Add binding documentation for ILITEK touch devices.

> > 

> > Signed-off-by: Joe Hung <joe_hung@ilitek.com>

> > ---

> > Changes in v4:

> >   - Change IRQ flag to level interrupt

> >   - Add support for common touchscreen-related properties

> >   - Modify reset gpio to active low

> >   - Modify irq type to LEVEL_LOW

> >   - Add compatible for Lego series ICs

> > 

> > Changes in v3:

> >   - Add include header in examples, and pass the dt binding check

> > 

> > Changes in v2:

> >   - Convert to DT schema format

> >   - Using interrupts instead of irq-gpios

> > 

> >  .../input/touchscreen/ilitek_ts_i2c.yaml      | 68 +++++++++++++++++++

> >  1 file changed, 68 insertions(+)

> >  create mode 100644 Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml

> > 

> 

> My bot found errors running 'make dt_binding_check' on your patch:

> 

> yamllint warnings/errors:

> ./Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml:60:1: [error] syntax error: found character '\t' that cannot start any token (syntax)

> 

> dtschema/dtc warnings/errors:

> make[1]: *** Deleting file 'Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.example.dts'

> Traceback (most recent call last):

>   File "/usr/local/bin/dt-extract-example", line 45, in <module>

>     binding = yaml.load(open(args.yamlfile, encoding='utf-8').read())

>   File "/usr/local/lib/python3.8/dist-packages/ruamel/yaml/main.py", line 343, in load

>     return constructor.get_single_data()

>   File "/usr/local/lib/python3.8/dist-packages/ruamel/yaml/constructor.py", line 111, in get_single_data

>     node = self.composer.get_single_node()

>   File "_ruamel_yaml.pyx", line 706, in _ruamel_yaml.CParser.get_single_node

>   File "_ruamel_yaml.pyx", line 724, in _ruamel_yaml.CParser._compose_document

>   File "_ruamel_yaml.pyx", line 775, in _ruamel_yaml.CParser._compose_node

>   File "_ruamel_yaml.pyx", line 889, in _ruamel_yaml.CParser._compose_mapping_node

>   File "_ruamel_yaml.pyx", line 773, in _ruamel_yaml.CParser._compose_node

>   File "_ruamel_yaml.pyx", line 848, in _ruamel_yaml.CParser._compose_sequence_node

>   File "_ruamel_yaml.pyx", line 904, in _ruamel_yaml.CParser._parse_next_event

> ruamel.yaml.scanner.ScannerError: while scanning a block scalar

>   in "<unicode string>", line 53, column 5

> found a tab character where an indentation space is expected

>   in "<unicode string>", line 60, column 1

> make[1]: *** [Documentation/devicetree/bindings/Makefile:20: Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.example.dts] Error 1

> make[1]: *** Waiting for unfinished jobs....

> ./Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml:  while scanning a block scalar

>   in "<unicode string>", line 53, column 5

> found a tab character where an indentation space is expected

>   in "<unicode string>", line 60, column 1

> /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml: ignoring, error parsing file

> warning: no schema found in file: ./Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml

> make: *** [Makefile:1380: dt_binding_check] Error 2

> 

> See https://patchwork.ozlabs.org/patch/1446274

> 

> This check can fail if there are any dependencies. The base for a patch

> series is generally the most recent rc1.

> 

> If you already ran 'make dt_binding_check' and didn't see the above

> error(s), then make sure 'yamllint' is installed and dt-schema is up to

> date:

> 

> pip3 install dtschema --upgrade

> 

> Please check and re-submit.


Thank you very much.
--

Joe Hung
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml b/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml
new file mode 100644
index 000000000000..7fe7ee8a8b20
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml
@@ -0,0 +1,68 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/touchscreen/ilitek_ts_i2c.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Ilitek I2C Touchscreen Controller
+
+maintainers:
+  - Dmitry Torokhov <dmitry.torokhov@gmail.com>
+
+allOf:
+  - $ref: touchscreen.yaml#
+
+properties:
+  compatible:
+    enum:
+      - ilitek,ili2130
+      - ilitek,ili2131
+      - ilitek,ili2132
+      - ilitek,ili2316
+      - ilitek,ili2322
+      - ilitek,ili2323
+      - ilitek,ili2326
+      - ilitek,ili2520
+      - ilitek,ili2521
+  reg:
+    const: 0x41
+  interrupts:
+    maxItems: 1
+  reset-gpios:
+    maxItems: 1
+
+  touchscreen-size-x: true
+  touchscreen-size-y: true
+  touchscreen-inverted-x: true
+  touchscreen-inverted-y: true
+  touchscreen-swapped-x-y: true
+
+  wakeup-source:
+    type: boolean
+    description: touchscreen can be used as a wakeup source.
+
+additionalProperties: false
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - reset-gpios
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/gpio/gpio.h>
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        touchscreen@41 {
+		 compatible = "ilitek,ili2520";
+		 reg = <0x41>;
+                interrupt-parent = <&gpio1>;
+                interrupts = <7 IRQ_TYPE_LEVEL_LOW>;
+		 reset-gpios = <&gpio1 8 GPIO_ACTIVE_LOW>;
+
+		 touchscreen-inverted-y;
+        };
+    };