Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:5 as permitted sender) client-ip=2620:137:e000::3:5;
From:   Javier Carrasco <javier.carrasco@wolfvision.net>
Date:   Tue, 17 Oct 2023 13:00:08 +0200
Subject: [PATCH v5 2/4] dt-bindings: touchscreen: add overlay-touchscreen
 and overlay-buttons properties
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit
Message-Id: <20230510-feature-ts_virtobj_patch-v5-2-ff6b5c4db693@wolfvision.net>
References: <20230510-feature-ts_virtobj_patch-v5-0-ff6b5c4db693@wolfvision.net>
In-Reply-To: <20230510-feature-ts_virtobj_patch-v5-0-ff6b5c4db693@wolfvision.net>
To:     Dmitry Torokhov <dmitry.torokhov@gmail.com>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Conor Dooley <conor+dt@kernel.org>,
        Henrik Rydberg <rydberg@bitmath.org>,
        Bastian Hecht <hechtb@gmail.com>,
        Michael Riesch <michael.riesch@wolfvision.net>
Cc:     linux-kernel@vger.kernel.org, linux-input@vger.kernel.org,
        devicetree@vger.kernel.org,
        Javier Carrasco <javier.carrasco@wolfvision.net>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?R2pHYjZJSm05M1RLUkRMMFF2enJhS3pmTmlEMlgvblJXRDNXeDJsdWExT25T?=
 =?utf-8?B?Z2taYjdvNHIrRTRCSkFYNzBnQU16M3lOYzVoUVRETEdKcXY0NFU1aEZDa3ha?=
 =?utf-8?B?WmJBRVJ4ZEtkcml6ZURURHorcTFSZmVIS2ttWmo5eGYxWGpOWmovVUdBb3Br?=
 =?utf-8?B?N1hRZXJOMUhGcWZDeStRV1JRdTdNdjcyVkhSTDNmZVJWNjJLUENVa3ZPU0pw?=
 =?utf-8?B?eFZnVHdhMXRHL242bHlFS041bjQ2VHc4aGNUNEJGb2xXNm15WXhqNWFRZytm?=
 =?utf-8?B?Vmx2SmVGK3pLcEE5R2tBV05neitwUUJwVnEvR0J3cEpqSjBKK1dOUlYrTFFt?=
 =?utf-8?B?N1FjUGVYRXU5ZFlyWXM5SWhHSkRIbjl2U1NsWE5Db1NxQWZ5MmRzRTRKVzVl?=
 =?utf-8?B?bjV0Q1JpZmR6ZERCZWhVL2xBemVwTzM5cVNkSGVCVGZxK3RyMmdLZ3FiMWFz?=
 =?utf-8?B?UlNQS2FzeW11Q0RSQ0lray9rNkw2bTV5RVk3L3hOMW5TNTJ1UGt0OFYyWDJt?=
 =?utf-8?B?eHVHTWhZVk1KZWk5Rnd4TjFXUXhZOGx5cFNLemRhcUxtWUhRYkJhSk1KVXNS?=
 =?utf-8?B?M213cTgzVmpnTXR2eDhQOVNRaWpYODMzNFRBSzZkUHBWcytUTG5UN1JaM3g2?=
 =?utf-8?B?QkF4U0pXVm5oVFdjUGF0bzdSanNITlFBWFpPT1FWcnVqN2xGV0dPUTBRM2Iw?=
 =?utf-8?B?aGNJM0pYRDFJOW40L2hjYWYrcDBXNW9rY3dWNEJreVlRcWQrU24xSXhTVU5U?=
 =?utf-8?B?VEJlcklwblZUUUExSnBQQkJvN2xZMWJaU2Jzb1lWeVJvNzcwOG5DcXJUYnBY?=
 =?utf-8?B?S05FTzJmeTRoUE5SYytmelJ1S0xPM3Yvc3VQbGxjL0VUNlBrcW9ueHl3R1Fu?=
 =?utf-8?B?N1EvWjNXNGZmYTdGT0w0cTBaTEhIcnJnSGt5VEpMd0Y3UDA3cWdES1NtVjg0?=
 =?utf-8?B?Rk9kbHNOMURsbUswcTU4SUJXOUNVMFJpR2VaNWJUeTNnd0NrTlYwdTVmTjFZ?=
 =?utf-8?B?MDVUdzk2dm85Sm9XYUozeDBlTjFVd3BKdmtoa1FQRkxJQ0I1enVPUGpzWEYr?=
 =?utf-8?B?dURhUytxREtvbDd4Rk9DOVlZUXhFUjhZSUMxY01RUVovbDc2WG9jNU02OEpU?=
 =?utf-8?B?NFNwcGpVQXpHMUQ5cXpaVDFTNWN3UTAyREhoaE80b2VnNldqYi9qWG1uNTVN?=
 =?utf-8?B?ZGdRNmlQMm43bUNwaHByZmZCeWwyMkU1YjJ4MmhQb1RCNFZTcm1LSFE2STZZ?=
 =?utf-8?B?RC8wam0vSXFqRFBNZ3o3WksrK3BpWDc0V3E5ZXVrRGJlbm91YW9uS0tGMURJ?=
 =?utf-8?B?MVhpSHpaMFBpVnhtM3RYNWozMWFydFNjY21vNmg4RjlYK1ducVEvRE9uZmJT?=
 =?utf-8?B?cEJ0dDJJZ0k5ZG5FRGx5bHhuenAzbEVwLzZaeS9qMkErNHk4OUxhUHlJZGNm?=
 =?utf-8?B?RnJBUVh2eXlJRDFBd1N2bDBZQTVmSkw0N0txL0R0UW9aUDFadEI1dDlWWFNt?=
 =?utf-8?B?QXVCN3Noc2hYR0ltbTI5THpwVXhXWENFZE50U2xnckhLMHZ5akNYd2VoRmdi?=
 =?utf-8?B?a1dXUkFXVXdkOEtJcVBaSHFtTWFpaG9hY0NYbTVkZzMwc1Jsc3FvZmdSVW1k?=
 =?utf-8?B?SVlwL0VFTE5wR2FWcDNuSnhibGx2OEVVNk53MGkvTFlXQkcwMEpWbzgra2V1?=
 =?utf-8?B?TU9YdXN2RGNpa3NBcDRaV0I1cUdVRjFTdzN1VU9YUGx0T09ieG0xRHo1T1ZI?=
 =?utf-8?B?ckE3NmVzOGgzaVpCZTYwRWdTQU9zTXExUVNKNjJUaWc3TmJ6aXpQRHpxUXl4?=
 =?utf-8?B?d21UUG9PcjI1NzRZVE52d05GSXF3L25KeEJnSllEblhxUHdJZkliQXpTcHVL?=
 =?utf-8?B?TElsQWpxcWpINklncnR3Vk9yOTI3Q1ZCNGZtL0EwYmdWR2NJN1BEUDA5Vmhp?=
 =?utf-8?B?MHcvaktXM0JpN1NIZTBPZzJ6bGZST1V4MnI2YjBrQ2RpQ014S0pnRnNKM2dO?=
 =?utf-8?B?RFkvNFJjdnpFYmkrYmtHZDRlclZ5a1c3OWpIM05vMCtreVFRamU5cWN0RnMy?=
 =?utf-8?B?Nmg0VFJaRnBURE93bk14V1VSZmNGS2tKQUpMTGltS2Z1eEJ4YzNRQVVQOEV3?=
 =?utf-8?B?YVFQeFEyYW5iTnNOYnRFc2Y3eFQzWDZhTEVLWEpPUE56UENiZmNxcUpwRGtG?=
 =?utf-8?Q?eReM03teisEmgydnrTF98xw=3D?=
