blob: 0e9d75b49bede16f09a7e96e697a6d9061677c0c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __SOUND_AC97_CODEC_H
2#define __SOUND_AC97_CODEC_H
3
4/*
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02005 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * 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>
Liam Girdwood0ca06a02005-07-29 16:13:36 +020029#include <linux/device.h>
Takashi Iwai6dbe6622006-06-27 18:28:53 +020030#include <linux/workqueue.h>
David Howellsa1ce3922012-10-02 18:01:25 +010031#include <sound/pcm.h>
32#include <sound/control.h>
33#include <sound/info.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
Marek Vasut4ac04782009-07-30 02:55:01 +020035/* maximum number of devices on the AC97 bus */
36#define AC97_BUS_MAX_DEVICES 4
37
Linus Torvalds1da177e2005-04-16 15:20:36 -070038/*
39 * AC'97 codec registers
40 */
41
42#define AC97_RESET 0x00 /* Reset */
43#define AC97_MASTER 0x02 /* Master Volume */
44#define AC97_HEADPHONE 0x04 /* Headphone Volume (optional) */
45#define AC97_MASTER_MONO 0x06 /* Master Volume Mono (optional) */
46#define AC97_MASTER_TONE 0x08 /* Master Tone (Bass & Treble) (optional) */
47#define AC97_PC_BEEP 0x0a /* PC Beep Volume (optinal) */
48#define AC97_PHONE 0x0c /* Phone Volume (optional) */
49#define AC97_MIC 0x0e /* MIC Volume */
50#define AC97_LINE 0x10 /* Line In Volume */
51#define AC97_CD 0x12 /* CD Volume */
52#define AC97_VIDEO 0x14 /* Video Volume (optional) */
53#define AC97_AUX 0x16 /* AUX Volume (optional) */
54#define AC97_PCM 0x18 /* PCM Volume */
55#define AC97_REC_SEL 0x1a /* Record Select */
56#define AC97_REC_GAIN 0x1c /* Record Gain */
57#define AC97_REC_GAIN_MIC 0x1e /* Record Gain MIC (optional) */
58#define AC97_GENERAL_PURPOSE 0x20 /* General Purpose (optional) */
59#define AC97_3D_CONTROL 0x22 /* 3D Control (optional) */
60#define AC97_INT_PAGING 0x24 /* Audio Interrupt & Paging (AC'97 2.3) */
61#define AC97_POWERDOWN 0x26 /* Powerdown control / status */
62/* range 0x28-0x3a - AUDIO AC'97 2.0 extensions */
63#define AC97_EXTENDED_ID 0x28 /* Extended Audio ID */
64#define AC97_EXTENDED_STATUS 0x2a /* Extended Audio Status and Control */
65#define AC97_PCM_FRONT_DAC_RATE 0x2c /* PCM Front DAC Rate */
66#define AC97_PCM_SURR_DAC_RATE 0x2e /* PCM Surround DAC Rate */
67#define AC97_PCM_LFE_DAC_RATE 0x30 /* PCM LFE DAC Rate */
68#define AC97_PCM_LR_ADC_RATE 0x32 /* PCM LR ADC Rate */
69#define AC97_PCM_MIC_ADC_RATE 0x34 /* PCM MIC ADC Rate */
70#define AC97_CENTER_LFE_MASTER 0x36 /* Center + LFE Master Volume */
71#define AC97_SURROUND_MASTER 0x38 /* Surround (Rear) Master Volume */
72#define AC97_SPDIF 0x3a /* S/PDIF control */
73/* range 0x3c-0x58 - MODEM */
74#define AC97_EXTENDED_MID 0x3c /* Extended Modem ID */
75#define AC97_EXTENDED_MSTATUS 0x3e /* Extended Modem Status and Control */
76#define AC97_LINE1_RATE 0x40 /* Line1 DAC/ADC Rate */
77#define AC97_LINE2_RATE 0x42 /* Line2 DAC/ADC Rate */
78#define AC97_HANDSET_RATE 0x44 /* Handset DAC/ADC Rate */
79#define AC97_LINE1_LEVEL 0x46 /* Line1 DAC/ADC Level */
80#define AC97_LINE2_LEVEL 0x48 /* Line2 DAC/ADC Level */
81#define AC97_HANDSET_LEVEL 0x4a /* Handset DAC/ADC Level */
82#define AC97_GPIO_CFG 0x4c /* GPIO Configuration */
83#define AC97_GPIO_POLARITY 0x4e /* GPIO Pin Polarity/Type, 0=low, 1=high active */
84#define AC97_GPIO_STICKY 0x50 /* GPIO Pin Sticky, 0=not, 1=sticky */
85#define AC97_GPIO_WAKEUP 0x52 /* GPIO Pin Wakeup, 0=no int, 1=yes int */
86#define AC97_GPIO_STATUS 0x54 /* GPIO Pin Status, slot 12 */
87#define AC97_MISC_AFE 0x56 /* Miscellaneous Modem AFE Status and Control */
88/* range 0x5a-0x7b - Vendor Specific */
89#define AC97_VENDOR_ID1 0x7c /* Vendor ID1 */
90#define AC97_VENDOR_ID2 0x7e /* Vendor ID2 / revision */
91/* range 0x60-0x6f (page 1) - extended codec registers */
92#define AC97_CODEC_CLASS_REV 0x60 /* Codec Class/Revision */
93#define AC97_PCI_SVID 0x62 /* PCI Subsystem Vendor ID */
94#define AC97_PCI_SID 0x64 /* PCI Subsystem ID */
95#define AC97_FUNC_SELECT 0x66 /* Function Select */
96#define AC97_FUNC_INFO 0x68 /* Function Information */
97#define AC97_SENSE_INFO 0x6a /* Sense Details */
98
Andreas Mohr03c2d872011-02-17 00:17:53 +010099/* volume controls */
100#define AC97_MUTE_MASK_MONO 0x8000
101#define AC97_MUTE_MASK_STEREO 0x8080
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103/* slot allocation */
104#define AC97_SLOT_TAG 0
105#define AC97_SLOT_CMD_ADDR 1
106#define AC97_SLOT_CMD_DATA 2
107#define AC97_SLOT_PCM_LEFT 3
108#define AC97_SLOT_PCM_RIGHT 4
109#define AC97_SLOT_MODEM_LINE1 5
110#define AC97_SLOT_PCM_CENTER 6
111#define AC97_SLOT_MIC 6 /* input */
112#define AC97_SLOT_SPDIF_LEFT1 6
113#define AC97_SLOT_PCM_SLEFT 7 /* surround left */
114#define AC97_SLOT_PCM_LEFT_0 7 /* double rate operation */
115#define AC97_SLOT_SPDIF_LEFT 7
116#define AC97_SLOT_PCM_SRIGHT 8 /* surround right */
117#define AC97_SLOT_PCM_RIGHT_0 8 /* double rate operation */
118#define AC97_SLOT_SPDIF_RIGHT 8
119#define AC97_SLOT_LFE 9
120#define AC97_SLOT_SPDIF_RIGHT1 9
121#define AC97_SLOT_MODEM_LINE2 10
122#define AC97_SLOT_PCM_LEFT_1 10 /* double rate operation */
123#define AC97_SLOT_SPDIF_LEFT2 10
124#define AC97_SLOT_HANDSET 11 /* output */
125#define AC97_SLOT_PCM_RIGHT_1 11 /* double rate operation */
126#define AC97_SLOT_SPDIF_RIGHT2 11
127#define AC97_SLOT_MODEM_GPIO 12 /* modem GPIO */
128#define AC97_SLOT_PCM_CENTER_1 12 /* double rate operation */
129
130/* basic capabilities (reset register) */
131#define AC97_BC_DEDICATED_MIC 0x0001 /* Dedicated Mic PCM In Channel */
132#define AC97_BC_RESERVED1 0x0002 /* Reserved (was Modem Line Codec support) */
133#define AC97_BC_BASS_TREBLE 0x0004 /* Bass & Treble Control */
134#define AC97_BC_SIM_STEREO 0x0008 /* Simulated stereo */
135#define AC97_BC_HEADPHONE 0x0010 /* Headphone Out Support */
136#define AC97_BC_LOUDNESS 0x0020 /* Loudness (bass boost) Support */
137#define AC97_BC_16BIT_DAC 0x0000 /* 16-bit DAC resolution */
138#define AC97_BC_18BIT_DAC 0x0040 /* 18-bit DAC resolution */
139#define AC97_BC_20BIT_DAC 0x0080 /* 20-bit DAC resolution */
140#define AC97_BC_DAC_MASK 0x00c0
141#define AC97_BC_16BIT_ADC 0x0000 /* 16-bit ADC resolution */
142#define AC97_BC_18BIT_ADC 0x0100 /* 18-bit ADC resolution */
143#define AC97_BC_20BIT_ADC 0x0200 /* 20-bit ADC resolution */
144#define AC97_BC_ADC_MASK 0x0300
Andreas Mohr03c2d872011-02-17 00:17:53 +0100145#define AC97_BC_3D_TECH_ID_MASK 0x7c00 /* Per-vendor ID of 3D enhancement */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147/* general purpose */
148#define AC97_GP_DRSS_MASK 0x0c00 /* double rate slot select */
149#define AC97_GP_DRSS_1011 0x0000 /* LR(C) 10+11(+12) */
150#define AC97_GP_DRSS_78 0x0400 /* LR 7+8 */
151
Takashi Iwai6dbe6622006-06-27 18:28:53 +0200152/* powerdown bits */
153#define AC97_PD_ADC_STATUS 0x0001 /* ADC status (RO) */
154#define AC97_PD_DAC_STATUS 0x0002 /* DAC status (RO) */
155#define AC97_PD_MIXER_STATUS 0x0004 /* Analog mixer status (RO) */
156#define AC97_PD_VREF_STATUS 0x0008 /* Vref status (RO) */
157#define AC97_PD_PR0 0x0100 /* Power down PCM ADCs and input MUX */
158#define AC97_PD_PR1 0x0200 /* Power down PCM front DAC */
159#define AC97_PD_PR2 0x0400 /* Power down Mixer (Vref still on) */
160#define AC97_PD_PR3 0x0800 /* Power down Mixer (Vref off) */
161#define AC97_PD_PR4 0x1000 /* Power down AC-Link */
162#define AC97_PD_PR5 0x2000 /* Disable internal clock usage */
163#define AC97_PD_PR6 0x4000 /* Headphone amplifier */
164#define AC97_PD_EAPD 0x8000 /* External Amplifer Power Down (EAPD) */
165
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166/* extended audio ID bit defines */
167#define AC97_EI_VRA 0x0001 /* Variable bit rate supported */
168#define AC97_EI_DRA 0x0002 /* Double rate supported */
169#define AC97_EI_SPDIF 0x0004 /* S/PDIF out supported */
170#define AC97_EI_VRM 0x0008 /* Variable bit rate supported for MIC */
171#define AC97_EI_DACS_SLOT_MASK 0x0030 /* DACs slot assignment */
172#define AC97_EI_DACS_SLOT_SHIFT 4
173#define AC97_EI_CDAC 0x0040 /* PCM Center DAC available */
174#define AC97_EI_SDAC 0x0080 /* PCM Surround DACs available */
175#define AC97_EI_LDAC 0x0100 /* PCM LFE DAC available */
176#define AC97_EI_AMAP 0x0200 /* indicates optional slot/DAC mapping based on codec ID */
177#define AC97_EI_REV_MASK 0x0c00 /* AC'97 revision mask */
178#define AC97_EI_REV_22 0x0400 /* AC'97 revision 2.2 */
179#define AC97_EI_REV_23 0x0800 /* AC'97 revision 2.3 */
180#define AC97_EI_REV_SHIFT 10
181#define AC97_EI_ADDR_MASK 0xc000 /* physical codec ID (address) */
182#define AC97_EI_ADDR_SHIFT 14
183
184/* extended audio status and control bit defines */
185#define AC97_EA_VRA 0x0001 /* Variable bit rate enable bit */
186#define AC97_EA_DRA 0x0002 /* Double-rate audio enable bit */
187#define AC97_EA_SPDIF 0x0004 /* S/PDIF out enable bit */
188#define AC97_EA_VRM 0x0008 /* Variable bit rate for MIC enable bit */
189#define AC97_EA_SPSA_SLOT_MASK 0x0030 /* Mask for slot assignment bits */
190#define AC97_EA_SPSA_SLOT_SHIFT 4
191#define AC97_EA_SPSA_3_4 0x0000 /* Slot assigned to 3 & 4 */
192#define AC97_EA_SPSA_7_8 0x0010 /* Slot assigned to 7 & 8 */
193#define AC97_EA_SPSA_6_9 0x0020 /* Slot assigned to 6 & 9 */
194#define AC97_EA_SPSA_10_11 0x0030 /* Slot assigned to 10 & 11 */
195#define AC97_EA_CDAC 0x0040 /* PCM Center DAC is ready (Read only) */
196#define AC97_EA_SDAC 0x0080 /* PCM Surround DACs are ready (Read only) */
197#define AC97_EA_LDAC 0x0100 /* PCM LFE DAC is ready (Read only) */
198#define AC97_EA_MDAC 0x0200 /* MIC ADC is ready (Read only) */
199#define AC97_EA_SPCV 0x0400 /* S/PDIF configuration valid (Read only) */
200#define AC97_EA_PRI 0x0800 /* Turns the PCM Center DAC off */
201#define AC97_EA_PRJ 0x1000 /* Turns the PCM Surround DACs off */
202#define AC97_EA_PRK 0x2000 /* Turns the PCM LFE DAC off */
203#define AC97_EA_PRL 0x4000 /* Turns the MIC ADC off */
204
205/* S/PDIF control bit defines */
206#define AC97_SC_PRO 0x0001 /* Professional status */
207#define AC97_SC_NAUDIO 0x0002 /* Non audio stream */
208#define AC97_SC_COPY 0x0004 /* Copyright status */
209#define AC97_SC_PRE 0x0008 /* Preemphasis status */
210#define AC97_SC_CC_MASK 0x07f0 /* Category Code mask */
211#define AC97_SC_CC_SHIFT 4
212#define AC97_SC_L 0x0800 /* Generation Level status */
213#define AC97_SC_SPSR_MASK 0x3000 /* S/PDIF Sample Rate bits */
214#define AC97_SC_SPSR_SHIFT 12
215#define AC97_SC_SPSR_44K 0x0000 /* Use 44.1kHz Sample rate */
216#define AC97_SC_SPSR_48K 0x2000 /* Use 48kHz Sample rate */
217#define AC97_SC_SPSR_32K 0x3000 /* Use 32kHz Sample rate */
218#define AC97_SC_DRS 0x4000 /* Double Rate S/PDIF */
219#define AC97_SC_V 0x8000 /* Validity status */
220
221/* Interrupt and Paging bit defines (AC'97 2.3) */
222#define AC97_PAGE_MASK 0x000f /* Page Selector */
223#define AC97_PAGE_VENDOR 0 /* Vendor-specific registers */
224#define AC97_PAGE_1 1 /* Extended Codec Registers page 1 */
225#define AC97_INT_ENABLE 0x0800 /* Interrupt Enable */
226#define AC97_INT_SENSE 0x1000 /* Sense Cycle */
227#define AC97_INT_CAUSE_SENSE 0x2000 /* Sense Cycle Completed (RO) */
228#define AC97_INT_CAUSE_GPIO 0x4000 /* GPIO bits changed (RO) */
229#define AC97_INT_STATUS 0x8000 /* Interrupt Status */
230
231/* extended modem ID bit defines */
232#define AC97_MEI_LINE1 0x0001 /* Line1 present */
233#define AC97_MEI_LINE2 0x0002 /* Line2 present */
234#define AC97_MEI_HANDSET 0x0004 /* Handset present */
235#define AC97_MEI_CID1 0x0008 /* caller ID decode for Line1 is supported */
236#define AC97_MEI_CID2 0x0010 /* caller ID decode for Line2 is supported */
237#define AC97_MEI_ADDR_MASK 0xc000 /* physical codec ID (address) */
238#define AC97_MEI_ADDR_SHIFT 14
239
240/* extended modem status and control bit defines */
241#define AC97_MEA_GPIO 0x0001 /* GPIO is ready (ro) */
242#define AC97_MEA_MREF 0x0002 /* Vref is up to nominal level (ro) */
243#define AC97_MEA_ADC1 0x0004 /* ADC1 operational (ro) */
244#define AC97_MEA_DAC1 0x0008 /* DAC1 operational (ro) */
245#define AC97_MEA_ADC2 0x0010 /* ADC2 operational (ro) */
246#define AC97_MEA_DAC2 0x0020 /* DAC2 operational (ro) */
247#define AC97_MEA_HADC 0x0040 /* HADC operational (ro) */
248#define AC97_MEA_HDAC 0x0080 /* HDAC operational (ro) */
249#define AC97_MEA_PRA 0x0100 /* GPIO power down (high) */
250#define AC97_MEA_PRB 0x0200 /* reserved */
251#define AC97_MEA_PRC 0x0400 /* ADC1 power down (high) */
252#define AC97_MEA_PRD 0x0800 /* DAC1 power down (high) */
253#define AC97_MEA_PRE 0x1000 /* ADC2 power down (high) */
254#define AC97_MEA_PRF 0x2000 /* DAC2 power down (high) */
255#define AC97_MEA_PRG 0x4000 /* HADC power down (high) */
256#define AC97_MEA_PRH 0x8000 /* HDAC power down (high) */
257
258/* modem gpio status defines */
259#define AC97_GPIO_LINE1_OH 0x0001 /* Off Hook Line1 */
260#define AC97_GPIO_LINE1_RI 0x0002 /* Ring Detect Line1 */
261#define AC97_GPIO_LINE1_CID 0x0004 /* Caller ID path enable Line1 */
262#define AC97_GPIO_LINE1_LCS 0x0008 /* Loop Current Sense Line1 */
263#define AC97_GPIO_LINE1_PULSE 0x0010 /* Opt./ Pulse Dial Line1 (out) */
264#define AC97_GPIO_LINE1_HL1R 0x0020 /* Opt./ Handset to Line1 relay control (out) */
265#define AC97_GPIO_LINE1_HOHD 0x0040 /* Opt./ Handset off hook detect Line1 (in) */
266#define AC97_GPIO_LINE12_AC 0x0080 /* Opt./ Int.bit 1 / Line1/2 AC (out) */
267#define AC97_GPIO_LINE12_DC 0x0100 /* Opt./ Int.bit 2 / Line1/2 DC (out) */
268#define AC97_GPIO_LINE12_RS 0x0200 /* Opt./ Int.bit 3 / Line1/2 RS (out) */
269#define AC97_GPIO_LINE2_OH 0x0400 /* Off Hook Line2 */
270#define AC97_GPIO_LINE2_RI 0x0800 /* Ring Detect Line2 */
271#define AC97_GPIO_LINE2_CID 0x1000 /* Caller ID path enable Line2 */
272#define AC97_GPIO_LINE2_LCS 0x2000 /* Loop Current Sense Line2 */
273#define AC97_GPIO_LINE2_PULSE 0x4000 /* Opt./ Pulse Dial Line2 (out) */
274#define AC97_GPIO_LINE2_HL1R 0x8000 /* Opt./ Handset to Line2 relay control (out) */
275
276/* specific - SigmaTel */
277#define AC97_SIGMATEL_OUTSEL 0x64 /* Output Select, STAC9758 */
278#define AC97_SIGMATEL_INSEL 0x66 /* Input Select, STAC9758 */
279#define AC97_SIGMATEL_IOMISC 0x68 /* STAC9758 */
280#define AC97_SIGMATEL_ANALOG 0x6c /* Analog Special */
281#define AC97_SIGMATEL_DAC2INVERT 0x6e
282#define AC97_SIGMATEL_BIAS1 0x70
283#define AC97_SIGMATEL_BIAS2 0x72
284#define AC97_SIGMATEL_VARIOUS 0x72 /* STAC9758 */
285#define AC97_SIGMATEL_MULTICHN 0x74 /* Multi-Channel programming */
286#define AC97_SIGMATEL_CIC1 0x76
287#define AC97_SIGMATEL_CIC2 0x78
288
289/* specific - Analog Devices */
290#define AC97_AD_TEST 0x5a /* test register */
Jaya Kumar02856b52006-06-23 15:18:41 +0200291#define AC97_AD_TEST2 0x5c /* undocumented test register 2 */
Andres Salomon0bed7b22008-11-05 17:29:53 -0500292#define AC97_AD_HPFD_SHIFT 12 /* High Pass Filter Disable */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293#define AC97_AD_CODEC_CFG 0x70 /* codec configuration */
294#define AC97_AD_JACK_SPDIF 0x72 /* Jack Sense & S/PDIF */
295#define AC97_AD_SERIAL_CFG 0x74 /* Serial Configuration */
296#define AC97_AD_MISC 0x76 /* Misc Control Bits */
Andres Salomon0bed7b22008-11-05 17:29:53 -0500297#define AC97_AD_VREFD_SHIFT 2 /* V_REFOUT Disable (AD1888) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
299/* specific - Cirrus Logic */
300#define AC97_CSR_ACMODE 0x5e /* AC Mode Register */
301#define AC97_CSR_MISC_CRYSTAL 0x60 /* Misc Crystal Control */
302#define AC97_CSR_SPDIF 0x68 /* S/PDIF Register */
303#define AC97_CSR_SERIAL 0x6a /* Serial Port Control */
304#define AC97_CSR_SPECF_ADDR 0x6c /* Special Feature Address */
305#define AC97_CSR_SPECF_DATA 0x6e /* Special Feature Data */
306#define AC97_CSR_BDI_STATUS 0x7a /* BDI Status */
307
308/* specific - Conexant */
309#define AC97_CXR_AUDIO_MISC 0x5c
310#define AC97_CXR_SPDIFEN (1<<3)
311#define AC97_CXR_COPYRGT (1<<2)
312#define AC97_CXR_SPDIF_MASK (3<<0)
313#define AC97_CXR_SPDIF_PCM 0x0
314#define AC97_CXR_SPDIF_AC3 0x2
315
316/* specific - ALC */
317#define AC97_ALC650_SPDIF_INPUT_STATUS1 0x60
318/* S/PDIF input status 1 bit defines */
319#define AC97_ALC650_PRO 0x0001 /* Professional status */
320#define AC97_ALC650_NAUDIO 0x0002 /* Non audio stream */
321#define AC97_ALC650_COPY 0x0004 /* Copyright status */
322#define AC97_ALC650_PRE 0x0038 /* Preemphasis status */
323#define AC97_ALC650_PRE_SHIFT 3
324#define AC97_ALC650_MODE 0x00C0 /* Preemphasis status */
325#define AC97_ALC650_MODE_SHIFT 6
326#define AC97_ALC650_CC_MASK 0x7f00 /* Category Code mask */
327#define AC97_ALC650_CC_SHIFT 8
328#define AC97_ALC650_L 0x8000 /* Generation Level status */
329
330#define AC97_ALC650_SPDIF_INPUT_STATUS2 0x62
331/* S/PDIF input status 2 bit defines */
332#define AC97_ALC650_SOUCE_MASK 0x000f /* Source number */
333#define AC97_ALC650_CHANNEL_MASK 0x00f0 /* Channel number */
334#define AC97_ALC650_CHANNEL_SHIFT 4
335#define AC97_ALC650_SPSR_MASK 0x0f00 /* S/PDIF Sample Rate bits */
336#define AC97_ALC650_SPSR_SHIFT 8
337#define AC97_ALC650_SPSR_44K 0x0000 /* Use 44.1kHz Sample rate */
338#define AC97_ALC650_SPSR_48K 0x0200 /* Use 48kHz Sample rate */
339#define AC97_ALC650_SPSR_32K 0x0300 /* Use 32kHz Sample rate */
340#define AC97_ALC650_CLOCK_ACCURACY 0x3000 /* Clock accuracy */
341#define AC97_ALC650_CLOCK_SHIFT 12
342#define AC97_ALC650_CLOCK_LOCK 0x4000 /* Clock locked status */
343#define AC97_ALC650_V 0x8000 /* Validity status */
344
345#define AC97_ALC650_SURR_DAC_VOL 0x64
346#define AC97_ALC650_LFE_DAC_VOL 0x66
347#define AC97_ALC650_UNKNOWN1 0x68
348#define AC97_ALC650_MULTICH 0x6a
349#define AC97_ALC650_UNKNOWN2 0x6c
350#define AC97_ALC650_REVISION 0x6e
351#define AC97_ALC650_UNKNOWN3 0x70
352#define AC97_ALC650_UNKNOWN4 0x72
353#define AC97_ALC650_MISC 0x74
354#define AC97_ALC650_GPIO_SETUP 0x76
355#define AC97_ALC650_GPIO_STATUS 0x78
356#define AC97_ALC650_CLOCK 0x7a
357
Keita Maehara13043982007-09-19 14:27:38 +0200358/* specific - Yamaha YMF7x3 */
359#define AC97_YMF7X3_DIT_CTRL 0x66 /* DIT Control (YMF743) / 2 (YMF753) */
360#define AC97_YMF7X3_3D_MODE_SEL 0x68 /* 3D Mode Select */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
362/* specific - C-Media */
363#define AC97_CM9738_VENDOR_CTRL 0x5a
364#define AC97_CM9739_MULTI_CHAN 0x64
365#define AC97_CM9739_SPDIF_IN_STATUS 0x68 /* 32bit */
366#define AC97_CM9739_SPDIF_CTRL 0x6c
367
368/* specific - wolfson */
369#define AC97_WM97XX_FMIXER_VOL 0x72
370#define AC97_WM9704_RMIXER_VOL 0x74
371#define AC97_WM9704_TEST 0x5a
372#define AC97_WM9704_RPCM_VOL 0x70
373#define AC97_WM9711_OUT3VOL 0x16
374
375
376/* ac97->scaps */
377#define AC97_SCAP_AUDIO (1<<0) /* audio codec 97 */
378#define AC97_SCAP_MODEM (1<<1) /* modem codec 97 */
379#define AC97_SCAP_SURROUND_DAC (1<<2) /* surround L&R DACs are present */
380#define AC97_SCAP_CENTER_LFE_DAC (1<<3) /* center and LFE DACs are present */
381#define AC97_SCAP_SKIP_AUDIO (1<<4) /* skip audio part of codec */
382#define AC97_SCAP_SKIP_MODEM (1<<5) /* skip modem part of codec */
383#define AC97_SCAP_INDEP_SDIN (1<<6) /* independent SDIN */
384#define AC97_SCAP_INV_EAPD (1<<7) /* inverted EAPD */
385#define AC97_SCAP_DETECT_BY_VENDOR (1<<8) /* use vendor registers for read tests */
386#define AC97_SCAP_NO_SPDIF (1<<9) /* don't build SPDIF controls */
Takashi Iwai6dbe6622006-06-27 18:28:53 +0200387#define AC97_SCAP_EAPD_LED (1<<10) /* EAPD as mute LED */
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300388#define AC97_SCAP_POWER_SAVE (1<<11) /* capable for aggressive power-saving */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
390/* ac97->flags */
391#define AC97_HAS_PC_BEEP (1<<0) /* force PC Speaker usage */
392#define AC97_AD_MULTI (1<<1) /* Analog Devices - multi codecs */
393#define AC97_CS_SPDIF (1<<2) /* Cirrus Logic uses funky SPDIF */
394#define AC97_CX_SPDIF (1<<3) /* Conexant's spdif interface */
395#define AC97_STEREO_MUTES (1<<4) /* has stereo mute bits */
396#define AC97_DOUBLE_RATE (1<<5) /* supports double rate playback */
397#define AC97_HAS_NO_MASTER_VOL (1<<6) /* no Master volume */
398#define AC97_HAS_NO_PCM_VOL (1<<7) /* no PCM volume */
399#define AC97_DEFAULT_POWER_OFF (1<<8) /* no RESET write */
400#define AC97_MODEM_PATCH (1<<9) /* modem patch */
401#define AC97_HAS_NO_REC_GAIN (1<<10) /* no Record gain */
402#define AC97_HAS_NO_PHONE (1<<11) /* no PHONE volume */
403#define AC97_HAS_NO_PC_BEEP (1<<12) /* no PC Beep volume */
404#define AC97_HAS_NO_VIDEO (1<<13) /* no Video volume */
405#define AC97_HAS_NO_CD (1<<14) /* no CD volume */
Liam Girdwood3998b702005-07-29 11:41:55 +0200406#define AC97_HAS_NO_MIC (1<<15) /* no MIC volume */
407#define AC97_HAS_NO_TONE (1<<16) /* no Tone volume */
408#define AC97_HAS_NO_STD_PCM (1<<17) /* no standard AC97 PCM volume and mute */
Rodolfo Giometti1459c782006-06-19 15:04:54 +0200409#define AC97_HAS_NO_AUX (1<<18) /* no standard AC97 AUX volume and mute */
Takashi Iwai4235a312008-02-18 12:23:13 +0100410#define AC97_HAS_8CH (1<<19) /* supports 8-channel output */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
412/* rates indexes */
413#define AC97_RATES_FRONT_DAC 0
414#define AC97_RATES_SURR_DAC 1
415#define AC97_RATES_LFE_DAC 2
416#define AC97_RATES_ADC 3
417#define AC97_RATES_MIC_ADC 4
418#define AC97_RATES_SPDIF 5
419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420/*
421 *
422 */
423
Takashi Iwaiee423812005-11-17 14:21:36 +0100424struct snd_ac97;
Takashi Iwai833a4932012-08-03 17:59:36 +0200425struct snd_pcm_chmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427struct snd_ac97_build_ops {
Takashi Iwaiee423812005-11-17 14:21:36 +0100428 int (*build_3d) (struct snd_ac97 *ac97);
429 int (*build_specific) (struct snd_ac97 *ac97);
430 int (*build_spdif) (struct snd_ac97 *ac97);
431 int (*build_post_spdif) (struct snd_ac97 *ac97);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432#ifdef CONFIG_PM
Takashi Iwaiee423812005-11-17 14:21:36 +0100433 void (*suspend) (struct snd_ac97 *ac97);
434 void (*resume) (struct snd_ac97 *ac97);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435#endif
Takashi Iwaiee423812005-11-17 14:21:36 +0100436 void (*update_jacks) (struct snd_ac97 *ac97); /* for jack-sharing */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437};
438
Takashi Iwaiee423812005-11-17 14:21:36 +0100439struct snd_ac97_bus_ops {
440 void (*reset) (struct snd_ac97 *ac97);
Richard Purdie808db4a2006-10-06 18:20:14 +0200441 void (*warm_reset)(struct snd_ac97 *ac97);
Takashi Iwaiee423812005-11-17 14:21:36 +0100442 void (*write) (struct snd_ac97 *ac97, unsigned short reg, unsigned short val);
443 unsigned short (*read) (struct snd_ac97 *ac97, unsigned short reg);
444 void (*wait) (struct snd_ac97 *ac97);
445 void (*init) (struct snd_ac97 *ac97);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446};
447
Takashi Iwaiee423812005-11-17 14:21:36 +0100448struct snd_ac97_bus {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 /* -- lowlevel (hardware) driver specific -- */
Takashi Iwaiee423812005-11-17 14:21:36 +0100450 struct snd_ac97_bus_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 void *private_data;
Takashi Iwaiee423812005-11-17 14:21:36 +0100452 void (*private_free) (struct snd_ac97_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 /* --- */
Takashi Iwaiee423812005-11-17 14:21:36 +0100454 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 unsigned short num; /* bus number */
456 unsigned short no_vra: 1, /* bridge doesn't support VRA */
457 dra: 1, /* bridge supports double rate */
458 isdin: 1;/* independent SDIN */
459 unsigned int clock; /* AC'97 base clock (usually 48000Hz) */
460 spinlock_t bus_lock; /* used mainly for slot allocation */
461 unsigned short used_slots[2][4]; /* actually used PCM slots */
462 unsigned short pcms_count; /* count of PCMs */
463 struct ac97_pcm *pcms;
Takashi Iwaiee423812005-11-17 14:21:36 +0100464 struct snd_ac97 *codec[4];
465 struct snd_info_entry *proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466};
467
Takashi Iwai7c5706b2006-03-15 13:52:54 +0100468/* static resolution table */
469struct snd_ac97_res_table {
470 unsigned short reg; /* register */
471 unsigned short bits; /* resolution bitmask */
472};
473
Takashi Iwaiee423812005-11-17 14:21:36 +0100474struct snd_ac97_template {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 void *private_data;
Takashi Iwaiee423812005-11-17 14:21:36 +0100476 void (*private_free) (struct snd_ac97 *ac97);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 struct pci_dev *pci; /* assigned PCI device - used for quirks */
478 unsigned short num; /* number of codec: 0 = primary, 1 = secondary */
479 unsigned short addr; /* physical address of codec [0-3] */
480 unsigned int scaps; /* driver capabilities */
Takashi Iwai7c5706b2006-03-15 13:52:54 +0100481 const struct snd_ac97_res_table *res_table; /* static resolution */
Takashi Iwai50dabc22006-02-09 11:45:20 +0100482};
483
Takashi Iwaiee423812005-11-17 14:21:36 +0100484struct snd_ac97 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 /* -- lowlevel (hardware) driver specific -- */
Hanno Boeck3e8b3b92011-01-14 19:14:47 +0100486 const struct snd_ac97_build_ops *build_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 void *private_data;
Takashi Iwaiee423812005-11-17 14:21:36 +0100488 void (*private_free) (struct snd_ac97 *ac97);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 /* --- */
Takashi Iwaiee423812005-11-17 14:21:36 +0100490 struct snd_ac97_bus *bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 struct pci_dev *pci; /* assigned PCI device - used for quirks */
Takashi Iwaiee423812005-11-17 14:21:36 +0100492 struct snd_info_entry *proc;
493 struct snd_info_entry *proc_regs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 unsigned short subsystem_vendor;
495 unsigned short subsystem_device;
Ingo Molnar62932df2006-01-16 16:34:20 +0100496 struct mutex reg_mutex;
497 struct mutex page_mutex; /* mutex for AD18xx multi-codecs and paging (2.3) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 unsigned short num; /* number of codec: 0 = primary, 1 = secondary */
499 unsigned short addr; /* physical address of codec [0-3] */
500 unsigned int id; /* identification of codec */
501 unsigned short caps; /* capabilities (register 0) */
502 unsigned short ext_id; /* extended feature identification (register 28) */
503 unsigned short ext_mid; /* extended modem ID (register 3C) */
Takashi Iwai50dabc22006-02-09 11:45:20 +0100504 const struct snd_ac97_res_table *res_table; /* static resolution */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 unsigned int scaps; /* driver capabilities */
506 unsigned int flags; /* specific code */
507 unsigned int rates[6]; /* see AC97_RATES_* defines */
508 unsigned int spdif_status;
509 unsigned short regs[0x80]; /* register cache */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 DECLARE_BITMAP(reg_accessed, 0x80); /* bit flags */
511 union { /* vendor specific code */
512 struct {
513 unsigned short unchained[3]; // 0 = C34, 1 = C79, 2 = C69
514 unsigned short chained[3]; // 0 = C34, 1 = C79, 2 = C69
515 unsigned short id[3]; // codec IDs (lower 16-bit word)
516 unsigned short pcmreg[3]; // PCM registers
517 unsigned short codec_cfg[3]; // CODEC_CFG bits
Randy Cushman67e9f4b2006-12-22 12:44:25 +0100518 unsigned char swap_mic_linein; // AD1986/AD1986A only
Takashi Iwaie48d6d92008-05-29 08:16:56 +0200519 unsigned char lo_as_master; /* LO as master */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 } ad18xx;
521 unsigned int dev_flags; /* device specific */
522 } spec;
Takashi Iwaieb8caf32005-04-13 14:32:57 +0200523 /* jack-sharing info */
524 unsigned char indep_surround;
525 unsigned char channel_mode;
Takashi Iwai6dbe6622006-06-27 18:28:53 +0200526
527#ifdef CONFIG_SND_AC97_POWER_SAVE
528 unsigned int power_up; /* power states */
David Howellsc4028952006-11-22 14:57:56 +0000529 struct delayed_work power_work;
Takashi Iwai6dbe6622006-06-27 18:28:53 +0200530#endif
Liam Girdwood0ca06a02005-07-29 16:13:36 +0200531 struct device dev;
Takashi Iwai833a4932012-08-03 17:59:36 +0200532
533 struct snd_pcm_chmap *chmaps[2]; /* channel-maps (optional) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534};
535
Takashi Iwaiee423812005-11-17 14:21:36 +0100536#define to_ac97_t(d) container_of(d, struct snd_ac97, dev)
Nicolas Pitre72e75de2005-09-16 18:49:22 +0200537
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538/* conditions */
Takashi Iwaiee423812005-11-17 14:21:36 +0100539static inline int ac97_is_audio(struct snd_ac97 * ac97)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540{
541 return (ac97->scaps & AC97_SCAP_AUDIO);
542}
Takashi Iwaiee423812005-11-17 14:21:36 +0100543static inline int ac97_is_modem(struct snd_ac97 * ac97)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544{
545 return (ac97->scaps & AC97_SCAP_MODEM);
546}
Takashi Iwaiee423812005-11-17 14:21:36 +0100547static inline int ac97_is_rev22(struct snd_ac97 * ac97)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548{
549 return (ac97->ext_id & AC97_EI_REV_MASK) >= AC97_EI_REV_22;
550}
Takashi Iwaiee423812005-11-17 14:21:36 +0100551static inline int ac97_can_amap(struct snd_ac97 * ac97)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552{
553 return (ac97->ext_id & AC97_EI_AMAP) != 0;
554}
Takashi Iwaiee423812005-11-17 14:21:36 +0100555static inline int ac97_can_spdif(struct snd_ac97 * ac97)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
557 return (ac97->ext_id & AC97_EI_SPDIF) != 0;
558}
559
560/* functions */
Takashi Iwaiee423812005-11-17 14:21:36 +0100561/* create new AC97 bus */
562int snd_ac97_bus(struct snd_card *card, int num, struct snd_ac97_bus_ops *ops,
563 void *private_data, struct snd_ac97_bus **rbus);
564/* create mixer controls */
565int snd_ac97_mixer(struct snd_ac97_bus *bus, struct snd_ac97_template *template,
566 struct snd_ac97 **rac97);
567const char *snd_ac97_get_short_name(struct snd_ac97 *ac97);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568
Takashi Iwaiee423812005-11-17 14:21:36 +0100569void snd_ac97_write(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
570unsigned short snd_ac97_read(struct snd_ac97 *ac97, unsigned short reg);
571void snd_ac97_write_cache(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
572int snd_ac97_update(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
573int snd_ac97_update_bits(struct snd_ac97 *ac97, unsigned short reg, unsigned short mask, unsigned short value);
Takashi Iwai6dbe6622006-06-27 18:28:53 +0200574#ifdef CONFIG_SND_AC97_POWER_SAVE
575int snd_ac97_update_power(struct snd_ac97 *ac97, int reg, int powerup);
576#else
577static inline int snd_ac97_update_power(struct snd_ac97 *ac97, int reg,
578 int powerup)
579{
580 return 0;
581}
582#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583#ifdef CONFIG_PM
Takashi Iwaiee423812005-11-17 14:21:36 +0100584void snd_ac97_suspend(struct snd_ac97 *ac97);
585void snd_ac97_resume(struct snd_ac97 *ac97);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586#endif
587
588/* quirk types */
589enum {
590 AC97_TUNE_DEFAULT = -1, /* use default from quirk list (not valid in list) */
591 AC97_TUNE_NONE = 0, /* nothing extra to do */
592 AC97_TUNE_HP_ONLY, /* headphone (true line-out) control as master only */
593 AC97_TUNE_SWAP_HP, /* swap headphone and master controls */
594 AC97_TUNE_SWAP_SURROUND, /* swap master and surround controls */
595 AC97_TUNE_AD_SHARING, /* for AD1985, turn on OMS bit and use headphone */
596 AC97_TUNE_ALC_JACK, /* for Realtek, enable JACK detection */
597 AC97_TUNE_INV_EAPD, /* inverted EAPD implementation */
598 AC97_TUNE_MUTE_LED, /* EAPD bit works as mute LED */
Matthew Garretta0faefe2005-12-06 13:59:12 +0100599 AC97_TUNE_HP_MUTE_LED, /* EAPD bit works as mute LED, use headphone control as master */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600};
601
602struct ac97_quirk {
Jaroslav Kysela69ad07c2005-05-30 14:48:16 +0200603 unsigned short subvendor; /* PCI subsystem vendor id */
Jean Delvare83cf0a92009-10-20 11:11:52 +0200604 unsigned short subdevice; /* PCI subsystem device id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 unsigned short mask; /* device id bit mask, 0 = accept all */
606 unsigned int codec_id; /* codec id (if any), 0 = accept all */
607 const char *name; /* name shown as info */
608 int type; /* quirk type above */
609};
610
Joe Percheseab0fbf2015-04-04 13:38:25 -0700611int snd_ac97_tune_hardware(struct snd_ac97 *ac97,
612 const struct ac97_quirk *quirk,
613 const char *override);
Takashi Iwaiee423812005-11-17 14:21:36 +0100614int snd_ac97_set_rate(struct snd_ac97 *ac97, int reg, unsigned int rate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Takashi Iwaib9b4bdd2005-11-17 10:42:40 +0100616/*
617 * PCM allocation
618 */
619
620enum ac97_pcm_cfg {
621 AC97_PCM_CFG_FRONT = 2,
622 AC97_PCM_CFG_REAR = 10, /* alias surround */
623 AC97_PCM_CFG_LFE = 11, /* center + lfe */
624 AC97_PCM_CFG_40 = 4, /* front + rear */
625 AC97_PCM_CFG_51 = 6, /* front + rear + center/lfe */
626 AC97_PCM_CFG_SPDIF = 20
627};
628
629struct ac97_pcm {
Takashi Iwaiee423812005-11-17 14:21:36 +0100630 struct snd_ac97_bus *bus;
Takashi Iwaib9b4bdd2005-11-17 10:42:40 +0100631 unsigned int stream: 1, /* stream type: 1 = capture */
632 exclusive: 1, /* exclusive mode, don't override with other pcms */
633 copy_flag: 1, /* lowlevel driver must fill all entries */
634 spdif: 1; /* spdif pcm */
635 unsigned short aslots; /* active slots */
Takashi Iwai6dbe6622006-06-27 18:28:53 +0200636 unsigned short cur_dbl; /* current double-rate state */
Takashi Iwaib9b4bdd2005-11-17 10:42:40 +0100637 unsigned int rates; /* available rates */
638 struct {
639 unsigned short slots; /* driver input: requested AC97 slot numbers */
640 unsigned short rslots[4]; /* allocated slots per codecs */
641 unsigned char rate_table[4];
Takashi Iwaiee423812005-11-17 14:21:36 +0100642 struct snd_ac97 *codec[4]; /* allocated codecs */
Takashi Iwaib9b4bdd2005-11-17 10:42:40 +0100643 } r[2]; /* 0 = standard rates, 1 = double rates */
644 unsigned long private_value; /* used by the hardware driver */
645};
646
Takashi Iwaiee423812005-11-17 14:21:36 +0100647int snd_ac97_pcm_assign(struct snd_ac97_bus *ac97,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 unsigned short pcms_count,
649 const struct ac97_pcm *pcms);
650int snd_ac97_pcm_open(struct ac97_pcm *pcm, unsigned int rate,
651 enum ac97_pcm_cfg cfg, unsigned short slots);
652int snd_ac97_pcm_close(struct ac97_pcm *pcm);
Takashi Iwaiee423812005-11-17 14:21:36 +0100653int snd_ac97_pcm_double_rate_rules(struct snd_pcm_runtime *runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Liam Girdwood0ca06a02005-07-29 16:13:36 +0200655/* ad hoc AC97 device driver access */
656extern struct bus_type ac97_bus_type;
657
Marek Vasut474828a2009-07-22 13:01:03 +0200658/* AC97 platform_data adding function */
659static inline void snd_ac97_dev_add_pdata(struct snd_ac97 *ac97, void *data)
660{
661 ac97->dev.platform_data = data;
662}
663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664#endif /* __SOUND_AC97_CODEC_H */