xref: /openbmc/linux/sound/soc/codecs/max98373-sdw.c (revision 738f6ba1)
1 // SPDX-License-Identifier: GPL-2.0-only
2 // Copyright (c) 2020, Maxim Integrated
3 
4 #include <linux/acpi.h>
5 #include <linux/delay.h>
6 #include <linux/module.h>
7 #include <linux/mod_devicetable.h>
8 #include <linux/pm_runtime.h>
9 #include <linux/regmap.h>
10 #include <linux/slab.h>
11 #include <sound/pcm.h>
12 #include <sound/pcm_params.h>
13 #include <sound/soc.h>
14 #include <sound/tlv.h>
15 #include <linux/of.h>
16 #include <linux/soundwire/sdw.h>
17 #include <linux/soundwire/sdw_type.h>
18 #include <linux/soundwire/sdw_registers.h>
19 #include "max98373.h"
20 #include "max98373-sdw.h"
21 
22 struct sdw_stream_data {
23 	struct sdw_stream_runtime *sdw_stream;
24 };
25 
26 static const u32 max98373_sdw_cache_reg[] = {
27 	MAX98373_R2054_MEAS_ADC_PVDD_CH_READBACK,
28 	MAX98373_R2055_MEAS_ADC_THERM_CH_READBACK,
29 	MAX98373_R20B6_BDE_CUR_STATE_READBACK,
30 };
31 
32 static struct reg_default max98373_reg[] = {
33 	{MAX98373_R0040_SCP_INIT_STAT_1, 0x00},
34 	{MAX98373_R0041_SCP_INIT_MASK_1, 0x00},
35 	{MAX98373_R0042_SCP_INIT_STAT_2, 0x00},
36 	{MAX98373_R0044_SCP_CTRL, 0x00},
37 	{MAX98373_R0045_SCP_SYSTEM_CTRL, 0x00},
38 	{MAX98373_R0046_SCP_DEV_NUMBER, 0x00},
39 	{MAX98373_R0050_SCP_DEV_ID_0, 0x21},
40 	{MAX98373_R0051_SCP_DEV_ID_1, 0x01},
41 	{MAX98373_R0052_SCP_DEV_ID_2, 0x9F},
42 	{MAX98373_R0053_SCP_DEV_ID_3, 0x87},
43 	{MAX98373_R0054_SCP_DEV_ID_4, 0x08},
44 	{MAX98373_R0055_SCP_DEV_ID_5, 0x00},
45 	{MAX98373_R0060_SCP_FRAME_CTLR, 0x00},
46 	{MAX98373_R0070_SCP_FRAME_CTLR, 0x00},
47 	{MAX98373_R0100_DP1_INIT_STAT, 0x00},
48 	{MAX98373_R0101_DP1_INIT_MASK, 0x00},
49 	{MAX98373_R0102_DP1_PORT_CTRL, 0x00},
50 	{MAX98373_R0103_DP1_BLOCK_CTRL_1, 0x00},
51 	{MAX98373_R0104_DP1_PREPARE_STATUS, 0x00},
52 	{MAX98373_R0105_DP1_PREPARE_CTRL, 0x00},
53 	{MAX98373_R0120_DP1_CHANNEL_EN, 0x00},
54 	{MAX98373_R0122_DP1_SAMPLE_CTRL1, 0x00},
55 	{MAX98373_R0123_DP1_SAMPLE_CTRL2, 0x00},
56 	{MAX98373_R0124_DP1_OFFSET_CTRL1, 0x00},
57 	{MAX98373_R0125_DP1_OFFSET_CTRL2, 0x00},
58 	{MAX98373_R0126_DP1_HCTRL, 0x00},
59 	{MAX98373_R0127_DP1_BLOCK_CTRL3, 0x00},
60 	{MAX98373_R0130_DP1_CHANNEL_EN, 0x00},
61 	{MAX98373_R0132_DP1_SAMPLE_CTRL1, 0x00},
62 	{MAX98373_R0133_DP1_SAMPLE_CTRL2, 0x00},
63 	{MAX98373_R0134_DP1_OFFSET_CTRL1, 0x00},
64 	{MAX98373_R0135_DP1_OFFSET_CTRL2, 0x00},
65 	{MAX98373_R0136_DP1_HCTRL, 0x0136},
66 	{MAX98373_R0137_DP1_BLOCK_CTRL3, 0x00},
67 	{MAX98373_R0300_DP3_INIT_STAT, 0x00},
68 	{MAX98373_R0301_DP3_INIT_MASK, 0x00},
69 	{MAX98373_R0302_DP3_PORT_CTRL, 0x00},
70 	{MAX98373_R0303_DP3_BLOCK_CTRL_1, 0x00},
71 	{MAX98373_R0304_DP3_PREPARE_STATUS, 0x00},
72 	{MAX98373_R0305_DP3_PREPARE_CTRL, 0x00},
73 	{MAX98373_R0320_DP3_CHANNEL_EN, 0x00},
74 	{MAX98373_R0322_DP3_SAMPLE_CTRL1, 0x00},
75 	{MAX98373_R0323_DP3_SAMPLE_CTRL2, 0x00},
76 	{MAX98373_R0324_DP3_OFFSET_CTRL1, 0x00},
77 	{MAX98373_R0325_DP3_OFFSET_CTRL2, 0x00},
78 	{MAX98373_R0326_DP3_HCTRL, 0x00},
79 	{MAX98373_R0327_DP3_BLOCK_CTRL3, 0x00},
80 	{MAX98373_R0330_DP3_CHANNEL_EN, 0x00},
81 	{MAX98373_R0332_DP3_SAMPLE_CTRL1, 0x00},
82 	{MAX98373_R0333_DP3_SAMPLE_CTRL2, 0x00},
83 	{MAX98373_R0334_DP3_OFFSET_CTRL1, 0x00},
84 	{MAX98373_R0335_DP3_OFFSET_CTRL2, 0x00},
85 	{MAX98373_R0336_DP3_HCTRL, 0x00},
86 	{MAX98373_R0337_DP3_BLOCK_CTRL3, 0x00},
87 	{MAX98373_R2000_SW_RESET, 0x00},
88 	{MAX98373_R2001_INT_RAW1, 0x00},
89 	{MAX98373_R2002_INT_RAW2, 0x00},
90 	{MAX98373_R2003_INT_RAW3, 0x00},
91 	{MAX98373_R2004_INT_STATE1, 0x00},
92 	{MAX98373_R2005_INT_STATE2, 0x00},
93 	{MAX98373_R2006_INT_STATE3, 0x00},
94 	{MAX98373_R2007_INT_FLAG1, 0x00},
95 	{MAX98373_R2008_INT_FLAG2, 0x00},
96 	{MAX98373_R2009_INT_FLAG3, 0x00},
97 	{MAX98373_R200A_INT_EN1, 0x00},
98 	{MAX98373_R200B_INT_EN2, 0x00},
99 	{MAX98373_R200C_INT_EN3, 0x00},
100 	{MAX98373_R200D_INT_FLAG_CLR1, 0x00},
101 	{MAX98373_R200E_INT_FLAG_CLR2, 0x00},
102 	{MAX98373_R200F_INT_FLAG_CLR3, 0x00},
103 	{MAX98373_R2010_IRQ_CTRL, 0x00},
104 	{MAX98373_R2014_THERM_WARN_THRESH, 0x10},
105 	{MAX98373_R2015_THERM_SHDN_THRESH, 0x27},
106 	{MAX98373_R2016_THERM_HYSTERESIS, 0x01},
107 	{MAX98373_R2017_THERM_FOLDBACK_SET, 0xC0},
108 	{MAX98373_R2018_THERM_FOLDBACK_EN, 0x00},
109 	{MAX98373_R201E_PIN_DRIVE_STRENGTH, 0x55},
110 	{MAX98373_R2020_PCM_TX_HIZ_EN_1, 0xFE},
111 	{MAX98373_R2021_PCM_TX_HIZ_EN_2, 0xFF},
112 	{MAX98373_R2022_PCM_TX_SRC_1, 0x00},
113 	{MAX98373_R2023_PCM_TX_SRC_2, 0x00},
114 	{MAX98373_R2024_PCM_DATA_FMT_CFG, 0xC0},
115 	{MAX98373_R2025_AUDIO_IF_MODE, 0x00},
116 	{MAX98373_R2026_PCM_CLOCK_RATIO, 0x04},
117 	{MAX98373_R2027_PCM_SR_SETUP_1, 0x08},
118 	{MAX98373_R2028_PCM_SR_SETUP_2, 0x88},
119 	{MAX98373_R2029_PCM_TO_SPK_MONO_MIX_1, 0x00},
120 	{MAX98373_R202A_PCM_TO_SPK_MONO_MIX_2, 0x00},
121 	{MAX98373_R202B_PCM_RX_EN, 0x00},
122 	{MAX98373_R202C_PCM_TX_EN, 0x00},
123 	{MAX98373_R202E_ICC_RX_CH_EN_1, 0x00},
124 	{MAX98373_R202F_ICC_RX_CH_EN_2, 0x00},
125 	{MAX98373_R2030_ICC_TX_HIZ_EN_1, 0xFF},
126 	{MAX98373_R2031_ICC_TX_HIZ_EN_2, 0xFF},
127 	{MAX98373_R2032_ICC_LINK_EN_CFG, 0x30},
128 	{MAX98373_R2034_ICC_TX_CNTL, 0x00},
129 	{MAX98373_R2035_ICC_TX_EN, 0x00},
130 	{MAX98373_R2036_SOUNDWIRE_CTRL, 0x05},
131 	{MAX98373_R203D_AMP_DIG_VOL_CTRL, 0x00},
132 	{MAX98373_R203E_AMP_PATH_GAIN, 0x08},
133 	{MAX98373_R203F_AMP_DSP_CFG, 0x02},
134 	{MAX98373_R2040_TONE_GEN_CFG, 0x00},
135 	{MAX98373_R2041_AMP_CFG, 0x03},
136 	{MAX98373_R2042_AMP_EDGE_RATE_CFG, 0x00},
137 	{MAX98373_R2043_AMP_EN, 0x00},
138 	{MAX98373_R2046_IV_SENSE_ADC_DSP_CFG, 0x04},
139 	{MAX98373_R2047_IV_SENSE_ADC_EN, 0x00},
140 	{MAX98373_R2051_MEAS_ADC_SAMPLING_RATE, 0x00},
141 	{MAX98373_R2052_MEAS_ADC_PVDD_FLT_CFG, 0x00},
142 	{MAX98373_R2053_MEAS_ADC_THERM_FLT_CFG, 0x00},
143 	{MAX98373_R2054_MEAS_ADC_PVDD_CH_READBACK, 0x00},
144 	{MAX98373_R2055_MEAS_ADC_THERM_CH_READBACK, 0x00},
145 	{MAX98373_R2056_MEAS_ADC_PVDD_CH_EN, 0x00},
146 	{MAX98373_R2090_BDE_LVL_HOLD, 0x00},
147 	{MAX98373_R2091_BDE_GAIN_ATK_REL_RATE, 0x00},
148 	{MAX98373_R2092_BDE_CLIPPER_MODE, 0x00},
149 	{MAX98373_R2097_BDE_L1_THRESH, 0x00},
150 	{MAX98373_R2098_BDE_L2_THRESH, 0x00},
151 	{MAX98373_R2099_BDE_L3_THRESH, 0x00},
152 	{MAX98373_R209A_BDE_L4_THRESH, 0x00},
153 	{MAX98373_R209B_BDE_THRESH_HYST, 0x00},
154 	{MAX98373_R20A8_BDE_L1_CFG_1, 0x00},
155 	{MAX98373_R20A9_BDE_L1_CFG_2, 0x00},
156 	{MAX98373_R20AA_BDE_L1_CFG_3, 0x00},
157 	{MAX98373_R20AB_BDE_L2_CFG_1, 0x00},
158 	{MAX98373_R20AC_BDE_L2_CFG_2, 0x00},
159 	{MAX98373_R20AD_BDE_L2_CFG_3, 0x00},
160 	{MAX98373_R20AE_BDE_L3_CFG_1, 0x00},
161 	{MAX98373_R20AF_BDE_L3_CFG_2, 0x00},
162 	{MAX98373_R20B0_BDE_L3_CFG_3, 0x00},
163 	{MAX98373_R20B1_BDE_L4_CFG_1, 0x00},
164 	{MAX98373_R20B2_BDE_L4_CFG_2, 0x00},
165 	{MAX98373_R20B3_BDE_L4_CFG_3, 0x00},
166 	{MAX98373_R20B4_BDE_INFINITE_HOLD_RELEASE, 0x00},
167 	{MAX98373_R20B5_BDE_EN, 0x00},
168 	{MAX98373_R20B6_BDE_CUR_STATE_READBACK, 0x00},
169 	{MAX98373_R20D1_DHT_CFG, 0x01},
170 	{MAX98373_R20D2_DHT_ATTACK_CFG, 0x02},
171 	{MAX98373_R20D3_DHT_RELEASE_CFG, 0x03},
172 	{MAX98373_R20D4_DHT_EN, 0x00},
173 	{MAX98373_R20E0_LIMITER_THRESH_CFG, 0x00},
174 	{MAX98373_R20E1_LIMITER_ATK_REL_RATES, 0x00},
175 	{MAX98373_R20E2_LIMITER_EN, 0x00},
176 	{MAX98373_R20FE_DEVICE_AUTO_RESTART_CFG, 0x00},
177 	{MAX98373_R20FF_GLOBAL_SHDN, 0x00},
178 	{MAX98373_R21FF_REV_ID, 0x42},
179 };
180 
181 static bool max98373_readable_register(struct device *dev, unsigned int reg)
182 {
183 	switch (reg) {
184 	case MAX98373_R21FF_REV_ID:
185 	case MAX98373_R2010_IRQ_CTRL:
186 	/* SoundWire Control Port Registers */
187 	case MAX98373_R0040_SCP_INIT_STAT_1 ... MAX98373_R0070_SCP_FRAME_CTLR:
188 	/* Soundwire Data Port 1 Registers */
189 	case MAX98373_R0100_DP1_INIT_STAT ... MAX98373_R0137_DP1_BLOCK_CTRL3:
190 	/* Soundwire Data Port 3 Registers */
191 	case MAX98373_R0300_DP3_INIT_STAT ... MAX98373_R0337_DP3_BLOCK_CTRL3:
192 	case MAX98373_R2000_SW_RESET ... MAX98373_R200C_INT_EN3:
193 	case MAX98373_R2014_THERM_WARN_THRESH
194 		... MAX98373_R2018_THERM_FOLDBACK_EN:
195 	case MAX98373_R201E_PIN_DRIVE_STRENGTH
196 		... MAX98373_R2036_SOUNDWIRE_CTRL:
197 	case MAX98373_R203D_AMP_DIG_VOL_CTRL ... MAX98373_R2043_AMP_EN:
198 	case MAX98373_R2046_IV_SENSE_ADC_DSP_CFG
199 		... MAX98373_R2047_IV_SENSE_ADC_EN:
200 	case MAX98373_R2051_MEAS_ADC_SAMPLING_RATE
201 		... MAX98373_R2056_MEAS_ADC_PVDD_CH_EN:
202 	case MAX98373_R2090_BDE_LVL_HOLD ... MAX98373_R2092_BDE_CLIPPER_MODE:
203 	case MAX98373_R2097_BDE_L1_THRESH
204 		... MAX98373_R209B_BDE_THRESH_HYST:
205 	case MAX98373_R20A8_BDE_L1_CFG_1 ... MAX98373_R20B3_BDE_L4_CFG_3:
206 	case MAX98373_R20B5_BDE_EN ... MAX98373_R20B6_BDE_CUR_STATE_READBACK:
207 	case MAX98373_R20D1_DHT_CFG ... MAX98373_R20D4_DHT_EN:
208 	case MAX98373_R20E0_LIMITER_THRESH_CFG ... MAX98373_R20E2_LIMITER_EN:
209 	case MAX98373_R20FE_DEVICE_AUTO_RESTART_CFG
210 		... MAX98373_R20FF_GLOBAL_SHDN:
211 		return true;
212 	default:
213 		return false;
214 	}
215 };
216 
217 static bool max98373_volatile_reg(struct device *dev, unsigned int reg)
218 {
219 	switch (reg) {
220 	case MAX98373_R2054_MEAS_ADC_PVDD_CH_READBACK:
221 	case MAX98373_R2055_MEAS_ADC_THERM_CH_READBACK:
222 	case MAX98373_R20B6_BDE_CUR_STATE_READBACK:
223 	case MAX98373_R21FF_REV_ID:
224 	/* SoundWire Control Port Registers */
225 	case MAX98373_R0040_SCP_INIT_STAT_1 ... MAX98373_R0070_SCP_FRAME_CTLR:
226 	/* Soundwire Data Port 1 Registers */
227 	case MAX98373_R0100_DP1_INIT_STAT ... MAX98373_R0137_DP1_BLOCK_CTRL3:
228 	/* Soundwire Data Port 3 Registers */
229 	case MAX98373_R0300_DP3_INIT_STAT ... MAX98373_R0337_DP3_BLOCK_CTRL3:
230 	case MAX98373_R2000_SW_RESET ... MAX98373_R2009_INT_FLAG3:
231 		return true;
232 	default:
233 		return false;
234 	}
235 }
236 
237 static const struct regmap_config max98373_sdw_regmap = {
238 	.reg_bits = 32,
239 	.val_bits = 8,
240 	.max_register = MAX98373_R21FF_REV_ID,
241 	.reg_defaults  = max98373_reg,
242 	.num_reg_defaults = ARRAY_SIZE(max98373_reg),
243 	.readable_reg = max98373_readable_register,
244 	.volatile_reg = max98373_volatile_reg,
245 	.cache_type = REGCACHE_RBTREE,
246 	.use_single_read = true,
247 	.use_single_write = true,
248 };
249 
250 /* Power management functions and structure */
251 static __maybe_unused int max98373_suspend(struct device *dev)
252 {
253 	struct max98373_priv *max98373 = dev_get_drvdata(dev);
254 	int i;
255 
256 	/* cache feedback register values before suspend */
257 	for (i = 0; i < max98373->cache_num; i++)
258 		regmap_read(max98373->regmap, max98373->cache[i].reg, &max98373->cache[i].val);
259 
260 	regcache_cache_only(max98373->regmap, true);
261 
262 	return 0;
263 }
264 
265 #define MAX98373_PROBE_TIMEOUT 5000
266 
267 static __maybe_unused int max98373_resume(struct device *dev)
268 {
269 	struct sdw_slave *slave = dev_to_sdw_dev(dev);
270 	struct max98373_priv *max98373 = dev_get_drvdata(dev);
271 	unsigned long time;
272 
273 	if (!max98373->hw_init)
274 		return 0;
275 
276 	if (!slave->unattach_request)
277 		goto regmap_sync;
278 
279 	time = wait_for_completion_timeout(&slave->initialization_complete,
280 					   msecs_to_jiffies(MAX98373_PROBE_TIMEOUT));
281 	if (!time) {
282 		dev_err(dev, "Initialization not complete, timed out\n");
283 		return -ETIMEDOUT;
284 	}
285 
286 regmap_sync:
287 	slave->unattach_request = 0;
288 	regcache_cache_only(max98373->regmap, false);
289 	regcache_sync(max98373->regmap);
290 
291 	return 0;
292 }
293 
294 static const struct dev_pm_ops max98373_pm = {
295 	SET_SYSTEM_SLEEP_PM_OPS(max98373_suspend, max98373_resume)
296 	SET_RUNTIME_PM_OPS(max98373_suspend, max98373_resume, NULL)
297 };
298 
299 static int max98373_read_prop(struct sdw_slave *slave)
300 {
301 	struct sdw_slave_prop *prop = &slave->prop;
302 	int nval, i;
303 	u32 bit;
304 	unsigned long addr;
305 	struct sdw_dpn_prop *dpn;
306 
307 	prop->scp_int1_mask = SDW_SCP_INT1_BUS_CLASH | SDW_SCP_INT1_PARITY;
308 
309 	/* BITMAP: 00001000  Dataport 3 is active */
310 	prop->source_ports = BIT(3);
311 	/* BITMAP: 00000010  Dataport 1 is active */
312 	prop->sink_ports = BIT(1);
313 	prop->paging_support = true;
314 	prop->clk_stop_timeout = 20;
315 
316 	nval = hweight32(prop->source_ports);
317 	prop->src_dpn_prop = devm_kcalloc(&slave->dev, nval,
318 					  sizeof(*prop->src_dpn_prop),
319 					  GFP_KERNEL);
320 	if (!prop->src_dpn_prop)
321 		return -ENOMEM;
322 
323 	i = 0;
324 	dpn = prop->src_dpn_prop;
325 	addr = prop->source_ports;
326 	for_each_set_bit(bit, &addr, 32) {
327 		dpn[i].num = bit;
328 		dpn[i].type = SDW_DPN_FULL;
329 		dpn[i].simple_ch_prep_sm = true;
330 		dpn[i].ch_prep_timeout = 10;
331 		i++;
332 	}
333 
334 	/* do this again for sink now */
335 	nval = hweight32(prop->sink_ports);
336 	prop->sink_dpn_prop = devm_kcalloc(&slave->dev, nval,
337 					   sizeof(*prop->sink_dpn_prop),
338 					   GFP_KERNEL);
339 	if (!prop->sink_dpn_prop)
340 		return -ENOMEM;
341 
342 	i = 0;
343 	dpn = prop->sink_dpn_prop;
344 	addr = prop->sink_ports;
345 	for_each_set_bit(bit, &addr, 32) {
346 		dpn[i].num = bit;
347 		dpn[i].type = SDW_DPN_FULL;
348 		dpn[i].simple_ch_prep_sm = true;
349 		dpn[i].ch_prep_timeout = 10;
350 		i++;
351 	}
352 
353 	/* set the timeout values */
354 	prop->clk_stop_timeout = 20;
355 
356 	return 0;
357 }
358 
359 static int max98373_io_init(struct sdw_slave *slave)
360 {
361 	struct device *dev = &slave->dev;
362 	struct max98373_priv *max98373 = dev_get_drvdata(dev);
363 
364 	if (max98373->pm_init_once) {
365 		regcache_cache_only(max98373->regmap, false);
366 		regcache_cache_bypass(max98373->regmap, true);
367 	}
368 
369 	/*
370 	 * PM runtime is only enabled when a Slave reports as Attached
371 	 */
372 	if (!max98373->pm_init_once) {
373 		/* set autosuspend parameters */
374 		pm_runtime_set_autosuspend_delay(dev, 3000);
375 		pm_runtime_use_autosuspend(dev);
376 
377 		/* update count of parent 'active' children */
378 		pm_runtime_set_active(dev);
379 
380 		/* make sure the device does not suspend immediately */
381 		pm_runtime_mark_last_busy(dev);
382 
383 		pm_runtime_enable(dev);
384 	}
385 
386 	pm_runtime_get_noresume(dev);
387 
388 	/* Software Reset */
389 	max98373_reset(max98373, dev);
390 
391 	/* Set soundwire mode */
392 	regmap_write(max98373->regmap, MAX98373_R2025_AUDIO_IF_MODE, 3);
393 	/* Enable ADC */
394 	regmap_write(max98373->regmap, MAX98373_R2047_IV_SENSE_ADC_EN, 3);
395 	/* Set default Soundwire clock */
396 	regmap_write(max98373->regmap, MAX98373_R2036_SOUNDWIRE_CTRL, 5);
397 	/* Set default sampling rate for speaker and IVDAC */
398 	regmap_write(max98373->regmap, MAX98373_R2028_PCM_SR_SETUP_2, 0x88);
399 	/* IV default slot configuration */
400 	regmap_write(max98373->regmap,
401 		     MAX98373_R2020_PCM_TX_HIZ_EN_1,
402 		     0xFF);
403 	regmap_write(max98373->regmap,
404 		     MAX98373_R2021_PCM_TX_HIZ_EN_2,
405 		     0xFF);
406 	/* L/R mix configuration */
407 	regmap_write(max98373->regmap,
408 		     MAX98373_R2029_PCM_TO_SPK_MONO_MIX_1,
409 		     0x80);
410 	regmap_write(max98373->regmap,
411 		     MAX98373_R202A_PCM_TO_SPK_MONO_MIX_2,
412 		     0x1);
413 	/* Enable DC blocker */
414 	regmap_write(max98373->regmap,
415 		     MAX98373_R203F_AMP_DSP_CFG,
416 		     0x3);
417 	/* Enable IMON VMON DC blocker */
418 	regmap_write(max98373->regmap,
419 		     MAX98373_R2046_IV_SENSE_ADC_DSP_CFG,
420 		     0x7);
421 	/* voltage, current slot configuration */
422 	regmap_write(max98373->regmap,
423 		     MAX98373_R2022_PCM_TX_SRC_1,
424 		     (max98373->i_slot << MAX98373_PCM_TX_CH_SRC_A_I_SHIFT |
425 		     max98373->v_slot) & 0xFF);
426 	if (max98373->v_slot < 8)
427 		regmap_update_bits(max98373->regmap,
428 				   MAX98373_R2020_PCM_TX_HIZ_EN_1,
429 				   1 << max98373->v_slot, 0);
430 	else
431 		regmap_update_bits(max98373->regmap,
432 				   MAX98373_R2021_PCM_TX_HIZ_EN_2,
433 				   1 << (max98373->v_slot - 8), 0);
434 
435 	if (max98373->i_slot < 8)
436 		regmap_update_bits(max98373->regmap,
437 				   MAX98373_R2020_PCM_TX_HIZ_EN_1,
438 				   1 << max98373->i_slot, 0);
439 	else
440 		regmap_update_bits(max98373->regmap,
441 				   MAX98373_R2021_PCM_TX_HIZ_EN_2,
442 				   1 << (max98373->i_slot - 8), 0);
443 
444 	/* speaker feedback slot configuration */
445 	regmap_write(max98373->regmap,
446 		     MAX98373_R2023_PCM_TX_SRC_2,
447 		     max98373->spkfb_slot & 0xFF);
448 
449 	/* Set interleave mode */
450 	if (max98373->interleave_mode)
451 		regmap_update_bits(max98373->regmap,
452 				   MAX98373_R2024_PCM_DATA_FMT_CFG,
453 				   MAX98373_PCM_TX_CH_INTERLEAVE_MASK,
454 				   MAX98373_PCM_TX_CH_INTERLEAVE_MASK);
455 
456 	/* Speaker enable */
457 	regmap_update_bits(max98373->regmap,
458 			   MAX98373_R2043_AMP_EN,
459 			   MAX98373_SPK_EN_MASK, 1);
460 
461 	regmap_write(max98373->regmap, MAX98373_R20B5_BDE_EN, 1);
462 	regmap_write(max98373->regmap, MAX98373_R20E2_LIMITER_EN, 1);
463 
464 	if (max98373->pm_init_once) {
465 		regcache_cache_bypass(max98373->regmap, false);
466 		regcache_mark_dirty(max98373->regmap);
467 	}
468 
469 	max98373->pm_init_once = true;
470 	max98373->hw_init = true;
471 
472 	pm_runtime_mark_last_busy(dev);
473 	pm_runtime_put_autosuspend(dev);
474 
475 	return 0;
476 }
477 
478 static int max98373_clock_calculate(struct sdw_slave *slave,
479 				    unsigned int clk_freq)
480 {
481 	int x, y;
482 	static const int max98373_clk_family[] = {
483 		7680000, 8400000, 9600000, 11289600,
484 		12000000, 12288000, 13000000
485 	};
486 
487 	for (x = 0; x < 4; x++)
488 		for (y = 0; y < ARRAY_SIZE(max98373_clk_family); y++)
489 			if (clk_freq == (max98373_clk_family[y] >> x))
490 				return (x << 3) + y;
491 
492 	/* Set default clock (12.288 Mhz) if the value is not in the list */
493 	dev_err(&slave->dev, "Requested clock not found. (clk_freq = %d)\n",
494 		clk_freq);
495 	return 0x5;
496 }
497 
498 static int max98373_clock_config(struct sdw_slave *slave,
499 				 struct sdw_bus_params *params)
500 {
501 	struct device *dev = &slave->dev;
502 	struct max98373_priv *max98373 = dev_get_drvdata(dev);
503 	unsigned int clk_freq, value;
504 
505 	clk_freq = (params->curr_dr_freq >> 1);
506 
507 	/*
508 	 *	Select the proper value for the register based on the
509 	 *	requested clock. If the value is not in the list,
510 	 *	use reasonable default - 12.288 Mhz
511 	 */
512 	value = max98373_clock_calculate(slave, clk_freq);
513 
514 	/* SWCLK */
515 	regmap_write(max98373->regmap, MAX98373_R2036_SOUNDWIRE_CTRL, value);
516 
517 	/* The default Sampling Rate value for IV is 48KHz*/
518 	regmap_write(max98373->regmap, MAX98373_R2028_PCM_SR_SETUP_2, 0x88);
519 
520 	return 0;
521 }
522 
523 #define MAX98373_RATES SNDRV_PCM_RATE_8000_96000
524 #define MAX98373_FORMATS (SNDRV_PCM_FMTBIT_S32_LE)
525 
526 static int max98373_sdw_dai_hw_params(struct snd_pcm_substream *substream,
527 				      struct snd_pcm_hw_params *params,
528 				      struct snd_soc_dai *dai)
529 {
530 	struct snd_soc_component *component = dai->component;
531 	struct max98373_priv *max98373 =
532 		snd_soc_component_get_drvdata(component);
533 
534 	struct sdw_stream_config stream_config;
535 	struct sdw_port_config port_config;
536 	enum sdw_data_direction direction;
537 	struct sdw_stream_data *stream;
538 	int ret, chan_sz, sampling_rate;
539 
540 	stream = snd_soc_dai_get_dma_data(dai, substream);
541 
542 	if (!stream)
543 		return -EINVAL;
544 
545 	if (!max98373->slave)
546 		return -EINVAL;
547 
548 	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
549 		direction = SDW_DATA_DIR_RX;
550 		port_config.num = 1;
551 	} else {
552 		direction = SDW_DATA_DIR_TX;
553 		port_config.num = 3;
554 	}
555 
556 	stream_config.frame_rate = params_rate(params);
557 	stream_config.bps = snd_pcm_format_width(params_format(params));
558 	stream_config.direction = direction;
559 
560 	if (max98373->slot && direction == SDW_DATA_DIR_RX) {
561 		stream_config.ch_count = max98373->slot;
562 		port_config.ch_mask = max98373->rx_mask;
563 	} else {
564 		/* only IV are supported by capture */
565 		if (direction == SDW_DATA_DIR_TX)
566 			stream_config.ch_count = 2;
567 		else
568 			stream_config.ch_count = params_channels(params);
569 
570 		port_config.ch_mask = GENMASK((int)stream_config.ch_count - 1, 0);
571 	}
572 
573 	ret = sdw_stream_add_slave(max98373->slave, &stream_config,
574 				   &port_config, 1, stream->sdw_stream);
575 	if (ret) {
576 		dev_err(dai->dev, "Unable to configure port\n");
577 		return ret;
578 	}
579 
580 	if (params_channels(params) > 16) {
581 		dev_err(component->dev, "Unsupported channels %d\n",
582 			params_channels(params));
583 		return -EINVAL;
584 	}
585 
586 	/* Channel size configuration */
587 	switch (snd_pcm_format_width(params_format(params))) {
588 	case 16:
589 		chan_sz = MAX98373_PCM_MODE_CFG_CHANSZ_16;
590 		break;
591 	case 24:
592 		chan_sz = MAX98373_PCM_MODE_CFG_CHANSZ_24;
593 		break;
594 	case 32:
595 		chan_sz = MAX98373_PCM_MODE_CFG_CHANSZ_32;
596 		break;
597 	default:
598 		dev_err(component->dev, "Channel size unsupported %d\n",
599 			params_format(params));
600 		return -EINVAL;
601 	}
602 
603 	max98373->ch_size = snd_pcm_format_width(params_format(params));
604 
605 	regmap_update_bits(max98373->regmap,
606 			   MAX98373_R2024_PCM_DATA_FMT_CFG,
607 			   MAX98373_PCM_MODE_CFG_CHANSZ_MASK, chan_sz);
608 
609 	dev_dbg(component->dev, "Format supported %d", params_format(params));
610 
611 	/* Sampling rate configuration */
612 	switch (params_rate(params)) {
613 	case 8000:
614 		sampling_rate = MAX98373_PCM_SR_SET1_SR_8000;
615 		break;
616 	case 11025:
617 		sampling_rate = MAX98373_PCM_SR_SET1_SR_11025;
618 		break;
619 	case 12000:
620 		sampling_rate = MAX98373_PCM_SR_SET1_SR_12000;
621 		break;
622 	case 16000:
623 		sampling_rate = MAX98373_PCM_SR_SET1_SR_16000;
624 		break;
625 	case 22050:
626 		sampling_rate = MAX98373_PCM_SR_SET1_SR_22050;
627 		break;
628 	case 24000:
629 		sampling_rate = MAX98373_PCM_SR_SET1_SR_24000;
630 		break;
631 	case 32000:
632 		sampling_rate = MAX98373_PCM_SR_SET1_SR_32000;
633 		break;
634 	case 44100:
635 		sampling_rate = MAX98373_PCM_SR_SET1_SR_44100;
636 		break;
637 	case 48000:
638 		sampling_rate = MAX98373_PCM_SR_SET1_SR_48000;
639 		break;
640 	case 88200:
641 		sampling_rate = MAX98373_PCM_SR_SET1_SR_88200;
642 		break;
643 	case 96000:
644 		sampling_rate = MAX98373_PCM_SR_SET1_SR_96000;
645 		break;
646 	default:
647 		dev_err(component->dev, "Rate %d is not supported\n",
648 			params_rate(params));
649 		return -EINVAL;
650 	}
651 
652 	/* set correct sampling frequency */
653 	regmap_update_bits(max98373->regmap,
654 			   MAX98373_R2028_PCM_SR_SETUP_2,
655 			   MAX98373_PCM_SR_SET2_SR_MASK,
656 			   sampling_rate << MAX98373_PCM_SR_SET2_SR_SHIFT);
657 
658 	/* set sampling rate of IV */
659 	regmap_update_bits(max98373->regmap,
660 			   MAX98373_R2028_PCM_SR_SETUP_2,
661 			   MAX98373_PCM_SR_SET2_IVADC_SR_MASK,
662 			   sampling_rate);
663 
664 	return 0;
665 }
666 
667 static int max98373_pcm_hw_free(struct snd_pcm_substream *substream,
668 				struct snd_soc_dai *dai)
669 {
670 	struct snd_soc_component *component = dai->component;
671 	struct max98373_priv *max98373 =
672 		snd_soc_component_get_drvdata(component);
673 	struct sdw_stream_data *stream =
674 		snd_soc_dai_get_dma_data(dai, substream);
675 
676 	if (!max98373->slave)
677 		return -EINVAL;
678 
679 	sdw_stream_remove_slave(max98373->slave, stream->sdw_stream);
680 	return 0;
681 }
682 
683 static int max98373_set_sdw_stream(struct snd_soc_dai *dai,
684 				   void *sdw_stream, int direction)
685 {
686 	struct sdw_stream_data *stream;
687 
688 	if (!sdw_stream)
689 		return 0;
690 
691 	stream = kzalloc(sizeof(*stream), GFP_KERNEL);
692 	if (!stream)
693 		return -ENOMEM;
694 
695 	stream->sdw_stream = sdw_stream;
696 
697 	/* Use tx_mask or rx_mask to configure stream tag and set dma_data */
698 	if (direction == SNDRV_PCM_STREAM_PLAYBACK)
699 		dai->playback_dma_data = stream;
700 	else
701 		dai->capture_dma_data = stream;
702 
703 	return 0;
704 }
705 
706 static void max98373_shutdown(struct snd_pcm_substream *substream,
707 			      struct snd_soc_dai *dai)
708 {
709 	struct sdw_stream_data *stream;
710 
711 	stream = snd_soc_dai_get_dma_data(dai, substream);
712 	snd_soc_dai_set_dma_data(dai, substream, NULL);
713 	kfree(stream);
714 }
715 
716 static int max98373_sdw_set_tdm_slot(struct snd_soc_dai *dai,
717 				     unsigned int tx_mask,
718 				     unsigned int rx_mask,
719 				     int slots, int slot_width)
720 {
721 	struct snd_soc_component *component = dai->component;
722 	struct max98373_priv *max98373 =
723 		snd_soc_component_get_drvdata(component);
724 
725 	/* tx_mask is unused since it's irrelevant for I/V feedback */
726 	if (tx_mask)
727 		return -EINVAL;
728 
729 	if (!rx_mask && !slots && !slot_width)
730 		max98373->tdm_mode = false;
731 	else
732 		max98373->tdm_mode = true;
733 
734 	max98373->rx_mask = rx_mask;
735 	max98373->slot = slots;
736 
737 	return 0;
738 }
739 
740 static const struct snd_soc_dai_ops max98373_dai_sdw_ops = {
741 	.hw_params = max98373_sdw_dai_hw_params,
742 	.hw_free = max98373_pcm_hw_free,
743 	.set_sdw_stream = max98373_set_sdw_stream,
744 	.shutdown = max98373_shutdown,
745 	.set_tdm_slot = max98373_sdw_set_tdm_slot,
746 };
747 
748 static struct snd_soc_dai_driver max98373_sdw_dai[] = {
749 	{
750 		.name = "max98373-aif1",
751 		.playback = {
752 			.stream_name = "HiFi Playback",
753 			.channels_min = 1,
754 			.channels_max = 2,
755 			.rates = MAX98373_RATES,
756 			.formats = MAX98373_FORMATS,
757 		},
758 		.capture = {
759 			.stream_name = "HiFi Capture",
760 			.channels_min = 1,
761 			.channels_max = 2,
762 			.rates = MAX98373_RATES,
763 			.formats = MAX98373_FORMATS,
764 		},
765 		.ops = &max98373_dai_sdw_ops,
766 	}
767 };
768 
769 static int max98373_init(struct sdw_slave *slave, struct regmap *regmap)
770 {
771 	struct max98373_priv *max98373;
772 	int ret;
773 	int i;
774 	struct device *dev = &slave->dev;
775 
776 	/*  Allocate and assign private driver data structure  */
777 	max98373 = devm_kzalloc(dev, sizeof(*max98373), GFP_KERNEL);
778 	if (!max98373)
779 		return -ENOMEM;
780 
781 	dev_set_drvdata(dev, max98373);
782 	max98373->regmap = regmap;
783 	max98373->slave = slave;
784 
785 	max98373->cache_num = ARRAY_SIZE(max98373_sdw_cache_reg);
786 	max98373->cache = devm_kcalloc(dev, max98373->cache_num,
787 				       sizeof(*max98373->cache),
788 				       GFP_KERNEL);
789 
790 	for (i = 0; i < max98373->cache_num; i++)
791 		max98373->cache[i].reg = max98373_sdw_cache_reg[i];
792 
793 	/* Read voltage and slot configuration */
794 	max98373_slot_config(dev, max98373);
795 
796 	max98373->hw_init = false;
797 	max98373->pm_init_once = false;
798 
799 	/* codec registration  */
800 	ret = devm_snd_soc_register_component(dev, &soc_codec_dev_max98373_sdw,
801 					      max98373_sdw_dai,
802 					      ARRAY_SIZE(max98373_sdw_dai));
803 	if (ret < 0)
804 		dev_err(dev, "Failed to register codec: %d\n", ret);
805 
806 	return ret;
807 }
808 
809 static int max98373_update_status(struct sdw_slave *slave,
810 				  enum sdw_slave_status status)
811 {
812 	struct max98373_priv *max98373 = dev_get_drvdata(&slave->dev);
813 
814 	if (status == SDW_SLAVE_UNATTACHED)
815 		max98373->hw_init = false;
816 
817 	/*
818 	 * Perform initialization only if slave status is SDW_SLAVE_ATTACHED
819 	 */
820 	if (max98373->hw_init || status != SDW_SLAVE_ATTACHED)
821 		return 0;
822 
823 	/* perform I/O transfers required for Slave initialization */
824 	return max98373_io_init(slave);
825 }
826 
827 static int max98373_bus_config(struct sdw_slave *slave,
828 			       struct sdw_bus_params *params)
829 {
830 	int ret;
831 
832 	ret = max98373_clock_config(slave, params);
833 	if (ret < 0)
834 		dev_err(&slave->dev, "Invalid clk config");
835 
836 	return ret;
837 }
838 
839 /*
840  * slave_ops: callbacks for get_clock_stop_mode, clock_stop and
841  * port_prep are not defined for now
842  */
843 static struct sdw_slave_ops max98373_slave_ops = {
844 	.read_prop = max98373_read_prop,
845 	.update_status = max98373_update_status,
846 	.bus_config = max98373_bus_config,
847 };
848 
849 static int max98373_sdw_probe(struct sdw_slave *slave,
850 			      const struct sdw_device_id *id)
851 {
852 	struct regmap *regmap;
853 
854 	/* Regmap Initialization */
855 	regmap = devm_regmap_init_sdw(slave, &max98373_sdw_regmap);
856 	if (IS_ERR(regmap))
857 		return PTR_ERR(regmap);
858 
859 	return max98373_init(slave, regmap);
860 }
861 
862 #if defined(CONFIG_OF)
863 static const struct of_device_id max98373_of_match[] = {
864 	{ .compatible = "maxim,max98373", },
865 	{},
866 };
867 MODULE_DEVICE_TABLE(of, max98373_of_match);
868 #endif
869 
870 #ifdef CONFIG_ACPI
871 static const struct acpi_device_id max98373_acpi_match[] = {
872 	{ "MX98373", 0 },
873 	{},
874 };
875 MODULE_DEVICE_TABLE(acpi, max98373_acpi_match);
876 #endif
877 
878 static const struct sdw_device_id max98373_id[] = {
879 	SDW_SLAVE_ENTRY(0x019F, 0x8373, 0),
880 	{},
881 };
882 MODULE_DEVICE_TABLE(sdw, max98373_id);
883 
884 static struct sdw_driver max98373_sdw_driver = {
885 	.driver = {
886 		.name = "max98373",
887 		.owner = THIS_MODULE,
888 		.of_match_table = of_match_ptr(max98373_of_match),
889 		.acpi_match_table = ACPI_PTR(max98373_acpi_match),
890 		.pm = &max98373_pm,
891 	},
892 	.probe = max98373_sdw_probe,
893 	.remove = NULL,
894 	.ops = &max98373_slave_ops,
895 	.id_table = max98373_id,
896 };
897 
898 module_sdw_driver(max98373_sdw_driver);
899 
900 MODULE_DESCRIPTION("ASoC MAX98373 driver SDW");
901 MODULE_AUTHOR("Oleg Sherbakov <oleg.sherbakov@maximintegrated.com>");
902 MODULE_LICENSE("GPL v2");
903