lkml.org 
[lkml]   [2022]   [Mar]   [31]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [RFC PATCH 1/5] dt-bindings: sound: Add Apple Macs sound system
From
On 31/03/2022 02:04, Martin Povišer wrote:
> Add binding for Apple Silicon Macs' machine-level sound system.
>
> Signed-off-by: Martin Povišer <povik+lin@cutebit.org>
> ---
> .../bindings/sound/apple,macaudio.yaml | 103 ++++++++++++++++++
> 1 file changed, 103 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/sound/apple,macaudio.yaml
>

Commit title does not match subsystem.

> diff --git a/Documentation/devicetree/bindings/sound/apple,macaudio.yaml b/Documentation/devicetree/bindings/sound/apple,macaudio.yaml
> new file mode 100644
> index 000000000000..a6380e4bdd1a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/apple,macaudio.yaml
> @@ -0,0 +1,103 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/apple,macaudio.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Apple Silicon Macs integrated sound system
> +
> +maintainers:
> + - Martin Povišer <povik+lin@cutebit.org>
> +

Add description.

> +definitions:

This does not make code more readable.

> + dai:
> + type: object
> + properties:
> + sound-dai: true
> + required:
> + - sound-dai
> +
> +properties:
> + compatible:
> + items:
> + - enum:
> + - apple,j274-macaudio
> + - apple,j293-macaudio
> + - apple,j314-macaudio
> + - const: apple,macaudio

Open example-schema.yaml and look at formatting plus general coding
style. You miss line breaks making it unreadable.

> + "#address-cells":
> + const: 1
> + "#size-cells":
> + const: 0
> + model:
> + description: |
> + Model name to use when the sound system is presented to users as a sound card.
> + $ref: /schemas/types.yaml#/definitions/string
> +
> +patternProperties:
> + "^dai-link(@[0-9a-f]+)?$":
> + description: |
> + A DAI link comprising of CPU and CODEC DAI specifiers and supplemental properties.
> + type: object
> + properties:
> + reg:
> + maxItems: 1
> + mclk-fs:
> + description: |
> + Forced MCLK/samplerate factor (optional).

Optional is obvious from !required.

Description is different than existing field in simple card. Is this the
same field or not?

> + $ref: /schemas/types.yaml#/definitions/uint32
> + link-name:
> + description: Name for the DAI link to present to users.
> + $ref: /schemas/types.yaml#/definitions/string
> + cpu:
> + $ref: "#/definitions/dai"
> + codec:
> + $ref: "#/definitions/dai"

missing maxItems for DAI phandles.

> + required:
> + - reg
> + - cpu
> + - codec
> + additionalProperties: false

This entire block is unreadable.

> +
> +required:
> + - compatible
> + - model
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + sound {
> + compatible = "apple,j293-macaudio", "apple,macaudio";
> + model = "MacBook Pro J293 integrated audio";
> +
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + dai-link@0 {
> + reg = <0>;
> + link-name = "Speakers";
> + mclk-fs = <64>;
> +
> + cpu {
> + sound-dai = <&mca 0>, <&mca 1>;
> + };
> + codec {
> + sound-dai = <&speaker_left_front>, <&speaker_right_front>,
> + <&speaker_left_rear>, <&speaker_right_rear>;

Align the line.

> + };
> + };
> +
> + dai-link@1 {
> + reg = <1>;
> + link-name = "Headphones Jack";
> + mclk-fs = <64>;
> +
> + cpu {
> + sound-dai = <&mca 2>;
> + };
> + codec {
> + sound-dai = <&jack_codec>;
> + };
> + };
> + };


Best regards,
Krzysztof

\
 
 \ /
  Last update: 2022-03-31 08:44    [W:0.965 / U:1.564 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site