xref: /openbmc/linux/sound/pci/au88x0/au88x0.h (revision 1da177e4)
1 /*
2  *  This program is free software; you can redistribute it and/or modify
3  *  it under the terms of the GNU General Public License as published by
4  *  the Free Software Foundation; either version 2 of the License, or
5  *  (at your option) any later version.
6  *
7  *  This program is distributed in the hope that it will be useful,
8  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
9  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  *  GNU Library General Public License for more details.
11  *
12  *  You should have received a copy of the GNU General Public License
13  *  along with this program; if not, write to the Free Software
14  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
15  */
16 
17 #ifndef __SOUND_AU88X0_H
18 #define __SOUND_AU88X0_H
19 
20 #ifdef __KERNEL__
21 #include <sound/driver.h>
22 #include <linux/init.h>
23 #include <linux/pci.h>
24 #include <asm/io.h>
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27 #include <sound/rawmidi.h>
28 #include <sound/mpu401.h>
29 #include <sound/hwdep.h>
30 #include <sound/ac97_codec.h>
31 
32 #endif
33 
34 #ifndef CHIP_AU8820
35 #include "au88x0_eq.h"
36 #include "au88x0_a3d.h"
37 #endif
38 #ifndef CHIP_AU8810
39 #include "au88x0_wt.h"
40 #endif
41 
42 #define	VORTEX_DMA_MASK	0xffffffff
43 
44 #define	hwread(x,y) readl((x)+((y)>>2))
45 #define	hwwrite(x,y,z) writel((z),(x)+((y)>>2))
46 
47 /* Vortex MPU401 defines. */
48 #define	MIDI_CLOCK_DIV		0x61
49 /* Standart MPU401 defines. */
50 #define	MPU401_RESET		0xff
51 #define	MPU401_ENTER_UART	0x3f
52 #define	MPU401_ACK		0xfe
53 
54 // Get src register value to convert from x to y.
55 #define	SRC_RATIO(x,y)		((((x<<15)/y) + 1)/2)
56 
57 /* FIFO software state constants. */
58 #define FIFO_STOP 0
59 #define FIFO_START 1
60 #define FIFO_PAUSE 2
61 
62 /* IRQ flags */
63 #define IRQ_ERR_MASK	0x00ff
64 #define IRQ_FATAL	0x0001
65 #define IRQ_PARITY	0x0002
66 #define IRQ_REG		0x0004
67 #define IRQ_FIFO	0x0008
68 #define IRQ_DMA		0x0010
69 #define IRQ_PCMOUT	0x0020	/* PCM OUT page crossing */
70 #define IRQ_TIMER	0x1000
71 #define IRQ_MIDI	0x2000
72 #define IRQ_MODEM	0x4000
73 
74 /* ADB Resource */
75 #define VORTEX_RESOURCE_DMA	0x00000000
76 #define VORTEX_RESOURCE_SRC	0x00000001
77 #define VORTEX_RESOURCE_MIXIN	0x00000002
78 #define VORTEX_RESOURCE_MIXOUT	0x00000003
79 #define VORTEX_RESOURCE_A3D	0x00000004
80 #define VORTEX_RESOURCE_LAST	0x00000005
81 
82 /* Check for SDAC bit in "Extended audio ID" AC97 register */
83 //#define VORTEX_IS_QUAD(x) (((x)->codec == NULL) ?  0 : ((x)->codec->ext_id&0x80))
84 #define VORTEX_IS_QUAD(x) ((x)->isquad)
85 /* Check if chip has bug. */
86 #define IS_BAD_CHIP(x) (\
87 	(x->rev == 0xfe && x->device == PCI_DEVICE_ID_AUREAL_VORTEX_2) || \
88 	(x->rev == 0xfe && x->device == PCI_DEVICE_ID_AUREAL_ADVANTAGE))
89 
90 
91 /* PCM devices */
92 #define VORTEX_PCM_ADB		0
93 #define VORTEX_PCM_SPDIF	1
94 #define VORTEX_PCM_A3D		2
95 #define VORTEX_PCM_WT		3
96 #define VORTEX_PCM_I2S		4
97 #define VORTEX_PCM_LAST		5
98 
99 #define MIX_CAPT(x) (vortex->mixcapt[x])
100 #define MIX_PLAYB(x) (vortex->mixplayb[x])
101 #define MIX_SPDIF(x) (vortex->mixspdif[x])
102 
103 #define NR_WTPB 0x20		/* WT channels per eahc bank. */
104 
105 /* Structs */
106 typedef struct {
107 	//int this_08;          /* Still unknown */
108 	int fifo_enabled;	/* this_24 */
109 	int fifo_status;	/* this_1c */
110 	int dma_ctrl;		/* this_78 (ADB), this_7c (WT) */
111 	int dma_unknown;	/* this_74 (ADB), this_78 (WT). WDM: +8 */
112 	int cfg0;
113 	int cfg1;
114 
115 	int nr_ch;		/* Nr of PCM channels in use */
116 	int type;		/* Output type (ac97, a3d, spdif, i2s, dsp) */
117 	int dma;		/* Hardware DMA index. */
118 	int dir;		/* Stream Direction. */
119 	u32 resources[5];
120 
121 	/* Virtual page extender stuff */
122 	int nr_periods;
123 	int period_bytes;
124 	snd_pcm_sgbuf_t *sgbuf;	/* DMA Scatter Gather struct */
125 	int period_real;
126 	int period_virt;
127 
128 	snd_pcm_substream_t *substream;
129 } stream_t;
130 
131 typedef struct snd_vortex vortex_t;
132 struct snd_vortex {
133 	/* ALSA structs. */
134 	snd_card_t *card;
135 	snd_pcm_t *pcm[VORTEX_PCM_LAST];
136 
137 	snd_rawmidi_t *rmidi;	/* Legacy Midi interface. */
138 	ac97_t *codec;
139 
140 	/* Stream structs. */
141 	stream_t dma_adb[NR_ADB];
142 	int spdif_sr;
143 #ifndef CHIP_AU8810
144 	stream_t dma_wt[NR_WT];
145 	wt_voice_t wt_voice[NR_WT];	/* WT register cache. */
146 	char mixwt[(NR_WT / NR_WTPB) * 6];	/* WT mixin objects */
147 #endif
148 
149 	/* Global resources */
150 	s8 mixcapt[2];
151 	s8 mixplayb[4];
152 #ifndef CHIP_AU8820
153 	s8 mixspdif[2];
154 	s8 mixa3d[2];	/* mixers which collect all a3d streams. */
155 	s8 mixxtlk[2];	/* crosstalk canceler mixer inputs. */
156 #endif
157 	u32 fixed_res[5];
158 
159 #ifndef CHIP_AU8820
160 	/* Hardware equalizer structs */
161 	eqlzr_t eq;
162 	/* A3D structs */
163 	a3dsrc_t a3d[NR_A3D];
164 	/* Xtalk canceler */
165 	int xt_mode;		/* 1: speakers, 0:headphones. */
166 #endif
167 
168 	int isquad;		/* cache of extended ID codec flag. */
169 
170 	/* Gameport stuff. */
171 	struct gameport *gameport;
172 
173 	/* PCI hardware resources */
174 	unsigned long io;
175 	unsigned long __iomem *mmio;
176 	unsigned int irq;
177 	spinlock_t lock;
178 
179 	/* PCI device */
180 	struct pci_dev *pci_dev;
181 	u16 vendor;
182 	u16 device;
183 	u8 rev;
184 };
185 
186 /* Functions. */
187 
188 /* SRC */
189 static void vortex_adb_setsrc(vortex_t * vortex, int adbdma,
190 			      unsigned int cvrt, int dir);
191 
192 /* DMA Engines. */
193 static void vortex_adbdma_setbuffers(vortex_t * vortex, int adbdma,
194 				     snd_pcm_sgbuf_t * sgbuf, int size,
195 				     int count);
196 static void vortex_adbdma_setmode(vortex_t * vortex, int adbdma, int ie,
197 				  int dir, int fmt, int d,
198 				  unsigned long offset);
199 static void vortex_adbdma_setstartbuffer(vortex_t * vortex, int adbdma, int sb);
200 #ifndef CHIP_AU8810
201 static void vortex_wtdma_setbuffers(vortex_t * vortex, int wtdma,
202 				    snd_pcm_sgbuf_t * sgbuf, int size,
203 				    int count);
204 static void vortex_wtdma_setmode(vortex_t * vortex, int wtdma, int ie, int fmt, int d,	/*int e, */
205 				 unsigned long offset);
206 static void vortex_wtdma_setstartbuffer(vortex_t * vortex, int wtdma, int sb);
207 #endif
208 
209 static void vortex_adbdma_startfifo(vortex_t * vortex, int adbdma);
210 //static void vortex_adbdma_stopfifo(vortex_t *vortex, int adbdma);
211 static void vortex_adbdma_pausefifo(vortex_t * vortex, int adbdma);
212 static void vortex_adbdma_resumefifo(vortex_t * vortex, int adbdma);
213 static int inline vortex_adbdma_getlinearpos(vortex_t * vortex, int adbdma);
214 static void vortex_adbdma_resetup(vortex_t *vortex, int adbdma);
215 
216 #ifndef CHIP_AU8810
217 static void vortex_wtdma_startfifo(vortex_t * vortex, int wtdma);
218 static void vortex_wtdma_stopfifo(vortex_t * vortex, int wtdma);
219 static void vortex_wtdma_pausefifo(vortex_t * vortex, int wtdma);
220 static void vortex_wtdma_resumefifo(vortex_t * vortex, int wtdma);
221 static int inline vortex_wtdma_getlinearpos(vortex_t * vortex, int wtdma);
222 #endif
223 
224 /* global stuff. */
225 static void vortex_codec_init(vortex_t * vortex);
226 static void vortex_codec_write(ac97_t * codec, unsigned short addr,
227 			       unsigned short data);
228 static unsigned short vortex_codec_read(ac97_t * codec, unsigned short addr);
229 static void vortex_spdif_init(vortex_t * vortex, int spdif_sr, int spdif_mode);
230 
231 static int vortex_core_init(vortex_t * card);
232 static int vortex_core_shutdown(vortex_t * card);
233 static void vortex_enable_int(vortex_t * card);
234 static irqreturn_t vortex_interrupt(int irq, void *dev_id,
235 				    struct pt_regs *regs);
236 static int vortex_alsafmt_aspfmt(int alsafmt);
237 
238 /* Connection  stuff. */
239 static void vortex_connect_default(vortex_t * vortex, int en);
240 static int vortex_adb_allocroute(vortex_t * vortex, int dma, int nr_ch,
241 				 int dir, int type);
242 static char vortex_adb_checkinout(vortex_t * vortex, int resmap[], int out,
243 				  int restype);
244 #ifndef CHIP_AU8810
245 static int vortex_wt_allocroute(vortex_t * vortex, int dma, int nr_ch);
246 static void vortex_wt_connect(vortex_t * vortex, int en);
247 static void vortex_wt_init(vortex_t * vortex);
248 #endif
249 
250 static void vortex_route(vortex_t * vortex, int en, unsigned char channel,
251 			 unsigned char source, unsigned char dest);
252 #if 0
253 static void vortex_routes(vortex_t * vortex, int en, unsigned char channel,
254 			  unsigned char source, unsigned char dest0,
255 			  unsigned char dest1);
256 #endif
257 static void vortex_connection_mixin_mix(vortex_t * vortex, int en,
258 					unsigned char mixin,
259 					unsigned char mix, int a);
260 static void vortex_mix_setinputvolumebyte(vortex_t * vortex,
261 					  unsigned char mix, int mixin,
262 					  unsigned char vol);
263 static void vortex_mix_setvolumebyte(vortex_t * vortex, unsigned char mix,
264 				     unsigned char vol);
265 
266 /* A3D functions. */
267 #ifndef CHIP_AU8820
268 static void vortex_Vort3D(vortex_t * v, int en);
269 static void vortex_Vort3D_connect(vortex_t * vortex, int en);
270 static void vortex_Vort3D_InitializeSource(a3dsrc_t * a, int en);
271 #endif
272 
273 /* Driver stuff. */
274 static int __devinit vortex_gameport_register(vortex_t * card);
275 static void vortex_gameport_unregister(vortex_t * card);
276 #ifndef CHIP_AU8820
277 static int __devinit vortex_eq_init(vortex_t * vortex);
278 static int __devexit vortex_eq_free(vortex_t * vortex);
279 #endif
280 /* ALSA stuff. */
281 static int __devinit snd_vortex_new_pcm(vortex_t * vortex, int idx, int nr);
282 static int __devinit snd_vortex_mixer(vortex_t * vortex);
283 static int __devinit snd_vortex_midi(vortex_t * vortex);
284 #endif
285