1 # SPDX-License-Identifier: GPL-2.0 1 # SPDX-License-Identifier: GPL-2.0
2 %YAML 1.2 2 %YAML 1.2
3 --- 3 ---
4 $id: http://devicetree.org/schemas/iio/adc/adc 4 $id: http://devicetree.org/schemas/iio/adc/adc.yaml#
5 $schema: http://devicetree.org/meta-schemas/co 5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6 6
7 title: IIO Common Properties for ADC Channels 7 title: IIO Common Properties for ADC Channels
8 8
9 maintainers: 9 maintainers:
10 - Jonathan Cameron <jic23@kernel.org> 10 - Jonathan Cameron <jic23@kernel.org>
11 11
12 description: 12 description:
13 A few properties are defined in a common way 13 A few properties are defined in a common way ADC channels.
14 14
15 properties: 15 properties:
16 $nodename: 16 $nodename:
17 pattern: "^channel(@[0-9a-f]+)?$" 17 pattern: "^channel(@[0-9a-f]+)?$"
18 description: 18 description:
19 A channel index should match reg. 19 A channel index should match reg.
20 20
21 reg: 21 reg:
22 maxItems: 1 22 maxItems: 1
23 23
24 label: 24 label:
>> 25 $ref: /schemas/types.yaml#/definitions/string
25 description: Unique name to identify which 26 description: Unique name to identify which channel this is.
26 27
27 bipolar: 28 bipolar:
28 $ref: /schemas/types.yaml#/definitions/fla 29 $ref: /schemas/types.yaml#/definitions/flag
29 description: If provided, the channel is t 30 description: If provided, the channel is to be used in bipolar mode.
30 31
31 diff-channels: 32 diff-channels:
32 $ref: /schemas/types.yaml#/definitions/uin 33 $ref: /schemas/types.yaml#/definitions/uint32-array
33 maxItems: 2 34 maxItems: 2
34 minItems: 2 35 minItems: 2
35 description: 36 description:
36 Many ADCs have dual Muxes to allow diffe 37 Many ADCs have dual Muxes to allow different input pins to be routed
37 to both the positive and negative inputs 38 to both the positive and negative inputs of a differential ADC.
38 The first value specifies the positive i 39 The first value specifies the positive input pin, the second
39 specifies the negative input pin. 40 specifies the negative input pin.
40 41
41 single-channel: <<
42 $ref: /schemas/types.yaml#/definitions/uin <<
43 description: <<
44 When devices combine single-ended and di <<
45 channel for a single element to be speci <<
46 differential channels). If this and diff <<
47 shall be used instead. <<
48 <<
49 common-mode-channel: <<
50 $ref: /schemas/types.yaml#/definitions/uin <<
51 description: <<
52 Some ADCs have differential input pins t <<
53 single-ended or pseudo-differential inpu <<
54 in addition to single-channel to signal <<
55 not differential but still specify two i <<
56 <<
57 The input pair is specified by setting s <<
58 input pin and common-mode-channel to the <<
59 <<
60 settling-time-us: 42 settling-time-us:
61 description: 43 description:
62 Time between enabling the channel and fi 44 Time between enabling the channel and first stable readings.
63 45
64 oversampling-ratio: 46 oversampling-ratio:
65 $ref: /schemas/types.yaml#/definitions/uin 47 $ref: /schemas/types.yaml#/definitions/uint32
66 description: 48 description:
67 Oversampling is used as replacement of o 49 Oversampling is used as replacement of or addition to the low-pass filter.
68 In some cases, the desired filtering cha 50 In some cases, the desired filtering characteristics are a function the
69 device design and can interact with othe 51 device design and can interact with other characteristics such as
70 settling time. 52 settling time.
71 <<
72 anyOf: <<
73 - oneOf: <<
74 - required: <<
75 - reg <<
76 - diff-channels <<
77 - required: <<
78 - reg <<
79 - single-channel <<
80 - required: <<
81 - reg <<
82 53
83 additionalProperties: true 54 additionalProperties: true
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.