xref: /openbmc/linux/sound/soc/codecs/wm8994.h (revision 81d67439)
1 /*
2  * wm8994.h  --  WM8994 Soc Audio driver
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  */
8 
9 #ifndef _WM8994_H
10 #define _WM8994_H
11 
12 #include <sound/soc.h>
13 #include <linux/firmware.h>
14 #include <linux/completion.h>
15 
16 #include "wm_hubs.h"
17 
18 /* Sources for AIF1/2 SYSCLK - use with set_dai_sysclk() */
19 #define WM8994_SYSCLK_MCLK1 1
20 #define WM8994_SYSCLK_MCLK2 2
21 #define WM8994_SYSCLK_FLL1  3
22 #define WM8994_SYSCLK_FLL2  4
23 
24 /* OPCLK is also configured with set_dai_sysclk, specify division*10 as rate. */
25 #define WM8994_SYSCLK_OPCLK 5
26 
27 #define WM8994_FLL1 1
28 #define WM8994_FLL2 2
29 
30 #define WM8994_FLL_SRC_MCLK1  1
31 #define WM8994_FLL_SRC_MCLK2  2
32 #define WM8994_FLL_SRC_LRCLK  3
33 #define WM8994_FLL_SRC_BCLK   4
34 
35 typedef void (*wm8958_micdet_cb)(u16 status, void *data);
36 
37 int wm8994_mic_detect(struct snd_soc_codec *codec, struct snd_soc_jack *jack,
38 		      int micbias, int det, int shrt);
39 int wm8958_mic_detect(struct snd_soc_codec *codec, struct snd_soc_jack *jack,
40 		      wm8958_micdet_cb cb, void *cb_data);
41 
42 #define WM8994_CACHE_SIZE 1570
43 
44 struct wm8994_access_mask {
45 	unsigned short readable;   /* Mask of readable bits */
46 	unsigned short writable;   /* Mask of writable bits */
47 };
48 
49 extern const struct wm8994_access_mask wm8994_access_masks[WM8994_CACHE_SIZE];
50 extern const u16 wm8994_reg_defaults[WM8994_CACHE_SIZE];
51 
52 int wm8958_aif_ev(struct snd_soc_dapm_widget *w,
53 		  struct snd_kcontrol *kcontrol, int event);
54 
55 void wm8958_dsp2_init(struct snd_soc_codec *codec);
56 
57 struct wm8994_micdet {
58 	struct snd_soc_jack *jack;
59 	int det;
60 	int shrt;
61 };
62 
63 /* codec private data */
64 struct wm8994_fll_config {
65 	int src;
66 	int in;
67 	int out;
68 };
69 
70 #define WM8994_NUM_DRC 3
71 #define WM8994_NUM_EQ  3
72 
73 struct wm8994_priv {
74 	struct wm_hubs_data hubs;
75 	enum snd_soc_control_type control_type;
76 	void *control_data;
77 	struct snd_soc_codec *codec;
78 	int sysclk[2];
79 	int sysclk_rate[2];
80 	int mclk[2];
81 	int aifclk[2];
82 	struct wm8994_fll_config fll[2], fll_suspend[2];
83 	struct completion fll_locked[2];
84 	bool fll_locked_irq;
85 
86 	int dac_rates[2];
87 	int lrclk_shared[2];
88 
89 	int mbc_ena[3];
90 	int hpf1_ena[3];
91 	int hpf2_ena[3];
92 	int vss_ena[3];
93 	int enh_eq_ena[3];
94 
95 	/* Platform dependant DRC configuration */
96 	const char **drc_texts;
97 	int drc_cfg[WM8994_NUM_DRC];
98 	struct soc_enum drc_enum;
99 
100 	/* Platform dependant ReTune mobile configuration */
101 	int num_retune_mobile_texts;
102 	const char **retune_mobile_texts;
103 	int retune_mobile_cfg[WM8994_NUM_EQ];
104 	struct soc_enum retune_mobile_enum;
105 
106 	/* Platform dependant MBC configuration */
107 	int mbc_cfg;
108 	const char **mbc_texts;
109 	struct soc_enum mbc_enum;
110 
111 	/* Platform dependant VSS configuration */
112 	int vss_cfg;
113 	const char **vss_texts;
114 	struct soc_enum vss_enum;
115 
116 	/* Platform dependant VSS HPF configuration */
117 	int vss_hpf_cfg;
118 	const char **vss_hpf_texts;
119 	struct soc_enum vss_hpf_enum;
120 
121 	/* Platform dependant enhanced EQ configuration */
122 	int enh_eq_cfg;
123 	const char **enh_eq_texts;
124 	struct soc_enum enh_eq_enum;
125 
126 	struct wm8994_micdet micdet[2];
127 
128 	wm8958_micdet_cb jack_cb;
129 	void *jack_cb_data;
130 	int micdet_irq;
131 
132 	int revision;
133 	struct wm8994_pdata *pdata;
134 
135 	unsigned int aif1clk_enable:1;
136 	unsigned int aif2clk_enable:1;
137 
138 	unsigned int aif1clk_disable:1;
139 	unsigned int aif2clk_disable:1;
140 
141 	int dsp_active;
142 	const struct firmware *cur_fw;
143 	const struct firmware *mbc;
144 	const struct firmware *mbc_vss;
145 	const struct firmware *enh_eq;
146 };
147 
148 #endif
149