mm: Don't pin ZERO_PAGE in pin_user_pages()
[linux-block.git] / include / sound / cs35l56.h
CommitLineData
e4961125
RF
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Common definitions for Cirrus Logic CS35L56 smart amp
4 *
5 * Copyright (C) 2023 Cirrus Logic, Inc. and
6 * Cirrus Logic International Semiconductor Ltd.
7 */
8
9#ifndef __CS35L56_H
10#define __CS35L56_H
11
12#include <linux/firmware/cirrus/cs_dsp.h>
13#include <linux/regulator/consumer.h>
14#include <linux/regmap.h>
15
16#define CS35L56_DEVID 0x0000000
17#define CS35L56_REVID 0x0000004
18#define CS35L56_RELID 0x000000C
19#define CS35L56_OTPID 0x0000010
20#define CS35L56_SFT_RESET 0x0000020
21#define CS35L56_GLOBAL_ENABLES 0x0002014
22#define CS35L56_BLOCK_ENABLES 0x0002018
23#define CS35L56_BLOCK_ENABLES2 0x000201C
24#define CS35L56_REFCLK_INPUT 0x0002C04
25#define CS35L56_GLOBAL_SAMPLE_RATE 0x0002C0C
26#define CS35L56_ASP1_ENABLES1 0x0004800
27#define CS35L56_ASP1_CONTROL1 0x0004804
28#define CS35L56_ASP1_CONTROL2 0x0004808
29#define CS35L56_ASP1_CONTROL3 0x000480C
30#define CS35L56_ASP1_FRAME_CONTROL1 0x0004810
31#define CS35L56_ASP1_FRAME_CONTROL5 0x0004820
32#define CS35L56_ASP1_DATA_CONTROL1 0x0004830
33#define CS35L56_ASP1_DATA_CONTROL5 0x0004840
34#define CS35L56_DACPCM1_INPUT 0x0004C00
35#define CS35L56_DACPCM2_INPUT 0x0004C08
36#define CS35L56_ASP1TX1_INPUT 0x0004C20
37#define CS35L56_ASP1TX2_INPUT 0x0004C24
38#define CS35L56_ASP1TX3_INPUT 0x0004C28
39#define CS35L56_ASP1TX4_INPUT 0x0004C2C
40#define CS35L56_DSP1RX1_INPUT 0x0004C40
41#define CS35L56_DSP1RX2_INPUT 0x0004C44
42#define CS35L56_SWIRE_DP3_CH1_INPUT 0x0004C70
43#define CS35L56_SWIRE_DP3_CH2_INPUT 0x0004C74
44#define CS35L56_SWIRE_DP3_CH3_INPUT 0x0004C78
45#define CS35L56_SWIRE_DP3_CH4_INPUT 0x0004C7C
e4961125
RF
46#define CS35L56_IRQ1_CFG 0x000E000
47#define CS35L56_IRQ1_STATUS 0x000E004
48#define CS35L56_IRQ1_EINT_1 0x000E010
49#define CS35L56_IRQ1_EINT_2 0x000E014
50#define CS35L56_IRQ1_EINT_4 0x000E01C
51#define CS35L56_IRQ1_EINT_8 0x000E02C
52#define CS35L56_IRQ1_EINT_18 0x000E054
53#define CS35L56_IRQ1_EINT_20 0x000E05C
54#define CS35L56_IRQ1_MASK_1 0x000E090
55#define CS35L56_IRQ1_MASK_2 0x000E094
56#define CS35L56_IRQ1_MASK_4 0x000E09C
57#define CS35L56_IRQ1_MASK_8 0x000E0AC
58#define CS35L56_IRQ1_MASK_18 0x000E0D4
59#define CS35L56_IRQ1_MASK_20 0x000E0DC
60#define CS35L56_DSP_VIRTUAL1_MBOX_1 0x0011020
61#define CS35L56_DSP_VIRTUAL1_MBOX_2 0x0011024
62#define CS35L56_DSP_VIRTUAL1_MBOX_3 0x0011028
63#define CS35L56_DSP_VIRTUAL1_MBOX_4 0x001102C
64#define CS35L56_DSP_VIRTUAL1_MBOX_5 0x0011030
65#define CS35L56_DSP_VIRTUAL1_MBOX_6 0x0011034
66#define CS35L56_DSP_VIRTUAL1_MBOX_7 0x0011038
67#define CS35L56_DSP_VIRTUAL1_MBOX_8 0x001103C
68#define CS35L56_DSP_RESTRICT_STS1 0x00190F0
69#define CS35L56_DSP1_XMEM_PACKED_0 0x2000000
70#define CS35L56_DSP1_XMEM_PACKED_6143 0x2005FFC
71#define CS35L56_DSP1_XMEM_UNPACKED32_0 0x2400000
72#define CS35L56_DSP1_XMEM_UNPACKED32_4095 0x2403FFC
73#define CS35L56_DSP1_SYS_INFO_ID 0x25E0000
74#define CS35L56_DSP1_SYS_INFO_END 0x25E004C
75#define CS35L56_DSP1_AHBM_WINDOW_DEBUG_0 0x25E2040
76#define CS35L56_DSP1_AHBM_WINDOW_DEBUG_1 0x25E2044
77#define CS35L56_DSP1_XMEM_UNPACKED24_0 0x2800000
78#define CS35L56_DSP1_HALO_STATE_A1 0x2801E58
79#define CS35L56_DSP1_HALO_STATE 0x28021E0
80#define CS35L56_DSP1_PM_CUR_STATE_A1 0x2804000
81#define CS35L56_DSP1_PM_CUR_STATE 0x2804308
82#define CS35L56_DSP1_XMEM_UNPACKED24_8191 0x2807FFC
83#define CS35L56_DSP1_CORE_BASE 0x2B80000
84#define CS35L56_DSP1_SCRATCH1 0x2B805C0
85#define CS35L56_DSP1_SCRATCH2 0x2B805C8
86#define CS35L56_DSP1_SCRATCH3 0x2B805D0
87#define CS35L56_DSP1_SCRATCH4 0x2B805D8
88#define CS35L56_DSP1_YMEM_PACKED_0 0x2C00000
89#define CS35L56_DSP1_YMEM_PACKED_4604 0x2C047F0
90#define CS35L56_DSP1_YMEM_UNPACKED32_0 0x3000000
91#define CS35L56_DSP1_YMEM_UNPACKED32_3070 0x3002FF8
92#define CS35L56_DSP1_YMEM_UNPACKED24_0 0x3400000
93#define CS35L56_MAIN_RENDER_USER_MUTE 0x3400024
94#define CS35L56_MAIN_RENDER_USER_VOLUME 0x340002C
95#define CS35L56_MAIN_POSTURE_NUMBER 0x3400094
59322d35 96#define CS35L56_PROTECTION_STATUS 0x34000D8
e4961125
RF
97#define CS35L56_TRANSDUCER_ACTUAL_PS 0x3400150
98#define CS35L56_DSP1_YMEM_UNPACKED24_6141 0x3405FF4
99#define CS35L56_DSP1_PMEM_0 0x3800000
100#define CS35L56_DSP1_PMEM_5114 0x3804FE8
101
102/* DEVID */
103#define CS35L56_DEVID_MASK 0x00FFFFFF
104
105/* REVID */
106#define CS35L56_AREVID_MASK 0x000000F0
107#define CS35L56_MTLREVID_MASK 0x0000000F
108#define CS35L56_REVID_B0 0x000000B0
109
110/* ASP_ENABLES1 */
111#define CS35L56_ASP_RX2_EN_SHIFT 17
112#define CS35L56_ASP_RX1_EN_SHIFT 16
113#define CS35L56_ASP_TX4_EN_SHIFT 3
114#define CS35L56_ASP_TX3_EN_SHIFT 2
115#define CS35L56_ASP_TX2_EN_SHIFT 1
116#define CS35L56_ASP_TX1_EN_SHIFT 0
117
118/* ASP_CONTROL1 */
119#define CS35L56_ASP_BCLK_FREQ_MASK 0x0000003F
120#define CS35L56_ASP_BCLK_FREQ_SHIFT 0
121
122/* ASP_CONTROL2 */
123#define CS35L56_ASP_RX_WIDTH_MASK 0xFF000000
124#define CS35L56_ASP_RX_WIDTH_SHIFT 24
125#define CS35L56_ASP_TX_WIDTH_MASK 0x00FF0000
126#define CS35L56_ASP_TX_WIDTH_SHIFT 16
127#define CS35L56_ASP_FMT_MASK 0x00000700
128#define CS35L56_ASP_FMT_SHIFT 8
129#define CS35L56_ASP_BCLK_INV_MASK 0x00000040
130#define CS35L56_ASP_FSYNC_INV_MASK 0x00000004
131
132/* ASP_CONTROL3 */
133#define CS35L56_ASP1_DOUT_HIZ_CTRL_MASK 0x00000003
134
135/* ASP_DATA_CONTROL1 */
136#define CS35L56_ASP_TX_WL_MASK 0x0000003F
137
138/* ASP_DATA_CONTROL5 */
139#define CS35L56_ASP_RX_WL_MASK 0x0000003F
140
141/* ASPTXn_INPUT */
142#define CS35L56_ASP_TXn_SRC_MASK 0x0000007F
143
144/* SWIRETX[1..7]_SRC SDWTXn INPUT */
145#define CS35L56_SWIRETXn_SRC_MASK 0x0000007F
146
147/* IRQ1_STATUS */
148#define CS35L56_IRQ1_STS_MASK 0x00000001
149
150/* IRQ1_EINT_1 */
151#define CS35L56_AMP_SHORT_ERR_EINT1_MASK 0x80000000
152
153/* IRQ1_EINT_2 */
154#define CS35L56_DSP_VIRTUAL2_MBOX_WR_EINT1_MASK 0x00200000
155
156/* IRQ1_EINT_4 */
157#define CS35L56_OTP_BOOT_DONE_MASK 0x00000002
158
159/* IRQ1_EINT_8 */
160#define CS35L56_TEMP_ERR_EINT1_MASK 0x80000000
161
162/* Mixer input sources */
163#define CS35L56_INPUT_SRC_NONE 0x00
164#define CS35L56_INPUT_SRC_ASP1RX1 0x08
165#define CS35L56_INPUT_SRC_ASP1RX2 0x09
166#define CS35L56_INPUT_SRC_VMON 0x18
167#define CS35L56_INPUT_SRC_IMON 0x19
168#define CS35L56_INPUT_SRC_ERR_VOL 0x20
169#define CS35L56_INPUT_SRC_CLASSH 0x21
170#define CS35L56_INPUT_SRC_VDDBMON 0x28
171#define CS35L56_INPUT_SRC_VBSTMON 0x29
172#define CS35L56_INPUT_SRC_DSP1TX1 0x32
173#define CS35L56_INPUT_SRC_DSP1TX2 0x33
174#define CS35L56_INPUT_SRC_DSP1TX3 0x34
175#define CS35L56_INPUT_SRC_DSP1TX4 0x35
176#define CS35L56_INPUT_SRC_DSP1TX5 0x36
177#define CS35L56_INPUT_SRC_DSP1TX6 0x37
178#define CS35L56_INPUT_SRC_DSP1TX7 0x38
179#define CS35L56_INPUT_SRC_DSP1TX8 0x39
180#define CS35L56_INPUT_SRC_TEMPMON 0x3A
181#define CS35L56_INPUT_SRC_INTERPOLATOR 0x40
d29a966b
RF
182#define CS35L56_INPUT_SRC_SWIRE_DP1_CHANNEL1 0x44
183#define CS35L56_INPUT_SRC_SWIRE_DP1_CHANNEL2 0x45
e4961125
RF
184#define CS35L56_INPUT_MASK 0x7F
185
d3a4efb3 186#define CS35L56_NUM_INPUT_SRC 21
e4961125
RF
187
188/* ASP formats */
189#define CS35L56_ASP_FMT_DSP_A 0
190#define CS35L56_ASP_FMT_I2S 2
191
192/* ASP HiZ modes */
193#define CS35L56_ASP_UNUSED_HIZ_OFF_HIZ 3
194
195/* MAIN_RENDER_ACTUAL_PS */
196#define CS35L56_PS0 0
197#define CS35L56_PS3 3
198
199/* CS35L56_DSP_RESTRICT_STS1 */
200#define CS35L56_RESTRICTED_MASK 0x7
201
202/* CS35L56_MAIN_RENDER_USER_MUTE */
203#define CS35L56_MAIN_RENDER_USER_MUTE_MASK 1
204
205/* CS35L56_MAIN_RENDER_USER_VOLUME */
206#define CS35L56_MAIN_RENDER_USER_VOLUME_MIN -400
207#define CS35L56_MAIN_RENDER_USER_VOLUME_MAX 400
208#define CS35L56_MAIN_RENDER_USER_VOLUME_MASK 0x0000FFC0
209#define CS35L56_MAIN_RENDER_USER_VOLUME_SHIFT 6
210#define CS35L56_MAIN_RENDER_USER_VOLUME_SIGNBIT 9
211
212/* CS35L56_MAIN_POSTURE_NUMBER */
213#define CS35L56_MAIN_POSTURE_MIN 0
214#define CS35L56_MAIN_POSTURE_MAX 255
215#define CS35L56_MAIN_POSTURE_MASK CS35L56_MAIN_POSTURE_MAX
216
59322d35
RF
217/* CS35L56_PROTECTION_STATUS */
218#define CS35L56_FIRMWARE_MISSING BIT(0)
219
e4961125
RF
220/* Software Values */
221#define CS35L56_HALO_STATE_SHUTDOWN 1
222#define CS35L56_HALO_STATE_BOOT_DONE 2
223
224#define CS35L56_MBOX_CMD_AUDIO_PLAY 0x0B000001
225#define CS35L56_MBOX_CMD_AUDIO_PAUSE 0x0B000002
226#define CS35L56_MBOX_CMD_HIBERNATE_NOW 0x02000001
227#define CS35L56_MBOX_CMD_WAKEUP 0x02000002
228#define CS35L56_MBOX_CMD_PREVENT_AUTO_HIBERNATE 0x02000003
229#define CS35L56_MBOX_CMD_ALLOW_AUTO_HIBERNATE 0x02000004
230#define CS35L56_MBOX_CMD_SHUTDOWN 0x02000005
231#define CS35L56_MBOX_CMD_SYSTEM_RESET 0x02000007
232
233#define CS35L56_MBOX_TIMEOUT_US 5000
234#define CS35L56_MBOX_POLL_US 250
235
236#define CS35L56_PS0_POLL_US 500
237#define CS35L56_PS0_TIMEOUT_US 50000
238#define CS35L56_PS3_POLL_US 500
239#define CS35L56_PS3_TIMEOUT_US 300000
240
241#define CS35L56_CONTROL_PORT_READY_US 2200
242#define CS35L56_HALO_STATE_POLL_US 1000
243#define CS35L56_HALO_STATE_TIMEOUT_US 50000
244#define CS35L56_HIBERNATE_WAKE_POLL_US 500
245#define CS35L56_HIBERNATE_WAKE_TIMEOUT_US 5000
246#define CS35L56_RESET_PULSE_MIN_US 1100
247
248#define CS35L56_SDW1_PLAYBACK_PORT 1
249#define CS35L56_SDW1_CAPTURE_PORT 3
250
251#define CS35L56_NUM_BULK_SUPPLIES 3
252#define CS35L56_NUM_DSP_REGIONS 5
253
254extern struct regmap_config cs35l56_regmap_i2c;
255extern struct regmap_config cs35l56_regmap_spi;
256extern struct regmap_config cs35l56_regmap_sdw;
257
258extern const struct cs_dsp_region cs35l56_dsp1_regions[CS35L56_NUM_DSP_REGIONS];
259extern const char * const cs35l56_tx_input_texts[CS35L56_NUM_INPUT_SRC];
260extern const unsigned int cs35l56_tx_input_values[CS35L56_NUM_INPUT_SRC];
261
e4961125
RF
262void cs35l56_reread_firmware_registers(struct device *dev, struct regmap *regmap);
263int cs35l56_get_bclk_freq_id(unsigned int freq);
264void cs35l56_fill_supply_names(struct regulator_bulk_data *data);
265
266#endif /* ifndef __CS35L56_H */