dt-bindings: iio: adc: Migrate MCP3911 documentation to yaml
Subsystems (3)
Marcus Folkesson
maintainerPATCH 1/1 dt-bindings: iio: adc: Migrate MCP3911 documentation to yaml
Rewrite bindings to use json-schema vocabulary.
--- .../devicetree/bindings/iio/adc/mcp3911.txt | 30 -------- .../bindings/iio/adc/microchip,mcp3911.yaml | 72 +++++++++++++++++++ MAINTAINERS | 2 +- 3 files changed, 73 insertions(+), 31 deletions(-) delete mode 100644 Documentation/devicetree/bindings/iio/adc/mcp3911.txt create mode 100644 Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml
Documentation/devicetree/bindings/iio/adc/mcp3911.txt deleted +0 -30
@@ -1,30 +0,0 @@ -* Microchip MCP3911 Dual channel analog front end (ADC) - -Required properties: - - compatible: Should be "microchip,mcp3911" - - reg: SPI chip select number for the device - -Recommended properties: - - spi-max-frequency: Definition as per - Documentation/devicetree/bindings/spi/spi-bus.txt. - Max frequency for this chip is 20MHz. - -Optional properties: - - clocks: Phandle and clock identifier for sampling clock - - interrupt-parent: Phandle to the parent interrupt controller - - interrupts: IRQ line for the ADC - - microchip,device-addr: Device address when multiple MCP3911 chips are present on the - same SPI bus. Valid values are 0-3. Defaults to 0. - - vref-supply: Phandle to the external reference voltage supply. - -Example: -adc@0 { - compatible = "microchip,mcp3911"; - reg = <0>; - interrupt-parent = <&gpio5>; - interrupts = <15 IRQ_TYPE_EDGE_RISING>; - spi-max-frequency = <20000000>; - microchip,device-addr = <0>; - vref-supply = <&vref_reg>; - clocks = <&xtal>; -};
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +72 -0
72 lines not on this page · raw message
MAINTAINERS +1 -1
@@ -10723,7 +10723,7 @@ M: Kent Gustavsson <[email protected]> L: [email protected] S: Supported F: drivers/iio/adc/mcp3911.c -F: Documentation/devicetree/bindings/iio/adc/mcp3911.txt +F: Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml MICROCHIP NAND DRIVER M: Tudor Ambarus <[email protected]>
Signature · 1 line
2.23.0
Rob Herring
maintainerQuoted 67 lines · Marcus Folkesson
Rewrite bindings to use json-schema vocabulary.
Signed-off-by Marcus Folkesson <[email protected]>--- .../devicetree/bindings/iio/adc/mcp3911.txt | 30 -------- .../bindings/iio/adc/microchip,mcp3911.yaml | 72 +++++++++++++++++++ MAINTAINERS | 2 +- 3 files changed, 73 insertions(+), 31 deletions(-) delete mode 100644 Documentation/devicetree/bindings/iio/adc/mcp3911.txt create mode 100644 Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yamlDocumentation/devicetree/bindings/iio/adc/mcp3911.txt deleted +0
-30@@ -1,30 +0,0 @@ -* Microchip MCP3911 Dual channel analog front end (ADC) - -Required properties: - - compatible: Should be "microchip,mcp3911" - - reg: SPI chip select number for the device - -Recommended properties: - - spi-max-frequency: Definition as per - Documentation/devicetree/bindings/spi/spi-bus.txt. - Max frequency for this chip is 20MHz. - -Optional properties: - - clocks: Phandle and clock identifier for sampling clock - - interrupt-parent: Phandle to the parent interrupt controller - - interrupts: IRQ line for the ADC - - microchip,device-addr: Device address when multiple MCP3911 chips are present on the - same SPI bus. Valid values are 0-3. Defaults to 0. - - vref-supply: Phandle to the external reference voltage supply. - -Example: -adc@0 { - compatible = "microchip,mcp3911"; - reg = <0>; - interrupt-parent = <&gpio5>; - interrupts = <15 IRQ_TYPE_EDGE_RISING>; - spi-max-frequency = <20000000>; - microchip,device-addr = <0>; - vref-supply = <&vref_reg>; - clocks = <&xtal>; -};Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +14
-0@@ -0,0 +1,72 @@ +# SPDX-License-Identifier: GPL-2.0 +# Copyright 2019 Marcus Folkesson <[email protected]> +%YAML 1.2 +--- +$id: "http://devicetree.org/schemas/bindings/iio/adc/microchip,mcp3911.yaml#" +$schema: "http://devicetree.org/meta-schemas/core.yaml#" + +title: Microchip MCP3911 Dual channel analog front end (ADC) + +maintainers: + - Marcus Folkesson <[email protected]> + - Kent Gustavsson <[email protected]> + +description: |
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml line 24
Quoted 10 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +10
-0+ Bindings for the Microchip MCP3911 Dual channel ADC device. Datasheet can be + found here: https://ww1.microchip.com/downloads/en/DeviceDoc/20002286C.pdf + +properties: + compatible: + enum: + - microchip,mcp3911 + + reg: + description: SPI chip select number for the device
No need to describe common properties if you have nothing special for this device to say.
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml line 29
Quoted 5 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +5
-0+ maxItems: 1 + + spi-max-frequency: + description: | + Definition as per Documentation/devicetree/bindings/spi/spi-bus.txt.
Same here.
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml line 31
Quoted 2 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +2
-0+ maximum: 20000000 + maxItems: 1
Not an array, so drop.
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml line 34
Quoted 3 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +3
-0+ + clocks: + description: Phandle and clock identifier for sampling clock
Same comment on descriptions.
Quoted 6 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +6
-0+ maxItems: 1 + + interrupts: + description: IRQ line of the ADC + maxItems: 1 +
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml line 50
Quoted 10 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +10
-0+ microchip,device-addr: + description: Device address when multiple MCP3911 chips are present on the same SPI bus. + allOf: + - $ref: /schemas/types.yaml#/definitions/uint32 + - enum: [0, 1, 2, 3] + - default: 0 + + vref-supply: + description: Phandle to the external reference voltage supply. + maxItems: 1
Drop this *-supply is always 1 item.
Quoted 38 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +22
-0+ +required: + - compatible + - reg + +examples: + - | + spi { + #address-cells = <1>; + #size-cells = <0>; + + adc@0 { + compatible = "microchip,mcp3911"; + reg = <0>; + interrupt-parent = <&gpio5>; + interrupts = <15 2>; + spi-max-frequency = <20000000>; + microchip,device-addr = <0>; + vref-supply = <&vref_reg>; + clocks = <&xtal>; + }; + };MAINTAINERS +1
-1@@ -10723,7 +10723,7 @@ M: Kent Gustavsson <[email protected]> L: [email protected] S: Supported F: drivers/iio/adc/mcp3911.c -F: Documentation/devicetree/bindings/iio/adc/mcp3911.txt +F: Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml MICROCHIP NAND DRIVER M: Tudor Ambarus <[email protected]>Signature · 1 line
2.23.0
Marcus Folkesson
maintainerHi Rob,
Thank you for comment. See inline comments.
I will apply the changes to this pending patch as well.
Subject: [PATCH] dt-bindings: iio: dac: Migrate LTC1660 documentation to yaml
Quoted 73 lines · Rob Herring
Quoted 72 lines · Marcus Folkesson
Rewrite bindings to use json-schema vocabulary.
Signed-off-by Marcus Folkesson <[email protected]>--- .../devicetree/bindings/iio/adc/mcp3911.txt | 30 -------- .../bindings/iio/adc/microchip,mcp3911.yaml | 72 +++++++++++++++++++ MAINTAINERS | 2 +- 3 files changed, 73 insertions(+), 31 deletions(-) delete mode 100644 Documentation/devicetree/bindings/iio/adc/mcp3911.txt create mode 100644 Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yamlDocumentation/devicetree/bindings/iio/adc/mcp3911.txt deleted +0
-30@@ -1,30 +0,0 @@ -* Microchip MCP3911 Dual channel analog front end (ADC) - -Required properties: - - compatible: Should be "microchip,mcp3911" - - reg: SPI chip select number for the device - -Recommended properties: - - spi-max-frequency: Definition as per - Documentation/devicetree/bindings/spi/spi-bus.txt. - Max frequency for this chip is 20MHz. - -Optional properties: - - clocks: Phandle and clock identifier for sampling clock - - interrupt-parent: Phandle to the parent interrupt controller - - interrupts: IRQ line for the ADC - - microchip,device-addr: Device address when multiple MCP3911 chips are present on the - same SPI bus. Valid values are 0-3. Defaults to 0. - - vref-supply: Phandle to the external reference voltage supply. - -Example: -adc@0 { - compatible = "microchip,mcp3911"; - reg = <0>; - interrupt-parent = <&gpio5>; - interrupts = <15 IRQ_TYPE_EDGE_RISING>; - spi-max-frequency = <20000000>; - microchip,device-addr = <0>; - vref-supply = <&vref_reg>; - clocks = <&xtal>; -};Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +19
-0@@ -0,0 +1,72 @@ +# SPDX-License-Identifier: GPL-2.0 +# Copyright 2019 Marcus Folkesson <[email protected]> +%YAML 1.2 +--- +$id: "http://devicetree.org/schemas/bindings/iio/adc/microchip,mcp3911.yaml#" +$schema: "http://devicetree.org/meta-schemas/core.yaml#" + +title: Microchip MCP3911 Dual channel analog front end (ADC) + +maintainers: + - Marcus Folkesson <[email protected]> + - Kent Gustavsson <[email protected]> + +description: | + Bindings for the Microchip MCP3911 Dual channel ADC device. Datasheet can be + found here: https://ww1.microchip.com/downloads/en/DeviceDoc/20002286C.pdf + +properties: + compatible:
Quoted 9 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml line 24
Quoted 5 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +5
-0+ enum: + - microchip,mcp3911 + + reg: + description: SPI chip select number for the deviceNo need to describe common properties if you have nothing special for this device to say.
OK
Quoted 10 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml line 29
Quoted 5 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +5
-0+ maxItems: 1 + + spi-max-frequency: + description: | + Definition as per Documentation/devicetree/bindings/spi/spi-bus.txt.Same here.
Quoted 2 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +2
-0+ maximum: 20000000 + maxItems: 1
Should I keep the maximum property?
Quoted 9 lines
Not an array, so drop.
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml line 34
Quoted 3 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +3
-0+ + clocks: + description: Phandle and clock identifier for sampling clockSame comment on descriptions.
I describe it a little bit more. Thanks
Quoted 10 lines
Quoted 10 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +10
-0+ maxItems: 1 + + interrupts: + description: IRQ line of the ADC + maxItems: 1 + + microchip,device-addr: + description: Device address when multiple MCP3911 chips are present on the same SPI bus. + allOf: + - $ref: /schemas/types.yaml#/definitions/uint32
Quoted 9 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml line 50
Quoted 6 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +6
-0+ - enum: [0, 1, 2, 3] + - default: 0 + + vref-supply: + description: Phandle to the external reference voltage supply. + maxItems: 1Drop this *-supply is always 1 item.
OK
Quoted 33 lines
Quoted 33 lines
Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml new file +22
-0+ +required: + - compatible + - reg + +examples: + - | + spi { + #address-cells = <1>; + #size-cells = <0>; + + adc@0 { + compatible = "microchip,mcp3911"; + reg = <0>; + interrupt-parent = <&gpio5>; + interrupts = <15 2>; + spi-max-frequency = <20000000>; + microchip,device-addr = <0>; + vref-supply = <&vref_reg>; + clocks = <&xtal>; + }; + };MAINTAINERS +1
-1@@ -10723,7 +10723,7 @@ M: Kent Gustavsson <[email protected]> L: [email protected] S: Supported F: drivers/iio/adc/mcp3911.c -F: Documentation/devicetree/bindings/iio/adc/mcp3911.txt +F: Documentation/devicetree/bindings/iio/adc/microchip,mcp3911.yaml
Quoted 5 lines
Quoted 5 lines
MAINTAINERS +0
-0MICROCHIP NAND DRIVER M: Tudor Ambarus <[email protected]>Signature · 1 line
2.23.0
Thanks,
Marcus Folkesson