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