# 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

  dai-tdm-idle-mode:
    $ref: /schemas/types.yaml#/definitions/string
    enum:
      - none
      - off
      - zero
      - pulldown
      - hiz
      - pullup
      - drivehigh
    description: Drive mode for inactive/idle TDM slots. For hardware that
      implements .set_tdm_idle(). Optional. "None" represents undefined
      behaviour and is the same as not setting this property.

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.

  '^dai-tdm-slot-[rt]x-idle-mask$':
    $ref: /schemas/types.yaml#/definitions/uint32
    description: Idle slot mask. Optional. A bit being set to 1 indicates
      that the corresponding TDM slot is inactive/idle.

additionalProperties: true