summaryrefslogtreecommitdiff
path: root/bindings/soc/qcom/qcom,glink-slatecom-xprt.txt
blob: b49bc3c79278c9ec080776ed5326dbe25a560123 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
Qualcomm Technologies, Inc GLINK SLATECOM transport (glink_slatecom_xprt) binding

This binding describes the Qualcomm Technologies, Inc glink slatecom transport
driver, a slatecom-spi based communication channel for sending data between the
various subsystems in Qualcomm Technologies, Inc platforms.

- compatible:
	Usage: required
	Value type: <stringlist>
	Definition: must be "qcom,glink-slatecom-xprt"

- label:
	Usage: required
	Value type: <stringlist>
	Definition: must be "slate"

= EXAMPLE

The following example reprsents a glink_slatecom node.

	qcom,glink-slatecom-xprt-slate {
		compatible = "qcom,glink-slatecom-xprt";
		label = "slate";
	};

= AUDIO_CC_IPC_PLATFORM
This node is defined as the platform driver with cc codec as the child device.
- compatible:
	Usage: required
	Value type: <stringlist>
	Definition: must be "qcom,audio-cc-ipc-platform"

= EXAMPLE

	qcom,audio-cc-ipc-platform {
		compatible = "qcom,audio-cc-ipc-platform";
	};

= AUDIO_CC_IPC_NODE
Each subnode of the glink_slatecom_xprt is a device node exposed to user space
by the audio-cc-ipc driver for sending ipc packets between the ipc clients.
Maximum nodes supported is 2.
- Each node defined should contain following property

- compatible:
	Usage: required
	Value type: <stringlist>
	Definition: must be "qcom,audio_cc_ipc"

- qcom,glink-channels:
	Usage: required
	Value type: <stringlist>

- reg:
	Usage: required
	Value type: <u32>

- cdev_name:
	Usage: required
	Value type: <stringlist>

= CC_CODEC_NODE
Audio_cc_ipc nodes can have a cc_codec child node. This node will act as an
interface for proxy codec, to manage the communication to its counter part
through ipc.
- Each node defined should contain following property

- compatible:
	Usage: required
	Value type: <stringlist>
	Definition: must be "qcom,cc-codec"

= EXAMPLE
The following example represents the audio-cc-ipc node having a codec child node

	audio_ipc1: qcom,audio_cc_ipc1 {
		compatible = "qcom,audio_cc_ipc";
		qcom,glink-channels = "custom_cc_apps";
		qcom,intents = <0x2000 2>;
		reg = <GPR_DOMAIN_ADSP>;
		cdev_name = "nongpr_channel";

		cc_codec: qcom,cc-codec {
			compatible = "qcom, cc-codec";
		};
	};