* [PATCH v4 1/2] ASoC: dt-bindings: ti,twl4030-audio: convert to DT schema
2025-08-19 20:13 [PATCH v4 0/2] ASoC: dt-bindings: Convert TI TWL4030 sound bindings to schema Jihed Chaibi
@ 2025-08-19 20:13 ` Jihed Chaibi
2025-08-20 14:09 ` Rob Herring (Arm)
2025-08-19 20:13 ` [PATCH v4 2/2] ASoC: dt-bindings: omap-twl4030: " Jihed Chaibi
2025-08-20 22:17 ` [PATCH v4 0/2] ASoC: dt-bindings: Convert TI TWL4030 sound bindings to schema Mark Brown
2 siblings, 1 reply; 6+ messages in thread
From: Jihed Chaibi @ 2025-08-19 20:13 UTC (permalink / raw)
To: broonie, lgirdwood, robh
Cc: peter.ujfalusi, krzk+dt, conor+dt, devicetree, linux-sound,
linux-omap, linux-kernel, shuah, jihed.chaibi.dev
Convert the TWL4030 audio module bindings from txt to YAML format and
move them to the sound subsystem bindings directory. This patch also
refines the schema by adding an enum constraint for ti,enable-vibra and
updates the example to remove irrelevant I2C clock-frequency property.
Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
---
Changes in v4:
- No change to binding content, only updating commit message format.
- Split from larger series per maintainer feedback.
- v3 link:
https://lore.kernel.org/all/20250816021523.167049-1-jihed.chaibi.dev@gmail.com/
Changes in v3:
- No changes.
Changes in v2:
- Moved binding from mfd to sound directory.
- Added enum: [0, 1] to ti,enable-vibra for stricter validation.
- Removed clock-frequency from the example as it’s not relevant to the binding.
- Simplified example by removing unnecessary I2C node properties.
---
.../devicetree/bindings/mfd/twl4030-audio.txt | 46 ----------
.../bindings/sound/ti,twl4030-audio.yaml | 90 +++++++++++++++++++
2 files changed, 90 insertions(+), 46 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/mfd/twl4030-audio.txt
create mode 100644 Documentation/devicetree/bindings/sound/ti,twl4030-audio.yaml
diff --git a/Documentation/devicetree/bindings/mfd/twl4030-audio.txt b/Documentation/devicetree/bindings/mfd/twl4030-audio.txt
deleted file mode 100644
index 414d2ae0a..000000000
--- a/Documentation/devicetree/bindings/mfd/twl4030-audio.txt
+++ /dev/null
@@ -1,46 +0,0 @@
-Texas Instruments TWL family (twl4030) audio module
-
-The audio module inside the TWL family consist of an audio codec and a vibra
-driver.
-
-Required properties:
-- compatible : must be "ti,twl4030-audio"
-
-Optional properties, nodes:
-
-Audio functionality:
-- codec { }: Need to be present if the audio functionality is used. Within this
- section the following options can be used:
-- ti,digimic_delay: Delay need after enabling the digimic to reduce artifacts
- from the start of the recorded sample (in ms)
--ti,ramp_delay_value: HS ramp delay configuration to reduce pop noise
--ti,hs_extmute: Use external mute for HS pop reduction
--ti,hs_extmute_gpio: Use external GPIO to control the external mute
--ti,offset_cncl_path: Offset cancellation path selection, refer to TRM for the
- valid values.
-
-Vibra functionality
-- ti,enable-vibra: Need to be set to <1> if the vibra functionality is used. if
- missing or it is 0, the vibra functionality is disabled.
-
-Example:
-&i2c1 {
- clock-frequency = <2600000>;
-
- twl: twl@48 {
- reg = <0x48>;
- interrupts = <7>; /* SYS_NIRQ cascaded to intc */
- interrupt-parent = <&intc>;
-
- twl_audio: audio {
- compatible = "ti,twl4030-audio";
-
- ti,enable-vibra = <1>;
-
- codec {
- ti,ramp_delay_value = <3>;
- };
-
- };
- };
-};
diff --git a/Documentation/devicetree/bindings/sound/ti,twl4030-audio.yaml b/Documentation/devicetree/bindings/sound/ti,twl4030-audio.yaml
new file mode 100644
index 000000000..c9c3f7513
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/ti,twl4030-audio.yaml
@@ -0,0 +1,90 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/ti,twl4030-audio.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments TWL4030-family Audio Module
+
+maintainers:
+ - Peter Ujfalusi <peter.ujfalusi@gmail.com>
+
+description:
+ The audio module within the TWL4030-family of companion chips consists
+ of an audio codec and a vibra driver. This binding describes the parent
+ node for these functions.
+
+properties:
+ compatible:
+ const: ti,twl4030-audio
+
+ codec:
+ type: object
+ description: Node containing properties for the audio codec functionality.
+
+ properties:
+ ti,digimic_delay:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Delay in milliseconds after enabling digital microphones to reduce
+ artifacts.
+
+ ti,ramp_delay_value:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Headset ramp delay configuration to reduce pop noise.
+
+ ti,hs_extmute:
+ type: boolean
+ description:
+ Enable the use of an external mute for headset pop reduction.
+
+ ti,hs_extmute_gpio:
+ $ref: /schemas/types.yaml#/definitions/phandle-array
+ description:
+ The GPIO specifier for the external mute control.
+ maxItems: 1
+
+ ti,offset_cncl_path:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ Offset cancellation path selection. Refer to the Technical
+ Reference Manual for valid values.
+
+ # The 'codec' node itself is optional, but if it exists, it can be empty.
+ # We don't require any of its sub-properties.
+
+ ti,enable-vibra:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ enum: [0, 1]
+ description:
+ Enable or disable the vibra functionality.
+
+additionalProperties: false
+
+required:
+ - compatible
+
+examples:
+ - |
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ twl: twl@48 {
+ reg = <0x48>;
+ interrupts = <7>; /* SYS_NIRQ cascaded to intc */
+ interrupt-parent = <&intc>;
+
+ twl_audio: audio {
+ compatible = "ti,twl4030-audio";
+
+ ti,enable-vibra = <1>;
+
+ codec {
+ ti,ramp_delay_value = <3>;
+ };
+
+ };
+ };
+ };
--
2.39.5
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH v4 1/2] ASoC: dt-bindings: ti,twl4030-audio: convert to DT schema
2025-08-19 20:13 ` [PATCH v4 1/2] ASoC: dt-bindings: ti,twl4030-audio: convert to DT schema Jihed Chaibi
@ 2025-08-20 14:09 ` Rob Herring (Arm)
0 siblings, 0 replies; 6+ messages in thread
From: Rob Herring (Arm) @ 2025-08-20 14:09 UTC (permalink / raw)
To: Jihed Chaibi
Cc: linux-omap, conor+dt, broonie, shuah, krzk+dt, linux-kernel,
devicetree, linux-sound, lgirdwood, peter.ujfalusi
On Tue, 19 Aug 2025 22:13:01 +0200, Jihed Chaibi wrote:
> Convert the TWL4030 audio module bindings from txt to YAML format and
> move them to the sound subsystem bindings directory. This patch also
> refines the schema by adding an enum constraint for ti,enable-vibra and
> updates the example to remove irrelevant I2C clock-frequency property.
>
> Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
>
> ---
> Changes in v4:
> - No change to binding content, only updating commit message format.
> - Split from larger series per maintainer feedback.
> - v3 link:
> https://lore.kernel.org/all/20250816021523.167049-1-jihed.chaibi.dev@gmail.com/
>
> Changes in v3:
> - No changes.
>
> Changes in v2:
> - Moved binding from mfd to sound directory.
> - Added enum: [0, 1] to ti,enable-vibra for stricter validation.
> - Removed clock-frequency from the example as it’s not relevant to the binding.
> - Simplified example by removing unnecessary I2C node properties.
> ---
> .../devicetree/bindings/mfd/twl4030-audio.txt | 46 ----------
> .../bindings/sound/ti,twl4030-audio.yaml | 90 +++++++++++++++++++
> 2 files changed, 90 insertions(+), 46 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/mfd/twl4030-audio.txt
> create mode 100644 Documentation/devicetree/bindings/sound/ti,twl4030-audio.yaml
>
Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v4 2/2] ASoC: dt-bindings: omap-twl4030: convert to DT schema
2025-08-19 20:13 [PATCH v4 0/2] ASoC: dt-bindings: Convert TI TWL4030 sound bindings to schema Jihed Chaibi
2025-08-19 20:13 ` [PATCH v4 1/2] ASoC: dt-bindings: ti,twl4030-audio: convert to DT schema Jihed Chaibi
@ 2025-08-19 20:13 ` Jihed Chaibi
2025-08-20 14:10 ` Rob Herring (Arm)
2025-08-20 22:17 ` [PATCH v4 0/2] ASoC: dt-bindings: Convert TI TWL4030 sound bindings to schema Mark Brown
2 siblings, 1 reply; 6+ messages in thread
From: Jihed Chaibi @ 2025-08-19 20:13 UTC (permalink / raw)
To: broonie, lgirdwood, robh
Cc: peter.ujfalusi, krzk+dt, conor+dt, devicetree, linux-sound,
linux-omap, linux-kernel, shuah, jihed.chaibi.dev
Convert the legacy TXT binding for the OMAP TWL4030 sound card
to the modern YAML DT schema format. This adds formal validation
and improves documentation.
Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
---
Changes in v4:
- Deleted redundant pins list.
- Split from larger series per maintainer feedback.
- v3 link:
https://lore.kernel.org/all/20250816021523.167049-1-jihed.chaibi.dev@gmail.com/
Changes in v3:
- No change to binding content, only updating commit message format.
Changes in v2:
- Fixed comment formatting (added spaces for better alignment).
- Updated commit subject to align with subsystem style.
- Retained Acked-by from v1 as changes are cosmetic.
---
.../bindings/sound/omap-twl4030.txt | 62 ------------
.../bindings/sound/ti,omap-twl4030.yaml | 98 +++++++++++++++++++
2 files changed, 98 insertions(+), 62 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/sound/omap-twl4030.txt
create mode 100644 Documentation/devicetree/bindings/sound/ti,omap-twl4030.yaml
diff --git a/Documentation/devicetree/bindings/sound/omap-twl4030.txt b/Documentation/devicetree/bindings/sound/omap-twl4030.txt
deleted file mode 100644
index f6a715e4e..000000000
--- a/Documentation/devicetree/bindings/sound/omap-twl4030.txt
+++ /dev/null
@@ -1,62 +0,0 @@
-* Texas Instruments SoC with twl4030 based audio setups
-
-Required properties:
-- compatible: "ti,omap-twl4030"
-- ti,model: Name of the sound card (for example "omap3beagle")
-- ti,mcbsp: phandle for the McBSP node
-
-Optional properties:
-- ti,codec: phandle for the twl4030 audio node
-- ti,mcbsp-voice: phandle for the McBSP node connected to the voice port of twl
-- ti, jack-det-gpio: Jack detect GPIO
-- ti,audio-routing: List of connections between audio components.
- Each entry is a pair of strings, the first being the connection's sink,
- the second being the connection's source.
- If the routing is not provided all possible connection will be available
-
-Available audio endpoints for the audio-routing table:
-
-Board connectors:
- * Headset Stereophone
- * Earpiece Spk
- * Handsfree Spk
- * Ext Spk
- * Main Mic
- * Sub Mic
- * Headset Mic
- * Carkit Mic
- * Digital0 Mic
- * Digital1 Mic
- * Line In
-
-twl4030 pins:
- * HSOL
- * HSOR
- * EARPIECE
- * HFL
- * HFR
- * PREDRIVEL
- * PREDRIVER
- * CARKITL
- * CARKITR
- * MAINMIC
- * SUBMIC
- * HSMIC
- * DIGIMIC0
- * DIGIMIC1
- * CARKITMIC
- * AUXL
- * AUXR
-
- * Headset Mic Bias
- * Mic Bias 1 /* Used for Main Mic or Digimic0 */
- * Mic Bias 2 /* Used for Sub Mic or Digimic1 */
-
-Example:
-
-sound {
- compatible = "ti,omap-twl4030";
- ti,model = "omap3beagle";
-
- ti,mcbsp = <&mcbsp2>;
-};
diff --git a/Documentation/devicetree/bindings/sound/ti,omap-twl4030.yaml b/Documentation/devicetree/bindings/sound/ti,omap-twl4030.yaml
new file mode 100644
index 000000000..27c7019bd
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/ti,omap-twl4030.yaml
@@ -0,0 +1,98 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/ti,omap-twl4030.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments SoC with twl4030 based audio setups
+
+maintainers:
+ - Peter Ujfalusi <peter.ujfalusi@gmail.com>
+
+description:
+ Audio setups on TI OMAP SoCs using TWL4030-family
+ audio codec connected via a McBSP port.
+
+properties:
+ compatible:
+ const: ti,omap-twl4030
+
+ ti,model:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: Name of the sound card (for example "omap3beagle").
+
+ ti,mcbsp:
+ $ref: /schemas/types.yaml#/definitions/phandle
+ description: phandle for the McBSP node.
+
+ ti,codec:
+ $ref: /schemas/types.yaml#/definitions/phandle
+ description: phandle for the twl4030 audio node.
+
+ ti,mcbsp-voice:
+ $ref: /schemas/types.yaml#/definitions/phandle
+ description: phandle to the McBSP node connected to the voice port.
+
+ ti,jack-det-gpio:
+ description: GPIO specifier for jack detection.
+ maxItems: 1
+
+ ti,audio-routing:
+ description: |
+ A list of audio routing connections. Each entry is a pair of strings,
+ with the first being the connection's sink and the second being the
+ source. If not provided, all possible connections are available.
+
+ $ref: /schemas/types.yaml#/definitions/non-unique-string-array
+ items:
+ enum:
+ # Board Connectors
+ - Headset Stereophone
+ - Earpiece Spk
+ - Handsfree Spk
+ - Ext Spk
+ - Main Mic
+ - Sub Mic
+ - Headset Mic
+ - Carkit Mic
+ - Digital0 Mic
+ - Digital1 Mic
+ - Line In
+
+ # CODEC Pins
+ - HSOL
+ - HSOR
+ - EARPIECE
+ - HFL
+ - HFR
+ - PREDRIVEL
+ - PREDRIVER
+ - CARKITL
+ - CARKITR
+ - MAINMIC
+ - SUBMIC
+ - HSMIC
+ - DIGIMIC0
+ - DIGIMIC1
+ - CARKITMIC
+ - AUXL
+ - AUXR
+
+ # Headset Mic Bias
+ - Mic Bias 1 # Used for Main Mic or Digimic0
+ - Mic Bias 2 # Used for Sub Mic or Digimic1
+
+required:
+ - compatible
+ - ti,model
+ - ti,mcbsp
+
+additionalProperties: false
+
+examples:
+ - |
+ sound {
+ compatible = "ti,omap-twl4030";
+ ti,model = "omap3beagle";
+ ti,mcbsp = <&mcbsp2>;
+ };
--
2.39.5
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH v4 2/2] ASoC: dt-bindings: omap-twl4030: convert to DT schema
2025-08-19 20:13 ` [PATCH v4 2/2] ASoC: dt-bindings: omap-twl4030: " Jihed Chaibi
@ 2025-08-20 14:10 ` Rob Herring (Arm)
0 siblings, 0 replies; 6+ messages in thread
From: Rob Herring (Arm) @ 2025-08-20 14:10 UTC (permalink / raw)
To: Jihed Chaibi
Cc: linux-omap, peter.ujfalusi, broonie, conor+dt, devicetree,
linux-sound, shuah, lgirdwood, krzk+dt, linux-kernel
On Tue, 19 Aug 2025 22:13:02 +0200, Jihed Chaibi wrote:
> Convert the legacy TXT binding for the OMAP TWL4030 sound card
> to the modern YAML DT schema format. This adds formal validation
> and improves documentation.
>
> Acked-by: Mark Brown <broonie@kernel.org>
> Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
>
> ---
> Changes in v4:
> - Deleted redundant pins list.
> - Split from larger series per maintainer feedback.
> - v3 link:
> https://lore.kernel.org/all/20250816021523.167049-1-jihed.chaibi.dev@gmail.com/
>
> Changes in v3:
> - No change to binding content, only updating commit message format.
>
> Changes in v2:
> - Fixed comment formatting (added spaces for better alignment).
> - Updated commit subject to align with subsystem style.
> - Retained Acked-by from v1 as changes are cosmetic.
> ---
> .../bindings/sound/omap-twl4030.txt | 62 ------------
> .../bindings/sound/ti,omap-twl4030.yaml | 98 +++++++++++++++++++
> 2 files changed, 98 insertions(+), 62 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/sound/omap-twl4030.txt
> create mode 100644 Documentation/devicetree/bindings/sound/ti,omap-twl4030.yaml
>
Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v4 0/2] ASoC: dt-bindings: Convert TI TWL4030 sound bindings to schema
2025-08-19 20:13 [PATCH v4 0/2] ASoC: dt-bindings: Convert TI TWL4030 sound bindings to schema Jihed Chaibi
2025-08-19 20:13 ` [PATCH v4 1/2] ASoC: dt-bindings: ti,twl4030-audio: convert to DT schema Jihed Chaibi
2025-08-19 20:13 ` [PATCH v4 2/2] ASoC: dt-bindings: omap-twl4030: " Jihed Chaibi
@ 2025-08-20 22:17 ` Mark Brown
2 siblings, 0 replies; 6+ messages in thread
From: Mark Brown @ 2025-08-20 22:17 UTC (permalink / raw)
To: lgirdwood, robh, Jihed Chaibi
Cc: peter.ujfalusi, krzk+dt, conor+dt, devicetree, linux-sound,
linux-omap, linux-kernel, shuah
On Tue, 19 Aug 2025 22:13:00 +0200, Jihed Chaibi wrote:
> 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.
>
> Link to v3 discussion:
> https://lore.kernel.org/all/20250816021523.167049-1-jihed.chaibi.dev@gmail.com/
>
> [...]
Applied to
https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next
Thanks!
[1/2] ASoC: dt-bindings: ti,twl4030-audio: convert to DT schema
commit: 04113322406b4763677922f80ba5ab44a8dae7bb
[2/2] ASoC: dt-bindings: omap-twl4030: convert to DT schema
commit: c232495d28ca092d0c39b10e35d3d613bd2414ab
All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.
You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.
If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.
Please add any relevant lists and maintainers to the CCs when replying
to this mail.
Thanks,
Mark
^ permalink raw reply [flat|nested] 6+ messages in thread