Received-SPF: pass (google.com: domain of linux-kernel+bounces-153150-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 v9 0/4] Input: support overlay objects on touchscreens
Date: Mon, 22 Apr 2024 12:07:36 +0200
Message-Id: <20240422-feature-ts_virtobj_patch-v9-0-acf118d12a8a@wolfvision.net>
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
To: Dmitry Torokhov <dmitry.torokhov@gmail.com>, 
 Rob Herring <robh@kernel.org>, 
 Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, 
 Conor Dooley <conor+dt@kernel.org>, Bastian Hecht <hechtb@gmail.com>, 
 Michael Riesch <michael.riesch@wolfvision.net>
Cc: linux-input@vger.kernel.org, devicetree@vger.kernel.org, 
 linux-kernel@vger.kernel.org, 
 Javier Carrasco <javier.carrasco@wolfvision.net>, 
 Jeff LaBundy <jeff@labundy.com>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?bFJUY3FQSCtFL2xSSlljYkdsTHczUnRlMnMzaWx2QXVSSXVRdk5sOFlNamox?=
 =?utf-8?B?VmxzTCtsN2xjS1FrMjZ2REpTMVJFK2ZxNlJhOHBwOXdQS1o1RWZ1WUZIQ2FL?=
 =?utf-8?B?dDc3UHBCRVozc3JaMkg0NGdIMENuNWpPNE5NckFuYW5CZTRrNUNyTFExQzJY?=
 =?utf-8?B?c0ZNcU9hMzNLeVlWM2Y5U2ZVUkl2SU9DRXpLUVNBL3NFMzlGaFQ3QVJvNmZ6?=
 =?utf-8?B?TWVQY0tlWGlvZ2NlU1IyK1hrZTBlMWRyZUpmZGgxRW5GL2xhT3FuOHdaMUx5?=
 =?utf-8?B?MlUwSHNIcWg3akRRK3dVaHp4ZjRVQVJUUm4vd2NwTWdnZlB5aWFwNHdWTDBi?=
 =?utf-8?B?YkJ0Y2t3d0NVN2tpVW9OcnhOakhuS1B5eDlycm9Uakl2TEJKaFQ4b0dUSnRw?=
 =?utf-8?B?SGJwUEVsWG9jaVBuWlJ4QTVwMU9jTmlwU2tST3g4U0lOUS9YaUZoeFlCVFFG?=
 =?utf-8?B?MXpjNVE5TnBRck1YM1FRZDkwZXV6Q0xKU0h4eTY3TGwrbWNHRFU5ZVJTWU5L?=
 =?utf-8?B?NWdyZVc0dkRLVGJIWTdyYjJQd2RGZUtzNG8wcjJNdjkxNnpNUjJpVnJZVzdh?=
 =?utf-8?B?RXZtK3JTRjNpTXVHUTFOYUcxdlorNGEzZGNiVW5ybmc2Z3lUVEV1Q3d2WVhr?=
 =?utf-8?B?Z25JeThLbkQ4K3YzZDNDQXNlZ0pCMWRkOUdrWHF1b0RoSTdhNVdPVVJ2SHdy?=
 =?utf-8?B?YU56SjcrZ09xdE5EUE5qQWdXdFp6WjZRZk0vcFhDeFU3a2pSVmErSVdia1ds?=
 =?utf-8?B?Z2NmQms0ZERvb0xNdkJzSDljUFU0YjVvK1EraGNtTUx1YkY0U3pHQjJtQkor?=
 =?utf-8?B?cTdjQUoxL2lobEdNK21TOVA0VHAyVklPZUozYzdBcGlrRkxybGNna3RqWjRS?=
 =?utf-8?B?VHJPNS9Va0UwejQ1VGhIQy9OMjJQTTJ1OVRBcSt5VW1NNXdrZE9wOUFGU3Av?=
 =?utf-8?B?Tnc2VlM5TjJaNXRSOURaT1pUV0N0aHVlNEVGeGs5d0p1d0pFbkZUWXNmQTdJ?=
 =?utf-8?B?RC9EcU4wV2U1YWI1blZFbmFIa1dTVmRCY2dGbVhYMkVhZUc0WFpGTktodFNC?=
 =?utf-8?B?NnBwT21idzZnRk5TcHlVNjJwYWJ2dXZKdXMyYXdaTzc3dnc4YkhMczRmaUhm?=
 =?utf-8?B?algrakQwM3JlWDlTQTVHeWZoa2djVG15dEVkbXJ6eittN3JyUngrenBmbWN4?=
 =?utf-8?B?Y0gxc2duUkZSUE1NeDIrQm9Qby9zUEQ5d2x3bHp1MG1KaXI0MFJpL3hYdlJV?=
 =?utf-8?B?ZjljSi80RkJ0VzlPMGpKQ3k5eHRuOEJCeVNRa0VNM0F1em1yNVEyZG1DMkZY?=
 =?utf-8?B?dVVweVBnL3VrUzF4anVWWEQ4eUJjeHhOZWR3dHpSR0x3WEVyMDI0OEFMZHdJ?=
 =?utf-8?B?Tk40dStEVmJzME9aZVBuVG15VWNVMWt5Ry9KZ1pYcGVrMEU3UVFjM2tpMkRy?=
 =?utf-8?B?R3htTWpaZVN4UzRpYmRKQ2hDR3hhMi82QklkNitTZ1MybWV5a3E2L0pTZmZm?=
 =?utf-8?B?UWNiMjBqK1MyQ09LemFrWGNkR3h2UW1lWjFQTjdteXFhUkp3TzB4SXd6S2x6?=
 =?utf-8?B?ZjBtTWlDU0lyYkdQTmNhaEhuRUt3WDdJUitIbEtBSmdaR1owMVpOSXpoL3Vn?=
 =?utf-8?B?WTFxT2ZnZUVBNjJMMnFnUE9oTFdEeWpJK2VjdjFIcWU3bHB5V2MvZlJDdVFK?=
 =?utf-8?B?MEsxZHprTENLdFVkb3RDYTdrUnhraHI2SStNb3NwcytuKzNjckgyeXpIemtL?=
 =?utf-8?B?MEM1Z0lRZmJ6b2lQdGt0dXhtZUFlSWhUOGlsZ2lRRzdVSG5wOVg3czVKQys2?=
 =?utf-8?B?NDFGTXh0S20zMEFmM3lzbEJ6Sjk1Y3l3WCtxaHczalV3NDUxU1o3NzRuOTdR?=
 =?utf-8?B?Z3piQXppSUkvSEhLNEdyWFRBK3VmTitRVnVjaHVTOU5yckQyeXg0NWVPZUZq?=
 =?utf-8?B?czArVDUyL0tXL3ZNZFFxS0JDaCt6bTRibjlNL1NCL1FNQWVGdTlhT3JIU0Z2?=
 =?utf-8?B?SXlsMGc0Z1FaQ3NNOXRLNVNVRzZiUDVYUEp2R3ZDN1hrbFc2VzAvZVJVRm5X?=
 =?utf-8?B?ZlVGbGlrZGUxRko0UEpHaTlsMWlzbDF2L2psdFo1MHFhWkRtUzU1ZXU3SEYw?=
 =?utf-8?B?eVExMFdNT252bko0THZSdjJ4ZnlVMlRGa25IdU1zRGVQSnpTeXRmMDJpQmpp?=
 =?utf-8?Q?Q5j6w1Hw6Lec25IbCUKyE8w=3D?=
