xref: /linux/Documentation/devicetree/bindings/sound/ti,omap-twl4030.yaml (revision 4f38da1f027ea2c9f01bb71daa7a299c191b6940) 
1# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/sound/ti,omap-twl4030.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Texas Instruments SoC with twl4030 based audio setups
8
9maintainers:
10  - Peter Ujfalusi <peter.ujfalusi@gmail.com>
11
12description:
13  Audio setups on TI OMAP SoCs using TWL4030-family
14  audio codec connected via a McBSP port.
15
16properties:
17  compatible:
18    const: ti,omap-twl4030
19
20  ti,model:
21    $ref: /schemas/types.yaml#/definitions/string
22    description: Name of the sound card (for example "omap3beagle").
23
24  ti,mcbsp:
25    $ref: /schemas/types.yaml#/definitions/phandle
26    description: phandle for the McBSP node.
27
28  ti,codec:
29    $ref: /schemas/types.yaml#/definitions/phandle
30    description: phandle for the twl4030 audio node.
31
32  ti,mcbsp-voice:
33    $ref: /schemas/types.yaml#/definitions/phandle
34    description: phandle to the McBSP node connected to the voice port.
35
36  ti,jack-det-gpio:
37    description: GPIO specifier for jack detection.
38    maxItems: 1
39
40  ti,audio-routing:
41    description: |
42      A list of audio routing connections. Each entry is a pair of strings,
43      with the first being the connection's sink and the second being the
44      source. If not provided, all possible connections are available.
45
46    $ref: /schemas/types.yaml#/definitions/non-unique-string-array
47    items:
48      enum:
49        # Board Connectors
50        - Headset Stereophone
51        - Earpiece Spk
52        - Handsfree Spk
53        - Ext Spk
54        - Main Mic
55        - Sub Mic
56        - Headset Mic
57        - Carkit Mic
58        - Digital0 Mic
59        - Digital1 Mic
60        - Line In
61
62        # CODEC Pins
63        - HSOL
64        - HSOR
65        - EARPIECE
66        - HFL
67        - HFR
68        - PREDRIVEL
69        - PREDRIVER
70        - CARKITL
71        - CARKITR
72        - MAINMIC
73        - SUBMIC
74        - HSMIC
75        - DIGIMIC0
76        - DIGIMIC1
77        - CARKITMIC
78        - AUXL
79        - AUXR
80
81        # Headset Mic Bias
82        - Mic Bias 1   # Used for Main Mic or Digimic0
83        - Mic Bias 2   # Used for Sub Mic or Digimic1
84
85required:
86  - compatible
87  - ti,model
88  - ti,mcbsp
89
90additionalProperties: false
91
92examples:
93  - |
94    sound {
95        compatible = "ti,omap-twl4030";
96        ti,model = "omap3beagle";
97        ti,mcbsp = <&mcbsp2>;
98    };
99