| Tom Rini | 53633a8 | 2024-02-29 12:33:36 -0500 | [diff] [blame] | 1 | # SPDX-License-Identifier: GPL-2.0 |
| 2 | %YAML 1.2 |
| 3 | --- |
| 4 | $id: http://devicetree.org/schemas/iio/adc/adc.yaml# |
| 5 | $schema: http://devicetree.org/meta-schemas/core.yaml# |
| 6 | |
| 7 | title: IIO Common Properties for ADC Channels |
| 8 | |
| 9 | maintainers: |
| 10 | - Jonathan Cameron <jic23@kernel.org> |
| 11 | |
| 12 | description: |
| 13 | A few properties are defined in a common way ADC channels. |
| 14 | |
| 15 | properties: |
| 16 | $nodename: |
| 17 | pattern: "^channel(@[0-9a-f]+)?$" |
| 18 | description: |
| 19 | A channel index should match reg. |
| 20 | |
| 21 | reg: |
| 22 | maxItems: 1 |
| 23 | |
| 24 | label: |
| 25 | $ref: /schemas/types.yaml#/definitions/string |
| 26 | description: Unique name to identify which channel this is. |
| 27 | |
| 28 | bipolar: |
| 29 | $ref: /schemas/types.yaml#/definitions/flag |
| 30 | description: If provided, the channel is to be used in bipolar mode. |
| 31 | |
| 32 | diff-channels: |
| 33 | $ref: /schemas/types.yaml#/definitions/uint32-array |
| 34 | maxItems: 2 |
| 35 | minItems: 2 |
| 36 | description: |
| 37 | Many ADCs have dual Muxes to allow different input pins to be routed |
| 38 | to both the positive and negative inputs of a differential ADC. |
| 39 | The first value specifies the positive input pin, the second |
| 40 | specifies the negative input pin. |
| 41 | |
| 42 | settling-time-us: |
| 43 | description: |
| 44 | Time between enabling the channel and first stable readings. |
| 45 | |
| 46 | oversampling-ratio: |
| 47 | $ref: /schemas/types.yaml#/definitions/uint32 |
| 48 | description: |
| 49 | Oversampling is used as replacement of or addition to the low-pass filter. |
| 50 | In some cases, the desired filtering characteristics are a function the |
| 51 | device design and can interact with other characteristics such as |
| 52 | settling time. |
| 53 | |
| 54 | additionalProperties: true |