xref: /openbmc/linux/sound/soc/codecs/cs35l35.h (revision d0e22329)
1 /*
2  * cs35l35.h -- CS35L35 ALSA SoC audio driver
3  *
4  * Copyright 2016 Cirrus Logic, Inc.
5  *
6  * Author: Brian Austin <brian.austin@cirrus.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 
14 #ifndef __CS35L35_H__
15 #define __CS35L35_H__
16 
17 #define CS35L35_FIRSTREG		0x01
18 #define CS35L35_LASTREG			0x7E
19 #define CS35L35_CHIP_ID			0x00035A35
20 #define CS35L35_DEVID_AB		0x01	/* Device ID A & B [RO] */
21 #define CS35L35_DEVID_CD		0x02    /* Device ID C & D [RO] */
22 #define CS35L35_DEVID_E			0x03    /* Device ID E [RO] */
23 #define CS35L35_FAB_ID			0x04	/* Fab ID [RO] */
24 #define CS35L35_REV_ID			0x05	/* Revision ID [RO] */
25 #define CS35L35_PWRCTL1			0x06    /* Power Ctl 1 */
26 #define CS35L35_PWRCTL2			0x07    /* Power Ctl 2 */
27 #define CS35L35_PWRCTL3			0x08	/* Power Ctl 3 */
28 #define CS35L35_CLK_CTL1		0x0A	/* Clocking Ctl 1 */
29 #define CS35L35_CLK_CTL2		0x0B	/* Clocking Ctl 2 */
30 #define CS35L35_CLK_CTL3		0x0C	/* Clocking Ctl 3 */
31 #define CS35L35_SP_FMT_CTL1		0x0D	/* Serial Port Format CTL1 */
32 #define CS35L35_SP_FMT_CTL2		0x0E	/* Serial Port Format CTL2 */
33 #define CS35L35_SP_FMT_CTL3		0x0F	/* Serial Port Format CTL3 */
34 #define CS35L35_MAG_COMP_CTL		0x13	/* Magnitude Comp CTL */
35 #define CS35L35_AMP_INP_DRV_CTL		0x14	/* Amp Input Drive Ctl */
36 #define CS35L35_AMP_DIG_VOL_CTL		0x15	/* Amplifier Dig Volume Ctl */
37 #define CS35L35_AMP_DIG_VOL		0x16	/* Amplifier Dig Volume */
38 #define CS35L35_ADV_DIG_VOL		0x17	/* Advisory Digital Volume */
39 #define CS35L35_PROTECT_CTL		0x18	/* Amp Gain - Prot Ctl Param */
40 #define CS35L35_AMP_GAIN_AUD_CTL	0x19	/* Amp Serial Port Gain Ctl */
41 #define CS35L35_AMP_GAIN_PDM_CTL	0x1A	/* Amplifier Gain PDM Ctl */
42 #define CS35L35_AMP_GAIN_ADV_CTL	0x1B	/* Amplifier Gain Ctl */
43 #define CS35L35_GPI_CTL			0x1C	/* GPI Ctl */
44 #define CS35L35_BST_CVTR_V_CTL		0x1D	/* Boost Conv Voltage Ctl */
45 #define CS35L35_BST_PEAK_I		0x1E	/* Boost Conv Peak Current */
46 #define CS35L35_BST_RAMP_CTL		0x20	/* Boost Conv Soft Ramp Ctl */
47 #define CS35L35_BST_CONV_COEF_1		0x21	/* Boost Conv Coefficients 1 */
48 #define CS35L35_BST_CONV_COEF_2		0x22	/* Boost Conv Coefficients 2 */
49 #define CS35L35_BST_CONV_SLOPE_COMP	0x23	/* Boost Conv Slope Comp */
50 #define CS35L35_BST_CONV_SW_FREQ	0x24	/* Boost Conv L BST SW Freq */
51 #define CS35L35_CLASS_H_CTL		0x30	/* CLS H Control */
52 #define CS35L35_CLASS_H_HEADRM_CTL	0x31	/* CLS H Headroom Ctl */
53 #define CS35L35_CLASS_H_RELEASE_RATE	0x32	/* CLS H Release Rate */
54 #define CS35L35_CLASS_H_FET_DRIVE_CTL	0x33	/* CLS H Weak FET Drive Ctl */
55 #define CS35L35_CLASS_H_VP_CTL		0x34	/* CLS H VP Ctl */
56 #define CS35L35_CLASS_H_STATUS		0x38	/* CLS H Status */
57 #define CS35L35_VPBR_CTL		0x3A	/* VPBR Ctl */
58 #define CS35L35_VPBR_VOL_CTL		0x3B	/* VPBR Volume Ctl */
59 #define CS35L35_VPBR_TIMING_CTL		0x3C	/* VPBR Timing Ctl */
60 #define CS35L35_VPBR_MODE_VOL_CTL	0x3D	/* VPBR Mode/Attack Vol Ctl */
61 #define CS35L35_VPBR_ATTEN_STATUS	0x4B	/* VPBR Attenuation Status */
62 #define CS35L35_SPKR_MON_CTL		0x4E	/* Speaker Monitoring Ctl */
63 #define CS35L35_IMON_SCALE_CTL		0x51	/* IMON Scale Ctl */
64 #define CS35L35_AUDIN_RXLOC_CTL		0x52	/* Audio Input RX Loc Ctl */
65 #define CS35L35_ADVIN_RXLOC_CTL		0x53	/* Advisory Input RX Loc Ctl */
66 #define CS35L35_VMON_TXLOC_CTL		0x54	/* VMON TX Loc Ctl */
67 #define CS35L35_IMON_TXLOC_CTL		0x55	/* IMON TX Loc Ctl */
68 #define CS35L35_VPMON_TXLOC_CTL		0x56	/* VPMON TX Loc Ctl */
69 #define CS35L35_VBSTMON_TXLOC_CTL	0x57	/* VBSTMON TX Loc Ctl */
70 #define CS35L35_VPBR_STATUS_TXLOC_CTL	0x58	/* VPBR Status TX Loc Ctl */
71 #define CS35L35_ZERO_FILL_LOC_CTL	0x59	/* Zero Fill Loc Ctl */
72 #define CS35L35_AUDIN_DEPTH_CTL		0x5A	/* Audio Input Depth Ctl */
73 #define CS35L35_SPKMON_DEPTH_CTL	0x5B	/* SPK Mon Output Depth Ctl */
74 #define CS35L35_SUPMON_DEPTH_CTL	0x5C	/* Supply Mon Out Depth Ctl */
75 #define CS35L35_ZEROFILL_DEPTH_CTL	0x5D	/* Zero Fill Mon Output Ctl */
76 #define CS35L35_MULT_DEV_SYNCH1		0x62	/* Multidevice Synch */
77 #define CS35L35_MULT_DEV_SYNCH2		0x63	/* Multidevice Synch 2 */
78 #define CS35L35_PROT_RELEASE_CTL	0x64	/* Protection Release Ctl */
79 #define CS35L35_DIAG_MODE_REG_LOCK	0x68	/* Diagnostic Mode Reg Lock */
80 #define CS35L35_DIAG_MODE_CTL_1		0x69	/* Diagnostic Mode Ctl 1 */
81 #define CS35L35_DIAG_MODE_CTL_2		0x6A	/* Diagnostic Mode Ctl 2 */
82 #define CS35L35_INT_MASK_1		0x70	/* Interrupt Mask 1 */
83 #define CS35L35_INT_MASK_2		0x71	/* Interrupt Mask 2 */
84 #define CS35L35_INT_MASK_3		0x72	/* Interrupt Mask 3 */
85 #define CS35L35_INT_MASK_4		0x73	/* Interrupt Mask 4 */
86 #define CS35L35_INT_STATUS_1		0x74	/* Interrupt Status 1 */
87 #define CS35L35_INT_STATUS_2		0x75	/* Interrupt Status 2 */
88 #define CS35L35_INT_STATUS_3		0x76	/* Interrupt Status 3 */
89 #define CS35L35_INT_STATUS_4		0x77	/* Interrupt Status 4 */
90 #define CS35L35_PLL_STATUS		0x78	/* PLL Status */
91 #define CS35L35_OTP_TRIM_STATUS		0x7E	/* OTP Trim Status */
92 
93 #define CS35L35_MAX_REGISTER		0x7F
94 
95 /* CS35L35_PWRCTL1 */
96 #define CS35L35_SFT_RST			0x80
97 #define CS35L35_DISCHG_FLT		0x02
98 #define CS35L35_PDN_ALL			0x01
99 
100 /* CS35L35_PWRCTL2 */
101 #define CS35L35_PDN_VMON		0x80
102 #define CS35L35_PDN_IMON		0x40
103 #define CS35L35_PDN_CLASSH		0x20
104 #define CS35L35_PDN_VPBR		0x10
105 #define CS35L35_PDN_BST			0x04
106 #define CS35L35_PDN_AMP			0x01
107 
108 /* CS35L35_PWRCTL3 */
109 #define CS35L35_PDN_VBSTMON_OUT		0x10
110 #define CS35L35_PDN_VMON_OUT		0x08
111 
112 #define CS35L35_AUDIN_DEPTH_MASK	0x03
113 #define CS35L35_AUDIN_DEPTH_SHIFT	0
114 #define CS35L35_ADVIN_DEPTH_MASK	0x0C
115 #define CS35L35_ADVIN_DEPTH_SHIFT	2
116 #define CS35L35_SDIN_DEPTH_8		0x01
117 #define CS35L35_SDIN_DEPTH_16		0x02
118 #define CS35L35_SDIN_DEPTH_24		0x03
119 
120 #define CS35L35_SDOUT_DEPTH_8		0x01
121 #define CS35L35_SDOUT_DEPTH_12		0x02
122 #define CS35L35_SDOUT_DEPTH_16		0x03
123 
124 #define CS35L35_AUD_IN_LR_MASK		0x80
125 #define CS35L35_AUD_IN_LR_SHIFT		7
126 #define CS35L35_ADV_IN_LR_MASK		0x80
127 #define CS35L35_ADV_IN_LR_SHIFT		7
128 #define CS35L35_AUD_IN_LOC_MASK		0x0F
129 #define CS35L35_AUD_IN_LOC_SHIFT	0
130 #define CS35L35_ADV_IN_LOC_MASK		0x0F
131 #define CS35L35_ADV_IN_LOC_SHIFT	0
132 
133 #define CS35L35_IMON_DEPTH_MASK		0x03
134 #define CS35L35_IMON_DEPTH_SHIFT	0
135 #define CS35L35_VMON_DEPTH_MASK		0x0C
136 #define CS35L35_VMON_DEPTH_SHIFT	2
137 #define CS35L35_VBSTMON_DEPTH_MASK	0x03
138 #define CS35L35_VBSTMON_DEPTH_SHIFT	0
139 #define CS35L35_VPMON_DEPTH_MASK	0x0C
140 #define CS35L35_VPMON_DEPTH_SHIFT	2
141 #define CS35L35_VPBRSTAT_DEPTH_MASK	0x30
142 #define CS35L35_VPBRSTAT_DEPTH_SHIFT	4
143 #define CS35L35_ZEROFILL_DEPTH_MASK	0x03
144 #define CS35L35_ZEROFILL_DEPTH_SHIFT	0x00
145 
146 #define CS35L35_MON_TXLOC_MASK		0x3F
147 #define CS35L35_MON_TXLOC_SHIFT		0
148 #define CS35L35_MON_FRM_MASK		0x80
149 #define CS35L35_MON_FRM_SHIFT		7
150 
151 #define CS35L35_IMON_SCALE_MASK		0xF8
152 #define CS35L35_IMON_SCALE_SHIFT	3
153 
154 #define CS35L35_MS_MASK			0x80
155 #define CS35L35_MS_SHIFT		7
156 #define CS35L35_SPMODE_MASK		0x40
157 #define CS35L35_SP_DRV_MASK		0x10
158 #define CS35L35_SP_DRV_SHIFT		4
159 #define CS35L35_CLK_CTL2_MASK		0xFF
160 #define CS35L35_PDM_MODE_MASK		0x40
161 #define CS35L35_PDM_MODE_SHIFT		6
162 #define CS35L35_CLK_SOURCE_MASK		0x03
163 #define CS35L35_CLK_SOURCE_SHIFT	0
164 #define CS35L35_CLK_SOURCE_MCLK		0
165 #define CS35L35_CLK_SOURCE_SCLK		1
166 #define CS35L35_CLK_SOURCE_PDM		2
167 
168 #define CS35L35_SP_SCLKS_MASK		0x0F
169 #define CS35L35_SP_SCLKS_SHIFT		0x00
170 #define CS35L35_SP_SCLKS_16FS		0x03
171 #define CS35L35_SP_SCLKS_32FS		0x07
172 #define CS35L35_SP_SCLKS_48FS		0x0B
173 #define CS35L35_SP_SCLKS_64FS		0x0F
174 #define CS35L35_SP_RATE_MASK		0xC0
175 
176 #define CS35L35_PDN_BST_MASK		0x06
177 #define CS35L35_PDN_BST_FETON_SHIFT	1
178 #define CS35L35_PDN_BST_FETOFF_SHIFT	2
179 #define CS35L35_PWR2_PDN_MASK		0xE0
180 #define CS35L35_PWR3_PDN_MASK		0x1E
181 #define CS35L35_PDN_ALL_MASK		0x01
182 #define CS35L35_DISCHG_FILT_MASK	0x02
183 #define CS35L35_DISCHG_FILT_SHIFT	1
184 #define CS35L35_MCLK_DIS_MASK		0x04
185 #define CS35L35_MCLK_DIS_SHIFT		2
186 
187 #define CS35L35_BST_CTL_MASK		0x7F
188 #define CS35L35_BST_CTL_SHIFT		0
189 #define CS35L35_BST_IPK_MASK		0x1F
190 #define CS35L35_BST_IPK_SHIFT		0
191 #define CS35L35_AMP_MUTE_MASK		0x20
192 #define CS35L35_AMP_MUTE_SHIFT		5
193 #define CS35L35_AMP_GAIN_ZC_MASK	0x10
194 #define CS35L35_AMP_GAIN_ZC_SHIFT	4
195 
196 #define CS35L35_AMP_DIGSFT_MASK		0x02
197 #define CS35L35_AMP_DIGSFT_SHIFT	1
198 
199 /* CS35L35_SP_FMT_CTL3 */
200 #define CS35L35_SP_I2S_DRV_MASK		0x03
201 #define CS35L35_SP_I2S_DRV_SHIFT	0
202 
203 /* Boost Converter Config */
204 #define CS35L35_BST_CONV_COEFF_MASK	0xFF
205 #define CS35L35_BST_CONV_SLOPE_MASK	0xFF
206 #define CS35L35_BST_CONV_LBST_MASK	0x03
207 #define CS35L35_BST_CONV_SWFREQ_MASK	0xF0
208 
209 /* Class H Algorithm Control */
210 #define CS35L35_CH_STEREO_MASK		0x40
211 #define CS35L35_CH_STEREO_SHIFT		6
212 #define CS35L35_CH_BST_OVR_MASK		0x04
213 #define CS35L35_CH_BST_OVR_SHIFT	2
214 #define CS35L35_CH_BST_LIM_MASK		0x08
215 #define CS35L35_CH_BST_LIM_SHIFT	3
216 #define CS35L35_CH_MEM_DEPTH_MASK	0x01
217 #define CS35L35_CH_MEM_DEPTH_SHIFT	0
218 #define CS35L35_CH_HDRM_CTL_MASK	0x3F
219 #define CS35L35_CH_HDRM_CTL_SHIFT	0
220 #define CS35L35_CH_REL_RATE_MASK	0xFF
221 #define CS35L35_CH_REL_RATE_SHIFT	0
222 #define CS35L35_CH_WKFET_DIS_MASK	0x80
223 #define CS35L35_CH_WKFET_DIS_SHIFT	7
224 #define CS35L35_CH_WKFET_DEL_MASK	0x70
225 #define CS35L35_CH_WKFET_DEL_SHIFT	4
226 #define CS35L35_CH_WKFET_THLD_MASK	0x0F
227 #define CS35L35_CH_WKFET_THLD_SHIFT	0
228 #define CS35L35_CH_VP_AUTO_MASK		0x80
229 #define CS35L35_CH_VP_AUTO_SHIFT	7
230 #define CS35L35_CH_VP_RATE_MASK		0x60
231 #define CS35L35_CH_VP_RATE_SHIFT	5
232 #define CS35L35_CH_VP_MAN_MASK		0x1F
233 #define CS35L35_CH_VP_MAN_SHIFT		0
234 
235 /* CS35L35_PROT_RELEASE_CTL */
236 #define CS35L35_CAL_ERR_RLS		0x80
237 #define CS35L35_SHORT_RLS		0x04
238 #define CS35L35_OTW_RLS			0x02
239 #define CS35L35_OTE_RLS			0x01
240 
241 /* INT Mask Registers */
242 #define CS35L35_INT1_CRIT_MASK		0x38
243 #define CS35L35_INT2_CRIT_MASK		0xEF
244 #define CS35L35_INT3_CRIT_MASK		0xEE
245 #define CS35L35_INT4_CRIT_MASK		0xFF
246 
247 /* PDN DONE Masks */
248 #define CS35L35_M_PDN_DONE_SHIFT	4
249 #define CS35L35_M_PDN_DONE_MASK		0x10
250 
251 /* CS35L35_INT_1 */
252 #define CS35L35_CAL_ERR			0x80
253 #define CS35L35_OTP_ERR			0x40
254 #define CS35L35_LRCLK_ERR		0x20
255 #define CS35L35_SPCLK_ERR		0x10
256 #define CS35L35_MCLK_ERR		0x08
257 #define CS35L35_AMP_SHORT		0x04
258 #define CS35L35_OTW			0x02
259 #define CS35L35_OTE			0x01
260 
261 /* CS35L35_INT_2 */
262 #define CS35L35_PDN_DONE		0x10
263 #define CS35L35_VPBR_ERR		0x02
264 #define CS35L35_VPBR_CLR		0x01
265 
266 /* CS35L35_INT_3 */
267 #define CS35L35_BST_HIGH		0x10
268 #define CS35L35_BST_HIGH_FLAG		0x08
269 #define CS35L35_BST_IPK_FLAG		0x04
270 #define CS35L35_LBST_SHORT		0x01
271 
272 /* CS35L35_INT_4 */
273 #define CS35L35_VMON_OVFL		0x08
274 #define CS35L35_IMON_OVFL		0x04
275 
276 #define CS35L35_FORMATS (SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S16_LE | \
277 			SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
278 
279 struct  cs35l35_private {
280 	struct device *dev;
281 	struct cs35l35_platform_data pdata;
282 	struct regmap *regmap;
283 	struct regulator_bulk_data supplies[2];
284 	int num_supplies;
285 	int sysclk;
286 	int sclk;
287 	bool pdm_mode;
288 	bool i2s_mode;
289 	bool slave_mode;
290 	/* GPIO for /RST */
291 	struct gpio_desc *reset_gpio;
292 	struct completion pdn_done;
293 };
294 
295 static const char * const cs35l35_supplies[] = {
296 	"VA",
297 	"VP",
298 };
299 
300 #endif
301