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