X-OriginatorOrg: wolfvision.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 5e81507e-e936-4135-8f20-08dc62b40d4a
X-MS-Exchange-CrossTenant-AuthSource: VE1PR08MB4974.eurprd08.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Apr 2024 10:07:43.7707
 (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: 5Wybz9jA2ZxsQdRibtxuJI0ZWo1dweiTk8ka3qXKTk+A4nk3m5eka1Pya37Rvn96s2iWvVNemKiif5toDj5NlWhDxsIjiq+5hqEU1jvRxi4=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS8PR08MB7885

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.

To: Dmitry Torokhov <dmitry.torokhov@gmail.com>
To: Rob Herring <robh@kernel.org>
To: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
To: Conor Dooley <conor+dt@kernel.org>
To: Bastian Hecht <hechtb@gmail.com>
To: Michael Riesch <michael.riesch@wolfvision.net>
Cc: linux-input@vger.kernel.org
Cc: devicetree@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Javier Carrasco <javier.carrasco@wolfvision.net>

Changes in v9:
- touch-overlay.c: trigger a button release if the finger slides out of
  the button segment to be consistent with the button press when sliding
  into a button segment (see touch_overlay_button_event()).
- touch-overlay.c: (nit) remove braces in if with a single statement in
  touch_overaly_process_event().
- Link to v8: https://lore.kernel.org/r/20240320-feature-ts_virtobj_patch-v8-0-cab6e7dcb1f6@wolfvision.net

Changes in v8:
- touchscreen bindings: fix description formatting.
- Link to v7: https://lore.kernel.org/r/20240119-feature-ts_virtobj_patch-v7-0-eda70985808f@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                      | 263 +++++++++++++++++++++
 drivers/input/touchscreen/st1232.c                 |  48 ++--
 include/linux/input/touch-overlay.h                |  22 ++
 7 files changed, 475 insertions(+), 15 deletions(-)
---
base-commit: 0bbac3facb5d6cc0171c45c9873a2dc96bea9680
change-id: 20230510-feature-ts_virtobj_patch-e267540aae74

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