From patchwork Mon Feb 8 17:04:04 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Rob Herring \(Arm\)" X-Patchwork-Id: 61417 Delivered-To: patch@linaro.org Received: by 10.112.43.199 with SMTP id y7csp1554055lbl; Mon, 8 Feb 2016 09:04:27 -0800 (PST) X-Received: by 10.67.7.42 with SMTP id cz10mr28943423pad.158.1454951067424; Mon, 08 Feb 2016 09:04:27 -0800 (PST) Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id h8si47625284pat.105.2016.02.08.09.04.27; Mon, 08 Feb 2016 09:04:27 -0800 (PST) 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 S1754560AbcBHRE0 (ORCPT + 6 others); Mon, 8 Feb 2016 12:04:26 -0500 Received: from mail-ob0-f176.google.com ([209.85.214.176]:35829 "EHLO mail-ob0-f176.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753431AbcBHREZ (ORCPT ); Mon, 8 Feb 2016 12:04:25 -0500 Received: by mail-ob0-f176.google.com with SMTP id xk3so161127925obc.2; Mon, 08 Feb 2016 09:04:25 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=5eAjtmkGvggHJfLrrK/f9UbOJtLd+D526sv9vVKnhMY=; b=lZK9vjvQQvQX60o5eArNx4NV+4u5X/1r0W3d9fTUmMFxt7fnqqAHSaOXoKoPN8citL J9OQe8tlPa6K5pA+F8SRYx1M1tAOZb8UiebRjiXKCQrUIEwfkl5XzygQqBKjeEplCP/x mz5l2XFAqgKwfagGajHbVbyf7AduvIVouxaiZINBdfF1rIIDk2wlDxF6P7knS/gqhLDx 2YIVSmxYA74uSYvvy5fcrA47aY3B4Tth5tjcNZvp/fvTP+4VwotskSKdwCGXVARpi4lW gB6fZToyF06/2hpMja3uhoyUYh73e0WDDs/ghHQ1s9nq7Q+Cdig38hgTb2u6LZx824V+ Kjkg== X-Gm-Message-State: AG10YOQUa/fAjh/qFGicArd3jnNhBtkw/p79+qJSUbDaqYODdZCK8bGirmCifPvywJgT2A== X-Received: by 10.182.60.170 with SMTP id i10mr25835476obr.62.1454951050431; Mon, 08 Feb 2016 09:04:10 -0800 (PST) Received: from rob-hp-laptop.herring.priv (72-48-98-129.dyn.grandenetworks.net. [72.48.98.129]) by smtp.googlemail.com with ESMTPSA id fg8sm14746406oeb.16.2016.02.08.09.04.09 (version=TLSv1/SSLv3 cipher=OTHER); Mon, 08 Feb 2016 09:04:09 -0800 (PST) From: Rob Herring To: devicetree@vger.kernel.org, devicetree-spec@vger.kernel.org Cc: Pawel Moll , Mark Rutland , Ian Campbell , Kumar Gala Subject: [PATCH] dt/bindings: add documentation on standard property unit suffixes Date: Mon, 8 Feb 2016 11:04:04 -0600 Message-Id: <1454951044-18223-1-git-send-email-robh@kernel.org> X-Mailer: git-send-email 2.5.0 Sender: devicetree-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org A common review comment is to add units to DT property names. The naming convention is inconsistent unfortunately although there are clear majorities in use already. This makes it hard to remember the exact name preferred, so I'm documenting this to provide an easy point of reference. Signed-off-by: Rob Herring Cc: Pawel Moll Cc: Mark Rutland Cc: Ian Campbell Cc: Kumar Gala --- .../devicetree/bindings/property-units.txt | 35 ++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 Documentation/devicetree/bindings/property-units.txt -- 2.5.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 Acked-by: Mark Rutland diff --git a/Documentation/devicetree/bindings/property-units.txt b/Documentation/devicetree/bindings/property-units.txt new file mode 100644 index 0000000..f8231ed --- /dev/null +++ b/Documentation/devicetree/bindings/property-units.txt @@ -0,0 +1,35 @@ +Standard Unit Suffixes for Property names + +Properties which have a unit of measure are recommended to have a unit +suffix appended to the property name. The list below contains the +recommended suffixes. Other variations exist in bindings, but should not +be used in new bindings or added here. The inconsistency in the unit +prefixes is due to selecting the most commonly used variants. + +It is also recommended to use the units listed here and not add additional +unit prefixes. + +Time/Frequency +---------------------------------------- +-mhz : megahertz +-hz : Hertz (preferred) +-sec : seconds +-ms : milliseconds +-us : microseconds +-ns : nanoseconds + +Electricity +---------------------------------------- +-microamp : micro amps +-ohms : Ohms +-micro-ohms : micro Ohms +-microvolt : micro volts + +Temperature +---------------------------------------- +-celsius : Degrees Celsius +-millicelsius : Degreee milli-Celsius + +Pressure +---------------------------------------- +-kpascal : kiloPascal