ti,tlv320aic3x.yaml

  1# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
  2# Copyright (C) 2022 Texas Instruments Incorporated
  3%YAML 1.2
  4---
  5$id: http://devicetree.org/schemas/sound/ti,tlv320aic3x.yaml#
  6$schema: http://devicetree.org/meta-schemas/core.yaml#
  7
  8title: Texas Instruments TLV320AIC3x Codec
  9
 10description: |
 11  TLV320AIC3x are a series of low-power stereo audio codecs with stereo
 12  headphone amplifier, as well as multiple inputs and outputs programmable in
 13  single-ended or fully differential configurations.
 14
 15  The serial control bus supports SPI or I2C protocols, while the serial audio
 16  data bus is programmable for I2S, left/right-justified, DSP, or TDM modes.
 17
 18  The following pins can be referred in the sound node's audio routing property:
 19
 20  CODEC output pins:
 21     LLOUT
 22     RLOUT
 23     MONO_LOUT
 24     HPLOUT
 25     HPROUT
 26     HPLCOM
 27     HPRCOM
 28
 29  CODEC input pins for TLV320AIC3104:
 30     MIC2L
 31     MIC2R
 32     LINE1L
 33     LINE1R
 34
 35  CODEC input pins for other compatible codecs:
 36     MIC3L
 37     MIC3R
 38     LINE1L
 39     LINE2L
 40     LINE1R
 41     LINE2R
 42
 43maintainers:
 44  - Jai Luthra <j-luthra@ti.com>
 45
 46properties:
 47  compatible:
 48    enum:
 49      - ti,tlv320aic23
 50      - ti,tlv320aic3x
 51      - ti,tlv320aic33
 52      - ti,tlv320aic3007
 53      - ti,tlv320aic3106
 54      - ti,tlv320aic3104
 55
 56  reg:
 57    maxItems: 1
 58
 59  reset-gpios:
 60    maxItems: 1
 61    description:
 62      GPIO specification for the active low RESET input.
 63
 64  gpio-reset:
 65    $ref: /schemas/types.yaml#/definitions/uint32-matrix
 66    maxItems: 1
 67    description:
 68      Deprecated, please use reset-gpios instead.
 69    deprecated: true
 70
 71  ai3x-gpio-func:
 72    description: AIC3X_GPIO1 & AIC3X_GPIO2 Functionality
 73    $ref: /schemas/types.yaml#/definitions/uint32-array
 74    maxItems: 2
 75
 76  ai3x-micbias-vg:
 77    description: MicBias required voltage. If node is omitted then MicBias is powered down.
 78    $ref: /schemas/types.yaml#/definitions/uint32
 79    oneOf:
 80      - const: 1
 81        description: MICBIAS output is powered to 2.0V.
 82      - const: 2
 83        description: MICBIAS output is powered to 2.5V.
 84      - const: 3
 85        description: MICBIAS output is connected to AVDD.
 86
 87  ai3x-ocmv:
 88    description: Output Common-Mode Voltage selection.
 89    $ref: /schemas/types.yaml#/definitions/uint32
 90    oneOf:
 91      - const: 0
 92        description: 1.35V
 93      - const: 1
 94        description: 1.5V
 95      - const: 2
 96        description: 1.65V
 97      - const: 3
 98        description: 1.8V
 99
100  AVDD-supply:
101    description: Analog DAC voltage.
102
103  IOVDD-supply:
104    description: I/O voltage.
105
106  DRVDD-supply:
107    description: ADC analog and output driver voltage.
108
109  DVDD-supply:
110    description: Digital core voltage.
111
112  '#sound-dai-cells':
113    const: 0
114
115  clocks:
116    maxItems: 1
117
118  port:
119    $ref: audio-graph-port.yaml#
120    unevaluatedProperties: false
121
122required:
123  - compatible
124  - reg
125
126additionalProperties: false
127
128examples:
129  - |
130    #include <dt-bindings/gpio/gpio.h>
131    i2c {
132      #address-cells = <1>;
133      #size-cells = <0>;
134
135      tlv320aic3x_i2c: audio-codec@1b {
136        compatible = "ti,tlv320aic3x";
137        reg = <0x1b>;
138
139        reset-gpios = <&gpio1 17 GPIO_ACTIVE_LOW>;
140
141        AVDD-supply = <&regulator>;
142        IOVDD-supply = <&regulator>;
143        DRVDD-supply = <&regulator>;
144        DVDD-supply = <&regulator>;
145      };
146    };
147
148  - |
149    #include <dt-bindings/gpio/gpio.h>
150    spi {
151      #address-cells = <1>;
152      #size-cells = <0>;
153
154      tlv320aic3x_spi: audio-codec@0 {
155        compatible = "ti,tlv320aic3x";
156        reg = <0>; /* CS number */
157        #sound-dai-cells = <0>;
158
159        AVDD-supply = <&regulator>;
160        IOVDD-supply = <&regulator>;
161        DRVDD-supply = <&regulator>;
162        DVDD-supply = <&regulator>;
163        ai3x-ocmv = <0>;
164      };
165    };
166
167...