xref: /openbmc/linux/sound/soc/codecs/wm_adsp.h (revision 5ace6934)
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 struct wm_adsp_region {
27 	int type;
28 	unsigned int base;
29 };
30 
31 struct wm_adsp_alg_region {
32 	struct list_head list;
33 	unsigned int alg;
34 	int type;
35 	unsigned int base;
36 };
37 
38 struct wm_adsp_compr;
39 struct wm_adsp_compr_buf;
40 
41 struct wm_adsp {
42 	const char *part;
43 	int num;
44 	int type;
45 	struct device *dev;
46 	struct regmap *regmap;
47 	struct snd_soc_codec *codec;
48 
49 	int base;
50 	int sysclk_reg;
51 	int sysclk_mask;
52 	int sysclk_shift;
53 
54 	struct list_head alg_regions;
55 
56 	unsigned int fw_id;
57 	unsigned int fw_id_version;
58 
59 	const struct wm_adsp_region *mem;
60 	int num_mems;
61 
62 	int fw;
63 	int fw_ver;
64 
65 	bool preloaded;
66 	bool booted;
67 	bool running;
68 
69 	struct list_head ctl_list;
70 
71 	struct work_struct boot_work;
72 
73 	struct wm_adsp_compr *compr;
74 	struct wm_adsp_compr_buf *buffer;
75 
76 	struct mutex pwr_lock;
77 
78 #ifdef CONFIG_DEBUG_FS
79 	struct dentry *debugfs_root;
80 	char *wmfw_file_name;
81 	char *bin_file_name;
82 #endif
83 
84 };
85 
86 #define WM_ADSP1(wname, num) \
87 	SND_SOC_DAPM_PGA_E(wname, SND_SOC_NOPM, num, 0, NULL, 0, \
88 		wm_adsp1_event, SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD)
89 
90 #define WM_ADSP2_PRELOAD_SWITCH(wname, num) \
91 	SOC_SINGLE_EXT(wname " Preload Switch", SND_SOC_NOPM, num, 1, 0, \
92 		wm_adsp2_preloader_get, wm_adsp2_preloader_put)
93 
94 #define WM_ADSP2(wname, num, event_fn) \
95 	SND_SOC_DAPM_SPK(wname " Preload", NULL), \
96 {	.id = snd_soc_dapm_supply, .name = wname " Preloader", \
97 	.reg = SND_SOC_NOPM, .shift = num, .event = event_fn, \
98 	.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD, \
99 	.subseq = 100, /* Ensure we run after SYSCLK supply widget */ }, \
100 {	.id = snd_soc_dapm_out_drv, .name = wname, \
101 	.reg = SND_SOC_NOPM, .shift = num, .event = wm_adsp2_event, \
102 	.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD }
103 
104 extern const struct snd_kcontrol_new wm_adsp_fw_controls[];
105 
106 int wm_adsp1_init(struct wm_adsp *dsp);
107 int wm_adsp2_init(struct wm_adsp *dsp);
108 void wm_adsp2_remove(struct wm_adsp *dsp);
109 int wm_adsp2_codec_probe(struct wm_adsp *dsp, struct snd_soc_codec *codec);
110 int wm_adsp2_codec_remove(struct wm_adsp *dsp, struct snd_soc_codec *codec);
111 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
112 		   struct snd_kcontrol *kcontrol, int event);
113 int wm_adsp2_early_event(struct snd_soc_dapm_widget *w,
114 			 struct snd_kcontrol *kcontrol, int event,
115 			 unsigned int freq);
116 int wm_adsp2_event(struct snd_soc_dapm_widget *w,
117 		   struct snd_kcontrol *kcontrol, int event);
118 
119 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
120 			   struct snd_ctl_elem_value *ucontrol);
121 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
122 			   struct snd_ctl_elem_value *ucontrol);
123 
124 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream);
125 int wm_adsp_compr_free(struct snd_compr_stream *stream);
126 int wm_adsp_compr_set_params(struct snd_compr_stream *stream,
127 			     struct snd_compr_params *params);
128 int wm_adsp_compr_get_caps(struct snd_compr_stream *stream,
129 			   struct snd_compr_caps *caps);
130 int wm_adsp_compr_trigger(struct snd_compr_stream *stream, int cmd);
131 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp);
132 int wm_adsp_compr_pointer(struct snd_compr_stream *stream,
133 			  struct snd_compr_tstamp *tstamp);
134 int wm_adsp_compr_copy(struct snd_compr_stream *stream,
135 		       char __user *buf, size_t count);
136 
137 #endif
138