Received-SPF: pass (google.com: domain of linux-kernel+bounces-6585-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: Javier Carrasco <javier.carrasco@wolfvision.net>
Subject: [PATCH v6 0/4] Input: support overlay objects on touchscreens
Date: Wed, 20 Dec 2023 09:39:42 +0100
Message-Id: <20230510-feature-ts_virtobj_patch-v6-0-d8a605975153@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>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?dDZDdmhUd3ZWQUpmMmRKTXgxMEY5clZuNzF0T1FlQUdqL25EUDFPcms3UVpm?=
 =?utf-8?B?RDFNdUVwaTJmMmtSSmE2SVhxODJ5cjhvaHV3cVRaaXBObHUzTVhteU84RnBR?=
 =?utf-8?B?WjBkL0hVVk5zbG85UE9Fc1pQd3JVaGx2STZucXNFOHdnQjc1Z1V6RDNmVTBB?=
 =?utf-8?B?YkpVempmWUd6N2xpeC8raVlPQ1d0VmlxQ1NBQzVJSE5kQlBLRzVNNGluUXVx?=
 =?utf-8?B?WGdmTURBaXV6NFUrR2RiME1MYjBTOUdYSU8zZ3FWTk1VK0Z0RVhyUDU1MzIz?=
 =?utf-8?B?RFdvUmc3ckJTditOdlVETlRJdG1SVXRpSmhHa0FwbFlBQlRoT21mVnJwNjJJ?=
 =?utf-8?B?SGpQMU91SmlMUkU4ejQycjVVQlhEMjlTekpKd2dES1pCQVgvcnZva0lXOGRt?=
 =?utf-8?B?UGtXSHRKOUFxWDFMMHZEa2UycnNROVhSZUF5SUZvOXhZODZUd0tNZ0JGOFJ0?=
 =?utf-8?B?a2c1L2dRbkxNMkpvWWtaem5nZisxaFhscEprTnIrWVU0N2g5TjN2SHFTdXBh?=
 =?utf-8?B?UzhkdlZVSlhIM2dQYWwzejU3bDcvQko4dFU2bFJ1bHBzNVFTa3RSV2p3NXVq?=
 =?utf-8?B?NGczRHBibG0waHFQODFmcU5MNS9FWTRpL2FtZy9EaTJNa3RaM0ZMQmZrUXEz?=
 =?utf-8?B?TE1QQmZwVHpiaTBNbVVPclZxZDlwY3dJcFZRLzRJRmxOTC8xVU1tQ21oSCt6?=
 =?utf-8?B?ZHNCblR2aERWT2lDMHJmbnhIK1A1NDJxRXpvaytmQjNETDBvR2dHODlJOFJn?=
 =?utf-8?B?T0pZYVp4dytHUDNIM1UzSWllUU9uamppdmRYWktLVzI0elNBZHd4NWJOaHpv?=
 =?utf-8?B?S3dScWJFd1RxeDV5bEphSFdpNWtGK3p6QnlKbTN0bGI1aWtBdWNXZWpHd3Yx?=
 =?utf-8?B?RUtOQ1ZhUE5ENXgrOHFvc0VwQ1d5WnJpbUxkcEZNWTBnSzV4NUVCM0ZCbTJz?=
 =?utf-8?B?QmMyU2xXSkVnVEE0WE0yRnluS2FsYkFPUXd0NGpaMXZHSzBDaldQWGV1WGFQ?=
 =?utf-8?B?Lzd1RXpJcnNHZW1DR0xqWCt1enpQRXdVc1dna2hzMEdLWkc1TGJGZ1M5M0JK?=
 =?utf-8?B?UDBJMmdVOERvbmNLV1IzZjQvbXZlRFBrYUFTNGJUbHdzQnNHUUU5QkhOaXY4?=
 =?utf-8?B?clh2aEc3VWdoNUM5K2VOOHZYZ3dtay9LVEdaTXVLMjNZMDM5VUpEM3dYWC9o?=
 =?utf-8?B?cjJVUWtaaXJFN0d2UFo0aC9sTEExTkYvMHRteHpnSXprOVQxblh1bVQvcGpX?=
 =?utf-8?B?bTJDVXEyeWJxNFZEbjhFZEVvajl0QWg5Ri9YdVQwS2JhV1F5dE94UHlFc003?=
 =?utf-8?B?ZHloVjdmVDQwVGlJalN0Z1VySm9LbUJKZDROL3Jic25DVFF4TFdPMG8xUmd6?=
 =?utf-8?B?dTE0Y0J5b0t5RjVlQVR6YjN3UytScURKNWhTVmhzQzYrc29lTEJ5Sk93T2Iw?=
 =?utf-8?B?dlpHcWp2cm85ZDFpNUJObS9ocUxoOFl6QmRYUzlHWSswRGxESVhOc2o4ZmVV?=
 =?utf-8?B?R3o1di9yUUJ4Si9nM0lMaDhPRmtaVjFyUE5rbUJvdFJ2OHNKdmo5dTZCNDBs?=
 =?utf-8?B?Qm9BWEo0ZWcrV0w2QlBBS3ZYYkx1T05IczkrREdseXpiSFBYdnhJS1dmcnBG?=
 =?utf-8?B?MUdEYkpyOEFPditSbERsTmFxNnlSWGdlYnBBUmxtU0hUV0VmZXBUNlppSHc3?=
 =?utf-8?B?YzQrY0RLWUl4VmdWYzBya0pna3RTcm9ScGx5c1FiWmkxTEExK1lkeTA2Tm9D?=
 =?utf-8?B?OVFVemNEQ0xsMCttZENmcWtLWlJoa0V3R3hSMndaRzB1ajFyWCtpUC91QW14?=
 =?utf-8?B?MmJnbEtZeHROdFBZMmtOWG01dGFkSWxqRmY4bE9LOWd2K205V2ZPMHR4QzRC?=
 =?utf-8?B?WkZRM254bkVkL2ZjMW9IMVhUSlllZHpvclpKQ2lobncrclZ0UUZHK2ZuQVdT?=
 =?utf-8?B?QTAyTDN2UytPeUlqZ1o5aFljK2xhZG9TMDFqTnlnSG41Z3BQZEthWlNyT2h2?=
 =?utf-8?B?UEtMaDNMblVHUXlQdTl0L0dvTE5TK0lvcXhvM2FxY25MLy81MWtQUlA0VEpK?=
 =?utf-8?B?RitWclEvcjJaRHVCNzNMdU9HWnFXaWxqakQyRVhGWE5XT3p1N0tRSDQ2b1VX?=
 =?utf-8?B?a3BJeW16SzFMaitXL3hINHhKV1BlMG96bjRQdHlBR1ErcGtyTENxV1R2bGl4?=
 =?utf-8?Q?6Ks2c1o4KHskDt6f1NVWQBo=3D?=
X-OriginatorOrg: wolfvision.net
X-MS-Exchange-CrossTenant-Network-Message-Id: a3e9e10b-2407-4095-f44b-08dc01373a4a
X-MS-Exchange-CrossTenant-AuthSource: VE1PR08MB4974.eurprd08.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Dec 2023 08:39:49.3493
 (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: 5o6Et9+3l+jPABOHT/KaTzHqfFbTJF90tkVJ8cnoG/LuwRSrtJ/lkIty84dY7e5+6a5hcsiiRRMTHOsVLVp7a+MZQIbVi2t9uoZ9Sczwuks=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PA4PR08MB6080

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, this series offers a documented,
device-tree-based solution by means of helper functions.
An implementation for a specific touchscreen driver is also included.

The functions in touch-overlay provide a simple workflow to acquire
physical objects from the device tree, map them into a list 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 v6:
- General: use a single list to manage a single type of object.
- General: swap patches to have bindings preceding the code.
- touch-overlay.c: minor code-sytle fixes.
- Link to v5: https://lore.kernel.org/r/20230510-feature-ts_virtobj_patch-v5-0-ff6b5c4db693@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):
      dt-bindings: touchscreen: add touch-overlay property
      Input: touch-overlay - Add touchscreen overlay handling
      dt-bindings: input: touchscreen: st1232: add touch-overlay example
      Input: st1232 - add touch overlays handling

 .../input/touchscreen/sitronix,st1232.yaml         |  29 +++
 .../bindings/input/touchscreen/touchscreen.yaml    | 119 +++++++++
 MAINTAINERS                                        |   7 +
 drivers/input/Makefile                             |   2 +-
 drivers/input/touch-overlay.c                      | 283 +++++++++++++++++++++
 drivers/input/touchscreen/st1232.c                 |  71 +++++-
 include/linux/input/touch-overlay.h                |  24 ++
 7 files changed, 520 insertions(+), 15 deletions(-)
---
base-commit: b85ea95d086471afb4ad062012a4d73cd328fa86
change-id: 20230510-feature-ts_virtobj_patch-e267540aae74

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