All of lore.kernel.org
 help / color / mirror / Atom feed
From: Miquel Raynal <miquel.raynal@bootlin.com>
To: Jonathan Cameron <jic23@kernel.org>,
	Lars-Peter Clausen <lars@metafoo.de>,
	Lee Jones <lee.jones@linaro.org>
Cc: Peter Meerwald-Stadler <pmeerw@pmeerw.net>,
	Rob Herring <robh+dt@kernel.org>,
	Dmitry Torokhov <dmitry.torokhov@gmail.com>,
	bcousson@baylibre.com, Tony Lindgren <tony@atomide.com>,
	linux-iio@vger.kernel.org, devicetree@vger.kernel.org,
	linux-omap@vger.kernel.org,
	Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
	Vignesh Raghavendra <vigneshr@ti.com>,
	Lokesh Vutla <lokeshvutla@ti.com>,
	Tero Kristo <kristo@kernel.org>,
	Ryan Barnett <ryan.barnett@collins.com>,
	Grygorii Strashko <grygorii.strashko@ti.com>,
	Jason Reeder <jreeder@ti.com>, <linux-kernel@vger.kernel.org>,
	Miquel Raynal <miquel.raynal@bootlin.com>,
	Rob Herring <robh@kernel.org>,
	Jonathan Cameron <Jonathan.Cameron@huawei.com>
Subject: [PATCH v4 03/48] dt-bindings: touchscreen: ti,am3359-tsc: New yaml description
Date: Tue, 28 Sep 2021 15:30:58 +0200	[thread overview]
Message-ID: <20210928133143.157329-4-miquel.raynal@bootlin.com> (raw)
In-Reply-To: <20210928133143.157329-1-miquel.raynal@bootlin.com>

This touchscreen controller is already described in a text file:
Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt

After introducing a proper description of the MFD, this is the second
step. The file cannot be removed yet as it also contains an ADC
description.

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Acked-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
---
 .../input/touchscreen/ti,am3359-tsc.yaml      | 76 +++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/ti,am3359-tsc.yaml

diff --git a/Documentation/devicetree/bindings/input/touchscreen/ti,am3359-tsc.yaml b/Documentation/devicetree/bindings/input/touchscreen/ti,am3359-tsc.yaml
new file mode 100644
index 000000000000..e44cc65abc8c
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/touchscreen/ti,am3359-tsc.yaml
@@ -0,0 +1,76 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/touchscreen/ti,am3359-tsc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TI AM3359 Touchscreen controller
+
+maintainers:
+  - Miquel Raynal <miquel.raynal@bootlin.com>
+
+properties:
+  compatible:
+    const: ti,am3359-tsc
+
+  ti,wires:
+    description: Wires refer to application modes i.e. 4/5/8 wire touchscreen
+      support on the platform.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [4, 5, 8]
+
+  ti,x-plate-resistance:
+    description: X plate resistance
+    $ref: /schemas/types.yaml#/definitions/uint32
+
+  ti,coordinate-readouts:
+    description: The sequencer supports a total of 16 programmable steps. Each
+      step is used to read a single coordinate. A single readout is enough but
+      multiple reads can increase the quality. A value of 5 means, 5 reads for
+      X, 5 for Y and 2 for Z (always). This utilises 12 of the 16 software steps
+      available. The remaining 4 can be used by the ADC.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    minimum: 1
+    maximum: 6
+
+  ti,wire-config:
+    description: Different boards could have a different order for connecting
+      wires on touchscreen. We need to provide an 8-bit number where the
+      first four bits represent the analog lines and the next 4 bits represent
+      positive/negative terminal on that input line. Notations to represent the
+      input lines and terminals respectively are as follows, AIN0 = 0, AIN1 = 1
+      and so on until AIN7 = 7. XP = 0, XN = 1, YP = 2, YN = 3.
+    $ref: /schemas/types.yaml#/definitions/uint32-array
+    minItems: 4
+    maxItems: 8
+
+  ti,charge-delay:
+    description: Length of touch screen charge delay step in terms of ADC clock
+      cycles. Charge delay value should be large in order to avoid false pen-up
+      events. This value effects the overall sampling speed, hence need to be
+      kept as low as possible, while avoiding false pen-up event. Start from a
+      lower value, say 0x400, and increase value until false pen-up events are
+      avoided. The pen-up detection happens immediately after the charge step,
+      so this does in fact function as a hardware knob for adjusting the amount
+      of "settling time".
+    $ref: /schemas/types.yaml#/definitions/uint32
+
+required:
+  - compatible
+  - ti,wires
+  - ti,x-plate-resistance
+  - ti,coordinate-readouts
+  - ti,wire-config
+
+additionalProperties: false
+
+examples:
+  - |
+    tsc {
+        compatible = "ti,am3359-tsc";
+        ti,wires = <4>;
+        ti,x-plate-resistance = <200>;
+        ti,coordinate-readouts = <5>;
+        ti,wire-config = <0x00 0x11 0x22 0x33>;
+        ti,charge-delay = <0x400>;
+    };
-- 
2.27.0


  parent reply	other threads:[~2021-09-28 13:32 UTC|newest]

