Received-SPF: pass (google.com: domain of linux-kernel+bounces-30854-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
From: Javier Carrasco <javier.carrasco@wolfvision.net>
Subject: [PATCH v7 0/4] Input: support overlay objects on touchscreens
Date: Fri, 19 Jan 2024 08:43:32 +0100
Message-Id: <20240119-feature-ts_virtobj_patch-v7-0-eda70985808f@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>, 
 Jeff LaBundy <jeff@labundy.com>
Cc: linux-kernel@vger.kernel.org, linux-input@vger.kernel.org, 
 devicetree@vger.kernel.org, 
 Javier Carrasco <javier.carrasco@wolfvision.net>, 
 Rob Herring <robh@kernel.org>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?a0dTdUVJUHcvV0l6SzJ3eDI4M1Rnc3dNcFNaR0ZIZWNIOXJ2TllWM2w2NlBX?=
 =?utf-8?B?RkVjMEljK2FISGZmY2Q1amdHN0M2STdCeFBFSWhta0lWNHZLYk5BcElCQjk1?=
 =?utf-8?B?VE4vQjZmTjBnemZJTWQ2L1h3SVBOallzK1pQbXpSYWlkTDZsMGV4UUFzbmhL?=
 =?utf-8?B?OXMzWlhUcGdsdUVGMWN6WGtSR1Y1UVlNUFVFeExnQytncHFselgxZ1lHUmZ5?=
 =?utf-8?B?M0lBeHBjQkVlVUk0NlcyU1JhUWhLdzg5eXlTZjcwR0NaRlRTdnE5L0hMbitk?=
 =?utf-8?B?aHBGeTlqeGo1U1JiSGpqN2RmSkY0OHZNSzBvdkhpMzZwMTh4NDFSR1BYYldU?=
 =?utf-8?B?U3ZYOUdIU0lZTkUvb21kRkp2VGtHclFGdEFVbjRJRUtKTDRXS0FwNnYvQ2I2?=
 =?utf-8?B?UVZ0ZENtZFN6OHZTOENPbmUvKzI3UnV5WC91cEhrc08zWDhvQUdvaGtCN0Zo?=
 =?utf-8?B?MitmRk1YQlJkL2xUK1dQK2V5U3d6WTdyaFZFWCtadFhFTyttNk1QNjVOeG1T?=
 =?utf-8?B?U3RJQ21NVTZ2VnBqK2RtR3N6Q3RDWGVzOHVEVzd2QnNBb3h5WTBLaHN5OVBm?=
 =?utf-8?B?ZmVjWFNuN0x3djdYN0pIZlZmeU1PSUEwZlhodDJSS3lOMVJ2b2VKbzFCelQw?=
 =?utf-8?B?cW9HdXdlV2pSc3N3dlpvN0ZwbENxYmFnWHBTdWZLalo1bi91ckM4UC8xWFZz?=
 =?utf-8?B?RVZ1YzFHWkVsQ25hQUhiUWhoTTJpdy9KUEFVUTlNWExkUjlTNmxRYmtIZlBF?=
 =?utf-8?B?R0ozUU5xekNLQmpmU1hTcDg3bE94eUJwUE1NcXpUZGQyR29QdGNVVzRzWXNV?=
 =?utf-8?B?VFIxWEordWY1M3JjZHA0QnVyK2I2NHlEQTZkQ2Q3aVA3T1NnZGMvRUo0ckFS?=
 =?utf-8?B?a2hlc0pDNzF5UW5qY3FULyt3TVVjdXk3SHFmTDRQTFJscVNOY05QVHViY2VM?=
 =?utf-8?B?OURDdGRnKzloeGxsbUlOc0hGTlpCOVlYOEE1RkQrZU9rcHVKZ3IrSk1nMDNX?=
 =?utf-8?B?WDhORW1ObHgxSHJ0aHVnZjd6U0l6TWphWU42R0hNN3d5ZzhjM0Q1YU4rMmI4?=
 =?utf-8?B?WEl4WE1Hc3JqQkNGYlFkOU5ySHdiWnljUWpkWTZ2c3MySDMwaXJJY25hTzVG?=
 =?utf-8?B?S3RBN2lLR0pGTUUxL3hBOHRlcGlobFlmTGxBR2wwMW5LWWZPVkkxQW9JWXFU?=
 =?utf-8?B?VUNqQ3Y4aGQxRnlkUTdwQ2dvSFh1YksxcGt1OUtkeEJVdkdvZmh2NEw3Umo4?=
 =?utf-8?B?aklBajRkaWRVUUVjVUc1R3hyREd0dUJxT1JwczFKdnpoYTQ3aDBSYzRYWVlM?=
 =?utf-8?B?b1Nwd1llVjA2Qmc4cXUzYzVOakhvby9ram0wQkJuWDREenMwWGJhWEJtbjFu?=
 =?utf-8?B?QkYzYjlpREd2dU84Y2VtaHBhYnBrQW93SWJMOVZwR0wyS0J5UGpUSnNRdldU?=
 =?utf-8?B?Nm9US3pZK1Y3NkFackRORFpVYi9PTDNEV3IrNkkxTVEyZU1oeHhOd2lERVNk?=
 =?utf-8?B?YWZsRHMvK1NnWTVBVm5pNVdxcnZnSFlXdkxqSkZvNTFuUlp2RTFSVnRDOUZq?=
 =?utf-8?B?aHhlQXEwSmVqZ3QrWmFiVlY4ZVFOTTRqd1V5c0k4MEw0ZUFRMGY5a1hiR3U0?=
 =?utf-8?B?NTIzS3dKUFJFNVBkK2o5ZWZIRTdqeFo5bi9uUjNIM0hBZCtkSHdQdUdIclBP?=
 =?utf-8?B?c0NUclhiT3BsVEs4c1VubXVIOEI1ZFZ3YkhnK21PMU42U05rOStxZHRpTFh6?=
 =?utf-8?B?WjZPZExRNU5BNDhuWDBQZG5OOGpVTDREYTE1cDZRbDErdzdNaEZJZ3NhaUVs?=
 =?utf-8?B?QmtvNmxOdk0wVEdscWhDMVUwNWlNM2JHSWtVdUtaK2VqSkcwQWh2S1hTcVBB?=
 =?utf-8?B?a3ZWOGVxamNnVllWYjg0UzVZS2VZSDdkZHRXaDN5TzFlb1dYKzhWc3NyOHlM?=
 =?utf-8?B?Z3k2M0IxOFAyMXFOTytvem1vZ2k4blVSMGdaSVExYlRDTVRJS3dmZTE2Sjlp?=
 =?utf-8?B?WFJ2VzVjS1U1eFVNYk5UazlaZ1FQTDFGa0x1VGRWenZ3TXpCdUtnTGNjdUx2?=
 =?utf-8?B?RWhUc2VpTHd0THVFaXZkOXdSOHZlVitEcUY0bnBQWkhKT3NxSmdOYzZGYVVp?=
 =?utf-8?B?SVcwSkpZV3R6eTV0QzhxRnBYQUhTRDF0M2Q4bHN1MnhuVGtXNXZaOW1aSzEy?=
 =?utf-8?Q?JCebv1DwRQddB9d3VG9Erro=3D?=
X-OriginatorOrg: wolfvision.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 36192de0-7805-487a-36c7-08dc18c25a2a
X-MS-Exchange-CrossTenant-AuthSource: VE1PR08MB4974.eurprd08.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Jan 2024 07:43:39.6341
 (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: 09/dc11qbWyskhuZ0yrdbKirdSzQukAMP3x7GV4KPPmClKXE0+5cLp5jffVQf1afiHVkvuFpouD6iEQbp900sKILo99IzoOgnThpPxGT0Tg=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM8PR08MB6578

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 v7:
- General: return to a single input device implementation.
- touchscreen bindings: segment instead of button in the label
  description.
- touch-overlay.c: define button-specific data inside segment struct.
- touch-overlay.c: remove fwnode_property_present() and check return
  value of fwnode_property_read_u32() in touch_overlay_get_segment().
- touch-overlay.c: simplify return path in touch_overlay_map().
- Link to v6: https://lore.kernel.org/r/20230510-feature-ts_virtobj_patch-v6-0-d8a605975153@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                      | 250 +++++++++++++++++++++
 drivers/input/touchscreen/st1232.c                 |  48 ++--
 include/linux/input/touch-overlay.h                |  22 ++
 7 files changed, 462 insertions(+), 15 deletions(-)
---
base-commit: 0dd3ee31125508cd67f7e7172247f05b7fd1753a
change-id: 20230510-feature-ts_virtobj_patch-e267540aae74

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