bc6d359f05338428fc60fe8bdbaa917f0da200f9
[muen/linux.git] / sound / soc / codecs / wm_adsp.h
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
58 struct wm_adsp {
59         const char *part;
60         int rev;
61         int num;
62         int type;
63         struct device *dev;
64         struct regmap *regmap;
65         struct snd_soc_component *component;
66
67         unsigned int base;
68         unsigned int sysclk_reg;
69         unsigned int sysclk_mask;
70         unsigned int sysclk_shift;
71
72         struct list_head alg_regions;
73
74         unsigned int fw_id;
75         unsigned int fw_id_version;
76
77         const struct wm_adsp_region *mem;
78         int num_mems;
79
80         int fw;
81         int fw_ver;
82
83         bool preloaded;
84         bool booted;
85         bool running;
86
87         struct list_head ctl_list;
88
89         struct work_struct boot_work;
90
91         struct wm_adsp_compr *compr;
92         struct wm_adsp_compr_buf *buffer;
93
94         struct mutex pwr_lock;
95
96         unsigned int lock_regions;
97
98 #ifdef CONFIG_DEBUG_FS
99         struct dentry *debugfs_root;
100         char *wmfw_file_name;
101         char *bin_file_name;
102 #endif
103
104 };
105
106 #define WM_ADSP1(wname, num) \
107         SND_SOC_DAPM_PGA_E(wname, SND_SOC_NOPM, num, 0, NULL, 0, \
108                 wm_adsp1_event, SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD)
109
110 #define WM_ADSP2_PRELOAD_SWITCH(wname, num) \
111         SOC_SINGLE_EXT(wname " Preload Switch", SND_SOC_NOPM, num, 1, 0, \
112                 wm_adsp2_preloader_get, wm_adsp2_preloader_put)
113
114 #define WM_ADSP2(wname, num, event_fn) \
115         SND_SOC_DAPM_SPK(wname " Preload", NULL), \
116 {       .id = snd_soc_dapm_supply, .name = wname " Preloader", \
117         .reg = SND_SOC_NOPM, .shift = num, .event = event_fn, \
118         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD, \
119         .subseq = 100, /* Ensure we run after SYSCLK supply widget */ }, \
120 {       .id = snd_soc_dapm_out_drv, .name = wname, \
121         .reg = SND_SOC_NOPM, .shift = num, .event = wm_adsp2_event, \
122         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD }
123
124 extern const struct snd_kcontrol_new wm_adsp_fw_controls[];
125
126 int wm_adsp1_init(struct wm_adsp *dsp);
127 int wm_adsp2_init(struct wm_adsp *dsp);
128 void wm_adsp2_remove(struct wm_adsp *dsp);
129 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component);
130 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component);
131 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
132                    struct snd_kcontrol *kcontrol, int event);
133 int wm_adsp2_early_event(struct snd_soc_dapm_widget *w,
134                          struct snd_kcontrol *kcontrol, int event,
135                          unsigned int freq);
136
137 int wm_adsp2_lock(struct wm_adsp *adsp, unsigned int regions);
138 irqreturn_t wm_adsp2_bus_error(struct wm_adsp *adsp);
139
140 int wm_adsp2_event(struct snd_soc_dapm_widget *w,
141                    struct snd_kcontrol *kcontrol, int event);
142
143 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
144                            struct snd_ctl_elem_value *ucontrol);
145 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
146                            struct snd_ctl_elem_value *ucontrol);
147
148 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream);
149 int wm_adsp_compr_free(struct snd_compr_stream *stream);
150 int wm_adsp_compr_set_params(struct snd_compr_stream *stream,
151                              struct snd_compr_params *params);
152 int wm_adsp_compr_get_caps(struct snd_compr_stream *stream,
153                            struct snd_compr_caps *caps);
154 int wm_adsp_compr_trigger(struct snd_compr_stream *stream, int cmd);
155 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp);
156 int wm_adsp_compr_pointer(struct snd_compr_stream *stream,
157                           struct snd_compr_tstamp *tstamp);
158 int wm_adsp_compr_copy(struct snd_compr_stream *stream,
159                        char __user *buf, size_t count);
160
161 #endif