Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:1 as permitted sender) client-ip=2620:137:e000::3:1;
From:   Javier Carrasco <javier.carrasco@wolfvision.net>
Subject: [PATCH v5 0/4] Input: support overlay objects on touchscreens
Date:   Tue, 17 Oct 2023 13:00:06 +0200
Message-Id: <20230510-feature-ts_virtobj_patch-v5-0-ff6b5c4db693@wolfvision.net>
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
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?S0ZwMmRMY1VMZklqdktaczhzd3piMkd6U2p6cmRmQ3J2YWhrQUhkcFhDaEh1?=
 =?utf-8?B?T0FyUGFRVU1yNm94QStlNzIvaHMwQy9JL3Bzb1huclFRVWZGUCtVK1J5MXo3?=
 =?utf-8?B?TzdnVFEvU0pQNE1LeGI3eDhjUG5UT3drZ0hLUTExYWJDL3V3RHp4TnFYYVRw?=
 =?utf-8?B?UkR2M2MyVzVyVHpJWE5Fb2ZRc0h2N3p2ek40dTBiMXdlNGpsb3BvN1ExQUlK?=
 =?utf-8?B?L1gwZHlkMkZnV0tlajJkMDkwVzNjQ2VrSUtNK0FoakgzSVdVaG5Bdk1BQmN5?=
 =?utf-8?B?K2NDck45NDRkZC95WHBtNEJoMERQbGxNMkV6MUZaY0ZNM0VDbCtPTFZzeHIv?=
 =?utf-8?B?aGhDZkhOMTlYL0pMTkhOb3psM1ZLeGNzV3hrRDJqOVpHVHdoY1Q5TTB1Si9y?=
 =?utf-8?B?Tlh4M1AzaStkT2FSSUxqRDlHdmNibWRTM0tmeFlBd3gzdkkzSmo5WkJIWk1W?=
 =?utf-8?B?YzYxV25YQkRHZUZQYjI2SWovOERqTVplcmRBTlpVdVJsUzlQWnlxV3dLL3Bt?=
 =?utf-8?B?SWx5UmFhaUNTQTMzbFl5ZDIvZ1dLb0tyRW5IZ1J2SjRpRExUc1A4bDRHbDFa?=
 =?utf-8?B?dUt4dzVBQzdxSkhRQ2xCN3ZrcDlrejUwRDBqMjlLSkp2QzA5MStsNXdiRE9F?=
 =?utf-8?B?aDgwa2w5UjBSbEpVb0F2MDExYVRkdkh6dko4MWdLME1wNDIxTmpyMEpEWkhK?=
 =?utf-8?B?Vkh3UCtCTER0VllsdjJtZVBGNHBKY2hEWnhENkdhdHk0dFg4TU02QlUvV3ZB?=
 =?utf-8?B?c0FYZ08xS3k4enpuejJiLzVzQ015QzdoMFFWZENvL2Jrb2s2VTRrUElJSG5X?=
 =?utf-8?B?VnVUZXZpRjg1K09XVG43TG0vcW1aU0dkSDF6UTkzQlZWczAyZzJNUk1nWjM0?=
 =?utf-8?B?T3VsWjVuMEJIYWI0RUNiY0xRSldqbGxKMzFiTW9MNDV5M3JhYVVJVUJVUmYw?=
 =?utf-8?B?NDFxUURJT244RmpxQ21ySFRuTE82ajYxWGFtS0lPZjAyd1huZGdETXRFU1Z3?=
 =?utf-8?B?WlhCdWQ4Z253S3dxMG55SlRRd2J1MkhtelVYRGpXeHJCVm5pazJwVlB6R0ta?=
 =?utf-8?B?bWxMNWQ1Ni83RHFuVnBzRnZpUDAvbFRrcVFNZmFaMHZmcXNpbXFlSnI4Qk9M?=
 =?utf-8?B?eDI0VmpBWDRPL3dHdmR3ckloNHpXUnYxUk01azBIYW85ZFhGRXdLOXhpVlVP?=
 =?utf-8?B?NC9sUlRyenVXWkpvVkcxMXhtSnNjUURpWWVPYks0aFZhWjgwc1JhaGErS0Vw?=
 =?utf-8?B?a2lVUzlVbnF5Qm9Yd2wrZHVYWDRiQWlYQk83OWVkRnQ0SGw1UVRNYVJUNzlW?=
 =?utf-8?B?RXU2SEFZL0srSWF4aWZkR1d5ZDVvY0xnMHV4VmwxeXRjdUlMMHdaT3ZoTFhz?=
 =?utf-8?B?cXN2WWhlZEdKY0VnamM1L1RVUWVUUjRuWWVRLzRWb1ZkZVJaSmtrYlRTYldn?=
 =?utf-8?B?TXZ4QzNlOFFraDdEaTlkcWpWdGJqMlBHQkRIVmxjVnZMdU1UaXBiMCs4UlpM?=
 =?utf-8?B?eGhSYVFuK3JZRHhUK0VxN2Y0cXVPNnF5UW9hZnlNZStOK29SVDNLSXZYSG50?=
 =?utf-8?B?dkRFRDVONmlMUHA3bjc0ek9YR3J1VzdleXBkSFpTWlYyWVkwVTBJMDRaL0to?=
 =?utf-8?B?MVc1MHUzMU5zcWltZ3R3QkhycVNEc1Ira1prdXlFRVNRR21BaHN3NDJZSTBO?=
 =?utf-8?B?cWsxcExRa2FPQkNBSURPZG9va2hhQUtlWUtzVWRTVHlUd2ZxRUFmaVFPd2I4?=
 =?utf-8?B?Wlc3N005M0JwdGpURVJCejVOaXJVWFl6TFl3VHBCTGVVYkpvd3gwSGY1Y1d6?=
 =?utf-8?B?Y1ZacTBoQUNSU3REampiRjdKdjIwN3VGemxqajRLNjZoSm9ydmE5dWxLSW45?=
 =?utf-8?B?Y3pQNzNzU2NuRVllT3p4dVpwWlFqSElTQmI1eG9IZUtXZkFxQ0tMRStWM3V3?=
 =?utf-8?B?aUJxVmJGTXNTam1CSW5abFNjL2JhMy96ZEhiRWZ0OG9NNmRFeVNwcVdzUjVu?=
 =?utf-8?B?cXk4SFJtWW10TFIwc1VFeW9sU0c3OXUrWDcyR2EwWGtCLzBxL1NjSExMYk9s?=
 =?utf-8?B?SGRqS1M3R1ZCSUZMSGlBQ3JZSldXUnNaSGh2eFhyQzh5QXFIRnNVejFLZjd3?=
 =?utf-8?B?WnZpdXRaSXhQQlUyRDFqRVE4czl4dlBqMGJKWGNlcldEeTBwbTVEQWJkcWhY?=
 =?utf-8?Q?C/5g771Z2/yaHIs+BzMwHtI=3D?=
