audio: a2220: Handle probe failure
[linux-2.6.git] / include / linux / a2220.h
1 /* include/linux/a2220.h - a2220 voice processor driver
2  *
3  * Copyright (C) 2009 HTC Corporation.
4  *
5  * This software is licensed under the terms of the GNU General Public
6  * License version 2, as published by the Free Software Foundation, and
7  * may be copied, distributed, and modified under those terms.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  */
15
16 #ifndef __LINUX_A2220_H
17 #define __LINUX_A2220_H
18
19 #include <linux/ioctl.h>
20
21 #ifdef CONFIG_USA_OPERATOR_TMO
22 #define AUDIENCE_BYPASS 1
23 #endif
24
25 #define CONFIG_USA_MODEL_SGH_I727 0
26
27 #define CONFIG_VP_A2220
28 #define CONFIG_USA_MODEL_SGH_I717  1
29 #ifdef CONFIG_USA_MODEL_SGH_I717
30 #define AUDIENCE_BYPASS 1
31 #endif
32
33 #ifdef CONFIG_VP_A2220
34 #define GPIO_SELECT_I2S_AUDIENCE_QTR 124
35 extern unsigned int get_hw_rev(void);
36 #endif
37
38 int a2220_ioctl2(unsigned int cmd, unsigned long arg);
39 extern int a2220_port_path_change(unsigned int msg);
40
41 extern bool dualmic_enabled;
42
43 #ifdef CONFIG_BATTERY_SEC
44 extern unsigned int is_lpcharging_state(void);
45 #endif
46
47 #define A2220_MAX_FW_SIZE       (32*1024)
48 struct a2220img {
49         unsigned char *buf;
50         unsigned img_size;
51 };
52
53 enum A2220_PathID {
54         A2220_PATH_SUSPEND,
55         A2220_PATH_INCALL_RECEIVER_NSON,
56         A2220_PATH_INCALL_RECEIVER_NSOFF,
57         A2220_PATH_INCALL_HEADSET,
58         A2220_PATH_INCALL_SPEAKER,
59         A2220_PATH_INCALL_BT,
60         A2220_PATH_VR_NO_NS_RECEIVER,
61         A2220_PATH_VR_NO_NS_HEADSET,
62         A2220_PATH_VR_NO_NS_SPEAKER,
63         A2220_PATH_VR_NO_NS_BT,
64         A2220_PATH_VR_NS_RECEIVER,
65         A2220_PATH_VR_NS_HEADSET,
66         A2220_PATH_VR_NS_SPEAKER,
67         A2220_PATH_VR_NS_BT,
68         A2220_PATH_RECORD_RECEIVER,
69         A2220_PATH_RECORD_HEADSET,
70         A2220_PATH_RECORD_SPEAKER,
71         A2220_PATH_RECORD_BT,
72         A2220_PATH_CAMCORDER,
73         A2220_PATH_INCALL_TTY,
74 #ifdef AUDIENCE_BYPASS
75         A2220_PATH_BYPASS_MULTIMEDIA
76 #endif
77 };
78
79 /* noise suppression states */
80 enum A2220_NS_states {
81         A2220_NS_STATE_AUTO,    /* leave mode as selected by driver  */
82         A2220_NS_STATE_OFF,     /* disable noise suppression */
83         A2220_NS_STATE_CT,      /* force close talk mode */
84         A2220_NS_STATE_FT,      /* force far talk mode */
85         A2220_NS_NUM_STATES
86 };
87
88 /* indicates if a2220_set_config() performs a full configuration or only
89  * a voice processing algorithm configuration */
90 /* IOCTLs for Audience A2220 */
91 #define A2220_IOCTL_MAGIC 'u'
92
93 #define A2220_BOOTUP_INIT  _IOW(A2220_IOCTL_MAGIC, 0x01, struct a2220img *)
94 #define A2220_SET_CONFIG   _IOW(A2220_IOCTL_MAGIC, 0x02, enum A2220_PathID)
95 #define A2220_SET_NS_STATE _IOW(A2220_IOCTL_MAGIC, 0x03, enum A2220_NS_states)
96
97 /* For Diag */
98 #define A2220_SET_MIC_ONOFF     _IOW(A2220_IOCTL_MAGIC, 0x50, unsigned)
99 #define A2220_SET_MICSEL_ONOFF  _IOW(A2220_IOCTL_MAGIC, 0x51, unsigned)
100 #define A2220_READ_DATA         _IOR(A2220_IOCTL_MAGIC, 0x52, unsigned)
101 #define A2220_WRITE_MSG         _IOW(A2220_IOCTL_MAGIC, 0x53, unsigned)
102 #define A2220_SYNC_CMD          _IO(A2220_IOCTL_MAGIC, 0x54)
103 #define A2220_SET_CMD_FILE      _IOW(A2220_IOCTL_MAGIC, 0x55, unsigned)
104
105 #ifdef __KERNEL__
106
107 /* A2220 Command codes */
108 #define CtrlMode_LAL            0x0001  /* Level Active Low  */
109 #define CtrlMode_LAH            0x0002  /* Level Active High */
110 #define CtrlMode_FE             0x0003  /* Falling Edge */
111 #define CtrlMode_RE             0x0004  /* Rising  Edge */
112 #define A100_msg_Sync           0x80000000
113 #define A100_msg_Sync_Ack       0x80000000
114
115 #define A100_msg_ReadPortA      0x800B0A07
116
117 /* add the port path if needed */
118 #define A100_msg_PortC_A_PASS   0x805200E2
119 #define A100_msg_PortA_C_PASS   0x805200C8
120
121 #define A100_msg_PortC_D_PASS   0x805200EE
122 #define A100_msg_PortD_C_PASS   0x805200FB
123
124 #define A100_msg_PortB_A_PASS   0x805200D1
125 #define A100_msg_PortA_B_PASS   0x805200C4
126
127 #define A100_msg_Reset          0x8002
128 #define RESET_IMMEDIATE         0x0000
129 #define RESET_DELAYED           0x0001
130
131 #define A100_msg_BootloadInitiate       0x8003
132 #define A100_msg_GetDeviceParm          0x800B
133 #define A100_msg_SetDeviceParmID        0x800C
134 #define A100_msg_SetDeviceParm          0x800D
135
136 /* Get/Set PCM Device Parameter ID List */
137 /* PCM-0 */
138 #define PCM0WordLength          0x0100
139 #define PCM0DelFromFsTx         0x0101
140 #define PCM0DelFromFsRx         0x0102
141 #define PCM0LatchEdge           0x0103
142 #define PCM0Endianness          0x0105
143 #define PCM0TristateEnable      0x0107
144
145 /* PCM-1 */
146 #define PCM1WordLength          0x0200
147 #define PCM1DelFromFsTx         0x0201
148 #define PCM1DelFromFsRx         0x0202
149 #define PCM1LatchEdge           0x0203
150 #define PCM1Endianness          0x0205
151 #define PCM1TristateEnable      0x0207
152
153 /* Possible setting values for PCM I/F */
154 #define PCMWordLength_16bit     0x10    /* Default */
155 #define PCMWordLength_24bit     0x18
156 #define PCMWordLength_32bit     0x20
157 #define PCMLatchEdge_Tx_F_Rx_R  0x00    /* Tx/Rx on falling/rising edge */
158 #define PCMLatchEdge_Tx_R_Rx_F  0x03    /* Tx/Rx on falling/rising edge */
159 #define PCMEndianness_Little    0x00
160 #define PCMEndianness_Big       0x01    /* Default */
161 #define PCMTristate_Disable     0x00    /* Default */
162 #define PCMTristate_Enable      0x01
163
164 /* Get/Set ADC Device Parameter ID List */
165 /* ADC-0 */
166 #define ADC0Gain        0x0300
167 #define ADC0Rate        0x0301
168 #define ADC0CutoffFreq  0x0302
169
170 /* ADC-1 */
171 #define ADC1Gain        0x0400
172 #define ADC1Rate        0x0401
173 #define ADC1CutoffFreq  0x0402
174
175 /* Possible setting values for ADC I/F */
176 #define ADC_Gain_0db                    0x00
177 #define ADC_Gain_6db                    0x01
178 #define ADC_Gain_12db                   0x02
179 #define ADC_Gain_18db                   0x03
180 #define ADC_Gain_24db                   0x04    /* Default */
181 #define ADC_Gain_30db                   0x05
182 #define ADC_Rate_8kHz                   0x00    /* Default */
183 #define ADC_Rate_16kHz                  0x01
184 #define ADC_CutoffFreq_NO_DC_Filter     0x00
185 #define ADC_CutoffFreq_59p68Hz          0x01    /* Default */
186 #define ADC_CutoffFreq_7p46Hz           0x02
187 #define ADC_CutoffFreq_3p73Hz           0x03
188
189 /* Set Power State */
190 #define A100_msg_Sleep          0x80100001
191
192 /* Get/Set Algorithm Parameter command codes list */
193 #define A100_msg_GetAlgorithmParm       0x8016
194 #define A100_msg_SetAlgorithmParmID     0x8017
195 #define A100_msg_SetAlgorithmParm       0x8018
196
197 /* Get/Set Algorithm Parameter ID List (Transmit Feature) */
198 #define AIS_Global_Supression_Level     0x0000
199 #define Mic_Config                      0x0002
200 #define AEC_Mode                        0x0003
201 #define AEC_CNG                         0x0023
202 #define Output_AGC                      0x0004
203 #define Output_AGC_Target_Level         0x0005
204 #define Output_AGC_Noise_Floor          0x0006
205 #define Output_AGC_SNR_Improvement      0x0007
206 #define Comfort_Noise                   0x001A
207 #define Comfort_Noise_Level             0x001B
208
209 /* Get/Set Algorithm Parameter ID List (Receive Feature) */
210 #define Speaker_Volume                  0x0012
211 #define VEQ_Mode                        0x0009
212 #define VEQ_Max_FarEnd_Limiter_Level    0x000D
213 #define VEQ_Noise_Estimation_Adj        0x0025
214 #define Receive_NS                      0x000E
215 #define Receive_NS_Level                0x000F
216 #define SideTone                        0x0015
217 #define SideTone_Gain                   0x0016
218
219 /* Audio Path Commands */
220 /* Get/Set Transmit Digital Input Gain */
221 #define A100_msg_GetTxDigitalInputGain  0x801A
222 #define A100_msg_SetTxDigitalInputGain  0x801B
223
224 /* Get/Set Receive Digital Input Gain */
225 #define A100_msg_GetRcvDigitalInputGain 0x8022
226 #define A100_msg_SetRcvDigitalInputGain 0x8023
227
228 /* Get/Set Transmit Digital Output Gain */
229 #define A100_msg_GetTxDigitalOutputGain 0x801D
230 #define A100_msg_SetTxDigitalOutputGain 0x8015
231
232 /* Bypass */
233 #define A100_msg_Bypass         0x801C /* 0ff = 0x0000;
234 on = 0x0001 (Default) */
235 #define A2220_msg_VP_ON         0x801C0001
236 #define A2220_msg_VP_OFF        0x801C0000
237
238 /* Diagnostic API Commands */
239 #define A100_msg_GetMicRMS      0x8013
240 #define A100_msg_GetMicPeak     0x8014
241 #define DiagPath_Pri_Input_Mic  0x0000
242 #define DiagPath_Sec_Input_Mic  0x0001
243 #define DiagPath_Output_Mic     0x0002
244 #define DiagPath_Far_End_Input  0x0003
245 #define DiagPath_Far_End_Output 0x0004
246 #define A100_msg_SwapInputCh    0x8019
247 #define A100_msg_OutputKnownSig 0x801E
248
249 #define A2220_msg_BOOT          0x0001
250 #define A2220_msg_BOOT_ACK      0x01
251
252 /* general definitions */
253 #define TIMEOUT                 20      /* ms */
254 #define RETRY_CNT               1
255 #define POLLING_RETRY_CNT       3
256 #define A2220_ERROR_CODE        0xffff
257 #define A2220_SLEEP             0
258 #define A2220_ACTIVE            1
259 #define A2220_CMD_FIFO_DEPTH    64
260 #define ERROR                   0xffffffff
261
262 enum A2220_config_mode {
263         A2220_CONFIG_FULL,
264         A2220_CONFIG_VP
265 };
266
267 struct a2220_platform_data {
268         uint32_t gpio_a2220_micsel;
269         uint32_t gpio_a2220_wakeup;
270         uint32_t gpio_a2220_reset;
271         uint32_t gpio_a2220_int;
272         uint32_t gpio_a2220_clk;
273         uint32_t gpio_a2220_audience_chip_sel;
274 };
275
276 #endif                          /* __KERNEL__ */
277 #endif                          /* __LINUX_A2220_H */