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>
This commit is contained in:
James Calligeros
2026-03-01 18:05:20 +10:00
committed by Mark Brown
parent f338e77383
commit 5273cb8197
2 changed files with 33 additions and 29 deletions

View File

@@ -1,29 +0,0 @@
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 specified driver, there could be one .of_xlate_tdm_slot_mask()
to specify an 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.

View File

@@ -0,0 +1,33 @@
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/sound/tdm-slot.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#
title: Time Division Multiplexing (TDM) Slot Parameters
maintainers:
- Liam Girdwood <lgirdwood@gmail.com>
select: false
properties:
dai-tdm-slot-num:
$ref: /schemas/types.yaml#/definitions/uint32
description: Number of slots in use
dai-tdm-slot-width:
$ref: /schemas/types.yaml#/definitions/uint32
description: Width, in bits, of each slot
patternProperties:
'^dai-tdm-slot-[rt]x-mask$':
$ref: /schemas/types.yaml#/definitions/uint32-array
description: Slot mask for active TDM slots. Optional. Drivers may
specify .xlate_tdm_slot_mask() to generate a slot mask dynamically. If
neither this property nor a driver-specific function are specified, the
default snd_soc_xlate_tdm_slot_mask() function will be used to generate
a mask. The first element of the array is slot 0 (LSB). Any nonzero
value will be treated as 1.
additionalProperties: true