From: Amit Kucheria <amit.kucheria@linaro.org>
To: Doug Anderson <dianders@chromium.org>
Cc: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Rajendra Nayak <rnayak@codeaurora.org>,
linux-arm-msm <linux-arm-msm@vger.kernel.org>,
Bjorn Andersson <bjorn.andersson@linaro.org>,
Eduardo Valentin <edubezval@gmail.com>,
smohanad@codeaurora.org,
Vivek Gautam <vivek.gautam@codeaurora.org>,
Andy Gross <andy.gross@linaro.org>,
Zhang Rui <rui.zhang@intel.com>, Rob Herring <robh+dt@kernel.org>,
Mark Rutland <mark.rutland@arm.com>,
Linux PM list <linux-pm@vger.kernel.org>,
DTML <devicetree@vger.kernel.org>
Subject: Re: [PATCH v6 6/7] dt: thermal: tsens: Document the fallback DT property for v2 of TSENS IP
Date: Thu, 12 Jul 2018 11:26:25 +0530 [thread overview]
Message-ID: <CAP245DVpOPhuCZ4OJ0t=izquND2mUrQ8ekkU8M+sMeyUJ_fjYw@mail.gmail.com> (raw)
In-Reply-To: <CAD=FV=W-snhM9L9Ez-ypAJwn2NhNJ1X=s5wDvu-gbQvmLZY9Qg@mail.gmail.com>
On Thu, Jul 12, 2018 at 12:12 AM Doug Anderson <dianders@chromium.org> wrote:
>
> Hi,
>
> On Mon, Jul 9, 2018 at 4:43 AM, Amit Kucheria <amit.kucheria@linaro.org> wrote:
> > We want to create common code for v2 of the TSENS IP block that is used in
> > a large number of Qualcomm SoCs. "qcom,tsens-v2" should be able to handle
> > most of the common functionality start with a common get_temp() function.
> >
> > It is also necessary to split out the memory regions for the TM and SROT
> > register banks because their offsets are not constant across SoC families.
>
> nit that bindings should be earlier in the patch series than the code
> implementing the bindings.
Will reorder.
>
> > Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>
> > ---
> > .../devicetree/bindings/thermal/qcom-tsens.txt | 25 +++++++++++++++++-----
> > 1 file changed, 20 insertions(+), 5 deletions(-)
> >
> > diff --git a/Documentation/devicetree/bindings/thermal/qcom-tsens.txt b/Documentation/devicetree/bindings/thermal/qcom-tsens.txt
> > index 06195e8..8f963b1 100644
> > --- a/Documentation/devicetree/bindings/thermal/qcom-tsens.txt
> > +++ b/Documentation/devicetree/bindings/thermal/qcom-tsens.txt
> > @@ -1,10 +1,16 @@
> > * QCOM SoC Temperature Sensor (TSENS)
> >
> > Required properties:
> > -- compatible :
> > - - "qcom,msm8916-tsens" : For 8916 Family of SoCs
> > - - "qcom,msm8974-tsens" : For 8974 Family of SoCs
> > - - "qcom,msm8996-tsens" : For 8996 Family of SoCs
> > +- compatible:
> > + Must be one of the following:
> > + - "qcom,msm8916-tsens" (MSM8916)
> > + - "qcom,msm8974-tsens" (MSM8974)
> > + - "qcom,msm8996-tsens" (MSM8996)
> > + - "qcom,msm8998-tsens", "qcom,tsens-v2" (MSM8998)
> > + - "qcom,sdm845-tsens", "qcom,tsens-v2" (SDM845)
> > + The generic "qcom,tsens-v2" property must be used as a fallback for any SoC with
> > + version 2 of the TSENS IP. MSM8996 is the only exception beacause the generic
> > + property did not exist when support was added.
> >
> > - reg: Address range of the thermal registers
>
> You need to document that for old SoCs where TM / SROT were 0x1000
> apart (SROT first) that one "reg" field was OK. ...and that for new
> SoCs you specify two reg ranges: the first for TM and the second for
> SROT.
OK.
> > - #thermal-sensor-cells : Should be 1. See ./thermal.txt for a description.
> > @@ -12,7 +18,7 @@ Required properties:
> > - Refer to Documentation/devicetree/bindings/nvmem/nvmem.txt to know how to specify
> > nvmem cells
> >
> > -Example:
> > +Example 1 (legacy support before a fallback tsens-v2 propoerty was introduced):
> > tsens: thermal-sensor@900000 {
> > compatible = "qcom,msm8916-tsens";
> > reg = <0x4a8000 0x2000>;
> > @@ -20,3 +26,12 @@ tsens: thermal-sensor@900000 {
> > nvmem-cell-names = "caldata", "calsel";
> > #thermal-sensor-cells = <1>;
> > };
> > +
> > +Example 2 (for any platform containing v2 of the TSENS IP):
> > +tsens0: tsens@c222000 {
>
> A) Use a generic name for the node, not a specific one. Thus the node
> should be "thermal-sensor", not "tsens".
>
> B) This unit address needs to match the _first_ reg address listed.
> Give your reg below, this should be @c263000
>
> Thus your node name should be:
>
> tsens0: thermal-sensor@c263000 {
Fixed
> > + compatible = "qcom,sdm845-tsens", "qcom,tsens-v2";
> > + reg = <0xc263000 0x1ff>, /* TM */
> > + <0xc222000 0x1ff>; /* SROT */
> > + #qcom,sensors = <13>;
>
> The "#qcom,sensors" property seems wrong in a few ways:
>
> A) I wouldn't have expected it to start with a "#". I only expect to
> see that on things specifying sizes / lengths. Rob can feel free to
> override me, though.
>
> B) It's not documented above. Just putting something in an example
> doesn't document it--it needs to be listed in the "Optional
> properties".
next prev parent reply other threads:[~2018-07-12 5:56 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-09 11:43 [PATCH v6 0/7] thermal: tsens: Refactoring for TSENSv2 IP Amit Kucheria
2018-07-09 11:43 ` [PATCH v6 1/7] thermal: tsens: Get rid of unused fields in structure Amit Kucheria
2018-07-09 11:43 ` [PATCH v6 2/7] thermal: tsens: Add support to split up register address space into two Amit Kucheria
2018-07-11 16:34 ` Bjorn Andersson
2018-07-11 18:37 ` Doug Anderson
2018-07-12 4:40 ` Amit Kucheria
2018-07-09 11:43 ` [PATCH v6 3/7] dt: qcom: 8996: thermal: Move to DT initialisation Amit Kucheria
2018-07-11 16:37 ` Bjorn Andersson
2018-07-11 18:39 ` Doug Anderson
2018-07-12 5:03 ` Amit Kucheria
2018-07-09 11:43 ` [PATCH v6 4/7] thermal: tsens: Rename tsens-8996 to tsens-v2 for reuse Amit Kucheria
2018-07-11 16:39 ` Bjorn Andersson
2018-07-09 11:43 ` [PATCH v6 5/7] thermal: tsens: Add generic support for TSENS v2 IP Amit Kucheria
2018-07-11 16:40 ` Bjorn Andersson
2018-07-11 18:40 ` Doug Anderson
2018-07-12 5:12 ` Amit Kucheria
2018-07-09 11:43 ` [PATCH v6 6/7] dt: thermal: tsens: Document the fallback DT property for v2 of TSENS IP Amit Kucheria
2018-07-11 13:49 ` Rob Herring
2018-07-11 16:42 ` Bjorn Andersson
2018-07-11 18:42 ` Doug Anderson
2018-07-12 5:56 ` Amit Kucheria [this message]
2018-07-09 11:43 ` [PATCH v6 7/7] arm64: dts: sdm845: Add tsens nodes Amit Kucheria
2018-07-11 16:41 ` Bjorn Andersson
2018-07-11 18:44 ` Doug Anderson
2018-07-11 21:51 ` Matthias Kaehlcke
2018-07-11 22:00 ` Doug Anderson
2018-07-12 5:36 ` Amit Kucheria
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAP245DVpOPhuCZ4OJ0t=izquND2mUrQ8ekkU8M+sMeyUJ_fjYw@mail.gmail.com' \
--to=amit.kucheria@linaro.org \
--cc=andy.gross@linaro.org \
--cc=bjorn.andersson@linaro.org \
--cc=devicetree@vger.kernel.org \
--cc=dianders@chromium.org \
--cc=edubezval@gmail.com \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=rnayak@codeaurora.org \
--cc=robh+dt@kernel.org \
--cc=rui.zhang@intel.com \
--cc=smohanad@codeaurora.org \
--cc=vivek.gautam@codeaurora.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).