GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / devicetree / bindings / iio / frequency / adi,admv1013.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,admv1013.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: ADMV1013 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 24 GHz to 44 GHz frequency range.
15
16    https://www.analog.com/en/products/admv1013.html
17
18 properties:
19   compatible:
20     enum:
21       - adi,admv1013
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   vcm-supply:
39     description:
40       Analog voltage regulator.
41
42   vcc-drv-supply:
43     description:
44       RF Driver voltage regulator.
45
46   vcc2-drv-supply:
47     description:
48       RF predriver voltage regulator.
49
50   vcc-vva-supply:
51     description:
52       VVA Control Circuit voltage regulator.
53
54   vcc-amp1-supply:
55     description:
56       RF Amplifier 1 voltage regulator.
57
58   vcc-amp2-supply:
59     description:
60       RF Amplifier 2 voltage regulator.
61
62   vcc-env-supply:
63     description:
64       Envelope Detector voltage regulator.
65
66   vcc-bg-supply:
67     description:
68       Mixer Chip Band Gap Circuit voltage regulator.
69
70   vcc-bg2-supply:
71     description:
72       VGA Chip Band Gap Circuit voltage regulator.
73
74   vcc-mixer-supply:
75     description:
76       Mixer voltage regulator.
77
78   vcc-quad-supply:
79     description:
80       Quadruppler voltage regulator.
81
82   adi,detector-enable:
83     description:
84       Enable the Envelope Detector available at output pins VENV_P and
85       VENV_N. Disable to reduce power consumption.
86     type: boolean
87
88   adi,input-mode:
89     description:
90       Select the input mode.
91       iq - in-phase quadrature (I/Q) input
92       if - complex intermediate frequency (IF) input
93     enum: [iq, if]
94
95   adi,quad-se-mode:
96     description:
97       Switch the LO path from differential to single-ended operation.
98       se-neg - Single-Ended Mode, Negative Side Disabled.
99       se-pos - Single-Ended Mode, Positive Side Disabled.
100       diff - Differential Mode.
101     enum: [se-neg, se-pos, diff]
102
103   '#clock-cells':
104     const: 0
105
106 required:
107   - compatible
108   - reg
109   - clocks
110   - clock-names
111   - vcm-supply
112   - vcc-drv-supply
113   - vcc2-drv-supply
114   - vcc-vva-supply
115   - vcc-amp1-supply
116   - vcc-amp2-supply
117   - vcc-env-supply
118   - vcc-bg-supply
119   - vcc-bg2-supply
120   - vcc-mixer-supply
121   - vcc-quad-supply
122
123 allOf:
124   - $ref: /schemas/spi/spi-peripheral-props.yaml#
125
126 unevaluatedProperties: false
127
128 examples:
129   - |
130     spi {
131       #address-cells = <1>;
132       #size-cells = <0>;
133       admv1013@0{
134         compatible = "adi,admv1013";
135         reg = <0>;
136         spi-max-frequency = <1000000>;
137         clocks = <&admv1013_lo>;
138         clock-names = "lo_in";
139         vcm-supply = <&vcm>;
140         vcc-drv-supply = <&vcc_drv>;
141         vcc2-drv-supply = <&vcc2_drv>;
142         vcc-vva-supply = <&vcc_vva>;
143         vcc-amp1-supply = <&vcc_amp1>;
144         vcc-amp2-supply = <&vcc_amp2>;
145         vcc-env-supply = <&vcc_env>;
146         vcc-bg-supply = <&vcc_bg>;
147         vcc-bg2-supply = <&vcc_bg2>;
148         vcc-mixer-supply = <&vcc_mixer>;
149         vcc-quad-supply = <&vcc_quad>;
150         adi,quad-se-mode = "diff";
151         adi,detector-enable;
152       };
153     };
154 ...