xref: /linux/sound/soc/codecs/wm_adsp.h (revision 07f0148aafe8c95a3a76cd59e9e75b4d78d1d31d)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * wm_adsp.h  --  Wolfson ADSP support
4  *
5  * Copyright 2012 Wolfson Microelectronics plc
6  *
7  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8  */
9 
10 #ifndef __WM_ADSP_H
11 #define __WM_ADSP_H
12 
13 #include <linux/firmware/cirrus/cs_dsp.h>
14 #include <linux/firmware/cirrus/wmfw.h>
15 
16 #include <sound/soc.h>
17 #include <sound/soc-dapm.h>
18 #include <sound/compress_driver.h>
19 
20 /* Return values for wm_adsp_compr_handle_irq */
21 #define WM_ADSP_COMPR_OK                 0
22 #define WM_ADSP_COMPR_VOICE_TRIGGER      1
23 
24 struct wm_adsp_compr;
25 struct wm_adsp_compr_buf;
26 
27 struct wm_adsp {
28 	struct cs_dsp cs_dsp;
29 	const char *part;
30 	const char *fwf_name;
31 	const char *system_name;
32 	struct snd_soc_component *component;
33 
34 	unsigned int sys_config_size;
35 
36 	int fw;
37 
38 	struct work_struct boot_work;
39 	int (*pre_run)(struct wm_adsp *dsp);
40 
41 	bool preloaded;
42 	bool fatal_error;
43 
44 	struct list_head compr_list;
45 	struct list_head buffer_list;
46 
47 	/*
48 	 * Flag indicating the preloader widget only needs power toggled
49 	 * on state change rather than held on for the duration of the
50 	 * preload, useful for devices that can retain firmware memory
51 	 * across power down.
52 	 */
53 	bool toggle_preload;
54 };
55 
56 #define WM_ADSP1(wname, num) \
57 	SND_SOC_DAPM_PGA_E(wname, SND_SOC_NOPM, num, 0, NULL, 0, \
58 		wm_adsp1_event, SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD)
59 
60 #define WM_ADSP2_PRELOAD_SWITCH(wname, num) \
61 	SOC_SINGLE_EXT(wname " Preload Switch", SND_SOC_NOPM, num, 1, 0, \
62 		wm_adsp2_preloader_get, wm_adsp2_preloader_put)
63 
64 #define WM_ADSP2(wname, num, event_fn) \
65 	SND_SOC_DAPM_SPK(wname " Preload", NULL), \
66 {	.id = snd_soc_dapm_supply, .name = wname " Preloader", \
67 	.reg = SND_SOC_NOPM, .shift = num, .event = event_fn, \
68 	.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD, \
69 	.subseq = 100, /* Ensure we run after SYSCLK supply widget */ }, \
70 {	.id = snd_soc_dapm_out_drv, .name = wname, \
71 	.reg = SND_SOC_NOPM, .shift = num, .event = wm_adsp_event, \
72 	.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD }
73 
74 #define WM_ADSP_FW_CONTROL(dspname, num) \
75 	SOC_ENUM_EXT(dspname " Firmware", wm_adsp_fw_enum[num], \
76 		     wm_adsp_fw_get, wm_adsp_fw_put)
77 
78 extern const struct soc_enum wm_adsp_fw_enum[];
79 
80 int wm_adsp1_init(struct wm_adsp *dsp);
81 int wm_adsp2_init(struct wm_adsp *dsp);
82 void wm_adsp2_remove(struct wm_adsp *dsp);
83 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component);
84 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component);
85 int wm_halo_init(struct wm_adsp *dsp);
86 
87 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
88 		   struct snd_kcontrol *kcontrol, int event);
89 
90 int wm_adsp_early_event(struct snd_soc_dapm_widget *w,
91 			struct snd_kcontrol *kcontrol, int event);
92 
93 irqreturn_t wm_adsp2_bus_error(int irq, void *data);
94 irqreturn_t wm_halo_bus_error(int irq, void *data);
95 irqreturn_t wm_halo_wdt_expire(int irq, void *data);
96 
97 int wm_adsp_event(struct snd_soc_dapm_widget *w,
98 		  struct snd_kcontrol *kcontrol, int event);
99 
100 int wm_adsp2_set_dspclk(struct snd_soc_dapm_widget *w, unsigned int freq);
101 
102 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
103 			   struct snd_ctl_elem_value *ucontrol);
104 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
105 			   struct snd_ctl_elem_value *ucontrol);
106 int wm_adsp_fw_get(struct snd_kcontrol *kcontrol,
107 		   struct snd_ctl_elem_value *ucontrol);
108 int wm_adsp_fw_put(struct snd_kcontrol *kcontrol,
109 		   struct snd_ctl_elem_value *ucontrol);
110 
111 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream);
112 int wm_adsp_compr_free(struct snd_soc_component *component,
113 		       struct snd_compr_stream *stream);
114 int wm_adsp_compr_set_params(struct snd_soc_component *component,
115 			     struct snd_compr_stream *stream,
116 			     struct snd_compr_params *params);
117 int wm_adsp_compr_get_caps(struct snd_soc_component *component,
118 			   struct snd_compr_stream *stream,
119 			   struct snd_compr_caps *caps);
120 int wm_adsp_compr_trigger(struct snd_soc_component *component,
121 			  struct snd_compr_stream *stream, int cmd);
122 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp);
123 int wm_adsp_compr_pointer(struct snd_soc_component *component,
124 			  struct snd_compr_stream *stream,
125 			  struct snd_compr_tstamp *tstamp);
126 int wm_adsp_compr_copy(struct snd_soc_component *component,
127 		       struct snd_compr_stream *stream,
128 		       char __user *buf, size_t count);
129 int wm_adsp_write_ctl(struct wm_adsp *dsp, const char *name,  int type,
130 		      unsigned int alg, void *buf, size_t len);
131 int wm_adsp_read_ctl(struct wm_adsp *dsp, const char *name,  int type,
132 		      unsigned int alg, void *buf, size_t len);
133 
134 #endif
135