diff mbox series

[v5,1/2] dt-bindings: iio: adc: adding support for PAC193X

Message ID 20240222164206.65700-2-marius.cristea@microchip.com (mailing list archive)
State Handled Elsewhere
Headers show
Series adding support for Microchip PAC193X Power Monitor | expand

Commit Message

marius.cristea@microchip.com Feb. 22, 2024, 4:42 p.m. UTC
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>
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>
---
 .../bindings/iio/adc/microchip,pac1934.yaml   | 120 ++++++++++++++++++
 1 file changed, 120 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml

Comments

Rob Herring (Arm) Feb. 22, 2024, 5:45 p.m. UTC | #1
On Thu, 22 Feb 2024 18:42:05 +0200, 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>
> Reviewed-by: Conor Dooley <conor.dooley@microchip.com>
> ---
>  .../bindings/iio/adc/microchip,pac1934.yaml   | 120 ++++++++++++++++++
>  1 file changed, 120 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:
./Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml:51:9: [warning] wrong indentation: expected 6 but found 8 (indentation)

dtschema/dtc warnings/errors:

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20240222164206.65700-2-marius.cristea@microchip.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
kernel test robot Feb. 24, 2024, 7:34 a.m. UTC | #2
Hi,

kernel test robot noticed the following build warnings:

[auto build test WARNING on b1a1eaf6183697b77f7243780a25f35c7c0c8bdf]

