[alsa-devel] [PATCH] ASoC: rt5514: expose Hotword Model control

[Hsin-yu Chao]

Please ignore this commit. I create this as a re-land of an earlier
commit which got reverted on linux-next.
And Oder pointed out doing this is incorrect because I need to create
commit applying to Mark's branch.

Sorry for the confusion.

Hsin-yu

On Mon, Aug 28, 2017 at 2:36 PM, Hsin-Yu Chao <hychao at chromium.org> wrote:
> This change exposes mixer control 'Hotword Model' for switching
> hotword model in runtime. This new function requires updated
> firmware to load hotword model at address 0x4ff80000.
>
> Note that if the rt5514-spi driver is not enabled in kernel, hotword
> model will not be loaded when "DSP Voice Wake Up" is set to turn on
> DSP mode, and an error is logged instead.
>
> Signed-off-by: Hsin-Yu Chao <hychao at chromium.org>
> ---
>  sound/soc/codecs/rt5514.c | 63 +++++++++++++++++++++++++++++++++++++++++++++++
>  sound/soc/codecs/rt5514.h |  3 +++
>  2 files changed, 66 insertions(+)
>
> diff --git a/sound/soc/codecs/rt5514.c b/sound/soc/codecs/rt5514.c
> index a2722177470e..250581082e9d 100644
> --- a/sound/soc/codecs/rt5514.c
> +++ b/sound/soc/codecs/rt5514.c
> @@ -335,6 +335,39 @@ static int rt5514_dsp_voice_wake_up_put(struct snd_kcontrol *kcontrol,
>                                 fw = NULL;
>                         }
>
> +                       if (rt5514->model_buf && rt5514->model_len) {
> +#if IS_ENABLED(CONFIG_SND_SOC_RT5514_SPI)
> +                               int ret;
> +
> +                               ret = rt5514_spi_burst_write(0x4ff80000,
> +                                       rt5514->model_buf,
> +                                       ((rt5514->model_len / 8) + 1) * 8);
> +                               if (ret) {
> +                                       dev_err(codec->dev,
> +                                               "Model load failed %d\n", ret);
> +                                       return ret;
> +                               }
> +#else
> +                               dev_err(codec->dev,
> +                                       "No SPI driver for loading firmware\n");
> +#endif
> +                       } else {
> +                               request_firmware(&fw, RT5514_FIRMWARE3,
> +                                                codec->dev);
> +                               if (fw) {
> +#if IS_ENABLED(CONFIG_SND_SOC_RT5514_SPI)
> +                                       rt5514_spi_burst_write(0x4ff80000,
> +                                               fw->data,
> +                                               ((fw->size/8)+1)*8);
> +#else
> +                                       dev_err(codec->dev,
> +                                               "No SPI driver to load fw\n");
> +#endif
> +                                       release_firmware(fw);
> +                                       fw = NULL;
> +                               }
> +                       }
> +
>                         /* DSP run */
>                         regmap_write(rt5514->i2c_regmap, 0x18002f00,
>                                 0x00055148);
> @@ -349,6 +382,34 @@ static int rt5514_dsp_voice_wake_up_put(struct snd_kcontrol *kcontrol,
>         return 0;
>  }
>
> +static int rt5514_hotword_model_put(struct snd_kcontrol *kcontrol,
> +               const unsigned int __user *bytes, unsigned int size)
> +{
> +       struct snd_soc_component *component = snd_kcontrol_chip(kcontrol);
> +       struct rt5514_priv *rt5514 = snd_soc_component_get_drvdata(component);
> +       struct snd_soc_codec *codec = rt5514->codec;
> +       int ret = 0;
> +
> +       if (rt5514->model_buf || rt5514->model_len < size) {
> +               if (rt5514->model_buf)
> +                       devm_kfree(codec->dev, rt5514->model_buf);
> +               rt5514->model_buf = devm_kmalloc(codec->dev, size, GFP_KERNEL);
> +               if (!rt5514->model_buf) {
> +                       ret = -ENOMEM;
> +                       goto done;
> +               }
> +       }
> +
> +       /* Skips the TLV header. */
> +       bytes += 2;
> +
> +       if (copy_from_user(rt5514->model_buf, bytes, size))
> +               ret = -EFAULT;
> +done:
> +       rt5514->model_len = (ret ? 0 : size);
> +       return ret;
> +}
> +
>  static const struct snd_kcontrol_new rt5514_snd_controls[] = {
>         SOC_DOUBLE_TLV("MIC Boost Volume", RT5514_ANA_CTRL_MICBST,
>                 RT5514_SEL_BSTL_SFT, RT5514_SEL_BSTR_SFT, 8, 0, bst_tlv),
> @@ -360,6 +421,8 @@ static const struct snd_kcontrol_new rt5514_snd_controls[] = {
>                 adc_vol_tlv),
>         SOC_SINGLE_EXT("DSP Voice Wake Up", SND_SOC_NOPM, 0, 1, 0,
>                 rt5514_dsp_voice_wake_up_get, rt5514_dsp_voice_wake_up_put),
> +       SND_SOC_BYTES_TLV("Hotword Model", 0x8504,
> +               NULL, rt5514_hotword_model_put),
>  };
>
>  /* ADC Mixer*/
> diff --git a/sound/soc/codecs/rt5514.h b/sound/soc/codecs/rt5514.h
> index 02bc212a86d9..07475a9918d2 100644
> --- a/sound/soc/codecs/rt5514.h
> +++ b/sound/soc/codecs/rt5514.h
> @@ -236,6 +236,7 @@
>
>  #define RT5514_FIRMWARE1       "rt5514_dsp_fw1.bin"
>  #define RT5514_FIRMWARE2       "rt5514_dsp_fw2.bin"
> +#define RT5514_FIRMWARE3       "rt5514_dsp_fw3.bin"
>
>  /* System Clock Source */
>  enum {
> @@ -262,6 +263,8 @@ struct rt5514_priv {
>         int pll_in;
>         int pll_out;
>         int dsp_enabled;
> +       u8 *model_buf;
> +       unsigned int model_len;
>  };
>
>  #endif /* __RT5514_H__ */
> --
> 2.12.2
>