linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Miquel Raynal <miquel.raynal@bootlin.com>
To: Jonathan Cameron <jic23@kernel.org>,
	Lee Jones <lee.jones@linaro.org>,
	linux-iio@vger.kernel.org, linux-omap@vger.kernel.org,
	Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
	Ryan Barnett <ryan.barnett@collins.com>,
	linux-kernel@vger.kernel.org
Cc: Miquel Raynal <miquel.raynal@bootlin.com>,
	Rob Herring <robh@kernel.org>,
	Jonathan Cameron <Jonathan.Cameron@huawei.com>,
	Dmitry Torokhov <dmitry.torokhov@gmail.com>
Subject: [PATCH v6 03/48] dt-bindings: touchscreen: ti,am3359-tsc: New yaml description
Date: Fri, 15 Oct 2021 10:14:21 +0200	[thread overview]
Message-ID: <20211015081506.933180-4-miquel.raynal@bootlin.com> (raw)
In-Reply-To: <20211015081506.933180-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-10-15  8:15 UTC|newest]

Thread overview: 60+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-15  8:14 [PATCH v6 00/48] TI AM437X ADC1 Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 01/48] clk: ti: am43xx: Add clkctrl data for am43xx ADC1 Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 02/48] dt-bindings: mfd: ti,am3359-tscadc: Add a yaml description for this MFD Miquel Raynal
2021-10-15  8:14 ` Miquel Raynal [this message]
2021-10-15  8:14 ` [PATCH v6 04/48] dt-bindings: iio: adc: ti,am3359-adc: New yaml description Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 05/48] dt-bindings: touchscreen: ti,am3359-tsc: Remove deprecated text file Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 06/48] dt-bindings: mfd: ti,am3359-tscadc: Describe am4372 MFD compatible Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 07/48] dt-bindings: iio: adc: ti,am3359-adc: Describe am4372 ADC compatible Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 08/48] mfd: ti_am335x_tscadc: Ensure a balanced number of node get/put Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 09/48] mfd: ti_am335x_tscadc: Replace license text with SPDX tag Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 10/48] mfd: ti_am335x_tscadc: Fix style Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 11/48] mfd: ti_am335x_tscadc: Drop extra spacing when declaring stack variables Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 12/48] mfd: ti_am335x_tscadc: Get rid of useless gotos Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 13/48] mfd: ti_am335x_tscadc: Reword the comment explaining the dividers Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 14/48] mfd: ti_am335x_tscadc: Don't search the tree for our clock Miquel Raynal
2022-03-04 22:38   ` H. Nikolaus Schaller
2022-03-07 11:10     ` Miquel Raynal
2022-03-07 11:15       ` H. Nikolaus Schaller
2021-10-15  8:14 ` [PATCH v6 15/48] mfd: ti_am335x_tscadc: Simplify divisor calculation Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 16/48] mfd: ti_am335x_tscadc: Move the driver structure allocation earlier Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 17/48] mfd: ti_am335x_tscadc: Use driver data Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 18/48] mfd: ti_am335x_tscadc: Mimic the probe from resume() Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 19/48] mfd: ti_am335x_tscadc: Drop useless variables from the driver structure Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 20/48] mfd: ti_am335x_tscadc: Always provide an idle configuration Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 21/48] mfd: ti_am335x_tscadc: Reorder the initialization steps Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 22/48] mfd: ti_am335x_tscadc: Gather the ctrl register logic in one place Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 23/48] mfd: ti_am335x_tscadc: Replace the header license text with SPDX tag Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 24/48] mfd: ti_am335x_tscadc: Fix header spacing Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 25/48] mfd: ti_am335x_tscadc: Use the new HZ_PER_MHZ macro Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 26/48] mfd: ti_am335x_tscadc: Drop unused definitions from the header Miquel Raynal
2021-10-15 14:00   ` Jonathan Cameron
2021-10-15  8:14 ` [PATCH v6 27/48] mfd: ti_am335x_tscadc: Use BIT(), GENMASK() and FIELD_PREP() when relevant Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 28/48] mfd: ti_am335x_tscadc: Clarify the maximum values for DT entries Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 29/48] mfd: ti_am335x_tscadc: Drop useless definitions from the header Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 30/48] mfd: ti_am335x_tscadc: Rename the subsystem enable macro Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 31/48] mfd: ti_am335x_tscadc: Add TSC prefix in certain macros Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 32/48] mfd: ti_am335x_tscadc: Rename a variable Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 33/48] mfd: ti_am335x_tscadc: Fix an error message Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 34/48] mfd: ti_am335x_tscadc: Add a boolean to clarify the presence of a touchscreen Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 35/48] mfd: ti_am335x_tscadc: Introduce a helper to deal with the type of hardware Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 36/48] mfd: ti_am335x_tscadc: Add ADC1/magnetic reader support Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 37/48] mfd: ti_am335x_tscadc: Support the correctly spelled DT property Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 38/48] iio: adc: ti_am335x_adc: Wait the idle state to avoid stalls Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 39/48] iio: adc: ti_am335x_adc: Replace license text with SPDX tag Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 40/48] iio: adc: ti_am335x_adc: Fix style Miquel Raynal
2021-10-15  8:14 ` [PATCH v6 41/48] iio: adc: ti_am335x_adc: Get rid of useless gotos Miquel Raynal
2021-10-15  8:15 ` [PATCH v6 42/48] iio: adc: ti_am335x_adc: Gather the checks on the delays Miquel Raynal
2021-10-15  8:15 ` [PATCH v6 43/48] iio: adc: ti_am335x_adc: Add a unit to the timeout delay Miquel Raynal
2021-10-15  8:15 ` [PATCH v6 44/48] iio: adc: ti_am335x_adc: Add the scale information Miquel Raynal
2021-10-15  8:15 ` [PATCH v6 45/48] iio: adc: ti_am335x_adc: Add the am437x compatible Miquel Raynal
2021-10-15  8:15 ` [PATCH v6 46/48] ARM: dts: am437x-cm-t43: Use a correctly spelled DT property Miquel Raynal
2021-10-15  8:15 ` [PATCH v6 47/48] ARM: dts: am43xx: Describe the magnetic reader/ADC1 hardware module Miquel Raynal
2021-10-15  8:15 ` [PATCH v6 48/48] ARM: dts: am437x-gp-evm: enable ADC1 Miquel Raynal
2021-10-20 15:36 ` [PATCH v6 00/48] TI AM437X ADC1 Miquel Raynal
2021-10-20 15:57   ` Lee Jones
2021-10-21  7:45     ` Miquel Raynal
2021-10-21 12:02 ` [GIT PULL] Immutable branch between MFD, IIO, Input (Touchscreen) and Clk due for the v5.16 merge window Lee Jones
2021-10-21 12:13   ` Miquel Raynal
2021-10-21 12:31     ` Lee Jones
2021-10-21 12:41       ` 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=20211015081506.933180-4-miquel.raynal@bootlin.com \
    --to=miquel.raynal@bootlin.com \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=dmitry.torokhov@gmail.com \
    --cc=jic23@kernel.org \
    --cc=lee.jones@linaro.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-omap@vger.kernel.org \
    --cc=robh@kernel.org \
    --cc=ryan.barnett@collins.com \
    --cc=thomas.petazzoni@bootlin.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).