xref: /dragonfly/sys/dev/sound/pci/maestro_reg.h (revision 2a1ad637466621af45d5a17185b33f3dcaaa1b1c)
1 /*-
2  * Copyright (c) 1999-2000 Taku YAMAMOTO <taku@cent.saitama-u.ac.jp>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  *        maestro_reg.h,v 1.13 2001/11/11 18:29:46 taku Exp
27  * $FreeBSD: head/sys/dev/sound/pci/maestro_reg.h 137500 2004-11-10 04:29:09Z julian $
28  */
29 
30 #ifndef   MAESTRO_REG_H_INCLUDED
31 #define   MAESTRO_REG_H_INCLUDED
32 
33 /* -----------------------------
34  * PCI config registers
35  */
36 
37 /* Legacy emulation */
38 #define CONF_LEGACY 0x40
39 
40 #define LEGACY_DISABLED       0x8000
41 
42 /* Chip configurations */
43 #define CONF_MAESTRO          0x50
44 #define MAESTRO_PMC           0x08000000
45 #define MAESTRO_SPDIF                   0x01000000
46 #define MAESTRO_HWVOL                   0x00800000
47 #define MAESTRO_CHIBUS                  0x00100000
48 #define MAESTRO_POSTEDWRITE   0x00000080
49 #define MAESTRO_DMA_PCITIMING 0x00000040
50 #define MAESTRO_SWAP_LR                 0x00000020
51 
52 /* ACPI configurations */
53 #define CONF_ACPI_STOPCLOCK   0x54
54 #define ACPI_PART_2ndC_CLOCK  15
55 #define ACPI_PART_CODEC_CLOCK 14
56 #define ACPI_PART_978                   13 /* Docking station or something */
57 #define ACPI_PART_SPDIF                 12
58 #define ACPI_PART_GLUE                  11 /* What? */
59 #define ACPI_PART_DAA                   10
60 #define ACPI_PART_PCI_IF      9
61 #define ACPI_PART_HW_VOL      8
62 #define ACPI_PART_GPIO                  7
63 #define ACPI_PART_ASSP                  6
64 #define ACPI_PART_SB                    5
65 #define ACPI_PART_FM                    4
66 #define ACPI_PART_RINGBUS     3
67 #define ACPI_PART_MIDI                  2
68 #define ACPI_PART_GAME_PORT   1
69 #define ACPI_PART_WP                    0
70 
71 /* Power management */
72 #define   CONF_PM_PTR         0x34      /* BYTE R */
73 #define   PM_CID              0         /* BYTE R */
74 #define   PPMI_CID  1
75 #define   PM_CTRL             4         /* BYTE RW */
76 #define   PPMI_D0             0         /* Full power */
77 #define   PPMI_D1             1         /* Medium power */
78 #define   PPMI_D2             2         /* Low power */
79 #define   PPMI_D3             3         /* Turned off */
80 
81 
82 /* -----------------------------
83  * I/O ports
84  */
85 
86 /* Direct Sound Processor (aka WP) */
87 #define PORT_DSP_DATA         0x00      /* WORD RW */
88 #define PORT_DSP_INDEX        0x02      /* WORD RW */
89 #define PORT_INT_STAT         0x04      /* WORD RW */
90 #define PORT_SAMPLE_CNT       0x06      /* WORD RO */
91 
92 /* WaveCache */
93 #define PORT_WAVCACHE_INDEX   0x10      /* WORD RW */
94 #define PORT_WAVCACHE_DATA    0x12      /* WORD RW */
95 #define WAVCACHE_PCMBAR                 0x1fc
96 #define WAVCACHE_WTBAR                  0x1f0
97 #define WAVCACHE_BASEADDR_SHIFT         12
98 
99 #define WAVCACHE_CHCTL_ADDRTAG_MASK     0xfff8
100 #define WAVCACHE_CHCTL_U8               0x0004
101 #define WAVCACHE_CHCTL_STEREO           0x0002
102 #define WAVCACHE_CHCTL_DECREMENTAL      0x0001
103 
104 #define PORT_WAVCACHE_CTRL    0x14      /* WORD RW */
105 #define WAVCACHE_EXTRA_CH_ENABLED       0x0200
106 #define WAVCACHE_ENABLED                0x0100
107 #define WAVCACHE_CH_60_ENABLED                    0x0080
108 #define WAVCACHE_WTSIZE_MASK  0x0060
109 #define WAVCACHE_WTSIZE_1MB   0x0000
110 #define WAVCACHE_WTSIZE_2MB   0x0020
111 #define WAVCACHE_WTSIZE_4MB   0x0040
112 #define WAVCACHE_WTSIZE_8MB   0x0060
113 #define WAVCACHE_SGC_MASK               0x000c
114 #define WAVCACHE_SGC_DISABLED           0x0000
115 #define WAVCACHE_SGC_40_47              0x0004
116 #define WAVCACHE_SGC_32_47              0x0008
117 #define WAVCACHE_TESTMODE               0x0001
118 
119 /* Host Interruption */
120 #define PORT_HOSTINT_CTRL     0x18      /* WORD RW */
121 #define HOSTINT_CTRL_SOFT_RESET                   0x8000
122 #define HOSTINT_CTRL_DSOUND_RESET       0x4000
123 #define HOSTINT_CTRL_HW_VOL_TO_PME      0x0400
124 #define HOSTINT_CTRL_CLKRUN_ENABLED     0x0100
125 #define HOSTINT_CTRL_HWVOL_ENABLED      0x0040
126 #define HOSTINT_CTRL_ASSP_INT_ENABLED   0x0010
127 #define HOSTINT_CTRL_ISDN_INT_ENABLED   0x0008
128 #define HOSTINT_CTRL_DSOUND_INT_ENABLED 0x0004
129 #define HOSTINT_CTRL_MPU401_INT_ENABLED 0x0002
130 #define HOSTINT_CTRL_SB_INT_ENABLED     0x0001
131 
132 #define PORT_HOSTINT_STAT     0x1a      /* BYTE RW */
133 #define HOSTINT_STAT_HWVOL    0x40
134 #define HOSTINT_STAT_ASSP     0x10
135 #define HOSTINT_STAT_ISDN     0x08
136 #define HOSTINT_STAT_DSOUND   0x04
137 #define HOSTINT_STAT_MPU401   0x02
138 #define HOSTINT_STAT_SB                 0x01
139 
140 /* Hardware volume */
141 #define PORT_HWVOL_CTRL                 0x1b      /* BYTE RW */
142 #define HWVOL_CTRL_SPLIT_SHADOW         0x01
143 
144 #define PORT_HWVOL_VOICE_SHADOW         0x1c      /* BYTE RW */
145 #define PORT_HWVOL_VOICE      0x1d      /* BYTE RW */
146 #define PORT_HWVOL_MASTER_SHADOW 0x1e   /* BYTE RW */
147 #define PORT_HWVOL_MASTER     0x1f      /* BYTE RW */
148 #define HWVOL_NOP             0x88
149 #define HWVOL_MUTE            0x11
150 #define HWVOL_UP              0xaa
151 #define HWVOL_DOWN            0x66
152 
153 /* CODEC */
154 #define   PORT_CODEC_CMD      0x30      /* BYTE W */
155 #define CODEC_CMD_READ        0x80
156 #define   CODEC_CMD_WRITE     0x00
157 #define   CODEC_CMD_ADDR_MASK 0x7f
158 
159 #define PORT_CODEC_STAT       0x30      /* BYTE R */
160 #define CODEC_STAT_MASK       0x01
161 #define CODEC_STAT_RW_DONE    0x00
162 #define CODEC_STAT_PROGLESS   0x01
163 
164 #define PORT_CODEC_REG        0x32      /* WORD RW */
165 
166 /* Ring bus control */
167 #define PORT_RINGBUS_CTRL     0x34      /* DWORD RW */
168 #define RINGBUS_CTRL_I2S_ENABLED        0x80000000
169 #define RINGBUS_CTRL_RINGBUS_ENABLED    0x20000000
170 #define RINGBUS_CTRL_ACLINK_ENABLED     0x10000000
171 #define RINGBUS_CTRL_AC97_SWRESET       0x08000000
172 
173 #define RINGBUS_SRC_MIC                 20
174 #define RINGBUS_SRC_I2S                 16
175 #define RINGBUS_SRC_ADC                 12
176 #define RINGBUS_SRC_MODEM     8
177 #define RINGBUS_SRC_DSOUND    4
178 #define RINGBUS_SRC_ASSP      0
179 
180 #define RINGBUS_DEST_MONORAL  000
181 #define RINGBUS_DEST_STEREO   010
182 #define RINGBUS_DEST_NONE     0
183 #define RINGBUS_DEST_DAC      1
184 #define RINGBUS_DEST_MODEM_IN 2
185 #define RINGBUS_DEST_RESERVED3          3
186 #define RINGBUS_DEST_DSOUND_IN          4
187 #define RINGBUS_DEST_ASSP_IN  5
188 
189 /* Ring bus control B */
190 #define PORT_RINGBUS_CTRL_B   0x38      /* BYTE RW */
191 #define RINGBUS_CTRL_SSPE               0x40
192 #define RINGBUS_CTRL_2ndCODEC           0x20
193 #define RINGBUS_CTRL_SPDIF              0x10
194 #define RINGBUS_CTRL_ITB_DISABLE        0x08
195 #define RINGBUS_CTRL_CODEC_ID_MASK      0x03
196 #define RINGBUS_CTRL_CODEC_ID_AC98      2
197 
198 /* General Purpose I/O */
199 #define PORT_GPIO_DATA        0x60      /* WORD RW */
200 #define PORT_GPIO_MASK        0x64      /* WORD RW */
201 #define PORT_GPIO_DIR         0x68      /* WORD RW */
202 
203 /* Application Specific Signal Processor */
204 #define PORT_ASSP_MEM_INDEX   0x80      /* DWORD RW */
205 #define PORT_ASSP_MEM_DATA    0x84      /* WORD RW */
206 #define PORT_ASSP_CTRL_A      0xa2      /* BYTE RW */
207 #define PORT_ASSP_CTRL_B      0xa4      /* BYTE RW */
208 #define PORT_ASSP_CTRL_C      0xa6      /* BYTE RW */
209 #define PORT_ASSP_HOST_WR_INDEX         0xa8      /* BYTE W */
210 #define PORT_ASSP_HOST_WR_DATA          0xaa      /* BYTE RW */
211 #define PORT_ASSP_INT_STAT    0xac      /* BYTE RW */
212 
213 
214 /* -----------------------------
215  * Wave Processor Indexed Data Registers.
216  */
217 
218 #define WPREG_DATA_PORT                 0
219 #define WPREG_CRAM_PTR                  1
220 #define WPREG_CRAM_DATA                 2
221 #define WPREG_WAVE_DATA                 3
222 #define WPREG_WAVE_PTR_LOW    4
223 #define WPREG_WAVE_PTR_HIGH   5
224 
225 #define WPREG_TIMER_FREQ      6
226 #define WP_TIMER_FREQ_PRESCALE_MASK     0x00e0    /* actual - 9 */
227 #define WP_TIMER_FREQ_PRESCALE_SHIFT    5
228 #define WP_TIMER_FREQ_DIVIDE_MASK       0x001f
229 #define WP_TIMER_FREQ_DIVIDE_SHIFT      0
230 
231 #define WPREG_WAVE_ROMRAM     7
232 #define WP_WAVE_VIRTUAL_ENABLED         0x0400
233 #define WP_WAVE_8BITRAM_ENABLED         0x0200
234 #define WP_WAVE_DRAM_ENABLED  0x0100
235 #define WP_WAVE_RAMSPLIT_MASK 0x00ff
236 #define WP_WAVE_RAMSPLIT_SHIFT          0
237 
238 #define WPREG_BASE            12
239 #define WP_PARAOUT_BASE_MASK  0xf000
240 #define WP_PARAOUT_BASE_SHIFT 12
241 #define WP_PARAIN_BASE_MASK   0x0f00
242 #define WP_PARAIN_BASE_SHIFT  8
243 #define WP_SERIAL0_BASE_MASK  0x00f0
244 #define WP_SERIAL0_BASE_SHIFT 4
245 #define WP_SERIAL1_BASE_MASK  0x000f
246 #define WP_SERIAL1_BASE_SHIFT 0
247 
248 #define WPREG_TIMER_ENABLE    17
249 #define WPREG_TIMER_START     23
250 
251 
252 /* -----------------------------
253  * Audio Processing Unit.
254  */
255 #define APUREG_APUTYPE        0
256 #define APU_DMA_ENABLED       0x4000
257 #define APU_INT_ON_LOOP       0x2000
258 #define APU_ENDCURVE          0x1000
259 #define APU_APUTYPE_MASK      0x00f0
260 #define APU_FILTERTYPE_MASK   0x000c
261 #define APU_FILTERQ_MASK      0x0003
262 
263 /* APU types */
264 #define APU_APUTYPE_SHIFT     4
265 
266 #define APUTYPE_INACTIVE      0
267 #define APUTYPE_16BITLINEAR   1
268 #define APUTYPE_16BITSTEREO   2
269 #define APUTYPE_8BITLINEAR    3
270 #define APUTYPE_8BITSTEREO    4
271 #define APUTYPE_8BITDIFF      5
272 #define APUTYPE_DIGITALDELAY  6
273 #define APUTYPE_DUALTAP_READER          7
274 #define APUTYPE_CORRELATOR    8
275 #define APUTYPE_INPUTMIXER    9
276 #define APUTYPE_WAVETABLE     10
277 #define APUTYPE_RATECONV      11
278 #define APUTYPE_16BITPINGPONG 12
279 /* APU type 13 through 15 are reserved. */
280 
281 /* Filter types */
282 #define APU_FILTERTYPE_SHIFT  2
283 
284 #define FILTERTYPE_2POLE_LOPASS                   0
285 #define FILTERTYPE_2POLE_BANDPASS       1
286 #define FILTERTYPE_2POLE_HIPASS                   2
287 #define FILTERTYPE_1POLE_LOPASS                   3
288 #define FILTERTYPE_1POLE_HIPASS                   4
289 #define FILTERTYPE_PASSTHROUGH                    5
290 
291 /* Filter Q */
292 #define APU_FILTERQ_SHIFT     0
293 
294 #define FILTERQ_LESSQ         0
295 #define FILTERQ_MOREQ         3
296 
297 /* APU register 2 */
298 #define APUREG_FREQ_LOBYTE    2
299 #define APU_FREQ_LOBYTE_MASK  0xff00
300 #define APU_plus6dB           0x0010
301 
302 /* APU register 3 */
303 #define APUREG_FREQ_HIWORD    3
304 #define APU_FREQ_HIWORD_MASK  0x0fff
305 
306 /* Frequency */
307 #define APU_FREQ_LOBYTE_SHIFT 8
308 #define APU_FREQ_HIWORD_SHIFT 0
309 #define FREQ_Hz2DIV(freq)     (((u_int64_t)(freq) << 16) / 48000)
310 
311 /* APU register 4 */
312 #define APUREG_WAVESPACE      4
313 #define APU_64KPAGE_MASK      0xff00
314 
315 /* 64KW (==128KB) Page */
316 #define APU_64KPAGE_SHIFT     8
317 
318 /* Wave Processor Wavespace Address */
319 #define WPWA_MAX              ((1 << 22) - 1)
320 #define WPWA_STEREO           (1 << 23)
321 #define WPWA_USE_SYSMEM                 (1 << 22)
322 
323 #define WPWA_WTBAR_SHIFT(wtsz)          WPWA_WTBAR_SHIFT_##wtsz
324 #define WPWA_WTBAR_SHIFT_1    15
325 #define WPWA_WTBAR_SHIFT_2    16
326 #define WPWA_WTBAR_SHIFT_4    17
327 #define WPWA_WTBAR_SHIFT_8    18
328 
329 #define WPWA_PCMBAR_SHIFT     20
330 
331 /* APU register 5 - 7 */
332 #define APUREG_CURPTR         5
333 #define APUREG_ENDPTR         6
334 #define APUREG_LOOPLEN        7
335 
336 /* APU register 8 */
337 #define APUREG_EFFECT_GAIN    8
338 
339 /* Effect gain? */
340 #define APUREG_EFFECT_GAIN_MASK         0x00ff
341 
342 /* APU register 9 */
343 #define APUREG_AMPLITUDE      9
344 #define APU_AMPLITUDE_NOW_MASK          0xff00
345 #define APU_AMPLITUDE_DEST_MASK         0x00ff
346 
347 /* Amplitude now? */
348 #define APU_AMPLITUDE_NOW_SHIFT         8
349 
350 /* APU register 10 */
351 #define APUREG_POSITION       10
352 #define APU_RADIUS_MASK       0x00c0
353 #define APU_PAN_MASK          0x003f
354 
355 /* Radius control. */
356 #define APU_RADIUS_SHIFT      6
357 #define RADIUS_CENTERCIRCLE   0
358 #define RADIUS_MIDDLE                   1
359 #define RADIUS_OUTSIDE                  2
360 
361 /* Polar pan. */
362 #define APU_PAN_SHIFT         0
363 #define PAN_RIGHT   0x00
364 #define PAN_FRONT   0x08
365 #define PAN_LEFT    0x10
366 
367 /* Source routing. */
368 #define APUREG_ROUTING        11
369 #define APU_INVERT_POLARITY_B 0x8000
370 #define APU_DATASRC_B_MASK    0x7f00
371 #define APU_INVERT_POLARITY_A 0x0080
372 #define APU_DATASRC_A_MASK    0x007f
373 
374 #define APU_DATASRC_A_SHIFT   0
375 #define APU_DATASRC_B_SHIFT   8
376 
377 
378 /* -----------------------------
379  * Limits.
380  */
381 #define WPWA_MAXADDR          ((1 << 23) - 1)
382 #define MAESTRO_MAXADDR       ((1 << 28) - 1)
383 
384 #endif    /* MAESTRO_REG_H_INCLUDED */
385