xref: /linux/sound/soc/codecs/wm_adsp.h (revision 79e03f29fc84db76f78834b1f73ed329b377d753)
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 	struct snd_soc_component *component;
32 
33 	unsigned int sys_config_size;
34 
35 	int fw;
36 
37 	struct work_struct boot_work;
38 
39 	bool preloaded;
40 	bool fatal_error;
41 
42 	struct list_head compr_list;
43 	struct list_head buffer_list;
44 
45 	/*
46 	 * Flag indicating the preloader widget only needs power toggled
47 	 * on state change rather than held on for the duration of the
48 	 * preload, useful for devices that can retain firmware memory
49 	 * across power down.
50 	 */
51 	bool toggle_preload;
52 };
53 
54 #define WM_ADSP1(wname, num) \
55 	SND_SOC_DAPM_PGA_E(wname, SND_SOC_NOPM, num, 0, NULL, 0, \
56 		wm_adsp1_event, SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD)
57 
58 #define WM_ADSP2_PRELOAD_SWITCH(wname, num) \
59 	SOC_SINGLE_EXT(wname " Preload Switch", SND_SOC_NOPM, num, 1, 0, \
60 		wm_adsp2_preloader_get, wm_adsp2_preloader_put)
61 
62 #define WM_ADSP2(wname, num, event_fn) \
63 	SND_SOC_DAPM_SPK(wname " Preload", NULL), \
64 {	.id = snd_soc_dapm_supply, .name = wname " Preloader", \
65 	.reg = SND_SOC_NOPM, .shift = num, .event = event_fn, \
66 	.event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD, \
67 	.subseq = 100, /* Ensure we run after SYSCLK supply widget */ }, \
68 {	.id = snd_soc_dapm_out_drv, .name = wname, \
69 	.reg = SND_SOC_NOPM, .shift = num, .event = wm_adsp_event, \
70 	.event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD }
71 
72 #define WM_ADSP_FW_CONTROL(dspname, num) \
73 	SOC_ENUM_EXT(dspname " Firmware", wm_adsp_fw_enum[num], \
74 		     wm_adsp_fw_get, wm_adsp_fw_put)
75 
76 extern const struct soc_enum wm_adsp_fw_enum[];
77 
78 int wm_adsp1_init(struct wm_adsp *dsp);
79 int wm_adsp2_init(struct wm_adsp *dsp);
80 void wm_adsp2_remove(struct wm_adsp *dsp);
81 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component);
82 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component);
83 int wm_halo_init(struct wm_adsp *dsp);
84 
85 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
86 		   struct snd_kcontrol *kcontrol, int event);
87 
88 int wm_adsp_early_event(struct snd_soc_dapm_widget *w,
89 			struct snd_kcontrol *kcontrol, int event);
90 
91 irqreturn_t wm_adsp2_bus_error(int irq, void *data);
92 irqreturn_t wm_halo_bus_error(int irq, void *data);
93 irqreturn_t wm_halo_wdt_expire(int irq, void *data);
94 
95 int wm_adsp_event(struct snd_soc_dapm_widget *w,
96 		  struct snd_kcontrol *kcontrol, int event);
97 
98 int wm_adsp2_set_dspclk(struct snd_soc_dapm_widget *w, unsigned int freq);
99 
100 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
101 			   struct snd_ctl_elem_value *ucontrol);
102 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
103 			   struct snd_ctl_elem_value *ucontrol);
104 int wm_adsp_fw_get(struct snd_kcontrol *kcontrol,
105 		   struct snd_ctl_elem_value *ucontrol);
106 int wm_adsp_fw_put(struct snd_kcontrol *kcontrol,
107 		   struct snd_ctl_elem_value *ucontrol);
108 
109 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream);
110 int wm_adsp_compr_free(struct snd_soc_component *component,
111 		       struct snd_compr_stream *stream);
112 int wm_adsp_compr_set_params(struct snd_soc_component *component,
113 			     struct snd_compr_stream *stream,
114 			     struct snd_compr_params *params);
115 int wm_adsp_compr_get_caps(struct snd_soc_component *component,
116 			   struct snd_compr_stream *stream,
117 			   struct snd_compr_caps *caps);
118 int wm_adsp_compr_trigger(struct snd_soc_component *component,
119 			  struct snd_compr_stream *stream, int cmd);
120 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp);
121 int wm_adsp_compr_pointer(struct snd_soc_component *component,
122 			  struct snd_compr_stream *stream,
123 			  struct snd_compr_tstamp *tstamp);
124 int wm_adsp_compr_copy(struct snd_soc_component *component,
125 		       struct snd_compr_stream *stream,
126 		       char __user *buf, size_t count);
127 int wm_adsp_write_ctl(struct wm_adsp *dsp, const char *name,  int type,
128 		      unsigned int alg, void *buf, size_t len);
129 int wm_adsp_read_ctl(struct wm_adsp *dsp, const char *name,  int type,
130 		      unsigned int alg, void *buf, size_t len);
131 
132 #endif
133