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
 7title: Texas Instruments TWL4030-family Audio Module
 8
 9maintainers:
10  - Peter Ujfalusi <peter.ujfalusi@gmail.com>
11
12description:
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
17properties:
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
63additionalProperties: false
64
65required:
66  - compatible
67
68examples:
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    };