Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
ASoC: dt-bindings: convert tdm-slot to YAML
This schema was still in plaintext form. Convert to YAML format.
Signed-off-by: James Calligeros <jcalligeros99@gmail.com>
Link: https://patch.msgid.link/20260301-tdm-idle-slots-v3-1-c6ac5351489a@gmail.com
Signed-off-by: Mark Brown <broonie@kernel.org>
authored by
James Calligeros
and committed by
Mark Brown
5273cb81
f338e773
+33
-29
-29
Documentation/devicetree/bindings/sound/tdm-slot.txt
-29
Documentation/devicetree/bindings/sound/tdm-slot.txt
···
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.
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
10
-
11
-
For instance:
12
-
dai-tdm-slot-num = <2>;
13
-
dai-tdm-slot-width = <8>;
14
-
dai-tdm-slot-tx-mask = <0 1>;
15
-
dai-tdm-slot-rx-mask = <1 0>;
16
-
17
-
And for each specified driver, there could be one .of_xlate_tdm_slot_mask()
18
-
to specify an 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.
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.
+33
Documentation/devicetree/bindings/sound/tdm-slot.yaml
+33
Documentation/devicetree/bindings/sound/tdm-slot.yaml
···
1
+
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2
+
%YAML 1.2
3
+
---
4
+
$id: http://devicetree.org/schemas/sound/tdm-slot.yaml#
5
+
$schema: http://devicetree.org/meta-schemas/core.yaml#
6
+
7
+
title: Time Division Multiplexing (TDM) Slot Parameters
8
+
9
+
maintainers:
10
+
- Liam Girdwood <lgirdwood@gmail.com>
11
+
12
+
select: false
13
+
14
+
properties:
15
+
dai-tdm-slot-num:
16
+
$ref: /schemas/types.yaml#/definitions/uint32
17
+
description: Number of slots in use
18
+
19
+
dai-tdm-slot-width:
20
+
$ref: /schemas/types.yaml#/definitions/uint32
21
+
description: Width, in bits, of each slot
22
+
23
+
patternProperties:
24
+
'^dai-tdm-slot-[rt]x-mask$':
25
+
$ref: /schemas/types.yaml#/definitions/uint32-array
26
+
description: Slot mask for active TDM slots. Optional. Drivers may
27
+
specify .xlate_tdm_slot_mask() to generate a slot mask dynamically. If
28
+
neither this property nor a driver-specific function are specified, the
29
+
default snd_soc_xlate_tdm_slot_mask() function will be used to generate
30
+
a mask. The first element of the array is slot 0 (LSB). Any nonzero
31
+
value will be treated as 1.
32
+
33
+
additionalProperties: true