Thread overview: 55+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-28 13:30 [PATCH v4 00/48] TI AM437X ADC1 Miquel Raynal
2021-09-28 13:30 ` [PATCH v4 01/48] clk: ti: am43xx: Add clkctrl data for am43xx ADC1 Miquel Raynal
2021-09-28 13:30 ` [PATCH v4 02/48] dt-bindings: mfd: ti,am3359-tscadc: Add a yaml description for this MFD Miquel Raynal
2021-09-28 13:30 ` Miquel Raynal [this message]
2021-09-28 13:30 ` [PATCH v4 04/48] dt-bindings: iio: adc: ti,am3359-adc: New yaml description Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 05/48] dt-bindings: touchscreen: ti,am3359-tsc: Remove deprecated text file Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 06/48] dt-bindings: mfd: ti,am3359-tscadc: Describe am4372 MFD compatible Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 07/48] dt-bindings: iio: adc: ti,am3359-adc: Describe am4372 ADC compatible Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 08/48] mfd: ti_am335x_tscadc: Ensure a balanced number of node get/put Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 09/48] mfd: ti_am335x_tscadc: Replace license text with SPDX tag Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 10/48] mfd: ti_am335x_tscadc: Fix style Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 11/48] mfd: ti_am335x_tscadc: Drop extra spacing when declaring stack variables Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 12/48] mfd: ti_am335x_tscadc: Get rid of useless gotos Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 13/48] mfd: ti_am335x_tscadc: Reword the comment explaining the dividers Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 14/48] mfd: ti_am335x_tscadc: Don't search the tree for our clock Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 15/48] mfd: ti_am335x_tscadc: Simplify divisor calculation Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 16/48] mfd: ti_am335x_tscadc: Move the driver structure allocation earlier Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 17/48] mfd: ti_am335x_tscadc: Use driver data Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 18/48] mfd: ti_am335x_tscadc: Mimic the probe from resume() Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 19/48] mfd: ti_am335x_tscadc: Drop useless variables from the driver structure Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 20/48] mfd: ti_am335x_tscadc: Always provide an idle configuration Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 21/48] mfd: ti_am335x_tscadc: Reorder the initialization steps Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 22/48] mfd: ti_am335x_tscadc: Gather the ctrl register logic in one place Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 23/48] mfd: ti_am335x_tscadc: Replace the header license text with SPDX tag Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 24/48] mfd: ti_am335x_tscadc: Fix header spacing Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 25/48] mfd: ti_am335x_tscadc: Use the new HZ_PER_MHZ macro Miquel Raynal
2021-09-29 15:29   ` Jonathan Cameron
2021-10-01  7:11     ` Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 26/48] mfd: ti_am335x_tscadc: Drop unused definitions from the header Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 27/48] mfd: ti_am335x_tscadc: Use BIT(), GENMASK() and FIELD_PREP() when relevant Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 28/48] mfd: ti_am335x_tscadc: Clarify the maximum values for DT entries Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 29/48] mfd: ti_am335x_tscadc: Drop useless definitions from the header Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 30/48] mfd: ti_am335x_tscadc: Rename the subsystem enable macro Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 31/48] mfd: ti_am335x_tscadc: Add TSC prefix in certain macros Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 32/48] mfd: ti_am335x_tscadc: Rename a variable Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 33/48] mfd: ti_am335x_tscadc: Fix an error message Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 34/48] mfd: ti_am335x_tscadc: Add a boolean to clarify the presence of a touchscreen Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 35/48] mfd: ti_am335x_tscadc: Introduce a helper to deal with the type of hardware Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 36/48] mfd: ti_am335x_tscadc: Add ADC1/magnetic reader support Miquel Raynal
2021-09-28 22:32   ` kernel test robot
2021-09-28 22:32     ` kernel test robot
2021-10-01  7:26     ` Miquel Raynal
2021-10-01 18:15       ` Lee Jones
2021-09-28 13:31 ` [PATCH v4 37/48] mfd: ti_am335x_tscadc: Support the correctly spelled DT property Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 38/48] iio: adc: ti_am335x_adc: Wait the idle state to avoid stalls Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 39/48] iio: adc: ti_am335x_adc: Replace license text with SPDX tag Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 40/48] iio: adc: ti_am335x_adc: Fix style Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 41/48] iio: adc: ti_am335x_adc: Get rid of useless gotos Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 42/48] iio: adc: ti_am335x_adc: Gather the checks on the delays Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 43/48] iio: adc: ti_am335x_adc: Add a unit to the timeout delay Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 44/48] iio: adc: ti_am335x_adc: Add the scale information Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 45/48] iio: adc: ti_am335x_adc: Add the am437x compatible Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 46/48] ARM: dts: am437x-cm-t43: Use a correctly spelled DT property Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 47/48] ARM: dts: am43xx: Describe the magnetic reader/ADC1 hardware module Miquel Raynal
2021-09-28 13:31 ` [PATCH v4 48/48] ARM: dts: am437x-gp-evm: enable ADC1 Miquel Raynal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210928133143.157329-4-miquel.raynal@bootlin.com \
    --to=miquel.raynal@bootlin.com \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=bcousson@baylibre.com \
    --cc=devicetree@vger.kernel.org \
    --cc=dmitry.torokhov@gmail.com \
    --cc=grygorii.strashko@ti.com \
    --cc=jic23@kernel.org \
    --cc=jreeder@ti.com \
    --cc=kristo@kernel.org \
    --cc=lars@metafoo.de \
    --cc=lee.jones@linaro.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-omap@vger.kernel.org \
    --cc=lokeshvutla@ti.com \
    --cc=pmeerw@pmeerw.net \
    --cc=robh+dt@kernel.org \
    --cc=robh@kernel.org \
    --cc=ryan.barnett@collins.com \
    --cc=thomas.petazzoni@bootlin.com \
    --cc=tony@atomide.com \
    --cc=vigneshr@ti.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.