Convert Documentation/bindings/devicetree/alc5623.txt to yaml.
First attempt at a dt schema conversion patch.
Checked the yaml file with make dt_binding_check and make CHECK_DTBS=y.
Only warning being produced is
Documentation/devicetree/bindings/net/snps,dwmac.yaml: mac-mode: missing type definition
Not sure how I should handle this.
Signed-off-by: Aryabhatta Dey <[email protected]>
---
.../devicetree/bindings/sound/alc5623.txt | 25 ----------
.../bindings/sound/realtek,alc5623.yaml | 48 +++++++++++++++++++
2 files changed, 48 insertions(+), 25 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/sound/alc5623.txt
create mode 100644 Documentation/devicetree/bindings/sound/realtek,alc5623.yaml
diff --git a/Documentation/devicetree/bindings/sound/alc5623.txt b/Documentation/devicetree/bindings/sound/alc5623.txt
deleted file mode 100644
index 26c86c98d671..000000000000
--- a/Documentation/devicetree/bindings/sound/alc5623.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-ALC5621/ALC5622/ALC5623 audio Codec
-
-Required properties:
-
- - compatible: "realtek,alc5623"
- - reg: the I2C address of the device.
-
-Optional properties:
-
- - add-ctrl: Default register value for Reg-40h, Additional Control
- Register. If absent or has the value of 0, the
- register is untouched.
-
- - jack-det-ctrl: Default register value for Reg-5Ah, Jack Detect
- Control Register. If absent or has value 0, the
- register is untouched.
-
-Example:
-
- alc5621: alc5621@1a {
- compatible = "alc5621";
- reg = <0x1a>;
- add-ctrl = <0x3700>;
- jack-det-ctrl = <0x4810>;
- };
diff --git a/Documentation/devicetree/bindings/sound/realtek,alc5623.yaml b/Documentation/devicetree/bindings/sound/realtek,alc5623.yaml
new file mode 100644
index 000000000000..207386e6d437
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/realtek,alc5623.yaml
@@ -0,0 +1,48 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/realtek,alc5623.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ALC5621/ALC5622/ALC5623 audio Codec
+
+maintainers:
+ - Aryabhatta Dey <[email protected]>
+
+properties:
+ compatible:
+ const: realtek,alc5623
+
+ reg:
+ maxItems: 1
+
+ add-ctrl:
+ description:
+ Default register value for Reg-40h, Additional Control Register. If absent
+ or has the value of 0, the register is untouched.
+ type: object
+
+ jack-det-ctrl:
+ description:
+ Default register value for Reg-5Ah, Jack Detect Control Register. If absent
+ or has value 0, the register is untouched.
+ type: object
+
+required:
+ - compatible
+ - reg
+
+additionalProperties: false
+
+examples:
+ - |
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ codec@1a {
+ compatible = "realtek,alc5632";
+ reg = <0x1a>;
+ add-ctrl = <0x3700>;
+ jack-det-ctrl = <0x4810>;
+ };
+ };
--
2.45.0
On Sat, 11 May 2024 10:11:24 +0530, Aryabhatta Dey wrote:
> Convert Documentation/bindings/devicetree/alc5623.txt to yaml.
>
> First attempt at a dt schema conversion patch.
> Checked the yaml file with make dt_binding_check and make CHECK_DTBS=y.
> Only warning being produced is
> Documentation/devicetree/bindings/net/snps,dwmac.yaml: mac-mode: missing type definition
> Not sure how I should handle this.
>
> Signed-off-by: Aryabhatta Dey <[email protected]>
> ---
> .../devicetree/bindings/sound/alc5623.txt | 25 ----------
> .../bindings/sound/realtek,alc5623.yaml | 48 +++++++++++++++++++
> 2 files changed, 48 insertions(+), 25 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/sound/alc5623.txt
> create mode 100644 Documentation/devicetree/bindings/sound/realtek,alc5623.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/sound/realtek,alc5623.example.dtb: codec@1a: '#gpio-cells' is a required property
from schema $id: http://devicetree.org/schemas/sound/realtek,alc5632.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/sound/realtek,alc5623.example.dtb: codec@1a: 'gpio-controller' is a required property
from schema $id: http://devicetree.org/schemas/sound/realtek,alc5632.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/sound/realtek,alc5623.example.dtb: codec@1a: 'add-ctrl', 'jack-det-ctrl' do not match any of the regexes: 'pinctrl-[0-9]+'
from schema $id: http://devicetree.org/schemas/sound/realtek,alc5632.yaml#
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/j2f5m3lydlkipt3vnyikeoq5bx6tsf6z22ljpspcgtnohy65on@htyjjd3ojkde
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.