xref: /freebsd/sys/contrib/device-tree/Bindings/iio/adc/microchip,mcp3911.yaml (revision a90b9d0159070121c221b966469c3e36d912bf82) 
1# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
2# Copyright 2019 Marcus Folkesson <marcus.folkesson@gmail.com>
3%YAML 1.2
4---
5$id: http://devicetree.org/schemas/iio/adc/microchip,mcp3911.yaml#
6$schema: http://devicetree.org/meta-schemas/core.yaml#
7
8title: Microchip MCP3911 Dual channel analog front end (ADC)
9
10maintainers:
11  - Marcus Folkesson <marcus.folkesson@gmail.com>
12  - Kent Gustavsson <nedo80@gmail.com>
13
14description: |
15  Bindings for the Microchip MCP3911 Dual channel ADC device. Datasheet can be
16  found here: https://ww1.microchip.com/downloads/en/DeviceDoc/20002286C.pdf
17
18properties:
19  compatible:
20    enum:
21      - microchip,mcp3910
22      - microchip,mcp3911
23      - microchip,mcp3912
24      - microchip,mcp3913
25      - microchip,mcp3914
26      - microchip,mcp3918
27      - microchip,mcp3919
28
29  reg:
30    maxItems: 1
31
32  spi-max-frequency:
33    maximum: 20000000
34
35  clocks:
36    description: |
37      Phandle and clock identifier for external sampling clock.
38      If not specified, the internal crystal oscillator will be used.
39    maxItems: 1
40
41  interrupts:
42    description: IRQ line of the ADC
43    maxItems: 1
44
45  microchip,data-ready-hiz:
46    description:
47      Data Ready Pin Inactive State Control
48      true = The DR pin state is high-impedance
49      false = The DR pin state is logic high
50    type: boolean
51
52  microchip,device-addr:
53    description: Device address when multiple MCP3911 chips are present on the same SPI bus.
54    $ref: /schemas/types.yaml#/definitions/uint32
55    enum: [0, 1, 2, 3]
56    default: 0
57
58  vref-supply:
59    description: |
60      Phandle to the external reference voltage supply.
61      If not specified, the internal voltage reference (1.2V) will be used.
62
63required:
64  - compatible
65  - reg
66
67allOf:
68  - $ref: /schemas/spi/spi-peripheral-props.yaml#
69
70unevaluatedProperties: false
71
72examples:
73  - |
74    spi {
75      #address-cells = <1>;
76      #size-cells = <0>;
77
78      adc@0 {
79        compatible = "microchip,mcp3911";
80        reg = <0>;
81        interrupt-parent = <&gpio5>;
82        interrupts = <15 2>;
83        spi-max-frequency = <20000000>;
84        microchip,device-addr = <0>;
85        vref-supply = <&vref_reg>;
86        clocks = <&xtal>;
87      };
88    };
89