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