LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Rob Herring <robh@kernel.org>
To: Billy Tsai <billy_tsai@aspeedtech.com>
Cc: jic23@kernel.org, lars@metafoo.de, pmeerw@pmeerw.net,
	joel@jms.id.au, andrew@aj.id.au, p.zabel@pengutronix.de,
	lgirdwood@gmail.com, broonie@kernel.org,
	linux-iio@vger.kernel.org, devicetree@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	linux-aspeed@lists.ozlabs.org, linux-kernel@vger.kernel.org,
	BMC-SW@aspeedtech.com
Subject: Re: [v4 01/15] dt-bindings: iio: adc: Add ast2600-adc bindings
Date: Tue, 24 Aug 2021 07:13:04 -0500	[thread overview]
Message-ID: <YSTiUPQa+HYSA63t@robh.at.kernel.org> (raw)
In-Reply-To: <20210823070240.12600-2-billy_tsai@aspeedtech.com>

On Mon, Aug 23, 2021 at 03:02:26PM +0800, Billy Tsai wrote:
> Add device tree bindings document for the aspeed ast2600 adc device
> driver.
> 
> Signed-off-by: Billy Tsai <billy_tsai@aspeedtech.com>
> ---
>  .../bindings/iio/adc/aspeed,ast2600-adc.yaml  | 97 +++++++++++++++++++
>  1 file changed, 97 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/adc/aspeed,ast2600-adc.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/aspeed,ast2600-adc.yaml b/Documentation/devicetree/bindings/iio/adc/aspeed,ast2600-adc.yaml
> new file mode 100644
> index 000000000000..248cda7d91e9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/aspeed,ast2600-adc.yaml
> @@ -0,0 +1,97 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/aspeed,ast2600-adc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ADC that forms part of an ASPEED server management processor.
> +
> +maintainers:
> +  - Billy Tsai <billy_tsai@aspeedtech.com>
> +
> +description: |
> +  • 10-bits resolution for 16 voltage channels.
> +  • The device split into two individual engine and each contains 8 voltage
> +  channels.
> +  • Channel scanning can be non-continuous.
> +  • Programmable ADC clock frequency.
> +  • Programmable upper and lower threshold for each channels.
> +  • Interrupt when larger or less than threshold for each channels.
> +  • Support hysteresis for each channels.
> +  • Built-in a compensating method.
> +  • Built-in a register to trim internal reference voltage.
> +  • Internal or External reference voltage.
> +  • Support 2 Internal reference voltage 1.2v or 2.5v.
> +  • Integrate dividing circuit for battery sensing.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - aspeed,ast2600-adc0
> +      - aspeed,ast2600-adc1

What's the difference between 0 and 1?

> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    description:
> +      Input clock used to derive the sample clock. Expected to be the
> +      SoC's APB clock.

How many clocks?

> +
> +  resets:
> +    maxItems: 1
> +
> +  "#io-channel-cells":
> +    const: 1
> +
> +  vref-supply:
> +    description:
> +      The external regulator supply ADC reference voltage.
> +
> +  aspeed,int_vref_mv:

Don't use '_' in property names.

Use standard unit suffixes as defined in property-units.yaml.

> +    $ref: /schemas/types.yaml#/definitions/uint32

And then you can drop this.

> +    enum: [1200, 2500]
> +    description:
> +      ADC internal reference voltage in millivolts.
> +
> +  aspeed,battery-sensing:
> +    type: boolean
> +    description:
> +      Inform the driver that last channel will be used to sensor battery.
> +
> +  aspeed,trim-data-valid:
> +    type: boolean
> +    description: |
> +      The ADC reference voltage can be calibrated to obtain the trimming
> +      data which will be stored in otp. This property informs the driver that
> +      the data store in the otp is valid.
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - resets
> +  - "#io-channel-cells"
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/ast2600-clock.h>
> +    adc0: adc@1e6e9000 {
> +        compatible = "aspeed,ast2600-adc0";
> +        reg = <0x1e6e9000 0x100>;
> +        clocks = <&syscon ASPEED_CLK_APB2>;
> +        resets = <&syscon ASPEED_RESET_ADC>;
> +        #io-channel-cells = <1>;
> +        aspeed,int_vref_mv = <2500>;
> +    };
> +    adc1: adc@1e6e9100 {
> +        compatible = "aspeed,ast2600-adc1";
> +        reg = <0x1e6e9100 0x100>;
> +        clocks = <&syscon ASPEED_CLK_APB2>;
> +        resets = <&syscon ASPEED_RESET_ADC>;
> +        #io-channel-cells = <1>;
> +        aspeed,int_vref_mv = <2500>;
> +    };
> +...
> -- 
> 2.25.1
> 
> 

  reply	other threads:[~2021-08-24 12:13 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-23  7:02 [v4 00/15] Add support for ast2600 ADC Billy Tsai
2021-08-23  7:02 ` [v4 01/15] dt-bindings: iio: adc: Add ast2600-adc bindings Billy Tsai
2021-08-24 12:13   ` Rob Herring [this message]
2021-08-25  0:06     ` Billy Tsai
2021-08-29 14:53       ` Jonathan Cameron
2021-08-23  7:02 ` [v4 02/15] iio: adc: aspeed: completes the bitfield declare Billy Tsai
2021-08-23  7:02 ` [v4 03/15] iio: adc: aspeed: set driver data when adc probe Billy Tsai
2021-08-23  7:02 ` [v4 04/15] iio: adc: aspeed: Keep model data to driver data Billy Tsai
2021-08-23  7:02 ` [v4 05/15] iio: adc: aspeed: Refactory model data structure Billy Tsai
2021-08-23  7:02 ` [v4 06/15] iio: adc: aspeed: Add vref config function Billy Tsai
2021-08-23  7:02 ` [v4 07/15] iio: adc: aspeed: Set num_channels with model data Billy Tsai
2021-08-23  7:02 ` [v4 08/15] iio: adc: aspeed: Use model_data to set clk scaler Billy Tsai
2021-08-23  7:02 ` [v4 09/15] iio: adc: aspeed: Use devm_add_action_or_reset Billy Tsai

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=YSTiUPQa+HYSA63t@robh.at.kernel.org \
    --to=robh@kernel.org \
    --cc=BMC-SW@aspeedtech.com \
    --cc=andrew@aj.id.au \
    --cc=billy_tsai@aspeedtech.com \
    --cc=broonie@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=jic23@kernel.org \
    --cc=joel@jms.id.au \
    --cc=lars@metafoo.de \
    --cc=lgirdwood@gmail.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-aspeed@lists.ozlabs.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=p.zabel@pengutronix.de \
    --cc=pmeerw@pmeerw.net \
    --subject='Re: [v4 01/15] dt-bindings: iio: adc: Add ast2600-adc bindings' \
    /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

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).