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@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 allOf:
111 items: !! 106 - $ref: /schemas/types.yaml#/definitions/phandle-array
112 - items: !! 107 - maxItems: 1
113 - description: phandle of the SA <<
114 - description: index of the SAI <<
115 108
116 st,iec60958: 109 st,iec60958:
117 description: 110 description:
118 If set, support S/PDIF IEC6958 proto 111 If set, support S/PDIF IEC6958 protocol for playback.
119 IEC60958 protocol is not available f 112 IEC60958 protocol is not available for capture.
120 By default, custom protocol is assum 113 By default, custom protocol is assumed, meaning that protocol is
121 configured according to protocol def 114 configured according to protocol defined in related DAI link node,
122 such as i2s, left justified, right j 115 such as i2s, left justified, right justified, dsp and pdm protocols.
123 $ref: /schemas/types.yaml#/definitions !! 116 allOf:
>> 117 - $ref: /schemas/types.yaml#/definitions/flag
124 118
125 "#clock-cells": 119 "#clock-cells":
126 description: Configure the SAI device 120 description: Configure the SAI device as master clock provider.
127 const: 0 121 const: 0
128 122
129 port: <<
130 $ref: audio-graph-port.yaml# <<
131 unevaluatedProperties: false <<
132 <<
133 required: 123 required:
134 - compatible 124 - compatible
135 - "#sound-dai-cells" 125 - "#sound-dai-cells"
136 - reg 126 - reg
137 - clocks 127 - clocks
138 - clock-names 128 - clock-names
139 - dmas 129 - dmas
140 - dma-names 130 - dma-names
141 131
142 allOf: 132 allOf:
143 - if: 133 - if:
144 properties: 134 properties:
145 compatible: 135 compatible:
146 contains: 136 contains:
147 const: st,stm32f4-sai 137 const: st,stm32f4-sai
148 then: !! 138
>> 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
>> 151 - else:
160 properties: 152 properties:
161 clocks: 153 clocks:
162 items: 154 items:
163 - description: pclk feeds the peri 155 - description: pclk feeds the peripheral bus interface.
164 - description: x8k, SAI parent clo 156 - description: x8k, SAI parent clock for sampling rates multiple of 8kHz.
165 - description: x11k, SAI parent cl 157 - description: x11k, SAI parent clock for sampling rates multiple of 11.025kHz.
166 158
167 clock-names: 159 clock-names:
168 items: 160 items:
169 - const: pclk 161 - const: pclk
170 - const: x8k 162 - const: x8k
171 - const: x11k 163 - const: x11k
172 164
173 additionalProperties: false 165 additionalProperties: false
174 166
175 examples: 167 examples:
176 - | 168 - |
177 #include <dt-bindings/interrupt-controller 169 #include <dt-bindings/interrupt-controller/arm-gic.h>
178 #include <dt-bindings/clock/stm32mp1-clks. 170 #include <dt-bindings/clock/stm32mp1-clks.h>
179 #include <dt-bindings/reset/stm32mp1-reset 171 #include <dt-bindings/reset/stm32mp1-resets.h>
180 sai2: sai@4400b000 { 172 sai2: sai@4400b000 {
181 compatible = "st,stm32h7-sai"; 173 compatible = "st,stm32h7-sai";
182 #address-cells = <1>; 174 #address-cells = <1>;
183 #size-cells = <1>; 175 #size-cells = <1>;
184 ranges = <0 0x4400b000 0x400>; 176 ranges = <0 0x4400b000 0x400>;
185 reg = <0x4400b000 0x4>, <0x4400b3f0 0x10 177 reg = <0x4400b000 0x4>, <0x4400b3f0 0x10>;
186 clocks = <&rcc SAI2>, <&rcc PLL3_Q>, <&r 178 clocks = <&rcc SAI2>, <&rcc PLL3_Q>, <&rcc PLL3_R>;
187 clock-names = "pclk", "x8k", "x11k"; 179 clock-names = "pclk", "x8k", "x11k";
188 pinctrl-names = "default", "sleep"; 180 pinctrl-names = "default", "sleep";
189 pinctrl-0 = <&sai2a_pins_a>, <&sai2b_pin 181 pinctrl-0 = <&sai2a_pins_a>, <&sai2b_pins_b>;
190 pinctrl-1 = <&sai2a_sleep_pins_a>, <&sai 182 pinctrl-1 = <&sai2a_sleep_pins_a>, <&sai2b_sleep_pins_b>;
191 183
192 sai2a: audio-controller@4400b004 { 184 sai2a: audio-controller@4400b004 {
193 #sound-dai-cells = <0>; 185 #sound-dai-cells = <0>;
194 compatible = "st,stm32-sai-sub-a"; 186 compatible = "st,stm32-sai-sub-a";
195 reg = <0x4 0x1c>; 187 reg = <0x4 0x1c>;
196 dmas = <&dmamux1 89 0x400 0x01>; 188 dmas = <&dmamux1 89 0x400 0x01>;
197 dma-names = "tx"; 189 dma-names = "tx";
198 clocks = <&rcc SAI2_K>; 190 clocks = <&rcc SAI2_K>;
199 clock-names = "sai_ck"; 191 clock-names = "sai_ck";
200 }; 192 };
201 }; 193 };
202 194
203 ... 195 ...
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.