xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/sound/qcom,q6asm.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunQualcomm Audio Stream Manager (Q6ASM) binding
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunQ6ASM is one of the APR audio service on Q6DSP.
4*4882a593SmuzhiyunPlease refer to qcom,apr.txt for details of the common apr service bindings
5*4882a593Smuzhiyunused by the apr service device.
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun- but must contain the following property:
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun- compatible:
10*4882a593Smuzhiyun	Usage: required
11*4882a593Smuzhiyun	Value type: <stringlist>
12*4882a593Smuzhiyun	Definition: must be "qcom,q6asm-v<MAJOR-NUMBER>.<MINOR-NUMBER>".
13*4882a593Smuzhiyun		    Or "qcom,q6asm" where the version number can be queried
14*4882a593Smuzhiyun		    from DSP.
15*4882a593Smuzhiyun		    example "qcom,q6asm-v2.0"
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun= ASM DAIs (Digial Audio Interface)
18*4882a593Smuzhiyun"dais" subnode of the ASM node represents dai specific configuration
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun- compatible:
21*4882a593Smuzhiyun	Usage: required
22*4882a593Smuzhiyun	Value type: <stringlist>
23*4882a593Smuzhiyun	Definition: must be "qcom,q6asm-dais".
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun- #sound-dai-cells
26*4882a593Smuzhiyun	Usage: required
27*4882a593Smuzhiyun	Value type: <u32>
28*4882a593Smuzhiyun	Definition: Must be 1
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun== ASM DAI is subnode of "dais" and represent a dai, it includes board specific
31*4882a593Smuzhiyunconfiguration of each dai. Must contain the following properties.
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun- reg
34*4882a593Smuzhiyun	Usage: required
35*4882a593Smuzhiyun	Value type: <u32>
36*4882a593Smuzhiyun	Definition: Must be dai id
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun- direction:
39*4882a593Smuzhiyun	Usage: Required for Compress offload dais
40*4882a593Smuzhiyun	Value type: <u32>
41*4882a593Smuzhiyun	Definition: Specifies the direction of the dai stream
42*4882a593Smuzhiyun			Q6ASM_DAI_TX_RX (0) for both tx and rx
43*4882a593Smuzhiyun			Q6ASM_DAI_TX (1) for only tx (Capture/Encode)
44*4882a593Smuzhiyun			Q6ASM_DAI_RX (2) for only rx (Playback/Decode)
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun- is-compress-dai:
47*4882a593Smuzhiyun	Usage: Required for Compress offload dais
48*4882a593Smuzhiyun	Value type: <boolean>
49*4882a593Smuzhiyun	Definition: present for Compress offload dais
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun= EXAMPLE
53*4882a593Smuzhiyun#include <dt-bindings/sound/qcom,q6asm.h>
54*4882a593Smuzhiyun
55*4882a593Smuzhiyunapr-service@7 {
56*4882a593Smuzhiyun	compatible = "qcom,q6asm";
57*4882a593Smuzhiyun	reg = <APR_SVC_ASM>;
58*4882a593Smuzhiyun	q6asmdai: dais {
59*4882a593Smuzhiyun		compatible = "qcom,q6asm-dais";
60*4882a593Smuzhiyun		#address-cells = <1>;
61*4882a593Smuzhiyun		#size-cells = <0>;
62*4882a593Smuzhiyun		#sound-dai-cells = <1>;
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun		dai@0 {
65*4882a593Smuzhiyun			reg = <0>;
66*4882a593Smuzhiyun			direction = <Q6ASM_DAI_RX>;
67*4882a593Smuzhiyun			is-compress-dai;
68*4882a593Smuzhiyun		};
69*4882a593Smuzhiyun	};
70*4882a593Smuzhiyun};
71