X-OriginatorOrg: wolfvision.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 6075dda0-d713-4eb3-df1d-08dbcf003e1c
X-MS-Exchange-CrossTenant-AuthSource: VE1PR08MB4974.eurprd08.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Oct 2023 11:00:15.3057
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: e94ec9da-9183-471e-83b3-51baa8eb804f
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: uK4O51GRrmrmeatfZl7n6nWs5hmKHWp0ZXXDF0VNvzLt38JcoKzPWhDF/coMiUoChqG0p0GHIlEONsc+0URNaUECnSymM8yqi3deiDbgNFQ=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS8PR08MB6295
X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no
	version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on groat.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (groat.vger.email [0.0.0.0]); Tue, 17 Oct 2023 04:00:59 -0700 (PDT)

The overlay-touchscreen object defines an area within the touchscreen
where touch events are reported and their coordinates get converted to
the overlay origin. This object avoids getting events from areas that
are physically hidden by overlay frames.

For touchscreens where overlay buttons on the touchscreen surface are
provided, the overlay-buttons object contains a node for every button
and the key event that should be reported when pressed.

Signed-off-by: Javier Carrasco <javier.carrasco@wolfvision.net>
---
 .../bindings/input/touchscreen/touchscreen.yaml    | 143 +++++++++++++++++++++
 1 file changed, 143 insertions(+)

diff --git a/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml b/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml
index 431c13335c40..5c58eb79ee9a 100644
--- a/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml
+++ b/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml
@@ -87,6 +87,129 @@ properties:
   touchscreen-y-plate-ohms:
     description: Resistance of the Y-plate in Ohms
 
