xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/slimbus/slim-ngd-qcom-ctrl.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunQualcomm SLIMBus Non Generic Device (NGD) Controller binding
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunSLIMBus NGD controller is a light-weight driver responsible for communicating
4*4882a593Smuzhiyunwith SLIMBus slaves directly over the bus using messaging interface and
5*4882a593Smuzhiyuncommunicating with master component residing on ADSP for bandwidth and
6*4882a593Smuzhiyundata-channel management
7*4882a593Smuzhiyun
8*4882a593SmuzhiyunPlease refer to slimbus/bus.txt for details of the common SLIMBus bindings.
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun- compatible:
11*4882a593Smuzhiyun	Usage: required
12*4882a593Smuzhiyun	Value type: <stringlist>
13*4882a593Smuzhiyun	Definition: must be "qcom,slim-ngd-v<MAJOR>.<MINOR>.<STEP>"
14*4882a593Smuzhiyun	must be one of the following.
15*4882a593Smuzhiyun	"qcom,slim-ngd-v1.5.0" for MSM8996
16*4882a593Smuzhiyun	"qcom,slim-ngd-v2.1.0" for SDM845
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun- reg:
19*4882a593Smuzhiyun	Usage: required
20*4882a593Smuzhiyun	Value type: <prop-encoded-array>
21*4882a593Smuzhiyun	Definition: must specify the base address and size of the controller
22*4882a593Smuzhiyun		    register space.
23*4882a593Smuzhiyun- dmas
24*4882a593Smuzhiyun	Usage: required
25*4882a593Smuzhiyun	Value type: <array of phandles>
26*4882a593Smuzhiyun	Definition: List of rx and tx dma channels
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun- dma-names
29*4882a593Smuzhiyun	Usage: required
30*4882a593Smuzhiyun	Value type: <stringlist>
31*4882a593Smuzhiyun	Definition: must be "rx" and "tx".
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun- interrupts:
34*4882a593Smuzhiyun	Usage: required
35*4882a593Smuzhiyun	Value type: <prop-encoded-array>
36*4882a593Smuzhiyun	Definition: must list controller IRQ.
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun#address-cells
39*4882a593Smuzhiyun	Usage: required
40*4882a593Smuzhiyun	Value type: <u32>
41*4882a593Smuzhiyun	Definition: Should be 1, reflecting the instance id of ngd.
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun#size-cells
44*4882a593Smuzhiyun	Usage: required
45*4882a593Smuzhiyun	Value type: <u32>
46*4882a593Smuzhiyun	Definition: Should be 0
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun= NGD Devices
49*4882a593SmuzhiyunEach subnode represents an instance of NGD, must contain the following
50*4882a593Smuzhiyunproperties:
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun- reg:
53*4882a593Smuzhiyun	Usage: required
54*4882a593Smuzhiyun	Value type: <u32>
55*4882a593Smuzhiyun	Definition: Should be instance id of ngd.
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun#address-cells
58*4882a593Smuzhiyun	Usage: required
59*4882a593Smuzhiyun	Refer to slimbus/bus.txt for details of the common SLIMBus bindings.
60*4882a593Smuzhiyun
61*4882a593Smuzhiyun#size-cells
62*4882a593Smuzhiyun	Usage: required
63*4882a593Smuzhiyun	Refer to slimbus/bus.txt for details of the common SLIMBus bindings.
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun= EXAMPLE
66*4882a593Smuzhiyun
67*4882a593Smuzhiyunslim@91c0000 {
68*4882a593Smuzhiyun	compatible = "qcom,slim-ngd-v1.5.0";
69*4882a593Smuzhiyun	reg = <0x91c0000 0x2c000>;
70*4882a593Smuzhiyun	interrupts = <0 163 0>;
71*4882a593Smuzhiyun	dmas =	<&slimbam 3>, <&slimbam 4>;
72*4882a593Smuzhiyun	dma-names = "rx", "tx";
73*4882a593Smuzhiyun	#address-cells = <1>;
74*4882a593Smuzhiyun	#size-cells = <0>;
75*4882a593Smuzhiyun	ngd@1 {
76*4882a593Smuzhiyun		reg = <1>;
77*4882a593Smuzhiyun		#address-cells = <1>;
78*4882a593Smuzhiyun		#size-cells = <1>;
79*4882a593Smuzhiyun		codec@1 {
80*4882a593Smuzhiyun			compatible = "slim217,1a0";
81*4882a593Smuzhiyun			reg  = <1 0>;
82*4882a593Smuzhiyun		};
83*4882a593Smuzhiyun	};
84*4882a593Smuzhiyun};
85