1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright 2012-2013 Freescale Semiconductor, Inc.
4 */
5
6#ifndef __FSL_SAI_H
7#define __FSL_SAI_H
8
9#include <linux/dma/imx-dma.h>
10#include <sound/dmaengine_pcm.h>
11
12#define FSL_SAI_FORMATS (SNDRV_PCM_FMTBIT_S16_LE |\
13 SNDRV_PCM_FMTBIT_S20_3LE |\
14 SNDRV_PCM_FMTBIT_S24_LE |\
15 SNDRV_PCM_FMTBIT_S32_LE |\
16 SNDRV_PCM_FMTBIT_DSD_U8 |\
17 SNDRV_PCM_FMTBIT_DSD_U16_LE |\
18 SNDRV_PCM_FMTBIT_DSD_U32_LE)
19
20/* SAI Register Map Register */
21#define FSL_SAI_VERID 0x00 /* SAI Version ID Register */
22#define FSL_SAI_PARAM 0x04 /* SAI Parameter Register */
23#define FSL_SAI_TCSR(ofs) (0x00 + ofs) /* SAI Transmit Control */
24#define FSL_SAI_TCR1(ofs) (0x04 + ofs) /* SAI Transmit Configuration 1 */
25#define FSL_SAI_TCR2(ofs) (0x08 + ofs) /* SAI Transmit Configuration 2 */
26#define FSL_SAI_TCR3(ofs) (0x0c + ofs) /* SAI Transmit Configuration 3 */
27#define FSL_SAI_TCR4(ofs) (0x10 + ofs) /* SAI Transmit Configuration 4 */
28#define FSL_SAI_TCR5(ofs) (0x14 + ofs) /* SAI Transmit Configuration 5 */
29#define FSL_SAI_TDR0 0x20 /* SAI Transmit Data 0 */
30#define FSL_SAI_TDR1 0x24 /* SAI Transmit Data 1 */
31#define FSL_SAI_TDR2 0x28 /* SAI Transmit Data 2 */
32#define FSL_SAI_TDR3 0x2C /* SAI Transmit Data 3 */
33#define FSL_SAI_TDR4 0x30 /* SAI Transmit Data 4 */
34#define FSL_SAI_TDR5 0x34 /* SAI Transmit Data 5 */
35#define FSL_SAI_TDR6 0x38 /* SAI Transmit Data 6 */
36#define FSL_SAI_TDR7 0x3C /* SAI Transmit Data 7 */
37#define FSL_SAI_TFR0 0x40 /* SAI Transmit FIFO 0 */
38#define FSL_SAI_TFR1 0x44 /* SAI Transmit FIFO 1 */
39#define FSL_SAI_TFR2 0x48 /* SAI Transmit FIFO 2 */
40#define FSL_SAI_TFR3 0x4C /* SAI Transmit FIFO 3 */
41#define FSL_SAI_TFR4 0x50 /* SAI Transmit FIFO 4 */
42#define FSL_SAI_TFR5 0x54 /* SAI Transmit FIFO 5 */
43#define FSL_SAI_TFR6 0x58 /* SAI Transmit FIFO 6 */
44#define FSL_SAI_TFR7 0x5C /* SAI Transmit FIFO 7 */
45#define FSL_SAI_TMR 0x60 /* SAI Transmit Mask */
46#define FSL_SAI_TTCTL 0x70 /* SAI Transmit Timestamp Control Register */
47#define FSL_SAI_TTCTN 0x74 /* SAI Transmit Timestamp Counter Register */
48#define FSL_SAI_TBCTN 0x78 /* SAI Transmit Bit Counter Register */
49#define FSL_SAI_TTCAP 0x7C /* SAI Transmit Timestamp Capture */
50#define FSL_SAI_RCSR(ofs) (0x80 + ofs) /* SAI Receive Control */
51#define FSL_SAI_RCR1(ofs) (0x84 + ofs)/* SAI Receive Configuration 1 */
52#define FSL_SAI_RCR2(ofs) (0x88 + ofs) /* SAI Receive Configuration 2 */
53#define FSL_SAI_RCR3(ofs) (0x8c + ofs) /* SAI Receive Configuration 3 */
54#define FSL_SAI_RCR4(ofs) (0x90 + ofs) /* SAI Receive Configuration 4 */
55#define FSL_SAI_RCR5(ofs) (0x94 + ofs) /* SAI Receive Configuration 5 */
56#define FSL_SAI_RDR0 0xa0 /* SAI Receive Data 0 */
57#define FSL_SAI_RDR1 0xa4 /* SAI Receive Data 1 */
58#define FSL_SAI_RDR2 0xa8 /* SAI Receive Data 2 */
59#define FSL_SAI_RDR3 0xac /* SAI Receive Data 3 */
60#define FSL_SAI_RDR4 0xb0 /* SAI Receive Data 4 */
61#define FSL_SAI_RDR5 0xb4 /* SAI Receive Data 5 */
62#define FSL_SAI_RDR6 0xb8 /* SAI Receive Data 6 */
63#define FSL_SAI_RDR7 0xbc /* SAI Receive Data 7 */
64#define FSL_SAI_RFR0 0xc0 /* SAI Receive FIFO 0 */
65#define FSL_SAI_RFR1 0xc4 /* SAI Receive FIFO 1 */
66#define FSL_SAI_RFR2 0xc8 /* SAI Receive FIFO 2 */
67#define FSL_SAI_RFR3 0xcc /* SAI Receive FIFO 3 */
68#define FSL_SAI_RFR4 0xd0 /* SAI Receive FIFO 4 */
69#define FSL_SAI_RFR5 0xd4 /* SAI Receive FIFO 5 */
70#define FSL_SAI_RFR6 0xd8 /* SAI Receive FIFO 6 */
71#define FSL_SAI_RFR7 0xdc /* SAI Receive FIFO 7 */
72#define FSL_SAI_RMR 0xe0 /* SAI Receive Mask */
73#define FSL_SAI_RTCTL 0xf0 /* SAI Receive Timestamp Control Register */
74#define FSL_SAI_RTCTN 0xf4 /* SAI Receive Timestamp Counter Register */
75#define FSL_SAI_RBCTN 0xf8 /* SAI Receive Bit Counter Register */
76#define FSL_SAI_RTCAP 0xfc /* SAI Receive Timestamp Capture */
77
78#define FSL_SAI_MCTL 0x100 /* SAI MCLK Control Register */
79#define FSL_SAI_MDIV 0x104 /* SAI MCLK Divide Register */
80
81#define FSL_SAI_xCSR(tx, ofs) (tx ? FSL_SAI_TCSR(ofs) : FSL_SAI_RCSR(ofs))
82#define FSL_SAI_xCR1(tx, ofs) (tx ? FSL_SAI_TCR1(ofs) : FSL_SAI_RCR1(ofs))
83#define FSL_SAI_xCR2(tx, ofs) (tx ? FSL_SAI_TCR2(ofs) : FSL_SAI_RCR2(ofs))
84#define FSL_SAI_xCR3(tx, ofs) (tx ? FSL_SAI_TCR3(ofs) : FSL_SAI_RCR3(ofs))
85#define FSL_SAI_xCR4(tx, ofs) (tx ? FSL_SAI_TCR4(ofs) : FSL_SAI_RCR4(ofs))
86#define FSL_SAI_xCR5(tx, ofs) (tx ? FSL_SAI_TCR5(ofs) : FSL_SAI_RCR5(ofs))
87#define FSL_SAI_xDR0(tx) (tx ? FSL_SAI_TDR0 : FSL_SAI_RDR0)
88#define FSL_SAI_xFR0(tx) (tx ? FSL_SAI_TFR0 : FSL_SAI_RFR0)
89#define FSL_SAI_xMR(tx) (tx ? FSL_SAI_TMR : FSL_SAI_RMR)
90
91/* SAI Transmit/Receive Control Register */
92#define FSL_SAI_CSR_TERE BIT(31)
93#define FSL_SAI_CSR_SE BIT(30)
94#define FSL_SAI_CSR_BCE BIT(28)
95#define FSL_SAI_CSR_FR BIT(25)
96#define FSL_SAI_CSR_SR BIT(24)
97#define FSL_SAI_CSR_xF_SHIFT 16
98#define FSL_SAI_CSR_xF_W_SHIFT 18
99#define FSL_SAI_CSR_xF_MASK (0x1f << FSL_SAI_CSR_xF_SHIFT)
100#define FSL_SAI_CSR_xF_W_MASK (0x7 << FSL_SAI_CSR_xF_W_SHIFT)
101#define FSL_SAI_CSR_WSF BIT(20)
102#define FSL_SAI_CSR_SEF BIT(19)
103#define FSL_SAI_CSR_FEF BIT(18)
104#define FSL_SAI_CSR_FWF BIT(17)
105#define FSL_SAI_CSR_FRF BIT(16)
106#define FSL_SAI_CSR_xIE_SHIFT 8
107#define FSL_SAI_CSR_xIE_MASK (0x1f << FSL_SAI_CSR_xIE_SHIFT)
108#define FSL_SAI_CSR_WSIE BIT(12)
109#define FSL_SAI_CSR_SEIE BIT(11)
110#define FSL_SAI_CSR_FEIE BIT(10)
111#define FSL_SAI_CSR_FWIE BIT(9)
112#define FSL_SAI_CSR_FRIE BIT(8)
113#define FSL_SAI_CSR_FRDE BIT(0)
114
115/* SAI Transmit and Receive Configuration 1 Register */
116#define FSL_SAI_CR1_RFW_MASK(x) ((x) - 1)
117
118/* SAI Transmit and Receive Configuration 2 Register */
119#define FSL_SAI_CR2_SYNC BIT(30)
120#define FSL_SAI_CR2_BCI BIT(28)
121#define FSL_SAI_CR2_MSEL_MASK (0x3 << 26)
122#define FSL_SAI_CR2_MSEL_BUS 0
123#define FSL_SAI_CR2_MSEL_MCLK1 BIT(26)
124#define FSL_SAI_CR2_MSEL_MCLK2 BIT(27)
125#define FSL_SAI_CR2_MSEL_MCLK3 (BIT(26) | BIT(27))
126#define FSL_SAI_CR2_MSEL(ID) ((ID) << 26)
127#define FSL_SAI_CR2_BCP BIT(25)
128#define FSL_SAI_CR2_BCD_MSTR BIT(24)
129#define FSL_SAI_CR2_BYP BIT(23) /* BCLK bypass */
130#define FSL_SAI_CR2_DIV_MASK 0xff
131
132/* SAI Transmit and Receive Configuration 3 Register */
133#define FSL_SAI_CR3_TRCE(x) ((x) << 16)
134#define FSL_SAI_CR3_TRCE_MASK GENMASK(23, 16)
135#define FSL_SAI_CR3_WDFL(x) (x)
136#define FSL_SAI_CR3_WDFL_MASK 0x1f
137
138/* SAI Transmit and Receive Configuration 4 Register */
139
140#define FSL_SAI_CR4_FCONT BIT(28)
141#define FSL_SAI_CR4_FCOMB_SHIFT BIT(26)
142#define FSL_SAI_CR4_FCOMB_SOFT BIT(27)
143#define FSL_SAI_CR4_FCOMB_MASK (0x3 << 26)
144#define FSL_SAI_CR4_FPACK_8 (0x2 << 24)
145#define FSL_SAI_CR4_FPACK_16 (0x3 << 24)
146#define FSL_SAI_CR4_FRSZ(x) (((x) - 1) << 16)
147#define FSL_SAI_CR4_FRSZ_MASK (0x1f << 16)
148#define FSL_SAI_CR4_SYWD(x) (((x) - 1) << 8)
149#define FSL_SAI_CR4_SYWD_MASK (0x1f << 8)
150#define FSL_SAI_CR4_CHMOD BIT(5)
151#define FSL_SAI_CR4_CHMOD_MASK BIT(5)
152#define FSL_SAI_CR4_MF BIT(4)
153#define FSL_SAI_CR4_FSE BIT(3)
154#define FSL_SAI_CR4_FSP BIT(1)
155#define FSL_SAI_CR4_FSD_MSTR BIT(0)
156
157/* SAI Transmit and Receive Configuration 5 Register */
158#define FSL_SAI_CR5_WNW(x) (((x) - 1) << 24)
159#define FSL_SAI_CR5_WNW_MASK (0x1f << 24)
160#define FSL_SAI_CR5_W0W(x) (((x) - 1) << 16)
161#define FSL_SAI_CR5_W0W_MASK (0x1f << 16)
162#define FSL_SAI_CR5_FBT(x) ((x) << 8)
163#define FSL_SAI_CR5_FBT_MASK (0x1f << 8)
164
165/* SAI MCLK Control Register */
166#define FSL_SAI_MCTL_MCLK_EN BIT(30) /* MCLK Enable */
167#define FSL_SAI_MCTL_MSEL_MASK (0x3 << 24)
168#define FSL_SAI_MCTL_MSEL(ID) ((ID) << 24)
169#define FSL_SAI_MCTL_MSEL_BUS 0
170#define FSL_SAI_MCTL_MSEL_MCLK1 BIT(24)
171#define FSL_SAI_MCTL_MSEL_MCLK2 BIT(25)
172#define FSL_SAI_MCTL_MSEL_MCLK3 (BIT(24) | BIT(25))
173#define FSL_SAI_MCTL_DIV_EN BIT(23)
174#define FSL_SAI_MCTL_DIV_MASK 0xFF
175
176/* SAI VERID Register */
177#define FSL_SAI_VERID_MAJOR_SHIFT 24
178#define FSL_SAI_VERID_MAJOR_MASK GENMASK(31, 24)
179#define FSL_SAI_VERID_MINOR_SHIFT 16
180#define FSL_SAI_VERID_MINOR_MASK GENMASK(23, 16)
181#define FSL_SAI_VERID_FEATURE_SHIFT 0
182#define FSL_SAI_VERID_FEATURE_MASK GENMASK(15, 0)
183#define FSL_SAI_VERID_EFIFO_EN BIT(0)
184#define FSL_SAI_VERID_TSTMP_EN BIT(1)
185
186/* SAI PARAM Register */
187#define FSL_SAI_PARAM_SPF_SHIFT 16
188#define FSL_SAI_PARAM_SPF_MASK GENMASK(19, 16)
189#define FSL_SAI_PARAM_WPF_SHIFT 8
190#define FSL_SAI_PARAM_WPF_MASK GENMASK(11, 8)
191#define FSL_SAI_PARAM_DLN_MASK GENMASK(3, 0)
192
193/* SAI MCLK Divide Register */
194#define FSL_SAI_MDIV_MASK 0xFFFFF
195
196/* SAI timestamp and bitcounter */
197#define FSL_SAI_xTCTL_TSEN BIT(0)
198#define FSL_SAI_xTCTL_TSINC BIT(1)
199#define FSL_SAI_xTCTL_RTSC BIT(8)
200#define FSL_SAI_xTCTL_RBC BIT(9)
201
202/* SAI type */
203#define FSL_SAI_DMA BIT(0)
204#define FSL_SAI_USE_AC97 BIT(1)
205#define FSL_SAI_NET BIT(2)
206#define FSL_SAI_TRA_SYN BIT(3)
207#define FSL_SAI_REC_SYN BIT(4)
208#define FSL_SAI_USE_I2S_SLAVE BIT(5)
209
210/* SAI clock sources */
211#define FSL_SAI_CLK_BUS 0
212#define FSL_SAI_CLK_MAST1 1
213#define FSL_SAI_CLK_MAST2 2
214#define FSL_SAI_CLK_MAST3 3
215
216#define FSL_SAI_MCLK_MAX 4
217
218/* SAI data transfer numbers per DMA request */
219#define FSL_SAI_MAXBURST_TX 6
220#define FSL_SAI_MAXBURST_RX 6
221
222#define PMQOS_CPU_LATENCY BIT(0)
223
224/* Max number of dataline */
225#define FSL_SAI_DL_NUM (8)
226/* default dataline type is zero */
227#define FSL_SAI_DL_DEFAULT (0)
228#define FSL_SAI_DL_I2S BIT(0)
229#define FSL_SAI_DL_PDM BIT(1)
230
231struct fsl_sai_soc_data {
232 bool use_imx_pcm;
233 bool use_edma;
234 bool mclk0_is_mclk1;
235 bool mclk_with_tere;
236 unsigned int fifo_depth;
237 unsigned int pins;
238 unsigned int reg_offset;
239 unsigned int flags;
240 unsigned int max_register;
241 unsigned int max_burst[2];
242};
243
244/**
245 * struct fsl_sai_verid - version id data
246 * @version: version number
247 * @feature: feature specification number
248 * 0000000000000000b - Standard feature set
249 * 0000000000000000b - Standard feature set
250 */
251struct fsl_sai_verid {
252 u32 version;
253 u32 feature;
254};
255
256/**
257 * struct fsl_sai_param - parameter data
258 * @slot_num: The maximum number of slots per frame
259 * @fifo_depth: The number of words in each FIFO (depth)
260 * @dataline: The number of datalines implemented
261 */
262struct fsl_sai_param {
263 u32 slot_num;
264 u32 fifo_depth;
265 u32 dataline;
266};
267
268struct fsl_sai_dl_cfg {
269 unsigned int type;
270 unsigned int pins[2];
271 unsigned int mask[2];
272 unsigned int start_off[2];
273 unsigned int next_off[2];
274};
275
276struct fsl_sai {
277 struct platform_device *pdev;
278 struct regmap *regmap;
279 struct clk *bus_clk;
280 struct clk *mclk_clk[FSL_SAI_MCLK_MAX];
281 struct clk *pll8k_clk;
282 struct clk *pll11k_clk;
283 struct resource *res;
284
285 bool is_consumer_mode;
286 bool is_lsb_first;
287 bool is_dsp_mode;
288 bool is_pdm_mode;
289 bool is_multi_fifo_dma;
290 bool synchronous[2];
291 struct fsl_sai_dl_cfg *dl_cfg;
292 unsigned int dl_cfg_cnt;
293 bool mclk_direction_output;
294
295 unsigned int mclk_id[2];
296 unsigned int mclk_streams;
297 unsigned int slots;
298 unsigned int slot_width;
299 unsigned int bclk_ratio;
300
301 const struct fsl_sai_soc_data *soc_data;
302 struct snd_soc_dai_driver cpu_dai_drv;
303 struct snd_dmaengine_dai_dma_data dma_params_rx;
304 struct snd_dmaengine_dai_dma_data dma_params_tx;
305 struct fsl_sai_verid verid;
306 struct fsl_sai_param param;
307 struct pm_qos_request pm_qos_req;
308 struct pinctrl *pinctrl;
309 struct pinctrl_state *pins_state;
310 struct sdma_peripheral_config audio_config[2];
311};
312
313#define TX 1
314#define RX 0
315
316#endif /* __FSL_SAI_H */
317

source code of linux/sound/soc/fsl/fsl_sai.h