1 From e740bd2cc3fcd632fcd6c8881b1fc671bcde5914 Mon Sep 17 00:00:00 2001
2 From: dev-3Dlab <45081440+dev-3Dlab@users.noreply.github.com>
3 Date: Wed, 5 Dec 2018 10:59:11 +0100
4 Subject: [PATCH 288/806] ASoC: add driver for 3Dlab Nano soundcard (#2758)
6 Signed-off-by: GT <dev@3d-lab-av.com>
8 .../overlays/3dlab-nano-player-overlay.dts | 32 ++
9 arch/arm/boot/dts/overlays/Makefile | 1 +
10 arch/arm/boot/dts/overlays/README | 6 +
11 sound/soc/bcm/3dlab-nano-player.c | 370 ++++++++++++++++++
12 sound/soc/bcm/Kconfig | 6 +
13 sound/soc/bcm/Makefile | 2 +
14 8 files changed, 419 insertions(+)
15 create mode 100644 arch/arm/boot/dts/overlays/3dlab-nano-player-overlay.dts
16 create mode 100644 sound/soc/bcm/3dlab-nano-player.c
19 +++ b/arch/arm/boot/dts/overlays/3dlab-nano-player-overlay.dts
21 +// Definitions for 3Dlab Nano Player
26 + compatible = "brcm,bcm2708";
38 + #address-cells = <1>;
43 + compatible = "3dlab,nano-player";
45 + i2s-controller = <&i2s>;
53 --- a/arch/arm/boot/dts/overlays/Makefile
54 +++ b/arch/arm/boot/dts/overlays/Makefile
56 # Overlays for the Raspberry Pi platform
58 dtbo-$(CONFIG_ARCH_BCM2835) += \
59 + 3dlab-nano-player.dtbo \
61 adau7002-simple.dtbo \
63 --- a/arch/arm/boot/dts/overlays/README
64 +++ b/arch/arm/boot/dts/overlays/README
65 @@ -199,6 +199,12 @@ Params:
66 and the other i2c baudrate parameters.
69 +Name: 3dlab-nano-player
70 +Info: Configures the 3Dlab Nano Player
71 +Load: dtoverlay=3dlab-nano-player
76 Info: Overlay for activation of ADAU1977 ADC codec over I2C for control
79 +++ b/sound/soc/bcm/3dlab-nano-player.c
82 + * 3Dlab Nano Player ALSA SoC Audio driver.
84 + * Copyright (C) 2018 3Dlab.
86 + * Author: GT <dev@3d-lab-av.com>
88 + * This program is free software; you can redistribute it and/or
89 + * modify it under the terms of the GNU General Public License
90 + * version 2 as published by the Free Software Foundation.
92 + * This program is distributed in the hope that it will be useful, but
93 + * WITHOUT ANY WARRANTY; without even the implied warranty of
94 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
95 + * General Public License for more details.
98 +#include <linux/module.h>
99 +#include <linux/i2c.h>
100 +#include <sound/soc.h>
101 +#include <sound/pcm.h>
102 +#include <sound/pcm_params.h>
103 +#include <sound/control.h>
105 +#define NANO_ID 0x00
106 +#define NANO_VER 0x01
107 +#define NANO_CFG 0x02
108 +#define NANO_STATUS 0x03
109 +#define NANO_SPI_ADDR 0x04
110 +#define NANO_SPI_DATA 0x05
112 +#define NANO_ID_VAL 0x3D
113 +#define NANO_CFG_OFF 0x00
114 +#define NANO_CFG_MULT1 0
115 +#define NANO_CFG_MULT2 1
116 +#define NANO_CFG_MULT4 2
117 +#define NANO_CFG_MULT8 3
118 +#define NANO_CFG_MULT16 4
119 +#define NANO_CFG_CLK22 0
120 +#define NANO_CFG_CLK24 BIT(3)
121 +#define NANO_CFG_DSD BIT(4)
122 +#define NANO_CFG_ENA BIT(5)
123 +#define NANO_CFG_BLINK BIT(6)
124 +#define NANO_STATUS_P1 BIT(0)
125 +#define NANO_STATUS_P2 BIT(1)
126 +#define NANO_STATUS_FLG BIT(2)
127 +#define NANO_STATUS_CLK BIT(3)
128 +#define NANO_SPI_READ 0
129 +#define NANO_SPI_WRITE BIT(5)
131 +#define NANO_DAC_CTRL1 0x00
132 +#define NANO_DAC_CTRL2 0x01
133 +#define NANO_DAC_CTRL3 0x02
134 +#define NANO_DAC_LATT 0x03
135 +#define NANO_DAC_RATT 0x04
137 +#define NANO_CTRL2_VAL 0x22
139 +static int nano_player_spi_write(struct regmap *map,
140 + unsigned int reg, unsigned int val)
142 + /* indirect register access */
143 + regmap_write(map, NANO_SPI_DATA, val);
144 + regmap_write(map, NANO_SPI_ADDR, reg | NANO_SPI_WRITE);
148 +static int nano_player_ctrl_info(struct snd_kcontrol *kcontrol,
149 + struct snd_ctl_elem_info *uinfo)
151 + /* describe control element */
152 + if (strstr(kcontrol->id.name, "Volume")) {
153 + uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
155 + uinfo->value.integer.min = 0;
156 + uinfo->value.integer.max = 100;
158 + uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
160 + uinfo->value.integer.min = 0;
161 + uinfo->value.integer.max = 1;
167 +static int nano_player_ctrl_put(struct snd_kcontrol *kcontrol,
168 + struct snd_ctl_elem_value *ucontrol)
170 + /* program control value to hardware */
171 + struct snd_soc_card *card = snd_kcontrol_chip(kcontrol);
172 + struct regmap *regmap = snd_soc_card_get_drvdata(card);
174 + if (strstr(kcontrol->id.name, "Volume")) {
175 + unsigned int vol = ucontrol->value.integer.value[0];
176 + unsigned int att = 255 - (2 * (100 - vol));
178 + nano_player_spi_write(regmap, NANO_DAC_LATT, att);
179 + nano_player_spi_write(regmap, NANO_DAC_RATT, att);
180 + kcontrol->private_value = vol;
182 + unsigned int mute = ucontrol->value.integer.value[0];
183 + unsigned int reg = NANO_CTRL2_VAL | mute;
185 + nano_player_spi_write(regmap, NANO_DAC_CTRL2, reg);
186 + kcontrol->private_value = mute;
191 +static int nano_player_ctrl_get(struct snd_kcontrol *kcontrol,
192 + struct snd_ctl_elem_value *ucontrol)
194 + /* return last programmed value */
195 + ucontrol->value.integer.value[0] = kcontrol->private_value;
199 +#define SOC_NANO_PLAYER_CTRL(xname) \
200 +{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
201 + .access = SNDRV_CTL_ELEM_ACCESS_READWRITE, \
202 + .info = nano_player_ctrl_info, \
203 + .put = nano_player_ctrl_put, \
204 + .get = nano_player_ctrl_get }
206 +static const struct snd_kcontrol_new nano_player_controls[] = {
207 + SOC_NANO_PLAYER_CTRL("Master Playback Volume"),
208 + SOC_NANO_PLAYER_CTRL("Master Playback Switch"),
211 +static const unsigned int nano_player_rates[] = {
212 + 44100, 48000, 88200, 96000, 176400, 192000, 352800, 384000,
213 + 705600, 768000 /* only possible with fast clocks */
216 +static struct snd_pcm_hw_constraint_list nano_player_constraint_rates = {
217 + .list = nano_player_rates,
218 + .count = ARRAY_SIZE(nano_player_rates),
221 +static int nano_player_init(struct snd_soc_pcm_runtime *rtd)
223 + struct snd_soc_card *card = rtd->card;
224 + struct regmap *regmap = snd_soc_card_get_drvdata(card);
225 + struct snd_soc_pcm_stream *cpu = &rtd->cpu_dai->driver->playback;
226 + struct snd_soc_pcm_stream *codec = &rtd->codec_dai->driver->playback;
227 + unsigned int sample_bits = 32;
230 + /* configure cpu dai */
231 + cpu->formats |= SNDRV_PCM_FMTBIT_DSD_U32_LE;
232 + cpu->rate_max = 768000;
234 + /* configure dummy codec dai */
235 + codec->rate_min = 44100;
236 + codec->rates = SNDRV_PCM_RATE_KNOT;
237 + codec->formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_DSD_U32_LE;
239 + /* configure max supported rate */
240 + regmap_read(regmap, NANO_STATUS, &val);
241 + if (val & NANO_STATUS_CLK) {
242 + dev_notice(card->dev, "Board with fast clocks installed\n");
243 + codec->rate_max = 768000;
245 + dev_notice(card->dev, "Board with normal clocks installed\n");
246 + codec->rate_max = 384000;
249 + /* frame length enforced by hardware */
250 + return snd_soc_dai_set_bclk_ratio(rtd->cpu_dai, sample_bits * 2);
253 +static int nano_player_startup(struct snd_pcm_substream *substream)
255 + return snd_pcm_hw_constraint_list(substream->runtime, 0,
256 + SNDRV_PCM_HW_PARAM_RATE,
257 + &nano_player_constraint_rates);
260 +static int nano_player_hw_params(struct snd_pcm_substream *substream,
261 + struct snd_pcm_hw_params *params)
263 + struct snd_soc_pcm_runtime *rtd = substream->private_data;
264 + struct snd_soc_card *card = rtd->card;
265 + struct regmap *regmap = snd_soc_card_get_drvdata(card);
266 + unsigned int config = NANO_CFG_ENA;
267 + struct snd_mask *fmt;
269 + /* configure PCM or DSD */
270 + fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
271 + if (snd_mask_test(fmt, SNDRV_PCM_FORMAT_DSD_U32_LE)) {
272 + /* embed DSD in PCM data */
273 + snd_mask_none(fmt);
274 + snd_mask_set(fmt, SNDRV_PCM_FORMAT_S32_LE);
275 + /* enable DSD mode */
276 + config |= NANO_CFG_DSD;
279 + /* configure clocks */
280 + switch (params_rate(params)) {
282 + config |= NANO_CFG_MULT1 | NANO_CFG_CLK22;
285 + config |= NANO_CFG_MULT2 | NANO_CFG_CLK22;
288 + config |= NANO_CFG_MULT4 | NANO_CFG_CLK22;
291 + config |= NANO_CFG_MULT8 | NANO_CFG_CLK22;
294 + config |= NANO_CFG_MULT16 | NANO_CFG_CLK22;
297 + config |= NANO_CFG_MULT1 | NANO_CFG_CLK24;
300 + config |= NANO_CFG_MULT2 | NANO_CFG_CLK24;
303 + config |= NANO_CFG_MULT4 | NANO_CFG_CLK24;
306 + config |= NANO_CFG_MULT8 | NANO_CFG_CLK24;
309 + config |= NANO_CFG_MULT16 | NANO_CFG_CLK24;
315 + dev_dbg(card->dev, "Send CFG register 0x%02X\n", config);
316 + return regmap_write(regmap, NANO_CFG, config);
319 +static struct snd_soc_ops nano_player_ops = {
320 + .startup = nano_player_startup,
321 + .hw_params = nano_player_hw_params,
324 +static struct snd_soc_dai_link nano_player_link = {
325 + .name = "3Dlab Nano Player",
326 + .stream_name = "3Dlab Nano Player HiFi",
327 + .platform_name = "bcm2708-i2s.0",
328 + .cpu_dai_name = "bcm2708-i2s.0",
329 + .codec_name = "snd-soc-dummy",
330 + .codec_dai_name = "snd-soc-dummy-dai",
331 + .dai_fmt = SND_SOC_DAIFMT_I2S |
332 + SND_SOC_DAIFMT_CONT |
333 + SND_SOC_DAIFMT_NB_NF |
334 + SND_SOC_DAIFMT_CBM_CFM,
335 + .init = nano_player_init,
336 + .ops = &nano_player_ops,
339 +static const struct regmap_config nano_player_regmap = {
342 + .max_register = 128,
343 + .cache_type = REGCACHE_RBTREE,
346 +static int nano_player_card_probe(struct snd_soc_card *card)
348 + struct regmap *regmap = snd_soc_card_get_drvdata(card);
351 + /* check hardware integrity */
352 + regmap_read(regmap, NANO_ID, &val);
353 + if (val != NANO_ID_VAL) {
354 + dev_err(card->dev, "Invalid ID register 0x%02X\n", val);
358 + /* report version to the user */
359 + regmap_read(regmap, NANO_VER, &val);
360 + dev_notice(card->dev, "Started 3Dlab Nano Player driver (v%d)\n", val);
362 + /* enable internal audio bus and blink status LED */
363 + return regmap_write(regmap, NANO_CFG, NANO_CFG_ENA | NANO_CFG_BLINK);
366 +static int nano_player_card_remove(struct snd_soc_card *card)
368 + /* disable internal audio bus */
369 + struct regmap *regmap = snd_soc_card_get_drvdata(card);
371 + return regmap_write(regmap, NANO_CFG, NANO_CFG_OFF);
374 +static struct snd_soc_card nano_player_card = {
375 + .name = "3Dlab_Nano_Player",
376 + .owner = THIS_MODULE,
377 + .dai_link = &nano_player_link,
379 + .controls = nano_player_controls,
380 + .num_controls = ARRAY_SIZE(nano_player_controls),
381 + .probe = nano_player_card_probe,
382 + .remove = nano_player_card_remove,
385 +static int nano_player_i2c_probe(struct i2c_client *i2c,
386 + const struct i2c_device_id *id)
388 + struct regmap *regmap;
391 + regmap = devm_regmap_init_i2c(i2c, &nano_player_regmap);
392 + if (IS_ERR(regmap)) {
393 + ret = PTR_ERR(regmap);
394 + dev_err(&i2c->dev, "Failed to init regmap %d\n", ret);
398 + if (i2c->dev.of_node) {
399 + struct snd_soc_dai_link *dai = &nano_player_link;
400 + struct device_node *node;
402 + /* cpu handle configured by device tree */
403 + node = of_parse_phandle(i2c->dev.of_node, "i2s-controller", 0);
405 + dai->platform_name = NULL;
406 + dai->platform_of_node = node;
407 + dai->cpu_dai_name = NULL;
408 + dai->cpu_of_node = node;
412 + nano_player_card.dev = &i2c->dev;
413 + snd_soc_card_set_drvdata(&nano_player_card, regmap);
414 + ret = devm_snd_soc_register_card(&i2c->dev, &nano_player_card);
416 + if (ret && ret != -EPROBE_DEFER)
417 + dev_err(&i2c->dev, "Failed to register card %d\n", ret);
422 +static const struct of_device_id nano_player_of_match[] = {
423 + { .compatible = "3dlab,nano-player", },
426 +MODULE_DEVICE_TABLE(of, nano_player_of_match);
428 +static const struct i2c_device_id nano_player_i2c_id[] = {
429 + { "nano-player", 0 },
432 +MODULE_DEVICE_TABLE(i2c, nano_player_i2c_id);
434 +static struct i2c_driver nano_player_i2c_driver = {
435 + .probe = nano_player_i2c_probe,
436 + .id_table = nano_player_i2c_id,
438 + .name = "nano-player",
439 + .owner = THIS_MODULE,
440 + .of_match_table = nano_player_of_match,
444 +module_i2c_driver(nano_player_i2c_driver);
446 +MODULE_DESCRIPTION("ASoC 3Dlab Nano Player driver");
447 +MODULE_AUTHOR("GT <dev@3d-lab-av.com>");
448 +MODULE_LICENSE("GPL v2");
451 --- a/sound/soc/bcm/Kconfig
452 +++ b/sound/soc/bcm/Kconfig
453 @@ -17,6 +17,12 @@ config SND_SOC_CYGNUS
455 If you don't know what to do here, say N.
457 +config SND_BCM2708_SOC_3DLAB_NANO_PLAYER
458 + tristate "Support for 3Dlab Nano Player"
459 + depends on SND_BCM2708_SOC_I2S || SND_BCM2835_SOC_I2S
461 + Say Y or M if you want to add support for 3Dlab Nano Player.
463 config SND_BCM2708_SOC_GOOGLEVOICEHAT_SOUNDCARD
464 tristate "Support for Google voiceHAT soundcard"
465 depends on SND_BCM2708_SOC_I2S || SND_BCM2835_SOC_I2S
466 --- a/sound/soc/bcm/Makefile
467 +++ b/sound/soc/bcm/Makefile
468 @@ -12,6 +12,7 @@ obj-$(CONFIG_SND_SOC_CYGNUS) += snd-soc-
469 snd-soc-googlevoicehat-codec-objs := googlevoicehat-codec.o
471 # BCM2708 Machine Support
472 +snd-soc-3dlab-nano-player-objs := 3dlab-nano-player.o
473 snd-soc-hifiberry-dacplus-objs := hifiberry_dacplus.o
474 snd-soc-justboom-dac-objs := justboom-dac.o
475 snd-soc-rpi-cirrus-objs := rpi-cirrus.o
476 @@ -31,6 +32,7 @@ snd-soc-fe-pi-audio-objs := fe-pi-audio.
477 snd-soc-rpi-simple-soundcard-objs := rpi-simple-soundcard.o
478 snd-soc-rpi-wm8804-soundcard-objs := rpi-wm8804-soundcard.o
480 +obj-$(CONFIG_SND_BCM2708_SOC_3DLAB_NANO_PLAYER) += snd-soc-3dlab-nano-player.o
481 obj-$(CONFIG_SND_BCM2708_SOC_GOOGLEVOICEHAT_SOUNDCARD) += snd-soc-googlevoicehat-codec.o
482 obj-$(CONFIG_SND_BCM2708_SOC_HIFIBERRY_DACPLUS) += snd-soc-hifiberry-dacplus.o
483 obj-$(CONFIG_SND_BCM2708_SOC_JUSTBOOM_DAC) += snd-soc-justboom-dac.o