diff mbox series

[2/2] ASoC: dt-bindings: sma1303: Iron Device SMA1303 Amp

Message ID 20220817032938.2659-3-kiseok.jo@irondevice.com (mailing list archive)
State Superseded
Headers show
Series ASoC: Add a driver for the Iron Device SMA1303 Amp | expand

Commit Message

Ki-Seok Jo Aug. 17, 2022, 3:29 a.m. UTC
This adds the schema binding for the Iron Device SMA1303 amplifier.

Signed-off-by: Kiseok Jo <kiseok.jo@irondevice.com>
---
 .../bindings/sound/irondevice,sma1303.yaml    | 56 +++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/irondevice,sma1303.yaml

Comments

Rob Herring (Arm) Aug. 18, 2022, 3:43 p.m. UTC | #1
On Wed, Aug 17, 2022 at 12:29:38PM +0900, Kiseok Jo wrote:
> This adds the schema binding for the Iron Device SMA1303 amplifier.
> 
> Signed-off-by: Kiseok Jo <kiseok.jo@irondevice.com>
> ---
>  .../bindings/sound/irondevice,sma1303.yaml    | 56 +++++++++++++++++++
>  1 file changed, 56 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/irondevice,sma1303.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/irondevice,sma1303.yaml b/Documentation/devicetree/bindings/sound/irondevice,sma1303.yaml
> new file mode 100644
> index 000000000000..e11e74d367c0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/irondevice,sma1303.yaml
> @@ -0,0 +1,56 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/irondevice,sma1303.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Iron Device SMA1303 Audio Amplifier
> +
> +maintainers:
> +  - Kiseok Jo <kiseok.jo@irondevice.com>
> +
> +description:
> +  SMA1303 digital class-D audio amplifier with an integrated boost converter.
> +
> +allOf:
> +  - $ref: name-prefix.yaml#
> +
> +properties:
> +  compatible:
> +    const: irondevice,sma1303

'irondevice' needs to be added to vendor-prefixes.yaml

> +
> +  reg:
> +    description:
> +      I2C address of the amplifier. See the datasheet for possible values.
> +
> +  init-vol:

Needs a vendor prefix.

However, why does this belong in DT? I don't recall any other binding 
having something similar.

> +    description:
> +      Initial speaker volume level.
> +      If specified, the driver will assert speaker volume value at probe time.
> +      If not, default hardcoded value(0x30 / 0dB) was reflected.
> +    $ref: "/schemas/types.yaml#/definitions/uint32"
> +    minimum: 0
> +    maximum: 255
> +    default: 49

0x30 or 49?

> +
> +  stereo-two-chip:

vendor prefix needed.

> +    description:
> +      Stereo for two chip solution
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: true
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +    i2c_bus {
> +		sma1303_amp: sma1303@1e {
> +			compatible = "irondevice,sma1303";
> +			reg = <0x1e>;
> +			init-vol = <0x31>;
> +			stereo-two-chip;
> +		};
> +	};
> \ No newline at end of file

Fix this.

> -- 
> 2.30.2
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/irondevice,sma1303.yaml b/Documentation/devicetree/bindings/sound/irondevice,sma1303.yaml
new file mode 100644
index 000000000000..e11e74d367c0
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/irondevice,sma1303.yaml
@@ -0,0 +1,56 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/irondevice,sma1303.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Iron Device SMA1303 Audio Amplifier
+
+maintainers:
+  - Kiseok Jo <kiseok.jo@irondevice.com>
+
+description:
+  SMA1303 digital class-D audio amplifier with an integrated boost converter.
+
+allOf:
+  - $ref: name-prefix.yaml#
+
+properties:
+  compatible:
+    const: irondevice,sma1303
+
+  reg:
+    description:
+      I2C address of the amplifier. See the datasheet for possible values.
+
+  init-vol:
+    description:
+      Initial speaker volume level.
+      If specified, the driver will assert speaker volume value at probe time.
+      If not, default hardcoded value(0x30 / 0dB) was reflected.
+    $ref: "/schemas/types.yaml#/definitions/uint32"
+    minimum: 0
+    maximum: 255
+    default: 49
+
+  stereo-two-chip:
+    description:
+      Stereo for two chip solution
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: true
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    i2c_bus {
+		sma1303_amp: sma1303@1e {
+			compatible = "irondevice,sma1303";
+			reg = <0x1e>;
+			init-vol = <0x31>;
+			stereo-two-chip;
+		};
+	};
\ No newline at end of file