GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / devicetree / bindings / sound / qcom,q6asm-dais.yaml
1 # SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/sound/qcom,q6asm-dais.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Qualcomm Audio Stream Manager (Q6ASM)
8
9 maintainers:
10   - Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
11   - Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
12
13 description:
14   Q6ASM is one of the APR audio services on Q6DSP. Each of its subnodes
15   represent a dai with board specific configuration.
16
17 properties:
18   compatible:
19     enum:
20       - qcom,q6asm-dais
21
22   iommus:
23     maxItems: 1
24
25   "#sound-dai-cells":
26     const: 1
27
28   "#address-cells":
29     const: 1
30
31   "#size-cells":
32     const: 0
33
34 patternProperties:
35   "^dai@[0-9]+$":
36     type: object
37     description:
38       Q6ASM Digital Audio Interface
39
40     properties:
41       reg:
42         maxItems: 1
43
44       direction:
45         $ref: /schemas/types.yaml#/definitions/uint32
46         enum: [0, 1, 2]
47         description: |
48           The direction of the dai stream::
49            - Q6ASM_DAI_TX_RX (0) for both tx and rx
50            - Q6ASM_DAI_TX (1) for only tx (Capture/Encode)
51            - Q6ASM_DAI_RX (2) for only rx (Playback/Decode)
52
53       is-compress-dai:
54         type: boolean
55         description:
56           Compress offload dai.
57
58     dependencies:
59       is-compress-dai: ["direction"]
60
61     required:
62       - reg
63
64     additionalProperties: false
65
66 required:
67   - compatible
68   - "#sound-dai-cells"
69   - "#address-cells"
70   - "#size-cells"
71
72 additionalProperties: false
73
74 examples:
75   - |
76     #include <dt-bindings/soc/qcom,apr.h>
77     #include <dt-bindings/sound/qcom,q6asm.h>
78
79     apr {
80         compatible = "qcom,apr-v2";
81         qcom,domain = <APR_DOMAIN_ADSP>;
82         #address-cells = <1>;
83         #size-cells = <0>;
84
85         service@7 {
86             compatible = "qcom,q6asm";
87             reg = <APR_SVC_ASM>;
88             qcom,protection-domain = "avs/audio", "msm/adsp/audio_pd";
89
90             dais {
91                 compatible = "qcom,q6asm-dais";
92                 iommus = <&apps_smmu 0x1821 0x0>;
93                 #address-cells = <1>;
94                 #size-cells = <0>;
95                 #sound-dai-cells = <1>;
96
97                 dai@0 {
98                     reg = <0>;
99                 };
100
101                 dai@1 {
102                     reg = <1>;
103                 };
104
105                 dai@2 {
106                     reg = <2>;
107                     is-compress-dai;
108                     direction = <1>;
109                 };
110             };
111         };
112     };