This patch adds document the bindings for MAX77541 and MAX77540
regulator drivers.
Signed-off-by: Okan Sahin <[email protected]>
---
.../bindings/regulator/adi,max77541.yaml | 44 +++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 45 insertions(+)
create mode 100644 Documentation/devicetree/bindings/regulator/adi,max77541.yaml
diff --git a/Documentation/devicetree/bindings/regulator/adi,max77541.yaml b/Documentation/devicetree/bindings/regulator/adi,max77541.yaml
new file mode 100644
index 000000000000..1f828895ab3a
--- /dev/null
+++ b/Documentation/devicetree/bindings/regulator/adi,max77541.yaml
@@ -0,0 +1,44 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/regulator/adi,max77541.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Buck Converter driver for MAX77540/MAX77541
+
+maintainers:
+ - Okan Sahin <[email protected]>
+
+description: |
+ This is a part of device tree bindings for ADI MAX77540/MAX77541
+
+ The buck convertere is represented as a sub-node of the PMIC node on the device tree.
+
+ The device has two buck regulators.
+ See also Documentation/devicetree/bindings/mfd/adi,max77541.yaml for
+ additional information and example.
+
+properties:
+ compatible:
+ enum:
+ - adi,max77540-regulator
+ - adi,max77541-regulator
+
+patternProperties:
+ "^BUCK[12]$":
+ type: object
+ $ref: regulator.yaml#
+ additionalProperties: false
+ description: |
+ Buck regulator.
+
+ properties:
+ regulator-name: true
+ regulator-always-on: true
+ regulator-boot-on: true
+ regulator-min-microvolt:
+ minimum: 300000
+ regulator-max-microvolt:
+ maximum: 5200000
+
+additionalProperties: false
\ No newline at end of file
diff --git a/MAINTAINERS b/MAINTAINERS
index 5704ed5afce3..8e5572b28a8c 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -12502,6 +12502,7 @@ M: Okan Sahin <[email protected]>
L: [email protected]
S: Maintained
F: Documentation/devicetree/bindings/mfd/adi,max77541.yaml
+F: Documentation/devicetree/bindings/regulator/adi,max77541.yaml
F: drivers/mfd/max77541.c
F: drivers/regulator/max77541-regulator.c
F: include/linux/mfd/max77541.h
--
2.30.2
On 07/12/2022 10:08, Okan Sahin wrote:
> This patch adds document the bindings for MAX77541 and MAX77540
> regulator drivers.
Do not use "This commit/patch".
https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95
>
> Signed-off-by: Okan Sahin <[email protected]>
> ---
> .../bindings/regulator/adi,max77541.yaml | 44 +++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 45 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/regulator/adi,max77541.yaml
>
> diff --git a/Documentation/devicetree/bindings/regulator/adi,max77541.yaml b/Documentation/devicetree/bindings/regulator/adi,max77541.yaml
> new file mode 100644
> index 000000000000..1f828895ab3a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/regulator/adi,max77541.yaml
> @@ -0,0 +1,44 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/regulator/adi,max77541.yaml#
Filename matching compatible, so adi,max77541-regulator.yaml
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Buck Converter driver for MAX77540/MAX77541
Drop "driver" and any other references to Linux drivers.
> +
> +maintainers:
> + - Okan Sahin <[email protected]>
> +
> +description: |
> + This is a part of device tree bindings for ADI MAX77540/MAX77541
> +
> + The buck convertere is represented as a sub-node of the PMIC node on the device tree.
Typo, converter
> +
> + The device has two buck regulators.
> + See also Documentation/devicetree/bindings/mfd/adi,max77541.yaml for
> + additional information and example.
> +
> +properties:
> + compatible:
> + enum:
> + - adi,max77540-regulator
> + - adi,max77541-regulator
> +
> +patternProperties:
> + "^BUCK[12]$":
Does not look like you tested the bindings. Please run `make
dt_binding_check` (see
Documentation/devicetree/bindings/writing-schema.rst for instructions).
> + type: object
> + $ref: regulator.yaml#
> + additionalProperties: false
> + description: |
> + Buck regulator.
> +
> + properties:
> + regulator-name: true
> + regulator-always-on: true
> + regulator-boot-on: true
> + regulator-min-microvolt:
> + minimum: 300000
> + regulator-max-microvolt:
> + maximum: 5200000
> +
> +additionalProperties: false
> \ No newline at end of file
Check your patches before sending...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 5704ed5afce3..8e5572b28a8c 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -12502,6 +12502,7 @@ M: Okan Sahin <[email protected]>
> L: [email protected]
> S: Maintained
> F: Documentation/devicetree/bindings/mfd/adi,max77541.yaml
> +F: Documentation/devicetree/bindings/regulator/adi,max77541.yaml
> F: drivers/mfd/max77541.c
> F: drivers/regulator/max77541-regulator.c
> F: include/linux/mfd/max77541.h
Best regards,
Krzysztof
On Wed, 07 Dec 2022 12:08:43 +0300, Okan Sahin wrote:
> This patch adds document the bindings for MAX77541 and MAX77540
> regulator drivers.
>
> Signed-off-by: Okan Sahin <[email protected]>
> ---
> .../bindings/regulator/adi,max77541.yaml | 44 +++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 45 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/regulator/adi,max77541.yaml
>
My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):
yamllint warnings/errors:
./Documentation/devicetree/bindings/regulator/adi,max77541.yaml:44:28: [error] no new line character at the end of file (new-line-at-end-of-file)
dtschema/dtc warnings/errors:
doc reference errors (make refcheckdocs):
Documentation/devicetree/bindings/regulator/adi,max77541.yaml: Documentation/devicetree/bindings/mfd/adi,max77541.yaml
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.