url:    https://github.com/intel-lab-lkp/linux/commits/marius-cristea-microchip-com/dt-bindings-iio-adc-adding-support-for-PAC193X/20240223-004332
base:   b1a1eaf6183697b77f7243780a25f35c7c0c8bdf
patch link:    https://lore.kernel.org/r/20240222164206.65700-2-marius.cristea%40microchip.com
patch subject: [PATCH v5 1/2] dt-bindings: iio: adc: adding support for PAC193X
compiler: loongarch64-linux-gcc (GCC) 13.2.0
reproduce: (https://download.01.org/0day-ci/archive/20240224/202402241545.xf7CnlPz-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202402241545.xf7CnlPz-lkp@intel.com/

dtcheck warnings: (new ones prefixed by >>)
>> Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml:51:9: [warning] wrong indentation: expected 6 but found 8 (indentation)

vim +51 Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml

     8	
     9	maintainers:
    10	  - Marius Cristea <marius.cristea@microchip.com>
    11	
    12	description: |
    13	  This device is part of the Microchip family of Power Monitors with
    14	  Accumulator.
    15	  The datasheet for PAC1931, PAC1932, PAC1933 and PAC1934 can be found here:
    16	    https://ww1.microchip.com/downloads/aemDocuments/documents/OTH/ProductDocuments/DataSheets/PAC1931-Family-Data-Sheet-DS20005850E.pdf
    17	
    18	properties:
    19	  compatible:
    20	    enum:
    21	      - microchip,pac1931
    22	      - microchip,pac1932
    23	      - microchip,pac1933
    24	      - microchip,pac1934
    25	
    26	  reg:
    27	    maxItems: 1
    28	
    29	  "#address-cells":
    30	    const: 1
    31	
    32	  "#size-cells":
    33	    const: 0
    34	
    35	  interrupts:
    36	    maxItems: 1
    37	
    38	  slow-io-gpios:
    39	    description:
    40	      A GPIO used to trigger a change is sampling rate (lowering the chip power
    41	      consumption). If configured in SLOW mode, if this pin is forced high,
    42	      sampling rate is forced to eight samples/second. When it is forced low,
    43	      the sampling rate is 1024 samples/second unless a different sample rate
    44	      has been programmed.
    45	
    46	patternProperties:
    47	  "^channel@[1-4]+$":
    48	    type: object
    49	    $ref: adc.yaml
    50	    description:
  > 51	        Represents the external channels which are connected to the ADC.
    52	
    53	    properties:
    54	      reg:
    55	        items:
    56	          minimum: 1
    57	          maximum: 4
    58	
    59	      shunt-resistor-micro-ohms:
    60	        description:
    61	          Value in micro Ohms of the shunt resistor connected between
    62	          the SENSE+ and SENSE- inputs, across which the current is measured.
    63	          Value is needed to compute the scaling of the measured current.
    64	
    65	    required:
    66	      - reg
    67	      - shunt-resistor-micro-ohms
    68	
    69	    unevaluatedProperties: false
    70	
    71	required:
    72	  - compatible
    73	  - reg
    74	  - "#address-cells"
    75	  - "#size-cells"
    76
Jonathan Cameron Feb. 24, 2024, 7:14 p.m. UTC | #3
On Sat, 24 Feb 2024 15:34:51 +0800
kernel test robot <lkp@intel.com> wrote:

> Hi,
> 
> kernel test robot noticed the following build warnings:
> 
> [auto build test WARNING on b1a1eaf6183697b77f7243780a25f35c7c0c8bdf]
> 
> url:    https://github.com/intel-lab-lkp/linux/commits/marius-cristea-microchip-com/dt-bindings-iio-adc-adding-support-for-PAC193X/20240223-004332
> base:   b1a1eaf6183697b77f7243780a25f35c7c0c8bdf
> patch link:    https://lore.kernel.org/r/20240222164206.65700-2-marius.cristea%40microchip.com
> patch subject: [PATCH v5 1/2] dt-bindings: iio: adc: adding support for PAC193X
> compiler: loongarch64-linux-gcc (GCC) 13.2.0
> reproduce: (https://download.01.org/0day-ci/archive/20240224/202402241545.xf7CnlPz-lkp@intel.com/reproduce)
> 
> If you fix the issue in a separate patch/commit (i.e. not just a new version of
> the same patch/commit), kindly add following tags
> | Reported-by: kernel test robot <lkp@intel.com>
> | Closes: https://lore.kernel.org/oe-kbuild-all/202402241545.xf7CnlPz-lkp@intel.com/
> 
> dtcheck warnings: (new ones prefixed by >>)
> >> Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml:51:9: [warning] wrong indentation: expected 6 but found 8 (indentation)  


>     45	
>     46	patternProperties:
>     47	  "^channel@[1-4]+$":
>     48	    type: object
>     49	    $ref: adc.yaml
>     50	    description:
>   > 51	        Represents the external channels which are connected to the ADC.  
I've fixed this up whilst applying.

>     52	
>     53	    properties:
>     54	      reg:
>     55	        items:
>     56	          minimum: 1
>     57	          maximum: 4
>     58	
>     59	      shunt-resistor-micro-ohms:
>     60	        description:
>     61	          Value in micro Ohms of the shunt resistor connected between
>     62	          the SENSE+ and SENSE- inputs, across which the current is measured.
>     63	          Value is needed to compute the scaling of the measured current.
>     64	
>     65	    required:
>     66	      - reg
>     67	      - shunt-resistor-micro-ohms
>     68	
>     69	    unevaluatedProperties: false
>     70	
>     71	required:
>     72	  - compatible
>     73	  - reg
>     74	  - "#address-cells"
>     75	  - "#size-cells"
>     76	
>
diff mbox series

Patch

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..52be5ada1eb6
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/microchip,pac1934.yaml
@@ -0,0 +1,120 @@ 
+# 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: |
+  This device is part of 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:
+    maxItems: 1
+
+  slow-io-gpios:
+    description:
+      A GPIO used to trigger a change is sampling rate (lowering the chip power
+      consumption). If configured in SLOW 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.
+
+patternProperties:
+  "^channel@[1-4]+$":
+    type: object
+    $ref: adc.yaml
+    description:
+        Represents the external channels which are connected to the ADC.
+
+    properties:
+      reg:
+        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.
+
+    required:
+      - reg
+      - shunt-resistor-micro-ohms
+
+    unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+  - "#address-cells"
+  - "#size-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        power-monitor@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;
+            };
+        };
+    };
+
+...