+  overlay-touchscreen:
+    description: Clipped touchscreen area
+
+      This object can be used to describe a frame that restricts the area
+      within touch events are reported, ignoring the events that occur outside
+      this area. This is of special interest if the touchscreen is shipped
+      with a physical overlay on top of it with a frame that hides some part
+      of the original touchscreen area.
+
+      The x-origin and y-origin properties of this object define the offset of
+      a new origin from where the touchscreen events are referenced.
+      This offset is applied to the events accordingly. The x-size and y-size
+      properties define the size of the overlay-touchscreen (effective area).
+
+      The following example shows the new touchscreen area and the new origin
+      (0',0') for the touch events generated by the device.
+
+                   Touchscreen (full area)
+         ┌────────────────────────────────────────┐
+         │    ┌───────────────────────────────┐   │
+         │    │                               │   │
+         │    ├ y-size                        │   │
+         │    │                               │   │
+         │    │      overlay-touchscreen      │   │
+         │    │                               │   │
+         │    │                               │   │
+         │    │            x-size             │   │
+         │   ┌└──────────────┴────────────────┘   │
+         │(0',0')                                 │
+        ┌└────────────────────────────────────────┘
+      (0,0)
+
+     where (0',0') = (0+x-origin,0+y-origin)
+
+    type: object
+    $ref: '#/$defs/overlay-node'
+    unevaluatedProperties: false
+
+    required:
+      - x-origin
+      - y-origin
+      - x-size
+      - y-size
+
+  overlay-buttons:
+    description: list of nodes defining the buttons on the touchscreen
+
+      This object can be used to describe buttons on the touchscreen area,
+      reporting the touch events on their surface as key events instead of
+      the original touch events.
+
+      This is of special interest if the touchscreen is shipped with a
+      physical overlay on top of it where a number of buttons with some
+      predefined functionality are printed. In that case a specific behavior
+      is expected from those buttons instead of raw touch events.
+
+      The overlay-buttons properties define a per-button area as well as an
+      origin relative to the real touchscreen origin. Touch events within the
+      button area are reported as the key event defined in the linux,code
+      property. Given that the key events do not provide coordinates, the
+      button origin is only used to place the button area on the touchscreen
+      surface. Any event outside the overlay-buttons object is reported as a
+      touch event with no coordinate transformation.
+
+      The following example shows a touchscreen with a single button on it
+
+              Touchscreen (full area)
+        ┌───────────────────────────────────┐
+        │                                   │
+        │                                   │
+        │   ┌─────────┐                     │
+        │   │button 0 │                     │
+        │   │KEY_POWER│                     │
+        │   └─────────┘                     │
+        │                                   │
+        │                                   │
+       ┌└───────────────────────────────────┘
+     (0,0)
+
+      The overlay-buttons object can  be combined with the overlay-touchscreen
+      object as shown in the following example. In that case only the events
+      within the overlay-touchscreen object are reported as touch events.
+
+                  Touchscreen (full area)
+        ┌─────────┬──────────────────────────────┐
+        │         │                              │
+        │         │    ┌───────────────────────┐ │
+        │ button 0│    │                       │ │
+        │KEY_POWER│    │                       │ │
+        │         │    │                       │ │
+        ├─────────┤    │  overlay-touchscreen  │ │
+        │         │    │                       │ │
+        │         │    │                       │ │
+        │ button 1│    │                       │ │
+        │ KEY_INFO│   ┌└───────────────────────┘ │
+        │         │(0',0')                       │
+       ┌└─────────┴──────────────────────────────┘
+     (0,0)
+
+    type: object
+
+    patternProperties:
+      '^button-':
+        type: object
+        description:
+          Each button (key) is represented as a sub-node.
+        $ref: '#/$defs/overlay-node'
+        unevaluatedProperties: false
+
+        properties:
+          label:
+            $ref: /schemas/types.yaml#/definitions/string
+            description: descriptive name of the button
+
+          linux,code: true
+
+        required:
+          - linux,code
+          - x-origin
+          - y-origin
+          - x-size
+          - y-size
+
 dependencies:
   touchscreen-size-x: [ touchscreen-size-y ]
   touchscreen-size-y: [ touchscreen-size-x ]
@@ -94,3 +217,23 @@ dependencies:
   touchscreen-y-mm: [ touchscreen-x-mm ]
 
 additionalProperties: true
+
+$defs:
+  overlay-node:
+    type: object
+    properties:
+      x-origin:
+        description: horizontal origin of the node area
+        $ref: /schemas/types.yaml#/definitions/uint32
+
+      y-origin:
+        description: vertical origin of the node area
+        $ref: /schemas/types.yaml#/definitions/uint32
+
+      x-size:
+        description: horizontal resolution of the node area
+        $ref: /schemas/types.yaml#/definitions/uint32
+
+      y-size:
+        description: vertical resolution of the node area
+        $ref: /schemas/types.yaml#/definitions/uint32

-- 
2.39.2