Documentation/devicetree/bindings/sound/fsl,audmix.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/fsl,audmix.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: NXP Audio Mixer (AUDMIX).
   8
   9 maintainers:
  10   - Shengjiu Wang <shengjiu.wang@nxp.com>
  11   - Frank Li <Frank.Li@nxp.com>
  12
  13 description: |
  14   The Audio Mixer is a on-chip functional module that allows mixing of two
  15   audio streams into a single audio stream. Audio Mixer has two input serial
  16   audio interfaces. These are driven by two Synchronous Audio interface
  17   modules (SAI). Each input serial interface carries 8 audio channels in its
  18   frame in TDM manner. Mixer mixes audio samples of corresponding channels
  19   from two interfaces into a single sample. Before mixing, audio samples of
  20   two inputs can be attenuated based on configuration. The output of the
  21   Audio Mixer is also a serial audio interface. Like input interfaces it has
  22   the same TDM frame format. This output is used to drive the serial DAC TDM
  23   interface of audio codec and also sent to the external pins along with the
  24   receive path of normal audio SAI module for readback by the CPU.
  25
  26   The output of Audio Mixer can be selected from any of the three streams
  27     - serial audio input 1
  28     - serial audio input 2
  29     - mixed audio
  30
  31   Mixing operation is independent of audio sample rate but the two audio
  32   input streams must have same audio sample rate with same number of channels
  33   in TDM frame to be eligible for mixing.
  34
  35 properties:
  36   compatible:
  37     const: fsl,imx8qm-audmix
  38
  39   reg:
  40     maxItems: 1
  41
  42   clocks:
  43     maxItems: 1
  44
  45   clock-names:
  46     items:
  47       - const: ipg
  48
  49   power-domains:
  50     maxItems: 1
  51
  52   dais:
  53     description: contain a list of phandles to AUDMIX connected DAIs.
  54     $ref: /schemas/types.yaml#/definitions/phandle-array
  55     minItems: 2
  56     items:
  57       - description: the AUDMIX output
  58         maxItems: 1
  59       - description: serial audio input 1
  60         maxItems: 1
  61       - description: serial audio input 2
  62         maxItems: 1
  63
  64 required:
  65   - compatible
  66   - reg
  67   - clocks
  68   - clock-names
  69   - power-domains
  70   - dais
  71
  72 unevaluatedProperties: false
  73
  74 examples:
  75   - |
  76     audmix@59840000 {
  77       compatible = "fsl,imx8qm-audmix";
  78       reg = <0x59840000 0x10000>;
  79       clocks = <&amix_lpcg 0>;
  80       clock-names = "ipg";
  81       power-domains = <&pd_audmix>;
  82       dais = <&sai4>, <&sai5>;
  83     };