From patchwork Tue Aug 22 23:02:07 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rob Herring X-Patchwork-Id: 110701 Delivered-To: patch@linaro.org Received: by 10.140.95.78 with SMTP id h72csp3326197qge; Tue, 22 Aug 2017 16:02:22 -0700 (PDT) X-Received: by 10.98.194.11 with SMTP id l11mr732448pfg.248.1503442941942; Tue, 22 Aug 2017 16:02:21 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1503442941; cv=none; d=google.com; s=arc-20160816; b=0b55dcelXSx7rLcfcLITLngB65Z77exP21bpJoDjIdmoLmXNzx97Y+pK/zPr5thiGM NpzXizxEr7me6UiX9mH0AVU2nseb37zhaO/xhzjBsYhHFD9T+tY8jgWwYY5cU79pXt7v Pw+X8LcnPSW/y9cKfHCeb3Q+8DOaJXicAriEJKmj5XFM8N1e6IsQDWlq7XSswMSxVqFi tKRvoC0KqHEAv2ZjsI2HIRWuzXTB937USwMNOPhs5rdHGWEYGgA2oowRJfFvpvIX3dZu ofRQPF/EdLNHPeCMixJM1ctZjmlOo3//ZHjVHSXXWyJ0zS67VmcHvcRP2iMUT4/OjEpt y5ew== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:references:in-reply-to:message-id:date :subject:cc:to:from:arc-authentication-results; bh=N4yZfMvBGAhQoQiEj1PQdxqQHjt424OTQQTg6/EMMpI=; b=AN3L6dyUODYEaNSJBtR3cRQGMPJYITTcF/NWMQILLiMtyYS6fKHYW+x/va7jj9oSEO EZe+Rev8ULoa+t8BIzl/yf9ECud/RnlwdZ5CsY9gYBjXmlMtlUNoLsDpLfnSVdAMLpmd HQVpjA/xyf9i5NEe3mjY/k2oraaJVjDmzFwJLNFSYQtkAFj0IF+jDFKfMxyzMGCpWkbp 6+1LO6Gww5UXEmchREAkG7M/XXYTNW66YpJAYMiccArSFn3q6qSfQWEDO7QxLfZoSzrv T8s6Khthezbb4hIZvTSPTyaVHdpodeBH9E8CmWJYrwiABtNgthgoRKfyzaK/AESkNcHV /jxw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of devicetree-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=devicetree-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id v189si64822pgd.384.2017.08.22.16.02.21; Tue, 22 Aug 2017 16:02:21 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of devicetree-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of devicetree-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=devicetree-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752659AbdHVXCR (ORCPT + 6 others); Tue, 22 Aug 2017 19:02:17 -0400 Received: from mail-oi0-f66.google.com ([209.85.218.66]:38525 "EHLO mail-oi0-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752779AbdHVXCO (ORCPT ); Tue, 22 Aug 2017 19:02:14 -0400 Received: by mail-oi0-f66.google.com with SMTP id j144so126794oib.5; Tue, 22 Aug 2017 16:02:13 -0700 (PDT) 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; bh=oE5V2QktCQ9tb31TzF4s3p2U+X2bxys4/jBe1IRR428=; b=lCcReWsuK6ojvqDtKqcdlMoIBFEgnzbfyBO6M5vQhdosguPYfbTMvrNiopcxKV1en6 Ym/nuF/YcHflyE0ftKyOXHxwV8Plr8xyDjJdeR4UDZDjek8sA9md6FNmct/yHPYn6Dt8 OOXVaW0mmnE67FDFLQFsDfDMNiu//W/iG4hPJZ01VrZUatvztemCwgSjtMG8OSw8AyNl DDthuhzNi2g+GMBYJlrtioHMxTRreNhAWBsmvqjtI3+oGdlbtGj2FB5trXb+zYEGtVXo BoNe9HQrjExVTKSMxIPtvlEz0shTrKNRKHb3K6RmUodcWTXlP7y2Jl1Xl3xSWbI41u5w Tt/g== X-Gm-Message-State: AHYfb5gtBJuqq6vwm1QMRS/7xzj2WHVS7rDX6fLWvPnGcCqXF4T1rbDH +un4ctxVnycfRP0LwVg= X-Received: by 10.202.205.204 with SMTP id d195mr943263oig.229.1503442933434; Tue, 22 Aug 2017 16:02:13 -0700 (PDT) Received: from localhost.localdomain (216-188-254-6.dyn.grandenetworks.net. [216.188.254.6]) by smtp.googlemail.com with ESMTPSA id u196sm108821oia.57.2017.08.22.16.02.12 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 22 Aug 2017 16:02:12 -0700 (PDT) From: Rob Herring To: David Gibson Cc: devicetree-compiler@vger.kernel.org, devicetree@vger.kernel.org Subject: [PATCH v2 2/3] checks: add gpio binding properties check Date: Tue, 22 Aug 2017 18:02:07 -0500 Message-Id: <20170822230208.20987-3-robh@kernel.org> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170822230208.20987-1-robh@kernel.org> References: <20170822230208.20987-1-robh@kernel.org> Sender: devicetree-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org The GPIO binding is different compared to other phandle plus args properties in that the property name has a variable, optional prefix. The format of the property name is [-]gpio{s} where can be any legal property string. Therefore, custom matching of property names is needed, but the common check_property_phandle_args() function can still be used. It's possible that there are property names matching which are not GPIO binding specifiers. There's only been one case found in testing which is "[,]nr-gpio{s}". This property has been blacklisted and the same should be done to any others we find. This check will prevent getting any more of these, too. Signed-off-by: Rob Herring --- v2: - New patch with GPIO checks split to separate patch - Add check for deprecated [-]gpio form - Rework property name matching to include "gpio" and "gpios" - Skip the "gpios" property in gpio hogs binding - Improve the blacklisting comment - Add a test checks.c | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ tests/bad-gpio.dts | 13 ++++++++++ tests/run_tests.sh | 2 ++ 3 files changed, 88 insertions(+) create mode 100644 tests/bad-gpio.dts -- 2.11.0 -- To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Reviewed-by: David Gibson diff --git a/checks.c b/checks.c index 548d7e118c42..3315a4646497 100644 --- a/checks.c +++ b/checks.c @@ -1043,6 +1043,76 @@ WARNING_PROPERTY_PHANDLE_CELLS(resets, "resets", "#reset-cells"); WARNING_PROPERTY_PHANDLE_CELLS(sound_dais, "sound-dais", "#sound-dai-cells"); WARNING_PROPERTY_PHANDLE_CELLS(thermal_sensors, "thermal-sensors", "#thermal-sensor-cells"); +static bool prop_is_gpio(struct property *prop) +{ + char *str; + + /* + * *-gpios and *-gpio can appear in property names, + * so skip over any false matches (only one known ATM) + */ + if (strstr(prop->name, "nr-gpio")) + return false; + + str = strrchr(prop->name, '-'); + if (str) + str++; + else + str = prop->name; + if (!(streq(str, "gpios") || streq(str, "gpio"))) + return false; + + return true; +} + +static void check_gpios_property(struct check *c, + struct dt_info *dti, + struct node *node) +{ + struct property *prop; + + /* Skip GPIO hog nodes which have 'gpios' property */ + if (get_property(node, "gpio-hog")) + return; + + for_each_property(node, prop) { + struct provider provider; + + if (!prop_is_gpio(prop)) + continue; + + provider.prop_name = prop->name; + provider.cell_name = "#gpio-cells"; + provider.optional = false; + check_property_phandle_args(c, dti, node, prop, &provider); + } + +} +WARNING(gpios_property, check_gpios_property, NULL, &phandle_references); + +static void check_deprecated_gpio_property(struct check *c, + struct dt_info *dti, + struct node *node) +{ + struct property *prop; + + for_each_property(node, prop) { + char *str; + + if (!prop_is_gpio(prop)) + continue; + + str = strstr(prop->name, "gpio"); + if (!streq(str, "gpio")) + continue; + + FAIL(c, dti, "'[*-]gpio' is deprecated, use '[*-]gpios' instead for %s:%s", + node->fullpath, prop->name); + } + +} +CHECK(deprecated_gpio_property, check_deprecated_gpio_property, NULL); + static struct check *check_table[] = { &duplicate_node_names, &duplicate_property_names, &node_name_chars, &node_name_format, &property_name_chars, @@ -1091,6 +1161,9 @@ static struct check *check_table[] = { &sound_dais_property, &thermal_sensors_property, + &deprecated_gpio_property, + &gpios_property, + &always_fail, }; diff --git a/tests/bad-gpio.dts b/tests/bad-gpio.dts new file mode 100644 index 000000000000..6b77be447b82 --- /dev/null +++ b/tests/bad-gpio.dts @@ -0,0 +1,13 @@ +/dts-v1/; + +/ { + gpio: gpio-controller { + #gpio-cells = <3>; + }; + + node { + nr-gpios = <1>; + foo-gpios = <&gpio>; + bar-gpio = <&gpio 1 2 3>; + }; +}; diff --git a/tests/run_tests.sh b/tests/run_tests.sh index 7cbc6971130a..2a29fa4ee451 100755 --- a/tests/run_tests.sh +++ b/tests/run_tests.sh @@ -551,6 +551,8 @@ dtc_tests () { check_tests unit-addr-leading-0x.dts unit_address_format check_tests unit-addr-leading-0s.dts unit_address_format check_tests bad-phandle-cells.dts interrupts_extended_property + check_tests bad-gpio.dts gpios_property + run_sh_test dtc-checkfails.sh deprecated_gpio_property -- -Wdeprecated_gpio_property -I dts -O dtb bad-gpio.dts run_sh_test dtc-checkfails.sh node_name_chars -- -I dtb -O dtb bad_node_char.dtb run_sh_test dtc-checkfails.sh node_name_format -- -I dtb -O dtb bad_node_format.dtb run_sh_test dtc-checkfails.sh prop_name_chars -- -I dtb -O dtb bad_prop_char.dtb