From: Marius Cristea <marius.cristea@microchip.com>
This is the device tree schema for iio driver for
Microchip PAC193X series of Power Monitors with Accumulator.
Signed-off-by: Marius Cristea <marius.cristea@microchip.com>
---
.../bindings/iio/adc/microchip,pac1934.yaml | 146 ++++++++++++++++++
1 file changed, 146 insertions(+)
create mode 100644 Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
diff --git a/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml b/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
new file mode 100644
index 000000000000..837053ed8a71
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
@@ -0,0 +1,146 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/microchip,pac1934.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Microchip PAC1934 Power Monitors with Accumulator
+
+maintainers:
+ - Marius Cristea <marius.cristea@microchip.com>
+
+description: |
+ Bindings for the Microchip family of Power Monitors with Accumulator.
+ The datasheet for PAC1931, PAC1932, PAC1933 and PAC1934 can be found here:
+ https://ww1.microchip.com/downloads/aemDocuments/documents/OTH/ProductDocuments/DataSheets/PAC1931-Family-Data-Sheet-DS20005850E.pdf
+
+properties:
+ compatible:
+ enum:
+ - microchip,pac1931
+ - microchip,pac1932
+ - microchip,pac1933
+ - microchip,pac1934
+
+ reg:
+ maxItems: 1
+
+ "#address-cells":
+ const: 1
+
+ "#size-cells":
+ const: 0
+
+ interrupts:
+ description: IRQ line of the ADC
+ maxItems: 1
+
+ drive-open-drain:
+ description: The IRQ signal is configured as open-drain.
+ type: boolean
+ maxItems: 1
+
+ microchip,slow-io:
+ type: boolean
+ description: |
+ A GPIO used to trigger a change is sampling rate (lowering the chip power consumption).
+ In default mode, if this pin is forced high, sampling rate is forced to eight
+ samples/second. When it is forced low, the sampling rate is 1024 samples/second unless
+ a different sample rate has been programmed.
+
+required:
+ - compatible
+ - reg
+ - "#address-cells"
+ - "#size-cells"
+
+patternProperties:
+ "^channel@[1-4]+$":
+ type: object
+ $ref: adc.yaml
+ description: Represents the external channels which are connected to the ADC.
+
+ properties:
+ reg:
+ description: |
+ The channel number.
+ It can have up to 4 channels, numbered from 1 to 4.
+ items:
+ - minimum: 1
+ maximum: 4
+
+ shunt-resistor-micro-ohms:
+ description: |
+ Value in micro Ohms of the shunt resistor connected between
+ the SENSE+ and SENSE- inputs, across which the current is measured. Value
+ is needed to compute the scaling of the measured current.
+
+ label:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: Name of the monitored power rail.
+
+ bipolar:
+ description: Whether the channel is bi-directional.
+ type: boolean
+
+ required:
+ - reg
+ - shunt-resistor-micro-ohms
+
+ additionalProperties: false
+
+allOf:
+ - if:
+ required:
+ - interrupts
+ then:
+ required:
+ - drive-open-drain
+ else:
+ properties:
+ drive-open-drain: false
+
+additionalProperties: false
+
+examples:
+ - |
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ pac193x: pac193x@10 {
+ compatible = "microchip,pac1934";
+ reg = <0x10>;
+
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ channel@1 {
+ reg = <0x1>;
+ shunt-resistor-micro-ohms = <24900000>;
+ label = "CPU";
+ };
+
+ channel@2 {
+ reg = <0x2>;
+ shunt-resistor-micro-ohms = <49900000>;
+ label = "GPU";
+ };
+
+ channel@3 {
+ reg = <0x3>;
+ shunt-resistor-micro-ohms = <75000000>;
+ label = "MEM";
+ bipolar;
+ };
+
+ channel@4 {
+ reg = <0x4>;
+ shunt-resistor-micro-ohms = <100000000>;
+ label = "NET";
+ bipolar;
+ };
+ };
+ };
+
+...
--
2.34.1A nit, subject: drop second/last, redundant "bindings". The
"dt-bindings" prefix is already stating that these are bindings.
On 25/10/2023 15:44, marius.cristea@microchip.com wrote:
> From: Marius Cristea <marius.cristea@microchip.com>
>
> This is the device tree schema for iio driver for
> Microchip PAC193X series of Power Monitors with Accumulator.
>
> Signed-off-by: Marius Cristea <marius.cristea@microchip.com>
> ---
> .../bindings/iio/adc/microchip,pac1934.yaml | 146 ++++++++++++++++++
> 1 file changed, 146 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml b/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
> new file mode 100644
> index 000000000000..837053ed8a71
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
> @@ -0,0 +1,146 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/microchip,pac1934.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Microchip PAC1934 Power Monitors with Accumulator
> +
> +maintainers:
> + - Marius Cristea <marius.cristea@microchip.com>
> +
> +description: |
> + Bindings for the Microchip family of Power Monitors with Accumulator.
Drop "Bindings for" and describe instead the hardware.
> + The datasheet for PAC1931, PAC1932, PAC1933 and PAC1934 can be found here:
> + https://ww1.microchip.com/downloads/aemDocuments/documents/OTH/ProductDocuments/DataSheets/PAC1931-Family-Data-Sheet-DS20005850E.pdf
> +
> +properties:
> + compatible:
> + enum:
> + - microchip,pac1931
> + - microchip,pac1932
> + - microchip,pac1933
> + - microchip,pac1934
> +
> + reg:
> + maxItems: 1
> +
> + "#address-cells":
> + const: 1
> +
> + "#size-cells":
> + const: 0
> +
> + interrupts:
> + description: IRQ line of the ADC
Drop, useless.
> + maxItems: 1
> +
> + drive-open-drain:
> + description: The IRQ signal is configured as open-drain.
> + type: boolean
> + maxItems: 1
> +
> + microchip,slow-io:
> + type: boolean
> + description: |
> + A GPIO used to trigger a change is sampling rate (lowering the chip power consumption).
> + In default mode, if this pin is forced high, sampling rate is forced to eight
> + samples/second. When it is forced low, the sampling rate is 1024 samples/second unless
> + a different sample rate has been programmed.
> +
> +required:
> + - compatible
> + - reg
> + - "#address-cells"
> + - "#size-cells"
> +
> +patternProperties:
patternProperties: follow properties:, not required: block. Reorder.
> + "^channel@[1-4]+$":
> + type: object
> + $ref: adc.yaml
> + description: Represents the external channels which are connected to the ADC.
> +
> + properties:
> + reg:
> + description: |
> + The channel number.
> + It can have up to 4 channels, numbered from 1 to 4.
Drop, redundant, comes with adc.yaml.
> + items:
> + - minimum: 1
> + maximum: 4
> +
> + shunt-resistor-micro-ohms:
> + description: |
> + Value in micro Ohms of the shunt resistor connected between
> + the SENSE+ and SENSE- inputs, across which the current is measured. Value
> + is needed to compute the scaling of the measured current.
> +
> + label:
> + $ref: /schemas/types.yaml#/definitions/string
> + description: Name of the monitored power rail.
Drop property, comes with adc.yaml.
> +
> + bipolar:
> + description: Whether the channel is bi-directional.
> + type: boolean
Drop property, comes with adc.yaml.
> +
> + required:
> + - reg
> + - shunt-resistor-micro-ohms
> +
> + additionalProperties: false
unevaluatedProperties: false
> +
> +allOf:
> + - if:
> + required:
> + - interrupts
> + then:
> + required:
> + - drive-open-drain
> + else:
> + properties:
> + drive-open-drain: false
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + pac193x: pac193x@10 {
Node names should be generic. See also an explanation and list of
examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
> + compatible = "microchip,pac1934";
> + reg = <0x10>;
> +
Best regards,
Krzysztof
Hey Marius, On Wed, Oct 25, 2023 at 04:44:03PM +0300, marius.cristea@microchip.com wrote: > From: Marius Cristea <marius.cristea@microchip.com> > > This is the device tree schema for iio driver for > Microchip PAC193X series of Power Monitors with Accumulator. > > Signed-off-by: Marius Cristea <marius.cristea@microchip.com> > --- > .../bindings/iio/adc/microchip,pac1934.yaml | 146 ++++++++++++++++++ > 1 file changed, 146 insertions(+) > create mode 100644 Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml > > diff --git a/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml b/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml > new file mode 100644 > index 000000000000..837053ed8a71 > --- /dev/null > +++ b/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml > @@ -0,0 +1,146 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/iio/adc/microchip,pac1934.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Microchip PAC1934 Power Monitors with Accumulator > + > +maintainers: > + - Marius Cristea <marius.cristea@microchip.com> > + > +description: | > + Bindings for the Microchip family of Power Monitors with Accumulator. > + The datasheet for PAC1931, PAC1932, PAC1933 and PAC1934 can be found here: > + https://ww1.microchip.com/downloads/aemDocuments/documents/OTH/ProductDocuments/DataSheets/PAC1931-Family-Data-Sheet-DS20005850E.pdf > + > +properties: > + compatible: > + enum: > + - microchip,pac1931 > + - microchip,pac1932 > + - microchip,pac1933 > + - microchip,pac1934 > + > + reg: > + maxItems: 1 > + > + "#address-cells": > + const: 1 > + > + "#size-cells": > + const: 0 > + > + interrupts: > + description: IRQ line of the ADC > + maxItems: 1 > + > + drive-open-drain: > + description: The IRQ signal is configured as open-drain. > + type: boolean > + maxItems: 1 > + > + microchip,slow-io: > + type: boolean > + description: | > + A GPIO used to trigger a change is sampling rate (lowering the chip power consumption). > + In default mode, if this pin is forced high, sampling rate is forced to eight > + samples/second. When it is forced low, the sampling rate is 1024 samples/second unless > + a different sample rate has been programmed. This description doesn't really make sense to me - if a GPIO is used to drive the pin low or high, why do we need a property? A DT property implies that this is a static configuration depending on the board, but reading the description this seems to be something that can be toggled at runtime. I do note though, that this GPIO is not documented in the binding, so I suppose what really needs to happen here is document the gpio so that the driver can determine at runtime what state this pin is in? Also, you say "In default mode", but don't mention what the non-default mode is. What happens in the other mode? Cheers, Conor.
Hi Conor, On Wed, 2023-10-25 at 16:08 +0100, Conor Dooley wrote: > Hey Marius, > > On Wed, Oct 25, 2023 at 04:44:03PM +0300, > marius.cristea@microchip.com wrote: > > From: Marius Cristea <marius.cristea@microchip.com> > > > > This is the device tree schema for iio driver for > > Microchip PAC193X series of Power Monitors with Accumulator. > > > > Signed-off-by: Marius Cristea <marius.cristea@microchip.com> > > --- > > .../bindings/iio/adc/microchip,pac1934.yaml | 146 > > ++++++++++++++++++ > > 1 file changed, 146 insertions(+) > > create mode 100644 > > Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml > > > > diff --git > > a/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml > > b/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml > > new file mode 100644 > > index 000000000000..837053ed8a71 > > --- /dev/null > > +++ > > b/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml > > @@ -0,0 +1,146 @@ > > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/iio/adc/microchip,pac1934.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: Microchip PAC1934 Power Monitors with Accumulator > > + > > +maintainers: > > + - Marius Cristea <marius.cristea@microchip.com> > > + > > +description: | > > + Bindings for the Microchip family of Power Monitors with > > Accumulator. > > + The datasheet for PAC1931, PAC1932, PAC1933 and PAC1934 can be > > found here: > > + > > https://ww1.microchip.com/downloads/aemDocuments/documents/OTH/ProductDocuments/DataSheets/PAC1931-Family-Data-Sheet-DS20005850E.pdf > > + > > +properties: > > + compatible: > > + enum: > > + - microchip,pac1931 > > + - microchip,pac1932 > > + - microchip,pac1933 > > + - microchip,pac1934 > > + > > + reg: > > + maxItems: 1 > > + > > + "#address-cells": > > + const: 1 > > + > > + "#size-cells": > > + const: 0 > > + > > + interrupts: > > + description: IRQ line of the ADC > > + maxItems: 1 > > + > > + drive-open-drain: > > + description: The IRQ signal is configured as open-drain. > > + type: boolean > > + maxItems: 1 > > + > > + microchip,slow-io: > > + type: boolean > > + description: | > > + A GPIO used to trigger a change is sampling rate (lowering > > the chip power consumption). > > + In default mode, if this pin is forced high, sampling rate > > is forced to eight > > + samples/second. When it is forced low, the sampling rate is > > 1024 samples/second unless > > + a different sample rate has been programmed. > > This description doesn't really make sense to me - if a GPIO is used > to > drive the pin low or high, why do we need a property? A DT property > implies that this is a static configuration depending on the board, > but > reading the description this seems to be something that can be > toggled > at runtime. > I do note though, that this GPIO is not documented in the binding, so > I > suppose what really needs to happen here is document the gpio so that > the driver can determine at runtime what state this pin is in? > > Also, you say "In default mode", but don't mention what the non- > default > mode is. What happens in the other mode? > > Cheers, > Conor. This is a "double function" pin. On the PAC193x there is the SLOW/ALERT pin. At runtime this pin could be configured as an input to the PAC and the functionality will be "SLOW" that means if it is forced high, the PAC will work in low power mode by changing the sample rate to 8 SPS. If it's forced low the PAC will work at it's full sample rate. "SLOW" is the default function of the pin but it may be programmed to function as ALERT pin (Open Collector when functioning as ALERT, requires pull-up resistor to VDD I/O). This time the pin will be set as output from PAC (ALERT functionality) to trigger an interrupt to the system (this is covered by the interrupts and drive-open-drain). The system could work fine without this pin. The driver doesn't use interrupt at this time, but it could be extended. Thanks, Marius
On Thu, Oct 26, 2023 at 03:23:46PM +0000, Marius.Cristea@microchip.com wrote:
> Hi Conor,
>
> On Wed, 2023-10-25 at 16:08 +0100, Conor Dooley wrote:
> > Hey Marius,
> >
> > On Wed, Oct 25, 2023 at 04:44:03PM +0300,
> > marius.cristea@microchip.com wrote:
> > > From: Marius Cristea <marius.cristea@microchip.com>
> > >
> > > This is the device tree schema for iio driver for
> > > Microchip PAC193X series of Power Monitors with Accumulator.
> > >
> > > Signed-off-by: Marius Cristea <marius.cristea@microchip.com>
> > > ---
> > > .../bindings/iio/adc/microchip,pac1934.yaml | 146
> > > ++++++++++++++++++
> > > 1 file changed, 146 insertions(+)
> > > create mode 100644
> > > Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
> > >
> > > diff --git
> > > a/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
> > > b/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
> > > new file mode 100644
> > > index 000000000000..837053ed8a71
> > > --- /dev/null
> > > +++
> > > b/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
> > > @@ -0,0 +1,146 @@
> > > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/iio/adc/microchip,pac1934.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: Microchip PAC1934 Power Monitors with Accumulator
> > > +
> > > +maintainers:
> > > + - Marius Cristea <marius.cristea@microchip.com>
> > > +
> > > +description: |
> > > + Bindings for the Microchip family of Power Monitors with
> > > Accumulator.
> > > + The datasheet for PAC1931, PAC1932, PAC1933 and PAC1934 can be
> > > found here:
> > > +
> > > https://ww1.microchip.com/downloads/aemDocuments/documents/OTH/ProductDocuments/DataSheets/PAC1931-Family-Data-Sheet-DS20005850E.pdf
> > > +
> > > +properties:
> > > + compatible:
> > > + enum:
> > > + - microchip,pac1931
> > > + - microchip,pac1932
> > > + - microchip,pac1933
> > > + - microchip,pac1934
> > > +
> > > + reg:
> > > + maxItems: 1
> > > +
> > > + "#address-cells":
> > > + const: 1
> > > +
> > > + "#size-cells":
> > > + const: 0
> > > +
> > > + interrupts:
> > > + description: IRQ line of the ADC
> > > + maxItems: 1
> > > +
> > > + drive-open-drain:
> > > + description: The IRQ signal is configured as open-drain.
> > > + type: boolean
> > > + maxItems: 1
> > > +
> > > + microchip,slow-io:
> > > + type: boolean
> > > + description: |
> > > + A GPIO used to trigger a change is sampling rate (lowering
> > > the chip power consumption).
> > > + In default mode, if this pin is forced high, sampling rate
> > > is forced to eight
> > > + samples/second. When it is forced low, the sampling rate is
> > > 1024 samples/second unless
> > > + a different sample rate has been programmed.
> >
> > This description doesn't really make sense to me - if a GPIO is used
> > to
> > drive the pin low or high, why do we need a property? A DT property
> > implies that this is a static configuration depending on the board,
> > but
> > reading the description this seems to be something that can be
> > toggled
> > at runtime.
> > I do note though, that this GPIO is not documented in the binding, so
> > I
> > suppose what really needs to happen here is document the gpio so that
> > the driver can determine at runtime what state this pin is in?
> >
> > Also, you say "In default mode", but don't mention what the non-
> > default
> > mode is. What happens in the other mode?
> This is a "double function" pin. On the PAC193x there is the SLOW/ALERT
> pin. At runtime this pin could be configured as an input to the PAC and
> the functionality will be "SLOW" that means if it is forced high, the
> PAC will work in low power mode by changing the sample rate to 8 SPS.
> If it's forced low the PAC will work at it's full sample rate.
Since this is a runtime thing, it doesn't make sense to have a property
that is set at dts creation time that decides what mode the pin is in.
> "SLOW" is the default function of the pin but it may be programmed to
> function as ALERT pin (Open Collector when functioning as ALERT,
> requires pull-up resistor to VDD I/O). This time the pin will be set as
> output from PAC (ALERT functionality) to trigger an interrupt to the
> system (this is covered by the interrupts and drive-open-drain).
Hmm, at the risk of getting out of my depth with what the GPIO subsystem
is capable of doing, I would expect to see something like
sampling-rate-gpios:
description:
<what you have above>
maxItems: 1
Which would allow the driver to either drive this pin via the gpio
subsystem, or to use the interrupt property to use it as an interrupt
instead.
Perhaps Jonathan etc knows better for these sort of dual mode pins.
> The system could work fine without this pin. The driver doesn't use
> interrupt at this time, but it could be extended.
Cheers,
Conor.
© 2016 - 2025 Red Hat, Inc.