xref: /linux/Documentation/devicetree/bindings/sound/fsl,mqs.yaml (revision a9e6060bb2a6cae6d43a98ec0794844ad01273d3) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/sound/fsl,mqs.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: NXP Medium Quality Sound (MQS)
8
9maintainers:
10  - Shengjiu Wang <shengjiu.wang@nxp.com>
11  - Chancel Liu <chancel.liu@nxp.com>
12
13description: |
14  Medium quality sound (MQS) is used to generate medium quality audio
15  via a standard GPIO in the pinmux, allowing the user to connect
16  stereo speakers or headphones to a power amplifier without an
17  additional DAC chip.
18
19properties:
20  compatible:
21    enum:
22      - fsl,imx6sx-mqs
23      - fsl,imx8qm-mqs
24      - fsl,imx8qxp-mqs
25      - fsl,imx93-mqs
26      - fsl,imx943-aonmix-mqs
27      - fsl,imx943-wakeupmix-mqs
28      - fsl,imx95-aonmix-mqs
29      - fsl,imx95-netcmix-mqs
30
31  "#sound-dai-cells":
32    const: 0
33
34  clocks:
35    minItems: 1
36    maxItems: 2
37
38  clock-names:
39    minItems: 1
40    maxItems: 2
41
42  gpr:
43    $ref: /schemas/types.yaml#/definitions/phandle
44    description: The phandle to the General Purpose Register (GPR) node
45
46  reg:
47    maxItems: 1
48
49  power-domains:
50    maxItems: 1
51
52  resets:
53    maxItems: 1
54
55  port:
56    $ref: audio-graph-port.yaml#
57    unevaluatedProperties: false
58
59required:
60  - compatible
61  - clocks
62  - clock-names
63
64allOf:
65  - $ref: dai-common.yaml#
66  - if:
67      properties:
68        compatible:
69          contains:
70            enum:
71              - fsl,imx8qm-mqs
72              - fsl,imx8qxp-mqs
73    then:
74      properties:
75        clocks:
76          items:
77            - description: Master clock
78            - description: Clock for register access
79        clock-names:
80          items:
81            - const: mclk
82            - const: core
83      required:
84        - reg
85        - power-domains
86    else:
87      properties:
88        clocks:
89          items:
90            - description: Master clock
91        clock-names:
92          items:
93            - const: mclk
94      required:
95        - gpr
96
97unevaluatedProperties: false
98
99examples:
100  - |
101    #include <dt-bindings/clock/imx6sx-clock.h>
102    mqs0: mqs {
103        compatible = "fsl,imx6sx-mqs";
104        gpr = <&gpr>;
105        clocks = <&clks IMX6SX_CLK_SAI1>;
106        clock-names = "mclk";
107    };
108
109  - |
110    #include <dt-bindings/firmware/imx/rsrc.h>
111    mqs1: mqs@59850000 {
112        compatible = "fsl,imx8qm-mqs";
113        reg = <0x59850000 0x10000>;
114        clocks = <&mqs0_lpcg 0>, <&mqs0_lpcg 1>;
115        clock-names = "mclk", "core";
116        power-domains = <&pd IMX_SC_R_MQS_0>;
117    };
118