GNU Linux-libre 4.9.337-gnu1
[releases.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 struct wm_adsp_region {
27         int type;
28         unsigned int base;
29 };
30
31 struct wm_adsp_alg_region {
32         struct list_head list;
33         unsigned int alg;
34         int type;
35         unsigned int base;
36 };
37
38 struct wm_adsp_compr;
39 struct wm_adsp_compr_buf;
40
41 struct wm_adsp {
42         const char *part;
43         int num;
44         int type;
45         struct device *dev;
46         struct regmap *regmap;
47         struct snd_soc_card *card;
48
49         int base;
50         int sysclk_reg;
51         int sysclk_mask;
52         int sysclk_shift;
53
54         struct list_head alg_regions;
55
56         unsigned int fw_id;
57         unsigned int fw_id_version;
58
59         const struct wm_adsp_region *mem;
60         int num_mems;
61
62         int fw;
63         int fw_ver;
64
65         bool booted;
66         bool running;
67
68         struct list_head ctl_list;
69
70         struct work_struct boot_work;
71
72         struct wm_adsp_compr *compr;
73         struct wm_adsp_compr_buf *buffer;
74
75         struct mutex pwr_lock;
76
77 #ifdef CONFIG_DEBUG_FS
78         struct dentry *debugfs_root;
79         char *wmfw_file_name;
80         char *bin_file_name;
81 #endif
82
83 };
84
85 #define WM_ADSP1(wname, num) \
86         SND_SOC_DAPM_PGA_E(wname, SND_SOC_NOPM, num, 0, NULL, 0, \
87                 wm_adsp1_event, SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD)
88
89 #define WM_ADSP2(wname, num, event_fn) \
90 {       .id = snd_soc_dapm_supply, .name = wname " Preloader", \
91         .reg = SND_SOC_NOPM, .shift = num, .event = event_fn, \
92         .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD, \
93         .subseq = 100, /* Ensure we run after SYSCLK supply widget */ }, \
94 {       .id = snd_soc_dapm_out_drv, .name = wname, \
95         .reg = SND_SOC_NOPM, .shift = num, .event = wm_adsp2_event, \
96         .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD }
97
98 extern const struct snd_kcontrol_new wm_adsp_fw_controls[];
99
100 int wm_adsp1_init(struct wm_adsp *dsp);
101 int wm_adsp2_init(struct wm_adsp *dsp);
102 void wm_adsp2_remove(struct wm_adsp *dsp);
103 int wm_adsp2_codec_probe(struct wm_adsp *dsp, struct snd_soc_codec *codec);
104 int wm_adsp2_codec_remove(struct wm_adsp *dsp, struct snd_soc_codec *codec);
105 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
106                    struct snd_kcontrol *kcontrol, int event);
107 int wm_adsp2_early_event(struct snd_soc_dapm_widget *w,
108                          struct snd_kcontrol *kcontrol, int event,
109                          unsigned int freq);
110 int wm_adsp2_event(struct snd_soc_dapm_widget *w,
111                    struct snd_kcontrol *kcontrol, int event);
112
113 extern int wm_adsp_compr_open(struct wm_adsp *dsp,
114                               struct snd_compr_stream *stream);
115 extern int wm_adsp_compr_free(struct snd_compr_stream *stream);
116 extern int wm_adsp_compr_set_params(struct snd_compr_stream *stream,
117                                     struct snd_compr_params *params);
118 extern int wm_adsp_compr_get_caps(struct snd_compr_stream *stream,
119                                   struct snd_compr_caps *caps);
120 extern int wm_adsp_compr_trigger(struct snd_compr_stream *stream, int cmd);
121 extern int wm_adsp_compr_handle_irq(struct wm_adsp *dsp);
122 extern int wm_adsp_compr_pointer(struct snd_compr_stream *stream,
123                                  struct snd_compr_tstamp *tstamp);
124 extern int wm_adsp_compr_copy(struct snd_compr_stream *stream,
125                               char __user *buf, size_t count);
126
127 #endif