From patchwork Thu Mar 4 10:24:42 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bartosz Golaszewski X-Patchwork-Id: 393014 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER, INCLUDES_PATCH, MAILING_LIST_MULTI, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6F822C433DB for ; Thu, 4 Mar 2021 10:32:46 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 3E25164F34 for ; Thu, 4 Mar 2021 10:32:46 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238589AbhCDKb7 (ORCPT ); Thu, 4 Mar 2021 05:31:59 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39592 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238520AbhCDKb2 (ORCPT ); Thu, 4 Mar 2021 05:31:28 -0500 Received: from mail-wr1-x432.google.com (mail-wr1-x432.google.com [IPv6:2a00:1450:4864:20::432]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 26334C061765 for ; Thu, 4 Mar 2021 02:30:09 -0800 (PST) Received: by mail-wr1-x432.google.com with SMTP id 7so27042935wrz.0 for ; Thu, 04 Mar 2021 02:30:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bgdev-pl.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=VTVqUZIbWOBx2vi73M7W0VDXvAw3I3R3JVZHB7Sln/A=; b=jqFcOBFmBW6OGc8pMVCLj1b0qqQuqt+YCkzk+Q27uBMQbo1iaTw6oEMoEV0AkHeBzR dWlkMEhqAPzVj08vhy2rqL3OqLGUdGOghAKhuAUT6MI+okAPLhtoAOucsEYnH2zbLaT3 9QMIOIg3wAPG++RHWS8WI+guEtK0StMdFlXIwa4Izj6Mp8z65Bh214qQsC8XcaUfdihR qFmhsDb26mfxrcaKHalzQtvIQQaAr8Too5zk0OPZW/tS96T7iFF8XoJdx6gLx55GKPCg Txiytv9H5miJ9VWDuZpIXpO/YYqrze0SMaethq2N5T5iiDXao32SdTfEkfL/ZmtLs1cH mHFQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=VTVqUZIbWOBx2vi73M7W0VDXvAw3I3R3JVZHB7Sln/A=; b=Vj++eoZ8WHCm8V2puCXRBcRS0SFXzVrM2a/YE+kg8FmAV0kYKV4wcOuf4RZ0tbGyHB fzaJ/S087ALD+AU2ZW6bYLtzmdyvEUpOnSOE+KoGZ0sW7aEoOvd4sFdmVfoHDHD8bqh/ 2fTDremzdFtgyktrBrw2VyWiJev9yX1DETfdpnKrtyssukRZ2FJx6+NAy1s4aqv0K8Xr +6ESiGkWTYsQAd8khSTSX/0kDNGJH4Uor86netrWjuDkPSxt3nZMfwtIXqejDOBKRvnH iv6iv/PZr+q1v+bbRl+npGipcDQeeEYIPEw13ypXR2iM8TYENJt3wwqZQ4yck/OLi5lE wm+Q== X-Gm-Message-State: AOAM531mlYQsyOtxQP1IgNWG4NVtX5PU+1/ExG2GsFrFK3lXshdyO8Mn ZOS5icPSJIazBH/UzitGIlgHCA== X-Google-Smtp-Source: ABdhPJwtsEIc4u6ANMWw8IOZ9a7RTFR2HMfg/vg90IRd5QlPPB3mPTtotQP5MkKc3Mdjx0AIJURabw== X-Received: by 2002:a05:6000:1803:: with SMTP id m3mr2828509wrh.50.1614853807980; Thu, 04 Mar 2021 02:30:07 -0800 (PST) Received: from debian-brgl.home (amarseille-656-1-4-167.w90-8.abo.wanadoo.fr. [90.8.158.167]) by smtp.gmail.com with ESMTPSA id f7sm35501854wre.78.2021.03.04.02.30.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Mar 2021 02:30:07 -0800 (PST) From: Bartosz Golaszewski To: Joel Becker , Christoph Hellwig , Shuah Khan , Linus Walleij , Andy Shevchenko , =?utf-8?q?Uwe_Kleine-K=C3=B6nig?= , Geert Uytterhoeven , Kent Gibson , Jonathan Corbet Cc: linux-gpio@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, Bartosz Golaszewski Subject: [PATCH v2 02/12] configfs: use (1UL << bit) for internal flags Date: Thu, 4 Mar 2021 11:24:42 +0100 Message-Id: <20210304102452.21726-3-brgl@bgdev.pl> X-Mailer: git-send-email 2.29.1 In-Reply-To: <20210304102452.21726-1-brgl@bgdev.pl> References: <20210304102452.21726-1-brgl@bgdev.pl> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org From: Bartosz Golaszewski For better readability and maintenance: use the (1UL << bit) for flag definitions. Signed-off-by: Bartosz Golaszewski Acked-by: Linus Walleij --- fs/configfs/configfs_internal.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/fs/configfs/configfs_internal.h b/fs/configfs/configfs_internal.h index 9a3aed249692..b495c9f043d4 100644 --- a/fs/configfs/configfs_internal.h +++ b/fs/configfs/configfs_internal.h @@ -46,16 +46,16 @@ struct configfs_dirent { struct configfs_fragment *s_frag; }; -#define CONFIGFS_ROOT 0x0001 -#define CONFIGFS_DIR 0x0002 -#define CONFIGFS_ITEM_ATTR 0x0004 -#define CONFIGFS_ITEM_BIN_ATTR 0x0008 -#define CONFIGFS_ITEM_LINK 0x0020 -#define CONFIGFS_USET_DIR 0x0040 -#define CONFIGFS_USET_DEFAULT 0x0080 -#define CONFIGFS_USET_DROPPING 0x0100 -#define CONFIGFS_USET_IN_MKDIR 0x0200 -#define CONFIGFS_USET_CREATING 0x0400 +#define CONFIGFS_ROOT (1UL << 0) +#define CONFIGFS_DIR (1UL << 1) +#define CONFIGFS_ITEM_ATTR (1UL << 2) +#define CONFIGFS_ITEM_BIN_ATTR (1UL << 3) +#define CONFIGFS_ITEM_LINK (1UL << 5) +#define CONFIGFS_USET_DIR (1UL << 6) +#define CONFIGFS_USET_DEFAULT (1UL << 7) +#define CONFIGFS_USET_DROPPING (1UL << 8) +#define CONFIGFS_USET_IN_MKDIR (1UL << 9) +#define CONFIGFS_USET_CREATING (1UL << 10) #define CONFIGFS_NOT_PINNED (CONFIGFS_ITEM_ATTR | CONFIGFS_ITEM_BIN_ATTR) extern struct mutex configfs_symlink_mutex; From patchwork Thu Mar 4 10:24:44 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bartosz Golaszewski X-Patchwork-Id: 393013 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER, INCLUDES_PATCH, MAILING_LIST_MULTI, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED, USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id B462EC4332D for ; Thu, 4 Mar 2021 10:32:46 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 97D0664F3A for ; Thu, 4 Mar 2021 10:32:46 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238555AbhCDKcA (ORCPT ); Thu, 4 Mar 2021 05:32:00 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39544 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238485AbhCDKbb (ORCPT ); Thu, 4 Mar 2021 05:31:31 -0500 Received: from mail-wr1-x42d.google.com (mail-wr1-x42d.google.com [IPv6:2a00:1450:4864:20::42d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 00B1FC0613DD for ; Thu, 4 Mar 2021 02:30:10 -0800 (PST) Received: by mail-wr1-x42d.google.com with SMTP id a18so18822308wrc.13 for ; Thu, 04 Mar 2021 02:30:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bgdev-pl.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Bs0N+b7IbNFBoZCqiL+fVI6wVQVsEVA2VSnx/V3f4QI=; b=i+Zvg25xWRRu3Q+3OHqNie0KuSOiMHg6Had86XZY/5pU4nj64JjnzVPBvlXb100DOY 55fH5/xUvZDflCQt+qb9eJwDxrAMVcc7VTXf6LvuhVwMt1UI4r2jr3FJBwU3JDkwv7Wj HHaBp+Fcl37uh7LYBMPHYBrlascVC/XfrppRxQlYnItNZNgWlwOr6g4cybI0E7r+GYzS +3o5/Tdy1Xuc+yp9ld87CGZnogyIBpZpBLyYcUQQQ4UKcKjieo7ocJtNtt4mVUjHveiP 2bV+S5MkgpN53kZtGLSaMR+WRRpxvc3iOwYVGB0xQNFRR04gtt+9fr5q+r/0HBpEtkmV lAwg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Bs0N+b7IbNFBoZCqiL+fVI6wVQVsEVA2VSnx/V3f4QI=; b=V706neAo3yy4XiABUvHGOmPDW145Q1R7qP9YA8ZzAQKdAAKq+f0HvzXxw510rrbrdr L4SsHiEjobQtTBDJm0Xb0kSHKYjn1TiWSxnoyjLt13XhIqrNzCg8lx0k8UBblMQQb3YY N2UDeOwxMskaSo6nOtZtuMA9L4ku4cCgj5RZX13x+qM0GFHo2YcvQuYGQyjn1XJPIT4y KV9PlS9b/GAwbgACokUYDHVZbjY61pJVRXKPndDTQBxyOIgy/I9BIvZ9p7swcJqvYohb VnUFLROxWMAubaUEeq9kB+cdO6+6qOp7sKskGbryd62x+Knf1PrFGrETnVWktDalw4Td WOKw== X-Gm-Message-State: AOAM532uZw3FJuwZv0EuaSA62g69ptKGQXsUJZ73OksnxG5EbBA1NW5W o+RrTMiG+LiJCsbOC7kRlmoQaQ== X-Google-Smtp-Source: ABdhPJzIhX1GD3MT99SO7tV3rh3J1lUvbyMcRtszgrTHe6AQgZOwY8ko4EmIITwwTNLJc76mCCH0Uw== X-Received: by 2002:adf:d236:: with SMTP id k22mr3317611wrh.144.1614853809697; Thu, 04 Mar 2021 02:30:09 -0800 (PST) Received: from debian-brgl.home (amarseille-656-1-4-167.w90-8.abo.wanadoo.fr. [90.8.158.167]) by smtp.gmail.com with ESMTPSA id f7sm35501854wre.78.2021.03.04.02.30.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Mar 2021 02:30:09 -0800 (PST) From: Bartosz Golaszewski To: Joel Becker , Christoph Hellwig , Shuah Khan , Linus Walleij , Andy Shevchenko , =?utf-8?q?Uwe_Kleine-K=C3=B6nig?= , Geert Uytterhoeven , Kent Gibson , Jonathan Corbet Cc: linux-gpio@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, Bartosz Golaszewski Subject: [PATCH v2 04/12] samples: configfs: add a committable group Date: Thu, 4 Mar 2021 11:24:44 +0100 Message-Id: <20210304102452.21726-5-brgl@bgdev.pl> X-Mailer: git-send-email 2.29.1 In-Reply-To: <20210304102452.21726-1-brgl@bgdev.pl> References: <20210304102452.21726-1-brgl@bgdev.pl> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org From: Bartosz Golaszewski Add an example of using committable items to configfs samples. Each config item has two attributes: read-write 'storeme' which works similarly to other examples in this file and a read-only 'committed' attribute which changes its value between false and true depending on whether it's committed or not at the moment. Signed-off-by: Bartosz Golaszewski Acked-by: Linus Walleij --- samples/configfs/configfs_sample.c | 153 +++++++++++++++++++++++++++++ 1 file changed, 153 insertions(+) diff --git a/samples/configfs/configfs_sample.c b/samples/configfs/configfs_sample.c index f9008be7a8a1..9bef74e4369d 100644 --- a/samples/configfs/configfs_sample.c +++ b/samples/configfs/configfs_sample.c @@ -315,6 +315,158 @@ static struct configfs_subsystem group_children_subsys = { /* ----------------------------------------------------------------- */ +/* + * 04-committable-children + * + * This is an example of a committable group. It's similar to the simple + * children example but each config_item has an additional 'committed' + * attribute which is read-only and is only modified when the config_item + * is moved from the 'pending' to the 'live' directory. + */ + +struct committable_child { + struct config_item item; + int storeme; + bool committed; +}; + +static inline struct committable_child * +to_committable_child(struct config_item *item) +{ + return container_of(item, struct committable_child, item); +} + +static ssize_t +committable_child_storeme_show(struct config_item *item, char *page) +{ + return sprintf(page, "%d\n", to_committable_child(item)->storeme); +} + +static ssize_t committable_child_storeme_store(struct config_item *item, + const char *page, size_t count) +{ + struct committable_child *child = to_committable_child(item); + int ret; + + if (child->committed) + return -EPERM; + + ret = kstrtoint(page, 10, &child->storeme); + if (ret) + return ret; + + return count; +} + +CONFIGFS_ATTR(committable_child_, storeme); + +static ssize_t +committable_child_committed_show(struct config_item *item, char *page) +{ + return sprintf(page, "%s\n", + to_committable_child(item)->committed ? "true" : "false"); +} + +CONFIGFS_ATTR_RO(committable_child_, committed); + +static struct configfs_attribute *committable_child_attrs[] = { + &committable_child_attr_storeme, + &committable_child_attr_committed, + NULL, +}; + +static void committable_child_release(struct config_item *item) +{ + kfree(to_committable_child(item)); +} + +static struct configfs_item_operations committable_child_item_ops = { + .release = committable_child_release, +}; + +static const struct config_item_type committable_child_type = { + .ct_item_ops = &committable_child_item_ops, + .ct_attrs = committable_child_attrs, + .ct_owner = THIS_MODULE, +}; + +struct committable_children { + struct config_group group; +}; + +static struct config_item * +committable_children_make_item(struct config_group *group, const char *name) +{ + struct committable_child *child; + + child = kzalloc(sizeof(*child), GFP_KERNEL); + if (!child) + return ERR_PTR(-ENOMEM); + + config_item_init_type_name(&child->item, name, &committable_child_type); + + return &child->item; +} + +static ssize_t +committable_children_description_show(struct config_item *item, char *page) +{ + return sprintf(page, +"[04-committable-children]\n" +"\n" +"This subsystem allows creation of committable config_items. The subsystem\n" +"has two subdirectories: pending and live. New config_items can only be\n" +"created in pending/ and they have one writable and readable attribute as\n" +"well as a single read-only attribute. The latter is only changed once the\n" +"item is 'committed'. This is done by moving the config_item (using\n" +"rename()) to the live/ directory. In this example, the storeme attribute\n" +"becomes 'read-only' once committed.\n"); +} + +CONFIGFS_ATTR_RO(committable_children_, description); + +static struct configfs_attribute *committable_children_attrs[] = { + &committable_children_attr_description, + NULL, +}; + +static int committable_children_commit_item(struct config_item *item) +{ + to_committable_child(item)->committed = true; + + return 0; +} + +static int committable_children_uncommit_item(struct config_item *item) +{ + to_committable_child(item)->committed = false; + + return 0; +} + +static struct configfs_group_operations committable_children_group_ops = { + .make_item = committable_children_make_item, + .commit_item = committable_children_commit_item, + .uncommit_item = committable_children_uncommit_item, +}; + +static const struct config_item_type committable_children_type = { + .ct_group_ops = &committable_children_group_ops, + .ct_attrs = committable_children_attrs, + .ct_owner = THIS_MODULE, +}; + +static struct configfs_subsystem committable_children_subsys = { + .su_group = { + .cg_item = { + .ci_namebuf = "04-committable-children", + .ci_type = &committable_children_type, + }, + }, +}; + +/* ----------------------------------------------------------------- */ + /* * We're now done with our subsystem definitions. * For convenience in this module, here's a list of them all. It @@ -326,6 +478,7 @@ static struct configfs_subsystem *example_subsys[] = { &childless_subsys.subsys, &simple_children_subsys, &group_children_subsys, + &committable_children_subsys, NULL, }; From patchwork Thu Mar 4 10:24:45 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bartosz Golaszewski X-Patchwork-Id: 393011 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER, INCLUDES_PATCH, MAILING_LIST_MULTI, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED, USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6922FC4360C for ; Thu, 4 Mar 2021 10:32:47 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 59F9B64F41 for ; Thu, 4 Mar 2021 10:32:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238577AbhCDKcC (ORCPT ); Thu, 4 Mar 2021 05:32:02 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39706 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238582AbhCDKb4 (ORCPT ); Thu, 4 Mar 2021 05:31:56 -0500 Received: from mail-wm1-x32f.google.com (mail-wm1-x32f.google.com [IPv6:2a00:1450:4864:20::32f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 262C7C0613E0 for ; Thu, 4 Mar 2021 02:30:12 -0800 (PST) Received: by mail-wm1-x32f.google.com with SMTP id w7so7532981wmb.5 for ; Thu, 04 Mar 2021 02:30:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bgdev-pl.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=pCe90PiqGmxROg4pfqFFTH25K7JQCv+JP3yxH8AOnKc=; b=EnueNiX6NpYKxBrj0wY36yyGp38a1izgQNX8Hx89b9vCl82p35QuJoeFi0PlgUEKdu adhL2KupJr9zBnoE0Qj3UPOk5DXG8PTYa5do55m2LDWTrih9GhieMQGmMBel92zrhQMP SCOQ89LyCAgrDjvE/GGe6WITNj68OMGsE2uQ/aHKJvaYrYVEBdBMJ1ro6OAp/GkchOFM QLTa526fTJMiNYEzS4msmOreeOBYRGRZoGlmYhUax5bQZNM+bFN17TIrx4urSvta/XbJ cgxuZAvzP/tJdV8HivrZ+Tq3Op8aL12FAm2laj/AgEFHrerOZpyLfbUC1dbjTcSrQ0FY CEZw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=pCe90PiqGmxROg4pfqFFTH25K7JQCv+JP3yxH8AOnKc=; b=NYLGMS0OLf6cTYv1H6OwC25LLmlk+1ODbSiC8K0kGe/wMBZiMuhH6M/ReuBdretHlp OpiYKs9SYtwDh5GSbgSe7bB3xnNpUp5kiyGZa6noZGpBnneoUvlcTdAMCXxWO0ZQxRcf JwyxPo9SY4PF+VvBpYyeNxi5cgnsBlrq47llcLuQ9TqUcT6cyApZLFBgxrhm1/eys7l0 KNBaVQbmkdmQGGaGyCkl9mPaCUEG0UYBwNG8z86l9QOXTaNaK2jmUFWpGlg8QgmBRUWn 1y8oJdDNrxyy7QvpAdAQkgnDIkTk5nHBoP9S3Sx0NWnMa1jy0s61s9LNYJtSt/Xxic9S aAQQ== X-Gm-Message-State: AOAM533bBcErg4y6pgQCeBL7eFMCCUojb2TzQBpAgf2S6hoIXNxmbEze oFXE7qbuyZjJfJlhm5+89+icJw== X-Google-Smtp-Source: ABdhPJzXMkznue5E1BXwSAv/5Jnk3qYctYhg0S8yF4gHZKgRkHzuNTIh1oPe4Fqhe5HmfeqXk9SRtA== X-Received: by 2002:a1c:2016:: with SMTP id g22mr3213575wmg.137.1614853810754; Thu, 04 Mar 2021 02:30:10 -0800 (PST) Received: from debian-brgl.home (amarseille-656-1-4-167.w90-8.abo.wanadoo.fr. [90.8.158.167]) by smtp.gmail.com with ESMTPSA id f7sm35501854wre.78.2021.03.04.02.30.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Mar 2021 02:30:10 -0800 (PST) From: Bartosz Golaszewski To: Joel Becker , Christoph Hellwig , Shuah Khan , Linus Walleij , Andy Shevchenko , =?utf-8?q?Uwe_Kleine-K=C3=B6nig?= , Geert Uytterhoeven , Kent Gibson , Jonathan Corbet Cc: linux-gpio@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, Bartosz Golaszewski Subject: [PATCH v2 05/12] lib: bitmap: remove the 'extern' keyword from function declarations Date: Thu, 4 Mar 2021 11:24:45 +0100 Message-Id: <20210304102452.21726-6-brgl@bgdev.pl> X-Mailer: git-send-email 2.29.1 In-Reply-To: <20210304102452.21726-1-brgl@bgdev.pl> References: <20210304102452.21726-1-brgl@bgdev.pl> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org From: Bartosz Golaszewski The 'extern' keyword doesn't have any benefits in header files. Remove it. Signed-off-by: Bartosz Golaszewski Reviewed-by: Andy Shevchenko --- include/linux/bitmap.h | 115 ++++++++++++++++++++--------------------- 1 file changed, 57 insertions(+), 58 deletions(-) diff --git a/include/linux/bitmap.h b/include/linux/bitmap.h index 70a932470b2d..6939a8983026 100644 --- a/include/linux/bitmap.h +++ b/include/linux/bitmap.h @@ -118,54 +118,53 @@ * Allocation and deallocation of bitmap. * Provided in lib/bitmap.c to avoid circular dependency. */ -extern unsigned long *bitmap_alloc(unsigned int nbits, gfp_t flags); -extern unsigned long *bitmap_zalloc(unsigned int nbits, gfp_t flags); -extern void bitmap_free(const unsigned long *bitmap); +unsigned long *bitmap_alloc(unsigned int nbits, gfp_t flags); +unsigned long *bitmap_zalloc(unsigned int nbits, gfp_t flags); +void bitmap_free(const unsigned long *bitmap); /* * lib/bitmap.c provides these functions: */ -extern int __bitmap_equal(const unsigned long *bitmap1, - const unsigned long *bitmap2, unsigned int nbits); -extern bool __pure __bitmap_or_equal(const unsigned long *src1, - const unsigned long *src2, - const unsigned long *src3, - unsigned int nbits); -extern void __bitmap_complement(unsigned long *dst, const unsigned long *src, - unsigned int nbits); -extern void __bitmap_shift_right(unsigned long *dst, const unsigned long *src, - unsigned int shift, unsigned int nbits); -extern void __bitmap_shift_left(unsigned long *dst, const unsigned long *src, - unsigned int shift, unsigned int nbits); -extern void bitmap_cut(unsigned long *dst, const unsigned long *src, - unsigned int first, unsigned int cut, - unsigned int nbits); -extern int __bitmap_and(unsigned long *dst, const unsigned long *bitmap1, +int __bitmap_equal(const unsigned long *bitmap1, + const unsigned long *bitmap2, unsigned int nbits); +bool __pure __bitmap_or_equal(const unsigned long *src1, + const unsigned long *src2, + const unsigned long *src3, + unsigned int nbits); +void __bitmap_complement(unsigned long *dst, const unsigned long *src, + unsigned int nbits); +void __bitmap_shift_right(unsigned long *dst, const unsigned long *src, + unsigned int shift, unsigned int nbits); +void __bitmap_shift_left(unsigned long *dst, const unsigned long *src, + unsigned int shift, unsigned int nbits); +void bitmap_cut(unsigned long *dst, const unsigned long *src, + unsigned int first, unsigned int cut, unsigned int nbits); +int __bitmap_and(unsigned long *dst, const unsigned long *bitmap1, + const unsigned long *bitmap2, unsigned int nbits); +void __bitmap_or(unsigned long *dst, const unsigned long *bitmap1, + const unsigned long *bitmap2, unsigned int nbits); +void __bitmap_xor(unsigned long *dst, const unsigned long *bitmap1, + const unsigned long *bitmap2, unsigned int nbits); +int __bitmap_andnot(unsigned long *dst, const unsigned long *bitmap1, + const unsigned long *bitmap2, unsigned int nbits); +void __bitmap_replace(unsigned long *dst, + const unsigned long *old, const unsigned long *new, + const unsigned long *mask, unsigned int nbits); +int __bitmap_intersects(const unsigned long *bitmap1, const unsigned long *bitmap2, unsigned int nbits); -extern void __bitmap_or(unsigned long *dst, const unsigned long *bitmap1, - const unsigned long *bitmap2, unsigned int nbits); -extern void __bitmap_xor(unsigned long *dst, const unsigned long *bitmap1, - const unsigned long *bitmap2, unsigned int nbits); -extern int __bitmap_andnot(unsigned long *dst, const unsigned long *bitmap1, - const unsigned long *bitmap2, unsigned int nbits); -extern void __bitmap_replace(unsigned long *dst, - const unsigned long *old, const unsigned long *new, - const unsigned long *mask, unsigned int nbits); -extern int __bitmap_intersects(const unsigned long *bitmap1, - const unsigned long *bitmap2, unsigned int nbits); -extern int __bitmap_subset(const unsigned long *bitmap1, - const unsigned long *bitmap2, unsigned int nbits); -extern int __bitmap_weight(const unsigned long *bitmap, unsigned int nbits); -extern void __bitmap_set(unsigned long *map, unsigned int start, int len); -extern void __bitmap_clear(unsigned long *map, unsigned int start, int len); - -extern unsigned long bitmap_find_next_zero_area_off(unsigned long *map, - unsigned long size, - unsigned long start, - unsigned int nr, - unsigned long align_mask, - unsigned long align_offset); +int __bitmap_subset(const unsigned long *bitmap1, + const unsigned long *bitmap2, unsigned int nbits); +int __bitmap_weight(const unsigned long *bitmap, unsigned int nbits); +void __bitmap_set(unsigned long *map, unsigned int start, int len); +void __bitmap_clear(unsigned long *map, unsigned int start, int len); + +unsigned long bitmap_find_next_zero_area_off(unsigned long *map, + unsigned long size, + unsigned long start, + unsigned int nr, + unsigned long align_mask, + unsigned long align_offset); /** * bitmap_find_next_zero_area - find a contiguous aligned zero area @@ -190,33 +189,33 @@ bitmap_find_next_zero_area(unsigned long *map, align_mask, 0); } -extern int bitmap_parse(const char *buf, unsigned int buflen, +int bitmap_parse(const char *buf, unsigned int buflen, unsigned long *dst, int nbits); -extern int bitmap_parse_user(const char __user *ubuf, unsigned int ulen, +int bitmap_parse_user(const char __user *ubuf, unsigned int ulen, unsigned long *dst, int nbits); -extern int bitmap_parselist(const char *buf, unsigned long *maskp, +int bitmap_parselist(const char *buf, unsigned long *maskp, int nmaskbits); -extern int bitmap_parselist_user(const char __user *ubuf, unsigned int ulen, +int bitmap_parselist_user(const char __user *ubuf, unsigned int ulen, unsigned long *dst, int nbits); -extern void bitmap_remap(unsigned long *dst, const unsigned long *src, +void bitmap_remap(unsigned long *dst, const unsigned long *src, const unsigned long *old, const unsigned long *new, unsigned int nbits); -extern int bitmap_bitremap(int oldbit, +int bitmap_bitremap(int oldbit, const unsigned long *old, const unsigned long *new, int bits); -extern void bitmap_onto(unsigned long *dst, const unsigned long *orig, +void bitmap_onto(unsigned long *dst, const unsigned long *orig, const unsigned long *relmap, unsigned int bits); -extern void bitmap_fold(unsigned long *dst, const unsigned long *orig, +void bitmap_fold(unsigned long *dst, const unsigned long *orig, unsigned int sz, unsigned int nbits); -extern int bitmap_find_free_region(unsigned long *bitmap, unsigned int bits, int order); -extern void bitmap_release_region(unsigned long *bitmap, unsigned int pos, int order); -extern int bitmap_allocate_region(unsigned long *bitmap, unsigned int pos, int order); +int bitmap_find_free_region(unsigned long *bitmap, unsigned int bits, int order); +void bitmap_release_region(unsigned long *bitmap, unsigned int pos, int order); +int bitmap_allocate_region(unsigned long *bitmap, unsigned int pos, int order); #ifdef __BIG_ENDIAN -extern void bitmap_copy_le(unsigned long *dst, const unsigned long *src, unsigned int nbits); +void bitmap_copy_le(unsigned long *dst, const unsigned long *src, unsigned int nbits); #else #define bitmap_copy_le bitmap_copy #endif -extern unsigned int bitmap_ord_to_pos(const unsigned long *bitmap, unsigned int ord, unsigned int nbits); -extern int bitmap_print_to_pagebuf(bool list, char *buf, +unsigned int bitmap_ord_to_pos(const unsigned long *bitmap, unsigned int ord, unsigned int nbits); +int bitmap_print_to_pagebuf(bool list, char *buf, const unsigned long *maskp, int nmaskbits); #define BITMAP_FIRST_WORD_MASK(start) (~0UL << ((start) & (BITS_PER_LONG - 1))) @@ -265,9 +264,9 @@ static inline void bitmap_copy_clear_tail(unsigned long *dst, * therefore conversion is not needed when copying data from/to arrays of u32. */ #if BITS_PER_LONG == 64 -extern void bitmap_from_arr32(unsigned long *bitmap, const u32 *buf, +void bitmap_from_arr32(unsigned long *bitmap, const u32 *buf, unsigned int nbits); -extern void bitmap_to_arr32(u32 *buf, const unsigned long *bitmap, +void bitmap_to_arr32(u32 *buf, const unsigned long *bitmap, unsigned int nbits); #else #define bitmap_from_arr32(bitmap, buf, nbits) \ From patchwork Thu Mar 4 10:24:46 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bartosz Golaszewski X-Patchwork-Id: 393009 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER, INCLUDES_PATCH, MAILING_LIST_MULTI, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED, USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BE4C0C433E6 for ; Thu, 4 Mar 2021 10:33:18 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9C6B564F2B for ; Thu, 4 Mar 2021 10:33:18 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238687AbhCDKcc (ORCPT ); Thu, 4 Mar 2021 05:32:32 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39750 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238656AbhCDKcI (ORCPT ); Thu, 4 Mar 2021 05:32:08 -0500 Received: from mail-wm1-x330.google.com (mail-wm1-x330.google.com [IPv6:2a00:1450:4864:20::330]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 058B6C0613E3 for ; Thu, 4 Mar 2021 02:30:13 -0800 (PST) Received: by mail-wm1-x330.google.com with SMTP id k66so9130327wmf.1 for ; Thu, 04 Mar 2021 02:30:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bgdev-pl.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=jzLcn/9JFFu/zAnz2fz4llMxe0ZNESpsBe/AAdOPAB8=; b=tuRBMG8HzrbDNFK8qAYS22PR4XQ2So85s7DniK8OWce7W92hEoiJwjeBU2i2PY3X6l ouGt9uuEdG/TNzuKbXDdMBzv60SNx9ywfNVhzNiAo7JXpYnaKPPFL11M4k2tl7iFSrte ZXlJOQfCvCeEvhP5Xt9/W1FScPmHLQgb+PHAu3Tb8sSdiF8LUGhBpuPjC8OYpwIdJDaT 9+JTGwgtBqmhkH5eT0PzY0YZ+w2S7TY5fiHBnRcNEr5rmRDDOVv5KNekn9HZ8xJTwDjO 5WhJoGB6Q6g96ok0hzPlUyDW1B1RJyptPiXTZ84Amg1hKWsWGlLuwuY6lpZNoJTg6gTU jMhA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=jzLcn/9JFFu/zAnz2fz4llMxe0ZNESpsBe/AAdOPAB8=; b=LLRceZx9BwYWfaoPeA+3vniqbCRjEh+1hGGWomgOOFOqNlvG3TVP+I/tZR6ghmmpt4 Kl7YlGYMS7/f6blWSb301ECxyBh3cMSwgKiAVq7m1+uVh94FYO6aIofpL6tdde6Ki4w1 j+1o0Wo7tetPrSmR2nb8qd5zz2TAtINS5xF1+GFCUvplLW2oatFfU3IWTotOW0sBkO4A KYVSuoNKA9XtI/5LTk7MIKVrAaIigefEKscoVA9FzVCv/5wKGv2PqDqZZ4EcAEpj9Prv vUTsudJxxJ4Z1tT6F5P4m/lByvf/IQ2gzeIQ7juH+zlXh7gBxO+5er6Nvig8wM9MJufl mAgA== X-Gm-Message-State: AOAM532mBwHdHJb0ouXyrYorZXjZk7lKSj0deqoIt0CM0vGda7bK/h7B +EYalv05AvaDhmKGfkTbDiha8g== X-Google-Smtp-Source: ABdhPJwOYvL1KO3KRXjN8n30tg8GfdxYxQb08ru+C3Jv/q3rkh1v5cZ0T6iJXrCdfEmnn+bpte48GA== X-Received: by 2002:a05:600c:2204:: with SMTP id z4mr3303682wml.31.1614853811561; Thu, 04 Mar 2021 02:30:11 -0800 (PST) Received: from debian-brgl.home (amarseille-656-1-4-167.w90-8.abo.wanadoo.fr. [90.8.158.167]) by smtp.gmail.com with ESMTPSA id f7sm35501854wre.78.2021.03.04.02.30.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Mar 2021 02:30:11 -0800 (PST) From: Bartosz Golaszewski To: Joel Becker , Christoph Hellwig , Shuah Khan , Linus Walleij , Andy Shevchenko , =?utf-8?q?Uwe_Kleine-K=C3=B6nig?= , Geert Uytterhoeven , Kent Gibson , Jonathan Corbet Cc: linux-gpio@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, Bartosz Golaszewski Subject: [PATCH v2 06/12] lib: bitmap: order includes alphabetically Date: Thu, 4 Mar 2021 11:24:46 +0100 Message-Id: <20210304102452.21726-7-brgl@bgdev.pl> X-Mailer: git-send-email 2.29.1 In-Reply-To: <20210304102452.21726-1-brgl@bgdev.pl> References: <20210304102452.21726-1-brgl@bgdev.pl> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org From: Bartosz Golaszewski For better readability and maintenance: order the includes in bitmap source files alphabetically. Signed-off-by: Bartosz Golaszewski Reviewed-by: Andy Shevchenko --- include/linux/bitmap.h | 4 ++-- lib/bitmap.c | 9 +++++---- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/include/linux/bitmap.h b/include/linux/bitmap.h index 6939a8983026..3282db97e06c 100644 --- a/include/linux/bitmap.h +++ b/include/linux/bitmap.h @@ -4,10 +4,10 @@ #ifndef __ASSEMBLY__ -#include #include -#include #include +#include +#include /* * bitmaps provide bit arrays that consume one or more unsigned diff --git a/lib/bitmap.c b/lib/bitmap.c index 75006c4036e9..78f70d9007ad 100644 --- a/lib/bitmap.c +++ b/lib/bitmap.c @@ -3,17 +3,18 @@ * lib/bitmap.c * Helper functions for bitmap.h. */ -#include -#include -#include -#include + #include #include #include +#include +#include +#include #include #include #include #include +#include #include #include From patchwork Thu Mar 4 10:24:49 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bartosz Golaszewski X-Patchwork-Id: 393010 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER, INCLUDES_PATCH, MAILING_LIST_MULTI, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A1813C4160E for ; Thu, 4 Mar 2021 10:32:47 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8630264F42 for ; Thu, 4 Mar 2021 10:32:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238544AbhCDKcC (ORCPT ); Thu, 4 Mar 2021 05:32:02 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39544 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238577AbhCDKbr (ORCPT ); Thu, 4 Mar 2021 05:31:47 -0500 Received: from mail-wm1-x32e.google.com (mail-wm1-x32e.google.com [IPv6:2a00:1450:4864:20::32e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 89E19C061797 for ; Thu, 4 Mar 2021 02:30:17 -0800 (PST) Received: by mail-wm1-x32e.google.com with SMTP id o7-20020a05600c4fc7b029010a0247d5f0so4254265wmq.1 for ; Thu, 04 Mar 2021 02:30:17 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bgdev-pl.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=yCWIrKl54RCFx8GrQqQlQePQo4V7mPlw65+kYdkruHs=; b=xW5W/NR9KpYNo0xU4NqtIBePcq+6Q/gJ9WCX06ULAuLzDTcsWyp5tn5rj9FvTQ3NlQ rz7qbrtrdvLMo5VG0sH11qn+MHqPSKhw+MNJccouVAEgmMhwt/NBjIlMDngj3X/WYma+ 6gk5in71irTgeD1UcsqCUyxjwJObCGyEUGmqWg4LxJXGsgHZfJLZ2iIi2Wrjq5M7chpL 2ebGPnaQy++r/+sTXjLCu9Y5xkQj5mhc1jEN7+USTrJuWVjjml4nQpjgoJURFN9frkI1 mHuV5HkL2rpYMzoFx009eHOHN2XNuL/r+bMfnFhYXNfKgurbziXhz2eg4ULFF3nHN0h1 XufQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=yCWIrKl54RCFx8GrQqQlQePQo4V7mPlw65+kYdkruHs=; b=Y76hor/8MKK4KsLxwTkTSRXOZfnhK/BOpRm/4q4pG7Yq9fn5iMR8ZVWrXfEqlFxWV2 k/dklgkc+J9kdRxqk4XTF+2LQe6DC7Kn3yBzCr8Y3BeZ9V40btweiIH9YeRvPYenSybc CjaahqGs3D8ELTegqVw9F/9zy4j5w3V0E4+eP/WEKojNLtHjNBGmJcB6MR3Q+UcelOJy 9kA12mSu+guT1bOt+4r8cQ2XiYKVuxDmbspcf2J9CJ/DorMuBGyYId44YSzTuqZ/GOT0 Twjq6qvm/MNfQKzNgcVa5xufQwq59wJbN+/pMBcrJAiutSVSZbmLJKyTM4cJaOdE/3hd ZF+Q== X-Gm-Message-State: AOAM532PT3QqQVdOe0scKdcLsZ1g7V1XMXWFU00/b3A2Juho3ZKAarnD Ua0YRU9So1rGtQh1j8jnLSUZng== X-Google-Smtp-Source: ABdhPJz27pRYR80u8kJTr7vIWpJD3d+O3wO70yrk42jZHOdgDFAjaXA9wSp8ymBNq34BZLreAWYaMA== X-Received: by 2002:a05:600c:409:: with SMTP id q9mr3261421wmb.105.1614853813981; Thu, 04 Mar 2021 02:30:13 -0800 (PST) Received: from debian-brgl.home (amarseille-656-1-4-167.w90-8.abo.wanadoo.fr. [90.8.158.167]) by smtp.gmail.com with ESMTPSA id f7sm35501854wre.78.2021.03.04.02.30.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Mar 2021 02:30:13 -0800 (PST) From: Bartosz Golaszewski To: Joel Becker , Christoph Hellwig , Shuah Khan , Linus Walleij , Andy Shevchenko , =?utf-8?q?Uwe_Kleine-K=C3=B6nig?= , Geert Uytterhoeven , Kent Gibson , Jonathan Corbet Cc: linux-gpio@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, Bartosz Golaszewski Subject: [PATCH v2 09/12] gpio: sim: new testing module Date: Thu, 4 Mar 2021 11:24:49 +0100 Message-Id: <20210304102452.21726-10-brgl@bgdev.pl> X-Mailer: git-send-email 2.29.1 In-Reply-To: <20210304102452.21726-1-brgl@bgdev.pl> References: <20210304102452.21726-1-brgl@bgdev.pl> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org From: Bartosz Golaszewski Implement a new, modern GPIO testing module controlled by configfs attributes instead of module parameters. The goal of this driver is to provide a replacement for gpio-mockup that will be easily extensible with new features and doesn't require reloading the module to change the setup. Signed-off-by: Bartosz Golaszewski --- Documentation/admin-guide/gpio/gpio-sim.rst | 72 ++ drivers/gpio/Kconfig | 8 + drivers/gpio/Makefile | 1 + drivers/gpio/gpio-sim.c | 878 ++++++++++++++++++++ 4 files changed, 959 insertions(+) create mode 100644 Documentation/admin-guide/gpio/gpio-sim.rst create mode 100644 drivers/gpio/gpio-sim.c diff --git a/Documentation/admin-guide/gpio/gpio-sim.rst b/Documentation/admin-guide/gpio/gpio-sim.rst new file mode 100644 index 000000000000..08eac487e35e --- /dev/null +++ b/Documentation/admin-guide/gpio/gpio-sim.rst @@ -0,0 +1,72 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +Configfs GPIO Simulator +======================= + +The configfs GPIO Simulator (gpio-sim) provides a way to create simulated GPIO +chips for testing purposes. The lines exposed by these chips can be accessed +using the standard GPIO character device interface as well as manipulated +using sysfs attributes. + +Creating simulated chips +------------------------ + +The gpio-sim module registers a configfs subsystem called 'gpio-sim'. It's a +subsystem with committable items which means two subdirectories are created in +the filesystem: pending and live. For more information on configfs and +committable items, please refer to Documentation/filesystems/configfs.rst. + +In order to instantiate a new simulated chip, the user needs to mkdir() a new +directory in pending/. Inside each new directory, there's a set of attributes +that can be used to configure the new chip. Once the configuration is complete, +the user needs to use rename() to move the chip to the live/ directory. This +creates and registers the new device. + +In order to destroy a simulated chip, it has to be moved back to pending first +and then removed using rmdir(). + +Currently supported configuration attributes are: + + num_lines - an unsigned integer value defining the number of GPIO lines to + export + + label - a string defining the label for the GPIO chip + + line_names - a list of GPIO line names in the form of quoted strings + separated by commas, e.g.: '"foo", "bar", "", "foobar"'. The + number of strings doesn't have to be equal to the value set in + the num_lines attribute. If it's lower than the number of lines, + the remaining lines are unnamed. If it's larger, the superfluous + lines are ignored. A name of the form: '""' means the line + should be unnamed. + +Additionally two read-only attributes named 'chip_name' and 'dev_name' are +exposed in order to provide users with a mapping from configfs directories to +the actual devices created in the kernel. The former returns the name of the +GPIO device as assigned by gpiolib (i.e. "gpiochip0", "gpiochip1", etc.). The +latter returns the parent device name as defined by the gpio-sim driver (i.e. +"gpio-sim.0", "gpio-sim.1", etc.). This allows user-space to map the configfs +items both to the correct character device file as well as the associated entry +in sysfs. + +Simulated GPIO chips can also be defined in device-tree. The compatible string +must be: "gpio-simulator". Supported properties are: + + "gpio-sim,label" - chip label + + "gpio-sim,nr-gpios" - number of lines + +Other standard GPIO properties (like "gpio-line-names" and gpio-hog) are also +supported. + +Manipulating simulated lines +---------------------------- + +Each simulated GPIO chip creates a sysfs attribute group under its device +directory called 'line-ctrl'. Inside each group, there's a separate attribute +for each GPIO line. The name of the attribute is of the form 'gpioX' where X +is the line's offset in the chip. + +Reading from a line attribute returns the current value. Writing to it (0 or 1) +changes the configuration of the simulated pull-up/pull-down resistor +(1 - pull-up, 0 - pull-down). diff --git a/drivers/gpio/Kconfig b/drivers/gpio/Kconfig index e3607ec4c2e8..b6b6150d0d04 100644 --- a/drivers/gpio/Kconfig +++ b/drivers/gpio/Kconfig @@ -1633,6 +1633,14 @@ config GPIO_MOCKUP tools/testing/selftests/gpio/gpio-mockup.sh. Reference the usage in it. +config GPIO_SIM + tristate "GPIO Simulator Module" + select IRQ_SIM + select CONFIGFS_FS + help + This enables the GPIO simulator - a configfs-based GPIO testing + driver. + endmenu endif diff --git a/drivers/gpio/Makefile b/drivers/gpio/Makefile index c58a90a3c3b1..d717aa85f8e1 100644 --- a/drivers/gpio/Makefile +++ b/drivers/gpio/Makefile @@ -130,6 +130,7 @@ obj-$(CONFIG_GPIO_SAMA5D2_PIOBU) += gpio-sama5d2-piobu.o obj-$(CONFIG_GPIO_SCH311X) += gpio-sch311x.o obj-$(CONFIG_GPIO_SCH) += gpio-sch.o obj-$(CONFIG_GPIO_SIFIVE) += gpio-sifive.o +obj-$(CONFIG_GPIO_SIM) += gpio-sim.o obj-$(CONFIG_GPIO_SIOX) += gpio-siox.o obj-$(CONFIG_GPIO_SL28CPLD) += gpio-sl28cpld.o obj-$(CONFIG_GPIO_SODAVILLE) += gpio-sodaville.o diff --git a/drivers/gpio/gpio-sim.c b/drivers/gpio/gpio-sim.c new file mode 100644 index 000000000000..0ed297127bca --- /dev/null +++ b/drivers/gpio/gpio-sim.c @@ -0,0 +1,878 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * GPIO testing driver based on configfs. + * + * Copyright (C) 2021 Bartosz Golaszewski + */ + +#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "gpiolib.h" + +/* + * This normally should correspond with the number of attributes exposed over + * configfs + sentinel. + */ +#define GPIO_SIM_MAX_PROP 4 + +static DEFINE_IDA(gpio_sim_ida); + +struct gpio_sim_chip { + struct gpio_chip gc; + unsigned long *directions; + unsigned long *values; + unsigned long *pulls; + struct irq_domain *irq_sim; + struct mutex lock; + struct attribute_group attr_group; +}; + +struct gpio_sim_attribute { + struct device_attribute dev_attr; + unsigned int offset; +}; + +static struct gpio_sim_attribute * +to_gpio_sim_attr(struct device_attribute *dev_attr) +{ + return container_of(dev_attr, struct gpio_sim_attribute, dev_attr); +} + +static int gpio_sim_apply_pull(struct gpio_sim_chip *chip, + unsigned int offset, int value) +{ + int curr_val, irq, irq_type, ret; + struct gpio_desc *desc; + struct gpio_chip *gc; + + gc = &chip->gc; + desc = &gc->gpiodev->descs[offset]; + + mutex_lock(&chip->lock); + + if (test_bit(FLAG_REQUESTED, &desc->flags) && + !test_bit(FLAG_IS_OUT, &desc->flags)) { + curr_val = !!test_bit(offset, chip->values); + if (curr_val == value) + goto set_pull; + + /* + * This is fine - it just means, nobody is listening + * for interrupts on this line, otherwise + * irq_create_mapping() would have been called from + * the to_irq() callback. + */ + irq = irq_find_mapping(chip->irq_sim, offset); + if (!irq) + goto set_value; + + irq_type = irq_get_trigger_type(irq); + + if ((value && (irq_type & IRQ_TYPE_EDGE_RISING)) || + (!value && (irq_type & IRQ_TYPE_EDGE_FALLING))) { + ret = irq_set_irqchip_state(irq, IRQCHIP_STATE_PENDING, + true); + if (ret) + goto set_pull; + } + } + +set_value: + /* Change the value unless we're actively driving the line. */ + if (!test_bit(FLAG_REQUESTED, &desc->flags) || + !test_bit(FLAG_IS_OUT, &desc->flags)) + __assign_bit(offset, chip->values, value); + +set_pull: + __assign_bit(offset, chip->pulls, value); + mutex_unlock(&chip->lock); + return 0; +} + +static int gpio_sim_get(struct gpio_chip *gc, unsigned int offset) +{ + struct gpio_sim_chip *chip = gpiochip_get_data(gc); + int ret; + + mutex_lock(&chip->lock); + ret = !!test_bit(offset, chip->values); + mutex_unlock(&chip->lock); + + return ret; +} + +static void gpio_sim_set(struct gpio_chip *gc, unsigned int offset, int value) +{ + struct gpio_sim_chip *chip = gpiochip_get_data(gc); + + mutex_lock(&chip->lock); + __assign_bit(offset, chip->values, value); + mutex_unlock(&chip->lock); +} + +static int gpio_sim_get_multiple(struct gpio_chip *gc, + unsigned long *mask, unsigned long *bits) +{ + struct gpio_sim_chip *chip = gpiochip_get_data(gc); + + mutex_lock(&chip->lock); + bitmap_copy(bits, chip->values, gc->ngpio); + mutex_unlock(&chip->lock); + + return 0; +} + +static void gpio_sim_set_multiple(struct gpio_chip *gc, + unsigned long *mask, unsigned long *bits) +{ + struct gpio_sim_chip *chip = gpiochip_get_data(gc); + + mutex_lock(&chip->lock); + bitmap_copy(chip->values, bits, gc->ngpio); + mutex_unlock(&chip->lock); +} + +static int gpio_sim_direction_output(struct gpio_chip *gc, + unsigned int offset, int value) +{ + struct gpio_sim_chip *chip = gpiochip_get_data(gc); + + mutex_lock(&chip->lock); + __clear_bit(offset, chip->directions); + __assign_bit(offset, chip->values, value); + mutex_unlock(&chip->lock); + + return 0; +} + +static int gpio_sim_direction_input(struct gpio_chip *gc, unsigned int offset) +{ + struct gpio_sim_chip *chip = gpiochip_get_data(gc); + + mutex_lock(&chip->lock); + __set_bit(offset, chip->directions); + mutex_unlock(&chip->lock); + + return 0; +} + +static int gpio_sim_get_direction(struct gpio_chip *gc, unsigned int offset) +{ + struct gpio_sim_chip *chip = gpiochip_get_data(gc); + int direction; + + mutex_lock(&chip->lock); + direction = !!test_bit(offset, chip->directions); + mutex_unlock(&chip->lock); + + return direction ? GPIO_LINE_DIRECTION_IN : GPIO_LINE_DIRECTION_OUT; +} + +static int gpio_sim_set_config(struct gpio_chip *gc, + unsigned int offset, unsigned long config) +{ + struct gpio_sim_chip *chip = gpiochip_get_data(gc); + + switch (pinconf_to_config_param(config)) { + case PIN_CONFIG_BIAS_PULL_UP: + return gpio_sim_apply_pull(chip, offset, 1); + case PIN_CONFIG_BIAS_PULL_DOWN: + return gpio_sim_apply_pull(chip, offset, 0); + default: + break; + } + + return -ENOTSUPP; +} + +static int gpio_sim_to_irq(struct gpio_chip *gc, unsigned int offset) +{ + struct gpio_sim_chip *chip = gpiochip_get_data(gc); + + return irq_create_mapping(chip->irq_sim, offset); +} + +static void gpio_sim_free(struct gpio_chip *gc, unsigned int offset) +{ + struct gpio_sim_chip *chip = gpiochip_get_data(gc); + + mutex_lock(&chip->lock); + __assign_bit(offset, chip->values, !!test_bit(offset, chip->pulls)); + mutex_unlock(&chip->lock); +} + +static ssize_t gpio_sim_sysfs_line_show(struct device *dev, + struct device_attribute *attr, + char *buf) +{ + struct gpio_sim_attribute *line_attr = to_gpio_sim_attr(attr); + struct gpio_sim_chip *chip = dev_get_drvdata(dev); + int ret; + + mutex_lock(&chip->lock); + ret = sprintf(buf, "%u\n", !!test_bit(line_attr->offset, chip->values)); + mutex_unlock(&chip->lock); + + return ret; +} + +static ssize_t gpio_sim_sysfs_line_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t len) +{ + struct gpio_sim_attribute *line_attr = to_gpio_sim_attr(attr); + struct gpio_sim_chip *chip = dev_get_drvdata(dev); + int ret, val; + + if (len > 2 || (buf[0] != '0' && buf[0] != '1')) + return -EINVAL; + + val = buf[0] == '0' ? 0 : 1; + + ret = gpio_sim_apply_pull(chip, line_attr->offset, val); + if (ret) + return ret; + + return len; +} + +static void gpio_sim_mutex_destroy(void *data) +{ + struct mutex *lock = data; + + mutex_destroy(lock); +} + +static void gpio_sim_sysfs_remove(void *data) +{ + struct gpio_sim_chip *chip = data; + + sysfs_remove_group(&chip->gc.parent->kobj, &chip->attr_group); +} + +static int gpio_sim_setup_sysfs(struct gpio_sim_chip *chip) +{ + unsigned int i, num_lines = chip->gc.ngpio; + struct device *dev = chip->gc.parent; + struct gpio_sim_attribute *line_attr; + struct device_attribute *dev_attr; + struct attribute **attrs; + int ret; + + attrs = devm_kcalloc(dev, sizeof(*attrs), num_lines + 1, GFP_KERNEL); + if (!attrs) + return -ENOMEM; + + for (i = 0; i < num_lines; i++) { + line_attr = devm_kzalloc(dev, sizeof(*line_attr), GFP_KERNEL); + if (!line_attr) + return -ENOMEM; + + line_attr->offset = i; + + dev_attr = &line_attr->dev_attr; + + dev_attr->attr.name = devm_kasprintf(dev, GFP_KERNEL, + "gpio%u", i); + if (!dev_attr->attr.name) + return -ENOMEM; + + dev_attr->attr.mode = 0644; + + dev_attr->show = gpio_sim_sysfs_line_show; + dev_attr->store = gpio_sim_sysfs_line_store; + + attrs[i] = &dev_attr->attr; + } + + chip->attr_group.name = "line-ctrl"; + chip->attr_group.attrs = attrs; + + ret = sysfs_create_group(&dev->kobj, &chip->attr_group); + if (ret) + return ret; + + return devm_add_action_or_reset(dev, gpio_sim_sysfs_remove, chip); +} + +static int gpio_sim_probe(struct platform_device *pdev) +{ + struct device *dev = &pdev->dev; + struct gpio_sim_chip *chip; + struct gpio_chip *gc; + const char *label; + u32 num_lines; + int ret; + + ret = device_property_read_u32(dev, "gpio-sim,nr-gpios", &num_lines); + if (ret) + return ret; + + ret = device_property_read_string(dev, "gpio-sim,label", &label); + if (ret) + label = dev_name(dev); + + chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL); + if (!chip) + return -ENOMEM; + + chip->directions = devm_bitmap_zalloc(dev, num_lines, GFP_KERNEL); + if (!chip->directions) + return -ENOMEM; + + /* Default to input mode. */ + bitmap_fill(chip->directions, num_lines); + + chip->values = devm_bitmap_zalloc(dev, num_lines, GFP_KERNEL); + if (!chip->values) + return -ENOMEM; + + chip->pulls = devm_bitmap_zalloc(dev, num_lines, GFP_KERNEL); + if (!chip->pulls) + return -ENOMEM; + + chip->irq_sim = devm_irq_domain_create_sim(dev, NULL, num_lines); + if (IS_ERR(chip->irq_sim)) + return PTR_ERR(chip->irq_sim); + + mutex_init(&chip->lock); + ret = devm_add_action_or_reset(dev, gpio_sim_mutex_destroy, + &chip->lock); + if (ret) + return ret; + + gc = &chip->gc; + gc->base = -1; + gc->ngpio = num_lines; + gc->label = label; + gc->owner = THIS_MODULE; + gc->parent = dev; + gc->get = gpio_sim_get; + gc->set = gpio_sim_set; + gc->get_multiple = gpio_sim_get_multiple; + gc->set_multiple = gpio_sim_set_multiple; + gc->direction_output = gpio_sim_direction_output; + gc->direction_input = gpio_sim_direction_input; + gc->get_direction = gpio_sim_get_direction; + gc->set_config = gpio_sim_set_config; + gc->to_irq = gpio_sim_to_irq; + gc->free = gpio_sim_free; + + ret = devm_gpiochip_add_data(dev, gc, chip); + if (ret) + return ret; + + /* Used by sysfs and configfs callbacks. */ + dev_set_drvdata(dev, chip); + + ret = gpio_sim_setup_sysfs(chip); + if (ret) + return ret; + + return 0; +} + +static const struct of_device_id gpio_sim_of_match[] = { + { .compatible = "gpio-simulator" }, + { } +}; +MODULE_DEVICE_TABLE(of, gpio_sim_of_match); + +static struct platform_driver gpio_sim_driver = { + .driver = { + .name = "gpio-sim", + }, + .probe = gpio_sim_probe, +}; + +struct gpio_sim_chip_config { + struct config_item item; + + /* + * If pdev is NULL, the item is 'pending' (waiting for configuration). + * Once the pointer is assigned, the device has been created and the + * item is 'live'. + */ + struct platform_device *pdev; + + /* + * Each configfs filesystem operation is protected with the subsystem + * mutex. Each separate attribute is protected with the buffer mutex. + * This structure however can be modified by callbacks of different + * attributes so we need another lock. + */ + struct mutex lock; + + char label[32]; + unsigned int num_lines; + char **line_names; + unsigned int num_line_names; +}; + +static struct gpio_sim_chip_config * +to_gpio_sim_chip_config(struct config_item *item) +{ + return container_of(item, struct gpio_sim_chip_config, item); +} + +static ssize_t gpio_sim_config_dev_name_show(struct config_item *item, + char *page) +{ + struct gpio_sim_chip_config *config = to_gpio_sim_chip_config(item); + struct platform_device *pdev; + int ret; + + mutex_lock(&config->lock); + pdev = config->pdev; + if (pdev && device_is_bound(&pdev->dev)) + ret = sprintf(page, "%s\n", dev_name(&pdev->dev)); + else + ret = -ENODEV; + mutex_unlock(&config->lock); + + return ret; +} + +CONFIGFS_ATTR_RO(gpio_sim_config_, dev_name); + +static ssize_t gpio_sim_config_chip_name_show(struct config_item *item, + char *page) +{ + struct gpio_sim_chip_config *config = to_gpio_sim_chip_config(item); + struct platform_device *pdev; + struct gpio_sim_chip *chip; + int ret; + + mutex_lock(&config->lock); + pdev = config->pdev; + if (pdev && device_is_bound(&pdev->dev)) { + chip = dev_get_drvdata(&pdev->dev); + ret = sprintf(page, "%s\n", dev_name(&chip->gc.gpiodev->dev)); + } else { + ret = -ENODEV; + } + mutex_unlock(&config->lock); + + return ret; +} + +CONFIGFS_ATTR_RO(gpio_sim_config_, chip_name); + +static ssize_t gpio_sim_config_label_show(struct config_item *item, char *page) +{ + struct gpio_sim_chip_config *config = to_gpio_sim_chip_config(item); + int ret; + + mutex_lock(&config->lock); + ret = sprintf(page, "%s\n", config->label); + mutex_unlock(&config->lock); + + return ret; +} + +static ssize_t gpio_sim_config_label_store(struct config_item *item, + const char *page, size_t count) +{ + struct gpio_sim_chip_config *config = to_gpio_sim_chip_config(item); + char *dup, *trimmed; + int ret; + + mutex_lock(&config->lock); + + if (config->pdev) { + mutex_unlock(&config->lock); + return -EBUSY; + } + + dup = kstrndup(page, count, GFP_KERNEL); + if (!dup) { + mutex_unlock(&config->lock); + return -ENOMEM; + } + + trimmed = strstrip(dup); + ret = snprintf(config->label, sizeof(config->label), "%s", trimmed); + kfree(dup); + if (ret < 0) { + mutex_unlock(&config->lock); + return ret; + } + + mutex_unlock(&config->lock); + return count; +} + +CONFIGFS_ATTR(gpio_sim_config_, label); + +static ssize_t gpio_sim_config_num_lines_show(struct config_item *item, + char *page) +{ + struct gpio_sim_chip_config *config = to_gpio_sim_chip_config(item); + int ret; + + mutex_lock(&config->lock); + ret = sprintf(page, "%u\n", config->num_lines); + mutex_unlock(&config->lock); + + return ret; +} + +static ssize_t gpio_sim_config_num_lines_store(struct config_item *item, + const char *page, size_t count) +{ + struct gpio_sim_chip_config *config = to_gpio_sim_chip_config(item); + unsigned int num_lines; + int ret; + + mutex_lock(&config->lock); + + if (config->pdev) { + mutex_unlock(&config->lock); + return -EBUSY; + } + + ret = kstrtouint(page, 10, &num_lines); + if (ret) { + mutex_unlock(&config->lock); + return ret; + } + + if (num_lines == 0) { + mutex_unlock(&config->lock); + return -EINVAL; + } + + config->num_lines = num_lines; + + mutex_unlock(&config->lock); + return count; +} + +CONFIGFS_ATTR(gpio_sim_config_, num_lines); + +static ssize_t gpio_sim_config_line_names_show(struct config_item *item, + char *page) +{ + struct gpio_sim_chip_config *config = to_gpio_sim_chip_config(item); + int ret, i, written = 0; + + mutex_lock(&config->lock); + + if (!config->line_names) { + mutex_unlock(&config->lock); + return sprintf(page, "\n"); + } + + for (i = 0; i < config->num_line_names; i++) { + ret = sprintf(page + written, + i < config->num_line_names - 1 ? + "\"%s\", " : "\"%s\"\n", + config->line_names[i] ?: ""); + if (ret < 0) { + mutex_unlock(&config->lock); + return ret; + } + + written += ret; + } + + mutex_unlock(&config->lock); + return written; +} + +static ssize_t gpio_sim_config_line_names_store(struct config_item *item, + const char *page, size_t count) +{ + struct gpio_sim_chip_config *config = to_gpio_sim_chip_config(item); + unsigned int num_new_names = 1, num_old_names, name_idx = 0; + bool in_quote = false, got_comma = true; + char **new_names, **old_names, *name, c; + const char *start = page; + size_t pos, name_len; + int err = -EINVAL; + + mutex_lock(&config->lock); + + if (config->pdev) { + mutex_unlock(&config->lock); + return -EBUSY; + } + + /* + * Line names are stored in a pointer array so that we can easily + * pass them down to the GPIO subsystem in a "gpio-line-names" + * property. + * + * Line names must be passed as a list of quoted names separated by + * commas, for example: '"foo", "bar", "foobar"'. + */ + + for (pos = 0; pos < count; pos++) { + /* + * Just count the commas and assume the number if strings + * equals the number of commas + 1. If the format is wrong + * we'll bail out anyway. + */ + if (page[pos] == ',') + num_new_names++; + } + + new_names = kcalloc(num_new_names, sizeof(char *), GFP_KERNEL); + if (!new_names) { + mutex_unlock(&config->lock); + return -ENOMEM; + } + + /* + * FIXME If anyone knows a better way to parse that - please let me + * know. + */ + for (pos = 0; pos < count; pos++) { + c = page[pos]; + + if (in_quote) { + if (c == '"') { + /* This is the end of the name. */ + in_quote = got_comma = false; + name_len = (page + pos) - start; + if (name_len == 0) { + /* Name is empty (passed as ""). */ + name_idx++; + continue; + } + + name = kzalloc(name_len + 1, GFP_KERNEL); + if (!name) { + err = -ENOMEM; + goto err_out; + } + + memcpy(name, start, name_len); + new_names[name_idx++] = name; + } + } else { + if (c == '"') { + /* Enforce separating names with commas. */ + if (!got_comma) + goto err_out; + + start = page + pos + 1; + in_quote = true; + } else if (c == ',') { + if (!got_comma) + got_comma = true; + else + /* Double commas are not allowed. */ + goto err_out; + } else if (!isspace(c)) { + goto err_out; + } + } + } + + /* + * End of input sanity checks, must not have a comma at the end and + * must have finished scanning the last name. + */ + if (in_quote || got_comma) + goto err_out; + + old_names = config->line_names; + num_old_names = config->num_line_names; + config->line_names = new_names; + config->num_line_names = num_new_names; + + mutex_unlock(&config->lock); + kfree_strarray(old_names, num_old_names); + return count; + +err_out: + mutex_unlock(&config->lock); + kfree_strarray(new_names, name_idx); + return err; +} + +CONFIGFS_ATTR(gpio_sim_config_, line_names); + +static struct configfs_attribute *gpio_sim_config_attrs[] = { + &gpio_sim_config_attr_dev_name, + &gpio_sim_config_attr_chip_name, + &gpio_sim_config_attr_label, + &gpio_sim_config_attr_num_lines, + &gpio_sim_config_attr_line_names, + NULL +}; + +static void gpio_sim_chip_config_release(struct config_item *item) +{ + struct gpio_sim_chip_config *config = to_gpio_sim_chip_config(item); + + mutex_destroy(&config->lock); + kfree_strarray(config->line_names, config->num_line_names); + kfree(config); +} + +static struct configfs_item_operations gpio_sim_config_item_ops = { + .release = gpio_sim_chip_config_release, +}; + +static const struct config_item_type gpio_sim_chip_config_type = { + .ct_item_ops = &gpio_sim_config_item_ops, + .ct_attrs = gpio_sim_config_attrs, + .ct_owner = THIS_MODULE, +}; + +static struct config_item * +gpio_sim_config_make_item(struct config_group *group, const char *name) +{ + struct gpio_sim_chip_config *config; + + config = kzalloc(sizeof(*config), GFP_KERNEL); + if (!config) + return ERR_PTR(-ENOMEM); + + config_item_init_type_name(&config->item, name, + &gpio_sim_chip_config_type); + config->num_lines = 1; + mutex_init(&config->lock); + + return &config->item; +} + +static int gpio_sim_config_commit_item(struct config_item *item) +{ + struct gpio_sim_chip_config *config = to_gpio_sim_chip_config(item); + struct property_entry properties[GPIO_SIM_MAX_PROP]; + struct platform_device_info pdevinfo; + struct platform_device *pdev; + unsigned int prop_idx = 0; + + memset(&pdevinfo, 0, sizeof(pdevinfo)); + memset(properties, 0, sizeof(properties)); + + mutex_lock(&config->lock); + + properties[prop_idx++] = PROPERTY_ENTRY_U32("gpio-sim,nr-gpios", + config->num_lines); + + if (config->label[0] != '\0') + properties[prop_idx++] = PROPERTY_ENTRY_STRING("gpio-sim,label", + config->label); + + if (config->line_names) + properties[prop_idx++] = PROPERTY_ENTRY_STRING_ARRAY_LEN( + "gpio-line-names", + config->line_names, + config->num_line_names); + + pdevinfo.id = ida_alloc(&gpio_sim_ida, GFP_KERNEL); + if (pdevinfo.id < 0) { + mutex_unlock(&config->lock); + return pdevinfo.id; + } + + pdevinfo.name = "gpio-sim"; + pdevinfo.properties = properties; + + pdev = platform_device_register_full(&pdevinfo); + if (IS_ERR(pdev)) { + ida_free(&gpio_sim_ida, pdevinfo.id); + mutex_unlock(&config->lock); + return PTR_ERR(pdev); + } + + config->pdev = pdev; + mutex_unlock(&config->lock); + + return 0; +} + +static int gpio_sim_config_uncommit_item(struct config_item *item) +{ + struct gpio_sim_chip_config *config = to_gpio_sim_chip_config(item); + int id; + + mutex_lock(&config->lock); + id = config->pdev->id; + platform_device_unregister(config->pdev); + config->pdev = NULL; + ida_free(&gpio_sim_ida, id); + mutex_unlock(&config->lock); + + return 0; +} + +static struct configfs_group_operations gpio_sim_config_group_ops = { + .make_item = gpio_sim_config_make_item, + .commit_item = gpio_sim_config_commit_item, + .uncommit_item = gpio_sim_config_uncommit_item, +}; + +static const struct config_item_type gpio_sim_config_type = { + .ct_group_ops = &gpio_sim_config_group_ops, + .ct_owner = THIS_MODULE, +}; + +static struct configfs_subsystem gpio_sim_config_subsys = { + .su_group = { + .cg_item = { + .ci_namebuf = "gpio-sim", + .ci_type = &gpio_sim_config_type, + }, + }, +}; + +static int __init gpio_sim_init(void) +{ + int ret; + + ret = platform_driver_register(&gpio_sim_driver); + if (ret) { + pr_err("Error %d while registering the platform driver\n", ret); + return ret; + } + + config_group_init(&gpio_sim_config_subsys.su_group); + mutex_init(&gpio_sim_config_subsys.su_mutex); + ret = configfs_register_subsystem(&gpio_sim_config_subsys); + if (ret) { + pr_err("Error %d while registering the configfs subsystem %s\n", + ret, gpio_sim_config_subsys.su_group.cg_item.ci_namebuf); + mutex_destroy(&gpio_sim_config_subsys.su_mutex); + platform_driver_unregister(&gpio_sim_driver); + return ret; + } + + return 0; +} +module_init(gpio_sim_init); + +static void __exit gpio_sim_exit(void) +{ + configfs_unregister_subsystem(&gpio_sim_config_subsys); + mutex_destroy(&gpio_sim_config_subsys.su_mutex); + platform_driver_unregister(&gpio_sim_driver); +} +module_exit(gpio_sim_exit); + +MODULE_AUTHOR("Bartosz Golaszewski "); +MODULE_DESCRIPTION("GPIO Simulator Module"); +MODULE_LICENSE("GPL"); From patchwork Thu Mar 4 10:24:52 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bartosz Golaszewski X-Patchwork-Id: 393012 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER, INCLUDES_PATCH, MAILING_LIST_MULTI, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 557A7C43619 for ; Thu, 4 Mar 2021 10:32:47 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 385CD64EE3 for ; Thu, 4 Mar 2021 10:32:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238587AbhCDKcD (ORCPT ); Thu, 4 Mar 2021 05:32:03 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39590 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238586AbhCDKb6 (ORCPT ); Thu, 4 Mar 2021 05:31:58 -0500 Received: from mail-wr1-x432.google.com (mail-wr1-x432.google.com [IPv6:2a00:1450:4864:20::432]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id EBFF2C0617A9 for ; Thu, 4 Mar 2021 02:30:17 -0800 (PST) Received: by mail-wr1-x432.google.com with SMTP id 7so27043511wrz.0 for ; Thu, 04 Mar 2021 02:30:17 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bgdev-pl.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=XNP0GOSaV6O38FdFUyX0Qx0YcxxArEepxK+Me+y1rLM=; b=bm+cIjTxkth9i1+gyCY7gEOOY/uhQ2lR2vLD0gXNi4iSQJSy6dAgKUmKhdlLO3lNub +ZUwYCb2CprGcCF+1M04Y/U/zl2IXZxJr17oz01qfua/DYletcuFUZuEKNruIr/ML4Zu HP7zun7OCGpENTpYnBritQ9eS0A4iiMyAmRd+TC6XGGa0daoxt0drrZwXBTnJ4ubXKQT wRsVhZBFjtGvARzTzV1lQZDcqfaaWmpm16I5ZkG/nsAEY3ENux5ttklSaBjdrHUdaUvC iqAvACDTQWQiAYWzX4GhHrZw6xh/WDaaDNfuFh8kBMFjo5DF2VJYO77W0paGyWXzCNT5 aq5g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=XNP0GOSaV6O38FdFUyX0Qx0YcxxArEepxK+Me+y1rLM=; b=ZyhFeEsg4sQ9aZCyQjvJoOxmiHX+WuRQRKoDQms5acyWxIkIMUq/uVYL/cYic79pJE ZopaARbSJidxAb3MT9mCn4R9YLUiipnLsF0OtEV9cqtlho5lphCxHK5KoUqee+9STaa6 n76sbYeERJI8CNEcOuOvT0KpQ10Vsk7zL+Yzc/Pk3jO7UNJtn79jVhpw9j9KekjUj1jB oYI+2Q48FO1jmxl2nPaBxG6AIdTyT3Agv2tdxjQ4xRESDyowlDP41BpXXSDH/9sw7uG6 Nw+rQ4pdQNGjmyfvKC/MEubvHQ3rC7Bflh9eVZSVnO09HwG+eWVcatQYe3kh0Mt0unJE RuUA== X-Gm-Message-State: AOAM5316qQpWpwJOZXGt8VAmACKit9iXTkELOKhKMpvk8aJzLiNfkH86 YiQ9DMETPPCw1BkVgRfAH9hpUA== X-Google-Smtp-Source: ABdhPJzXcOg37JPCvCRkmoG/VR1TucC/GjNfp6BeXHvfBBfTHfG4HjNy0I0yVw1jzcBbgW6isMF8wA== X-Received: by 2002:adf:a4d1:: with SMTP id h17mr3238842wrb.57.1614853816427; Thu, 04 Mar 2021 02:30:16 -0800 (PST) Received: from debian-brgl.home (amarseille-656-1-4-167.w90-8.abo.wanadoo.fr. [90.8.158.167]) by smtp.gmail.com with ESMTPSA id f7sm35501854wre.78.2021.03.04.02.30.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Mar 2021 02:30:16 -0800 (PST) From: Bartosz Golaszewski To: Joel Becker , Christoph Hellwig , Shuah Khan , Linus Walleij , Andy Shevchenko , =?utf-8?q?Uwe_Kleine-K=C3=B6nig?= , Geert Uytterhoeven , Kent Gibson , Jonathan Corbet Cc: linux-gpio@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, Bartosz Golaszewski Subject: [PATCH v2 12/12] selftests: gpio: add test cases for gpio-sim Date: Thu, 4 Mar 2021 11:24:52 +0100 Message-Id: <20210304102452.21726-13-brgl@bgdev.pl> X-Mailer: git-send-email 2.29.1 In-Reply-To: <20210304102452.21726-1-brgl@bgdev.pl> References: <20210304102452.21726-1-brgl@bgdev.pl> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org From: Bartosz Golaszewski Add a set of tests for the new gpio-sim module. This is a pure shell test-suite and uses the helper programs available in the gpio selftests directory. These test-cases only test the functionalities exposed by the gpio-sim driver, not those handled by core gpiolib code. Signed-off-by: Bartosz Golaszewski --- tools/testing/selftests/gpio/Makefile | 2 +- tools/testing/selftests/gpio/config | 1 + tools/testing/selftests/gpio/gpio-sim.sh | 229 +++++++++++++++++++++++ 3 files changed, 231 insertions(+), 1 deletion(-) create mode 100755 tools/testing/selftests/gpio/gpio-sim.sh diff --git a/tools/testing/selftests/gpio/Makefile b/tools/testing/selftests/gpio/Makefile index d7d8f1985d99..4c6df61c76a8 100644 --- a/tools/testing/selftests/gpio/Makefile +++ b/tools/testing/selftests/gpio/Makefile @@ -1,6 +1,6 @@ # SPDX-License-Identifier: GPL-2.0 -TEST_PROGS := gpio-mockup.sh +TEST_PROGS := gpio-mockup.sh gpio-sim.sh TEST_FILES := gpio-mockup-sysfs.sh TEST_GEN_PROGS_EXTENDED := gpio-mockup-cdev gpio-chip-info gpio-line-name diff --git a/tools/testing/selftests/gpio/config b/tools/testing/selftests/gpio/config index ce100342c20b..409a8532facc 100644 --- a/tools/testing/selftests/gpio/config +++ b/tools/testing/selftests/gpio/config @@ -1,3 +1,4 @@ CONFIG_GPIOLIB=y CONFIG_GPIO_CDEV=y CONFIG_GPIO_MOCKUP=m +CONFIG_GPIO_SIM=m diff --git a/tools/testing/selftests/gpio/gpio-sim.sh b/tools/testing/selftests/gpio/gpio-sim.sh new file mode 100755 index 000000000000..9fd13ab8bec6 --- /dev/null +++ b/tools/testing/selftests/gpio/gpio-sim.sh @@ -0,0 +1,229 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0 +# Copyright (C) 2021 Bartosz Golaszewski + +BASE_DIR=`dirname $0` +CONFIGFS_DIR="/sys/kernel/config/gpio-sim" +PENDING_DIR=$CONFIGFS_DIR/pending +LIVE_DIR=$CONFIGFS_DIR/live +MODULE="gpio-sim" + +fail() { + echo "$*" >&2 + echo "GPIO $MODULE test FAIL" + exit 1 +} + +skip() { + echo "$*" >&2 + echo "GPIO $MODULE test SKIP" + exit 4 +} + +configfs_cleanup() { + for DIR in `ls $LIVE_DIR`; do + mv $LIVE_DIR/$DIR $PENDING_DIR + done + + for DIR in `ls $PENDING_DIR`; do + rmdir $PENDING_DIR/$DIR + done +} + +create_pending_chip() { + local NAME="$1" + local LABEL="$2" + local NUM_LINES="$3" + local LINE_NAMES="$4" + local CHIP_DIR="$PENDING_DIR/$NAME" + + mkdir $CHIP_DIR + test -n "$LABEL" && echo $LABEL > $CHIP_DIR/label + test -n "$NUM_LINES" && echo $NUM_LINES > $CHIP_DIR/num_lines + if [ -n "$LINE_NAMES" ]; then + echo $LINE_NAMES 2> /dev/null > $CHIP_DIR/line_names + # This one can fail + if [ "$?" -ne "0" ]; then + return 1 + fi + fi +} + +create_live_chip() { + local CHIP_DIR="$PENDING_DIR/$1" + + create_pending_chip "$@" || fail "unable to create the chip configfs item" + mv $CHIP_DIR $LIVE_DIR || fail "unable to commit the chip configfs item" +} + +remove_pending_chip() { + local NAME="$1" + + rmdir $PENDING_DIR/$NAME || fail "unable to remove the chip configfs item" +} + +remove_live_chip() { + local NAME="$1" + + mv $LIVE_DIR/$NAME $PENDING_DIR || fail "unable to uncommit the chip configfs item" + remove_pending_chip "$@" +} + +configfs_chip_name() { + local CHIP="$1" + + cat $LIVE_DIR/$CHIP/chip_name 2> /dev/null || return 1 +} + +configfs_dev_name() { + local CHIP="$1" + + cat $LIVE_DIR/$CHIP/dev_name 2> /dev/null || return 1 +} + +get_chip_num_lines() { + local CHIP="$1" + + $BASE_DIR/gpio-chip-info /dev/`configfs_chip_name $CHIP` num-lines +} + +get_chip_label() { + local CHIP="$1" + + $BASE_DIR/gpio-chip-info /dev/`configfs_chip_name $CHIP` label +} + +get_line_name() { + local CHIP="$1" + local OFFSET="$2" + + $BASE_DIR/gpio-line-name /dev/`configfs_chip_name $CHIP` $OFFSET +} + +sysfs_set_pull() { + local CHIP="$1" + local OFFSET="$2" + local PULL="$3" + local SYSFSPATH="/sys/devices/platform/`configfs_dev_name $CHIP`/line-ctrl/gpio$OFFSET" + + echo $PULL > $SYSFSPATH +} + +# Load the gpio-sim module. This will pull in configfs if needed too. +modprobe gpio-sim || skip "unable to load the gpio-sim module" +# Make sure configfs is mounted at /sys/kernel/config. Wait a bit if needed. +for IDX in `seq 5`; do + if [ "$IDX" -eq "5" ]; then + skip "configfs not mounted at /sys/kernel/config" + fi + + mountpoint -q /sys/kernel/config && break + sleep 0.1 +done +# If the module was already loaded: remove all previous chips +configfs_cleanup + +trap "exit 1" SIGTERM SIGINT +trap configfs_cleanup EXIT + +echo "1. chip_name and dev_name attributes" + +echo "1.1. Chip name is communicated to user" +create_live_chip chip +test -n `cat $LIVE_DIR/chip/chip_name` || fail "chip_name doesn't work" +remove_live_chip chip + +echo "1.2. chip_name returns an error if chip is still pending" +create_pending_chip chip +configfs_chip_name chip && fail "chip_name doesn't return error for a pending chip" +remove_pending_chip chip + +echo "1.3. Device name is communicated to user" +create_live_chip chip +test -n `cat $LIVE_DIR/chip/dev_name` || fail "dev_name doesn't work" +remove_live_chip chip + +echo "1.4. dev_name returns an error if chip is still pending" +create_pending_chip chip +configfs_dev_name chip && fail "dev_name doesn't return error for a pending chip" +remove_pending_chip chip + +echo "2. Creating simulated chips" + +echo "2.1. Default number of lines is 1" +create_live_chip chip +test "`get_chip_num_lines chip`" = "1" || fail "default number of lines is not 1" +remove_live_chip chip + +echo "2.2. Number of lines can be specified" +create_live_chip chip test-label 16 +test "`get_chip_num_lines chip`" = "16" || fail "number of lines is not 16" +remove_live_chip chip + +echo "2.3. Label can be set" +create_live_chip chip foobar +test "`get_chip_label chip`" = "foobar" || fail "label is incorrect" +remove_live_chip chip + +echo "2.4. Label can be left empty" +create_live_chip chip +test -z "`cat $LIVE_DIR/chip/label`" || fail "label is not empty" +remove_live_chip chip + +echo "2.5. Line names can be configured" +create_live_chip chip test-label 16 '"foo", "", "bar"' +test "`get_line_name chip 0`" = "foo" || fail "line name is incorrect" +test "`get_line_name chip 2`" = "bar" || fail "line name is incorrect" +remove_live_chip chip + +echo "2.6. Errors in line names are detected" +create_pending_chip chip test-label 8 '"foo", bar' && fail "incorrect line name accepted" +remove_pending_chip chip +create_pending_chip chip test-label 8 '"foo" "bar"' && fail "incorrect line name accepted" +remove_pending_chip chip + +echo "2.7. Multiple chips can be created" +create_live_chip chip0 +create_live_chip chip1 +create_live_chip chip2 +remove_live_chip chip0 +remove_live_chip chip1 +remove_live_chip chip2 + +echo "3. Controlling simulated chips" + +echo "3.3. Pull can be set over sysfs" +create_live_chip chip test-label 8 +sysfs_set_pull chip 0 1 +$BASE_DIR/gpio-mockup-cdev /dev/`configfs_chip_name chip` 0 +test "$?" = "1" || fail "pull set incorrectly" +sysfs_set_pull chip 0 0 +$BASE_DIR/gpio-mockup-cdev /dev/`configfs_chip_name chip` 1 +test "$?" = "0" || fail "pull set incorrectly" +remove_live_chip chip + +echo "3.4. Incorrect input in sysfs is rejected" +create_live_chip chip test-label 8 +SYSFS_PATH="/sys/devices/platform/`configfs_dev_name chip`/line-ctrl/gpio0" +echo 2 > $SYSFS_PATH 2> /dev/null && fail "invalid input not detectec" +remove_live_chip chip + +echo "4. Simulated GPIO chips are functional" + +echo "4.1. Values can be read from sysfs" +create_live_chip chip test-label 8 +SYSFS_PATH="/sys/devices/platform/`configfs_dev_name chip`/line-ctrl/gpio0" +test `cat $SYSFS_PATH` = "0" || fail "incorrect value read from sysfs" +$BASE_DIR/gpio-mockup-cdev -s 1 /dev/`configfs_chip_name chip` 0 & +sleep 0.1 # FIXME Any better way? +test `cat $SYSFS_PATH` = "1" || fail "incorrect value read from sysfs" +kill $! +remove_live_chip chip + +echo "4.2. Bias settings work correctly" +create_live_chip chip test-label 8 +$BASE_DIR/gpio-mockup-cdev -b pull-up /dev/`configfs_chip_name chip` 0 +test `cat $SYSFS_PATH` = "1" || fail "bias setting does not work" +remove_live_chip chip + +echo "GPIO $MODULE test PASS"