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 #define WM_ADSP2_REGION_0 BIT(0) 27 #define WM_ADSP2_REGION_1 BIT(1) 28 #define WM_ADSP2_REGION_2 BIT(2) 29 #define WM_ADSP2_REGION_3 BIT(3) 30 #define WM_ADSP2_REGION_4 BIT(4) 31 #define WM_ADSP2_REGION_5 BIT(5) 32 #define WM_ADSP2_REGION_6 BIT(6) 33 #define WM_ADSP2_REGION_7 BIT(7) 34 #define WM_ADSP2_REGION_8 BIT(8) 35 #define WM_ADSP2_REGION_9 BIT(9) 36 #define WM_ADSP2_REGION_1_9 (WM_ADSP2_REGION_1 | \ 37 WM_ADSP2_REGION_2 | WM_ADSP2_REGION_3 | \ 38 WM_ADSP2_REGION_4 | WM_ADSP2_REGION_5 | \ 39 WM_ADSP2_REGION_6 | WM_ADSP2_REGION_7 | \ 40 WM_ADSP2_REGION_8 | WM_ADSP2_REGION_9) 41 #define WM_ADSP2_REGION_ALL (WM_ADSP2_REGION_0 | WM_ADSP2_REGION_1_9) 42 43 struct wm_adsp_region { 44 int type; 45 unsigned int base; 46 }; 47 48 struct wm_adsp_alg_region { 49 struct list_head list; 50 unsigned int alg; 51 int type; 52 unsigned int base; 53 }; 54 55 struct wm_adsp_compr; 56 struct wm_adsp_compr_buf; 57 struct wm_adsp_ops; 58 59 struct wm_adsp { 60 const char *part; 61 const char *name; 62 const char *fwf_name; 63 int rev; 64 int num; 65 int type; 66 struct device *dev; 67 struct regmap *regmap; 68 struct snd_soc_component *component; 69 70 struct wm_adsp_ops *ops; 71 72 unsigned int base; 73 unsigned int base_sysinfo; 74 unsigned int sysclk_reg; 75 unsigned int sysclk_mask; 76 unsigned int sysclk_shift; 77 78 struct list_head alg_regions; 79 80 unsigned int fw_id; 81 unsigned int fw_id_version; 82 unsigned int fw_vendor_id; 83 84 const struct wm_adsp_region *mem; 85 int num_mems; 86 87 int fw; 88 int fw_ver; 89 90 bool preloaded; 91 bool booted; 92 bool running; 93 bool fatal_error; 94 95 struct list_head ctl_list; 96 97 struct work_struct boot_work; 98 99 struct list_head compr_list; 100 struct list_head buffer_list; 101 102 struct mutex pwr_lock; 103 104 unsigned int lock_regions; 105 106 #ifdef CONFIG_DEBUG_FS 107 struct dentry *debugfs_root; 108 char *wmfw_file_name; 109 char *bin_file_name; 110 #endif 111 112 }; 113 114 struct wm_adsp_ops { 115 unsigned int sys_config_size; 116 117 bool (*validate_version)(struct wm_adsp *dsp, unsigned int version); 118 unsigned int (*parse_sizes)(struct wm_adsp *dsp, 119 const char * const file, 120 unsigned int pos, 121 const struct firmware *firmware); 122 int (*setup_algs)(struct wm_adsp *dsp); 123 unsigned int (*region_to_reg)(struct wm_adsp_region const *mem, 124 unsigned int offset); 125 126 void (*show_fw_status)(struct wm_adsp *dsp); 127 void (*stop_watchdog)(struct wm_adsp *dsp); 128 129 int (*enable_memory)(struct wm_adsp *dsp); 130 void (*disable_memory)(struct wm_adsp *dsp); 131 int (*lock_memory)(struct wm_adsp *dsp, unsigned int lock_regions); 132 133 int (*enable_core)(struct wm_adsp *dsp); 134 void (*disable_core)(struct wm_adsp *dsp); 135 136 int (*start_core)(struct wm_adsp *dsp); 137 void (*stop_core)(struct wm_adsp *dsp); 138 }; 139 140 #define WM_ADSP1(wname, num) \ 141 SND_SOC_DAPM_PGA_E(wname, SND_SOC_NOPM, num, 0, NULL, 0, \ 142 wm_adsp1_event, SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD) 143 144 #define WM_ADSP2_PRELOAD_SWITCH(wname, num) \ 145 SOC_SINGLE_EXT(wname " Preload Switch", SND_SOC_NOPM, num, 1, 0, \ 146 wm_adsp2_preloader_get, wm_adsp2_preloader_put) 147 148 #define WM_ADSP2(wname, num, event_fn) \ 149 SND_SOC_DAPM_SPK(wname " Preload", NULL), \ 150 { .id = snd_soc_dapm_supply, .name = wname " Preloader", \ 151 .reg = SND_SOC_NOPM, .shift = num, .event = event_fn, \ 152 .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD, \ 153 .subseq = 100, /* Ensure we run after SYSCLK supply widget */ }, \ 154 { .id = snd_soc_dapm_out_drv, .name = wname, \ 155 .reg = SND_SOC_NOPM, .shift = num, .event = wm_adsp_event, \ 156 .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD } 157 158 #define WM_ADSP_FW_CONTROL(dspname, num) \ 159 SOC_ENUM_EXT(dspname " Firmware", wm_adsp_fw_enum[num], \ 160 wm_adsp_fw_get, wm_adsp_fw_put) 161 162 extern const struct soc_enum wm_adsp_fw_enum[]; 163 164 int wm_adsp1_init(struct wm_adsp *dsp); 165 int wm_adsp2_init(struct wm_adsp *dsp); 166 void wm_adsp2_remove(struct wm_adsp *dsp); 167 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component); 168 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component); 169 int wm_halo_init(struct wm_adsp *dsp); 170 171 int wm_adsp1_event(struct snd_soc_dapm_widget *w, 172 struct snd_kcontrol *kcontrol, int event); 173 174 int wm_adsp_early_event(struct snd_soc_dapm_widget *w, 175 struct snd_kcontrol *kcontrol, int event); 176 177 irqreturn_t wm_adsp2_bus_error(struct wm_adsp *adsp); 178 irqreturn_t wm_halo_bus_error(struct wm_adsp *dsp); 179 irqreturn_t wm_halo_wdt_expire(int irq, void *data); 180 181 int wm_adsp_event(struct snd_soc_dapm_widget *w, 182 struct snd_kcontrol *kcontrol, int event); 183 184 int wm_adsp2_set_dspclk(struct snd_soc_dapm_widget *w, unsigned int freq); 185 186 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol, 187 struct snd_ctl_elem_value *ucontrol); 188 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol, 189 struct snd_ctl_elem_value *ucontrol); 190 int wm_adsp_fw_get(struct snd_kcontrol *kcontrol, 191 struct snd_ctl_elem_value *ucontrol); 192 int wm_adsp_fw_put(struct snd_kcontrol *kcontrol, 193 struct snd_ctl_elem_value *ucontrol); 194 195 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream); 196 int wm_adsp_compr_free(struct snd_compr_stream *stream); 197 int wm_adsp_compr_set_params(struct snd_compr_stream *stream, 198 struct snd_compr_params *params); 199 int wm_adsp_compr_get_caps(struct snd_compr_stream *stream, 200 struct snd_compr_caps *caps); 201 int wm_adsp_compr_trigger(struct snd_compr_stream *stream, int cmd); 202 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp); 203 int wm_adsp_compr_pointer(struct snd_compr_stream *stream, 204 struct snd_compr_tstamp *tstamp); 205 int wm_adsp_compr_copy(struct snd_compr_stream *stream, 206 char __user *buf, size_t count); 207 208 #endif 209