GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / devicetree / bindings / iio / frequency / adi,adrf6780.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/iio/frequency/adi,adrf6780.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: ADRF6780 Microwave Upconverter
8
9 maintainers:
10   - Antoniu Miclaus <antoniu.miclaus@analog.com>
11
12 description: |
13    Wideband, microwave upconverter optimized for point to point microwave
14    radio designs operating in the 5.9 GHz to 23.6 GHz frequency range.
15
16    https://www.analog.com/en/products/adrf6780.html
17
18 properties:
19   compatible:
20     enum:
21       - adi,adrf6780
22
23   reg:
24     maxItems: 1
25
26   spi-max-frequency:
27     maximum: 1000000
28
29   clocks:
30     description:
31       Definition of the external clock.
32     minItems: 1
33
34   clock-names:
35     items:
36       - const: lo_in
37
38   clock-output-names:
39     maxItems: 1
40
41   adi,vga-buff-en:
42     description:
43       RF Variable Gain Amplifier Buffer Enable. Gain is controlled by
44       the voltage on the VATT pin.
45     type: boolean
46
47   adi,lo-buff-en:
48     description:
49       Local Oscillator Amplifier Enable. Disable to put the part in
50       a power down state.
51     type: boolean
52
53   adi,if-mode-en:
54     description:
55       Intermediate Frequency Mode Enable. Either IF Mode or I/Q Mode
56       can be enabled at a time.
57     type: boolean
58
59   adi,iq-mode-en:
60     description:
61       I/Q Mode Enable. Either IF Mode or I/Q Mode can be enabled at a
62       time.
63     type: boolean
64
65   adi,lo-x2-en:
66     description:
67       Double the Local Oscillator output frequency from the Local
68       Oscillator Input Frequency. Either LOx1 or LOx2 can be enabled
69       at a time.
70     type: boolean
71
72   adi,lo-ppf-en:
73     description:
74       Local Oscillator input frequency equal to the Local Oscillator
75       output frequency (LO x1). Either LOx1 or LOx2 can be enabled
76       at a time.
77     type: boolean
78
79   adi,lo-en:
80     description:
81       Enable additional cirtuitry in the LO chain. Disable to put the
82       part in a power down state.
83     type: boolean
84
85   adi,uc-bias-en:
86     description:
87       Enable all bias circuitry thourghout the entire part.
88       Disable to put the part in a power down state.
89     type: boolean
90
91   adi,lo-sideband:
92     description:
93       Switch to the Lower LO Sideband. By default the Upper LO
94       sideband is enabled.
95     type: boolean
96
97   adi,vdet-out-en:
98     description:
99       VDET Output Select Enable. Expose the RF detector output to the
100       VDET external pin.
101     type: boolean
102
103   '#clock-cells':
104     const: 0
105
106 dependencies:
107   adi,lo-x2-en: [ "adi,lo-en" ]
108   adi,lo-ppf-en: [ "adi,lo-en" ]
109
110 required:
111   - compatible
112   - reg
113   - clocks
114   - clock-names
115
116 allOf:
117   - $ref: /schemas/spi/spi-peripheral-props.yaml#
118
119 unevaluatedProperties: false
120
121 examples:
122   - |
123     spi {
124       #address-cells = <1>;
125       #size-cells = <0>;
126       adrf6780@0 {
127         compatible = "adi,adrf6780";
128         reg = <0>;
129         spi-max-frequency = <1000000>;
130         clocks = <&adrf6780_lo>;
131         clock-names = "lo_in";
132       };
133     };
134 ...