xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/sound/nvidia,tegra210-i2s.yaml (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2*4882a593Smuzhiyun%YAML 1.2
3*4882a593Smuzhiyun---
4*4882a593Smuzhiyun$id: http://devicetree.org/schemas/sound/nvidia,tegra210-i2s.yaml#
5*4882a593Smuzhiyun$schema: http://devicetree.org/meta-schemas/core.yaml#
6*4882a593Smuzhiyun
7*4882a593Smuzhiyuntitle: Tegra210 I2S Controller Device Tree Bindings
8*4882a593Smuzhiyun
9*4882a593Smuzhiyundescription: |
10*4882a593Smuzhiyun  The Inter-IC Sound (I2S) controller implements full-duplex,
11*4882a593Smuzhiyun  bi-directional and single direction point-to-point serial
12*4882a593Smuzhiyun  interfaces. It can interface with I2S compatible devices.
13*4882a593Smuzhiyun  I2S controller can operate both in master and slave mode.
14*4882a593Smuzhiyun
15*4882a593Smuzhiyunmaintainers:
16*4882a593Smuzhiyun  - Jon Hunter <jonathanh@nvidia.com>
17*4882a593Smuzhiyun  - Sameer Pujar <spujar@nvidia.com>
18*4882a593Smuzhiyun
19*4882a593Smuzhiyunproperties:
20*4882a593Smuzhiyun  $nodename:
21*4882a593Smuzhiyun    pattern: "^i2s@[0-9a-f]*$"
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun  compatible:
24*4882a593Smuzhiyun    oneOf:
25*4882a593Smuzhiyun      - const: nvidia,tegra210-i2s
26*4882a593Smuzhiyun      - items:
27*4882a593Smuzhiyun          - enum:
28*4882a593Smuzhiyun              - nvidia,tegra194-i2s
29*4882a593Smuzhiyun              - nvidia,tegra186-i2s
30*4882a593Smuzhiyun          - const: nvidia,tegra210-i2s
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun  reg:
33*4882a593Smuzhiyun    maxItems: 1
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun  clocks:
36*4882a593Smuzhiyun    minItems: 1
37*4882a593Smuzhiyun    maxItems: 2
38*4882a593Smuzhiyun    items:
39*4882a593Smuzhiyun      - description: I2S bit clock
40*4882a593Smuzhiyun      - description:
41*4882a593Smuzhiyun          Sync input clock, which can act as clock source to other I/O
42*4882a593Smuzhiyun          modules in AHUB. The Tegra I2S driver sets this clock rate as
43*4882a593Smuzhiyun          per bit clock rate. I/O module which wants to use this clock
44*4882a593Smuzhiyun          as source, can mention this clock as parent in the DT bindings.
45*4882a593Smuzhiyun          This is an optional clock entry, since it is only required when
46*4882a593Smuzhiyun          some other I/O wants to reference from a particular I2Sx
47*4882a593Smuzhiyun          instance.
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun  clock-names:
50*4882a593Smuzhiyun    minItems: 1
51*4882a593Smuzhiyun    maxItems: 2
52*4882a593Smuzhiyun    items:
53*4882a593Smuzhiyun      - const: i2s
54*4882a593Smuzhiyun      - const: sync_input
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun  assigned-clocks:
57*4882a593Smuzhiyun    minItems: 1
58*4882a593Smuzhiyun    maxItems: 2
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun  assigned-clock-parents:
61*4882a593Smuzhiyun    minItems: 1
62*4882a593Smuzhiyun    maxItems: 2
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun  assigned-clock-rates:
65*4882a593Smuzhiyun    minItems: 1
66*4882a593Smuzhiyun    maxItems: 2
67*4882a593Smuzhiyun
68*4882a593Smuzhiyun  sound-name-prefix:
69*4882a593Smuzhiyun    pattern: "^I2S[1-9]$"
70*4882a593Smuzhiyun    $ref: /schemas/types.yaml#/definitions/string
71*4882a593Smuzhiyun    description:
72*4882a593Smuzhiyun      Used as prefix for sink/source names of the component. Must be a
73*4882a593Smuzhiyun      unique string among multiple instances of the same component.
74*4882a593Smuzhiyun      The name can be "I2S1" or "I2S2" ... "I2Sx", where x depends
75*4882a593Smuzhiyun      on the maximum available instances on a Tegra SoC.
76*4882a593Smuzhiyun
77*4882a593Smuzhiyunrequired:
78*4882a593Smuzhiyun  - compatible
79*4882a593Smuzhiyun  - reg
80*4882a593Smuzhiyun  - clocks
81*4882a593Smuzhiyun  - clock-names
82*4882a593Smuzhiyun  - assigned-clocks
83*4882a593Smuzhiyun  - assigned-clock-parents
84*4882a593Smuzhiyun
85*4882a593SmuzhiyunadditionalProperties: false
86*4882a593Smuzhiyun
87*4882a593Smuzhiyunexamples:
88*4882a593Smuzhiyun  - |
89*4882a593Smuzhiyun    #include<dt-bindings/clock/tegra210-car.h>
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun    i2s@702d1000 {
92*4882a593Smuzhiyun        compatible = "nvidia,tegra210-i2s";
93*4882a593Smuzhiyun        reg = <0x702d1000 0x100>;
94*4882a593Smuzhiyun        clocks = <&tegra_car TEGRA210_CLK_I2S0>;
95*4882a593Smuzhiyun        clock-names = "i2s";
96*4882a593Smuzhiyun        assigned-clocks = <&tegra_car TEGRA210_CLK_I2S0>;
97*4882a593Smuzhiyun        assigned-clock-parents = <&tegra_car TEGRA210_CLK_PLL_A_OUT0>;
98*4882a593Smuzhiyun        assigned-clock-rates = <1536000>;
99*4882a593Smuzhiyun        sound-name-prefix = "I2S1";
100*4882a593Smuzhiyun    };
101*4882a593Smuzhiyun
102*4882a593Smuzhiyun...
103