[ALSA] ca0106 - Code clean up
[linux-block.git] / include / sound / ac97_codec.h
CommitLineData
1da177e4
LT
1#ifndef __SOUND_AC97_CODEC_H
2#define __SOUND_AC97_CODEC_H
3
4/*
5 * Copyright (c) by Jaroslav Kysela <perex@suse.cz>
6 * Universal interface for Audio Codec '97
7 *
8 * For more details look to AC '97 component specification revision 2.1
9 * by Intel Corporation (http://developer.intel.com).
10 *
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 *
26 */
27
28#include <linux/bitops.h>
0ca06a00 29#include <linux/device.h>
1da177e4
LT
30#include "pcm.h"
31#include "control.h"
32#include "info.h"
33
34/*
35 * AC'97 codec registers
36 */
37
38#define AC97_RESET 0x00 /* Reset */
39#define AC97_MASTER 0x02 /* Master Volume */
40#define AC97_HEADPHONE 0x04 /* Headphone Volume (optional) */
41#define AC97_MASTER_MONO 0x06 /* Master Volume Mono (optional) */
42#define AC97_MASTER_TONE 0x08 /* Master Tone (Bass & Treble) (optional) */
43#define AC97_PC_BEEP 0x0a /* PC Beep Volume (optinal) */
44#define AC97_PHONE 0x0c /* Phone Volume (optional) */
45#define AC97_MIC 0x0e /* MIC Volume */
46#define AC97_LINE 0x10 /* Line In Volume */
47#define AC97_CD 0x12 /* CD Volume */
48#define AC97_VIDEO 0x14 /* Video Volume (optional) */
49#define AC97_AUX 0x16 /* AUX Volume (optional) */
50#define AC97_PCM 0x18 /* PCM Volume */
51#define AC97_REC_SEL 0x1a /* Record Select */
52#define AC97_REC_GAIN 0x1c /* Record Gain */
53#define AC97_REC_GAIN_MIC 0x1e /* Record Gain MIC (optional) */
54#define AC97_GENERAL_PURPOSE 0x20 /* General Purpose (optional) */
55#define AC97_3D_CONTROL 0x22 /* 3D Control (optional) */
56#define AC97_INT_PAGING 0x24 /* Audio Interrupt & Paging (AC'97 2.3) */
57#define AC97_POWERDOWN 0x26 /* Powerdown control / status */
58/* range 0x28-0x3a - AUDIO AC'97 2.0 extensions */
59#define AC97_EXTENDED_ID 0x28 /* Extended Audio ID */
60#define AC97_EXTENDED_STATUS 0x2a /* Extended Audio Status and Control */
61#define AC97_PCM_FRONT_DAC_RATE 0x2c /* PCM Front DAC Rate */
62#define AC97_PCM_SURR_DAC_RATE 0x2e /* PCM Surround DAC Rate */
63#define AC97_PCM_LFE_DAC_RATE 0x30 /* PCM LFE DAC Rate */
64#define AC97_PCM_LR_ADC_RATE 0x32 /* PCM LR ADC Rate */
65#define AC97_PCM_MIC_ADC_RATE 0x34 /* PCM MIC ADC Rate */
66#define AC97_CENTER_LFE_MASTER 0x36 /* Center + LFE Master Volume */
67#define AC97_SURROUND_MASTER 0x38 /* Surround (Rear) Master Volume */
68#define AC97_SPDIF 0x3a /* S/PDIF control */
69/* range 0x3c-0x58 - MODEM */
70#define AC97_EXTENDED_MID 0x3c /* Extended Modem ID */
71#define AC97_EXTENDED_MSTATUS 0x3e /* Extended Modem Status and Control */
72#define AC97_LINE1_RATE 0x40 /* Line1 DAC/ADC Rate */
73#define AC97_LINE2_RATE 0x42 /* Line2 DAC/ADC Rate */
74#define AC97_HANDSET_RATE 0x44 /* Handset DAC/ADC Rate */
75#define AC97_LINE1_LEVEL 0x46 /* Line1 DAC/ADC Level */
76#define AC97_LINE2_LEVEL 0x48 /* Line2 DAC/ADC Level */
77#define AC97_HANDSET_LEVEL 0x4a /* Handset DAC/ADC Level */
78#define AC97_GPIO_CFG 0x4c /* GPIO Configuration */
79#define AC97_GPIO_POLARITY 0x4e /* GPIO Pin Polarity/Type, 0=low, 1=high active */
80#define AC97_GPIO_STICKY 0x50 /* GPIO Pin Sticky, 0=not, 1=sticky */
81#define AC97_GPIO_WAKEUP 0x52 /* GPIO Pin Wakeup, 0=no int, 1=yes int */
82#define AC97_GPIO_STATUS 0x54 /* GPIO Pin Status, slot 12 */
83#define AC97_MISC_AFE 0x56 /* Miscellaneous Modem AFE Status and Control */
84/* range 0x5a-0x7b - Vendor Specific */
85#define AC97_VENDOR_ID1 0x7c /* Vendor ID1 */
86#define AC97_VENDOR_ID2 0x7e /* Vendor ID2 / revision */
87/* range 0x60-0x6f (page 1) - extended codec registers */
88#define AC97_CODEC_CLASS_REV 0x60 /* Codec Class/Revision */
89#define AC97_PCI_SVID 0x62 /* PCI Subsystem Vendor ID */
90#define AC97_PCI_SID 0x64 /* PCI Subsystem ID */
91#define AC97_FUNC_SELECT 0x66 /* Function Select */
92#define AC97_FUNC_INFO 0x68 /* Function Information */
93#define AC97_SENSE_INFO 0x6a /* Sense Details */
94
95/* slot allocation */
96#define AC97_SLOT_TAG 0
97#define AC97_SLOT_CMD_ADDR 1
98#define AC97_SLOT_CMD_DATA 2
99#define AC97_SLOT_PCM_LEFT 3
100#define AC97_SLOT_PCM_RIGHT 4
101#define AC97_SLOT_MODEM_LINE1 5
102#define AC97_SLOT_PCM_CENTER 6
103#define AC97_SLOT_MIC 6 /* input */
104#define AC97_SLOT_SPDIF_LEFT1 6
105#define AC97_SLOT_PCM_SLEFT 7 /* surround left */
106#define AC97_SLOT_PCM_LEFT_0 7 /* double rate operation */
107#define AC97_SLOT_SPDIF_LEFT 7
108#define AC97_SLOT_PCM_SRIGHT 8 /* surround right */
109#define AC97_SLOT_PCM_RIGHT_0 8 /* double rate operation */
110#define AC97_SLOT_SPDIF_RIGHT 8
111#define AC97_SLOT_LFE 9
112#define AC97_SLOT_SPDIF_RIGHT1 9
113#define AC97_SLOT_MODEM_LINE2 10
114#define AC97_SLOT_PCM_LEFT_1 10 /* double rate operation */
115#define AC97_SLOT_SPDIF_LEFT2 10
116#define AC97_SLOT_HANDSET 11 /* output */
117#define AC97_SLOT_PCM_RIGHT_1 11 /* double rate operation */
118#define AC97_SLOT_SPDIF_RIGHT2 11
119#define AC97_SLOT_MODEM_GPIO 12 /* modem GPIO */
120#define AC97_SLOT_PCM_CENTER_1 12 /* double rate operation */
121
122/* basic capabilities (reset register) */
123#define AC97_BC_DEDICATED_MIC 0x0001 /* Dedicated Mic PCM In Channel */
124#define AC97_BC_RESERVED1 0x0002 /* Reserved (was Modem Line Codec support) */
125#define AC97_BC_BASS_TREBLE 0x0004 /* Bass & Treble Control */
126#define AC97_BC_SIM_STEREO 0x0008 /* Simulated stereo */
127#define AC97_BC_HEADPHONE 0x0010 /* Headphone Out Support */
128#define AC97_BC_LOUDNESS 0x0020 /* Loudness (bass boost) Support */
129#define AC97_BC_16BIT_DAC 0x0000 /* 16-bit DAC resolution */
130#define AC97_BC_18BIT_DAC 0x0040 /* 18-bit DAC resolution */
131#define AC97_BC_20BIT_DAC 0x0080 /* 20-bit DAC resolution */
132#define AC97_BC_DAC_MASK 0x00c0
133#define AC97_BC_16BIT_ADC 0x0000 /* 16-bit ADC resolution */
134#define AC97_BC_18BIT_ADC 0x0100 /* 18-bit ADC resolution */
135#define AC97_BC_20BIT_ADC 0x0200 /* 20-bit ADC resolution */
136#define AC97_BC_ADC_MASK 0x0300
137
138/* general purpose */
139#define AC97_GP_DRSS_MASK 0x0c00 /* double rate slot select */
140#define AC97_GP_DRSS_1011 0x0000 /* LR(C) 10+11(+12) */
141#define AC97_GP_DRSS_78 0x0400 /* LR 7+8 */
142
143/* extended audio ID bit defines */
144#define AC97_EI_VRA 0x0001 /* Variable bit rate supported */
145#define AC97_EI_DRA 0x0002 /* Double rate supported */
146#define AC97_EI_SPDIF 0x0004 /* S/PDIF out supported */
147#define AC97_EI_VRM 0x0008 /* Variable bit rate supported for MIC */
148#define AC97_EI_DACS_SLOT_MASK 0x0030 /* DACs slot assignment */
149#define AC97_EI_DACS_SLOT_SHIFT 4
150#define AC97_EI_CDAC 0x0040 /* PCM Center DAC available */
151#define AC97_EI_SDAC 0x0080 /* PCM Surround DACs available */
152#define AC97_EI_LDAC 0x0100 /* PCM LFE DAC available */
153#define AC97_EI_AMAP 0x0200 /* indicates optional slot/DAC mapping based on codec ID */
154#define AC97_EI_REV_MASK 0x0c00 /* AC'97 revision mask */
155#define AC97_EI_REV_22 0x0400 /* AC'97 revision 2.2 */
156#define AC97_EI_REV_23 0x0800 /* AC'97 revision 2.3 */
157#define AC97_EI_REV_SHIFT 10
158#define AC97_EI_ADDR_MASK 0xc000 /* physical codec ID (address) */
159#define AC97_EI_ADDR_SHIFT 14
160
161/* extended audio status and control bit defines */
162#define AC97_EA_VRA 0x0001 /* Variable bit rate enable bit */
163#define AC97_EA_DRA 0x0002 /* Double-rate audio enable bit */
164#define AC97_EA_SPDIF 0x0004 /* S/PDIF out enable bit */
165#define AC97_EA_VRM 0x0008 /* Variable bit rate for MIC enable bit */
166#define AC97_EA_SPSA_SLOT_MASK 0x0030 /* Mask for slot assignment bits */
167#define AC97_EA_SPSA_SLOT_SHIFT 4
168#define AC97_EA_SPSA_3_4 0x0000 /* Slot assigned to 3 & 4 */
169#define AC97_EA_SPSA_7_8 0x0010 /* Slot assigned to 7 & 8 */
170#define AC97_EA_SPSA_6_9 0x0020 /* Slot assigned to 6 & 9 */
171#define AC97_EA_SPSA_10_11 0x0030 /* Slot assigned to 10 & 11 */
172#define AC97_EA_CDAC 0x0040 /* PCM Center DAC is ready (Read only) */
173#define AC97_EA_SDAC 0x0080 /* PCM Surround DACs are ready (Read only) */
174#define AC97_EA_LDAC 0x0100 /* PCM LFE DAC is ready (Read only) */
175#define AC97_EA_MDAC 0x0200 /* MIC ADC is ready (Read only) */
176#define AC97_EA_SPCV 0x0400 /* S/PDIF configuration valid (Read only) */
177#define AC97_EA_PRI 0x0800 /* Turns the PCM Center DAC off */
178#define AC97_EA_PRJ 0x1000 /* Turns the PCM Surround DACs off */
179#define AC97_EA_PRK 0x2000 /* Turns the PCM LFE DAC off */
180#define AC97_EA_PRL 0x4000 /* Turns the MIC ADC off */
181
182/* S/PDIF control bit defines */
183#define AC97_SC_PRO 0x0001 /* Professional status */
184#define AC97_SC_NAUDIO 0x0002 /* Non audio stream */
185#define AC97_SC_COPY 0x0004 /* Copyright status */
186#define AC97_SC_PRE 0x0008 /* Preemphasis status */
187#define AC97_SC_CC_MASK 0x07f0 /* Category Code mask */
188#define AC97_SC_CC_SHIFT 4
189#define AC97_SC_L 0x0800 /* Generation Level status */
190#define AC97_SC_SPSR_MASK 0x3000 /* S/PDIF Sample Rate bits */
191#define AC97_SC_SPSR_SHIFT 12
192#define AC97_SC_SPSR_44K 0x0000 /* Use 44.1kHz Sample rate */
193#define AC97_SC_SPSR_48K 0x2000 /* Use 48kHz Sample rate */
194#define AC97_SC_SPSR_32K 0x3000 /* Use 32kHz Sample rate */
195#define AC97_SC_DRS 0x4000 /* Double Rate S/PDIF */
196#define AC97_SC_V 0x8000 /* Validity status */
197
198/* Interrupt and Paging bit defines (AC'97 2.3) */
199#define AC97_PAGE_MASK 0x000f /* Page Selector */
200#define AC97_PAGE_VENDOR 0 /* Vendor-specific registers */
201#define AC97_PAGE_1 1 /* Extended Codec Registers page 1 */
202#define AC97_INT_ENABLE 0x0800 /* Interrupt Enable */
203#define AC97_INT_SENSE 0x1000 /* Sense Cycle */
204#define AC97_INT_CAUSE_SENSE 0x2000 /* Sense Cycle Completed (RO) */
205#define AC97_INT_CAUSE_GPIO 0x4000 /* GPIO bits changed (RO) */
206#define AC97_INT_STATUS 0x8000 /* Interrupt Status */
207
208/* extended modem ID bit defines */
209#define AC97_MEI_LINE1 0x0001 /* Line1 present */
210#define AC97_MEI_LINE2 0x0002 /* Line2 present */
211#define AC97_MEI_HANDSET 0x0004 /* Handset present */
212#define AC97_MEI_CID1 0x0008 /* caller ID decode for Line1 is supported */
213#define AC97_MEI_CID2 0x0010 /* caller ID decode for Line2 is supported */
214#define AC97_MEI_ADDR_MASK 0xc000 /* physical codec ID (address) */
215#define AC97_MEI_ADDR_SHIFT 14
216
217/* extended modem status and control bit defines */
218#define AC97_MEA_GPIO 0x0001 /* GPIO is ready (ro) */
219#define AC97_MEA_MREF 0x0002 /* Vref is up to nominal level (ro) */
220#define AC97_MEA_ADC1 0x0004 /* ADC1 operational (ro) */
221#define AC97_MEA_DAC1 0x0008 /* DAC1 operational (ro) */
222#define AC97_MEA_ADC2 0x0010 /* ADC2 operational (ro) */
223#define AC97_MEA_DAC2 0x0020 /* DAC2 operational (ro) */
224#define AC97_MEA_HADC 0x0040 /* HADC operational (ro) */
225#define AC97_MEA_HDAC 0x0080 /* HDAC operational (ro) */
226#define AC97_MEA_PRA 0x0100 /* GPIO power down (high) */
227#define AC97_MEA_PRB 0x0200 /* reserved */
228#define AC97_MEA_PRC 0x0400 /* ADC1 power down (high) */
229#define AC97_MEA_PRD 0x0800 /* DAC1 power down (high) */
230#define AC97_MEA_PRE 0x1000 /* ADC2 power down (high) */
231#define AC97_MEA_PRF 0x2000 /* DAC2 power down (high) */
232#define AC97_MEA_PRG 0x4000 /* HADC power down (high) */
233#define AC97_MEA_PRH 0x8000 /* HDAC power down (high) */
234
235/* modem gpio status defines */
236#define AC97_GPIO_LINE1_OH 0x0001 /* Off Hook Line1 */
237#define AC97_GPIO_LINE1_RI 0x0002 /* Ring Detect Line1 */
238#define AC97_GPIO_LINE1_CID 0x0004 /* Caller ID path enable Line1 */
239#define AC97_GPIO_LINE1_LCS 0x0008 /* Loop Current Sense Line1 */
240#define AC97_GPIO_LINE1_PULSE 0x0010 /* Opt./ Pulse Dial Line1 (out) */
241#define AC97_GPIO_LINE1_HL1R 0x0020 /* Opt./ Handset to Line1 relay control (out) */
242#define AC97_GPIO_LINE1_HOHD 0x0040 /* Opt./ Handset off hook detect Line1 (in) */
243#define AC97_GPIO_LINE12_AC 0x0080 /* Opt./ Int.bit 1 / Line1/2 AC (out) */
244#define AC97_GPIO_LINE12_DC 0x0100 /* Opt./ Int.bit 2 / Line1/2 DC (out) */
245#define AC97_GPIO_LINE12_RS 0x0200 /* Opt./ Int.bit 3 / Line1/2 RS (out) */
246#define AC97_GPIO_LINE2_OH 0x0400 /* Off Hook Line2 */
247#define AC97_GPIO_LINE2_RI 0x0800 /* Ring Detect Line2 */
248#define AC97_GPIO_LINE2_CID 0x1000 /* Caller ID path enable Line2 */
249#define AC97_GPIO_LINE2_LCS 0x2000 /* Loop Current Sense Line2 */
250#define AC97_GPIO_LINE2_PULSE 0x4000 /* Opt./ Pulse Dial Line2 (out) */
251#define AC97_GPIO_LINE2_HL1R 0x8000 /* Opt./ Handset to Line2 relay control (out) */
252
253/* specific - SigmaTel */
254#define AC97_SIGMATEL_OUTSEL 0x64 /* Output Select, STAC9758 */
255#define AC97_SIGMATEL_INSEL 0x66 /* Input Select, STAC9758 */
256#define AC97_SIGMATEL_IOMISC 0x68 /* STAC9758 */
257#define AC97_SIGMATEL_ANALOG 0x6c /* Analog Special */
258#define AC97_SIGMATEL_DAC2INVERT 0x6e
259#define AC97_SIGMATEL_BIAS1 0x70
260#define AC97_SIGMATEL_BIAS2 0x72
261#define AC97_SIGMATEL_VARIOUS 0x72 /* STAC9758 */
262#define AC97_SIGMATEL_MULTICHN 0x74 /* Multi-Channel programming */
263#define AC97_SIGMATEL_CIC1 0x76
264#define AC97_SIGMATEL_CIC2 0x78
265
266/* specific - Analog Devices */
267#define AC97_AD_TEST 0x5a /* test register */
268#define AC97_AD_CODEC_CFG 0x70 /* codec configuration */
269#define AC97_AD_JACK_SPDIF 0x72 /* Jack Sense & S/PDIF */
270#define AC97_AD_SERIAL_CFG 0x74 /* Serial Configuration */
271#define AC97_AD_MISC 0x76 /* Misc Control Bits */
272
273/* specific - Cirrus Logic */
274#define AC97_CSR_ACMODE 0x5e /* AC Mode Register */
275#define AC97_CSR_MISC_CRYSTAL 0x60 /* Misc Crystal Control */
276#define AC97_CSR_SPDIF 0x68 /* S/PDIF Register */
277#define AC97_CSR_SERIAL 0x6a /* Serial Port Control */
278#define AC97_CSR_SPECF_ADDR 0x6c /* Special Feature Address */
279#define AC97_CSR_SPECF_DATA 0x6e /* Special Feature Data */
280#define AC97_CSR_BDI_STATUS 0x7a /* BDI Status */
281
282/* specific - Conexant */
283#define AC97_CXR_AUDIO_MISC 0x5c
284#define AC97_CXR_SPDIFEN (1<<3)
285#define AC97_CXR_COPYRGT (1<<2)
286#define AC97_CXR_SPDIF_MASK (3<<0)
287#define AC97_CXR_SPDIF_PCM 0x0
288#define AC97_CXR_SPDIF_AC3 0x2
289
290/* specific - ALC */
291#define AC97_ALC650_SPDIF_INPUT_STATUS1 0x60
292/* S/PDIF input status 1 bit defines */
293#define AC97_ALC650_PRO 0x0001 /* Professional status */
294#define AC97_ALC650_NAUDIO 0x0002 /* Non audio stream */
295#define AC97_ALC650_COPY 0x0004 /* Copyright status */
296#define AC97_ALC650_PRE 0x0038 /* Preemphasis status */
297#define AC97_ALC650_PRE_SHIFT 3
298#define AC97_ALC650_MODE 0x00C0 /* Preemphasis status */
299#define AC97_ALC650_MODE_SHIFT 6
300#define AC97_ALC650_CC_MASK 0x7f00 /* Category Code mask */
301#define AC97_ALC650_CC_SHIFT 8
302#define AC97_ALC650_L 0x8000 /* Generation Level status */
303
304#define AC97_ALC650_SPDIF_INPUT_STATUS2 0x62
305/* S/PDIF input status 2 bit defines */
306#define AC97_ALC650_SOUCE_MASK 0x000f /* Source number */
307#define AC97_ALC650_CHANNEL_MASK 0x00f0 /* Channel number */
308#define AC97_ALC650_CHANNEL_SHIFT 4
309#define AC97_ALC650_SPSR_MASK 0x0f00 /* S/PDIF Sample Rate bits */
310#define AC97_ALC650_SPSR_SHIFT 8
311#define AC97_ALC650_SPSR_44K 0x0000 /* Use 44.1kHz Sample rate */
312#define AC97_ALC650_SPSR_48K 0x0200 /* Use 48kHz Sample rate */
313#define AC97_ALC650_SPSR_32K 0x0300 /* Use 32kHz Sample rate */
314#define AC97_ALC650_CLOCK_ACCURACY 0x3000 /* Clock accuracy */
315#define AC97_ALC650_CLOCK_SHIFT 12
316#define AC97_ALC650_CLOCK_LOCK 0x4000 /* Clock locked status */
317#define AC97_ALC650_V 0x8000 /* Validity status */
318
319#define AC97_ALC650_SURR_DAC_VOL 0x64
320#define AC97_ALC650_LFE_DAC_VOL 0x66
321#define AC97_ALC650_UNKNOWN1 0x68
322#define AC97_ALC650_MULTICH 0x6a
323#define AC97_ALC650_UNKNOWN2 0x6c
324#define AC97_ALC650_REVISION 0x6e
325#define AC97_ALC650_UNKNOWN3 0x70
326#define AC97_ALC650_UNKNOWN4 0x72
327#define AC97_ALC650_MISC 0x74
328#define AC97_ALC650_GPIO_SETUP 0x76
329#define AC97_ALC650_GPIO_STATUS 0x78
330#define AC97_ALC650_CLOCK 0x7a
331
332/* specific - Yamaha YMF753 */
333#define AC97_YMF753_DIT_CTRL2 0x66 /* DIT Control 2 */
334#define AC97_YMF753_3D_MODE_SEL 0x68 /* 3D Mode Select */
335
336/* specific - C-Media */
337#define AC97_CM9738_VENDOR_CTRL 0x5a
338#define AC97_CM9739_MULTI_CHAN 0x64
339#define AC97_CM9739_SPDIF_IN_STATUS 0x68 /* 32bit */
340#define AC97_CM9739_SPDIF_CTRL 0x6c
341
342/* specific - wolfson */
343#define AC97_WM97XX_FMIXER_VOL 0x72
344#define AC97_WM9704_RMIXER_VOL 0x74
345#define AC97_WM9704_TEST 0x5a
346#define AC97_WM9704_RPCM_VOL 0x70
347#define AC97_WM9711_OUT3VOL 0x16
348
349
350/* ac97->scaps */
351#define AC97_SCAP_AUDIO (1<<0) /* audio codec 97 */
352#define AC97_SCAP_MODEM (1<<1) /* modem codec 97 */
353#define AC97_SCAP_SURROUND_DAC (1<<2) /* surround L&R DACs are present */
354#define AC97_SCAP_CENTER_LFE_DAC (1<<3) /* center and LFE DACs are present */
355#define AC97_SCAP_SKIP_AUDIO (1<<4) /* skip audio part of codec */
356#define AC97_SCAP_SKIP_MODEM (1<<5) /* skip modem part of codec */
357#define AC97_SCAP_INDEP_SDIN (1<<6) /* independent SDIN */
358#define AC97_SCAP_INV_EAPD (1<<7) /* inverted EAPD */
359#define AC97_SCAP_DETECT_BY_VENDOR (1<<8) /* use vendor registers for read tests */
360#define AC97_SCAP_NO_SPDIF (1<<9) /* don't build SPDIF controls */
361
362/* ac97->flags */
363#define AC97_HAS_PC_BEEP (1<<0) /* force PC Speaker usage */
364#define AC97_AD_MULTI (1<<1) /* Analog Devices - multi codecs */
365#define AC97_CS_SPDIF (1<<2) /* Cirrus Logic uses funky SPDIF */
366#define AC97_CX_SPDIF (1<<3) /* Conexant's spdif interface */
367#define AC97_STEREO_MUTES (1<<4) /* has stereo mute bits */
368#define AC97_DOUBLE_RATE (1<<5) /* supports double rate playback */
369#define AC97_HAS_NO_MASTER_VOL (1<<6) /* no Master volume */
370#define AC97_HAS_NO_PCM_VOL (1<<7) /* no PCM volume */
371#define AC97_DEFAULT_POWER_OFF (1<<8) /* no RESET write */
372#define AC97_MODEM_PATCH (1<<9) /* modem patch */
373#define AC97_HAS_NO_REC_GAIN (1<<10) /* no Record gain */
374#define AC97_HAS_NO_PHONE (1<<11) /* no PHONE volume */
375#define AC97_HAS_NO_PC_BEEP (1<<12) /* no PC Beep volume */
376#define AC97_HAS_NO_VIDEO (1<<13) /* no Video volume */
377#define AC97_HAS_NO_CD (1<<14) /* no CD volume */
3998b70f
LG
378#define AC97_HAS_NO_MIC (1<<15) /* no MIC volume */
379#define AC97_HAS_NO_TONE (1<<16) /* no Tone volume */
380#define AC97_HAS_NO_STD_PCM (1<<17) /* no standard AC97 PCM volume and mute */
1da177e4
LT
381
382/* rates indexes */
383#define AC97_RATES_FRONT_DAC 0
384#define AC97_RATES_SURR_DAC 1
385#define AC97_RATES_LFE_DAC 2
386#define AC97_RATES_ADC 3
387#define AC97_RATES_MIC_ADC 4
388#define AC97_RATES_SPDIF 5
389
1da177e4
LT
390/*
391 *
392 */
393
394typedef struct _snd_ac97_bus ac97_bus_t;
395typedef struct _snd_ac97_bus_ops ac97_bus_ops_t;
396typedef struct _snd_ac97_template ac97_template_t;
397typedef struct _snd_ac97 ac97_t;
398
399enum ac97_pcm_cfg {
400 AC97_PCM_CFG_FRONT = 2,
401 AC97_PCM_CFG_REAR = 10, /* alias surround */
402 AC97_PCM_CFG_LFE = 11, /* center + lfe */
403 AC97_PCM_CFG_40 = 4, /* front + rear */
404 AC97_PCM_CFG_51 = 6, /* front + rear + center/lfe */
405 AC97_PCM_CFG_SPDIF = 20
406};
407
408/* PCM allocation */
409struct ac97_pcm {
410 ac97_bus_t *bus;
411 unsigned int stream: 1, /* stream type: 1 = capture */
412 exclusive: 1, /* exclusive mode, don't override with other pcms */
413 copy_flag: 1, /* lowlevel driver must fill all entries */
414 spdif: 1; /* spdif pcm */
415 unsigned short aslots; /* active slots */
416 unsigned int rates; /* available rates */
417 struct {
418 unsigned short slots; /* driver input: requested AC97 slot numbers */
419 unsigned short rslots[4]; /* allocated slots per codecs */
420 unsigned char rate_table[4];
421 ac97_t *codec[4]; /* allocated codecs */
422 } r[2]; /* 0 = standard rates, 1 = double rates */
423 unsigned long private_value; /* used by the hardware driver */
424};
425
426struct snd_ac97_build_ops {
427 int (*build_3d) (ac97_t *ac97);
428 int (*build_specific) (ac97_t *ac97);
429 int (*build_spdif) (ac97_t *ac97);
430 int (*build_post_spdif) (ac97_t *ac97);
431#ifdef CONFIG_PM
432 void (*suspend) (ac97_t *ac97);
433 void (*resume) (ac97_t *ac97);
434#endif
eb8caf30 435 void (*update_jacks) (ac97_t *ac97); /* for jack-sharing */
1da177e4
LT
436};
437
438struct _snd_ac97_bus_ops {
439 void (*reset) (ac97_t *ac97);
440 void (*write) (ac97_t *ac97, unsigned short reg, unsigned short val);
441 unsigned short (*read) (ac97_t *ac97, unsigned short reg);
442 void (*wait) (ac97_t *ac97);
443 void (*init) (ac97_t *ac97);
444};
445
446struct _snd_ac97_bus {
447 /* -- lowlevel (hardware) driver specific -- */
448 ac97_bus_ops_t *ops;
449 void *private_data;
450 void (*private_free) (ac97_bus_t *bus);
451 /* --- */
452 snd_card_t *card;
453 unsigned short num; /* bus number */
454 unsigned short no_vra: 1, /* bridge doesn't support VRA */
455 dra: 1, /* bridge supports double rate */
456 isdin: 1;/* independent SDIN */
457 unsigned int clock; /* AC'97 base clock (usually 48000Hz) */
458 spinlock_t bus_lock; /* used mainly for slot allocation */
459 unsigned short used_slots[2][4]; /* actually used PCM slots */
460 unsigned short pcms_count; /* count of PCMs */
461 struct ac97_pcm *pcms;
1da177e4
LT
462 ac97_t *codec[4];
463 snd_info_entry_t *proc;
464};
465
466struct _snd_ac97_template {
467 void *private_data;
468 void (*private_free) (ac97_t *ac97);
469 struct pci_dev *pci; /* assigned PCI device - used for quirks */
470 unsigned short num; /* number of codec: 0 = primary, 1 = secondary */
471 unsigned short addr; /* physical address of codec [0-3] */
472 unsigned int scaps; /* driver capabilities */
473 unsigned int limited_regs; /* allow limited registers only */
474 DECLARE_BITMAP(reg_accessed, 0x80); /* bit flags */
475};
476
477struct _snd_ac97 {
478 /* -- lowlevel (hardware) driver specific -- */
479 struct snd_ac97_build_ops * build_ops;
480 void *private_data;
481 void (*private_free) (ac97_t *ac97);
482 /* --- */
483 ac97_bus_t *bus;
484 struct pci_dev *pci; /* assigned PCI device - used for quirks */
485 snd_info_entry_t *proc;
486 snd_info_entry_t *proc_regs;
487 unsigned short subsystem_vendor;
488 unsigned short subsystem_device;
489 struct semaphore reg_mutex;
490 struct semaphore page_mutex; /* mutex for AD18xx multi-codecs and paging (2.3) */
491 unsigned short num; /* number of codec: 0 = primary, 1 = secondary */
492 unsigned short addr; /* physical address of codec [0-3] */
493 unsigned int id; /* identification of codec */
494 unsigned short caps; /* capabilities (register 0) */
495 unsigned short ext_id; /* extended feature identification (register 28) */
496 unsigned short ext_mid; /* extended modem ID (register 3C) */
497 unsigned int scaps; /* driver capabilities */
498 unsigned int flags; /* specific code */
499 unsigned int rates[6]; /* see AC97_RATES_* defines */
500 unsigned int spdif_status;
501 unsigned short regs[0x80]; /* register cache */
502 unsigned int limited_regs; /* allow limited registers only */
503 DECLARE_BITMAP(reg_accessed, 0x80); /* bit flags */
504 union { /* vendor specific code */
505 struct {
506 unsigned short unchained[3]; // 0 = C34, 1 = C79, 2 = C69
507 unsigned short chained[3]; // 0 = C34, 1 = C79, 2 = C69
508 unsigned short id[3]; // codec IDs (lower 16-bit word)
509 unsigned short pcmreg[3]; // PCM registers
510 unsigned short codec_cfg[3]; // CODEC_CFG bits
511 } ad18xx;
512 unsigned int dev_flags; /* device specific */
513 } spec;
eb8caf30
TI
514 /* jack-sharing info */
515 unsigned char indep_surround;
516 unsigned char channel_mode;
0ca06a00 517 struct device dev;
1da177e4
LT
518};
519
72e75de2
NP
520#define to_ac97_t(d) container_of(d, struct _snd_ac97, dev)
521
1da177e4
LT
522/* conditions */
523static inline int ac97_is_audio(ac97_t * ac97)
524{
525 return (ac97->scaps & AC97_SCAP_AUDIO);
526}
527static inline int ac97_is_modem(ac97_t * ac97)
528{
529 return (ac97->scaps & AC97_SCAP_MODEM);
530}
531static inline int ac97_is_rev22(ac97_t * ac97)
532{
533 return (ac97->ext_id & AC97_EI_REV_MASK) >= AC97_EI_REV_22;
534}
535static inline int ac97_can_amap(ac97_t * ac97)
536{
537 return (ac97->ext_id & AC97_EI_AMAP) != 0;
538}
539static inline int ac97_can_spdif(ac97_t * ac97)
540{
541 return (ac97->ext_id & AC97_EI_SPDIF) != 0;
542}
543
544/* functions */
545int snd_ac97_bus(snd_card_t *card, int num, ac97_bus_ops_t *ops, void *private_data, ac97_bus_t **rbus); /* create new AC97 bus */
546int snd_ac97_mixer(ac97_bus_t *bus, ac97_template_t *template, ac97_t **rac97); /* create mixer controls */
547const char *snd_ac97_get_short_name(ac97_t *ac97);
548
549void snd_ac97_write(ac97_t *ac97, unsigned short reg, unsigned short value);
550unsigned short snd_ac97_read(ac97_t *ac97, unsigned short reg);
551void snd_ac97_write_cache(ac97_t *ac97, unsigned short reg, unsigned short value);
552int snd_ac97_update(ac97_t *ac97, unsigned short reg, unsigned short value);
553int snd_ac97_update_bits(ac97_t *ac97, unsigned short reg, unsigned short mask, unsigned short value);
554#ifdef CONFIG_PM
555void snd_ac97_suspend(ac97_t *ac97);
556void snd_ac97_resume(ac97_t *ac97);
557#endif
558
559/* quirk types */
560enum {
561 AC97_TUNE_DEFAULT = -1, /* use default from quirk list (not valid in list) */
562 AC97_TUNE_NONE = 0, /* nothing extra to do */
563 AC97_TUNE_HP_ONLY, /* headphone (true line-out) control as master only */
564 AC97_TUNE_SWAP_HP, /* swap headphone and master controls */
565 AC97_TUNE_SWAP_SURROUND, /* swap master and surround controls */
566 AC97_TUNE_AD_SHARING, /* for AD1985, turn on OMS bit and use headphone */
567 AC97_TUNE_ALC_JACK, /* for Realtek, enable JACK detection */
568 AC97_TUNE_INV_EAPD, /* inverted EAPD implementation */
569 AC97_TUNE_MUTE_LED, /* EAPD bit works as mute LED */
570};
571
572struct ac97_quirk {
69ad07cf
JK
573 unsigned short subvendor; /* PCI subsystem vendor id */
574 unsigned short subdevice; /* PCI sybsystem device id */
1da177e4
LT
575 unsigned short mask; /* device id bit mask, 0 = accept all */
576 unsigned int codec_id; /* codec id (if any), 0 = accept all */
577 const char *name; /* name shown as info */
578 int type; /* quirk type above */
579};
580
581int snd_ac97_tune_hardware(ac97_t *ac97, struct ac97_quirk *quirk, const char *override);
582int snd_ac97_set_rate(ac97_t *ac97, int reg, unsigned int rate);
583
584int snd_ac97_pcm_assign(ac97_bus_t *ac97,
585 unsigned short pcms_count,
586 const struct ac97_pcm *pcms);
587int snd_ac97_pcm_open(struct ac97_pcm *pcm, unsigned int rate,
588 enum ac97_pcm_cfg cfg, unsigned short slots);
589int snd_ac97_pcm_close(struct ac97_pcm *pcm);
590int snd_ac97_pcm_double_rate_rules(snd_pcm_runtime_t *runtime);
591
592struct ac97_enum {
593 unsigned char reg;
594 unsigned char shift_l;
595 unsigned char shift_r;
596 unsigned short mask;
597 const char **texts;
598};
0ca06a00
LG
599
600/* ad hoc AC97 device driver access */
601extern struct bus_type ac97_bus_type;
602
1da177e4 603#endif /* __SOUND_AC97_CODEC_H */