Add binding for Apple Silicon Macs' machine-level integration of sound
peripherals.
Signed-off-by: Martin Povišer <[email protected]>
---
.../bindings/sound/apple,macaudio.yaml | 157 ++++++++++++++++++
1 file changed, 157 insertions(+)
create mode 100644 Documentation/devicetree/bindings/sound/apple,macaudio.yaml
diff --git a/Documentation/devicetree/bindings/sound/apple,macaudio.yaml b/Documentation/devicetree/bindings/sound/apple,macaudio.yaml
new file mode 100644
index 000000000000..f7c12697beab
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/apple,macaudio.yaml
@@ -0,0 +1,157 @@
+# 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 peripherals
+
+description: |
+ This binding represents the overall machine-level integration of sound
+ peripherals on 'Apple Silicon' machines by Apple.
+
+maintainers:
+ - Martin Povišer <[email protected]>
+
+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 for presentation to users
+ $ref: /schemas/types.yaml#/definitions/string
+
+patternProperties:
+ "^dai-link(@[0-9a-f]+)?$":
+ description: |
+ Node for each sound peripheral such as the speaker array, headphones jack,
+ or microphone.
+ type: object
+ properties:
+ reg:
+ maxItems: 1
+
+ link-name:
+ description: |
+ Name for the peripheral, expecting 'Speaker' or 'Speakers' if this is
+ the speaker array.
+ $ref: /schemas/types.yaml#/definitions/string
+
+ cpu:
+ type: object
+ properties:
+ sound-dai:
+ description: |
+ DAI list with CPU-side I2S ports involved in this peripheral.
+ minItems: 1
+ maxItems: 2
+ required:
+ - sound-dai
+
+ codec:
+ type: object
+ properties:
+ sound-dai:
+ description: |
+ DAI list with the CODEC-side DAIs connected to the above CPU-side
+ DAIs and involved in this sound peripheral.
+
+ The list is in left/right order if applicable. If there are more
+ than one CPU-side DAIs (there can be two), the CODECs must be
+ listed first those connected to the first CPU, then those
+ connected to the second.
+
+ In addition, on some machines with many speaker codecs, the CODECs
+ are listed in this fixed order:
+
+ J293: Left Front, Left Rear, Right Front, Right Rear
+ J314: Left Woofer 1, Left Tweeter, Left Woofer 2,
+ Right Woofer 1, Right Tweeter, Right Woofer 2
+ minItems: 1
+ maxItems: 8
+ required:
+ - sound-dai
+
+ required:
+ - reg
+ - cpu
+ - codec
+
+ additionalProperties: false
+
+required:
+ - compatible
+ - model
+
+additionalProperties: false
+
+examples:
+ - |
+ mca: mca@9b600000 {
+ compatible = "apple,t6000-mca", "apple,mca";
+ reg = <0x9b600000 0x10000>,
+ <0x9b500000 0x20000>;
+
+ clocks = <&nco 0>, <&nco 1>, <&nco 2>, <&nco 3>;
+ power-domains = <&ps_audio_p>, <&ps_mca0>, <&ps_mca1>,
+ <&ps_mca2>, <&ps_mca3>;
+ dmas = <&admac 0>, <&admac 1>, <&admac 2>, <&admac 3>,
+ <&admac 4>, <&admac 5>, <&admac 6>, <&admac 7>,
+ <&admac 8>, <&admac 9>, <&admac 10>, <&admac 11>,
+ <&admac 12>, <&admac 13>, <&admac 14>, <&admac 15>;
+ dma-names = "tx0a", "rx0a", "tx0b", "rx0b",
+ "tx1a", "rx1a", "tx1b", "rx1b",
+ "tx2a", "rx2a", "tx2b", "rx2b",
+ "tx3a", "rx3a", "tx3b", "rx3b";
+
+ #sound-dai-cells = <1>;
+ };
+
+ sound {
+ compatible = "apple,j314-macaudio", "apple,macaudio";
+ model = "MacBook Pro J314 integrated audio";
+
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ dai-link@0 {
+ reg = <0>;
+ link-name = "Speakers";
+
+ cpu {
+ sound-dai = <&mca 0>, <&mca 1>;
+ };
+ codec {
+ sound-dai = <&speaker_left_woof1>,
+ <&speaker_left_tweet>,
+ <&speaker_left_woof2>,
+ <&speaker_right_woof1>,
+ <&speaker_right_tweet>,
+ <&speaker_right_woof2>;
+ };
+ };
+
+ dai-link@1 {
+ reg = <1>;
+ link-name = "Headphones Jack";
+
+ cpu {
+ sound-dai = <&mca 2>;
+ };
+ codec {
+ sound-dai = <&jack_codec>;
+ };
+ };
+ };
--
2.33.0
On Mon, Jun 06, 2022 at 09:19:07PM +0200, Martin Povišer wrote:
> + dai-link@1 {
> + reg = <1>;
> + link-name = "Headphones Jack";
Incredibly trivial bikeshed but normally that'd be "Headphone Jack"
(singular).
On Mon, Jun 06, 2022 at 09:19:07PM +0200, Martin Povišer wrote:
> Add binding for Apple Silicon Macs' machine-level integration of sound
> peripherals.
>
> Signed-off-by: Martin Povišer <[email protected]>
> ---
> .../bindings/sound/apple,macaudio.yaml | 157 ++++++++++++++++++
> 1 file changed, 157 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/sound/apple,macaudio.yaml
>
> diff --git a/Documentation/devicetree/bindings/sound/apple,macaudio.yaml b/Documentation/devicetree/bindings/sound/apple,macaudio.yaml
> new file mode 100644
> index 000000000000..f7c12697beab
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/apple,macaudio.yaml
> @@ -0,0 +1,157 @@
> +# 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 peripherals
> +
> +description: |
> + This binding represents the overall machine-level integration of sound
> + peripherals on 'Apple Silicon' machines by Apple.
> +
> +maintainers:
> + - Martin Povišer <[email protected]>
> +
> +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: |
Don't need '|' if there's no formatting to preserve.
> + Model name for presentation to users
> + $ref: /schemas/types.yaml#/definitions/string
> +
> +patternProperties:
> + "^dai-link(@[0-9a-f]+)?$":
> + description: |
> + Node for each sound peripheral such as the speaker array, headphones jack,
> + or microphone.
> + type: object
blank line
> + properties:
> + reg:
> + maxItems: 1
> +
> + link-name:
> + description: |
> + Name for the peripheral, expecting 'Speaker' or 'Speakers' if this is
> + the speaker array.
> + $ref: /schemas/types.yaml#/definitions/string
> +
> + cpu:
> + type: object
additionalProperties: false
blank line before properties.
> + properties:
> + sound-dai:
> + description: |
> + DAI list with CPU-side I2S ports involved in this peripheral.
> + minItems: 1
> + maxItems: 2
blank line
> + required:
> + - sound-dai
> +
> + codec:
> + type: object
blank line
> + properties:
> + sound-dai:
> + description: |
> + DAI list with the CODEC-side DAIs connected to the above CPU-side
> + DAIs and involved in this sound peripheral.
> +
> + The list is in left/right order if applicable. If there are more
> + than one CPU-side DAIs (there can be two), the CODECs must be
> + listed first those connected to the first CPU, then those
> + connected to the second.
> +
> + In addition, on some machines with many speaker codecs, the CODECs
> + are listed in this fixed order:
> +
> + J293: Left Front, Left Rear, Right Front, Right Rear
> + J314: Left Woofer 1, Left Tweeter, Left Woofer 2,
> + Right Woofer 1, Right Tweeter, Right Woofer 2
> + minItems: 1
> + maxItems: 8
blank line
> + required:
> + - sound-dai
> +
> + required:
> + - reg
> + - cpu
> + - codec
> +
> + additionalProperties: false
I prefer this to be above 'properties' in the indented cases.
> +
> +required:
> + - compatible
> + - model
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + mca: mca@9b600000 {
> + compatible = "apple,t6000-mca", "apple,mca";
> + reg = <0x9b600000 0x10000>,
> + <0x9b500000 0x20000>;
> +
> + clocks = <&nco 0>, <&nco 1>, <&nco 2>, <&nco 3>;
> + power-domains = <&ps_audio_p>, <&ps_mca0>, <&ps_mca1>,
> + <&ps_mca2>, <&ps_mca3>;
> + dmas = <&admac 0>, <&admac 1>, <&admac 2>, <&admac 3>,
> + <&admac 4>, <&admac 5>, <&admac 6>, <&admac 7>,
> + <&admac 8>, <&admac 9>, <&admac 10>, <&admac 11>,
> + <&admac 12>, <&admac 13>, <&admac 14>, <&admac 15>;
> + dma-names = "tx0a", "rx0a", "tx0b", "rx0b",
> + "tx1a", "rx1a", "tx1b", "rx1b",
> + "tx2a", "rx2a", "tx2b", "rx2b",
> + "tx3a", "rx3a", "tx3b", "rx3b";
> +
> + #sound-dai-cells = <1>;
> + };
> +
> + sound {
> + compatible = "apple,j314-macaudio", "apple,macaudio";
> + model = "MacBook Pro J314 integrated audio";
> +
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + dai-link@0 {
> + reg = <0>;
> + link-name = "Speakers";
> +
> + cpu {
> + sound-dai = <&mca 0>, <&mca 1>;
> + };
> + codec {
> + sound-dai = <&speaker_left_woof1>,
> + <&speaker_left_tweet>,
> + <&speaker_left_woof2>,
> + <&speaker_right_woof1>,
> + <&speaker_right_tweet>,
> + <&speaker_right_woof2>;
> + };
> + };
> +
> + dai-link@1 {
> + reg = <1>;
> + link-name = "Headphones Jack";
> +
> + cpu {
> + sound-dai = <&mca 2>;
> + };
> + codec {
> + sound-dai = <&jack_codec>;
> + };
> + };
> + };
> --
> 2.33.0
>
>