xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/hsi/client-devices.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunEach HSI port is supposed to have one child node, which
2*4882a593Smuzhiyunsymbols the remote device connected to the HSI port. The
3*4882a593Smuzhiyunfollowing properties are standardized for HSI clients:
4*4882a593Smuzhiyun
5*4882a593SmuzhiyunRequired HSI configuration properties:
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun- hsi-channel-ids:	A list of channel ids
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun- hsi-rx-mode:		Receiver Bit transmission mode ("stream" or "frame")
10*4882a593Smuzhiyun- hsi-tx-mode:		Transmitter Bit transmission mode ("stream" or "frame")
11*4882a593Smuzhiyun- hsi-mode:		May be used instead hsi-rx-mode and hsi-tx-mode if
12*4882a593Smuzhiyun			the transmission mode is the same for receiver and
13*4882a593Smuzhiyun			transmitter
14*4882a593Smuzhiyun- hsi-speed-kbps:	Max bit transmission speed in kbit/s
15*4882a593Smuzhiyun- hsi-flow:		RX flow type ("synchronized" or "pipeline")
16*4882a593Smuzhiyun- hsi-arb-mode:		Arbitration mode for TX frame ("round-robin", "priority")
17*4882a593Smuzhiyun
18*4882a593SmuzhiyunOptional HSI configuration properties:
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun- hsi-channel-names:	A list with one name per channel specified in the
21*4882a593Smuzhiyun			hsi-channel-ids property
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun
24*4882a593SmuzhiyunDevice Tree node example for an HSI client:
25*4882a593Smuzhiyun
26*4882a593Smuzhiyunhsi-controller {
27*4882a593Smuzhiyun	hsi-port {
28*4882a593Smuzhiyun		modem: hsi-client {
29*4882a593Smuzhiyun			compatible = "nokia,n900-modem";
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun			hsi-channel-ids = <0>, <1>, <2>, <3>;
32*4882a593Smuzhiyun			hsi-channel-names = "mcsaab-control",
33*4882a593Smuzhiyun					    "speech-control",
34*4882a593Smuzhiyun					    "speech-data",
35*4882a593Smuzhiyun					    "mcsaab-data";
36*4882a593Smuzhiyun			hsi-speed-kbps = <55000>;
37*4882a593Smuzhiyun			hsi-mode = "frame";
38*4882a593Smuzhiyun			hsi-flow = "synchronized";
39*4882a593Smuzhiyun			hsi-arb-mode = "round-robin";
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun			/* more client specific properties */
42*4882a593Smuzhiyun		};
43*4882a593Smuzhiyun	};
44*4882a593Smuzhiyun};
45