2024-05-29 16:02:29

by Ramona Alexandra Nechita

[permalink] [raw]
Subject: [PATCH v2] dt-bindings: iio: adc: add a7779 doc

Add dt bindings for adc ad7779.

Signed-off-by: ranechita <[email protected]>
---
.../ABI/testing/sysfs-bus-iio-adc-ad777x | 23 +++++
.../bindings/iio/adc/adi,ad7779.yaml | 89 +++++++++++++++++++
2 files changed, 112 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ad777x
create mode 100644 Documentation/devicetree/bindings/iio/adc/adi,ad7779.yaml

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad777x b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad777x
new file mode 100644
index 000000000000..0a57fda598e6
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad777x
@@ -0,0 +1,23 @@
+What: /sys/bus/iio/devices/iio:deviceX/filter_type_available
+KernelVersion: 6.1
+Contact: [email protected]
+Description:
+ Reading returns a list with the possible filter modes. Only supported by
+ AD7771.
+
+ * "sinc3" - The digital sinc3 filter implements three main notches, one at
+ the maximum ODR (128 kHz or 32 kHz, depending on the
+ power mode) and another two at the ODR frequency selected to
+ stop noise aliasing into the pass band.
+
+ * "sinc5" - The sinc5 filter implements five notches, one at
+ the maximum ODR (128 kHz or 32 kHz, depending on the
+ power mode) and another four at the ODR frequency
+ selected to stop noise aliasing into the pass band.
+
+What: /sys/bus/iio/devices/iio:deviceX/filter_type
+KernelVersion: 6.1
+Contact: [email protected]
+Description:
+ Set the filter mode of the differential channel. The current sampling_frequency
+ is set according to the filter range. Only supported by AD7771.
diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7779.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7779.yaml
new file mode 100644
index 000000000000..190070ed80b5
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7779.yaml
@@ -0,0 +1,89 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/adi,ad7779.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices AD777X family 8-Channel, 24-Bit, Simultaneous Sampling ADCs
+
+maintainers:
+ - Ramona Nechita <[email protected]>
+
+description: |
+ The AD777X family consist of 8-channel, simultaneous sampling analog-to-
+ digital converter (ADC). Eight full Σ-Δ ADCs are on-chip. The
+ AD7771 provides an ultralow input current to allow direct sensor
+ connection. Each input channel has a programmable gain stage
+ allowing gains of 1, 2, 4, and 8 to map lower amplitude sensor
+ outputs into the full-scale ADC input range, maximizing the
+ dynamic range of the signal chain.
+
+ https://www.analog.com/media/en/technical-documentation/data-sheets/ad7770.pdf
+ https://www.analog.com/media/en/technical-documentation/data-sheets/ad7771.pdf
+ https://www.analog.com/media/en/technical-documentation/data-sheets/ad7779.pdf
+
+$ref: /schemas/spi/spi-peripheral-props.yaml#
+
+properties:
+ compatible:
+ enum:
+ - adi,ad7770
+ - adi,ad7771
+ - adi,ad7779
+
+ reg:
+ maxItems: 1
+
+ '#address-cells':
+ const: 1
+
+ '#size-cells':
+ const: 0
+
+ spi-max-frequency: true
+
+ clocks:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+ vref-supply:
+ description:
+ ADC reference voltage supply
+
+ start-gpios:
+ description:
+ Pin that controls start synchronization pulse.
+ maxItems: 1
+
+ reset-gpios:
+ maxItems: 1
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - clock-names
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+ spi {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ adc@0 {
+ compatible = "adi,ad7779";
+ reg = <0>;
+ spi-max-frequency = <20000000>;
+ vref-supply = <&vref>;
+ start-gpios = <&gpio0 87 GPIO_ACTIVE_LOW>;
+ reset-gpios = <&gpio0 93 GPIO_ACTIVE_LOW>;
+ clocks = <&adc_clk>;
+ clock-names = "adc-clk";
+ };
+ };
+...
--
2.43.0



2024-05-29 17:26:06

by Rob Herring (Arm)

[permalink] [raw]
Subject: Re: [PATCH v2] dt-bindings: iio: adc: add a7779 doc


On Wed, 29 May 2024 19:00:52 +0300, ranechita wrote:
> Add dt bindings for adc ad7779.
>
> Signed-off-by: ranechita <[email protected]>
> ---
> .../ABI/testing/sysfs-bus-iio-adc-ad777x | 23 +++++
> .../bindings/iio/adc/adi,ad7779.yaml | 89 +++++++++++++++++++
> 2 files changed, 112 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ad777x
> create mode 100644 Documentation/devicetree/bindings/iio/adc/adi,ad7779.yaml
>

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/iio/adc/adi,ad7779.example.dtb: adc@0: Unevaluated properties are not allowed ('clock-names' was unexpected)
from schema $id: http://devicetree.org/schemas/iio/adc/adi,ad7779.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/[email protected]

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.


2024-05-30 07:58:49

by Ramona Alexandra Nechita

[permalink] [raw]
Subject: RE: [PATCH v2] dt-bindings: iio: adc: add a7779 doc

Hello,

Thank you for the suggestion, I have installed the appropriate packages and now 'make dt_binding_check' works properly. I will re-submit this patch in a separate email.

Best Regards,
Ramona

-----Original Message-----
From: Rob Herring (Arm) <[email protected]>
Sent: Wednesday, May 29, 2024 8:26 PM
To: Nechita, Ramona <[email protected]>
Cc: Hennerich, Michael <[email protected]>; Krzysztof Kozlowski <[email protected]>; Conor Dooley <[email protected]>; [email protected]; [email protected]; Lars-Peter Clausen <[email protected]>; Jonathan Cameron <[email protected]>; [email protected]
Subject: Re: [PATCH v2] dt-bindings: iio: adc: add a7779 doc

[External]


On Wed, 29 May 2024 19:00:52 +0300, ranechita wrote:
> Add dt bindings for adc ad7779.
>
> Signed-off-by: ranechita <[email protected]>
> ---
> .../ABI/testing/sysfs-bus-iio-adc-ad777x | 23 +++++
> .../bindings/iio/adc/adi,ad7779.yaml | 89 +++++++++++++++++++
> 2 files changed, 112 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ad777x
> create mode 100644
> Documentation/devicetree/bindings/iio/adc/adi,ad7779.yaml
>

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/iio/adc/adi,ad7779.example.dtb: adc@0: Unevaluated properties are not allowed ('clock-names' was unexpected)
from schema $id: https://urldefense.com/v3/__http://devicetree.org/schemas/iio/adc/adi,ad7779.yaml*__;Iw!!A3Ni8CS0y2Y!5LPa4GEpfumgRCThzt_lSrVFgb7dCb_TXOWIs2bKUMwR8W7A_wcSuZajrhPwt-FNmVbwRRJ8nvfA3WA$

doc reference errors (make refcheckdocs):

See https://urldefense.com/v3/__https://patchwork.ozlabs.org/project/devicetree-bindings/patch/[email protected]__;!!A3Ni8CS0y2Y!5LPa4GEpfumgRCThzt_lSrVFgb7dCb_TXOWIs2bKUMwR8W7A_wcSuZajrhPwt-FNmVbwRRJ8UcPeVdQ$

The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.