xref: /linux/sound/soc/codecs/wm_adsp.h (revision 55223394d56bab42ebac71ba52e0fd8bfdc6fc07)
1 /*
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>
18 #include <sound/compress_driver.h>
19 
20 #include "wmfw.h"
21 
22 /* Return values for wm_adsp_compr_handle_irq */
23 #define WM_ADSP_COMPR_OK                 0
24 #define WM_ADSP_COMPR_VOICE_TRIGGER      1
25 
26 #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 
43 struct wm_adsp_region {
44 	int type;
45 	unsigned int base;
46 };
47 
48 struct wm_adsp_alg_region {
49 	struct list_head list;
50 	unsigned int alg;
51 	int type;
52 	unsigned int base;
53 };
54 
55 struct wm_adsp_compr;
56 struct wm_adsp_compr_buf;
57 
58 struct wm_adsp {
59 	const char *part;
60 	const char *name;
61 	const char *fwf_name;
62 	int rev;
63 	int num;
64 	int type;
65 	struct device *dev;
66 	struct regmap *regmap;
67 	struct snd_soc_component *component;
68 
69 	unsigned int base;
70 	unsigned int sysclk_reg;
71 	unsigned int sysclk_mask;
72 	unsigned int sysclk_shift;
73 
74 	struct list_head alg_regions;
75 
76 	unsigned int fw_id;
77 	unsigned int fw_id_version;
78 
79 	const struct wm_adsp_region *mem;
80 	int num_mems;
81 
82 	int fw;
83 	int fw_ver;
84 
85 	bool preloaded;
86 	bool booted;
87 	bool running;
88 	bool fatal_error;
89 
90 	struct list_head ctl_list;
91 
92 	struct work_struct boot_work;
93 
94 	struct list_head compr_list;
95 	struct list_head buffer_list;
96 
97 	struct mutex pwr_lock;
98 
99 	unsigned int lock_regions;
100 
101 #ifdef CONFIG_DEBUG_FS
102 	struct dentry *debugfs_root;
103 	char *wmfw_file_name;
104 	char *bin_file_name;
105 #endif
106 
107 };
108 
109 #define WM_ADSP1(wname, num) \
110 	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)
112 
113 #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 
117 #define WM_ADSP2(wname, num, event_fn) \
118 	SND_SOC_DAPM_SPK(wname " Preload", NULL), \
119 {	.id = snd_soc_dapm_supply, .name = wname " Preloader", \
120 	.reg = SND_SOC_NOPM, .shift = num, .event = event_fn, \
121 	.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD, \
122 	.subseq = 100, /* Ensure we run after SYSCLK supply widget */ }, \
123 {	.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 }
126 
127 #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 
131 extern const struct soc_enum wm_adsp_fw_enum[];
132 
133 int wm_adsp1_init(struct wm_adsp *dsp);
134 int wm_adsp2_init(struct wm_adsp *dsp);
135 void wm_adsp2_remove(struct wm_adsp *dsp);
136 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component);
137 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component);
138 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
139 		   struct snd_kcontrol *kcontrol, int event);
140 int wm_adsp2_early_event(struct snd_soc_dapm_widget *w,
141 			 struct snd_kcontrol *kcontrol, int event,
142 			 unsigned int freq);
143 
144 int wm_adsp2_lock(struct wm_adsp *adsp, unsigned int regions);
145 irqreturn_t wm_adsp2_bus_error(struct wm_adsp *adsp);
146 
147 int wm_adsp2_event(struct snd_soc_dapm_widget *w,
148 		   struct snd_kcontrol *kcontrol, int event);
149 
150 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
151 			   struct snd_ctl_elem_value *ucontrol);
152 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
153 			   struct snd_ctl_elem_value *ucontrol);
154 int wm_adsp_fw_get(struct snd_kcontrol *kcontrol,
155 		   struct snd_ctl_elem_value *ucontrol);
156 int wm_adsp_fw_put(struct snd_kcontrol *kcontrol,
157 		   struct snd_ctl_elem_value *ucontrol);
158 
159 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream);
160 int wm_adsp_compr_free(struct snd_compr_stream *stream);
161 int wm_adsp_compr_set_params(struct snd_compr_stream *stream,
162 			     struct snd_compr_params *params);
163 int wm_adsp_compr_get_caps(struct snd_compr_stream *stream,
164 			   struct snd_compr_caps *caps);
165 int wm_adsp_compr_trigger(struct snd_compr_stream *stream, int cmd);
166 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp);
167 int wm_adsp_compr_pointer(struct snd_compr_stream *stream,
168 			  struct snd_compr_tstamp *tstamp);
169 int wm_adsp_compr_copy(struct snd_compr_stream *stream,
170 		       char __user *buf, size_t count);
171 
172 #endif
173