Commit 5313513d authored by Marcus Folkesson's avatar Marcus Folkesson Committed by Jonathan Cameron
Browse files

dt-bindings: iio: adc: Migrate MCP3911 documentation to yaml



Rewrite bindings to use json-schema vocabulary.

Signed-off-by: default avatarMarcus Folkesson <marcus.folkesson@gmail.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
parent 26a0ffee
Loading
Loading
Loading
Loading
+0 −30
Original line number Diff line number Diff line
* 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>;
};
+71 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
# Copyright 2019 Marcus Folkesson <marcus.folkesson@gmail.com>
%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 <marcus.folkesson@gmail.com>
  - Kent Gustavsson <nedo80@gmail.com>

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:
    enum:
      - microchip,mcp3911

  reg:
    maxItems: 1

  spi-max-frequency:
    maximum: 20000000

  clocks:
    description: |
      Phandle and clock identifier for external sampling clock.
      If not specified, the internal crystal oscillator will be used.
    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
      - enum: [0, 1, 2, 3]
      - default: 0

  vref-supply:
    description: |
      Phandle to the external reference voltage supply.
      If not specified, the internal voltage reference (1.2V) will be used.

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>;
      };
    };
+1 −1
Original line number Diff line number Diff line
@@ -10734,7 +10734,7 @@ M: Kent Gustavsson <kent@minoris.se>
L:	linux-iio@vger.kernel.org
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 <tudor.ambarus@microchip.com>