GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / devicetree / bindings / iio / frequency / adf4371.yaml
1 # SPDX-License-Identifier: GPL-2.0
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/iio/frequency/adf4371.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Analog Devices ADF4371/ADF4372 Wideband Synthesizers
8
9 maintainers:
10   - Popa Stefan <stefan.popa@analog.com>
11
12 description: |
13   Analog Devices ADF4371/ADF4372 SPI Wideband Synthesizers
14   https://www.analog.com/media/en/technical-documentation/data-sheets/adf4371.pdf
15   https://www.analog.com/media/en/technical-documentation/data-sheets/adf4372.pdf
16
17 properties:
18   compatible:
19     enum:
20       - adi,adf4371
21       - adi,adf4372
22
23   reg:
24     maxItems: 1
25
26   clocks:
27     description:
28       Definition of the external clock (see clock/clock-bindings.txt)
29     maxItems: 1
30
31   clock-names:
32     description:
33       Must be "clkin"
34     maxItems: 1
35
36   adi,mute-till-lock-en:
37     type: boolean
38     description:
39       If this property is present, then the supply current to RF8P and RF8N
40       output stage will shut down until the ADF4371/ADF4372 achieves lock as
41       measured by the digital lock detect circuitry.
42
43 required:
44   - compatible
45   - reg
46   - clocks
47   - clock-names
48
49 allOf:
50   - $ref: /schemas/spi/spi-peripheral-props.yaml#
51
52 unevaluatedProperties: false
53
54 examples:
55   - |
56     spi0 {
57         #address-cells = <1>;
58         #size-cells = <0>;
59
60         frequency@0 {
61                 compatible = "adi,adf4371";
62                 reg = <0>;
63                 spi-max-frequency = <1000000>;
64                 clocks = <&adf4371_clkin>;
65                 clock-names = "clkin";
66         };
67     };
68 ...