Unverified Commit 45c6c5e0 authored by Sameer Pujar's avatar Sameer Pujar Committed by Mark Brown
Browse files

ASoC: tegra: Add binding doc for OPE module 



This patch adds YAML schema for DT bindings of Output Processing
Engine (OPE) module. It consists of Parametric Equalizer (PEQ)
and Multi Band Dynamic Range Compressor (MBDRC) sub blocks and
binding doc for these blocks are added as well. The OPE will be
registered as an ASoC component and can be plugged into an audio
path as per need via ALSA mixer controls. The DT bindings are
applicable on Tegra210 and later SoCs where OPE module is present.

Signed-off-by: default avatarSameer Pujar <spujar@nvidia.com>
Link: https://lore.kernel.org/r/1654238172-16293-2-git-send-email-spujar@nvidia.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent be1a63da

Documentation/devicetree/bindings/sound/nvidia,tegra210-ahub.yaml

+4 −0
Original line number Diff line number Diff line
@@ -110,6 +110,10 @@ patternProperties: 
    type: object

    $ref: nvidia,tegra186-asrc.yaml#



  '^processing-engine@[0-9a-f]+$':

    type: object

    $ref: nvidia,tegra210-ope.yaml#



required:

  - compatible

  - reg

Documentation/devicetree/bindings/sound/nvidia,tegra210-mbdrc.yaml

0 → 100644
+47 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/sound/nvidia,tegra210-mbdrc.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Tegra210 MBDRC



description:

  The Multi Band Dynamic Range Compressor (MBDRC) is part of Output

  Processing Engine (OPE) which interfaces with Audio Hub (AHUB) via

  Audio Client Interface (ACIF). MBDRC can be used as a traditional

  single full band or a dual band or a multi band dynamic processor.



maintainers:

  - Jon Hunter <jonathanh@nvidia.com>

  - Mohan Kumar <mkumard@nvidia.com>

  - Sameer Pujar <spujar@nvidia.com>



properties:

  compatible:

    oneOf:

      - const: nvidia,tegra210-mbdrc

      - items:

          - enum:

              - nvidia,tegra234-mbdrc

              - nvidia,tegra194-mbdrc

              - nvidia,tegra186-mbdrc

          - const: nvidia,tegra210-mbdrc



  reg:

    maxItems: 1



required:

  - compatible

  - reg



additionalProperties: false



examples:

  - |

    dynamic-range-compressor@702d8200 {

        compatible = "nvidia,tegra210-mbdrc";

        reg = <0x702d8200 0x200>;

    };



...

Documentation/devicetree/bindings/sound/nvidia,tegra210-ope.yaml

0 → 100644
+87 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/sound/nvidia,tegra210-ope.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Tegra210 OPE



description:

  The Output Processing Engine (OPE) is one of the AHUB client. It has

  PEQ (Parametric Equalizer) and MBDRC (Multi Band Dynamic Range Compressor)

  sub blocks for data processing.



maintainers:

  - Jon Hunter <jonathanh@nvidia.com>

  - Mohan Kumar <mkumard@nvidia.com>

  - Sameer Pujar <spujar@nvidia.com>



allOf:

  - $ref: name-prefix.yaml#



properties:

  compatible:

    oneOf:

      - const: nvidia,tegra210-ope

      - items:

          - enum:

              - nvidia,tegra234-ope

              - nvidia,tegra194-ope

              - nvidia,tegra186-ope

          - const: nvidia,tegra210-ope



  reg:

    maxItems: 1



  "#address-cells":

    const: 1



  "#size-cells":

    const: 1



  ranges: true



  sound-name-prefix:

    pattern: "^OPE[1-9]$"



  ports:

    $ref: /schemas/graph.yaml#/properties/ports

    properties:

      port@0:

        $ref: audio-graph-port.yaml#

        unevaluatedProperties: false

        description:

          OPE ACIF (Audio Client Interface) input port. This is connected

          to corresponding ACIF output port on AHUB (Audio Hub).



      port@1:

        $ref: audio-graph-port.yaml#

        unevaluatedProperties: false

        description:

          OPE ACIF output port. This is connected to corresponding ACIF

          input port on AHUB.



patternProperties:

  '^equalizer@[0-9a-f]+$':

    type: object

    $ref: nvidia,tegra210-peq.yaml#



  '^dynamic-range-compressor@[0-9a-f]+$':

    type: object

    $ref: nvidia,tegra210-mbdrc.yaml#



required:

  - compatible

  - reg



additionalProperties: false



examples:

  - |

    processing-engine@702d8000 {

        compatible = "nvidia,tegra210-ope";

        reg = <0x702d8000 0x100>;

        sound-name-prefix = "OPE1";

    };



...

Documentation/devicetree/bindings/sound/nvidia,tegra210-peq.yaml

0 → 100644
+48 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/sound/nvidia,tegra210-peq.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Tegra210 PEQ



description:

  The Parametric Equalizer (PEQ) is a cascade of biquad filters with

  each filter tuned based on certain parameters. It can be used to

  equalize the irregularities in the speaker frequency response.

  PEQ sits inside Output Processing Engine (OPE) which interfaces

  with Audio Hub (AHUB) via Audio Client Interface (ACIF).



maintainers:

  - Jon Hunter <jonathanh@nvidia.com>

  - Mohan Kumar <mkumard@nvidia.com>

  - Sameer Pujar <spujar@nvidia.com>



properties:

  compatible:

    oneOf:

      - const: nvidia,tegra210-peq

      - items:

          - enum:

              - nvidia,tegra234-peq

              - nvidia,tegra194-peq

              - nvidia,tegra186-peq

          - const: nvidia,tegra210-peq



  reg:

    maxItems: 1



required:

  - compatible

  - reg



additionalProperties: false



examples:

  - |

    equalizer@702d8100 {

        compatible = "nvidia,tegra210-peq";

        reg = <0x702d8100 0x100>;

    };



...