[RFC,1/5] dt-bindings: sound: Add Apple Macs sound system

Commit Message

Martin Povišer March 31, 2022, 12:04 a.m. UTC

Add binding for Apple Silicon Macs' machine-level sound system.

Signed-off-by: Martin Povišer <[e-mail]>
---
 .../bindings/sound/apple,macaudio.yaml        | 103 ++++++++++++++++++
 1 file changed, 103 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/apple,macaudio.yaml

Patch

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 <[e-mail]>
+
+definitions:
+  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
+  "#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).
+        $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"
+    required:
+      - reg
+      - cpu
+      - codec
+    additionalProperties: false
+
+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>;
+        };
+      };
+
+      dai-link@1 {
+        reg = <1>;
+        link-name = "Headphones Jack";
+        mclk-fs = <64>;
+
+        cpu {
+          sound-dai = <&mca 2>;
+        };
+        codec {
+          sound-dai = <&jack_codec>;
+        };
+      };
+    };