From: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
To: linux-kernel@vger.kernel.org
Cc: andreas@kemnade.info, 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 v2 7/9] Documentation: omap-twl4030: convert to DT schema
Date: Thu, 14 Aug 2025 15:21:27 +0200 [thread overview]
Message-ID: <20250814132129.138943-8-jihed.chaibi.dev@gmail.com> (raw)
In-Reply-To: <20250814132129.138943-1-jihed.chaibi.dev@gmail.com>
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.
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.
Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Jihed Chaibi <jihed.chaibi.dev@gmail.com>
---
.../bindings/sound/omap-twl4030.txt | 62 -----------
.../bindings/sound/ti,omap-twl4030.yaml | 102 ++++++++++++++++++
2 files changed, 102 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..7c9371860
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/ti,omap-twl4030.yaml
@@ -0,0 +1,102 @@
+# 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:
+ Bindings for 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.
+
+ Available TWL4030 Pins: "HFL", "HFR",
+ "PREDRIVEL", "PREDRIVER", "CARKITL", "CARKITR", "MAINMIC", "SUBMIC",
+ "HSMIC", "DIGIMIC0", "DIGIMIC1", "CARKITMIC", "AUXL", "AUXR",
+ "Headset Mic Bias", "Mic Bias 1", "Mic Bias 2"
+ $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
next prev parent reply other threads:[~2025-08-14 13:22 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-14 13:21 [PATCH v2 0/9] dt-bindings: Convert TWL4030/6040 family binding to DT schema Jihed Chaibi
2025-08-14 13:21 ` [PATCH v2 1/9] mfd: dt-bindings: ti,twl4030-audio: convert " Jihed Chaibi
2025-08-14 13:21 ` [PATCH v2 2/9] mfd: dt-bindings: ti,twl6040: " Jihed Chaibi
2025-08-14 14:27 ` Andreas Kemnade
2025-08-14 13:21 ` [PATCH v2 3/9] input: dt-bindings: ti,twl4030-keypad: " Jihed Chaibi
2025-08-14 18:35 ` Dmitry Torokhov
2025-08-14 13:21 ` [PATCH v2 4/9] mfd: dt-bindings: ti,twl4030-power: " Jihed Chaibi
2025-08-14 14:10 ` Andreas Kemnade
2025-08-14 13:21 ` [PATCH v2 5/9] pwm: dt-bindings: ti,twl-pwm: " Jihed Chaibi
2025-08-14 13:21 ` [PATCH v2 6/9] pwm: dt-bindings: ti,twl-pwmled: " Jihed Chaibi
2025-08-14 13:21 ` Jihed Chaibi [this message]
2025-08-14 13:33 ` [PATCH v2 7/9] Documentation: omap-twl4030: " Mark Brown
2025-08-14 14:27 ` Jihed Chaibi
2025-08-14 13:21 ` [PATCH v2 8/9] usb: dt-bindings: ti,twlxxxx-usb: " Jihed Chaibi
2025-08-14 13:21 ` [PATCH v2 9/9] dt-bindings: mfd: twl: Add missing sub-nodes for TWL4030 & TWL603x Jihed Chaibi
2025-08-14 14:22 ` Andreas Kemnade
2025-08-15 15:00 ` [PATCH v2 0/9] dt-bindings: Convert TWL4030/6040 family binding to DT schema Andreas Kemnade
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=20250814132129.138943-8-jihed.chaibi.dev@gmail.com \
--to=jihed.chaibi.dev@gmail.com \
--cc=andreas@kemnade.info \
--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).