Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

ASoC: dt-bindings: ti,twl4030-audio: convert to DT schema

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>
Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
Link: https://patch.msgid.link/20250819201302.80712-2-jihed.chaibi.dev@gmail.com
Signed-off-by: Mark Brown <broonie@kernel.org>

authored by

Jihed Chaibi and committed by
Mark Brown
04113322 c17b750b

+90 -46
-46
Documentation/devicetree/bindings/mfd/twl4030-audio.txt
··· 1 - Texas Instruments TWL family (twl4030) audio module 2 - 3 - The audio module inside the TWL family consist of an audio codec and a vibra 4 - driver. 5 - 6 - Required properties: 7 - - compatible : must be "ti,twl4030-audio" 8 - 9 - Optional properties, nodes: 10 - 11 - Audio functionality: 12 - - codec { }: Need to be present if the audio functionality is used. Within this 13 - section the following options can be used: 14 - - ti,digimic_delay: Delay need after enabling the digimic to reduce artifacts 15 - from the start of the recorded sample (in ms) 16 - -ti,ramp_delay_value: HS ramp delay configuration to reduce pop noise 17 - -ti,hs_extmute: Use external mute for HS pop reduction 18 - -ti,hs_extmute_gpio: Use external GPIO to control the external mute 19 - -ti,offset_cncl_path: Offset cancellation path selection, refer to TRM for the 20 - valid values. 21 - 22 - Vibra functionality 23 - - ti,enable-vibra: Need to be set to <1> if the vibra functionality is used. if 24 - missing or it is 0, the vibra functionality is disabled. 25 - 26 - Example: 27 - &i2c1 { 28 - clock-frequency = <2600000>; 29 - 30 - twl: twl@48 { 31 - reg = <0x48>; 32 - interrupts = <7>; /* SYS_NIRQ cascaded to intc */ 33 - interrupt-parent = <&intc>; 34 - 35 - twl_audio: audio { 36 - compatible = "ti,twl4030-audio"; 37 - 38 - ti,enable-vibra = <1>; 39 - 40 - codec { 41 - ti,ramp_delay_value = <3>; 42 - }; 43 - 44 - }; 45 - }; 46 - };
+90
Documentation/devicetree/bindings/sound/ti,twl4030-audio.yaml
··· 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 + };