From: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
To: linux-kernel@vger.kernel.org
Cc: peter.ujfalusi@gmail.com, dmitry.torokhov@gmail.com,
robh@kernel.org, krzk+dt@kernel.org, lgirdwood@gmail.com,
tiwai@suse.com, conor+dt@kernel.org, lee@kernel.org,
ukleinek@kernel.org, broonie@kernel.org,
gregkh@linuxfoundation.org, linux-input@vger.kernel.org,
devicetree@vger.kernel.org, linux-pwm@vger.kernel.org,
linux-sound@vger.kernel.org, linux-usb@vger.kernel.org,
shuah@kernel.org, jihed.chaibi.dev@gmail.com
Subject: [PATCH 1/8] mfd: dt-bindings: ti,twl4030-audio: convert to DT schema
Date: Tue, 12 Aug 2025 00:47:32 +0200 [thread overview]
Message-ID: <20250811224739.53869-2-jihed.chaibi.dev@gmail.com> (raw)
In-Reply-To: <20250811224739.53869-1-jihed.chaibi.dev@gmail.com>
Convert the legacy TXT binding for the TWL4030 audio module
to the modern YAML DT schema format. This adds formal validation
and improves documentation.
Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
---
.../bindings/mfd/ti,twl4030-audio.yaml | 91 +++++++++++++++++++
.../devicetree/bindings/mfd/twl4030-audio.txt | 46 ----------
2 files changed, 91 insertions(+), 46 deletions(-)
create mode 100644 Documentation/devicetree/bindings/mfd/ti,twl4030-audio.yaml
delete mode 100644 Documentation/devicetree/bindings/mfd/twl4030-audio.txt
diff --git a/Documentation/devicetree/bindings/mfd/ti,twl4030-audio.yaml b/Documentation/devicetree/bindings/mfd/ti,twl4030-audio.yaml
new file mode 100644
index 000000000..16ddcf007
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/ti,twl4030-audio.yaml
@@ -0,0 +1,91 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/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
+ description: |
+ Set to 1 to enable the vibra functionality, if missing
+ or it is 0, the vibra functionality is disabled.
+
+additionalProperties: false
+
+required:
+ - compatible
+
+examples:
+ - |
+ i2c {
+
+ clock-frequency = <2600000>;
+ #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>;
+ };
+
+ };
+ };
+ };
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>;
- };
-
- };
- };
-};
--
2.39.5
next prev parent reply other threads:[~2025-08-11 22:47 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-11 22:47 [PATCH 0/8] dt-bindings: Convert TWL4030/6040 family binding to DT schema Jihed Chaibi
2025-08-11 22:47 ` Jihed Chaibi [this message]
2025-08-12 14:58 ` [PATCH 1/8] mfd: dt-bindings: ti,twl4030-audio: convert " Rob Herring
2025-08-11 22:47 ` [PATCH 2/8] mfd: dt-bindings: ti,twl6040: " Jihed Chaibi
2025-08-12 1:24 ` Rob Herring (Arm)
2025-08-12 14:54 ` Rob Herring
2025-08-12 16:06 ` Jihed Chaibi
2025-08-14 21:24 ` Rob Herring
2025-08-11 22:47 ` [PATCH 3/8] input: dt-bindings: ti,twl4030-keypad: " Jihed Chaibi
2025-08-11 22:47 ` [PATCH 4/8] mfd: dt-bindings: ti,twl4030-power: " Jihed Chaibi
2025-08-11 22:47 ` [PATCH 5/8] pwm: dt-bindings: ti,twl-pwm: " Jihed Chaibi
2025-08-19 6:08 ` Uwe Kleine-König
2025-08-11 22:47 ` [PATCH 6/8] pwm: dt-bindings: ti,twl-pwmled: " Jihed Chaibi
2025-08-11 22:47 ` [PATCH 7/8] sound: dt-bindings: ti,omap-twl4030: " Jihed Chaibi
2025-08-13 20:29 ` Mark Brown
2025-08-18 18:03 ` Rob Herring
2025-08-11 22:47 ` [PATCH 8/8] usb: dt-bindings: ti,twlxxxx-usb: " Jihed Chaibi
2025-08-19 6:09 ` [PATCH 0/8] dt-bindings: Convert TWL4030/6040 family binding " Uwe Kleine-König
2025-08-19 13:19 ` Jihed Chaibi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250811224739.53869-2-jihed.chaibi.dev@gmail.com \
--to=jihed.chaibi.dev@gmail.com \
--cc=broonie@kernel.org \
--cc=conor+dt@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=dmitry.torokhov@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=krzk+dt@kernel.org \
--cc=lee@kernel.org \
--cc=lgirdwood@gmail.com \
--cc=linux-input@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pwm@vger.kernel.org \
--cc=linux-sound@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=peter.ujfalusi@gmail.com \
--cc=robh@kernel.org \
--cc=shuah@kernel.org \
--cc=tiwai@suse.com \
--cc=ukleinek@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).