1 /*        $NetBSD: ac97reg.h,v 1.14 2018/04/09 10:15:57 jmcneill Exp $          */
2 
3 /*
4  * Copyright (c) 1999 Constantine Sapuntzakis
5  *
6  * Author:        Constantine Sapuntzakis <csapuntz@stanford.edu>
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY CONSTANTINE SAPUNTZAKIS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
21  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #define   AC97_REG_RESET                          0x00
31 #define             AC97_CAPS_MICIN                         0x0001
32 #define             AC97_CAPS_MODEMLINECODEC      0x0002 /* 1.x only! */
33 #define             AC97_CAPS_TONECTRL            0x0004
34 #define             AC97_CAPS_SIMSTEREO           0x0008
35 #define             AC97_CAPS_HEADPHONES                    0x0010
36 #define             AC97_CAPS_LOUDNESS            0x0020
37 #define             AC97_CAPS_DAC18                         0x0040
38 #define             AC97_CAPS_DAC20                         0x0080
39 #define             AC97_CAPS_ADC18                         0x0100
40 #define             AC97_CAPS_ADC20                         0x0200
41 #define             AC97_CAPS_ENHANCEMENT_MASK    0xfc00
42 #define             AC97_CAPS_ENHANCEMENT_SHIFT   10
43 #define             AC97_CAPS_ENHANCEMENT(reg)    (((reg) >> 10) & 0x1f)
44 #define   AC97_REG_MASTER_VOLUME                  0x02
45 #define   AC97_REG_HEADPHONE_VOLUME     0x04
46 #define   AC97_REG_MASTER_VOLUME_MONO   0x06
47 #define   AC97_REG_MASTER_TONE                    0x08
48 #define   AC97_REG_PCBEEP_VOLUME                  0x0a
49 #define   AC97_REG_PHONE_VOLUME                   0x0c
50 #define   AC97_REG_MIC_VOLUME           0x0e
51 #define   AC97_REG_LINEIN_VOLUME                  0x10
52 #define   AC97_REG_CD_VOLUME            0x12
53 #define   AC97_REG_VIDEO_VOLUME                   0x14
54 #define   AC97_REG_AUX_VOLUME           0x16
55 #define   AC97_REG_PCMOUT_VOLUME                  0x18
56 #define   AC97_REG_RECORD_SELECT                  0x1a
57 #define   AC97_REG_RECORD_GAIN                    0x1c
58 #define   AC97_REG_RECORD_GAIN_MIC      0x1e /* for dedicated mic */
59 #define   AC97_REG_GP                             0x20
60 #define   AC97_REG_3D_CONTROL           0x22
61                                         /*        0x24      Modem sample rate in AC97 1.03
62                                                             Reserved in AC97 2.0
63                                                             Interrupt/paging in AC97 2.3 */
64 #define   AC97_REG_POWER                          0x26
65 #define             AC97_POWER_ADC                          0x0001
66 #define             AC97_POWER_DAC                          0x0002
67 #define             AC97_POWER_ANL                          0x0004
68 #define             AC97_POWER_REF                          0x0008
69 #define             AC97_POWER_IN                           0x0100
70 #define             AC97_POWER_OUT                          0x0200
71 #define             AC97_POWER_MIXER              0x0400
72 #define             AC97_POWER_MIXER_VREF                   0x0800
73 #define             AC97_POWER_ACLINK             0x1000
74 #define             AC97_POWER_CLK                          0x2000
75 #define             AC97_POWER_AUX                          0x4000
76 #define             AC97_POWER_EAMP                         0x8000
77 
78 /* AC'97 2.0 extensions -- 0x28-0x3a */
79 #define AC97_REG_EXT_AUDIO_ID           0x28
80 #define AC97_REG_EXT_AUDIO_CTRL                   0x2a
81 #define             AC97_EXT_AUDIO_VRA            0x0001
82 #define             AC97_EXT_AUDIO_DRA            0x0002
83 #define             AC97_EXT_AUDIO_SPDIF                    0x0004
84 #define             AC97_EXT_AUDIO_VRM            0x0008 /* for dedicated mic */
85 #define             AC97_EXT_AUDIO_DSA_MASK                 0x0030 /* for EXT ID */
86 #define              AC97_EXT_AUDIO_DSA00                   0x0000 /* for EXT ID */
87 #define              AC97_EXT_AUDIO_DSA01                   0x0010 /* for EXT ID */
88 #define              AC97_EXT_AUDIO_DSA10                   0x0020 /* for EXT ID */
89 #define              AC97_EXT_AUDIO_DSA11                   0x0030 /* for EXT ID */
90 #define             AC97_EXT_AUDIO_SPSA_MASK      0x0030 /* for EXT CTRL */
91 #define              AC97_EXT_AUDIO_SPSA34                  0x0000 /* for EXT CTRL */
92 #define              AC97_EXT_AUDIO_SPSA78                  0x0010 /* for EXT CTRL */
93 #define              AC97_EXT_AUDIO_SPSA69                  0x0020 /* for EXT CTRL */
94 #define              AC97_EXT_AUDIO_SPSAAB                  0x0030 /* for EXT CTRL */
95 #define             AC97_EXT_AUDIO_CDAC           0x0040
96 #define             AC97_EXT_AUDIO_SDAC           0x0080
97 #define             AC97_EXT_AUDIO_LDAC           0x0100
98 #define             AC97_EXT_AUDIO_AMAP           0x0200 /* for EXT ID */
99 #define             AC97_EXT_AUDIO_REV_MASK                 0x0C00 /* for EXT ID */
100 #define              AC97_EXT_AUDIO_REV_11                  0x0000 /* for EXT ID */
101 #define              AC97_EXT_AUDIO_REV_22                  0x0400 /* for EXT ID */
102 #define              AC97_EXT_AUDIO_REV_23                  0x0800 /* for EXT ID */
103 #define              AC97_EXT_AUDIO_REV_RESERVED11          0x0c00 /* for EXT ID */
104 #define             AC97_EXT_AUDIO_ID_MASK                  0xC000 /* for EXT ID */
105 #define              AC97_EXT_AUDIO_ID_PRIMARY    0x0000 /* for EXT ID */
106 #define              AC97_EXT_AUDIO_ID_SECONDARY01          0x4000 /* for EXT ID */
107 #define              AC97_EXT_AUDIO_ID_SECONDARY10          0x8000 /* for EXT ID */
108 #define              AC97_EXT_AUDIO_ID_SECONDARY11          0xc000 /* for EXT ID */
109 #define             AC97_EXT_AUDIO_MADC           0x0200 /* for EXT CTRL */
110 #define             AC97_EXT_AUDIO_SPCV           0x0400 /* for EXT CTRL */
111 #define             AC97_EXT_AUDIO_PRI            0x0800 /* for EXT CTRL */
112 #define             AC97_EXT_AUDIO_PRJ            0x1000 /* for EXT CTRL */
113 #define             AC97_EXT_AUDIO_PRK            0x2000 /* for EXT CTRL */
114 #define             AC97_EXT_AUDIO_PRL            0x4000 /* for EXT CTRL */
115 #define             AC97_EXT_AUDIO_VCFG           0x8000 /* for EXT CTRL */
116 
117 #define             AC97_SINGLE_RATE              48000
118 #define   AC97_REG_PCM_FRONT_DAC_RATE   0x2c
119 #define   AC97_REG_PCM_SURR_DAC_RATE    0x2e
120 #define   AC97_REG_PCM_LFE_DAC_RATE     0x30
121 #define   AC97_REG_PCM_LR_ADC_RATE      0x32
122 #define   AC97_REG_PCM_MIC_ADC_RATE     0x34      /* dedicated mic */
123 #define   AC97_REG_CENTER_LFE_MASTER    0x36      /* center + LFE master volume */
124 #define   AC97_REG_SURR_MASTER                    0x38      /* surround (rear) master vol */
125 #define AC97_REG_SPDIF_CTRL             0x3a
126 #define             AC97_SPDIF_V                            0x8000
127 #define             AC97_SPDIF_DRS                          0x4000
128 #define             AC97_SPDIF_SPSR_MASK                    0x3000
129 #define              AC97_SPDIF_SPSR_44K                    0x0000
130 #define              AC97_SPDIF_SPSR_48K                    0x2000
131 #define              AC97_SPDIF_SPSR_32K                    0x1000
132 #define             AC97_SPDIF_L                            0x0800
133 #define             AC97_SPDIF_CC_MASK            0x07f0
134 #define             AC97_SPDIF_PRE                          0x0008
135 #define             AC97_SPDIF_COPY                         0x0004
136 #define             AC97_SPDIF_NONAUDIO           0x0002
137 #define             AC97_SPDIF_PRO                          0x0001
138 
139 /* Modem -- 0x3c-0x58 */
140 #define   AC97_REG_EXT_MODEM_ID                   0x3c      /* extended modem id */
141 #define             AC97_EXT_MODEM_LINE1                    0x0001
142 #define             AC97_EXT_MODEM_LINE2                    0x0002
143 #define             AC97_EXT_MODEM_HANDSET                  0x0004
144 #define             AC97_EXT_MODEM_CID1           0x0008
145 #define             AC97_EXT_MODEM_CID2           0x0010
146 #define             AC97_EXT_MODEM_ID0            0x4000
147 #define             AC97_EXT_MODEM_ID1            0x8000
148 #define             AC97_EXT_MODEM_ID_MASK                  0xc000
149 #define   AC97_REG_EXT_MODEM_CTRL                 0x3e      /* extended modem ctrl */
150 #define             AC97_EXT_MODEM_CTRL_GPIO      0x0001    /* gpio is ready */
151 #define             AC97_EXT_MODEM_CTRL_MREF      0x0002    /* vref up */
152 #define             AC97_EXT_MODEM_CTRL_ADC1      0x0004    /* line1 adc ready */
153 #define             AC97_EXT_MODEM_CTRL_DAC1      0x0008    /* line1 dac ready */
154 #define             AC97_EXT_MODEM_CTRL_ADC2      0x0010    /* line2 adc ready */
155 #define             AC97_EXT_MODEM_CTRL_DAC2      0x0020    /* line2 dac ready */
156 #define             AC97_EXT_MODEM_CTRL_HADC      0x0040    /* handset adc ready */
157 #define             AC97_EXT_MODEM_CTRL_HDAC      0x0080    /* handset dac ready */
158 #define             AC97_EXT_MODEM_CTRL_PRA                 0x0100    /* gpio off */
159 #define             AC97_EXT_MODEM_CTRL_PRB                 0x0200    /* vref off */
160 #define             AC97_EXT_MODEM_CTRL_PRC                 0x0400    /* line1 adc off */
161 #define             AC97_EXT_MODEM_CTRL_PRD                 0x0800    /* line1 dac off */
162 #define             AC97_EXT_MODEM_CTRL_PRE                 0x1000    /* line2 adc off */
163 #define             AC97_EXT_MODEM_CTRL_PRF                 0x2000    /* line2 dac off */
164 #define             AC97_EXT_MODEM_CTRL_PRG                 0x4000    /* handset adc off */
165 #define             AC97_EXT_MODEM_CTRL_PRH                 0x8000    /* handset dac off */
166 #define AC97_REG_LINE1_RATE             0x40
167 #define   AC97_REG_LINE2_RATE           0x42
168 #define   AC97_REG_HANDSET_RATE                   0x44
169 #define   AC97_REG_LINE1_LEVEL                    0x46
170 #define   AC97_REG_LINE2_LEVEL                    0x48
171 #define   AC97_REG_HANDSET_LEVEL                  0x4a
172 #define   AC97_REG_GPIO_CFG             0x4c      /* gpio config */
173 #define   AC97_REG_GPIO_POLARITY                  0x4e      /* gpio pin polarity */
174 #define   AC97_REG_GPIO_STICKY                    0x50      /* gpio pin sticky */
175 #define   AC97_REG_GPIO_WAKEUP                    0x52      /* gpio pin wakeup */
176 #define   AC97_REG_GPIO_STATUS                    0x54
177 #define             AC97_GPIO_LINE1_OH            0x0001    /* off-hook */
178 #define             AC97_GPIO_LINE1_RI            0x0002    /* ring detect */
179 #define             AC97_GPIO_LINE1_CID           0x0004    /* caller-id */
180 #define             AC97_GPIO_LINE2_OH            0x0400    /* off-hook */
181 #define             AC97_GPIO_LINE2_RI            0x0800    /* ring detect */
182 #define             AC97_GPIO_LINE2_CID           0x1000    /* caller-id */
183 #define   AC97_REG_MISC_AFE             0x56      /* misc modem afe status & control */
184 #define             AC97_MISC_AFE_L1B_MASK                  0x0007    /* line1 loopback */
185 #define             AC97_MISC_AFE_L2B_MASK                  0x0070    /* line2 loopback */
186 #define             AC97_MISC_AFE_HSB_MASK                  0x0700    /* handset loopback */
187 #define             AC97_MISC_AFE_MLNK            0x1000    /* ac-link status */
188 #define             AC97_MISC_AFE_CID1            0x2000    /* line1 cid decode */
189 #define             AC97_MISC_AFE_CID2            0x4000    /* line2 cid decide */
190 #define             AC97_MISC_AFE_CIDR            0x8000    /* raw cid data */
191 
192 /* Modem loopback modes */
193 #define             AC97_LOOPBACK_DISABLE                   0
194 #define             AC97_LOOPBACK_ADC             1
195 #define             AC97_LOOPBACK_LOCAL_ANALOG    2
196 #define             AC97_LOOPBACK_DAC             3
197 #define             AC97_LOOPBACK_REMOTE_ANALOG   4
198 #define             AC97_LOOPBACK_VENDOR1                   5
199 #define             AC97_LOOPBACK_VENDOR2                   6
200 #define             AC97_LOOPBACK_VENDOR3                   7
201 
202 
203 
204 /* Vendor specific -- 0x5a-0x7b */
205 
206 #define   AC97_REG_VENDOR_ID1           0x7c
207 #define   AC97_REG_VENDOR_ID2           0x7e
208 #define             AC97_VENDOR_ID_MASK           0xffffff00
209 
210 #define   AC97_CODEC_ID(a0, a1, a2, x)                                          \
211           (((a0) << 24) | ((a1) << 16) | ((a2) << 8) | (x))
212 
213 #define   AC97_GET_CODEC_ID(id, cp)                                             \
214 do {                                                                                      \
215           (cp)[0] = ((id) >> 24) & 0xff;                                                  \
216           (cp)[1] = ((id) >> 16) & 0xff;                                                  \
217           (cp)[2] = ((id) >> 8)  & 0xff;                                                  \
218           (cp)[3] = (id) & 0xff;                                                          \
219 } while (0)
220 
221 /* AC-link slot assignments */
222 #define   AC97_SLOT_TAG                           0
223 #define   AC97_SLOT_ADDR                          1
224 #define   AC97_SLOT_DATA                          2
225 #define   AC97_SLOT_PCM_L                         3
226 #define   AC97_SLOT_PCM_R                         4
227 #define   AC97_SLOT_MODEM_LINE1                   5
228 #define   AC97_SLOT_PCM_C                         6         /* output */
229 #define   AC97_SLOT_MIC                           6         /* input */
230 #define   AC97_SLOT_PCM_SL              7         /* output */
231 #define   AC97_SLOT_PCM_SR              8         /* output */
232 #define   AC97_SLOT_LFE                           9         /* output */
233 #define   AC97_SLOT_MODEM_LINE2                   10
234 #define   AC97_SLOT_MODEM_HANDSET                 11
235 #define   AC97_SLOT_MODEM_GPIO                    12        /* input */
236