xref: /openbmc/linux/drivers/soundwire/intel.c (revision 76ce0265)
1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2 // Copyright(c) 2015-17 Intel Corporation.
3 
4 /*
5  * Soundwire Intel Master Driver
6  */
7 
8 #include <linux/acpi.h>
9 #include <linux/debugfs.h>
10 #include <linux/delay.h>
11 #include <linux/module.h>
12 #include <linux/interrupt.h>
13 #include <linux/io.h>
14 #include <linux/platform_device.h>
15 #include <sound/pcm_params.h>
16 #include <sound/soc.h>
17 #include <linux/soundwire/sdw_registers.h>
18 #include <linux/soundwire/sdw.h>
19 #include <linux/soundwire/sdw_intel.h>
20 #include "cadence_master.h"
21 #include "bus.h"
22 #include "intel.h"
23 
24 /* Intel SHIM Registers Definition */
25 #define SDW_SHIM_LCAP			0x0
26 #define SDW_SHIM_LCTL			0x4
27 #define SDW_SHIM_IPPTR			0x8
28 #define SDW_SHIM_SYNC			0xC
29 
30 #define SDW_SHIM_CTLSCAP(x)		(0x010 + 0x60 * (x))
31 #define SDW_SHIM_CTLS0CM(x)		(0x012 + 0x60 * (x))
32 #define SDW_SHIM_CTLS1CM(x)		(0x014 + 0x60 * (x))
33 #define SDW_SHIM_CTLS2CM(x)		(0x016 + 0x60 * (x))
34 #define SDW_SHIM_CTLS3CM(x)		(0x018 + 0x60 * (x))
35 #define SDW_SHIM_PCMSCAP(x)		(0x020 + 0x60 * (x))
36 
37 #define SDW_SHIM_PCMSYCHM(x, y)		(0x022 + (0x60 * (x)) + (0x2 * (y)))
38 #define SDW_SHIM_PCMSYCHC(x, y)		(0x042 + (0x60 * (x)) + (0x2 * (y)))
39 #define SDW_SHIM_PDMSCAP(x)		(0x062 + 0x60 * (x))
40 #define SDW_SHIM_IOCTL(x)		(0x06C + 0x60 * (x))
41 #define SDW_SHIM_CTMCTL(x)		(0x06E + 0x60 * (x))
42 
43 #define SDW_SHIM_WAKEEN			0x190
44 #define SDW_SHIM_WAKESTS		0x192
45 
46 #define SDW_SHIM_LCTL_SPA		BIT(0)
47 #define SDW_SHIM_LCTL_CPA		BIT(8)
48 
49 #define SDW_SHIM_SYNC_SYNCPRD_VAL	0x176F
50 #define SDW_SHIM_SYNC_SYNCPRD		GENMASK(14, 0)
51 #define SDW_SHIM_SYNC_SYNCCPU		BIT(15)
52 #define SDW_SHIM_SYNC_CMDSYNC_MASK	GENMASK(19, 16)
53 #define SDW_SHIM_SYNC_CMDSYNC		BIT(16)
54 #define SDW_SHIM_SYNC_SYNCGO		BIT(24)
55 
56 #define SDW_SHIM_PCMSCAP_ISS		GENMASK(3, 0)
57 #define SDW_SHIM_PCMSCAP_OSS		GENMASK(7, 4)
58 #define SDW_SHIM_PCMSCAP_BSS		GENMASK(12, 8)
59 
60 #define SDW_SHIM_PCMSYCM_LCHN		GENMASK(3, 0)
61 #define SDW_SHIM_PCMSYCM_HCHN		GENMASK(7, 4)
62 #define SDW_SHIM_PCMSYCM_STREAM		GENMASK(13, 8)
63 #define SDW_SHIM_PCMSYCM_DIR		BIT(15)
64 
65 #define SDW_SHIM_PDMSCAP_ISS		GENMASK(3, 0)
66 #define SDW_SHIM_PDMSCAP_OSS		GENMASK(7, 4)
67 #define SDW_SHIM_PDMSCAP_BSS		GENMASK(12, 8)
68 #define SDW_SHIM_PDMSCAP_CPSS		GENMASK(15, 13)
69 
70 #define SDW_SHIM_IOCTL_MIF		BIT(0)
71 #define SDW_SHIM_IOCTL_CO		BIT(1)
72 #define SDW_SHIM_IOCTL_COE		BIT(2)
73 #define SDW_SHIM_IOCTL_DO		BIT(3)
74 #define SDW_SHIM_IOCTL_DOE		BIT(4)
75 #define SDW_SHIM_IOCTL_BKE		BIT(5)
76 #define SDW_SHIM_IOCTL_WPDD		BIT(6)
77 #define SDW_SHIM_IOCTL_CIBD		BIT(8)
78 #define SDW_SHIM_IOCTL_DIBD		BIT(9)
79 
80 #define SDW_SHIM_CTMCTL_DACTQE		BIT(0)
81 #define SDW_SHIM_CTMCTL_DODS		BIT(1)
82 #define SDW_SHIM_CTMCTL_DOAIS		GENMASK(4, 3)
83 
84 #define SDW_SHIM_WAKEEN_ENABLE		BIT(0)
85 #define SDW_SHIM_WAKESTS_STATUS		BIT(0)
86 
87 /* Intel ALH Register definitions */
88 #define SDW_ALH_STRMZCFG(x)		(0x000 + (0x4 * (x)))
89 #define SDW_ALH_NUM_STREAMS		64
90 
91 #define SDW_ALH_STRMZCFG_DMAT_VAL	0x3
92 #define SDW_ALH_STRMZCFG_DMAT		GENMASK(7, 0)
93 #define SDW_ALH_STRMZCFG_CHN		GENMASK(19, 16)
94 
95 #define SDW_INTEL_QUIRK_MASK_BUS_DISABLE	BIT(1)
96 
97 enum intel_pdi_type {
98 	INTEL_PDI_IN = 0,
99 	INTEL_PDI_OUT = 1,
100 	INTEL_PDI_BD = 2,
101 };
102 
103 struct sdw_intel {
104 	struct sdw_cdns cdns;
105 	int instance;
106 	struct sdw_intel_link_res *res;
107 #ifdef CONFIG_DEBUG_FS
108 	struct dentry *debugfs;
109 #endif
110 };
111 
112 #define cdns_to_intel(_cdns) container_of(_cdns, struct sdw_intel, cdns)
113 
114 /*
115  * Read, write helpers for HW registers
116  */
117 static inline int intel_readl(void __iomem *base, int offset)
118 {
119 	return readl(base + offset);
120 }
121 
122 static inline void intel_writel(void __iomem *base, int offset, int value)
123 {
124 	writel(value, base + offset);
125 }
126 
127 static inline u16 intel_readw(void __iomem *base, int offset)
128 {
129 	return readw(base + offset);
130 }
131 
132 static inline void intel_writew(void __iomem *base, int offset, u16 value)
133 {
134 	writew(value, base + offset);
135 }
136 
137 static int intel_clear_bit(void __iomem *base, int offset, u32 value, u32 mask)
138 {
139 	int timeout = 10;
140 	u32 reg_read;
141 
142 	writel(value, base + offset);
143 	do {
144 		reg_read = readl(base + offset);
145 		if (!(reg_read & mask))
146 			return 0;
147 
148 		timeout--;
149 		udelay(50);
150 	} while (timeout != 0);
151 
152 	return -EAGAIN;
153 }
154 
155 static int intel_set_bit(void __iomem *base, int offset, u32 value, u32 mask)
156 {
157 	int timeout = 10;
158 	u32 reg_read;
159 
160 	writel(value, base + offset);
161 	do {
162 		reg_read = readl(base + offset);
163 		if (reg_read & mask)
164 			return 0;
165 
166 		timeout--;
167 		udelay(50);
168 	} while (timeout != 0);
169 
170 	return -EAGAIN;
171 }
172 
173 /*
174  * debugfs
175  */
176 #ifdef CONFIG_DEBUG_FS
177 
178 #define RD_BUF (2 * PAGE_SIZE)
179 
180 static ssize_t intel_sprintf(void __iomem *mem, bool l,
181 			     char *buf, size_t pos, unsigned int reg)
182 {
183 	int value;
184 
185 	if (l)
186 		value = intel_readl(mem, reg);
187 	else
188 		value = intel_readw(mem, reg);
189 
190 	return scnprintf(buf + pos, RD_BUF - pos, "%4x\t%4x\n", reg, value);
191 }
192 
193 static int intel_reg_show(struct seq_file *s_file, void *data)
194 {
195 	struct sdw_intel *sdw = s_file->private;
196 	void __iomem *s = sdw->res->shim;
197 	void __iomem *a = sdw->res->alh;
198 	char *buf;
199 	ssize_t ret;
200 	int i, j;
201 	unsigned int links, reg;
202 
203 	buf = kzalloc(RD_BUF, GFP_KERNEL);
204 	if (!buf)
205 		return -ENOMEM;
206 
207 	links = intel_readl(s, SDW_SHIM_LCAP) & GENMASK(2, 0);
208 
209 	ret = scnprintf(buf, RD_BUF, "Register  Value\n");
210 	ret += scnprintf(buf + ret, RD_BUF - ret, "\nShim\n");
211 
212 	for (i = 0; i < links; i++) {
213 		reg = SDW_SHIM_LCAP + i * 4;
214 		ret += intel_sprintf(s, true, buf, ret, reg);
215 	}
216 
217 	for (i = 0; i < links; i++) {
218 		ret += scnprintf(buf + ret, RD_BUF - ret, "\nLink%d\n", i);
219 		ret += intel_sprintf(s, false, buf, ret, SDW_SHIM_CTLSCAP(i));
220 		ret += intel_sprintf(s, false, buf, ret, SDW_SHIM_CTLS0CM(i));
221 		ret += intel_sprintf(s, false, buf, ret, SDW_SHIM_CTLS1CM(i));
222 		ret += intel_sprintf(s, false, buf, ret, SDW_SHIM_CTLS2CM(i));
223 		ret += intel_sprintf(s, false, buf, ret, SDW_SHIM_CTLS3CM(i));
224 		ret += intel_sprintf(s, false, buf, ret, SDW_SHIM_PCMSCAP(i));
225 
226 		ret += scnprintf(buf + ret, RD_BUF - ret, "\n PCMSyCH registers\n");
227 
228 		/*
229 		 * the value 10 is the number of PDIs. We will need a
230 		 * cleanup to remove hard-coded Intel configurations
231 		 * from cadence_master.c
232 		 */
233 		for (j = 0; j < 10; j++) {
234 			ret += intel_sprintf(s, false, buf, ret,
235 					SDW_SHIM_PCMSYCHM(i, j));
236 			ret += intel_sprintf(s, false, buf, ret,
237 					SDW_SHIM_PCMSYCHC(i, j));
238 		}
239 		ret += scnprintf(buf + ret, RD_BUF - ret, "\n PDMSCAP, IOCTL, CTMCTL\n");
240 
241 		ret += intel_sprintf(s, false, buf, ret, SDW_SHIM_PDMSCAP(i));
242 		ret += intel_sprintf(s, false, buf, ret, SDW_SHIM_IOCTL(i));
243 		ret += intel_sprintf(s, false, buf, ret, SDW_SHIM_CTMCTL(i));
244 	}
245 
246 	ret += scnprintf(buf + ret, RD_BUF - ret, "\nWake registers\n");
247 	ret += intel_sprintf(s, false, buf, ret, SDW_SHIM_WAKEEN);
248 	ret += intel_sprintf(s, false, buf, ret, SDW_SHIM_WAKESTS);
249 
250 	ret += scnprintf(buf + ret, RD_BUF - ret, "\nALH STRMzCFG\n");
251 	for (i = 0; i < SDW_ALH_NUM_STREAMS; i++)
252 		ret += intel_sprintf(a, true, buf, ret, SDW_ALH_STRMZCFG(i));
253 
254 	seq_printf(s_file, "%s", buf);
255 	kfree(buf);
256 
257 	return 0;
258 }
259 DEFINE_SHOW_ATTRIBUTE(intel_reg);
260 
261 static void intel_debugfs_init(struct sdw_intel *sdw)
262 {
263 	struct dentry *root = sdw->cdns.bus.debugfs;
264 
265 	if (!root)
266 		return;
267 
268 	sdw->debugfs = debugfs_create_dir("intel-sdw", root);
269 
270 	debugfs_create_file("intel-registers", 0400, sdw->debugfs, sdw,
271 			    &intel_reg_fops);
272 
273 	sdw_cdns_debugfs_init(&sdw->cdns, sdw->debugfs);
274 }
275 
276 static void intel_debugfs_exit(struct sdw_intel *sdw)
277 {
278 	debugfs_remove_recursive(sdw->debugfs);
279 }
280 #else
281 static void intel_debugfs_init(struct sdw_intel *sdw) {}
282 static void intel_debugfs_exit(struct sdw_intel *sdw) {}
283 #endif /* CONFIG_DEBUG_FS */
284 
285 /*
286  * shim ops
287  */
288 
289 static int intel_link_power_up(struct sdw_intel *sdw)
290 {
291 	unsigned int link_id = sdw->instance;
292 	void __iomem *shim = sdw->res->shim;
293 	int spa_mask, cpa_mask;
294 	int link_control, ret;
295 
296 	/* Link power up sequence */
297 	link_control = intel_readl(shim, SDW_SHIM_LCTL);
298 	spa_mask = (SDW_SHIM_LCTL_SPA << link_id);
299 	cpa_mask = (SDW_SHIM_LCTL_CPA << link_id);
300 	link_control |=  spa_mask;
301 
302 	ret = intel_set_bit(shim, SDW_SHIM_LCTL, link_control, cpa_mask);
303 	if (ret < 0)
304 		return ret;
305 
306 	sdw->cdns.link_up = true;
307 	return 0;
308 }
309 
310 static int intel_shim_init(struct sdw_intel *sdw)
311 {
312 	void __iomem *shim = sdw->res->shim;
313 	unsigned int link_id = sdw->instance;
314 	int sync_reg, ret;
315 	u16 ioctl = 0, act = 0;
316 
317 	/* Initialize Shim */
318 	ioctl |= SDW_SHIM_IOCTL_BKE;
319 	intel_writew(shim, SDW_SHIM_IOCTL(link_id), ioctl);
320 
321 	ioctl |= SDW_SHIM_IOCTL_WPDD;
322 	intel_writew(shim, SDW_SHIM_IOCTL(link_id), ioctl);
323 
324 	ioctl |= SDW_SHIM_IOCTL_DO;
325 	intel_writew(shim, SDW_SHIM_IOCTL(link_id), ioctl);
326 
327 	ioctl |= SDW_SHIM_IOCTL_DOE;
328 	intel_writew(shim, SDW_SHIM_IOCTL(link_id), ioctl);
329 
330 	/* Switch to MIP from Glue logic */
331 	ioctl = intel_readw(shim,  SDW_SHIM_IOCTL(link_id));
332 
333 	ioctl &= ~(SDW_SHIM_IOCTL_DOE);
334 	intel_writew(shim, SDW_SHIM_IOCTL(link_id), ioctl);
335 
336 	ioctl &= ~(SDW_SHIM_IOCTL_DO);
337 	intel_writew(shim, SDW_SHIM_IOCTL(link_id), ioctl);
338 
339 	ioctl |= (SDW_SHIM_IOCTL_MIF);
340 	intel_writew(shim, SDW_SHIM_IOCTL(link_id), ioctl);
341 
342 	ioctl &= ~(SDW_SHIM_IOCTL_BKE);
343 	ioctl &= ~(SDW_SHIM_IOCTL_COE);
344 
345 	intel_writew(shim, SDW_SHIM_IOCTL(link_id), ioctl);
346 
347 	act |= 0x1 << SDW_REG_SHIFT(SDW_SHIM_CTMCTL_DOAIS);
348 	act |= SDW_SHIM_CTMCTL_DACTQE;
349 	act |= SDW_SHIM_CTMCTL_DODS;
350 	intel_writew(shim, SDW_SHIM_CTMCTL(link_id), act);
351 
352 	/* Now set SyncPRD period */
353 	sync_reg = intel_readl(shim, SDW_SHIM_SYNC);
354 	sync_reg |= (SDW_SHIM_SYNC_SYNCPRD_VAL <<
355 			SDW_REG_SHIFT(SDW_SHIM_SYNC_SYNCPRD));
356 
357 	/* Set SyncCPU bit */
358 	sync_reg |= SDW_SHIM_SYNC_SYNCCPU;
359 	ret = intel_clear_bit(shim, SDW_SHIM_SYNC, sync_reg,
360 			      SDW_SHIM_SYNC_SYNCCPU);
361 	if (ret < 0)
362 		dev_err(sdw->cdns.dev, "Failed to set sync period: %d\n", ret);
363 
364 	return ret;
365 }
366 
367 /*
368  * PDI routines
369  */
370 static void intel_pdi_init(struct sdw_intel *sdw,
371 			   struct sdw_cdns_stream_config *config)
372 {
373 	void __iomem *shim = sdw->res->shim;
374 	unsigned int link_id = sdw->instance;
375 	int pcm_cap, pdm_cap;
376 
377 	/* PCM Stream Capability */
378 	pcm_cap = intel_readw(shim, SDW_SHIM_PCMSCAP(link_id));
379 
380 	config->pcm_bd = (pcm_cap & SDW_SHIM_PCMSCAP_BSS) >>
381 					SDW_REG_SHIFT(SDW_SHIM_PCMSCAP_BSS);
382 	config->pcm_in = (pcm_cap & SDW_SHIM_PCMSCAP_ISS) >>
383 					SDW_REG_SHIFT(SDW_SHIM_PCMSCAP_ISS);
384 	config->pcm_out = (pcm_cap & SDW_SHIM_PCMSCAP_OSS) >>
385 					SDW_REG_SHIFT(SDW_SHIM_PCMSCAP_OSS);
386 
387 	dev_dbg(sdw->cdns.dev, "PCM cap bd:%d in:%d out:%d\n",
388 		config->pcm_bd, config->pcm_in, config->pcm_out);
389 
390 	/* PDM Stream Capability */
391 	pdm_cap = intel_readw(shim, SDW_SHIM_PDMSCAP(link_id));
392 
393 	config->pdm_bd = (pdm_cap & SDW_SHIM_PDMSCAP_BSS) >>
394 					SDW_REG_SHIFT(SDW_SHIM_PDMSCAP_BSS);
395 	config->pdm_in = (pdm_cap & SDW_SHIM_PDMSCAP_ISS) >>
396 					SDW_REG_SHIFT(SDW_SHIM_PDMSCAP_ISS);
397 	config->pdm_out = (pdm_cap & SDW_SHIM_PDMSCAP_OSS) >>
398 					SDW_REG_SHIFT(SDW_SHIM_PDMSCAP_OSS);
399 
400 	dev_dbg(sdw->cdns.dev, "PDM cap bd:%d in:%d out:%d\n",
401 		config->pdm_bd, config->pdm_in, config->pdm_out);
402 }
403 
404 static int
405 intel_pdi_get_ch_cap(struct sdw_intel *sdw, unsigned int pdi_num, bool pcm)
406 {
407 	void __iomem *shim = sdw->res->shim;
408 	unsigned int link_id = sdw->instance;
409 	int count;
410 
411 	if (pcm) {
412 		count = intel_readw(shim, SDW_SHIM_PCMSYCHC(link_id, pdi_num));
413 
414 		/*
415 		 * WORKAROUND: on all existing Intel controllers, pdi
416 		 * number 2 reports channel count as 1 even though it
417 		 * supports 8 channels. Performing hardcoding for pdi
418 		 * number 2.
419 		 */
420 		if (pdi_num == 2)
421 			count = 7;
422 
423 	} else {
424 		count = intel_readw(shim, SDW_SHIM_PDMSCAP(link_id));
425 		count = ((count & SDW_SHIM_PDMSCAP_CPSS) >>
426 					SDW_REG_SHIFT(SDW_SHIM_PDMSCAP_CPSS));
427 	}
428 
429 	/* zero based values for channel count in register */
430 	count++;
431 
432 	return count;
433 }
434 
435 static int intel_pdi_get_ch_update(struct sdw_intel *sdw,
436 				   struct sdw_cdns_pdi *pdi,
437 				   unsigned int num_pdi,
438 				   unsigned int *num_ch, bool pcm)
439 {
440 	int i, ch_count = 0;
441 
442 	for (i = 0; i < num_pdi; i++) {
443 		pdi->ch_count = intel_pdi_get_ch_cap(sdw, pdi->num, pcm);
444 		ch_count += pdi->ch_count;
445 		pdi++;
446 	}
447 
448 	*num_ch = ch_count;
449 	return 0;
450 }
451 
452 static int intel_pdi_stream_ch_update(struct sdw_intel *sdw,
453 				      struct sdw_cdns_streams *stream, bool pcm)
454 {
455 	intel_pdi_get_ch_update(sdw, stream->bd, stream->num_bd,
456 				&stream->num_ch_bd, pcm);
457 
458 	intel_pdi_get_ch_update(sdw, stream->in, stream->num_in,
459 				&stream->num_ch_in, pcm);
460 
461 	intel_pdi_get_ch_update(sdw, stream->out, stream->num_out,
462 				&stream->num_ch_out, pcm);
463 
464 	return 0;
465 }
466 
467 static int intel_pdi_ch_update(struct sdw_intel *sdw)
468 {
469 	/* First update PCM streams followed by PDM streams */
470 	intel_pdi_stream_ch_update(sdw, &sdw->cdns.pcm, true);
471 	intel_pdi_stream_ch_update(sdw, &sdw->cdns.pdm, false);
472 
473 	return 0;
474 }
475 
476 static void
477 intel_pdi_shim_configure(struct sdw_intel *sdw, struct sdw_cdns_pdi *pdi)
478 {
479 	void __iomem *shim = sdw->res->shim;
480 	unsigned int link_id = sdw->instance;
481 	int pdi_conf = 0;
482 
483 	/* the Bulk and PCM streams are not contiguous */
484 	pdi->intel_alh_id = (link_id * 16) + pdi->num + 3;
485 	if (pdi->num >= 2)
486 		pdi->intel_alh_id += 2;
487 
488 	/*
489 	 * Program stream parameters to stream SHIM register
490 	 * This is applicable for PCM stream only.
491 	 */
492 	if (pdi->type != SDW_STREAM_PCM)
493 		return;
494 
495 	if (pdi->dir == SDW_DATA_DIR_RX)
496 		pdi_conf |= SDW_SHIM_PCMSYCM_DIR;
497 	else
498 		pdi_conf &= ~(SDW_SHIM_PCMSYCM_DIR);
499 
500 	pdi_conf |= (pdi->intel_alh_id <<
501 			SDW_REG_SHIFT(SDW_SHIM_PCMSYCM_STREAM));
502 	pdi_conf |= (pdi->l_ch_num << SDW_REG_SHIFT(SDW_SHIM_PCMSYCM_LCHN));
503 	pdi_conf |= (pdi->h_ch_num << SDW_REG_SHIFT(SDW_SHIM_PCMSYCM_HCHN));
504 
505 	intel_writew(shim, SDW_SHIM_PCMSYCHM(link_id, pdi->num), pdi_conf);
506 }
507 
508 static void
509 intel_pdi_alh_configure(struct sdw_intel *sdw, struct sdw_cdns_pdi *pdi)
510 {
511 	void __iomem *alh = sdw->res->alh;
512 	unsigned int link_id = sdw->instance;
513 	unsigned int conf;
514 
515 	/* the Bulk and PCM streams are not contiguous */
516 	pdi->intel_alh_id = (link_id * 16) + pdi->num + 3;
517 	if (pdi->num >= 2)
518 		pdi->intel_alh_id += 2;
519 
520 	/* Program Stream config ALH register */
521 	conf = intel_readl(alh, SDW_ALH_STRMZCFG(pdi->intel_alh_id));
522 
523 	conf |= (SDW_ALH_STRMZCFG_DMAT_VAL <<
524 			SDW_REG_SHIFT(SDW_ALH_STRMZCFG_DMAT));
525 
526 	conf |= ((pdi->ch_count - 1) <<
527 			SDW_REG_SHIFT(SDW_ALH_STRMZCFG_CHN));
528 
529 	intel_writel(alh, SDW_ALH_STRMZCFG(pdi->intel_alh_id), conf);
530 }
531 
532 static int intel_params_stream(struct sdw_intel *sdw,
533 			       struct snd_pcm_substream *substream,
534 			       struct snd_soc_dai *dai,
535 			       struct snd_pcm_hw_params *hw_params,
536 			       int link_id, int alh_stream_id)
537 {
538 	struct sdw_intel_link_res *res = sdw->res;
539 	struct sdw_intel_stream_params_data params_data;
540 
541 	params_data.substream = substream;
542 	params_data.dai = dai;
543 	params_data.hw_params = hw_params;
544 	params_data.link_id = link_id;
545 	params_data.alh_stream_id = alh_stream_id;
546 
547 	if (res->ops && res->ops->params_stream && res->dev)
548 		return res->ops->params_stream(res->dev,
549 					       &params_data);
550 	return -EIO;
551 }
552 
553 /*
554  * bank switch routines
555  */
556 
557 static int intel_pre_bank_switch(struct sdw_bus *bus)
558 {
559 	struct sdw_cdns *cdns = bus_to_cdns(bus);
560 	struct sdw_intel *sdw = cdns_to_intel(cdns);
561 	void __iomem *shim = sdw->res->shim;
562 	int sync_reg;
563 
564 	/* Write to register only for multi-link */
565 	if (!bus->multi_link)
566 		return 0;
567 
568 	/* Read SYNC register */
569 	sync_reg = intel_readl(shim, SDW_SHIM_SYNC);
570 	sync_reg |= SDW_SHIM_SYNC_CMDSYNC << sdw->instance;
571 	intel_writel(shim, SDW_SHIM_SYNC, sync_reg);
572 
573 	return 0;
574 }
575 
576 static int intel_post_bank_switch(struct sdw_bus *bus)
577 {
578 	struct sdw_cdns *cdns = bus_to_cdns(bus);
579 	struct sdw_intel *sdw = cdns_to_intel(cdns);
580 	void __iomem *shim = sdw->res->shim;
581 	int sync_reg, ret;
582 
583 	/* Write to register only for multi-link */
584 	if (!bus->multi_link)
585 		return 0;
586 
587 	/* Read SYNC register */
588 	sync_reg = intel_readl(shim, SDW_SHIM_SYNC);
589 
590 	/*
591 	 * post_bank_switch() ops is called from the bus in loop for
592 	 * all the Masters in the steam with the expectation that
593 	 * we trigger the bankswitch for the only first Master in the list
594 	 * and do nothing for the other Masters
595 	 *
596 	 * So, set the SYNCGO bit only if CMDSYNC bit is set for any Master.
597 	 */
598 	if (!(sync_reg & SDW_SHIM_SYNC_CMDSYNC_MASK))
599 		return 0;
600 
601 	/*
602 	 * Set SyncGO bit to synchronously trigger a bank switch for
603 	 * all the masters. A write to SYNCGO bit clears CMDSYNC bit for all
604 	 * the Masters.
605 	 */
606 	sync_reg |= SDW_SHIM_SYNC_SYNCGO;
607 
608 	ret = intel_clear_bit(shim, SDW_SHIM_SYNC, sync_reg,
609 			      SDW_SHIM_SYNC_SYNCGO);
610 	if (ret < 0)
611 		dev_err(sdw->cdns.dev, "Post bank switch failed: %d\n", ret);
612 
613 	return ret;
614 }
615 
616 /*
617  * DAI routines
618  */
619 
620 static int intel_hw_params(struct snd_pcm_substream *substream,
621 			   struct snd_pcm_hw_params *params,
622 			   struct snd_soc_dai *dai)
623 {
624 	struct sdw_cdns *cdns = snd_soc_dai_get_drvdata(dai);
625 	struct sdw_intel *sdw = cdns_to_intel(cdns);
626 	struct sdw_cdns_dma_data *dma;
627 	struct sdw_cdns_pdi *pdi;
628 	struct sdw_stream_config sconfig;
629 	struct sdw_port_config *pconfig;
630 	int ch, dir;
631 	int ret;
632 	bool pcm = true;
633 
634 	dma = snd_soc_dai_get_dma_data(dai, substream);
635 	if (!dma)
636 		return -EIO;
637 
638 	ch = params_channels(params);
639 	if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
640 		dir = SDW_DATA_DIR_RX;
641 	else
642 		dir = SDW_DATA_DIR_TX;
643 
644 	if (dma->stream_type == SDW_STREAM_PDM)
645 		pcm = false;
646 
647 	if (pcm)
648 		pdi = sdw_cdns_alloc_pdi(cdns, &cdns->pcm, ch, dir, dai->id);
649 	else
650 		pdi = sdw_cdns_alloc_pdi(cdns, &cdns->pdm, ch, dir, dai->id);
651 
652 	if (!pdi) {
653 		ret = -EINVAL;
654 		goto error;
655 	}
656 
657 	/* do run-time configurations for SHIM, ALH and PDI/PORT */
658 	intel_pdi_shim_configure(sdw, pdi);
659 	intel_pdi_alh_configure(sdw, pdi);
660 	sdw_cdns_config_stream(cdns, ch, dir, pdi);
661 
662 
663 	/* Inform DSP about PDI stream number */
664 	ret = intel_params_stream(sdw, substream, dai, params,
665 				  sdw->instance,
666 				  pdi->intel_alh_id);
667 	if (ret)
668 		goto error;
669 
670 	sconfig.direction = dir;
671 	sconfig.ch_count = ch;
672 	sconfig.frame_rate = params_rate(params);
673 	sconfig.type = dma->stream_type;
674 
675 	if (dma->stream_type == SDW_STREAM_PDM) {
676 		sconfig.frame_rate *= 50;
677 		sconfig.bps = 1;
678 	} else {
679 		sconfig.bps = snd_pcm_format_width(params_format(params));
680 	}
681 
682 	/* Port configuration */
683 	pconfig = kcalloc(1, sizeof(*pconfig), GFP_KERNEL);
684 	if (!pconfig) {
685 		ret =  -ENOMEM;
686 		goto error;
687 	}
688 
689 	pconfig->num = pdi->num;
690 	pconfig->ch_mask = (1 << ch) - 1;
691 
692 	ret = sdw_stream_add_master(&cdns->bus, &sconfig,
693 				    pconfig, 1, dma->stream);
694 	if (ret)
695 		dev_err(cdns->dev, "add master to stream failed:%d\n", ret);
696 
697 	kfree(pconfig);
698 error:
699 	return ret;
700 }
701 
702 static int
703 intel_hw_free(struct snd_pcm_substream *substream, struct snd_soc_dai *dai)
704 {
705 	struct sdw_cdns *cdns = snd_soc_dai_get_drvdata(dai);
706 	struct sdw_cdns_dma_data *dma;
707 	int ret;
708 
709 	dma = snd_soc_dai_get_dma_data(dai, substream);
710 	if (!dma)
711 		return -EIO;
712 
713 	ret = sdw_stream_remove_master(&cdns->bus, dma->stream);
714 	if (ret < 0)
715 		dev_err(dai->dev, "remove master from stream %s failed: %d\n",
716 			dma->stream->name, ret);
717 
718 	return ret;
719 }
720 
721 static void intel_shutdown(struct snd_pcm_substream *substream,
722 			   struct snd_soc_dai *dai)
723 {
724 	struct sdw_cdns_dma_data *dma;
725 
726 	dma = snd_soc_dai_get_dma_data(dai, substream);
727 	if (!dma)
728 		return;
729 
730 	snd_soc_dai_set_dma_data(dai, substream, NULL);
731 	kfree(dma);
732 }
733 
734 static int intel_pcm_set_sdw_stream(struct snd_soc_dai *dai,
735 				    void *stream, int direction)
736 {
737 	return cdns_set_sdw_stream(dai, stream, true, direction);
738 }
739 
740 static int intel_pdm_set_sdw_stream(struct snd_soc_dai *dai,
741 				    void *stream, int direction)
742 {
743 	return cdns_set_sdw_stream(dai, stream, false, direction);
744 }
745 
746 static const struct snd_soc_dai_ops intel_pcm_dai_ops = {
747 	.hw_params = intel_hw_params,
748 	.hw_free = intel_hw_free,
749 	.shutdown = intel_shutdown,
750 	.set_sdw_stream = intel_pcm_set_sdw_stream,
751 };
752 
753 static const struct snd_soc_dai_ops intel_pdm_dai_ops = {
754 	.hw_params = intel_hw_params,
755 	.hw_free = intel_hw_free,
756 	.shutdown = intel_shutdown,
757 	.set_sdw_stream = intel_pdm_set_sdw_stream,
758 };
759 
760 static const struct snd_soc_component_driver dai_component = {
761 	.name           = "soundwire",
762 };
763 
764 static int intel_create_dai(struct sdw_cdns *cdns,
765 			    struct snd_soc_dai_driver *dais,
766 			    enum intel_pdi_type type,
767 			    u32 num, u32 off, u32 max_ch, bool pcm)
768 {
769 	int i;
770 
771 	if (num == 0)
772 		return 0;
773 
774 	 /* TODO: Read supported rates/formats from hardware */
775 	for (i = off; i < (off + num); i++) {
776 		dais[i].name = kasprintf(GFP_KERNEL, "SDW%d Pin%d",
777 					 cdns->instance, i);
778 		if (!dais[i].name)
779 			return -ENOMEM;
780 
781 		if (type == INTEL_PDI_BD || type == INTEL_PDI_OUT) {
782 			dais[i].playback.channels_min = 1;
783 			dais[i].playback.channels_max = max_ch;
784 			dais[i].playback.rates = SNDRV_PCM_RATE_48000;
785 			dais[i].playback.formats = SNDRV_PCM_FMTBIT_S16_LE;
786 		}
787 
788 		if (type == INTEL_PDI_BD || type == INTEL_PDI_IN) {
789 			dais[i].capture.channels_min = 1;
790 			dais[i].capture.channels_max = max_ch;
791 			dais[i].capture.rates = SNDRV_PCM_RATE_48000;
792 			dais[i].capture.formats = SNDRV_PCM_FMTBIT_S16_LE;
793 		}
794 
795 		if (pcm)
796 			dais[i].ops = &intel_pcm_dai_ops;
797 		else
798 			dais[i].ops = &intel_pdm_dai_ops;
799 	}
800 
801 	return 0;
802 }
803 
804 static int intel_register_dai(struct sdw_intel *sdw)
805 {
806 	struct sdw_cdns *cdns = &sdw->cdns;
807 	struct sdw_cdns_streams *stream;
808 	struct snd_soc_dai_driver *dais;
809 	int num_dai, ret, off = 0;
810 
811 	/* DAIs are created based on total number of PDIs supported */
812 	num_dai = cdns->pcm.num_pdi + cdns->pdm.num_pdi;
813 
814 	dais = devm_kcalloc(cdns->dev, num_dai, sizeof(*dais), GFP_KERNEL);
815 	if (!dais)
816 		return -ENOMEM;
817 
818 	/* Create PCM DAIs */
819 	stream = &cdns->pcm;
820 
821 	ret = intel_create_dai(cdns, dais, INTEL_PDI_IN, cdns->pcm.num_in,
822 			       off, stream->num_ch_in, true);
823 	if (ret)
824 		return ret;
825 
826 	off += cdns->pcm.num_in;
827 	ret = intel_create_dai(cdns, dais, INTEL_PDI_OUT, cdns->pcm.num_out,
828 			       off, stream->num_ch_out, true);
829 	if (ret)
830 		return ret;
831 
832 	off += cdns->pcm.num_out;
833 	ret = intel_create_dai(cdns, dais, INTEL_PDI_BD, cdns->pcm.num_bd,
834 			       off, stream->num_ch_bd, true);
835 	if (ret)
836 		return ret;
837 
838 	/* Create PDM DAIs */
839 	stream = &cdns->pdm;
840 	off += cdns->pcm.num_bd;
841 	ret = intel_create_dai(cdns, dais, INTEL_PDI_IN, cdns->pdm.num_in,
842 			       off, stream->num_ch_in, false);
843 	if (ret)
844 		return ret;
845 
846 	off += cdns->pdm.num_in;
847 	ret = intel_create_dai(cdns, dais, INTEL_PDI_OUT, cdns->pdm.num_out,
848 			       off, stream->num_ch_out, false);
849 	if (ret)
850 		return ret;
851 
852 	off += cdns->pdm.num_out;
853 	ret = intel_create_dai(cdns, dais, INTEL_PDI_BD, cdns->pdm.num_bd,
854 			       off, stream->num_ch_bd, false);
855 	if (ret)
856 		return ret;
857 
858 	return snd_soc_register_component(cdns->dev, &dai_component,
859 					  dais, num_dai);
860 }
861 
862 static int sdw_master_read_intel_prop(struct sdw_bus *bus)
863 {
864 	struct sdw_master_prop *prop = &bus->prop;
865 	struct fwnode_handle *link;
866 	char name[32];
867 	u32 quirk_mask;
868 
869 	/* Find master handle */
870 	snprintf(name, sizeof(name),
871 		 "mipi-sdw-link-%d-subproperties", bus->link_id);
872 
873 	link = device_get_named_child_node(bus->dev, name);
874 	if (!link) {
875 		dev_err(bus->dev, "Master node %s not found\n", name);
876 		return -EIO;
877 	}
878 
879 	fwnode_property_read_u32(link,
880 				 "intel-sdw-ip-clock",
881 				 &prop->mclk_freq);
882 
883 	/* the values reported by BIOS are the 2x clock, not the bus clock */
884 	prop->mclk_freq /= 2;
885 
886 	fwnode_property_read_u32(link,
887 				 "intel-quirk-mask",
888 				 &quirk_mask);
889 
890 	if (quirk_mask & SDW_INTEL_QUIRK_MASK_BUS_DISABLE)
891 		prop->hw_disabled = true;
892 
893 	return 0;
894 }
895 
896 static int intel_prop_read(struct sdw_bus *bus)
897 {
898 	/* Initialize with default handler to read all DisCo properties */
899 	sdw_master_read_prop(bus);
900 
901 	/* read Intel-specific properties */
902 	sdw_master_read_intel_prop(bus);
903 
904 	return 0;
905 }
906 
907 static struct sdw_master_ops sdw_intel_ops = {
908 	.read_prop = sdw_master_read_prop,
909 	.xfer_msg = cdns_xfer_msg,
910 	.xfer_msg_defer = cdns_xfer_msg_defer,
911 	.reset_page_addr = cdns_reset_page_addr,
912 	.set_bus_conf = cdns_bus_conf,
913 	.pre_bank_switch = intel_pre_bank_switch,
914 	.post_bank_switch = intel_post_bank_switch,
915 };
916 
917 static int intel_init(struct sdw_intel *sdw)
918 {
919 	/* Initialize shim and controller */
920 	intel_link_power_up(sdw);
921 	intel_shim_init(sdw);
922 
923 	return sdw_cdns_init(&sdw->cdns, false);
924 }
925 
926 /*
927  * probe and init
928  */
929 static int intel_probe(struct platform_device *pdev)
930 {
931 	struct sdw_cdns_stream_config config;
932 	struct sdw_intel *sdw;
933 	int ret;
934 
935 	sdw = devm_kzalloc(&pdev->dev, sizeof(*sdw), GFP_KERNEL);
936 	if (!sdw)
937 		return -ENOMEM;
938 
939 	sdw->instance = pdev->id;
940 	sdw->res = dev_get_platdata(&pdev->dev);
941 	sdw->cdns.dev = &pdev->dev;
942 	sdw->cdns.registers = sdw->res->registers;
943 	sdw->cdns.instance = sdw->instance;
944 	sdw->cdns.msg_count = 0;
945 	sdw->cdns.bus.dev = &pdev->dev;
946 	sdw->cdns.bus.link_id = pdev->id;
947 
948 	sdw_cdns_probe(&sdw->cdns);
949 
950 	/* Set property read ops */
951 	sdw_intel_ops.read_prop = intel_prop_read;
952 	sdw->cdns.bus.ops = &sdw_intel_ops;
953 
954 	platform_set_drvdata(pdev, sdw);
955 
956 	ret = sdw_add_bus_master(&sdw->cdns.bus);
957 	if (ret) {
958 		dev_err(&pdev->dev, "sdw_add_bus_master fail: %d\n", ret);
959 		return ret;
960 	}
961 
962 	if (sdw->cdns.bus.prop.hw_disabled) {
963 		dev_info(&pdev->dev, "SoundWire master %d is disabled, ignoring\n",
964 			 sdw->cdns.bus.link_id);
965 		return 0;
966 	}
967 
968 	/* Initialize shim, controller and Cadence IP */
969 	ret = intel_init(sdw);
970 	if (ret)
971 		goto err_init;
972 
973 	/* Read the PDI config and initialize cadence PDI */
974 	intel_pdi_init(sdw, &config);
975 	ret = sdw_cdns_pdi_init(&sdw->cdns, config);
976 	if (ret)
977 		goto err_init;
978 
979 	intel_pdi_ch_update(sdw);
980 
981 	/* Acquire IRQ */
982 	ret = request_threaded_irq(sdw->res->irq, sdw_cdns_irq, sdw_cdns_thread,
983 				   IRQF_SHARED, KBUILD_MODNAME, &sdw->cdns);
984 	if (ret < 0) {
985 		dev_err(sdw->cdns.dev, "unable to grab IRQ %d, disabling device\n",
986 			sdw->res->irq);
987 		goto err_init;
988 	}
989 
990 	ret = sdw_cdns_enable_interrupt(&sdw->cdns, true);
991 	if (ret < 0) {
992 		dev_err(sdw->cdns.dev, "cannot enable interrupts\n");
993 		goto err_init;
994 	}
995 
996 	ret = sdw_cdns_exit_reset(&sdw->cdns);
997 	if (ret < 0) {
998 		dev_err(sdw->cdns.dev, "unable to exit bus reset sequence\n");
999 		goto err_interrupt;
1000 	}
1001 
1002 	/* Register DAIs */
1003 	ret = intel_register_dai(sdw);
1004 	if (ret) {
1005 		dev_err(sdw->cdns.dev, "DAI registration failed: %d\n", ret);
1006 		snd_soc_unregister_component(sdw->cdns.dev);
1007 		goto err_interrupt;
1008 	}
1009 
1010 	intel_debugfs_init(sdw);
1011 
1012 	return 0;
1013 
1014 err_interrupt:
1015 	sdw_cdns_enable_interrupt(&sdw->cdns, false);
1016 	free_irq(sdw->res->irq, sdw);
1017 err_init:
1018 	sdw_delete_bus_master(&sdw->cdns.bus);
1019 	return ret;
1020 }
1021 
1022 static int intel_remove(struct platform_device *pdev)
1023 {
1024 	struct sdw_intel *sdw;
1025 
1026 	sdw = platform_get_drvdata(pdev);
1027 
1028 	if (!sdw->cdns.bus.prop.hw_disabled) {
1029 		intel_debugfs_exit(sdw);
1030 		sdw_cdns_enable_interrupt(&sdw->cdns, false);
1031 		free_irq(sdw->res->irq, sdw);
1032 		snd_soc_unregister_component(sdw->cdns.dev);
1033 	}
1034 	sdw_delete_bus_master(&sdw->cdns.bus);
1035 
1036 	return 0;
1037 }
1038 
1039 static struct platform_driver sdw_intel_drv = {
1040 	.probe = intel_probe,
1041 	.remove = intel_remove,
1042 	.driver = {
1043 		.name = "int-sdw",
1044 
1045 	},
1046 };
1047 
1048 module_platform_driver(sdw_intel_drv);
1049 
1050 MODULE_LICENSE("Dual BSD/GPL");
1051 MODULE_ALIAS("platform:int-sdw");
1052 MODULE_DESCRIPTION("Intel Soundwire Master Driver");
1053