[deliverable/linux.git] / Documentation / devicetree / bindings / sound / tdm-slot.txt

TDM slot:

This specifies audio DAI's TDM slot.

TDM slot properties:
dai-tdm-slot-num : Number of slots in use.
dai-tdm-slot-width : Width in bits for each slot.
dai-tdm-slot-tx-mask : Transmit direction slot mask, optional
dai-tdm-slot-rx-mask : Receive direction slot mask, optional

For instance:
	dai-tdm-slot-num = <2>;
	dai-tdm-slot-width = <8>;
	dai-tdm-slot-tx-mask = <0 1>;
	dai-tdm-slot-rx-mask = <1 0>;

And for each spcified driver, there could be one .of_xlate_tdm_slot_mask()
to specify a explicit mapping of the channels and the slots. If it's absent
the default snd_soc_of_xlate_tdm_slot_mask() will be used to generating the
tx and rx masks.

For snd_soc_of_xlate_tdm_slot_mask(), the tx and rx masks will use a 1 bit
for an active slot as default, and the default active bits are at the LSB of
the masks.

The explicit masks are given as array of integers, where the first
number presents bit-0 (LSB), second presents bit-1, etc. Any non zero
number is considered 1 and 0 is 0. snd_soc_of_xlate_tdm_slot_mask()
does not do anything, if either mask is set non zero value.
Commit	Line	Data
72899ad8 XL	1	TDM slot:
	2
	3	This specifies audio DAI's TDM slot.
	4
	5	TDM slot properties:
	6	dai-tdm-slot-num : Number of slots in use.
6131084a JS	7	dai-tdm-slot-width : Width in bits for each slot.
	8	dai-tdm-slot-tx-mask : Transmit direction slot mask, optional
	9	dai-tdm-slot-rx-mask : Receive direction slot mask, optional
72899ad8 XL	10
	11	For instance:
	12	dai-tdm-slot-num = <2>;
	13	dai-tdm-slot-width = <8>;
6131084a JS	14	dai-tdm-slot-tx-mask = <0 1>;
6131084a JS	15	dai-tdm-slot-rx-mask = <1 0>;
72899ad8 XL	16
	17	And for each spcified driver, there could be one .of_xlate_tdm_slot_mask()
	18	to specify a explicit mapping of the channels and the slots. If it's absent
	19	the default snd_soc_of_xlate_tdm_slot_mask() will be used to generating the
	20	tx and rx masks.
	21
	22	For snd_soc_of_xlate_tdm_slot_mask(), the tx and rx masks will use a 1 bit
	23	for an active slot as default, and the default active bits are at the LSB of
	24	the masks.
6131084a JS	25
	26	The explicit masks are given as array of integers, where the first
	27	number presents bit-0 (LSB), second presents bit-1, etc. Any non zero
	28	number is considered 1 and 0 is 0. snd_soc_of_xlate_tdm_slot_mask()
	29	does not do anything, if either mask is set non zero value.