Add bindings documentation file and MAINTAINERS entry for MAX11205.
Signed-off-by: Ramona Bolboaca <[email protected]>
---
changes in v2:
- reference /schemas/spi/spi-peripheral-props.yaml in allOf
- use unevaluatedProperties:false and remove additionalProperties:false
- use generic node name and fix indentation in device-tree example
- wrap lines nearer to 75-80 chars in documentation
- add extra information to the description of the regulator
.../bindings/iio/adc/maxim,max11205.yaml | 69 +++++++++++++++++++
MAINTAINERS | 8 +++
2 files changed, 77 insertions(+)
create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml
diff --git a/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml b/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml
new file mode 100644
index 000000000000..7902f82da927
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml
@@ -0,0 +1,69 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/maxim,max11205.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX11205 ADC
+
+maintainers:
+ - Ramona Bolboaca <[email protected]>
+
+description: |
+ The MAX11205 is an ultra-low-power (< 300FA max active current),
+ high-resolution, serial-output ADC.
+
+ https://datasheets.maximintegrated.com/en/ds/MAX11205.pdf
+
+allOf:
+ - $ref: /schemas/spi/spi-peripheral-props.yaml#
+
+properties:
+ compatible:
+ enum:
+ - maxim,max11205a
+ - maxim,max11205b
+
+ reg:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+ spi-max-frequency:
+ maximum: 5000000
+
+ spi-cpha: true
+
+ vref-supply:
+ description:
+ The regulator supply for the ADC reference voltage. This is a differential
+ reference. It is equal to the V_REFP - V_REFN. The maximum value is 3.6V.
+
+required:
+ - compatible
+ - reg
+ - spi-max-frequency
+ - spi-cpha
+ - interrupts
+ - vref-supply
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/irq.h>
+ spi {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ adc@0 {
+ compatible = "maxim,max11205a";
+ reg = <0>;
+ spi-max-frequency = <5000000>;
+ spi-cpha;
+ interrupt-parent = <&gpio>;
+ interrupts = <19 IRQ_TYPE_EDGE_FALLING>;
+ vref-supply = <&max11205_vref>;
+ };
+ };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index 96f47a7865d6..db1b5dc03988 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -12341,6 +12341,14 @@ S: Maintained
F: Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.yaml
F: drivers/iio/proximity/mb1232.c
+MAXIM MAX11205 DRIVER
+M: Ramona Bolboaca <[email protected]>
+L: [email protected]
+S: Supported
+W: https://ez.analog.com/linux-software-drivers
+F: Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml
+F: drivers/iio/adc/max11205.c
+
MAXIM MAX17040 FAMILY FUEL GAUGE DRIVERS
R: Iskren Chernev <[email protected]>
R: Krzysztof Kozlowski <[email protected]>
--
2.25.1
On 31/08/2022 16:30, Ramona Bolboaca wrote:
> Add bindings documentation file and MAINTAINERS entry for MAX11205.
>
> Signed-off-by: Ramona Bolboaca <[email protected]>
> +properties:
> + compatible:
> + enum:
> + - maxim,max11205a
> + - maxim,max11205b
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + spi-max-frequency:
> + maximum: 5000000
> +
> + spi-cpha: true
> +
> + vref-supply:
> + description:
> + The regulator supply for the ADC reference voltage. This is a differential
> + reference. It is equal to the V_REFP - V_REFN. The maximum value is 3.6V.
> +
> +required:
> + - compatible
> + - reg
> + - spi-max-frequency
> + - spi-cpha
> + - interrupts
> + - vref-supply
If you are going to send a new version, please put the properties here
in the same order as they appear in top-level "properties:".
In any case:
Reviewed-by: Krzysztof Kozlowski <[email protected]>
Best regards,
Krzysztof
On Wed, 31 Aug 2022 16:30:20 +0300
Ramona Bolboaca <[email protected]> wrote:
> Add bindings documentation file and MAINTAINERS entry for MAX11205.
Binding patch titles tend to be
dt-bindings: iio:
etc.
I'll fix whilst applying.
>
> Signed-off-by: Ramona Bolboaca <[email protected]>
> ---
> changes in v2:
> - reference /schemas/spi/spi-peripheral-props.yaml in allOf
> - use unevaluatedProperties:false and remove additionalProperties:false
> - use generic node name and fix indentation in device-tree example
> - wrap lines nearer to 75-80 chars in documentation
> - add extra information to the description of the regulator
> .../bindings/iio/adc/maxim,max11205.yaml | 69 +++++++++++++++++++
> MAINTAINERS | 8 +++
> 2 files changed, 77 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml b/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml
> new file mode 100644
> index 000000000000..7902f82da927
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml
> @@ -0,0 +1,69 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/maxim,max11205.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Maxim MAX11205 ADC
> +
> +maintainers:
> + - Ramona Bolboaca <[email protected]>
> +
> +description: |
> + The MAX11205 is an ultra-low-power (< 300FA max active current),
> + high-resolution, serial-output ADC.
> +
> + https://datasheets.maximintegrated.com/en/ds/MAX11205.pdf
> +
> +allOf:
> + - $ref: /schemas/spi/spi-peripheral-props.yaml#
> +
> +properties:
> + compatible:
> + enum:
> + - maxim,max11205a
> + - maxim,max11205b
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + spi-max-frequency:
> + maximum: 5000000
> +
> + spi-cpha: true
> +
> + vref-supply:
> + description:
> + The regulator supply for the ADC reference voltage. This is a differential
> + reference. It is equal to the V_REFP - V_REFN. The maximum value is 3.6V.
> +
> +required:
> + - compatible
> + - reg
> + - spi-max-frequency
> + - spi-cpha
> + - interrupts
> + - vref-supply
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> + spi {
> + #address-cells = <1>;
> + #size-cells = <0>;
> + adc@0 {
> + compatible = "maxim,max11205a";
> + reg = <0>;
> + spi-max-frequency = <5000000>;
> + spi-cpha;
> + interrupt-parent = <&gpio>;
> + interrupts = <19 IRQ_TYPE_EDGE_FALLING>;
> + vref-supply = <&max11205_vref>;
> + };
> + };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 96f47a7865d6..db1b5dc03988 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -12341,6 +12341,14 @@ S: Maintained
> F: Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.yaml
> F: drivers/iio/proximity/mb1232.c
>
> +MAXIM MAX11205 DRIVER
> +M: Ramona Bolboaca <[email protected]>
> +L: [email protected]
> +S: Supported
> +W: https://ez.analog.com/linux-software-drivers
> +F: Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml
> +F: drivers/iio/adc/max11205.c
> +
> MAXIM MAX17040 FAMILY FUEL GAUGE DRIVERS
> R: Iskren Chernev <[email protected]>
> R: Krzysztof Kozlowski <[email protected]>
On Wed, 31 Aug 2022 16:36:25 +0300
Krzysztof Kozlowski <[email protected]> wrote:
> On 31/08/2022 16:30, Ramona Bolboaca wrote:
> > Add bindings documentation file and MAINTAINERS entry for MAX11205.
> >
> > Signed-off-by: Ramona Bolboaca <[email protected]>
>
>
> > +properties:
> > + compatible:
> > + enum:
> > + - maxim,max11205a
> > + - maxim,max11205b
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + interrupts:
> > + maxItems: 1
> > +
> > + spi-max-frequency:
> > + maximum: 5000000
> > +
> > + spi-cpha: true
> > +
> > + vref-supply:
> > + description:
> > + The regulator supply for the ADC reference voltage. This is a differential
> > + reference. It is equal to the V_REFP - V_REFN. The maximum value is 3.6V.
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - spi-max-frequency
> > + - spi-cpha
> > + - interrupts
> > + - vref-supply
>
> If you are going to send a new version, please put the properties here
> in the same order as they appear in top-level "properties:".
Tweaked whilst applying.
J
>
> In any case:
>
> Reviewed-by: Krzysztof Kozlowski <[email protected]>
>
> Best regards,
> Krzysztof