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