Message ID | 20221122161437.18937-1-edmund.berenson@emlix.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp2307368wrr; Tue, 22 Nov 2022 08:23:16 -0800 (PST) X-Google-Smtp-Source: AA0mqf5E1Yntv24GeYL1HK0+KxPHn8HP7Vj3ewOFpsmSKHp/Zm4QmnPfLPLXdRGJ8mW59VuQL3zq X-Received: by 2002:a17:90b:354e:b0:212:e307:b59f with SMTP id lt14-20020a17090b354e00b00212e307b59fmr26537269pjb.208.1669134196645; Tue, 22 Nov 2022 08:23:16 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1669134196; cv=none; d=google.com; s=arc-20160816; b=glwujYRC0Szvg+JbBTjKHzTi+ctsGPKY4SmcAgKIREXAx+PSpvVoTZIewVKmOjUKht zcLDxNENB12JU58VdN/z9Odc2gDzIk0iil8EDbH3tc0kJM8DFRUntf9lrQ7cSVeVY2qw NpCGJdSQv+eft1cRcHAXXW0L3M8QSWFs9SZqA9dUya+M2b8v7E8yURb5zYl0XGfJiAMF eYcBKaMm7CAhptTYeWM9ZwaIMFQwCzAgcVwsE4hJv6kQTWJyIjWFB1ADwnJE9gQAG1eM hjH153VefJsGCs0tPemQ0o2FjvuOFT+zYEeoXBCpuWwq86PVtFV9ZqgXxr7foO8XAOIb fI7w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:to:content-transfer-encoding:mime-version :message-id:date:subject:cc:from; bh=7o7f/QI6URHTXgbH1AB8cURmpVXCQe/yiP2FwPcGCK8=; b=W3/ZjmVAW2hafuyib+X9w6v5XKGyk+FZnCtbd1c5xRYrk+L49rI5r+GKC9zQ1wV4Zk 6bC7VXqGyuPPvbeVCXKbeEeqGl08mcDVjYzPMz0rkScIwiVXVdzPCgfN3peww+plW+b7 gGPV+L9p1GYc/aptavafJWqMQSZZCnGDDRg95iynMG6cvRXKUijnG3V0L8SnfSL3ujto MhPqP7ecf+YcARtkldOLjmnwCnRo2VmoAo90qZszirDragPk+tWVLWrfBxfeaQPWiQnn ijHHgGSD8SiFtAY6Ozav0vbllGiqoLMsltiWXbiSWAyUQ1W20yxc09lJVAylk0OqKsov TtcQ== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id il4-20020a17090b164400b00205cc2ec8a6si3835256pjb.136.2022.11.22.08.22.59; Tue, 22 Nov 2022 08:23:16 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233602AbiKVQRW (ORCPT <rfc822;cjcooper78@gmail.com> + 99 others); Tue, 22 Nov 2022 11:17:22 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52270 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234319AbiKVQQk (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Tue, 22 Nov 2022 11:16:40 -0500 Received: from mx1.emlix.com (mx1.emlix.com [136.243.223.33]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5676F532DA; Tue, 22 Nov 2022 08:15:05 -0800 (PST) Received: from mailer.emlix.com (unknown [81.20.119.6]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.emlix.com (Postfix) with ESMTPS id 2655C5F886; Tue, 22 Nov 2022 17:15:04 +0100 (CET) From: Edmund Berenson <edmund.berenson@emlix.com> Cc: Edmund Berenson <edmund.berenson@emlix.com>, Lukasz Zemla <Lukasz.Zemla@woodward.com>, Lars-Peter Clausen <lars@metafoo.de>, Michael Hennerich <Michael.Hennerich@analog.com>, Jonathan Cameron <jic23@kernel.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, linux-iio@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v5] dt-bindings: iio: adc: ad7923: adjust documentation Date: Tue, 22 Nov 2022 17:14:37 +0100 Message-Id: <20221122161437.18937-1-edmund.berenson@emlix.com> X-Mailer: git-send-email 2.37.4 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,SPF_HELO_NONE, SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net To: unlisted-recipients:; (no To-header on input) Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1750214059265527946?= X-GMAIL-MSGID: =?utf-8?q?1750214059265527946?= |
Series |
[v5] dt-bindings: iio: adc: ad7923: adjust documentation
|
|
Commit Message
Edmund Berenson
Nov. 22, 2022, 4:14 p.m. UTC
- The ad7927 is fully compatible with ad7928 driver, add
documentation for device.
- ad7923 and ad7924 are treated the same in the driver, show
the relationship in the documentation.
Suggested-by: Lukasz Zemla <Lukasz.Zemla@woodward.com>
Signed-off-by: Edmund Berenson <edmund.berenson@emlix.com>
---
.../bindings/iio/adc/adi,ad7923.yaml | 26 ++++++++++++-------
1 file changed, 17 insertions(+), 9 deletions(-)
Comments
On 22/11/2022 17:14, Edmund Berenson wrote: > - The ad7927 is fully compatible with ad7928 driver, add > documentation for device. > - ad7923 and ad7924 are treated the same in the driver, show > the relationship in the documentation. > > Suggested-by: Lukasz Zemla <Lukasz.Zemla@woodward.com> > Signed-off-by: Edmund Berenson <edmund.berenson@emlix.com> > --- > .../bindings/iio/adc/adi,ad7923.yaml | 26 ++++++++++++------- > 1 file changed, 17 insertions(+), 9 deletions(-) > 1. This is a v5, what are the changes? 2. This is a friendly reminder during the review process. It looks like you received a tag and forgot to add it. If you do not know the process, here is a short explanation: Please add Acked-by/Reviewed-by/Tested-by tags when posting new versions. However, there's no need to repost patches *only* to add the tags. The upstream maintainer will do that for acks received on the version they apply. https://elixir.bootlin.com/linux/v5.17/source/Documentation/process/submitting-patches.rst#L540 If a tag was not added on purpose, please state why and what changed. > --- > .../bindings/iio/adc/adi,ad7923.yaml | 26 ++++++++++++------- > 1 file changed, 17 insertions(+), 9 deletions(-) > Best regards, Krzysztof
On Wed, Nov 23, 2022 at 11:42:40AM +0100, Krzysztof Kozlowski wrote: > On 22/11/2022 17:14, Edmund Berenson wrote: > > - The ad7927 is fully compatible with ad7928 driver, add > > documentation for device. > > - ad7923 and ad7924 are treated the same in the driver, show > > the relationship in the documentation. > > > > Suggested-by: Lukasz Zemla <Lukasz.Zemla@woodward.com> > > Signed-off-by: Edmund Berenson <edmund.berenson@emlix.com> > > --- > > .../bindings/iio/adc/adi,ad7923.yaml | 26 ++++++++++++------- > > 1 file changed, 17 insertions(+), 9 deletions(-) > > > > 1. This is a v5, what are the changes? > The original idea was adding the compatible string into driver itself, then it was suggested that I have a fallback compatible to 7928 as the hardware versions are treated the same in the driver. After that it was suggested to add deprecated flag to standalone compatibility, but doing so I didn't want to add compatibility on driver side just to mark it deprecated in the documentation, so I dropped driver side changes. Finally I had some issues getting the documentation syntax into an acceptable form, mainly const vs enum listing of compatibility stings. > 2. > This is a friendly reminder during the review process. > > It looks like you received a tag and forgot to add it. > > If you do not know the process, here is a short explanation: > Please add Acked-by/Reviewed-by/Tested-by tags when posting new > versions. However, there's no need to repost patches *only* to add the > tags. The upstream maintainer will do that for acks received on the > version they apply. > > https://elixir.bootlin.com/linux/v5.17/source/Documentation/process/submitting-patches.rst#L540 > > If a tag was not added on purpose, please state why and what changed. I did assume adding the tags was done by maintainer, I didn't knew I was supposed to add it myself when resubmitting the patch. My apologies, I will add the tags if I run in this situation in the future. > > > > > --- > > .../bindings/iio/adc/adi,ad7923.yaml | 26 ++++++++++++------- > > 1 file changed, 17 insertions(+), 9 deletions(-) > > > > > Best regards, > Krzysztof >
On 23/11/2022 12:32, Edmund Berenson wrote: > On Wed, Nov 23, 2022 at 11:42:40AM +0100, Krzysztof Kozlowski wrote: >> On 22/11/2022 17:14, Edmund Berenson wrote: >>> - The ad7927 is fully compatible with ad7928 driver, add >>> documentation for device. >>> - ad7923 and ad7924 are treated the same in the driver, show >>> the relationship in the documentation. >>> >>> Suggested-by: Lukasz Zemla <Lukasz.Zemla@woodward.com> >>> Signed-off-by: Edmund Berenson <edmund.berenson@emlix.com> >>> --- >>> .../bindings/iio/adc/adi,ad7923.yaml | 26 ++++++++++++------- >>> 1 file changed, 17 insertions(+), 9 deletions(-) >>> >> >> 1. This is a v5, what are the changes? >> > The original idea was adding the compatible string into driver itself, > then it was suggested that I have a fallback compatible to 7928 as the > hardware versions are treated the same in the driver. After that it was > suggested to add deprecated flag to standalone compatibility, but doing > so I didn't want to add compatibility on driver side just to mark it > deprecated in the documentation, so I dropped driver side changes. > Finally I had some issues getting the documentation syntax into an > acceptable form, mainly const vs enum listing of compatibility stings. That's a bit too long for a changelog. Keep it short but still descriptive. Anyway - this must be in the changelog place, so after --- Best regards, Krzysztof
On Wed, 23 Nov 2022 14:01:30 +0100 Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote: > On 23/11/2022 12:32, Edmund Berenson wrote: > > On Wed, Nov 23, 2022 at 11:42:40AM +0100, Krzysztof Kozlowski wrote: > >> On 22/11/2022 17:14, Edmund Berenson wrote: > >>> - The ad7927 is fully compatible with ad7928 driver, add > >>> documentation for device. > >>> - ad7923 and ad7924 are treated the same in the driver, show > >>> the relationship in the documentation. > >>> > >>> Suggested-by: Lukasz Zemla <Lukasz.Zemla@woodward.com> > >>> Signed-off-by: Edmund Berenson <edmund.berenson@emlix.com> > >>> --- > >>> .../bindings/iio/adc/adi,ad7923.yaml | 26 ++++++++++++------- > >>> 1 file changed, 17 insertions(+), 9 deletions(-) > >>> > >> > >> 1. This is a v5, what are the changes? > >> > > The original idea was adding the compatible string into driver itself, > > then it was suggested that I have a fallback compatible to 7928 as the > > hardware versions are treated the same in the driver. After that it was > > suggested to add deprecated flag to standalone compatibility, but doing > > so I didn't want to add compatibility on driver side just to mark it > > deprecated in the documentation, so I dropped driver side changes. > > Finally I had some issues getting the documentation syntax into an > > acceptable form, mainly const vs enum listing of compatibility stings. > > That's a bit too long for a changelog. Keep it short but still > descriptive. Anyway - this must be in the changelog place, so after --- > > > Best regards, > Krzysztof > Given it won't get picked up by git anyway and all the info is in this thread (plus we are right at end of the cycle and I want to pick this up). Applied with Krzysztof's tag from v4. Thanks, Jonathan
diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7923.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7923.yaml index 07f9d1c09c7d..85148338c597 100644 --- a/Documentation/devicetree/bindings/iio/adc/adi,ad7923.yaml +++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7923.yaml @@ -11,7 +11,7 @@ maintainers: description: | Analog Devices AD7904, AD7914, AD7923, AD7924 4 Channel ADCs, and AD7908, - AD7918, AD7928 8 Channels ADCs. + AD7918, AD7927, AD7928 8 Channels ADCs. Specifications about the part can be found at: https://www.analog.com/media/en/technical-documentation/data-sheets/AD7923.pdf @@ -20,14 +20,22 @@ description: | properties: compatible: - enum: - - adi,ad7904 - - adi,ad7914 - - adi,ad7923 - - adi,ad7924 - - adi,ad7908 - - adi,ad7918 - - adi,ad7928 + oneOf: + - enum: + - adi,ad7904 + - adi,ad7908 + - adi,ad7914 + - adi,ad7918 + - adi,ad7923 + - adi,ad7928 + - const: adi,ad7924 + deprecated: true + - items: + - const: adi,ad7924 + - const: adi,ad7923 + - items: + - const: adi,ad7927 + - const: adi,ad7928 reg: maxItems: 1