blob: ac1bec3b2248ce9d7f98db08fe3cf3a53241ef3e [file] [log] [blame]
Mark Brown2159ad932012-10-11 11:54:02 +09001/*
2 * wm_adsp.h -- Wolfson ADSP support
3 *
4 * Copyright 2012 Wolfson Microelectronics plc
5 *
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef __WM_ADSP_H
14#define __WM_ADSP_H
15
16#include <sound/soc.h>
17#include <sound/soc-dapm.h>
Charles Keepax406abc92015-12-15 11:29:45 +000018#include <sound/compress_driver.h>
Mark Brown2159ad932012-10-11 11:54:02 +090019
20#include "wmfw.h"
21
Charles Keepax20b7f7c2016-05-13 16:45:17 +010022/* Return values for wm_adsp_compr_handle_irq */
23#define WM_ADSP_COMPR_OK 0
24#define WM_ADSP_COMPR_VOICE_TRIGGER 1
25
Mayuresh Kulkarni51a2c942017-04-05 11:08:00 +010026#define WM_ADSP2_REGION_0 BIT(0)
27#define WM_ADSP2_REGION_1 BIT(1)
28#define WM_ADSP2_REGION_2 BIT(2)
29#define WM_ADSP2_REGION_3 BIT(3)
30#define WM_ADSP2_REGION_4 BIT(4)
31#define WM_ADSP2_REGION_5 BIT(5)
32#define WM_ADSP2_REGION_6 BIT(6)
33#define WM_ADSP2_REGION_7 BIT(7)
34#define WM_ADSP2_REGION_8 BIT(8)
35#define WM_ADSP2_REGION_9 BIT(9)
36#define WM_ADSP2_REGION_1_9 (WM_ADSP2_REGION_1 | \
37 WM_ADSP2_REGION_2 | WM_ADSP2_REGION_3 | \
38 WM_ADSP2_REGION_4 | WM_ADSP2_REGION_5 | \
39 WM_ADSP2_REGION_6 | WM_ADSP2_REGION_7 | \
40 WM_ADSP2_REGION_8 | WM_ADSP2_REGION_9)
41#define WM_ADSP2_REGION_ALL (WM_ADSP2_REGION_0 | WM_ADSP2_REGION_1_9)
42
Mark Brown2159ad932012-10-11 11:54:02 +090043struct wm_adsp_region {
44 int type;
45 unsigned int base;
46};
47
Mark Brown471f4882013-01-08 16:09:31 +000048struct wm_adsp_alg_region {
49 struct list_head list;
50 unsigned int alg;
51 int type;
52 unsigned int base;
53};
54
Charles Keepax406abc92015-12-15 11:29:45 +000055struct wm_adsp_compr;
Charles Keepax2cd19bd2015-12-15 11:29:46 +000056struct wm_adsp_compr_buf;
Charles Keepax406abc92015-12-15 11:29:45 +000057
Mark Brown2159ad932012-10-11 11:54:02 +090058struct wm_adsp {
59 const char *part;
Richard Fitzgerald605391d2018-08-08 17:13:39 +010060 const char *name;
61 const char *fwf_name;
Richard Fitzgeralde1ea1872017-04-05 11:07:59 +010062 int rev;
Mark Brown2159ad932012-10-11 11:54:02 +090063 int num;
64 int type;
65 struct device *dev;
66 struct regmap *regmap;
Kuninori Morimoto0fe1daa2018-02-13 02:03:12 +000067 struct snd_soc_component *component;
Mark Brown2159ad932012-10-11 11:54:02 +090068
Richard Fitzgeralde21a5ac2018-02-16 14:36:10 +000069 unsigned int base;
70 unsigned int sysclk_reg;
71 unsigned int sysclk_mask;
72 unsigned int sysclk_shift;
Mark Brown2159ad932012-10-11 11:54:02 +090073
Mark Brown471f4882013-01-08 16:09:31 +000074 struct list_head alg_regions;
75
Charles Keepax7585a5b2015-12-08 16:08:25 +000076 unsigned int fw_id;
77 unsigned int fw_id_version;
Mark Brownf395a212013-03-05 22:39:54 +080078
Mark Brown2159ad932012-10-11 11:54:02 +090079 const struct wm_adsp_region *mem;
80 int num_mems;
Mark Brown973838a2012-11-28 17:20:32 +000081
Mark Brown1023dbd2013-01-11 22:58:28 +000082 int fw;
Charles Keepax23237362015-04-13 13:28:02 +010083 int fw_ver;
Charles Keepax28823eb2016-09-20 13:52:32 +010084
Charles Keepaxaf813a62017-01-06 14:24:41 +000085 bool preloaded;
Charles Keepax28823eb2016-09-20 13:52:32 +010086 bool booted;
Viresh Kumar621a5f72015-09-26 15:04:07 -070087 bool running;
Charles Keepaxa2bcbc12019-03-19 11:52:07 +000088 bool fatal_error;
Mark Brown1023dbd2013-01-11 22:58:28 +000089
Dimitris Papastamos81ad93e2013-07-29 13:51:59 +010090 struct list_head ctl_list;
Charles Keepaxd8a64d62014-01-08 17:42:18 +000091
92 struct work_struct boot_work;
Richard Fitzgeraldf9f55e32015-06-11 11:32:32 +010093
Stuart Henderson4f2d4ea2019-02-22 10:04:20 +000094 struct list_head compr_list;
95 struct list_head buffer_list;
Charles Keepax406abc92015-12-15 11:29:45 +000096
Charles Keepax078e7182015-12-08 16:08:26 +000097 struct mutex pwr_lock;
98
Mayuresh Kulkarni51a2c942017-04-05 11:08:00 +010099 unsigned int lock_regions;
100
Richard Fitzgeraldf9f55e32015-06-11 11:32:32 +0100101#ifdef CONFIG_DEBUG_FS
102 struct dentry *debugfs_root;
Richard Fitzgeraldf9f55e32015-06-11 11:32:32 +0100103 char *wmfw_file_name;
104 char *bin_file_name;
105#endif
106
Mark Brown2159ad932012-10-11 11:54:02 +0900107};
108
109#define WM_ADSP1(wname, num) \
Lars-Peter Clausenf9eeae92013-06-19 19:34:02 +0200110 SND_SOC_DAPM_PGA_E(wname, SND_SOC_NOPM, num, 0, NULL, 0, \
111 wm_adsp1_event, SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD)
Mark Brown2159ad932012-10-11 11:54:02 +0900112
Charles Keepaxaf813a62017-01-06 14:24:41 +0000113#define WM_ADSP2_PRELOAD_SWITCH(wname, num) \
114 SOC_SINGLE_EXT(wname " Preload Switch", SND_SOC_NOPM, num, 1, 0, \
115 wm_adsp2_preloader_get, wm_adsp2_preloader_put)
116
Charles Keepaxd82d7672016-01-21 17:53:02 +0000117#define WM_ADSP2(wname, num, event_fn) \
Charles Keepaxaf813a62017-01-06 14:24:41 +0000118 SND_SOC_DAPM_SPK(wname " Preload", NULL), \
Charles Keepax5ca7e172016-09-20 13:52:31 +0100119{ .id = snd_soc_dapm_supply, .name = wname " Preloader", \
Richard Fitzgerald81ac58b2015-06-02 11:53:34 +0100120 .reg = SND_SOC_NOPM, .shift = num, .event = event_fn, \
Charles Keepax57a60cc2016-09-26 10:15:24 +0100121 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD, \
Charles Keepax5ca7e172016-09-20 13:52:31 +0100122 .subseq = 100, /* Ensure we run after SYSCLK supply widget */ }, \
Charles Keepax12db5ed2014-01-08 17:42:19 +0000123{ .id = snd_soc_dapm_out_drv, .name = wname, \
124 .reg = SND_SOC_NOPM, .shift = num, .event = wm_adsp2_event, \
125 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD }
Mark Brown2159ad932012-10-11 11:54:02 +0900126
Richard Fitzgerald0a047f02018-08-08 17:13:38 +0100127#define WM_ADSP_FW_CONTROL(dspname, num) \
128 SOC_ENUM_EXT(dspname " Firmware", wm_adsp_fw_enum[num], \
129 wm_adsp_fw_get, wm_adsp_fw_put)
130
131extern const struct soc_enum wm_adsp_fw_enum[];
Mark Brown1023dbd2013-01-11 22:58:28 +0000132
Charles Keepax3809f002015-04-13 13:27:54 +0100133int wm_adsp1_init(struct wm_adsp *dsp);
Richard Fitzgerald81ac58b2015-06-02 11:53:34 +0100134int wm_adsp2_init(struct wm_adsp *dsp);
Richard Fitzgerald66225e92016-04-27 14:58:27 +0100135void wm_adsp2_remove(struct wm_adsp *dsp);
Kuninori Morimoto0fe1daa2018-02-13 02:03:12 +0000136int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component);
137int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component);
Mark Brown2159ad932012-10-11 11:54:02 +0900138int wm_adsp1_event(struct snd_soc_dapm_widget *w,
139 struct snd_kcontrol *kcontrol, int event);
Richard Fitzgeraldb9070df2019-03-19 11:52:09 +0000140
Charles Keepax12db5ed2014-01-08 17:42:19 +0000141int wm_adsp2_early_event(struct snd_soc_dapm_widget *w,
Richard Fitzgeraldb9070df2019-03-19 11:52:09 +0000142 struct snd_kcontrol *kcontrol, int event);
Mayuresh Kulkarni51a2c942017-04-05 11:08:00 +0100143
Mayuresh Kulkarni51a2c942017-04-05 11:08:00 +0100144irqreturn_t wm_adsp2_bus_error(struct wm_adsp *adsp);
145
Mark Brown2159ad932012-10-11 11:54:02 +0900146int wm_adsp2_event(struct snd_soc_dapm_widget *w,
147 struct snd_kcontrol *kcontrol, int event);
148
Richard Fitzgeraldb9070df2019-03-19 11:52:09 +0000149int wm_adsp2_set_dspclk(struct snd_soc_dapm_widget *w, unsigned int freq);
150
Charles Keepaxaf813a62017-01-06 14:24:41 +0000151int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
152 struct snd_ctl_elem_value *ucontrol);
153int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
154 struct snd_ctl_elem_value *ucontrol);
Richard Fitzgerald0a047f02018-08-08 17:13:38 +0100155int wm_adsp_fw_get(struct snd_kcontrol *kcontrol,
156 struct snd_ctl_elem_value *ucontrol);
157int wm_adsp_fw_put(struct snd_kcontrol *kcontrol,
158 struct snd_ctl_elem_value *ucontrol);
Charles Keepaxaf813a62017-01-06 14:24:41 +0000159
Charles Keepax63079b62016-11-29 10:46:21 +0000160int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream);
161int wm_adsp_compr_free(struct snd_compr_stream *stream);
162int wm_adsp_compr_set_params(struct snd_compr_stream *stream,
163 struct snd_compr_params *params);
164int wm_adsp_compr_get_caps(struct snd_compr_stream *stream,
165 struct snd_compr_caps *caps);
166int wm_adsp_compr_trigger(struct snd_compr_stream *stream, int cmd);
167int wm_adsp_compr_handle_irq(struct wm_adsp *dsp);
168int wm_adsp_compr_pointer(struct snd_compr_stream *stream,
169 struct snd_compr_tstamp *tstamp);
170int wm_adsp_compr_copy(struct snd_compr_stream *stream,
171 char __user *buf, size_t count);
Charles Keepax406abc92015-12-15 11:29:45 +0000172
Mark Brown2159ad932012-10-11 11:54:02 +0900173#endif