X-OriginatorOrg: wolfvision.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 77f4ae82-a160-45b2-251a-08dbcf003d3f
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:13.9005
 (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: yRzDN3vQFcSInh1FbWEWSb+45YcVlvkNfzwnlQuw8/WQZc6uIH6NCiwAs+JJTx+BNF2Mj5rKMnE8sfTV3Z+UDk0U2eSG1v6XDdjbILEyBK4=
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 morse.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 (morse.vger.email [0.0.0.0]); Tue, 17 Oct 2023 04:00:32 -0700 (PDT)

Some touchscreens are shipped with a physical layer on top of them where
a number of buttons and a resized touchscreen surface might be available.

In order to generate proper key events by overlay buttons and adjust the
touch events to a clipped surface, these patches offer a documented,
device-tree-based solution by means of helper functions.
An implementation for a specific touchscreen driver is also included.

The functions in ts-overlay provide a simple workflow to acquire
physical objects from the device tree, map them into the device driver
structures as overlay objects and generate events according to
the object descriptions.

This feature has been tested with a JT240MHQS-E3 display, which consists
of an st1624 as the base touchscreen and an overlay with two buttons and
a frame that clips its effective surface mounted on it.

Signed-off-by: Javier Carrasco <javier.carrasco@wolfvision.net>
---
Changes in v5:
- touchscreen bindings: move overlay common properties to a $def entry (Rob Herring)
- st1232 bindings: move overlays to the existing example instead of
  making a new one (Rob Herring) 
- Link to v4: https://lore.kernel.org/r/20230510-feature-ts_virtobj_patch-v4-0-5c6c0fc1eed6@wolfvision.net

Changes in v4:
- General: rename "touchscreen" to "touch" to include other consumers.
- PATCH 1/4: move touch-overlay feature to input core.
- PATCH 1/4, 3/4: set key caps and report key events without consumer's
  intervention.
- PATCH 2/4: add missing 'required' field with the required properties.
- Link to v3: https://lore.kernel.org/r/20230510-feature-ts_virtobj_patch-v3-0-b4fb7fc4bab7@wolfvision.net

Changes in v3:
- General: rename "virtobj" and "virtual" to "overlay"
- PATCH 1/4: Make feature bool instead of tristate (selected by
  supported touchscreens)
- Link to v2: https://lore.kernel.org/r/20230510-feature-ts_virtobj_patch-v2-0-f68a6bfe7a0f@wolfvision.net

Changes in v2:
- PATCH 1/4: remove preprocessor directives (the module is selected by
  the drivers that support the feature). Typo in the commit message.
- PATCH 2/4: more detailed documentation. Images and examples were added.
- PATCH 3/4: select ts-virtobj automatically.
- Link to v1: https://lore.kernel.org/r/20230510-feature-ts_virtobj_patch-v1-0-5ae5e81bc264@wolfvision.net

---
Javier Carrasco (4):
      Input: touch-overlay - Add touchscreen overlay object handling
      dt-bindings: touchscreen: add overlay-touchscreen and overlay-buttons properties
      Input: st1232 - add touch overlays handling
      dt-bindings: input: touchscreen: st1232: add touch-overlay example

 .../input/touchscreen/sitronix,st1232.yaml         |  28 ++
 .../bindings/input/touchscreen/touchscreen.yaml    | 143 ++++++++
 MAINTAINERS                                        |   7 +
 drivers/input/Makefile                             |   2 +-
 drivers/input/touch-overlay.c                      | 399 +++++++++++++++++++++
 drivers/input/touchscreen/st1232.c                 |  70 +++-
 include/linux/input/touch-overlay.h                |  34 ++
 7 files changed, 668 insertions(+), 15 deletions(-)
---
base-commit: 213f891525c222e8ed145ce1ce7ae1f47921cb9c
change-id: 20230510-feature-ts_virtobj_patch-e267540aae74

Best regards,
-- 
Javier Carrasco <javier.carrasco@wolfvision.net>