Documentation/devicetree/bindings/sound/rockchip,rk3328-codec.yaml

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/sound/rockchip,rk3328-codec.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Rockchip rk3328 internal codec

maintainers:
  - Heiko Stuebner <heiko@sntech.de>

properties:
  compatible:
    const: rockchip,rk3328-codec

  reg:
    maxItems: 1

  clocks:
    items:
      - description: clock for audio codec
      - description: clock for I2S master clock

  clock-names:
    items:
      - const: pclk
      - const: mclk

  rockchip,grf:
    $ref: /schemas/types.yaml#/definitions/phandle
    description:
      The phandle of the syscon node for the GRF register.

  spk-depop-time-ms:
    default: 200
    description:
      Speaker depop time in msec.

  mute-gpios:
    maxItems: 1
    description:
      GPIO specifier for external line driver control (typically the
      dedicated GPIO_MUTE pin)

  "#sound-dai-cells":
    const: 0

required:
  - compatible
  - reg
  - clocks
  - clock-names
  - rockchip,grf
  - "#sound-dai-cells"

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>
    #include <dt-bindings/clock/rk3328-cru.h>
    codec: codec@ff410000 {
      compatible = "rockchip,rk3328-codec";
      reg = <0xff410000 0x1000>;
      clocks = <&cru PCLK_ACODECPHY>, <&cru SCLK_I2S1>;
      clock-names = "pclk", "mclk";
      rockchip,grf = <&grf>;
      mute-gpios = <&grf_gpio 0 GPIO_ACTIVE_LOW>;
      spk-depop-time-ms = <100>;
      #sound-dai-cells = <0>;
    };