1 # SPDX-License-Identifier: (GPL-2.0-only OR BS 1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2 2 %YAML 1.2
3 --- 3 ---
4 $id: http://devicetree.org/schemas/sound/st,st 4 $id: http://devicetree.org/schemas/sound/st,stm32-sai.yaml#
5 $schema: http://devicetree.org/meta-schemas/co 5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6 6
7 title: STMicroelectronics STM32 Serial Audio I 7 title: STMicroelectronics STM32 Serial Audio Interface (SAI)
8 8
9 maintainers: 9 maintainers:
10 - Olivier Moysan <olivier.moysan@foss.st.com> 10 - Olivier Moysan <olivier.moysan@foss.st.com>
11 11
12 description: 12 description:
13 The SAI interface (Serial Audio Interface) o 13 The SAI interface (Serial Audio Interface) offers a wide set of audio
14 protocols as I2S standards, LSB or MSB-justi 14 protocols as I2S standards, LSB or MSB-justified, PCM/DSP, TDM, and AC'97.
15 The SAI contains two independent audio sub-b 15 The SAI contains two independent audio sub-blocks. Each sub-block has
16 its own clock generator and I/O lines contro 16 its own clock generator and I/O lines controller.
17 17
18 properties: 18 properties:
19 compatible: 19 compatible:
20 enum: 20 enum:
21 - st,stm32f4-sai 21 - st,stm32f4-sai
22 - st,stm32h7-sai 22 - st,stm32h7-sai
23 23
24 reg: 24 reg:
25 items: 25 items:
26 - description: Base address and size of 26 - description: Base address and size of SAI common register set.
27 - description: Base address and size of 27 - description: Base address and size of SAI identification register set.
28 minItems: 1 28 minItems: 1
29 29
30 ranges: 30 ranges:
31 maxItems: 1 31 maxItems: 1
32 32
33 interrupts: 33 interrupts:
34 maxItems: 1 34 maxItems: 1
35 35
36 resets: 36 resets:
37 maxItems: 1 37 maxItems: 1
38 38
39 "#address-cells": 39 "#address-cells":
40 const: 1 40 const: 1
41 41
42 "#size-cells": 42 "#size-cells":
43 const: 1 43 const: 1
44 44
45 clocks: 45 clocks:
46 maxItems: 3 46 maxItems: 3
47 47
48 clock-names: 48 clock-names:
49 maxItems: 3 49 maxItems: 3
50 50
51 access-controllers: <<
52 minItems: 1 <<
53 maxItems: 2 <<
54 <<
55 required: 51 required:
56 - compatible 52 - compatible
57 - reg 53 - reg
58 - ranges 54 - ranges
59 - "#address-cells" 55 - "#address-cells"
60 - "#size-cells" 56 - "#size-cells"
61 - clocks 57 - clocks
62 - clock-names 58 - clock-names
63 59
64 patternProperties: 60 patternProperties:
65 "^audio-controller@[0-9a-f]+$": 61 "^audio-controller@[0-9a-f]+$":
66 type: object 62 type: object
67 additionalProperties: false <<
68 description: 63 description:
69 Two subnodes corresponding to SAI sub-bl 64 Two subnodes corresponding to SAI sub-block instances A et B
70 can be defined. Subnode can be omitted f !! 65 can be defined. Subnode can be omitted for unsused sub-block.
71 66
72 properties: 67 properties:
73 compatible: 68 compatible:
74 description: Compatible for SAI sub-bl 69 description: Compatible for SAI sub-block A or B.
75 pattern: "^st,stm32-sai-sub-[ab]$" !! 70 pattern: "st,stm32-sai-sub-[ab]"
76 71
77 "#sound-dai-cells": 72 "#sound-dai-cells":
78 const: 0 73 const: 0
79 74
80 reg: 75 reg:
81 maxItems: 1 76 maxItems: 1
82 77
83 clocks: 78 clocks:
84 items: 79 items:
85 - description: sai_ck clock feeding 80 - description: sai_ck clock feeding the internal clock generator.
86 - description: MCLK clock from a SAI 81 - description: MCLK clock from a SAI set as master clock provider.
87 minItems: 1 82 minItems: 1
88 83
89 clock-names: 84 clock-names:
90 items: 85 items:
91 - const: sai_ck 86 - const: sai_ck
92 - const: MCLK 87 - const: MCLK
93 minItems: 1 88 minItems: 1
94 89
95 dmas: 90 dmas:
96 maxItems: 1 91 maxItems: 1
97 92
98 dma-names: 93 dma-names:
99 description: | 94 description: |
100 rx: SAI sub-block is configured as a 95 rx: SAI sub-block is configured as a capture DAI.
101 tx: SAI sub-block is configured as a 96 tx: SAI sub-block is configured as a playback DAI.
102 enum: [ rx, tx ] 97 enum: [ rx, tx ]
103 98
104 st,sync: 99 st,sync:
105 description: 100 description:
106 Configure the SAI sub-block as slave 101 Configure the SAI sub-block as slave of another SAI sub-block.
107 By default SAI sub-block is in async 102 By default SAI sub-block is in asynchronous mode.
108 Must contain the phandle and index o 103 Must contain the phandle and index of the SAI sub-block providing
109 the synchronization. 104 the synchronization.
110 $ref: /schemas/types.yaml#/definitions 105 $ref: /schemas/types.yaml#/definitions/phandle-array
111 items: 106 items:
112 - items: 107 - items:
113 - description: phandle of the SA 108 - description: phandle of the SAI sub-block
114 - description: index of the SAI 109 - description: index of the SAI sub-block
115 110
116 st,iec60958: 111 st,iec60958:
117 description: 112 description:
118 If set, support S/PDIF IEC6958 proto 113 If set, support S/PDIF IEC6958 protocol for playback.
119 IEC60958 protocol is not available f 114 IEC60958 protocol is not available for capture.
120 By default, custom protocol is assum 115 By default, custom protocol is assumed, meaning that protocol is
121 configured according to protocol def 116 configured according to protocol defined in related DAI link node,
122 such as i2s, left justified, right j 117 such as i2s, left justified, right justified, dsp and pdm protocols.
123 $ref: /schemas/types.yaml#/definitions 118 $ref: /schemas/types.yaml#/definitions/flag
124 119
125 "#clock-cells": 120 "#clock-cells":
126 description: Configure the SAI device 121 description: Configure the SAI device as master clock provider.
127 const: 0 122 const: 0
128 <<
129 port: <<
130 $ref: audio-graph-port.yaml# <<
131 unevaluatedProperties: false <<
132 123
133 required: 124 required:
134 - compatible 125 - compatible
135 - "#sound-dai-cells" 126 - "#sound-dai-cells"
136 - reg 127 - reg
137 - clocks 128 - clocks
138 - clock-names 129 - clock-names
139 - dmas 130 - dmas
140 - dma-names 131 - dma-names
141 132
142 allOf: 133 allOf:
143 - if: 134 - if:
144 properties: 135 properties:
145 compatible: 136 compatible:
146 contains: 137 contains:
147 const: st,stm32f4-sai 138 const: st,stm32f4-sai
148 then: 139 then:
149 properties: 140 properties:
150 clocks: 141 clocks:
151 items: 142 items:
152 - description: x8k, SAI parent clo 143 - description: x8k, SAI parent clock for sampling rates multiple of 8kHz.
153 - description: x11k, SAI parent cl 144 - description: x11k, SAI parent clock for sampling rates multiple of 11.025kHz.
154 145
155 clock-names: 146 clock-names:
156 items: 147 items:
157 - const: x8k 148 - const: x8k
158 - const: x11k 149 - const: x11k
159 else: 150 else:
160 properties: 151 properties:
161 clocks: 152 clocks:
162 items: 153 items:
163 - description: pclk feeds the peri 154 - description: pclk feeds the peripheral bus interface.
164 - description: x8k, SAI parent clo 155 - description: x8k, SAI parent clock for sampling rates multiple of 8kHz.
165 - description: x11k, SAI parent cl 156 - description: x11k, SAI parent clock for sampling rates multiple of 11.025kHz.
166 157
167 clock-names: 158 clock-names:
168 items: 159 items:
169 - const: pclk 160 - const: pclk
170 - const: x8k 161 - const: x8k
171 - const: x11k 162 - const: x11k
172 163
173 additionalProperties: false 164 additionalProperties: false
174 165
175 examples: 166 examples:
176 - | 167 - |
177 #include <dt-bindings/interrupt-controller 168 #include <dt-bindings/interrupt-controller/arm-gic.h>
178 #include <dt-bindings/clock/stm32mp1-clks. 169 #include <dt-bindings/clock/stm32mp1-clks.h>
179 #include <dt-bindings/reset/stm32mp1-reset 170 #include <dt-bindings/reset/stm32mp1-resets.h>
180 sai2: sai@4400b000 { 171 sai2: sai@4400b000 {
181 compatible = "st,stm32h7-sai"; 172 compatible = "st,stm32h7-sai";
182 #address-cells = <1>; 173 #address-cells = <1>;
183 #size-cells = <1>; 174 #size-cells = <1>;
184 ranges = <0 0x4400b000 0x400>; 175 ranges = <0 0x4400b000 0x400>;
185 reg = <0x4400b000 0x4>, <0x4400b3f0 0x10 176 reg = <0x4400b000 0x4>, <0x4400b3f0 0x10>;
186 clocks = <&rcc SAI2>, <&rcc PLL3_Q>, <&r 177 clocks = <&rcc SAI2>, <&rcc PLL3_Q>, <&rcc PLL3_R>;
187 clock-names = "pclk", "x8k", "x11k"; 178 clock-names = "pclk", "x8k", "x11k";
188 pinctrl-names = "default", "sleep"; 179 pinctrl-names = "default", "sleep";
189 pinctrl-0 = <&sai2a_pins_a>, <&sai2b_pin 180 pinctrl-0 = <&sai2a_pins_a>, <&sai2b_pins_b>;
190 pinctrl-1 = <&sai2a_sleep_pins_a>, <&sai 181 pinctrl-1 = <&sai2a_sleep_pins_a>, <&sai2b_sleep_pins_b>;
191 182
192 sai2a: audio-controller@4400b004 { 183 sai2a: audio-controller@4400b004 {
193 #sound-dai-cells = <0>; 184 #sound-dai-cells = <0>;
194 compatible = "st,stm32-sai-sub-a"; 185 compatible = "st,stm32-sai-sub-a";
195 reg = <0x4 0x1c>; 186 reg = <0x4 0x1c>;
196 dmas = <&dmamux1 89 0x400 0x01>; 187 dmas = <&dmamux1 89 0x400 0x01>;
197 dma-names = "tx"; 188 dma-names = "tx";
198 clocks = <&rcc SAI2_K>; 189 clocks = <&rcc SAI2_K>;
199 clock-names = "sai_ck"; 190 clock-names = "sai_ck";
200 }; 191 };
201 }; 192 };
202 193
203 ... 194 ...
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.