xref: /linux/include/sound/aw88399.h (revision 67f8bc848ee31831336bd478e57d2f993551902e)
1 /* SPDX-License-Identifier: GPL-2.0-only
2  *
3  * linux/sound/aw88399.h --  Platform data for AW88399
4  *
5  * Copyright (c) 2023 AWINIC Technology CO., LTD
6  *
7  * Author: Weidong Wang <wangweidong.a@awinic.com>
8  */
9 
10 #ifndef __SOUND_AW88399_H
11 #define __SOUND_AW88399_H
12 
13 #include <linux/mutex.h>
14 #include <linux/workqueue.h>
15 
16 /* registers list */
17 #define AW88399_ID_REG			(0x00)
18 #define AW88399_SYSST_REG		(0x01)
19 #define AW88399_SYSINT_REG		(0x02)
20 #define AW88399_SYSINTM_REG		(0x03)
21 #define AW88399_SYSCTRL_REG		(0x04)
22 #define AW88399_SYSCTRL2_REG		(0x05)
23 #define AW88399_I2SCTRL1_REG		(0x06)
24 #define AW88399_I2SCTRL2_REG		(0x07)
25 #define AW88399_I2SCTRL3_REG		(0x08)
26 #define AW88399_DACCFG1_REG		(0x09)
27 #define AW88399_DACCFG2_REG		(0x0A)
28 #define AW88399_DACCFG3_REG		(0x0B)
29 #define AW88399_DACCFG4_REG		(0x0C)
30 #define AW88399_DACCFG5_REG		(0x0D)
31 #define AW88399_DACCFG6_REG		(0x0E)
32 #define AW88399_DACCFG7_REG		(0x0F)
33 #define AW88399_MPDCFG1_REG		(0x10)
34 #define AW88399_MPDCFG2_REG		(0x11)
35 #define AW88399_MPDCFG3_REG		(0x12)
36 #define AW88399_MPDCFG4_REG		(0x13)
37 #define AW88399_PWMCTRL1_REG		(0x14)
38 #define AW88399_PWMCTRL2_REG		(0x15)
39 #define AW88399_PWMCTRL3_REG		(0x16)
40 #define AW88399_I2SCFG1_REG		(0x17)
41 #define AW88399_DBGCTRL_REG		(0x18)
42 #define AW88399_HAGCST_REG		(0x20)
43 #define AW88399_VBAT_REG		(0x21)
44 #define AW88399_TEMP_REG		(0x22)
45 #define AW88399_PVDD_REG		(0x23)
46 #define AW88399_ISNDAT_REG		(0x24)
47 #define AW88399_VSNDAT_REG		(0x25)
48 #define AW88399_I2SINT_REG		(0x26)
49 #define AW88399_I2SCAPCNT_REG		(0x27)
50 #define AW88399_ANASTA1_REG		(0x28)
51 #define AW88399_ANASTA2_REG		(0x29)
52 #define AW88399_ANASTA3_REG		(0x2A)
53 #define AW88399_TESTDET_REG		(0x2B)
54 #define AW88399_DSMCFG1_REG		(0x30)
55 #define AW88399_DSMCFG2_REG		(0x31)
56 #define AW88399_DSMCFG3_REG		(0x32)
57 #define AW88399_DSMCFG4_REG		(0x33)
58 #define AW88399_DSMCFG5_REG		(0x34)
59 #define AW88399_DSMCFG6_REG		(0x35)
60 #define AW88399_DSMCFG7_REG		(0x36)
61 #define AW88399_DSMCFG8_REG		(0x37)
62 #define AW88399_TESTIN_REG		(0x38)
63 #define AW88399_TESTOUT_REG		(0x39)
64 #define AW88399_MEMTEST_REG		(0x3A)
65 #define AW88399_VSNCTRL1_REG		(0x3B)
66 #define AW88399_ISNCTRL1_REG		(0x3C)
67 #define AW88399_ISNCTRL2_REG		(0x3D)
68 #define AW88399_DSPMADD_REG		(0x40)
69 #define AW88399_DSPMDAT_REG		(0x41)
70 #define AW88399_WDT_REG		(0x42)
71 #define AW88399_ACR1_REG		(0x43)
72 #define AW88399_ACR2_REG		(0x44)
73 #define AW88399_ASR1_REG		(0x45)
74 #define AW88399_ASR2_REG		(0x46)
75 #define AW88399_DSPCFG_REG		(0x47)
76 #define AW88399_ASR3_REG		(0x48)
77 #define AW88399_ASR4_REG		(0x49)
78 #define AW88399_DSPVCALB_REG		(0x4A)
79 #define AW88399_CRCCTRL_REG		(0x4B)
80 #define AW88399_DSPDBG1_REG		(0x4C)
81 #define AW88399_DSPDBG2_REG		(0x4D)
82 #define AW88399_DSPDBG3_REG		(0x4E)
83 #define AW88399_PLLCTRL1_REG		(0x50)
84 #define AW88399_PLLCTRL2_REG		(0x51)
85 #define AW88399_PLLCTRL3_REG		(0x52)
86 #define AW88399_CDACTRL1_REG		(0x53)
87 #define AW88399_CDACTRL2_REG		(0x54)
88 #define AW88399_CDACTRL3_REG		(0x55)
89 #define AW88399_SADCCTRL1_REG		(0x56)
90 #define AW88399_SADCCTRL2_REG		(0x57)
91 #define AW88399_BOPCTRL1_REG		(0x58)
92 #define AW88399_BOPCTRL2_REG		(0x5A)
93 #define AW88399_BOPCTRL3_REG		(0x5B)
94 #define AW88399_BOPCTRL4_REG		(0x5C)
95 #define AW88399_BOPCTRL5_REG		(0x5D)
96 #define AW88399_BOPCTRL6_REG		(0x5E)
97 #define AW88399_BOPCTRL7_REG		(0x5F)
98 #define AW88399_BSTCTRL1_REG		(0x60)
99 #define AW88399_BSTCTRL2_REG		(0x61)
100 #define AW88399_BSTCTRL3_REG		(0x62)
101 #define AW88399_BSTCTRL4_REG		(0x63)
102 #define AW88399_BSTCTRL5_REG		(0x64)
103 #define AW88399_BSTCTRL6_REG		(0x65)
104 #define AW88399_BSTCTRL7_REG		(0x66)
105 #define AW88399_BSTCTRL8_REG		(0x67)
106 #define AW88399_BSTCTRL9_REG		(0x68)
107 #define AW88399_BSTCTRL10_REG		(0x69)
108 #define AW88399_CPCTRL_REG		(0x6A)
109 #define AW88399_EFWH_REG		(0x6C)
110 #define AW88399_EFWM2_REG		(0x6D)
111 #define AW88399_EFWM1_REG		(0x6E)
112 #define AW88399_EFWL_REG		(0x6F)
113 #define AW88399_TESTCTRL1_REG		(0x70)
114 #define AW88399_TESTCTRL2_REG		(0x71)
115 #define AW88399_EFCTRL1_REG		(0x72)
116 #define AW88399_EFCTRL2_REG		(0x73)
117 #define AW88399_EFRH4_REG		(0x74)
118 #define AW88399_EFRH3_REG		(0x75)
119 #define AW88399_EFRH2_REG		(0x76)
120 #define AW88399_EFRH1_REG		(0x77)
121 #define AW88399_EFRL4_REG		(0x78)
122 #define AW88399_EFRL3_REG		(0x79)
123 #define AW88399_EFRL2_REG		(0x7A)
124 #define AW88399_EFRL1_REG		(0x7B)
125 #define AW88399_TM_REG			(0x7C)
126 #define AW88399_TM2_REG		(0x7D)
127 
128 #define AW88399_REG_MAX		(0x7E)
129 #define AW88399_MUTE_VOL		(1023)
130 
131 #define AW88399_DSP_CFG_ADDR		(0x9B00)
132 #define AW88399_DSP_REG_CFG_ADPZ_RA	(0x9B68)
133 #define AW88399_DSP_FW_ADDR		(0x8980)
134 #define AW88399_DSP_ROM_CHECK_ADDR	(0x1F40)
135 #define AW88399_DSP_ROM_CHECK_DATA	(0x4638)
136 
137 #define AW88399_CALI_RE_HBITS_MASK	(~(0xFFFF0000))
138 #define AW88399_CALI_RE_HBITS_SHIFT	(16)
139 
140 #define AW88399_CALI_RE_LBITS_MASK	(~(0xFFFF))
141 #define AW88399_CALI_RE_LBITS_SHIFT	(0)
142 
143 #define AW88399_I2STXEN_START_BIT	(9)
144 #define AW88399_I2STXEN_BITS_LEN	(1)
145 #define AW88399_I2STXEN_MASK		\
146 	(~(((1<<AW88399_I2STXEN_BITS_LEN)-1) << AW88399_I2STXEN_START_BIT))
147 
148 #define AW88399_I2STXEN_DISABLE	(0)
149 #define AW88399_I2STXEN_DISABLE_VALUE	\
150 	(AW88399_I2STXEN_DISABLE << AW88399_I2STXEN_START_BIT)
151 
152 #define AW88399_I2STXEN_ENABLE		(1)
153 #define AW88399_I2STXEN_ENABLE_VALUE	\
154 	(AW88399_I2STXEN_ENABLE << AW88399_I2STXEN_START_BIT)
155 
156 #define AW88399_VOL_START_BIT		(0)
157 #define AW88399_VOL_BITS_LEN		(10)
158 #define AW88399_VOL_MASK		\
159 	(~(((1<<AW88399_VOL_BITS_LEN)-1) << AW88399_VOL_START_BIT))
160 
161 #define AW88399_PWDN_START_BIT		(0)
162 #define AW88399_PWDN_BITS_LEN		(1)
163 #define AW88399_PWDN_MASK		\
164 	(~(((1<<AW88399_PWDN_BITS_LEN)-1) << AW88399_PWDN_START_BIT))
165 
166 #define AW88399_PWDN_POWER_DOWN	(1)
167 #define AW88399_PWDN_POWER_DOWN_VALUE	\
168 	(AW88399_PWDN_POWER_DOWN << AW88399_PWDN_START_BIT)
169 
170 #define AW88399_PWDN_WORKING		(0)
171 #define AW88399_PWDN_WORKING_VALUE	\
172 	(AW88399_PWDN_WORKING << AW88399_PWDN_START_BIT)
173 
174 #define AW88399_DSPBY_START_BIT	(2)
175 #define AW88399_DSPBY_BITS_LEN		(1)
176 #define AW88399_DSPBY_MASK		\
177 	(~(((1<<AW88399_DSPBY_BITS_LEN)-1) << AW88399_DSPBY_START_BIT))
178 
179 #define AW88399_DSPBY_WORKING		(0)
180 #define AW88399_DSPBY_WORKING_VALUE	\
181 	(AW88399_DSPBY_WORKING << AW88399_DSPBY_START_BIT)
182 
183 #define AW88399_DSPBY_BYPASS		(1)
184 #define AW88399_DSPBY_BYPASS_VALUE	\
185 	(AW88399_DSPBY_BYPASS << AW88399_DSPBY_START_BIT)
186 
187 #define AW88399_MEM_CLKSEL_START_BIT	(3)
188 #define AW88399_MEM_CLKSEL_BITS_LEN	(1)
189 #define AW88399_MEM_CLKSEL_MASK		\
190 	(~(((1<<AW88399_MEM_CLKSEL_BITS_LEN)-1) << AW88399_MEM_CLKSEL_START_BIT))
191 
192 #define AW88399_MEM_CLKSEL_OSCCLK	(0)
193 #define AW88399_MEM_CLKSEL_OSCCLK_VALUE	\
194 	(AW88399_MEM_CLKSEL_OSCCLK << AW88399_MEM_CLKSEL_START_BIT)
195 
196 #define AW88399_MEM_CLKSEL_DAPHCLK	(1)
197 #define AW88399_MEM_CLKSEL_DAPHCLK_VALUE	\
198 	(AW88399_MEM_CLKSEL_DAPHCLK << AW88399_MEM_CLKSEL_START_BIT)
199 
200 #define AW88399_DITHER_EN_START_BIT	(15)
201 #define AW88399_DITHER_EN_BITS_LEN	(1)
202 #define AW88399_DITHER_EN_MASK		 \
203 	(~(((1<<AW88399_DITHER_EN_BITS_LEN)-1) << AW88399_DITHER_EN_START_BIT))
204 
205 #define AW88399_DITHER_EN_DISABLE	(0)
206 #define AW88399_DITHER_EN_DISABLE_VALUE	\
207 	(AW88399_DITHER_EN_DISABLE << AW88399_DITHER_EN_START_BIT)
208 
209 #define AW88399_DITHER_EN_ENABLE	(1)
210 #define AW88399_DITHER_EN_ENABLE_VALUE	\
211 	(AW88399_DITHER_EN_ENABLE << AW88399_DITHER_EN_START_BIT)
212 
213 #define AW88399_HMUTE_START_BIT	(8)
214 #define AW88399_HMUTE_BITS_LEN		(1)
215 #define AW88399_HMUTE_MASK		\
216 	(~(((1<<AW88399_HMUTE_BITS_LEN)-1) << AW88399_HMUTE_START_BIT))
217 
218 #define AW88399_HMUTE_DISABLE		(0)
219 #define AW88399_HMUTE_DISABLE_VALUE	\
220 	(AW88399_HMUTE_DISABLE << AW88399_HMUTE_START_BIT)
221 
222 #define AW88399_HMUTE_ENABLE		(1)
223 #define AW88399_HMUTE_ENABLE_VALUE	\
224 	(AW88399_HMUTE_ENABLE << AW88399_HMUTE_START_BIT)
225 
226 #define AW88399_EF_DBMD_START_BIT	(2)
227 #define AW88399_EF_DBMD_BITS_LEN	(1)
228 #define AW88399_EF_DBMD_MASK		\
229 	(~(((1<<AW88399_EF_DBMD_BITS_LEN)-1) << AW88399_EF_DBMD_START_BIT))
230 
231 #define AW88399_EF_DBMD_OR		(1)
232 #define AW88399_EF_DBMD_OR_VALUE	\
233 	(AW88399_EF_DBMD_OR << AW88399_EF_DBMD_START_BIT)
234 
235 #define AW88399_VDSEL_START_BIT	(5)
236 #define AW88399_VDSEL_BITS_LEN		(1)
237 #define AW88399_VDSEL_MASK		\
238 	(~(((1<<AW88399_VDSEL_BITS_LEN)-1) << AW88399_VDSEL_START_BIT))
239 
240 #define AW88399_EF_ISN_GESLP_H_START_BIT	(0)
241 #define AW88399_EF_ISN_GESLP_H_BITS_LEN	(10)
242 #define AW88399_EF_ISN_GESLP_H_MASK		\
243 	(~(((1<<AW88399_EF_ISN_GESLP_H_BITS_LEN)-1) << AW88399_EF_ISN_GESLP_H_START_BIT))
244 
245 /* EF_VSN_GESLP_H bit 9:0 (EFRH3 0x75) */
246 #define AW88399_EF_VSN_GESLP_H_START_BIT	(0)
247 #define AW88399_EF_VSN_GESLP_H_BITS_LEN	(10)
248 #define AW88399_EF_VSN_GESLP_H_MASK		\
249 	(~(((1<<AW88399_EF_VSN_GESLP_H_BITS_LEN)-1) << AW88399_EF_VSN_GESLP_H_START_BIT))
250 
251 #define AW88399_EF_ISN_GESLP_L_START_BIT	(0)
252 #define AW88399_EF_ISN_GESLP_L_BITS_LEN	(10)
253 #define AW88399_EF_ISN_GESLP_L_MASK		\
254 	(~(((1<<AW88399_EF_ISN_GESLP_L_BITS_LEN)-1) << AW88399_EF_ISN_GESLP_L_START_BIT))
255 
256 /* EF_VSN_GESLP_L bit 9:0 (EFRL3 0x79) */
257 #define AW88399_EF_VSN_GESLP_L_START_BIT	(0)
258 #define AW88399_EF_VSN_GESLP_L_BITS_LEN	(10)
259 #define AW88399_EF_VSN_GESLP_L_MASK		\
260 	(~(((1<<AW88399_EF_VSN_GESLP_L_BITS_LEN)-1) << AW88399_EF_VSN_GESLP_L_START_BIT))
261 
262 #define AW88399_INTERNAL_VSN_TRIM_H_START_BIT	(9)
263 #define AW88399_INTERNAL_VSN_TRIM_H_BITS_LEN	(6)
264 #define AW88399_INTERNAL_VSN_TRIM_H_MASK	\
265 	(~(((1<<AW88399_INTERNAL_VSN_TRIM_H_BITS_LEN)-1) << AW88399_INTERNAL_VSN_TRIM_H_START_BIT))
266 
267 #define AW88399_INTERNAL_VSN_TRIM_L_START_BIT	(9)
268 #define AW88399_INTERNAL_VSN_TRIM_L_BITS_LEN	(6)
269 #define AW88399_INTERNAL_VSN_TRIM_L_MASK	\
270 	(~(((1<<AW88399_INTERNAL_VSN_TRIM_L_BITS_LEN)-1) << AW88399_INTERNAL_VSN_TRIM_L_START_BIT))
271 
272 #define AW88399_RCV_MODE_START_BIT	(7)
273 #define AW88399_RCV_MODE_BITS_LEN	(1)
274 #define AW88399_RCV_MODE_MASK		\
275 	(~(((1<<AW88399_RCV_MODE_BITS_LEN)-1) << AW88399_RCV_MODE_START_BIT))
276 
277 #define AW88399_CLKI_START_BIT		(4)
278 #define AW88399_NOCLKI_START_BIT	(5)
279 #define AW88399_PLLI_START_BIT		(0)
280 #define AW88399_PLLI_INT_VALUE		(1)
281 #define AW88399_PLLI_INT_INTERRUPT \
282 	(AW88399_PLLI_INT_VALUE << AW88399_PLLI_START_BIT)
283 
284 #define AW88399_CLKI_INT_VALUE		(1)
285 #define AW88399_CLKI_INT_INTERRUPT \
286 	(AW88399_CLKI_INT_VALUE << AW88399_CLKI_START_BIT)
287 
288 #define AW88399_NOCLKI_INT_VALUE	(1)
289 #define AW88399_NOCLKI_INT_INTERRUPT \
290 	(AW88399_NOCLKI_INT_VALUE << AW88399_NOCLKI_START_BIT)
291 
292 #define AW88399_BIT_SYSINT_CHECK \
293 		(AW88399_PLLI_INT_INTERRUPT | \
294 		AW88399_CLKI_INT_INTERRUPT | \
295 		AW88399_NOCLKI_INT_INTERRUPT)
296 
297 #define AW88399_CRC_CHECK_START_BIT	(12)
298 #define AW88399_CRC_CHECK_BITS_LEN	(3)
299 #define AW88399_CRC_CHECK_BITS_MASK	\
300 	(~(((1<<AW88399_CRC_CHECK_BITS_LEN)-1) << AW88399_CRC_CHECK_START_BIT))
301 
302 #define AW88399_RCV_MODE_RECEIVER	(1)
303 #define AW88399_RCV_MODE_RECEIVER_VALUE	\
304 	(AW88399_RCV_MODE_RECEIVER << AW88399_RCV_MODE_START_BIT)
305 
306 #define AW88399_AMPPD_START_BIT	(1)
307 #define AW88399_AMPPD_BITS_LEN		(1)
308 #define AW88399_AMPPD_MASK		\
309 	(~(((1<<AW88399_AMPPD_BITS_LEN)-1) << AW88399_AMPPD_START_BIT))
310 
311 #define AW88399_AMPPD_WORKING		(0)
312 #define AW88399_AMPPD_WORKING_VALUE	\
313 	(AW88399_AMPPD_WORKING << AW88399_AMPPD_START_BIT)
314 
315 #define AW88399_AMPPD_POWER_DOWN	(1)
316 #define AW88399_AMPPD_POWER_DOWN_VALUE	\
317 	(AW88399_AMPPD_POWER_DOWN << AW88399_AMPPD_START_BIT)
318 
319 #define AW88399_RAM_CG_BYP_START_BIT	(0)
320 #define AW88399_RAM_CG_BYP_BITS_LEN	(1)
321 #define AW88399_RAM_CG_BYP_MASK		\
322 	(~(((1<<AW88399_RAM_CG_BYP_BITS_LEN)-1) << AW88399_RAM_CG_BYP_START_BIT))
323 
324 #define AW88399_RAM_CG_BYP_WORK	(0)
325 #define AW88399_RAM_CG_BYP_WORK_VALUE	\
326 	(AW88399_RAM_CG_BYP_WORK << AW88399_RAM_CG_BYP_START_BIT)
327 
328 #define AW88399_RAM_CG_BYP_BYPASS	(1)
329 #define AW88399_RAM_CG_BYP_BYPASS_VALUE	\
330 	(AW88399_RAM_CG_BYP_BYPASS << AW88399_RAM_CG_BYP_START_BIT)
331 
332 #define AW88399_CRC_END_ADDR_START_BIT	(0)
333 #define AW88399_CRC_END_ADDR_BITS_LEN	(12)
334 #define AW88399_CRC_END_ADDR_MASK	\
335 	(~(((1<<AW88399_CRC_END_ADDR_BITS_LEN)-1) << AW88399_CRC_END_ADDR_START_BIT))
336 
337 #define AW88399_CRC_CODE_EN_START_BIT	(13)
338 #define AW88399_CRC_CODE_EN_BITS_LEN	(1)
339 #define AW88399_CRC_CODE_EN_MASK	\
340 	(~(((1<<AW88399_CRC_CODE_EN_BITS_LEN)-1) << AW88399_CRC_CODE_EN_START_BIT))
341 
342 #define AW88399_CRC_CODE_EN_DISABLE	(0)
343 #define AW88399_CRC_CODE_EN_DISABLE_VALUE	\
344 	(AW88399_CRC_CODE_EN_DISABLE << AW88399_CRC_CODE_EN_START_BIT)
345 
346 #define AW88399_CRC_CODE_EN_ENABLE	(1)
347 #define AW88399_CRC_CODE_EN_ENABLE_VALUE	\
348 	(AW88399_CRC_CODE_EN_ENABLE << AW88399_CRC_CODE_EN_START_BIT)
349 
350 #define AW88399_CRC_CFG_EN_START_BIT	(12)
351 #define AW88399_CRC_CFG_EN_BITS_LEN	(1)
352 #define AW88399_CRC_CFG_EN_MASK		\
353 	(~(((1<<AW88399_CRC_CFG_EN_BITS_LEN)-1) << AW88399_CRC_CFG_EN_START_BIT))
354 
355 #define AW88399_CRC_CFG_EN_DISABLE	(0)
356 #define AW88399_CRC_CFG_EN_DISABLE_VALUE	\
357 	(AW88399_CRC_CFG_EN_DISABLE << AW88399_CRC_CFG_EN_START_BIT)
358 
359 #define AW88399_CRC_CFG_EN_ENABLE	(1)
360 #define AW88399_CRC_CFG_EN_ENABLE_VALUE	\
361 	(AW88399_CRC_CFG_EN_ENABLE << AW88399_CRC_CFG_EN_START_BIT)
362 
363 #define AW88399_OCDS_START_BIT		(3)
364 #define AW88399_OCDS_OC		(1)
365 #define AW88399_OCDS_OC_VALUE		\
366 	(AW88399_OCDS_OC << AW88399_OCDS_START_BIT)
367 
368 #define AW88399_NOCLKS_START_BIT	(5)
369 #define AW88399_NOCLKS_NO_CLOCK	(1)
370 #define AW88399_NOCLKS_NO_CLOCK_VALUE	\
371 	(AW88399_NOCLKS_NO_CLOCK << AW88399_NOCLKS_START_BIT)
372 
373 #define AW88399_SWS_START_BIT		(8)
374 #define AW88399_SWS_SWITCHING		(1)
375 #define AW88399_SWS_SWITCHING_VALUE	\
376 	(AW88399_SWS_SWITCHING << AW88399_SWS_START_BIT)
377 
378 #define AW88399_BSTS_START_BIT		(9)
379 #define AW88399_BSTS_FINISHED		(1)
380 #define AW88399_BSTS_FINISHED_VALUE	\
381 	(AW88399_BSTS_FINISHED << AW88399_BSTS_START_BIT)
382 
383 #define AW88399_UVLS_START_BIT		(14)
384 #define AW88399_UVLS_NORMAL		(0)
385 #define AW88399_UVLS_NORMAL_VALUE	\
386 	(AW88399_UVLS_NORMAL << AW88399_UVLS_START_BIT)
387 
388 #define AW88399_BSTOCS_START_BIT	(11)
389 #define AW88399_BSTOCS_OVER_CURRENT	(1)
390 #define AW88399_BSTOCS_OVER_CURRENT_VALUE	\
391 	(AW88399_BSTOCS_OVER_CURRENT << AW88399_BSTOCS_START_BIT)
392 
393 #define AW88399_OTHS_START_BIT		(1)
394 #define AW88399_OTHS_OT		(1)
395 #define AW88399_OTHS_OT_VALUE		\
396 	(AW88399_OTHS_OT << AW88399_OTHS_START_BIT)
397 
398 #define AW88399_PLLS_START_BIT		(0)
399 #define AW88399_PLLS_LOCKED		(1)
400 #define AW88399_PLLS_LOCKED_VALUE	\
401 	(AW88399_PLLS_LOCKED << AW88399_PLLS_START_BIT)
402 
403 #define AW88399_CLKS_START_BIT		(4)
404 #define AW88399_CLKS_STABLE		(1)
405 #define AW88399_CLKS_STABLE_VALUE	\
406 	(AW88399_CLKS_STABLE << AW88399_CLKS_START_BIT)
407 
408 #define AW88399_BIT_PLL_CHECK \
409 		(AW88399_CLKS_STABLE_VALUE | \
410 		AW88399_PLLS_LOCKED_VALUE)
411 
412 #define AW88399_BIT_SYSST_CHECK_MASK \
413 		(~(AW88399_UVLS_NORMAL_VALUE | \
414 		AW88399_BSTOCS_OVER_CURRENT_VALUE | \
415 		AW88399_BSTS_FINISHED_VALUE | \
416 		AW88399_SWS_SWITCHING_VALUE | \
417 		AW88399_NOCLKS_NO_CLOCK_VALUE | \
418 		AW88399_CLKS_STABLE_VALUE | \
419 		AW88399_OCDS_OC_VALUE | \
420 		AW88399_OTHS_OT_VALUE | \
421 		AW88399_PLLS_LOCKED_VALUE))
422 
423 #define AW88399_BIT_SYSST_NOSWS_CHECK \
424 		(AW88399_BSTS_FINISHED_VALUE | \
425 		AW88399_CLKS_STABLE_VALUE | \
426 		AW88399_PLLS_LOCKED_VALUE)
427 
428 #define AW88399_BIT_SYSST_SWS_CHECK \
429 		(AW88399_BSTS_FINISHED_VALUE | \
430 		AW88399_CLKS_STABLE_VALUE | \
431 		AW88399_PLLS_LOCKED_VALUE | \
432 		AW88399_SWS_SWITCHING_VALUE)
433 
434 #define AW88399_CCO_MUX_START_BIT	(14)
435 #define AW88399_CCO_MUX_BITS_LEN	(1)
436 #define AW88399_CCO_MUX_MASK		\
437 	(~(((1<<AW88399_CCO_MUX_BITS_LEN)-1) << AW88399_CCO_MUX_START_BIT))
438 
439 #define AW88399_CCO_MUX_DIVIDED	(0)
440 #define AW88399_CCO_MUX_DIVIDED_VALUE	\
441 	(AW88399_CCO_MUX_DIVIDED << AW88399_CCO_MUX_START_BIT)
442 
443 #define AW88399_CCO_MUX_BYPASS		(1)
444 #define AW88399_CCO_MUX_BYPASS_VALUE	\
445 	(AW88399_CCO_MUX_BYPASS << AW88399_CCO_MUX_START_BIT)
446 
447 #define AW88399_NOISE_GATE_EN_START_BIT	(13)
448 #define AW88399_NOISE_GATE_EN_BITS_LEN		(1)
449 #define AW88399_NOISE_GATE_EN_MASK	\
450 	(~(((1<<AW88399_NOISE_GATE_EN_BITS_LEN)-1) << AW88399_NOISE_GATE_EN_START_BIT))
451 
452 #define AW88399_WDT_CNT_START_BIT	(0)
453 #define AW88399_WDT_CNT_BITS_LEN	(8)
454 #define AW88399_WDT_CNT_MASK		\
455 	(~(((1<<AW88399_WDT_CNT_BITS_LEN)-1) << AW88399_WDT_CNT_START_BIT))
456 
457 #define AW88399_REABS_START_BIT	(3)
458 #define AW88399_REABS_BITS_LEN		(1)
459 #define AW88399_REABS_MASK		\
460 	(~(((1<<AW88399_REABS_BITS_LEN)-1) << AW88399_REABS_START_BIT))
461 
462 #define AW88399_DSP_VOL_START_BIT	(8)
463 #define AW88399_DSP_VOL_BITS_LEN	(8)
464 #define AW88399_DSP_VOL_MASK		\
465 	(~(((1<<AW88399_DSP_VOL_BITS_LEN)-1) << AW88399_DSP_VOL_START_BIT))
466 
467 #define AW883XX_DSP_NG_EN_START	(13)
468 #define AW883XX_DSP_NG_EN_LEN		(1)
469 #define AW883XX_DSP_NG_EN_MASK		\
470 	(~(((1 << AW883XX_DSP_NG_EN_LEN) - 1) << AW883XX_DSP_NG_EN_START))
471 #define AW883XX_DSP_NG_EN_DISABLE	(0)
472 #define AW883XX_DSP_NG_EN_DISABLE_VALUE	\
473 	(AW883XX_DSP_NG_EN_DISABLE << AW883XX_DSP_NG_EN_START)
474 
475 #define AW88399_VOLUME_STEP_DB			(64)
476 #define AW88399_VOL_DEFAULT_VALUE		(0)
477 #define AW88399_DSP_ODD_NUM_BIT_TEST		(0x5555)
478 #define AW88399_EF_ISN_GESLP_SIGN_MASK		(~(1 << 9))
479 #define AW88399_EF_ISN_GESLP_SIGN_NEG		(0xfe00)
480 
481 #define AW88399_EF_VSN_GESLP_SIGN_MASK		(~(1 << 9))
482 #define AW88399_EF_VSN_GESLP_SIGN_NEG		(0xfe00)
483 
484 #define AW88399_TEM4_SIGN_MASK			(~(1 << 5))
485 #define AW88399_TEM4_SIGN_NEG			(0xffc0)
486 
487 #define AW88399_ICABLK_FACTOR			(1)
488 #define AW88399_VCABLK_FACTOR			(1)
489 #define AW88399_VCABLK_DAC_FACTOR		(2)
490 
491 #define AW88399_VCALB_ADJ_FACTOR		(12)
492 #define AW88399_VCALB_ACCURACY			(1 << 12)
493 
494 #define AW88399_ISCAL_FACTOR			(3125)
495 #define AW88399_VSCAL_FACTOR			(18875)
496 #define AW88399_ISCAL_DAC_FACTOR		(3125)
497 #define AW88399_VSCAL_DAC_FACTOR		(12600)
498 #define AW88399_CABL_BASE_VALUE		(1000)
499 
500 #define AW88399_DEV_DEFAULT_CH			(0)
501 #define AW88399_DEV_DSP_CHECK_MAX		(5)
502 #define AW88399_MAX_RAM_WRITE_BYTE_SIZE	(128)
503 #define AW88399_DSP_RE_SHIFT			(12)
504 #define AW88399_CALI_RE_MAX			(15000)
505 #define AW88399_CALI_RE_MIN			(4000)
506 #define AW_FW_ADDR_LEN				(4)
507 #define AW88399_DSP_RE_TO_SHOW_RE(re, shift)	(((re) * (1000)) >> (shift))
508 #define AW88399_SHOW_RE_TO_DSP_RE(re, shift)	(((re) << shift) / (1000))
509 #define AW88399_CRC_CHECK_PASS_VAL		(0x4)
510 
511 #define AW88399_CRC_CFG_BASE_ADDR		(0xD80)
512 #define AW88399_CRC_FW_BASE_ADDR		(0x4C0)
513 #define AW88399_ACF_FILE			"aw88399_acf.bin"
514 #define AW88399_DEV_SYSST_CHECK_MAX		(10)
515 #define AW88399_CHIP_ID			0x2183
516 
517 #define AW88399_START_RETRIES			(5)
518 #define AW88399_START_WORK_DELAY_MS		(0)
519 
520 enum {
521 	AW_EF_AND_CHECK = 0,
522 	AW_EF_OR_CHECK,
523 };
524 
525 enum {
526 	AW88399_DEV_VDSEL_DAC = 0,
527 	AW88399_DEV_VDSEL_VSENSE = 32,
528 };
529 
530 enum {
531 	AW88399_DSP_CRC_NA = 0,
532 	AW88399_DSP_CRC_OK = 1,
533 };
534 
535 enum {
536 	AW88399_DSP_FW_UPDATE_OFF = 0,
537 	AW88399_DSP_FW_UPDATE_ON = 1,
538 };
539 
540 enum {
541 	AW88399_FORCE_UPDATE_OFF = 0,
542 	AW88399_FORCE_UPDATE_ON = 1,
543 };
544 
545 enum {
546 	AW88399_1000_US = 1000,
547 	AW88399_2000_US = 2000,
548 	AW88399_3000_US = 3000,
549 	AW88399_4000_US = 4000,
550 };
551 
552 enum AW88399_DEV_STATUS {
553 	AW88399_DEV_PW_OFF = 0,
554 	AW88399_DEV_PW_ON,
555 };
556 
557 enum AW88399_DEV_FW_STATUS {
558 	AW88399_DEV_FW_FAILED = 0,
559 	AW88399_DEV_FW_OK,
560 };
561 
562 enum AW88399_DEV_MEMCLK {
563 	AW88399_DEV_MEMCLK_OSC = 0,
564 	AW88399_DEV_MEMCLK_PLL = 1,
565 };
566 
567 enum AW88399_DEV_DSP_CFG {
568 	AW88399_DEV_DSP_WORK = 0,
569 	AW88399_DEV_DSP_BYPASS = 1,
570 };
571 
572 enum {
573 	AW88399_NOT_RCV_MODE = 0,
574 	AW88399_RCV_MODE = 1,
575 };
576 
577 enum {
578 	AW88399_SYNC_START = 0,
579 	AW88399_ASYNC_START,
580 };
581 
582 struct aw_device;
583 struct aw_container;
584 struct aw_cali_desc;
585 struct gpio_desc;
586 struct i2c_client;
587 struct regmap;
588 
589 struct aw88399 {
590 	struct aw_device *aw_pa;
591 	struct mutex lock;
592 	struct gpio_desc *reset_gpio;
593 	struct delayed_work start_work;
594 	struct regmap *regmap;
595 	struct aw_container *aw_cfg;
596 
597 	unsigned int check_val;
598 	unsigned int crc_init_val;
599 	unsigned int vcalb_init_val;
600 	unsigned int dither_st;
601 	bool bsts_unreliable;
602 	bool fw_needs_reload;
603 };
604 
605 int aw_dev_check_syspll(struct aw_device *aw_dev);
606 void aw_dev_dsp_enable(struct aw_device *aw_dev, bool is_enable);
607 int aw_dev_get_dsp_status(struct aw_device *aw_dev);
608 int aw_dev_set_volume(struct aw_device *aw_dev, unsigned int value);
609 int aw_dev_update_cali_re(struct aw_cali_desc *cali_desc);
610 int aw88399_dev_get_prof_name(struct aw_device *aw_dev, int index, char **prof_name);
611 void aw88399_dev_mute(struct aw_device *aw_dev, bool is_mute);
612 void aw88399_dev_set_channel(struct aw88399 *aw88399, int channel);
613 void aw88399_hw_reset(struct aw88399 *aw88399);
614 int aw88399_init(struct aw88399 *aw88399, struct i2c_client *i2c, struct regmap *regmap);
615 extern const struct regmap_config aw88399_remap_config;
616 int aw88399_request_firmware_file(struct aw88399 *aw88399);
617 void aw88399_start(struct aw88399 *aw88399, bool sync_start);
618 void aw88399_startup_work(struct work_struct *work);
619 int aw88399_stop(struct aw_device *aw_dev);
620 
621 #endif /* __SOUND_AW88399_H */
622