1// SPDX-License-Identifier: GPL-2.0-only
2// SPDX-FileCopyrightText: Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES.
3// All rights reserved.
4//
5// tegra210_ope.c - Tegra210 OPE driver
6
7#include <linux/clk.h>
8#include <linux/device.h>
9#include <linux/io.h>
10#include <linux/mod_devicetable.h>
11#include <linux/module.h>
12#include <linux/platform_device.h>
13#include <linux/pm_runtime.h>
14#include <linux/regmap.h>
15#include <sound/core.h>
16#include <sound/pcm.h>
17#include <sound/pcm_params.h>
18#include <sound/soc.h>
19
20#include "tegra210_mbdrc.h"
21#include "tegra210_ope.h"
22#include "tegra210_peq.h"
23#include "tegra_cif.h"
24
25static const struct reg_default tegra210_ope_reg_defaults[] = {
26 { TEGRA210_OPE_RX_INT_MASK, 0x00000001},
27 { TEGRA210_OPE_RX_CIF_CTRL, 0x00007700},
28 { TEGRA210_OPE_TX_INT_MASK, 0x00000001},
29 { TEGRA210_OPE_TX_CIF_CTRL, 0x00007700},
30 { TEGRA210_OPE_CG, 0x1},
31};
32
33static int tegra210_ope_set_audio_cif(struct tegra210_ope *ope,
34 struct snd_pcm_hw_params *params,
35 unsigned int reg)
36{
37 int channels, audio_bits;
38 struct tegra_cif_conf cif_conf;
39
40 memset(&cif_conf, 0, sizeof(struct tegra_cif_conf));
41
42 channels = params_channels(p: params);
43 if (channels < 2)
44 return -EINVAL;
45
46 switch (params_format(p: params)) {
47 case SNDRV_PCM_FORMAT_S16_LE:
48 audio_bits = TEGRA_ACIF_BITS_16;
49 break;
50 case SNDRV_PCM_FORMAT_S24_LE:
51 case SNDRV_PCM_FORMAT_S32_LE:
52 audio_bits = TEGRA_ACIF_BITS_32;
53 break;
54 default:
55 return -EINVAL;
56 }
57
58 cif_conf.audio_ch = channels;
59 cif_conf.client_ch = channels;
60 cif_conf.audio_bits = audio_bits;
61 cif_conf.client_bits = audio_bits;
62
63 tegra_set_cif(regmap: ope->regmap, reg, conf: &cif_conf);
64
65 return 0;
66}
67
68static int tegra210_ope_hw_params(struct snd_pcm_substream *substream,
69 struct snd_pcm_hw_params *params,
70 struct snd_soc_dai *dai)
71{
72 struct device *dev = dai->dev;
73 struct tegra210_ope *ope = snd_soc_dai_get_drvdata(dai);
74 int err;
75
76 /* Set RX and TX CIF */
77 err = tegra210_ope_set_audio_cif(ope, params,
78 TEGRA210_OPE_RX_CIF_CTRL);
79 if (err) {
80 dev_err(dev, "Can't set OPE RX CIF: %d\n", err);
81 return err;
82 }
83
84 err = tegra210_ope_set_audio_cif(ope, params,
85 TEGRA210_OPE_TX_CIF_CTRL);
86 if (err) {
87 dev_err(dev, "Can't set OPE TX CIF: %d\n", err);
88 return err;
89 }
90
91 tegra210_mbdrc_hw_params(cmpnt: dai->component);
92
93 return err;
94}
95
96static int tegra210_ope_component_probe(struct snd_soc_component *cmpnt)
97{
98 struct tegra210_ope *ope = dev_get_drvdata(dev: cmpnt->dev);
99
100 tegra210_peq_component_init(cmpnt);
101 tegra210_mbdrc_component_init(cmpnt);
102
103 /*
104 * The OPE, PEQ and MBDRC functionalities are combined under one
105 * device registered by OPE driver. In fact OPE HW block includes
106 * sub blocks PEQ and MBDRC. However driver registers separate
107 * regmap interfaces for each of these. ASoC core depends on
108 * dev_get_regmap() to populate the regmap field for a given ASoC
109 * component. A component can have one regmap reference and since
110 * the DAPM routes depend on OPE regmap only, below explicit
111 * assignment is done to highlight this. This is needed for ASoC
112 * core to access correct regmap during DAPM path setup.
113 */
114 snd_soc_component_init_regmap(component: cmpnt, regmap: ope->regmap);
115
116 return 0;
117}
118
119static const struct snd_soc_dai_ops tegra210_ope_dai_ops = {
120 .hw_params = tegra210_ope_hw_params,
121};
122
123static struct snd_soc_dai_driver tegra210_ope_dais[] = {
124 {
125 .name = "OPE-RX-CIF",
126 .playback = {
127 .stream_name = "RX-CIF-Playback",
128 .channels_min = 1,
129 .channels_max = 8,
130 .rates = SNDRV_PCM_RATE_8000_192000,
131 .formats = SNDRV_PCM_FMTBIT_S8 |
132 SNDRV_PCM_FMTBIT_S16_LE |
133 SNDRV_PCM_FMTBIT_S24_LE |
134 SNDRV_PCM_FMTBIT_S32_LE,
135 },
136 .capture = {
137 .stream_name = "RX-CIF-Capture",
138 .channels_min = 1,
139 .channels_max = 8,
140 .rates = SNDRV_PCM_RATE_8000_192000,
141 .formats = SNDRV_PCM_FMTBIT_S8 |
142 SNDRV_PCM_FMTBIT_S16_LE |
143 SNDRV_PCM_FMTBIT_S24_LE |
144 SNDRV_PCM_FMTBIT_S32_LE,
145 },
146 },
147 {
148 .name = "OPE-TX-CIF",
149 .playback = {
150 .stream_name = "TX-CIF-Playback",
151 .channels_min = 1,
152 .channels_max = 8,
153 .rates = SNDRV_PCM_RATE_8000_192000,
154 .formats = SNDRV_PCM_FMTBIT_S8 |
155 SNDRV_PCM_FMTBIT_S16_LE |
156 SNDRV_PCM_FMTBIT_S24_LE |
157 SNDRV_PCM_FMTBIT_S32_LE,
158 },
159 .capture = {
160 .stream_name = "TX-CIF-Capture",
161 .channels_min = 1,
162 .channels_max = 8,
163 .rates = SNDRV_PCM_RATE_8000_192000,
164 .formats = SNDRV_PCM_FMTBIT_S8 |
165 SNDRV_PCM_FMTBIT_S16_LE |
166 SNDRV_PCM_FMTBIT_S24_LE |
167 SNDRV_PCM_FMTBIT_S32_LE,
168 },
169 .ops = &tegra210_ope_dai_ops,
170 }
171};
172
173static const struct snd_soc_dapm_widget tegra210_ope_widgets[] = {
174 SND_SOC_DAPM_AIF_IN("RX", NULL, 0, SND_SOC_NOPM, 0, 0),
175 SND_SOC_DAPM_AIF_OUT("TX", NULL, 0, TEGRA210_OPE_ENABLE,
176 TEGRA210_OPE_EN_SHIFT, 0),
177};
178
179#define OPE_ROUTES(sname) \
180 { "RX XBAR-" sname, NULL, "XBAR-TX" }, \
181 { "RX-CIF-" sname, NULL, "RX XBAR-" sname }, \
182 { "RX", NULL, "RX-CIF-" sname }, \
183 { "TX-CIF-" sname, NULL, "TX" }, \
184 { "TX XBAR-" sname, NULL, "TX-CIF-" sname }, \
185 { "XBAR-RX", NULL, "TX XBAR-" sname }
186
187static const struct snd_soc_dapm_route tegra210_ope_routes[] = {
188 { "TX", NULL, "RX" },
189 OPE_ROUTES("Playback"),
190 OPE_ROUTES("Capture"),
191};
192
193static const char * const tegra210_ope_data_dir_text[] = {
194 "MBDRC to PEQ",
195 "PEQ to MBDRC"
196};
197
198static const struct soc_enum tegra210_ope_data_dir_enum =
199 SOC_ENUM_SINGLE(TEGRA210_OPE_DIR, TEGRA210_OPE_DIR_SHIFT,
200 2, tegra210_ope_data_dir_text);
201
202static int tegra210_ope_get_data_dir(struct snd_kcontrol *kcontrol,
203 struct snd_ctl_elem_value *ucontrol)
204{
205 struct snd_soc_component *cmpnt = snd_kcontrol_chip(kcontrol);
206 struct tegra210_ope *ope = snd_soc_component_get_drvdata(c: cmpnt);
207
208 ucontrol->value.enumerated.item[0] = ope->data_dir;
209
210 return 0;
211}
212
213static int tegra210_ope_put_data_dir(struct snd_kcontrol *kcontrol,
214 struct snd_ctl_elem_value *ucontrol)
215{
216 struct snd_soc_component *cmpnt = snd_kcontrol_chip(kcontrol);
217 struct tegra210_ope *ope = snd_soc_component_get_drvdata(c: cmpnt);
218 unsigned int value = ucontrol->value.enumerated.item[0];
219
220 if (value == ope->data_dir)
221 return 0;
222
223 ope->data_dir = value;
224
225 return 1;
226}
227
228static const struct snd_kcontrol_new tegra210_ope_controls[] = {
229 SOC_ENUM_EXT("Data Flow Direction", tegra210_ope_data_dir_enum,
230 tegra210_ope_get_data_dir, tegra210_ope_put_data_dir),
231};
232
233static const struct snd_soc_component_driver tegra210_ope_cmpnt = {
234 .probe = tegra210_ope_component_probe,
235 .dapm_widgets = tegra210_ope_widgets,
236 .num_dapm_widgets = ARRAY_SIZE(tegra210_ope_widgets),
237 .dapm_routes = tegra210_ope_routes,
238 .num_dapm_routes = ARRAY_SIZE(tegra210_ope_routes),
239 .controls = tegra210_ope_controls,
240 .num_controls = ARRAY_SIZE(tegra210_ope_controls),
241};
242
243static bool tegra210_ope_wr_reg(struct device *dev, unsigned int reg)
244{
245 switch (reg) {
246 case TEGRA210_OPE_RX_INT_MASK ... TEGRA210_OPE_RX_CIF_CTRL:
247 case TEGRA210_OPE_TX_INT_MASK ... TEGRA210_OPE_TX_CIF_CTRL:
248 case TEGRA210_OPE_ENABLE ... TEGRA210_OPE_CG:
249 case TEGRA210_OPE_DIR:
250 return true;
251 default:
252 return false;
253 }
254}
255
256static bool tegra210_ope_rd_reg(struct device *dev, unsigned int reg)
257{
258 if (tegra210_ope_wr_reg(dev, reg))
259 return true;
260
261 switch (reg) {
262 case TEGRA210_OPE_RX_STATUS:
263 case TEGRA210_OPE_RX_INT_STATUS:
264 case TEGRA210_OPE_TX_STATUS:
265 case TEGRA210_OPE_TX_INT_STATUS:
266 case TEGRA210_OPE_STATUS:
267 case TEGRA210_OPE_INT_STATUS:
268 return true;
269 default:
270 return false;
271 }
272}
273
274static bool tegra210_ope_volatile_reg(struct device *dev, unsigned int reg)
275{
276 switch (reg) {
277 case TEGRA210_OPE_RX_STATUS:
278 case TEGRA210_OPE_RX_INT_STATUS:
279 case TEGRA210_OPE_TX_STATUS:
280 case TEGRA210_OPE_TX_INT_STATUS:
281 case TEGRA210_OPE_SOFT_RESET:
282 case TEGRA210_OPE_STATUS:
283 case TEGRA210_OPE_INT_STATUS:
284 return true;
285 default:
286 return false;
287 }
288}
289
290static const struct regmap_config tegra210_ope_regmap_config = {
291 .reg_bits = 32,
292 .reg_stride = 4,
293 .val_bits = 32,
294 .max_register = TEGRA210_OPE_DIR,
295 .writeable_reg = tegra210_ope_wr_reg,
296 .readable_reg = tegra210_ope_rd_reg,
297 .volatile_reg = tegra210_ope_volatile_reg,
298 .reg_defaults = tegra210_ope_reg_defaults,
299 .num_reg_defaults = ARRAY_SIZE(tegra210_ope_reg_defaults),
300 .cache_type = REGCACHE_FLAT,
301};
302
303static int tegra210_ope_probe(struct platform_device *pdev)
304{
305 struct device *dev = &pdev->dev;
306 struct tegra210_ope *ope;
307 void __iomem *regs;
308 int err;
309
310 ope = devm_kzalloc(dev, size: sizeof(*ope), GFP_KERNEL);
311 if (!ope)
312 return -ENOMEM;
313
314 regs = devm_platform_ioremap_resource(pdev, index: 0);
315 if (IS_ERR(ptr: regs))
316 return PTR_ERR(ptr: regs);
317
318 ope->regmap = devm_regmap_init_mmio(dev, regs,
319 &tegra210_ope_regmap_config);
320 if (IS_ERR(ptr: ope->regmap)) {
321 dev_err(dev, "regmap init failed\n");
322 return PTR_ERR(ptr: ope->regmap);
323 }
324
325 regcache_cache_only(map: ope->regmap, enable: true);
326
327 dev_set_drvdata(dev, data: ope);
328
329 err = tegra210_peq_regmap_init(pdev);
330 if (err < 0) {
331 dev_err(dev, "PEQ init failed\n");
332 return err;
333 }
334
335 err = tegra210_mbdrc_regmap_init(pdev);
336 if (err < 0) {
337 dev_err(dev, "MBDRC init failed\n");
338 return err;
339 }
340
341 err = devm_snd_soc_register_component(dev, component_driver: &tegra210_ope_cmpnt,
342 dai_drv: tegra210_ope_dais,
343 ARRAY_SIZE(tegra210_ope_dais));
344 if (err) {
345 dev_err(dev, "can't register OPE component, err: %d\n", err);
346 return err;
347 }
348
349 pm_runtime_enable(dev);
350
351 return 0;
352}
353
354static void tegra210_ope_remove(struct platform_device *pdev)
355{
356 pm_runtime_disable(dev: &pdev->dev);
357}
358
359static int tegra210_ope_runtime_suspend(struct device *dev)
360{
361 struct tegra210_ope *ope = dev_get_drvdata(dev);
362
363 tegra210_peq_save(regmap: ope->peq_regmap, biquad_gains: ope->peq_biquad_gains,
364 biquad_shifts: ope->peq_biquad_shifts);
365
366 regcache_cache_only(map: ope->mbdrc_regmap, enable: true);
367 regcache_cache_only(map: ope->peq_regmap, enable: true);
368 regcache_cache_only(map: ope->regmap, enable: true);
369
370 regcache_mark_dirty(map: ope->regmap);
371 regcache_mark_dirty(map: ope->peq_regmap);
372 regcache_mark_dirty(map: ope->mbdrc_regmap);
373
374 return 0;
375}
376
377static int tegra210_ope_runtime_resume(struct device *dev)
378{
379 struct tegra210_ope *ope = dev_get_drvdata(dev);
380
381 regcache_cache_only(map: ope->regmap, enable: false);
382 regcache_cache_only(map: ope->peq_regmap, enable: false);
383 regcache_cache_only(map: ope->mbdrc_regmap, enable: false);
384
385 regcache_sync(map: ope->regmap);
386 regcache_sync(map: ope->peq_regmap);
387 regcache_sync(map: ope->mbdrc_regmap);
388
389 tegra210_peq_restore(regmap: ope->peq_regmap, biquad_gains: ope->peq_biquad_gains,
390 biquad_shifts: ope->peq_biquad_shifts);
391
392 return 0;
393}
394
395static const struct dev_pm_ops tegra210_ope_pm_ops = {
396 RUNTIME_PM_OPS(tegra210_ope_runtime_suspend,
397 tegra210_ope_runtime_resume, NULL)
398 SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend, pm_runtime_force_resume)
399};
400
401static const struct of_device_id tegra210_ope_of_match[] = {
402 { .compatible = "nvidia,tegra210-ope" },
403 {},
404};
405MODULE_DEVICE_TABLE(of, tegra210_ope_of_match);
406
407static struct platform_driver tegra210_ope_driver = {
408 .driver = {
409 .name = "tegra210-ope",
410 .of_match_table = tegra210_ope_of_match,
411 .pm = pm_ptr(&tegra210_ope_pm_ops),
412 },
413 .probe = tegra210_ope_probe,
414 .remove = tegra210_ope_remove,
415};
416module_platform_driver(tegra210_ope_driver)
417
418MODULE_AUTHOR("Sumit Bhattacharya <sumitb@nvidia.com>");
419MODULE_DESCRIPTION("Tegra210 OPE ASoC driver");
420MODULE_LICENSE("GPL");
421

source code of linux/sound/soc/tegra/tegra210_ope.c