From patchwork Thu Jun 13 09:28:28 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bartosz Golaszewski X-Patchwork-Id: 803980 Received: from mail-wm1-f53.google.com (mail-wm1-f53.google.com [209.85.128.53]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E62B013E3EF for ; Thu, 13 Jun 2024 09:28:41 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.53 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718270924; cv=none; b=YKmmFJpRKhe4jHKuqDslv6FkUsTN8Gu5XpTqBFO97h/GAKoCd+fvxA0Ere9Sot61zzepjvXlEVj2w3b9o4OMPnBf2Gp7QsRF35C4fmecaEfhtdNAEEOrHsmrn2kYQ4uMUGtg09iS5xKmhi/CdG1cQeZGy6cBIiPMA1M7OHjkx8w= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718270924; c=relaxed/simple; bh=vG4qRDV6pQg/Th6atlB32vTGlz7L1/BU8b4zcWJlXT8=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=ez5JMEWgS2jIzKbOWMdkQsDw5UE5+Ei3C/TfHL6TjRnsDhi8muuoOl1buK2tJ9FXzwGvOdQHj3GRNCkg39S+Rm4HTD8bjRPgzIEDokAG8+uJZjr8ZV3I3/VArb7Pg9Ylcc8LgkdpZGKsMB/C++v8/GXYXJOBjBDBZMJ9/gH8xKI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=bgdev.pl; spf=none smtp.mailfrom=bgdev.pl; dkim=pass (2048-bit key) header.d=bgdev-pl.20230601.gappssmtp.com header.i=@bgdev-pl.20230601.gappssmtp.com header.b=GNKFMSUW; arc=none smtp.client-ip=209.85.128.53 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=bgdev.pl Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=bgdev.pl Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=bgdev-pl.20230601.gappssmtp.com header.i=@bgdev-pl.20230601.gappssmtp.com header.b="GNKFMSUW" Received: by mail-wm1-f53.google.com with SMTP id 5b1f17b1804b1-42278f3aea4so8363395e9.1 for ; Thu, 13 Jun 2024 02:28:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bgdev-pl.20230601.gappssmtp.com; s=20230601; t=1718270920; x=1718875720; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=xTL7AN68DXuCJK85qnCP9b24mcfMbuTgeoppKNKx4+E=; b=GNKFMSUWkWy9RL8bJX1e55EBLWJlwKz5eK28rqMTmbqIHWBldOxrDsAoKr1g82bOxm 59j3NULqHmCmQBrBWcl/hpGwE820D2JbCK10zP+9U5Sdx7UmjdRbGK/AzyYtHs2QZB+L qgBMFOkX4Th+MK3Tsky9obDv8umao1dsDel6hzmbfqBBn3iCsDmxH+eSnOuR16oAoplS kygN/W1NjIoF8MJBOhFeQB9SCxMINt8vKeoZ2WYfHz8Q02DMdpjIAA4enKv/swlqLEmE bjTPVkOCu6++iiLhY7JNok4KV636NfrppOACCyOjRDz0CICQSPyVg1ujdF+nxkDfD9K+ pNTg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1718270920; x=1718875720; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=xTL7AN68DXuCJK85qnCP9b24mcfMbuTgeoppKNKx4+E=; b=fwIiv/mjA7BIIM4m89QjxsQWyujVi5JnaB86ivNeXau6hQvcf/JgnP3+b1pEnTmjFR mxVKS2klQEum4B2ZRuSnz6V3Dol80GefMKmI0+ptKmtY5O1QH5Ti54dtI3EdsbvPdqWI 88NkDn5VyJ33C7cdM0ILHJH0ihxFXgW7C7XQKc8HR2rhPg+ngROdGij490MFPV4JES97 zkqiNBM7ufHRzbsph5NKwi653DAhuMx1sMvOtrUFiB3RMEei+l2u2zNo9hHab1+iKly8 magbOf25kosOEPng6dXvYyyAU5d3fslx+wL6oLI76SydyM5Dy55TACn59Fu3h1FGCRur jd5Q== X-Gm-Message-State: AOJu0YwyuW1qiYpvcsJSmsCauxGdms3bX0WMetaUgLrwvj2FWrMTxegr sfW3u9Jkt/xUQ19SiLNArYxwQSEwH2/dev56jZK6xH6kyWVnqQ+N7YIT9wq8qsI= X-Google-Smtp-Source: AGHT+IHyJhmfHkwmz+c60I80UBc53UKeGLW66TsVm0UYMnuExWwyR8x8YdHhjF4yErR5gdcvD6NbTg== X-Received: by 2002:a05:600c:470b:b0:422:52c3:7fe0 with SMTP id 5b1f17b1804b1-422864aef80mr42455395e9.22.1718270920108; Thu, 13 Jun 2024 02:28:40 -0700 (PDT) Received: from brgl-uxlite.home ([2a01:cb1d:8d3:3800:875c:e292:3280:ccac]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-422874e73e8sm54990205e9.43.2024.06.13.02.28.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Jun 2024 02:28:39 -0700 (PDT) From: Bartosz Golaszewski To: Linus Walleij , Jonathan Corbet , Greg Kroah-Hartman , "Rafael J . Wysocki" , Arnd Bergmann , Andy Shevchenko Cc: linux-gpio@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Bartosz Golaszewski Subject: [PATCH v8 0/2] misc: add a virtual driver for testing the GPIO API Date: Thu, 13 Jun 2024 11:28:28 +0200 Message-ID: <20240613092830.15761-1-brgl@bgdev.pl> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-gpio@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 From: Bartosz Golaszewski The GPIO subsystem used to have a serious problem with undefined behavior and use-after-free bugs on hot-unplug of GPIO chips. This can be considered a corner-case by some as most GPIO controllers are enabled early in the boot process and live until the system goes down but most GPIO drivers do allow unbind over sysfs, many are loadable modules that can be (force) unloaded and there are also GPIO devices that can be dynamically detached, for instance CP2112 which is a USB GPIO expender. Bugs can be triggered both from user-space as well as by in-kernel users. We have the means of testing it from user-space via the character device but the issues manifest themselves differently in the kernel. This is a proposition of adding a new virtual driver - a configurable GPIO consumer that can be configured over configfs (similarly to gpio-sim) or described on the device-tree. This driver is aimed as a helper in spotting any regressions in hot-unplug handling in GPIOLIB. v7 -> v8: - move the driver to drivers/misc/ as it's not a GPIO provider and so its place is not in drivers/gpio/ - rework the data structures to make them more compact using unions - use correct string helpers for given use-cases - drop dependency on the gpio/driver.h, string.h and kernel.h headers - add a patch exporting to_ext_attribute() to be used by this driver - various minor improvements suggested by Andy Link to v7: https://lore.kernel.org/linux-gpio/20240527144054.155503-1-brgl@bgdev.pl/ v6 -> v7: - this is a complete rewrite of the original idea, the entire interface has changed so it warrants a new round of reviews Link to v6: https://lore.kernel.org/linux-gpio/20230817184356.25020-1-brgl@bgdev.pl/ v5 -> v6: - initialize the flags temp variables at declaration and hopefully make Andy happy finally :) v4 -> v5: - add the gpio-consumer docs to the admin-guide/gpio/ index (reported by kernel test robot ) v3 -> v4: - fix the toggle value assignment - use guard(mutex)() wherever we can return directly from the subsequent function call - use skip_spaces() + strim() to avoid having to do a memmove() when stripping strings off whitespaces - DON'T try to save a couple LOC in ifdefs if that makes them less readable (Andy :) ) v2 -> v3: - use cleanup.h interfaces - add some clarifying commets - more minor code tweaks RFC -> v2: - add documentation - fix various issues pointed out by Andy: use struct_size() where applicable, improve the logic when storing the 'live' property, improve log messages, remove commas in terminators, etc. Bartosz Golaszewski (2): drivers: export to_ext_attr() misc: gpio-virtuser: new virtual testing driver for the GPIO API .../admin-guide/gpio/gpio-virtuser.rst | 176 ++ Documentation/admin-guide/gpio/index.rst | 1 + MAINTAINERS | 8 + drivers/base/core.c | 2 - drivers/misc/Kconfig | 8 + drivers/misc/Makefile | 1 + drivers/misc/gpio-virtuser.c | 1790 +++++++++++++++++ include/linux/device.h | 6 + 8 files changed, 1990 insertions(+), 2 deletions(-) create mode 100644 Documentation/admin-guide/gpio/gpio-virtuser.rst create mode 100644 drivers/misc/gpio-virtuser.c