Unverified Commit 13a7d9e9 authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Mark Brown
Browse files

ASoC: dt-bindings: ti,pcm3168a: Convert to json-schema

Convert the Texas Instruments PCM3168A Audio Codec Device Tree binding
documentation to json-schema.

Add missing properties.
Drop unneeded pinctrl properties from example.

Link: https://lore.kernel.org/r/cover.1669980383.git.geert+renesas@glider.be
Link: https://lore.kernel.org/r/87mt7qpylw.wl-kuninori.morimoto.gx@renesas.com


Signed-off-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: default avatarKuninori Morimoto <kuninori.morimoto.gx@renesas.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/87k01d7rfv.wl-kuninori.morimoto.gx@renesas.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent f2a7ef1a
Loading
Loading
Loading
Loading
+0 −56
Original line number Diff line number Diff line
Texas Instruments pcm3168a DT bindings

This driver supports both SPI and I2C bus access for this codec

Required properties:

  - compatible: "ti,pcm3168a"

  - clocks : Contains an entry for each entry in clock-names

  - clock-names : Includes the following entries:
	"scki"	The system clock

  - VDD1-supply : Digital power supply regulator 1 (+3.3V)

  - VDD2-supply : Digital power supply regulator 2 (+3.3V)

  - VCCAD1-supply : ADC power supply regulator 1 (+5V)

  - VCCAD2-supply : ADC power supply regulator 2 (+5V)

  - VCCDA1-supply : DAC power supply regulator 1 (+5V)

  - VCCDA2-supply : DAC power supply regulator 2 (+5V)

For required properties on SPI/I2C, consult SPI/I2C device tree documentation

Optional properties:

  - reset-gpios : Optional reset gpio line connected to RST pin of the codec.
		  The RST line is low active:
		  RST = low: device power-down
		  RST = high: device is enabled

Examples:

i2c0: i2c0@0 {

	...

	pcm3168a: audio-codec@44 {
		compatible = "ti,pcm3168a";
		reg = <0x44>;
		reset-gpios = <&gpio0 4 GPIO_ACTIVE_LOW>;
		clocks = <&clk_core CLK_AUDIO>;
		clock-names = "scki";
		VDD1-supply = <&supply3v3>;
		VDD2-supply = <&supply3v3>;
		VCCAD1-supply = <&supply5v0>;
		VCCAD2-supply = <&supply5v0>;
		VCCDA1-supply = <&supply5v0>;
		VCCDA2-supply = <&supply5v0>;
		pinctrl-names = "default";
		pinctrl-0 = <&dac_clk_pin>;
	};
};
+107 −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/ti,pcm3168a.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Texas Instruments PCM3168A Audio Codec

maintainers:
  - Damien Horsley <Damien.Horsley@imgtec.com>
  - Geert Uytterhoeven <geert+renesas@glider.be>
  - Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>

description:
  The Texas Instruments PCM3168A is a 24-bit Multi-channel Audio CODEC with
  96/192kHz sampling rate, supporting both SPI and I2C bus access.

properties:
  compatible:
    const: ti,pcm3168a

  reg:
    maxItems: 1

  clocks:
    items:
      - description: System clock input

  clock-names:
    items:
      - const: scki

  reset-gpios:
    items:
      - description: |
          GPIO line connected to the active-low RST pin of the codec.
            RST = low: device power-down
            RST = high: device is enabled

  "#sound-dai-cells":
    enum: [0, 1]

  VDD1-supply:
    description: Digital power supply regulator 1 (+3.3V)

  VDD2-supply:
    description: Digital power supply regulator 2 (+3.3V)

  VCCAD1-supply:
    description: ADC power supply regulator 1 (+5V)

  VCCAD2-supply:
    description: ADC power supply regulator 2 (+5V)

  VCCDA1-supply:
    description: DAC power supply regulator 1 (+5V)

  VCCDA2-supply:
    description: DAC power supply regulator 2 (+5V)

  ports:
    $ref: audio-graph-port.yaml#/definitions/port-base
    properties:
      port@0:
        $ref: audio-graph-port.yaml#
        description: Audio input port.

      port@1:
        $ref: audio-graph-port.yaml#
        description: Audio output port.

required:
  - compatible
  - reg
  - clocks
  - clock-names
  - VDD1-supply
  - VDD2-supply
  - VCCAD1-supply
  - VCCAD2-supply
  - VCCDA1-supply
  - VCCDA2-supply

additionalProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>

    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        pcm3168a: audio-codec@44 {
            compatible = "ti,pcm3168a";
            reg = <0x44>;
            reset-gpios = <&gpio0 4 GPIO_ACTIVE_LOW>;
            clocks = <&clk_core 42>;
            clock-names = "scki";
            VDD1-supply = <&supply3v3>;
            VDD2-supply = <&supply3v3>;
            VCCAD1-supply = <&supply5v0>;
            VCCAD2-supply = <&supply5v0>;
            VCCDA1-supply = <&supply5v0>;
            VCCDA2-supply = <&supply5v0>;
        };
    };