Skip to content

Commit 23d7a7e

Browse files
committed
ASoC: dt-bindings: Convert TI TWL4030 sound
Merge series from Jihed Chaibi <jihed.chaibi.dev@gmail.com>: This series converts the legacy TXT bindings for the TI TWL4030 sound-related modules to the modern YAML DT schema format. This work was previously part of a larger series but is now being sent as a focused submission for the ASoC subsystem.
2 parents 132e098 + c232495 commit 23d7a7e

4 files changed

Lines changed: 188 additions & 108 deletions

File tree

Documentation/devicetree/bindings/mfd/twl4030-audio.txt

Lines changed: 0 additions & 46 deletions
This file was deleted.

Documentation/devicetree/bindings/sound/omap-twl4030.txt

Lines changed: 0 additions & 62 deletions
This file was deleted.
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
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+
7+
title: Texas Instruments SoC with twl4030 based audio setups
8+
9+
maintainers:
10+
- Peter Ujfalusi <peter.ujfalusi@gmail.com>
11+
12+
description:
13+
Audio setups on TI OMAP SoCs using TWL4030-family
14+
audio codec connected via a McBSP port.
15+
16+
properties:
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+
85+
required:
86+
- compatible
87+
- ti,model
88+
- ti,mcbsp
89+
90+
additionalProperties: false
91+
92+
examples:
93+
- |
94+
sound {
95+
compatible = "ti,omap-twl4030";
96+
ti,model = "omap3beagle";
97+
ti,mcbsp = <&mcbsp2>;
98+
};
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
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,twl4030-audio.yaml#
5+
$schema: http://devicetree.org/meta-schemas/core.yaml#
6+
7+
title: Texas Instruments TWL4030-family Audio Module
8+
9+
maintainers:
10+
- Peter Ujfalusi <peter.ujfalusi@gmail.com>
11+
12+
description:
13+
The audio module within the TWL4030-family of companion chips consists
14+
of an audio codec and a vibra driver. This binding describes the parent
15+
node for these functions.
16+
17+
properties:
18+
compatible:
19+
const: ti,twl4030-audio
20+
21+
codec:
22+
type: object
23+
description: Node containing properties for the audio codec functionality.
24+
25+
properties:
26+
ti,digimic_delay:
27+
$ref: /schemas/types.yaml#/definitions/uint32
28+
description:
29+
Delay in milliseconds after enabling digital microphones to reduce
30+
artifacts.
31+
32+
ti,ramp_delay_value:
33+
$ref: /schemas/types.yaml#/definitions/uint32
34+
description:
35+
Headset ramp delay configuration to reduce pop noise.
36+
37+
ti,hs_extmute:
38+
type: boolean
39+
description:
40+
Enable the use of an external mute for headset pop reduction.
41+
42+
ti,hs_extmute_gpio:
43+
$ref: /schemas/types.yaml#/definitions/phandle-array
44+
description:
45+
The GPIO specifier for the external mute control.
46+
maxItems: 1
47+
48+
ti,offset_cncl_path:
49+
$ref: /schemas/types.yaml#/definitions/uint32
50+
description:
51+
Offset cancellation path selection. Refer to the Technical
52+
Reference Manual for valid values.
53+
54+
# The 'codec' node itself is optional, but if it exists, it can be empty.
55+
# We don't require any of its sub-properties.
56+
57+
ti,enable-vibra:
58+
$ref: /schemas/types.yaml#/definitions/uint32
59+
enum: [0, 1]
60+
description:
61+
Enable or disable the vibra functionality.
62+
63+
additionalProperties: false
64+
65+
required:
66+
- compatible
67+
68+
examples:
69+
- |
70+
i2c {
71+
#address-cells = <1>;
72+
#size-cells = <0>;
73+
74+
twl: twl@48 {
75+
reg = <0x48>;
76+
interrupts = <7>; /* SYS_NIRQ cascaded to intc */
77+
interrupt-parent = <&intc>;
78+
79+
twl_audio: audio {
80+
compatible = "ti,twl4030-audio";
81+
82+
ti,enable-vibra = <1>;
83+
84+
codec {
85+
ti,ramp_delay_value = <3>;
86+
};
87+
88+
};
89+
};
90+
};

0 commit comments

Comments
 (0)