1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 *   Driver for the Conexant Riptide Soundchip
4 *
5 *	Copyright (c) 2004 Peter Gruber <nokos@gmx.net>
6 */
7/*
8  History:
9   - 02/15/2004 first release
10
11  This Driver is based on the OSS Driver version from Linuxant (riptide-0.6lnxtbeta03111100)
12  credits from the original files:
13
14  MODULE NAME:        cnxt_rt.h
15  AUTHOR:             K. Lazarev  (Transcribed by KNL)
16  HISTORY:         Major Revision               Date        By
17            -----------------------------     --------     -----
18            Created                           02/1/2000     KNL
19
20  MODULE NAME:     int_mdl.c
21  AUTHOR:          Konstantin Lazarev    (Transcribed by KNL)
22  HISTORY:         Major Revision               Date        By
23            -----------------------------     --------     -----
24            Created                           10/01/99      KNL
25
26  MODULE NAME:        riptide.h
27  AUTHOR:             O. Druzhinin  (Transcribed by OLD)
28  HISTORY:         Major Revision               Date        By
29            -----------------------------     --------     -----
30            Created                           10/16/97      OLD
31
32  MODULE NAME:        Rp_Cmdif.cpp
33  AUTHOR:             O. Druzhinin  (Transcribed by OLD)
34                      K. Lazarev    (Transcribed by KNL)
35  HISTORY:         Major Revision               Date        By
36            -----------------------------     --------     -----
37            Adopted from NT4 driver            6/22/99      OLD
38            Ported to Linux                    9/01/99      KNL
39
40  MODULE NAME:        rt_hw.c
41  AUTHOR:             O. Druzhinin  (Transcribed by OLD)
42                      C. Lazarev    (Transcribed by CNL)
43  HISTORY:         Major Revision               Date        By
44            -----------------------------     --------     -----
45            Created                           11/18/97      OLD
46            Hardware functions for RipTide    11/24/97      CNL
47            (ES1) are coded
48            Hardware functions for RipTide    12/24/97      CNL
49            (A0) are coded
50            Hardware functions for RipTide    03/20/98      CNL
51            (A1) are coded
52            Boot loader is included           05/07/98      CNL
53            Redesigned for WDM                07/27/98      CNL
54            Redesigned for Linux              09/01/99      CNL
55
56  MODULE NAME:        rt_hw.h
57  AUTHOR:             C. Lazarev    (Transcribed by CNL)
58  HISTORY:         Major Revision               Date        By
59            -----------------------------     --------     -----
60            Created                           11/18/97      CNL
61
62  MODULE NAME:     rt_mdl.c
63  AUTHOR:          Konstantin Lazarev    (Transcribed by KNL)
64  HISTORY:         Major Revision               Date        By
65            -----------------------------     --------     -----
66            Created                           10/01/99      KNL
67
68  MODULE NAME:        mixer.h
69  AUTHOR:             K. Kenney
70  HISTORY:         Major Revision                   Date          By
71            -----------------------------          --------     -----
72            Created from MS W95 Sample             11/28/95      KRS
73            RipTide                                10/15/97      KRS
74            Adopted for Windows NT driver          01/20/98      CNL
75*/
76
77#include <linux/delay.h>
78#include <linux/init.h>
79#include <linux/interrupt.h>
80#include <linux/pci.h>
81#include <linux/slab.h>
82#include <linux/wait.h>
83#include <linux/gameport.h>
84#include <linux/device.h>
85#include <linux/firmware.h>
86#include <linux/kernel.h>
87#include <linux/module.h>
88#include <linux/io.h>
89#include <sound/core.h>
90#include <sound/info.h>
91#include <sound/control.h>
92#include <sound/pcm.h>
93#include <sound/pcm_params.h>
94#include <sound/ac97_codec.h>
95#include <sound/mpu401.h>
96#include <sound/opl3.h>
97#include <sound/initval.h>
98
99#if IS_REACHABLE(CONFIG_GAMEPORT)
100#define SUPPORT_JOYSTICK 1
101#endif
102
103MODULE_AUTHOR("Peter Gruber <nokos@gmx.net>");
104MODULE_DESCRIPTION("riptide");
105MODULE_LICENSE("GPL");
106MODULE_SUPPORTED_DEVICE("{{Conexant,Riptide}}");
107MODULE_FIRMWARE("riptide.hex");
108
109static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
110static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
111static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE;
112
113#ifdef SUPPORT_JOYSTICK
114static int joystick_port[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS - 1)] = 0x200 };
115#endif
116static int mpu_port[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS - 1)] = 0x330 };
117static int opl3_port[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS - 1)] = 0x388 };
118
119module_param_array(index, int, NULL, 0444);
120MODULE_PARM_DESC(index, "Index value for Riptide soundcard.");
121module_param_array(id, charp, NULL, 0444);
122MODULE_PARM_DESC(id, "ID string for Riptide soundcard.");
123module_param_array(enable, bool, NULL, 0444);
124MODULE_PARM_DESC(enable, "Enable Riptide soundcard.");
125#ifdef SUPPORT_JOYSTICK
126module_param_hw_array(joystick_port, int, ioport, NULL, 0444);
127MODULE_PARM_DESC(joystick_port, "Joystick port # for Riptide soundcard.");
128#endif
129module_param_hw_array(mpu_port, int, ioport, NULL, 0444);
130MODULE_PARM_DESC(mpu_port, "MPU401 port # for Riptide driver.");
131module_param_hw_array(opl3_port, int, ioport, NULL, 0444);
132MODULE_PARM_DESC(opl3_port, "OPL3 port # for Riptide driver.");
133
134/*
135 */
136
137#define MPU401_HW_RIPTIDE MPU401_HW_MPU401
138#define OPL3_HW_RIPTIDE   OPL3_HW_OPL3
139
140#define PCI_EXT_CapId       0x40
141#define PCI_EXT_NextCapPrt  0x41
142#define PCI_EXT_PWMC        0x42
143#define PCI_EXT_PWSCR       0x44
144#define PCI_EXT_Data00      0x46
145#define PCI_EXT_PMSCR_BSE   0x47
146#define PCI_EXT_SB_Base     0x48
147#define PCI_EXT_FM_Base     0x4a
148#define PCI_EXT_MPU_Base    0x4C
149#define PCI_EXT_Game_Base   0x4E
150#define PCI_EXT_Legacy_Mask 0x50
151#define PCI_EXT_AsicRev     0x52
152#define PCI_EXT_Reserved3   0x53
153
154#define LEGACY_ENABLE_ALL      0x8000	/* legacy device options */
155#define LEGACY_ENABLE_SB       0x4000
156#define LEGACY_ENABLE_FM       0x2000
157#define LEGACY_ENABLE_MPU_INT  0x1000
158#define LEGACY_ENABLE_MPU      0x0800
159#define LEGACY_ENABLE_GAMEPORT 0x0400
160
161#define MAX_WRITE_RETRY  10	/* cmd interface limits */
162#define MAX_ERROR_COUNT  10
163#define CMDIF_TIMEOUT    50000
164#define RESET_TRIES      5
165
166#define READ_PORT_ULONG(p)     inl((unsigned long)&(p))
167#define WRITE_PORT_ULONG(p,x)  outl(x,(unsigned long)&(p))
168
169#define READ_AUDIO_CONTROL(p)     READ_PORT_ULONG(p->audio_control)
170#define WRITE_AUDIO_CONTROL(p,x)  WRITE_PORT_ULONG(p->audio_control,x)
171#define UMASK_AUDIO_CONTROL(p,x)  WRITE_PORT_ULONG(p->audio_control,READ_PORT_ULONG(p->audio_control)|x)
172#define MASK_AUDIO_CONTROL(p,x)   WRITE_PORT_ULONG(p->audio_control,READ_PORT_ULONG(p->audio_control)&x)
173#define READ_AUDIO_STATUS(p)      READ_PORT_ULONG(p->audio_status)
174
175#define SET_GRESET(p)     UMASK_AUDIO_CONTROL(p,0x0001)	/* global reset switch */
176#define UNSET_GRESET(p)   MASK_AUDIO_CONTROL(p,~0x0001)
177#define SET_AIE(p)        UMASK_AUDIO_CONTROL(p,0x0004)	/* interrupt enable */
178#define UNSET_AIE(p)      MASK_AUDIO_CONTROL(p,~0x0004)
179#define SET_AIACK(p)      UMASK_AUDIO_CONTROL(p,0x0008)	/* interrupt acknowledge */
180#define UNSET_AIACKT(p)   MASKAUDIO_CONTROL(p,~0x0008)
181#define SET_ECMDAE(p)     UMASK_AUDIO_CONTROL(p,0x0010)
182#define UNSET_ECMDAE(p)   MASK_AUDIO_CONTROL(p,~0x0010)
183#define SET_ECMDBE(p)     UMASK_AUDIO_CONTROL(p,0x0020)
184#define UNSET_ECMDBE(p)   MASK_AUDIO_CONTROL(p,~0x0020)
185#define SET_EDATAF(p)     UMASK_AUDIO_CONTROL(p,0x0040)
186#define UNSET_EDATAF(p)   MASK_AUDIO_CONTROL(p,~0x0040)
187#define SET_EDATBF(p)     UMASK_AUDIO_CONTROL(p,0x0080)
188#define UNSET_EDATBF(p)   MASK_AUDIO_CONTROL(p,~0x0080)
189#define SET_ESBIRQON(p)   UMASK_AUDIO_CONTROL(p,0x0100)
190#define UNSET_ESBIRQON(p) MASK_AUDIO_CONTROL(p,~0x0100)
191#define SET_EMPUIRQ(p)    UMASK_AUDIO_CONTROL(p,0x0200)
192#define UNSET_EMPUIRQ(p)  MASK_AUDIO_CONTROL(p,~0x0200)
193#define IS_CMDE(a)        (READ_PORT_ULONG(a->stat)&0x1)	/* cmd empty */
194#define IS_DATF(a)        (READ_PORT_ULONG(a->stat)&0x2)	/* data filled */
195#define IS_READY(p)       (READ_AUDIO_STATUS(p)&0x0001)
196#define IS_DLREADY(p)     (READ_AUDIO_STATUS(p)&0x0002)
197#define IS_DLERR(p)       (READ_AUDIO_STATUS(p)&0x0004)
198#define IS_GERR(p)        (READ_AUDIO_STATUS(p)&0x0008)	/* error ! */
199#define IS_CMDAEIRQ(p)    (READ_AUDIO_STATUS(p)&0x0010)
200#define IS_CMDBEIRQ(p)    (READ_AUDIO_STATUS(p)&0x0020)
201#define IS_DATAFIRQ(p)    (READ_AUDIO_STATUS(p)&0x0040)
202#define IS_DATBFIRQ(p)    (READ_AUDIO_STATUS(p)&0x0080)
203#define IS_EOBIRQ(p)      (READ_AUDIO_STATUS(p)&0x0100)	/* interrupt status */
204#define IS_EOSIRQ(p)      (READ_AUDIO_STATUS(p)&0x0200)
205#define IS_EOCIRQ(p)      (READ_AUDIO_STATUS(p)&0x0400)
206#define IS_UNSLIRQ(p)     (READ_AUDIO_STATUS(p)&0x0800)
207#define IS_SBIRQ(p)       (READ_AUDIO_STATUS(p)&0x1000)
208#define IS_MPUIRQ(p)      (READ_AUDIO_STATUS(p)&0x2000)
209
210#define RESP 0x00000001		/* command flags */
211#define PARM 0x00000002
212#define CMDA 0x00000004
213#define CMDB 0x00000008
214#define NILL 0x00000000
215
216#define LONG0(a)   ((u32)a)	/* shifts and masks */
217#define BYTE0(a)   (LONG0(a)&0xff)
218#define BYTE1(a)   (BYTE0(a)<<8)
219#define BYTE2(a)   (BYTE0(a)<<16)
220#define BYTE3(a)   (BYTE0(a)<<24)
221#define WORD0(a)   (LONG0(a)&0xffff)
222#define WORD1(a)   (WORD0(a)<<8)
223#define WORD2(a)   (WORD0(a)<<16)
224#define TRINIB0(a) (LONG0(a)&0xffffff)
225#define TRINIB1(a) (TRINIB0(a)<<8)
226
227#define RET(a)     ((union cmdret *)(a))
228
229#define SEND_GETV(p,b)             sendcmd(p,RESP,GETV,0,RET(b))	/* get version */
230#define SEND_GETC(p,b,c)           sendcmd(p,PARM|RESP,GETC,c,RET(b))
231#define SEND_GUNS(p,b)             sendcmd(p,RESP,GUNS,0,RET(b))
232#define SEND_SCID(p,b)             sendcmd(p,RESP,SCID,0,RET(b))
233#define SEND_RMEM(p,b,c,d)         sendcmd(p,PARM|RESP,RMEM|BYTE1(b),LONG0(c),RET(d))	/* memory access for firmware write */
234#define SEND_SMEM(p,b,c)           sendcmd(p,PARM,SMEM|BYTE1(b),LONG0(c),RET(0))	/* memory access for firmware write */
235#define SEND_WMEM(p,b,c)           sendcmd(p,PARM,WMEM|BYTE1(b),LONG0(c),RET(0))	/* memory access for firmware write */
236#define SEND_SDTM(p,b,c)           sendcmd(p,PARM|RESP,SDTM|TRINIB1(b),0,RET(c))	/* memory access for firmware write */
237#define SEND_GOTO(p,b)             sendcmd(p,PARM,GOTO,LONG0(b),RET(0))	/* memory access for firmware write */
238#define SEND_SETDPLL(p)	           sendcmd(p,0,ARM_SETDPLL,0,RET(0))
239#define SEND_SSTR(p,b,c)           sendcmd(p,PARM,SSTR|BYTE3(b),LONG0(c),RET(0))	/* start stream */
240#define SEND_PSTR(p,b)             sendcmd(p,PARM,PSTR,BYTE3(b),RET(0))	/* pause stream */
241#define SEND_KSTR(p,b)             sendcmd(p,PARM,KSTR,BYTE3(b),RET(0))	/* stop stream */
242#define SEND_KDMA(p)               sendcmd(p,0,KDMA,0,RET(0))	/* stop all dma */
243#define SEND_GPOS(p,b,c,d)         sendcmd(p,PARM|RESP,GPOS,BYTE3(c)|BYTE2(b),RET(d))	/* get position in dma */
244#define SEND_SETF(p,b,c,d,e,f,g)   sendcmd(p,PARM,SETF|WORD1(b)|BYTE3(c),d|BYTE1(e)|BYTE2(f)|BYTE3(g),RET(0))	/* set sample format at mixer */
245#define SEND_GSTS(p,b,c,d)         sendcmd(p,PARM|RESP,GSTS,BYTE3(c)|BYTE2(b),RET(d))
246#define SEND_NGPOS(p,b,c,d)        sendcmd(p,PARM|RESP,NGPOS,BYTE3(c)|BYTE2(b),RET(d))
247#define SEND_PSEL(p,b,c)           sendcmd(p,PARM,PSEL,BYTE2(b)|BYTE3(c),RET(0))	/* activate lbus path */
248#define SEND_PCLR(p,b,c)           sendcmd(p,PARM,PCLR,BYTE2(b)|BYTE3(c),RET(0))	/* deactivate lbus path */
249#define SEND_PLST(p,b)             sendcmd(p,PARM,PLST,BYTE3(b),RET(0))
250#define SEND_RSSV(p,b,c,d)         sendcmd(p,PARM|RESP,RSSV,BYTE2(b)|BYTE3(c),RET(d))
251#define SEND_LSEL(p,b,c,d,e,f,g,h) sendcmd(p,PARM,LSEL|BYTE1(b)|BYTE2(c)|BYTE3(d),BYTE0(e)|BYTE1(f)|BYTE2(g)|BYTE3(h),RET(0))	/* select paths for internal connections */
252#define SEND_SSRC(p,b,c,d,e)       sendcmd(p,PARM,SSRC|BYTE1(b)|WORD2(c),WORD0(d)|WORD2(e),RET(0))	/* configure source */
253#define SEND_SLST(p,b)             sendcmd(p,PARM,SLST,BYTE3(b),RET(0))
254#define SEND_RSRC(p,b,c)           sendcmd(p,RESP,RSRC|BYTE1(b),0,RET(c))	/* read source config */
255#define SEND_SSRB(p,b,c)           sendcmd(p,PARM,SSRB|BYTE1(b),WORD2(c),RET(0))
256#define SEND_SDGV(p,b,c,d,e)       sendcmd(p,PARM,SDGV|BYTE2(b)|BYTE3(c),WORD0(d)|WORD2(e),RET(0))	/* set digital mixer */
257#define SEND_RDGV(p,b,c,d)         sendcmd(p,PARM|RESP,RDGV|BYTE2(b)|BYTE3(c),0,RET(d))	/* read digital mixer */
258#define SEND_DLST(p,b)             sendcmd(p,PARM,DLST,BYTE3(b),RET(0))
259#define SEND_SACR(p,b,c)           sendcmd(p,PARM,SACR,WORD0(b)|WORD2(c),RET(0))	/* set AC97 register */
260#define SEND_RACR(p,b,c)           sendcmd(p,PARM|RESP,RACR,WORD2(b),RET(c))	/* get AC97 register */
261#define SEND_ALST(p,b)             sendcmd(p,PARM,ALST,BYTE3(b),RET(0))
262#define SEND_TXAC(p,b,c,d,e,f)     sendcmd(p,PARM,TXAC|BYTE1(b)|WORD2(c),WORD0(d)|BYTE2(e)|BYTE3(f),RET(0))
263#define SEND_RXAC(p,b,c,d)         sendcmd(p,PARM|RESP,RXAC,BYTE2(b)|BYTE3(c),RET(d))
264#define SEND_SI2S(p,b)             sendcmd(p,PARM,SI2S,WORD2(b),RET(0))
265
266#define EOB_STATUS         0x80000000	/* status flags : block boundary */
267#define EOS_STATUS         0x40000000	/*              : stoppped */
268#define EOC_STATUS         0x20000000	/*              : stream end */
269#define ERR_STATUS         0x10000000
270#define EMPTY_STATUS       0x08000000
271
272#define IEOB_ENABLE        0x1	/* enable interrupts for status notification above */
273#define IEOS_ENABLE        0x2
274#define IEOC_ENABLE        0x4
275#define RDONCE             0x8
276#define DESC_MAX_MASK      0xff
277
278#define ST_PLAY  0x1		/* stream states */
279#define ST_STOP  0x2
280#define ST_PAUSE 0x4
281
282#define I2S_INTDEC     3	/* config for I2S link */
283#define I2S_MERGER     0
284#define I2S_SPLITTER   0
285#define I2S_MIXER      7
286#define I2S_RATE       44100
287
288#define MODEM_INTDEC   4	/* config for modem link */
289#define MODEM_MERGER   3
290#define MODEM_SPLITTER 0
291#define MODEM_MIXER    11
292
293#define FM_INTDEC      3	/* config for FM/OPL3 link */
294#define FM_MERGER      0
295#define FM_SPLITTER    0
296#define FM_MIXER       9
297
298#define SPLIT_PATH  0x80	/* path splitting flag */
299
300enum FIRMWARE {
301	DATA_REC = 0, EXT_END_OF_FILE, EXT_SEG_ADDR_REC, EXT_GOTO_CMD_REC,
302	EXT_LIN_ADDR_REC,
303};
304
305enum CMDS {
306	GETV = 0x00, GETC, GUNS, SCID, RMEM =
307	    0x10, SMEM, WMEM, SDTM, GOTO, SSTR =
308	    0x20, PSTR, KSTR, KDMA, GPOS, SETF, GSTS, NGPOS, PSEL =
309	    0x30, PCLR, PLST, RSSV, LSEL, SSRC = 0x40, SLST, RSRC, SSRB, SDGV =
310	    0x50, RDGV, DLST, SACR = 0x60, RACR, ALST, TXAC, RXAC, SI2S =
311	    0x70, ARM_SETDPLL = 0x72,
312};
313
314enum E1SOURCE {
315	ARM2LBUS_FIFO0 = 0, ARM2LBUS_FIFO1, ARM2LBUS_FIFO2, ARM2LBUS_FIFO3,
316	ARM2LBUS_FIFO4, ARM2LBUS_FIFO5, ARM2LBUS_FIFO6, ARM2LBUS_FIFO7,
317	ARM2LBUS_FIFO8, ARM2LBUS_FIFO9, ARM2LBUS_FIFO10, ARM2LBUS_FIFO11,
318	ARM2LBUS_FIFO12, ARM2LBUS_FIFO13, ARM2LBUS_FIFO14, ARM2LBUS_FIFO15,
319	INTER0_OUT, INTER1_OUT, INTER2_OUT, INTER3_OUT, INTER4_OUT,
320	INTERM0_OUT, INTERM1_OUT, INTERM2_OUT, INTERM3_OUT, INTERM4_OUT,
321	INTERM5_OUT, INTERM6_OUT, DECIMM0_OUT, DECIMM1_OUT, DECIMM2_OUT,
322	DECIMM3_OUT, DECIM0_OUT, SR3_4_OUT, OPL3_SAMPLE, ASRC0, ASRC1,
323	ACLNK2PADC, ACLNK2MODEM0RX, ACLNK2MIC, ACLNK2MODEM1RX, ACLNK2HNDMIC,
324	DIGITAL_MIXER_OUT0, GAINFUNC0_OUT, GAINFUNC1_OUT, GAINFUNC2_OUT,
325	GAINFUNC3_OUT, GAINFUNC4_OUT, SOFTMODEMTX, SPLITTER0_OUTL,
326	SPLITTER0_OUTR, SPLITTER1_OUTL, SPLITTER1_OUTR, SPLITTER2_OUTL,
327	SPLITTER2_OUTR, SPLITTER3_OUTL, SPLITTER3_OUTR, MERGER0_OUT,
328	MERGER1_OUT, MERGER2_OUT, MERGER3_OUT, ARM2LBUS_FIFO_DIRECT, NO_OUT
329};
330
331enum E2SINK {
332	LBUS2ARM_FIFO0 = 0, LBUS2ARM_FIFO1, LBUS2ARM_FIFO2, LBUS2ARM_FIFO3,
333	LBUS2ARM_FIFO4, LBUS2ARM_FIFO5, LBUS2ARM_FIFO6, LBUS2ARM_FIFO7,
334	INTER0_IN, INTER1_IN, INTER2_IN, INTER3_IN, INTER4_IN, INTERM0_IN,
335	INTERM1_IN, INTERM2_IN, INTERM3_IN, INTERM4_IN, INTERM5_IN, INTERM6_IN,
336	DECIMM0_IN, DECIMM1_IN, DECIMM2_IN, DECIMM3_IN, DECIM0_IN, SR3_4_IN,
337	PDAC2ACLNK, MODEM0TX2ACLNK, MODEM1TX2ACLNK, HNDSPK2ACLNK,
338	DIGITAL_MIXER_IN0, DIGITAL_MIXER_IN1, DIGITAL_MIXER_IN2,
339	DIGITAL_MIXER_IN3, DIGITAL_MIXER_IN4, DIGITAL_MIXER_IN5,
340	DIGITAL_MIXER_IN6, DIGITAL_MIXER_IN7, DIGITAL_MIXER_IN8,
341	DIGITAL_MIXER_IN9, DIGITAL_MIXER_IN10, DIGITAL_MIXER_IN11,
342	GAINFUNC0_IN, GAINFUNC1_IN, GAINFUNC2_IN, GAINFUNC3_IN, GAINFUNC4_IN,
343	SOFTMODEMRX, SPLITTER0_IN, SPLITTER1_IN, SPLITTER2_IN, SPLITTER3_IN,
344	MERGER0_INL, MERGER0_INR, MERGER1_INL, MERGER1_INR, MERGER2_INL,
345	MERGER2_INR, MERGER3_INL, MERGER3_INR, E2SINK_MAX
346};
347
348enum LBUS_SINK {
349	LS_SRC_INTERPOLATOR = 0, LS_SRC_INTERPOLATORM, LS_SRC_DECIMATOR,
350	LS_SRC_DECIMATORM, LS_MIXER_IN, LS_MIXER_GAIN_FUNCTION,
351	LS_SRC_SPLITTER, LS_SRC_MERGER, LS_NONE1, LS_NONE2,
352};
353
354enum RT_CHANNEL_IDS {
355	M0TX = 0, M1TX, TAMTX, HSSPKR, PDAC, DSNDTX0, DSNDTX1, DSNDTX2,
356	DSNDTX3, DSNDTX4, DSNDTX5, DSNDTX6, DSNDTX7, WVSTRTX, COP3DTX, SPARE,
357	M0RX, HSMIC, M1RX, CLEANRX, MICADC, PADC, COPRX1, COPRX2,
358	CHANNEL_ID_COUNTER
359};
360
361enum { SB_CMD = 0, MODEM_CMD, I2S_CMD0, I2S_CMD1, FM_CMD, MAX_CMD };
362
363struct lbuspath {
364	const unsigned char *noconv;
365	const unsigned char *stereo;
366	const unsigned char *mono;
367};
368
369struct cmdport {
370	u32 data1;		/* cmd,param */
371	u32 data2;		/* param */
372	u32 stat;		/* status */
373	u32 pad[5];
374};
375
376struct riptideport {
377	u32 audio_control;	/* status registers */
378	u32 audio_status;
379	u32 pad[2];
380	struct cmdport port[2];	/* command ports */
381};
382
383struct cmdif {
384	struct riptideport *hwport;
385	spinlock_t lock;
386	unsigned int cmdcnt;	/* cmd statistics */
387	unsigned int cmdtime;
388	unsigned int cmdtimemax;
389	unsigned int cmdtimemin;
390	unsigned int errcnt;
391	int is_reset;
392};
393
394struct riptide_firmware {
395	u16 ASIC;
396	u16 CODEC;
397	u16 AUXDSP;
398	u16 PROG;
399};
400
401union cmdret {
402	u8 retbytes[8];
403	u16 retwords[4];
404	u32 retlongs[2];
405};
406
407union firmware_version {
408	union cmdret ret;
409	struct riptide_firmware firmware;
410};
411
412#define get_pcmhwdev(substream) (struct pcmhw *)(substream->runtime->private_data)
413
414#define PLAYBACK_SUBSTREAMS 3
415struct snd_riptide {
416	struct snd_card *card;
417	struct pci_dev *pci;
418	const struct firmware *fw_entry;
419
420	struct cmdif *cif;
421
422	struct snd_pcm *pcm;
423	struct snd_pcm *pcm_i2s;
424	struct snd_rawmidi *rmidi;
425	struct snd_opl3 *opl3;
426	struct snd_ac97 *ac97;
427	struct snd_ac97_bus *ac97_bus;
428
429	struct snd_pcm_substream *playback_substream[PLAYBACK_SUBSTREAMS];
430	struct snd_pcm_substream *capture_substream;
431
432	int openstreams;
433
434	int irq;
435	unsigned long port;
436	unsigned short mpuaddr;
437	unsigned short opladdr;
438#ifdef SUPPORT_JOYSTICK
439	unsigned short gameaddr;
440#endif
441	struct resource *res_port;
442
443	unsigned short device_id;
444
445	union firmware_version firmware;
446
447	spinlock_t lock;
448	struct snd_info_entry *proc_entry;
449
450	unsigned long received_irqs;
451	unsigned long handled_irqs;
452#ifdef CONFIG_PM_SLEEP
453	int in_suspend;
454#endif
455};
456
457struct sgd {			/* scatter gather desriptor */
458	__le32 dwNextLink;
459	__le32 dwSegPtrPhys;
460	__le32 dwSegLen;
461	__le32 dwStat_Ctl;
462};
463
464struct pcmhw {			/* pcm descriptor */
465	struct lbuspath paths;
466	const unsigned char *lbuspath;
467	unsigned char source;
468	unsigned char intdec[2];
469	unsigned char mixer;
470	unsigned char id;
471	unsigned char state;
472	unsigned int rate;
473	unsigned int channels;
474	snd_pcm_format_t format;
475	struct snd_dma_buffer sgdlist;
476	struct sgd *sgdbuf;
477	unsigned int size;
478	unsigned int pages;
479	unsigned int oldpos;
480	unsigned int pointer;
481};
482
483#define CMDRET_ZERO (union cmdret){{(u32)0, (u32) 0}}
484
485static int sendcmd(struct cmdif *cif, u32 flags, u32 cmd, u32 parm,
486		   union cmdret *ret);
487static int getsourcesink(struct cmdif *cif, unsigned char source,
488			 unsigned char sink, unsigned char *a,
489			 unsigned char *b);
490static int snd_riptide_initialize(struct snd_riptide *chip);
491static int riptide_reset(struct cmdif *cif, struct snd_riptide *chip);
492
493/*
494 */
495
496static const struct pci_device_id snd_riptide_ids[] = {
497	{ PCI_DEVICE(0x127a, 0x4310) },
498	{ PCI_DEVICE(0x127a, 0x4320) },
499	{ PCI_DEVICE(0x127a, 0x4330) },
500	{ PCI_DEVICE(0x127a, 0x4340) },
501	{0,},
502};
503
504#ifdef SUPPORT_JOYSTICK
505static const struct pci_device_id snd_riptide_joystick_ids[] = {
506	{ PCI_DEVICE(0x127a, 0x4312) },
507	{ PCI_DEVICE(0x127a, 0x4322) },
508	{ PCI_DEVICE(0x127a, 0x4332) },
509	{ PCI_DEVICE(0x127a, 0x4342) },
510	{0,},
511};
512#endif
513
514MODULE_DEVICE_TABLE(pci, snd_riptide_ids);
515
516/*
517 */
518
519static const unsigned char lbusin2out[E2SINK_MAX + 1][2] = {
520	{NO_OUT, LS_NONE1}, {NO_OUT, LS_NONE2}, {NO_OUT, LS_NONE1}, {NO_OUT,
521								     LS_NONE2},
522	{NO_OUT, LS_NONE1}, {NO_OUT, LS_NONE2}, {NO_OUT, LS_NONE1}, {NO_OUT,
523								     LS_NONE2},
524	{INTER0_OUT, LS_SRC_INTERPOLATOR}, {INTER1_OUT, LS_SRC_INTERPOLATOR},
525	{INTER2_OUT, LS_SRC_INTERPOLATOR}, {INTER3_OUT, LS_SRC_INTERPOLATOR},
526	{INTER4_OUT, LS_SRC_INTERPOLATOR}, {INTERM0_OUT, LS_SRC_INTERPOLATORM},
527	{INTERM1_OUT, LS_SRC_INTERPOLATORM}, {INTERM2_OUT,
528					      LS_SRC_INTERPOLATORM},
529	{INTERM3_OUT, LS_SRC_INTERPOLATORM}, {INTERM4_OUT,
530					      LS_SRC_INTERPOLATORM},
531	{INTERM5_OUT, LS_SRC_INTERPOLATORM}, {INTERM6_OUT,
532					      LS_SRC_INTERPOLATORM},
533	{DECIMM0_OUT, LS_SRC_DECIMATORM}, {DECIMM1_OUT, LS_SRC_DECIMATORM},
534	{DECIMM2_OUT, LS_SRC_DECIMATORM}, {DECIMM3_OUT, LS_SRC_DECIMATORM},
535	{DECIM0_OUT, LS_SRC_DECIMATOR}, {SR3_4_OUT, LS_NONE1}, {NO_OUT,
536								LS_NONE2},
537	{NO_OUT, LS_NONE1}, {NO_OUT, LS_NONE2}, {NO_OUT, LS_NONE1},
538	{DIGITAL_MIXER_OUT0, LS_MIXER_IN}, {DIGITAL_MIXER_OUT0, LS_MIXER_IN},
539	{DIGITAL_MIXER_OUT0, LS_MIXER_IN}, {DIGITAL_MIXER_OUT0, LS_MIXER_IN},
540	{DIGITAL_MIXER_OUT0, LS_MIXER_IN}, {DIGITAL_MIXER_OUT0, LS_MIXER_IN},
541	{DIGITAL_MIXER_OUT0, LS_MIXER_IN}, {DIGITAL_MIXER_OUT0, LS_MIXER_IN},
542	{DIGITAL_MIXER_OUT0, LS_MIXER_IN}, {DIGITAL_MIXER_OUT0, LS_MIXER_IN},
543	{DIGITAL_MIXER_OUT0, LS_MIXER_IN}, {DIGITAL_MIXER_OUT0, LS_MIXER_IN},
544	{GAINFUNC0_OUT, LS_MIXER_GAIN_FUNCTION}, {GAINFUNC1_OUT,
545						  LS_MIXER_GAIN_FUNCTION},
546	{GAINFUNC2_OUT, LS_MIXER_GAIN_FUNCTION}, {GAINFUNC3_OUT,
547						  LS_MIXER_GAIN_FUNCTION},
548	{GAINFUNC4_OUT, LS_MIXER_GAIN_FUNCTION}, {SOFTMODEMTX, LS_NONE1},
549	{SPLITTER0_OUTL, LS_SRC_SPLITTER}, {SPLITTER1_OUTL, LS_SRC_SPLITTER},
550	{SPLITTER2_OUTL, LS_SRC_SPLITTER}, {SPLITTER3_OUTL, LS_SRC_SPLITTER},
551	{MERGER0_OUT, LS_SRC_MERGER}, {MERGER0_OUT, LS_SRC_MERGER},
552	{MERGER1_OUT, LS_SRC_MERGER},
553	{MERGER1_OUT, LS_SRC_MERGER}, {MERGER2_OUT, LS_SRC_MERGER},
554	{MERGER2_OUT, LS_SRC_MERGER},
555	{MERGER3_OUT, LS_SRC_MERGER}, {MERGER3_OUT, LS_SRC_MERGER}, {NO_OUT,
556								     LS_NONE2},
557};
558
559static const unsigned char lbus_play_opl3[] = {
560	DIGITAL_MIXER_IN0 + FM_MIXER, 0xff
561};
562static const unsigned char lbus_play_modem[] = {
563	DIGITAL_MIXER_IN0 + MODEM_MIXER, 0xff
564};
565static const unsigned char lbus_play_i2s[] = {
566	INTER0_IN + I2S_INTDEC, DIGITAL_MIXER_IN0 + I2S_MIXER, 0xff
567};
568static const unsigned char lbus_play_out[] = {
569	PDAC2ACLNK, 0xff
570};
571static const unsigned char lbus_play_outhp[] = {
572	HNDSPK2ACLNK, 0xff
573};
574static const unsigned char lbus_play_noconv1[] = {
575	DIGITAL_MIXER_IN0, 0xff
576};
577static const unsigned char lbus_play_stereo1[] = {
578	INTER0_IN, DIGITAL_MIXER_IN0, 0xff
579};
580static const unsigned char lbus_play_mono1[] = {
581	INTERM0_IN, DIGITAL_MIXER_IN0, 0xff
582};
583static const unsigned char lbus_play_noconv2[] = {
584	DIGITAL_MIXER_IN1, 0xff
585};
586static const unsigned char lbus_play_stereo2[] = {
587	INTER1_IN, DIGITAL_MIXER_IN1, 0xff
588};
589static const unsigned char lbus_play_mono2[] = {
590	INTERM1_IN, DIGITAL_MIXER_IN1, 0xff
591};
592static const unsigned char lbus_play_noconv3[] = {
593	DIGITAL_MIXER_IN2, 0xff
594};
595static const unsigned char lbus_play_stereo3[] = {
596	INTER2_IN, DIGITAL_MIXER_IN2, 0xff
597};
598static const unsigned char lbus_play_mono3[] = {
599	INTERM2_IN, DIGITAL_MIXER_IN2, 0xff
600};
601static const unsigned char lbus_rec_noconv1[] = {
602	LBUS2ARM_FIFO5, 0xff
603};
604static const unsigned char lbus_rec_stereo1[] = {
605	DECIM0_IN, LBUS2ARM_FIFO5, 0xff
606};
607static const unsigned char lbus_rec_mono1[] = {
608	DECIMM3_IN, LBUS2ARM_FIFO5, 0xff
609};
610
611static const unsigned char play_ids[] = { 4, 1, 2, };
612static const unsigned char play_sources[] = {
613	ARM2LBUS_FIFO4, ARM2LBUS_FIFO1, ARM2LBUS_FIFO2,
614};
615static const struct lbuspath lbus_play_paths[] = {
616	{
617	 .noconv = lbus_play_noconv1,
618	 .stereo = lbus_play_stereo1,
619	 .mono = lbus_play_mono1,
620	 },
621	{
622	 .noconv = lbus_play_noconv2,
623	 .stereo = lbus_play_stereo2,
624	 .mono = lbus_play_mono2,
625	 },
626	{
627	 .noconv = lbus_play_noconv3,
628	 .stereo = lbus_play_stereo3,
629	 .mono = lbus_play_mono3,
630	 },
631};
632static const struct lbuspath lbus_rec_path = {
633	.noconv = lbus_rec_noconv1,
634	.stereo = lbus_rec_stereo1,
635	.mono = lbus_rec_mono1,
636};
637
638#define FIRMWARE_VERSIONS 1
639static union firmware_version firmware_versions[] = {
640	{
641		.firmware = {
642			.ASIC = 3,
643			.CODEC = 2,
644			.AUXDSP = 3,
645			.PROG = 773,
646		},
647	},
648};
649
650static u32 atoh(const unsigned char *in, unsigned int len)
651{
652	u32 sum = 0;
653	unsigned int mult = 1;
654	unsigned char c;
655
656	while (len) {
657		int value;
658
659		c = in[len - 1];
660		value = hex_to_bin(c);
661		if (value >= 0)
662			sum += mult * value;
663		mult *= 16;
664		--len;
665	}
666	return sum;
667}
668
669static int senddata(struct cmdif *cif, const unsigned char *in, u32 offset)
670{
671	u32 addr;
672	u32 data;
673	u32 i;
674	const unsigned char *p;
675
676	i = atoh(&in[1], 2);
677	addr = offset + atoh(&in[3], 4);
678	if (SEND_SMEM(cif, 0, addr) != 0)
679		return -EACCES;
680	p = in + 9;
681	while (i) {
682		data = atoh(p, 8);
683		if (SEND_WMEM(cif, 2,
684			      ((data & 0x0f0f0f0f) << 4) | ((data & 0xf0f0f0f0)
685							    >> 4)))
686			return -EACCES;
687		i -= 4;
688		p += 8;
689	}
690	return 0;
691}
692
693static int loadfirmware(struct cmdif *cif, const unsigned char *img,
694			unsigned int size)
695{
696	const unsigned char *in;
697	u32 laddr, saddr, t, val;
698	int err = 0;
699
700	laddr = saddr = 0;
701	while (size > 0 && err == 0) {
702		in = img;
703		if (in[0] == ':') {
704			t = atoh(&in[7], 2);
705			switch (t) {
706			case DATA_REC:
707				err = senddata(cif, in, laddr + saddr);
708				break;
709			case EXT_SEG_ADDR_REC:
710				saddr = atoh(&in[9], 4) << 4;
711				break;
712			case EXT_LIN_ADDR_REC:
713				laddr = atoh(&in[9], 4) << 16;
714				break;
715			case EXT_GOTO_CMD_REC:
716				val = atoh(&in[9], 8);
717				if (SEND_GOTO(cif, val) != 0)
718					err = -EACCES;
719				break;
720			case EXT_END_OF_FILE:
721				size = 0;
722				break;
723			default:
724				break;
725			}
726			while (size > 0) {
727				size--;
728				if (*img++ == '\n')
729					break;
730			}
731		}
732	}
733	snd_printdd("load firmware return %d\n", err);
734	return err;
735}
736
737static void
738alloclbuspath(struct cmdif *cif, unsigned char source,
739	      const unsigned char *path, unsigned char *mixer, unsigned char *s)
740{
741	while (*path != 0xff) {
742		unsigned char sink, type;
743
744		sink = *path & (~SPLIT_PATH);
745		if (sink != E2SINK_MAX) {
746			snd_printdd("alloc path 0x%x->0x%x\n", source, sink);
747			SEND_PSEL(cif, source, sink);
748			source = lbusin2out[sink][0];
749			type = lbusin2out[sink][1];
750			if (type == LS_MIXER_IN) {
751				if (mixer)
752					*mixer = sink - DIGITAL_MIXER_IN0;
753			}
754			if (type == LS_SRC_DECIMATORM ||
755			    type == LS_SRC_DECIMATOR ||
756			    type == LS_SRC_INTERPOLATORM ||
757			    type == LS_SRC_INTERPOLATOR) {
758				if (s) {
759					if (s[0] != 0xff)
760						s[1] = sink;
761					else
762						s[0] = sink;
763				}
764			}
765		}
766		if (*path++ & SPLIT_PATH) {
767			const unsigned char *npath = path;
768
769			while (*npath != 0xff)
770				npath++;
771			alloclbuspath(cif, source + 1, ++npath, mixer, s);
772		}
773	}
774}
775
776static void
777freelbuspath(struct cmdif *cif, unsigned char source, const unsigned char *path)
778{
779	while (*path != 0xff) {
780		unsigned char sink;
781
782		sink = *path & (~SPLIT_PATH);
783		if (sink != E2SINK_MAX) {
784			snd_printdd("free path 0x%x->0x%x\n", source, sink);
785			SEND_PCLR(cif, source, sink);
786			source = lbusin2out[sink][0];
787		}
788		if (*path++ & SPLIT_PATH) {
789			const unsigned char *npath = path;
790
791			while (*npath != 0xff)
792				npath++;
793			freelbuspath(cif, source + 1, ++npath);
794		}
795	}
796}
797
798static int writearm(struct cmdif *cif, u32 addr, u32 data, u32 mask)
799{
800	union cmdret rptr = CMDRET_ZERO;
801	unsigned int i = MAX_WRITE_RETRY;
802	int flag = 1;
803
804	SEND_RMEM(cif, 0x02, addr, &rptr);
805	rptr.retlongs[0] &= (~mask);
806
807	while (--i) {
808		SEND_SMEM(cif, 0x01, addr);
809		SEND_WMEM(cif, 0x02, (rptr.retlongs[0] | data));
810		SEND_RMEM(cif, 0x02, addr, &rptr);
811		if ((rptr.retlongs[0] & data) == data) {
812			flag = 0;
813			break;
814		} else
815			rptr.retlongs[0] &= ~mask;
816	}
817	snd_printdd("send arm 0x%x 0x%x 0x%x return %d\n", addr, data, mask,
818		    flag);
819	return flag;
820}
821
822static int sendcmd(struct cmdif *cif, u32 flags, u32 cmd, u32 parm,
823		   union cmdret *ret)
824{
825	int i, j;
826	int err;
827	unsigned int time = 0;
828	unsigned long irqflags;
829	struct riptideport *hwport;
830	struct cmdport *cmdport = NULL;
831
832	if (snd_BUG_ON(!cif))
833		return -EINVAL;
834
835	hwport = cif->hwport;
836	if (cif->errcnt > MAX_ERROR_COUNT) {
837		if (cif->is_reset) {
838			snd_printk(KERN_ERR
839				   "Riptide: Too many failed cmds, reinitializing\n");
840			if (riptide_reset(cif, NULL) == 0) {
841				cif->errcnt = 0;
842				return -EIO;
843			}
844		}
845		snd_printk(KERN_ERR "Riptide: Initialization failed.\n");
846		return -EINVAL;
847	}
848	if (ret) {
849		ret->retlongs[0] = 0;
850		ret->retlongs[1] = 0;
851	}
852	i = 0;
853	spin_lock_irqsave(&cif->lock, irqflags);
854	while (i++ < CMDIF_TIMEOUT && !IS_READY(cif->hwport))
855		udelay(10);
856	if (i > CMDIF_TIMEOUT) {
857		err = -EBUSY;
858		goto errout;
859	}
860
861	err = 0;
862	for (j = 0, time = 0; time < CMDIF_TIMEOUT; j++, time += 2) {
863		cmdport = &(hwport->port[j % 2]);
864		if (IS_DATF(cmdport)) {	/* free pending data */
865			READ_PORT_ULONG(cmdport->data1);
866			READ_PORT_ULONG(cmdport->data2);
867		}
868		if (IS_CMDE(cmdport)) {
869			if (flags & PARM)	/* put data */
870				WRITE_PORT_ULONG(cmdport->data2, parm);
871			WRITE_PORT_ULONG(cmdport->data1, cmd);	/* write cmd */
872			if ((flags & RESP) && ret) {
873				while (!IS_DATF(cmdport) &&
874				       time < CMDIF_TIMEOUT) {
875					udelay(10);
876					time++;
877				}
878				if (time < CMDIF_TIMEOUT) {	/* read response */
879					ret->retlongs[0] =
880					    READ_PORT_ULONG(cmdport->data1);
881					ret->retlongs[1] =
882					    READ_PORT_ULONG(cmdport->data2);
883				} else {
884					err = -ENOSYS;
885					goto errout;
886				}
887			}
888			break;
889		}
890		udelay(20);
891	}
892	if (time == CMDIF_TIMEOUT) {
893		err = -ENODATA;
894		goto errout;
895	}
896	spin_unlock_irqrestore(&cif->lock, irqflags);
897
898	cif->cmdcnt++;		/* update command statistics */
899	cif->cmdtime += time;
900	if (time > cif->cmdtimemax)
901		cif->cmdtimemax = time;
902	if (time < cif->cmdtimemin)
903		cif->cmdtimemin = time;
904	if ((cif->cmdcnt) % 1000 == 0)
905		snd_printdd
906		    ("send cmd %d time: %d mintime: %d maxtime %d err: %d\n",
907		     cif->cmdcnt, cif->cmdtime, cif->cmdtimemin,
908		     cif->cmdtimemax, cif->errcnt);
909	return 0;
910
911      errout:
912	cif->errcnt++;
913	spin_unlock_irqrestore(&cif->lock, irqflags);
914	snd_printdd
915	    ("send cmd %d hw: 0x%x flag: 0x%x cmd: 0x%x parm: 0x%x ret: 0x%x 0x%x CMDE: %d DATF: %d failed %d\n",
916	     cif->cmdcnt, (int)((void *)&(cmdport->stat) - (void *)hwport),
917	     flags, cmd, parm, ret ? ret->retlongs[0] : 0,
918	     ret ? ret->retlongs[1] : 0, IS_CMDE(cmdport), IS_DATF(cmdport),
919	     err);
920	return err;
921}
922
923static int
924setmixer(struct cmdif *cif, short num, unsigned short rval, unsigned short lval)
925{
926	union cmdret rptr = CMDRET_ZERO;
927	int i = 0;
928
929	snd_printdd("sent mixer %d: 0x%x 0x%x\n", num, rval, lval);
930	do {
931		SEND_SDGV(cif, num, num, rval, lval);
932		SEND_RDGV(cif, num, num, &rptr);
933		if (rptr.retwords[0] == lval && rptr.retwords[1] == rval)
934			return 0;
935	} while (i++ < MAX_WRITE_RETRY);
936	snd_printdd("sent mixer failed\n");
937	return -EIO;
938}
939
940static int getpaths(struct cmdif *cif, unsigned char *o)
941{
942	unsigned char src[E2SINK_MAX];
943	unsigned char sink[E2SINK_MAX];
944	int i, j = 0;
945
946	for (i = 0; i < E2SINK_MAX; i++) {
947		getsourcesink(cif, i, i, &src[i], &sink[i]);
948		if (sink[i] < E2SINK_MAX) {
949			o[j++] = sink[i];
950			o[j++] = i;
951		}
952	}
953	return j;
954}
955
956static int
957getsourcesink(struct cmdif *cif, unsigned char source, unsigned char sink,
958	      unsigned char *a, unsigned char *b)
959{
960	union cmdret rptr = CMDRET_ZERO;
961
962	if (SEND_RSSV(cif, source, sink, &rptr) &&
963	    SEND_RSSV(cif, source, sink, &rptr))
964		return -EIO;
965	*a = rptr.retbytes[0];
966	*b = rptr.retbytes[1];
967	snd_printdd("getsourcesink 0x%x 0x%x\n", *a, *b);
968	return 0;
969}
970
971static int
972getsamplerate(struct cmdif *cif, unsigned char *intdec, unsigned int *rate)
973{
974	unsigned char *s;
975	unsigned int p[2] = { 0, 0 };
976	int i;
977	union cmdret rptr = CMDRET_ZERO;
978
979	s = intdec;
980	for (i = 0; i < 2; i++) {
981		if (*s != 0xff) {
982			if (SEND_RSRC(cif, *s, &rptr) &&
983			    SEND_RSRC(cif, *s, &rptr))
984				return -EIO;
985			p[i] += rptr.retwords[1];
986			p[i] *= rptr.retwords[2];
987			p[i] += rptr.retwords[3];
988			p[i] /= 65536;
989		}
990		s++;
991	}
992	if (p[0]) {
993		if (p[1] != p[0])
994			snd_printdd("rates differ %d %d\n", p[0], p[1]);
995		*rate = (unsigned int)p[0];
996	} else
997		*rate = (unsigned int)p[1];
998	snd_printdd("getsampleformat %d %d %d\n", intdec[0], intdec[1], *rate);
999	return 0;
1000}
1001
1002static int
1003setsampleformat(struct cmdif *cif,
1004		unsigned char mixer, unsigned char id,
1005		unsigned char channels, snd_pcm_format_t format)
1006{
1007	unsigned char w, ch, sig, order;
1008
1009	snd_printdd
1010	    ("setsampleformat mixer: %d id: %d channels: %d format: %d\n",
1011	     mixer, id, channels, format);
1012	ch = channels == 1;
1013	w = snd_pcm_format_width(format) == 8;
1014	sig = snd_pcm_format_unsigned(format) != 0;
1015	order = snd_pcm_format_big_endian(format) != 0;
1016
1017	if (SEND_SETF(cif, mixer, w, ch, order, sig, id) &&
1018	    SEND_SETF(cif, mixer, w, ch, order, sig, id)) {
1019		snd_printdd("setsampleformat failed\n");
1020		return -EIO;
1021	}
1022	return 0;
1023}
1024
1025static int
1026setsamplerate(struct cmdif *cif, unsigned char *intdec, unsigned int rate)
1027{
1028	u32 D, M, N;
1029	union cmdret rptr = CMDRET_ZERO;
1030	int i;
1031
1032	snd_printdd("setsamplerate intdec: %d,%d rate: %d\n", intdec[0],
1033		    intdec[1], rate);
1034	D = 48000;
1035	M = ((rate == 48000) ? 47999 : rate) * 65536;
1036	N = M % D;
1037	M /= D;
1038	for (i = 0; i < 2; i++) {
1039		if (*intdec != 0xff) {
1040			do {
1041				SEND_SSRC(cif, *intdec, D, M, N);
1042				SEND_RSRC(cif, *intdec, &rptr);
1043			} while (rptr.retwords[1] != D &&
1044				 rptr.retwords[2] != M &&
1045				 rptr.retwords[3] != N &&
1046				 i++ < MAX_WRITE_RETRY);
1047			if (i > MAX_WRITE_RETRY) {
1048				snd_printdd("sent samplerate %d: %d failed\n",
1049					    *intdec, rate);
1050				return -EIO;
1051			}
1052		}
1053		intdec++;
1054	}
1055	return 0;
1056}
1057
1058static int
1059getmixer(struct cmdif *cif, short num, unsigned short *rval,
1060	 unsigned short *lval)
1061{
1062	union cmdret rptr = CMDRET_ZERO;
1063
1064	if (SEND_RDGV(cif, num, num, &rptr) && SEND_RDGV(cif, num, num, &rptr))
1065		return -EIO;
1066	*rval = rptr.retwords[0];
1067	*lval = rptr.retwords[1];
1068	snd_printdd("got mixer %d: 0x%x 0x%x\n", num, *rval, *lval);
1069	return 0;
1070}
1071
1072static irqreturn_t riptide_handleirq(int irq, void *dev_id)
1073{
1074	struct snd_riptide *chip = dev_id;
1075	struct cmdif *cif = chip->cif;
1076	struct snd_pcm_substream *substream[PLAYBACK_SUBSTREAMS + 1];
1077	struct snd_pcm_runtime *runtime;
1078	struct pcmhw *data = NULL;
1079	unsigned int pos, period_bytes;
1080	struct sgd *c;
1081	int i, j;
1082	unsigned int flag;
1083
1084	if (!cif)
1085		return IRQ_HANDLED;
1086
1087	for (i = 0; i < PLAYBACK_SUBSTREAMS; i++)
1088		substream[i] = chip->playback_substream[i];
1089	substream[i] = chip->capture_substream;
1090	for (i = 0; i < PLAYBACK_SUBSTREAMS + 1; i++) {
1091		if (substream[i] &&
1092		    (runtime = substream[i]->runtime) &&
1093		    (data = runtime->private_data) && data->state != ST_STOP) {
1094			pos = 0;
1095			for (j = 0; j < data->pages; j++) {
1096				c = &data->sgdbuf[j];
1097				flag = le32_to_cpu(c->dwStat_Ctl);
1098				if (flag & EOB_STATUS)
1099					pos += le32_to_cpu(c->dwSegLen);
1100				if (flag & EOC_STATUS)
1101					pos += le32_to_cpu(c->dwSegLen);
1102				if ((flag & EOS_STATUS)
1103				    && (data->state == ST_PLAY)) {
1104					data->state = ST_STOP;
1105					snd_printk(KERN_ERR
1106						   "Riptide: DMA stopped unexpectedly\n");
1107				}
1108				c->dwStat_Ctl =
1109				    cpu_to_le32(flag &
1110						~(EOS_STATUS | EOB_STATUS |
1111						  EOC_STATUS));
1112			}
1113			data->pointer += pos;
1114			pos += data->oldpos;
1115			if (data->state != ST_STOP) {
1116				period_bytes =
1117				    frames_to_bytes(runtime,
1118						    runtime->period_size);
1119				snd_printdd
1120				    ("interrupt 0x%x after 0x%lx of 0x%lx frames in period\n",
1121				     READ_AUDIO_STATUS(cif->hwport),
1122				     bytes_to_frames(runtime, pos),
1123				     runtime->period_size);
1124				j = 0;
1125				if (pos >= period_bytes) {
1126					j++;
1127					while (pos >= period_bytes)
1128						pos -= period_bytes;
1129				}
1130				data->oldpos = pos;
1131				if (j > 0)
1132					snd_pcm_period_elapsed(substream[i]);
1133			}
1134		}
1135	}
1136
1137	return IRQ_HANDLED;
1138}
1139
1140#ifdef CONFIG_PM_SLEEP
1141static int riptide_suspend(struct device *dev)
1142{
1143	struct snd_card *card = dev_get_drvdata(dev);
1144	struct snd_riptide *chip = card->private_data;
1145
1146	chip->in_suspend = 1;
1147	snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
1148	snd_ac97_suspend(chip->ac97);
1149	return 0;
1150}
1151
1152static int riptide_resume(struct device *dev)
1153{
1154	struct snd_card *card = dev_get_drvdata(dev);
1155	struct snd_riptide *chip = card->private_data;
1156
1157	snd_riptide_initialize(chip);
1158	snd_ac97_resume(chip->ac97);
1159	snd_power_change_state(card, SNDRV_CTL_POWER_D0);
1160	chip->in_suspend = 0;
1161	return 0;
1162}
1163
1164static SIMPLE_DEV_PM_OPS(riptide_pm, riptide_suspend, riptide_resume);
1165#define RIPTIDE_PM_OPS	&riptide_pm
1166#else
1167#define RIPTIDE_PM_OPS	NULL
1168#endif /* CONFIG_PM_SLEEP */
1169
1170static int try_to_load_firmware(struct cmdif *cif, struct snd_riptide *chip)
1171{
1172	union firmware_version firmware = { .ret = CMDRET_ZERO };
1173	int i, timeout, err;
1174
1175	for (i = 0; i < 2; i++) {
1176		WRITE_PORT_ULONG(cif->hwport->port[i].data1, 0);
1177		WRITE_PORT_ULONG(cif->hwport->port[i].data2, 0);
1178	}
1179	SET_GRESET(cif->hwport);
1180	udelay(100);
1181	UNSET_GRESET(cif->hwport);
1182	udelay(100);
1183
1184	for (timeout = 100000; --timeout; udelay(10)) {
1185		if (IS_READY(cif->hwport) && !IS_GERR(cif->hwport))
1186			break;
1187	}
1188	if (!timeout) {
1189		snd_printk(KERN_ERR
1190			   "Riptide: device not ready, audio status: 0x%x "
1191			   "ready: %d gerr: %d\n",
1192			   READ_AUDIO_STATUS(cif->hwport),
1193			   IS_READY(cif->hwport), IS_GERR(cif->hwport));
1194		return -EIO;
1195	} else {
1196		snd_printdd
1197			("Riptide: audio status: 0x%x ready: %d gerr: %d\n",
1198			 READ_AUDIO_STATUS(cif->hwport),
1199			 IS_READY(cif->hwport), IS_GERR(cif->hwport));
1200	}
1201
1202	SEND_GETV(cif, &firmware.ret);
1203	snd_printdd("Firmware version: ASIC: %d CODEC %d AUXDSP %d PROG %d\n",
1204		    firmware.firmware.ASIC, firmware.firmware.CODEC,
1205		    firmware.firmware.AUXDSP, firmware.firmware.PROG);
1206
1207	if (!chip)
1208		return 1;
1209
1210	for (i = 0; i < FIRMWARE_VERSIONS; i++) {
1211		if (!memcmp(&firmware_versions[i], &firmware, sizeof(firmware)))
1212			return 1; /* OK */
1213
1214	}
1215
1216	snd_printdd("Writing Firmware\n");
1217	if (!chip->fw_entry) {
1218		err = request_firmware(&chip->fw_entry, "riptide.hex",
1219				       &chip->pci->dev);
1220		if (err) {
1221			snd_printk(KERN_ERR
1222				   "Riptide: Firmware not available %d\n", err);
1223			return -EIO;
1224		}
1225	}
1226	err = loadfirmware(cif, chip->fw_entry->data, chip->fw_entry->size);
1227	if (err) {
1228		snd_printk(KERN_ERR
1229			   "Riptide: Could not load firmware %d\n", err);
1230		return err;
1231	}
1232
1233	chip->firmware = firmware;
1234
1235	return 1; /* OK */
1236}
1237
1238static int riptide_reset(struct cmdif *cif, struct snd_riptide *chip)
1239{
1240	union cmdret rptr = CMDRET_ZERO;
1241	int err, tries;
1242
1243	if (!cif)
1244		return -EINVAL;
1245
1246	cif->cmdcnt = 0;
1247	cif->cmdtime = 0;
1248	cif->cmdtimemax = 0;
1249	cif->cmdtimemin = 0xffffffff;
1250	cif->errcnt = 0;
1251	cif->is_reset = 0;
1252
1253	tries = RESET_TRIES;
1254	do {
1255		err = try_to_load_firmware(cif, chip);
1256		if (err < 0)
1257			return err;
1258	} while (!err && --tries);
1259
1260	SEND_SACR(cif, 0, AC97_RESET);
1261	SEND_RACR(cif, AC97_RESET, &rptr);
1262	snd_printdd("AC97: 0x%x 0x%x\n", rptr.retlongs[0], rptr.retlongs[1]);
1263
1264	SEND_PLST(cif, 0);
1265	SEND_SLST(cif, 0);
1266	SEND_DLST(cif, 0);
1267	SEND_ALST(cif, 0);
1268	SEND_KDMA(cif);
1269
1270	writearm(cif, 0x301F8, 1, 1);
1271	writearm(cif, 0x301F4, 1, 1);
1272
1273	SEND_LSEL(cif, MODEM_CMD, 0, 0, MODEM_INTDEC, MODEM_MERGER,
1274		  MODEM_SPLITTER, MODEM_MIXER);
1275	setmixer(cif, MODEM_MIXER, 0x7fff, 0x7fff);
1276	alloclbuspath(cif, ARM2LBUS_FIFO13, lbus_play_modem, NULL, NULL);
1277
1278	SEND_LSEL(cif, FM_CMD, 0, 0, FM_INTDEC, FM_MERGER, FM_SPLITTER,
1279		  FM_MIXER);
1280	setmixer(cif, FM_MIXER, 0x7fff, 0x7fff);
1281	writearm(cif, 0x30648 + FM_MIXER * 4, 0x01, 0x00000005);
1282	writearm(cif, 0x301A8, 0x02, 0x00000002);
1283	writearm(cif, 0x30264, 0x08, 0xffffffff);
1284	alloclbuspath(cif, OPL3_SAMPLE, lbus_play_opl3, NULL, NULL);
1285
1286	SEND_SSRC(cif, I2S_INTDEC, 48000,
1287		  ((u32) I2S_RATE * 65536) / 48000,
1288		  ((u32) I2S_RATE * 65536) % 48000);
1289	SEND_LSEL(cif, I2S_CMD0, 0, 0, I2S_INTDEC, I2S_MERGER, I2S_SPLITTER,
1290		  I2S_MIXER);
1291	SEND_SI2S(cif, 1);
1292	alloclbuspath(cif, ARM2LBUS_FIFO0, lbus_play_i2s, NULL, NULL);
1293	alloclbuspath(cif, DIGITAL_MIXER_OUT0, lbus_play_out, NULL, NULL);
1294	alloclbuspath(cif, DIGITAL_MIXER_OUT0, lbus_play_outhp, NULL, NULL);
1295
1296	SET_AIACK(cif->hwport);
1297	SET_AIE(cif->hwport);
1298	SET_AIACK(cif->hwport);
1299	cif->is_reset = 1;
1300
1301	return 0;
1302}
1303
1304static const struct snd_pcm_hardware snd_riptide_playback = {
1305	.info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
1306		 SNDRV_PCM_INFO_BLOCK_TRANSFER |
1307		 SNDRV_PCM_INFO_PAUSE | SNDRV_PCM_INFO_MMAP_VALID),
1308	.formats =
1309	    SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S8
1310	    | SNDRV_PCM_FMTBIT_U16_LE,
1311	.rates = SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_8000_48000,
1312	.rate_min = 5500,
1313	.rate_max = 48000,
1314	.channels_min = 1,
1315	.channels_max = 2,
1316	.buffer_bytes_max = (64 * 1024),
1317	.period_bytes_min = PAGE_SIZE >> 1,
1318	.period_bytes_max = PAGE_SIZE << 8,
1319	.periods_min = 2,
1320	.periods_max = 64,
1321	.fifo_size = 0,
1322};
1323static const struct snd_pcm_hardware snd_riptide_capture = {
1324	.info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
1325		 SNDRV_PCM_INFO_BLOCK_TRANSFER |
1326		 SNDRV_PCM_INFO_PAUSE | SNDRV_PCM_INFO_MMAP_VALID),
1327	.formats =
1328	    SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S8
1329	    | SNDRV_PCM_FMTBIT_U16_LE,
1330	.rates = SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_8000_48000,
1331	.rate_min = 5500,
1332	.rate_max = 48000,
1333	.channels_min = 1,
1334	.channels_max = 2,
1335	.buffer_bytes_max = (64 * 1024),
1336	.period_bytes_min = PAGE_SIZE >> 1,
1337	.period_bytes_max = PAGE_SIZE << 3,
1338	.periods_min = 2,
1339	.periods_max = 64,
1340	.fifo_size = 0,
1341};
1342
1343static snd_pcm_uframes_t snd_riptide_pointer(struct snd_pcm_substream
1344					     *substream)
1345{
1346	struct snd_riptide *chip = snd_pcm_substream_chip(substream);
1347	struct snd_pcm_runtime *runtime = substream->runtime;
1348	struct pcmhw *data = get_pcmhwdev(substream);
1349	struct cmdif *cif = chip->cif;
1350	union cmdret rptr = CMDRET_ZERO;
1351	snd_pcm_uframes_t ret;
1352
1353	SEND_GPOS(cif, 0, data->id, &rptr);
1354	if (data->size && runtime->period_size) {
1355		snd_printdd
1356		    ("pointer stream %d position 0x%x(0x%x in buffer) bytes 0x%lx(0x%lx in period) frames\n",
1357		     data->id, rptr.retlongs[1], rptr.retlongs[1] % data->size,
1358		     bytes_to_frames(runtime, rptr.retlongs[1]),
1359		     bytes_to_frames(runtime,
1360				     rptr.retlongs[1]) % runtime->period_size);
1361		if (rptr.retlongs[1] > data->pointer)
1362			ret =
1363			    bytes_to_frames(runtime,
1364					    rptr.retlongs[1] % data->size);
1365		else
1366			ret =
1367			    bytes_to_frames(runtime,
1368					    data->pointer % data->size);
1369	} else {
1370		snd_printdd("stream not started or strange parms (%d %ld)\n",
1371			    data->size, runtime->period_size);
1372		ret = bytes_to_frames(runtime, 0);
1373	}
1374	return ret;
1375}
1376
1377static int snd_riptide_trigger(struct snd_pcm_substream *substream, int cmd)
1378{
1379	int i, j;
1380	struct snd_riptide *chip = snd_pcm_substream_chip(substream);
1381	struct pcmhw *data = get_pcmhwdev(substream);
1382	struct cmdif *cif = chip->cif;
1383	union cmdret rptr = CMDRET_ZERO;
1384
1385	spin_lock(&chip->lock);
1386	switch (cmd) {
1387	case SNDRV_PCM_TRIGGER_START:
1388	case SNDRV_PCM_TRIGGER_RESUME:
1389		if (!(data->state & ST_PLAY)) {
1390			SEND_SSTR(cif, data->id, data->sgdlist.addr);
1391			SET_AIE(cif->hwport);
1392			data->state = ST_PLAY;
1393			if (data->mixer != 0xff)
1394				setmixer(cif, data->mixer, 0x7fff, 0x7fff);
1395			chip->openstreams++;
1396			data->oldpos = 0;
1397			data->pointer = 0;
1398		}
1399		break;
1400	case SNDRV_PCM_TRIGGER_STOP:
1401	case SNDRV_PCM_TRIGGER_SUSPEND:
1402		if (data->mixer != 0xff)
1403			setmixer(cif, data->mixer, 0, 0);
1404		setmixer(cif, data->mixer, 0, 0);
1405		SEND_KSTR(cif, data->id);
1406		data->state = ST_STOP;
1407		chip->openstreams--;
1408		j = 0;
1409		do {
1410			i = rptr.retlongs[1];
1411			SEND_GPOS(cif, 0, data->id, &rptr);
1412			udelay(1);
1413		} while (i != rptr.retlongs[1] && j++ < MAX_WRITE_RETRY);
1414		if (j > MAX_WRITE_RETRY)
1415			snd_printk(KERN_ERR "Riptide: Could not stop stream!");
1416		break;
1417	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1418		if (!(data->state & ST_PAUSE)) {
1419			SEND_PSTR(cif, data->id);
1420			data->state |= ST_PAUSE;
1421			chip->openstreams--;
1422		}
1423		break;
1424	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1425		if (data->state & ST_PAUSE) {
1426			SEND_SSTR(cif, data->id, data->sgdlist.addr);
1427			data->state &= ~ST_PAUSE;
1428			chip->openstreams++;
1429		}
1430		break;
1431	default:
1432		spin_unlock(&chip->lock);
1433		return -EINVAL;
1434	}
1435	spin_unlock(&chip->lock);
1436	return 0;
1437}
1438
1439static int snd_riptide_prepare(struct snd_pcm_substream *substream)
1440{
1441	struct snd_riptide *chip = snd_pcm_substream_chip(substream);
1442	struct snd_pcm_runtime *runtime = substream->runtime;
1443	struct pcmhw *data = get_pcmhwdev(substream);
1444	struct cmdif *cif = chip->cif;
1445	const unsigned char *lbuspath = NULL;
1446	unsigned int rate, channels;
1447	int err = 0;
1448	snd_pcm_format_t format;
1449
1450	if (snd_BUG_ON(!cif || !data))
1451		return -EINVAL;
1452
1453	snd_printdd("prepare id %d ch: %d f:0x%x r:%d\n", data->id,
1454		    runtime->channels, runtime->format, runtime->rate);
1455
1456	spin_lock_irq(&chip->lock);
1457	channels = runtime->channels;
1458	format = runtime->format;
1459	rate = runtime->rate;
1460	switch (channels) {
1461	case 1:
1462		if (rate == 48000 && format == SNDRV_PCM_FORMAT_S16_LE)
1463			lbuspath = data->paths.noconv;
1464		else
1465			lbuspath = data->paths.mono;
1466		break;
1467	case 2:
1468		if (rate == 48000 && format == SNDRV_PCM_FORMAT_S16_LE)
1469			lbuspath = data->paths.noconv;
1470		else
1471			lbuspath = data->paths.stereo;
1472		break;
1473	}
1474	snd_printdd("use sgdlist at 0x%p\n",
1475		    data->sgdlist.area);
1476	if (data->sgdlist.area) {
1477		unsigned int i, j, size, pages, f, pt, period;
1478		struct sgd *c, *p = NULL;
1479
1480		size = frames_to_bytes(runtime, runtime->buffer_size);
1481		period = frames_to_bytes(runtime, runtime->period_size);
1482		f = PAGE_SIZE;
1483		while ((size + (f >> 1) - 1) <= (f << 7) && (f << 1) > period)
1484			f = f >> 1;
1485		pages = DIV_ROUND_UP(size, f);
1486		data->size = size;
1487		data->pages = pages;
1488		snd_printdd
1489		    ("create sgd size: 0x%x pages %d of size 0x%x for period 0x%x\n",
1490		     size, pages, f, period);
1491		pt = 0;
1492		j = 0;
1493		for (i = 0; i < pages; i++) {
1494			unsigned int ofs, addr;
1495			c = &data->sgdbuf[i];
1496			if (p)
1497				p->dwNextLink = cpu_to_le32(data->sgdlist.addr +
1498							    (i *
1499							     sizeof(struct
1500								    sgd)));
1501			c->dwNextLink = cpu_to_le32(data->sgdlist.addr);
1502			ofs = j << PAGE_SHIFT;
1503			addr = snd_pcm_sgbuf_get_addr(substream, ofs) + pt;
1504			c->dwSegPtrPhys = cpu_to_le32(addr);
1505			pt = (pt + f) % PAGE_SIZE;
1506			if (pt == 0)
1507				j++;
1508			c->dwSegLen = cpu_to_le32(f);
1509			c->dwStat_Ctl =
1510			    cpu_to_le32(IEOB_ENABLE | IEOS_ENABLE |
1511					IEOC_ENABLE);
1512			p = c;
1513			size -= f;
1514		}
1515		data->sgdbuf[i].dwSegLen = cpu_to_le32(size);
1516	}
1517	if (lbuspath && lbuspath != data->lbuspath) {
1518		if (data->lbuspath)
1519			freelbuspath(cif, data->source, data->lbuspath);
1520		alloclbuspath(cif, data->source, lbuspath,
1521			      &data->mixer, data->intdec);
1522		data->lbuspath = lbuspath;
1523		data->rate = 0;
1524	}
1525	if (data->rate != rate || data->format != format ||
1526	    data->channels != channels) {
1527		data->rate = rate;
1528		data->format = format;
1529		data->channels = channels;
1530		if (setsampleformat
1531		    (cif, data->mixer, data->id, channels, format)
1532		    || setsamplerate(cif, data->intdec, rate))
1533			err = -EIO;
1534	}
1535	spin_unlock_irq(&chip->lock);
1536	return err;
1537}
1538
1539static int
1540snd_riptide_hw_params(struct snd_pcm_substream *substream,
1541		      struct snd_pcm_hw_params *hw_params)
1542{
1543	struct snd_riptide *chip = snd_pcm_substream_chip(substream);
1544	struct pcmhw *data = get_pcmhwdev(substream);
1545	struct snd_dma_buffer *sgdlist = &data->sgdlist;
1546	int err;
1547
1548	snd_printdd("hw params id %d (sgdlist: 0x%p 0x%lx %d)\n", data->id,
1549		    sgdlist->area, (unsigned long)sgdlist->addr,
1550		    (int)sgdlist->bytes);
1551	if (sgdlist->area)
1552		snd_dma_free_pages(sgdlist);
1553	if ((err = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV,
1554				       &chip->pci->dev,
1555				       sizeof(struct sgd) * (DESC_MAX_MASK + 1),
1556				       sgdlist)) < 0) {
1557		snd_printk(KERN_ERR "Riptide: failed to alloc %d dma bytes\n",
1558			   (int)sizeof(struct sgd) * (DESC_MAX_MASK + 1));
1559		return err;
1560	}
1561	data->sgdbuf = (struct sgd *)sgdlist->area;
1562	return 0;
1563}
1564
1565static int snd_riptide_hw_free(struct snd_pcm_substream *substream)
1566{
1567	struct snd_riptide *chip = snd_pcm_substream_chip(substream);
1568	struct pcmhw *data = get_pcmhwdev(substream);
1569	struct cmdif *cif = chip->cif;
1570
1571	if (cif && data) {
1572		if (data->lbuspath)
1573			freelbuspath(cif, data->source, data->lbuspath);
1574		data->lbuspath = NULL;
1575		data->source = 0xff;
1576		data->intdec[0] = 0xff;
1577		data->intdec[1] = 0xff;
1578
1579		if (data->sgdlist.area) {
1580			snd_dma_free_pages(&data->sgdlist);
1581			data->sgdlist.area = NULL;
1582		}
1583	}
1584	return 0;
1585}
1586
1587static int snd_riptide_playback_open(struct snd_pcm_substream *substream)
1588{
1589	struct snd_riptide *chip = snd_pcm_substream_chip(substream);
1590	struct snd_pcm_runtime *runtime = substream->runtime;
1591	struct pcmhw *data;
1592	int sub_num = substream->number;
1593
1594	chip->playback_substream[sub_num] = substream;
1595	runtime->hw = snd_riptide_playback;
1596
1597	data = kzalloc(sizeof(struct pcmhw), GFP_KERNEL);
1598	if (data == NULL)
1599		return -ENOMEM;
1600	data->paths = lbus_play_paths[sub_num];
1601	data->id = play_ids[sub_num];
1602	data->source = play_sources[sub_num];
1603	data->intdec[0] = 0xff;
1604	data->intdec[1] = 0xff;
1605	data->state = ST_STOP;
1606	runtime->private_data = data;
1607	return snd_pcm_hw_constraint_integer(runtime,
1608					     SNDRV_PCM_HW_PARAM_PERIODS);
1609}
1610
1611static int snd_riptide_capture_open(struct snd_pcm_substream *substream)
1612{
1613	struct snd_riptide *chip = snd_pcm_substream_chip(substream);
1614	struct snd_pcm_runtime *runtime = substream->runtime;
1615	struct pcmhw *data;
1616
1617	chip->capture_substream = substream;
1618	runtime->hw = snd_riptide_capture;
1619
1620	data = kzalloc(sizeof(struct pcmhw), GFP_KERNEL);
1621	if (data == NULL)
1622		return -ENOMEM;
1623	data->paths = lbus_rec_path;
1624	data->id = PADC;
1625	data->source = ACLNK2PADC;
1626	data->intdec[0] = 0xff;
1627	data->intdec[1] = 0xff;
1628	data->state = ST_STOP;
1629	runtime->private_data = data;
1630	return snd_pcm_hw_constraint_integer(runtime,
1631					     SNDRV_PCM_HW_PARAM_PERIODS);
1632}
1633
1634static int snd_riptide_playback_close(struct snd_pcm_substream *substream)
1635{
1636	struct snd_riptide *chip = snd_pcm_substream_chip(substream);
1637	struct pcmhw *data = get_pcmhwdev(substream);
1638	int sub_num = substream->number;
1639
1640	substream->runtime->private_data = NULL;
1641	chip->playback_substream[sub_num] = NULL;
1642	kfree(data);
1643	return 0;
1644}
1645
1646static int snd_riptide_capture_close(struct snd_pcm_substream *substream)
1647{
1648	struct snd_riptide *chip = snd_pcm_substream_chip(substream);
1649	struct pcmhw *data = get_pcmhwdev(substream);
1650
1651	substream->runtime->private_data = NULL;
1652	chip->capture_substream = NULL;
1653	kfree(data);
1654	return 0;
1655}
1656
1657static const struct snd_pcm_ops snd_riptide_playback_ops = {
1658	.open = snd_riptide_playback_open,
1659	.close = snd_riptide_playback_close,
1660	.hw_params = snd_riptide_hw_params,
1661	.hw_free = snd_riptide_hw_free,
1662	.prepare = snd_riptide_prepare,
1663	.trigger = snd_riptide_trigger,
1664	.pointer = snd_riptide_pointer,
1665};
1666static const struct snd_pcm_ops snd_riptide_capture_ops = {
1667	.open = snd_riptide_capture_open,
1668	.close = snd_riptide_capture_close,
1669	.hw_params = snd_riptide_hw_params,
1670	.hw_free = snd_riptide_hw_free,
1671	.prepare = snd_riptide_prepare,
1672	.trigger = snd_riptide_trigger,
1673	.pointer = snd_riptide_pointer,
1674};
1675
1676static int snd_riptide_pcm(struct snd_riptide *chip, int device)
1677{
1678	struct snd_pcm *pcm;
1679	int err;
1680
1681	if ((err =
1682	     snd_pcm_new(chip->card, "RIPTIDE", device, PLAYBACK_SUBSTREAMS, 1,
1683			 &pcm)) < 0)
1684		return err;
1685	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
1686			&snd_riptide_playback_ops);
1687	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE,
1688			&snd_riptide_capture_ops);
1689	pcm->private_data = chip;
1690	pcm->info_flags = 0;
1691	strcpy(pcm->name, "RIPTIDE");
1692	chip->pcm = pcm;
1693	snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV_SG,
1694				       &chip->pci->dev, 64 * 1024, 128 * 1024);
1695	return 0;
1696}
1697
1698static irqreturn_t
1699snd_riptide_interrupt(int irq, void *dev_id)
1700{
1701	struct snd_riptide *chip = dev_id;
1702	struct cmdif *cif = chip->cif;
1703	irqreturn_t ret = IRQ_HANDLED;
1704
1705	if (cif) {
1706		chip->received_irqs++;
1707		if (IS_EOBIRQ(cif->hwport) || IS_EOSIRQ(cif->hwport) ||
1708		    IS_EOCIRQ(cif->hwport)) {
1709			chip->handled_irqs++;
1710			ret = IRQ_WAKE_THREAD;
1711		}
1712		if (chip->rmidi && IS_MPUIRQ(cif->hwport)) {
1713			chip->handled_irqs++;
1714			snd_mpu401_uart_interrupt(irq,
1715						  chip->rmidi->private_data);
1716		}
1717		SET_AIACK(cif->hwport);
1718	}
1719	return ret;
1720}
1721
1722static void
1723snd_riptide_codec_write(struct snd_ac97 *ac97, unsigned short reg,
1724			unsigned short val)
1725{
1726	struct snd_riptide *chip = ac97->private_data;
1727	struct cmdif *cif = chip->cif;
1728	union cmdret rptr = CMDRET_ZERO;
1729	int i = 0;
1730
1731	if (snd_BUG_ON(!cif))
1732		return;
1733
1734	snd_printdd("Write AC97 reg 0x%x 0x%x\n", reg, val);
1735	do {
1736		SEND_SACR(cif, val, reg);
1737		SEND_RACR(cif, reg, &rptr);
1738	} while (rptr.retwords[1] != val && i++ < MAX_WRITE_RETRY);
1739	if (i > MAX_WRITE_RETRY)
1740		snd_printdd("Write AC97 reg failed\n");
1741}
1742
1743static unsigned short snd_riptide_codec_read(struct snd_ac97 *ac97,
1744					     unsigned short reg)
1745{
1746	struct snd_riptide *chip = ac97->private_data;
1747	struct cmdif *cif = chip->cif;
1748	union cmdret rptr = CMDRET_ZERO;
1749
1750	if (snd_BUG_ON(!cif))
1751		return 0;
1752
1753	if (SEND_RACR(cif, reg, &rptr) != 0)
1754		SEND_RACR(cif, reg, &rptr);
1755	snd_printdd("Read AC97 reg 0x%x got 0x%x\n", reg, rptr.retwords[1]);
1756	return rptr.retwords[1];
1757}
1758
1759static int snd_riptide_initialize(struct snd_riptide *chip)
1760{
1761	struct cmdif *cif;
1762	unsigned int device_id;
1763	int err;
1764
1765	if (snd_BUG_ON(!chip))
1766		return -EINVAL;
1767
1768	cif = chip->cif;
1769	if (!cif) {
1770		if ((cif = kzalloc(sizeof(struct cmdif), GFP_KERNEL)) == NULL)
1771			return -ENOMEM;
1772		cif->hwport = (struct riptideport *)chip->port;
1773		spin_lock_init(&cif->lock);
1774		chip->cif = cif;
1775	}
1776	cif->is_reset = 0;
1777	if ((err = riptide_reset(cif, chip)) != 0)
1778		return err;
1779	device_id = chip->device_id;
1780	switch (device_id) {
1781	case 0x4310:
1782	case 0x4320:
1783	case 0x4330:
1784		snd_printdd("Modem enable?\n");
1785		SEND_SETDPLL(cif);
1786		break;
1787	}
1788	snd_printdd("Enabling MPU IRQs\n");
1789	if (chip->rmidi)
1790		SET_EMPUIRQ(cif->hwport);
1791	return err;
1792}
1793
1794static int snd_riptide_free(struct snd_riptide *chip)
1795{
1796	struct cmdif *cif;
1797
1798	if (!chip)
1799		return 0;
1800
1801	if ((cif = chip->cif)) {
1802		SET_GRESET(cif->hwport);
1803		udelay(100);
1804		UNSET_GRESET(cif->hwport);
1805		kfree(chip->cif);
1806	}
1807	if (chip->irq >= 0)
1808		free_irq(chip->irq, chip);
1809	release_firmware(chip->fw_entry);
1810	release_and_free_resource(chip->res_port);
1811	kfree(chip);
1812	return 0;
1813}
1814
1815static int snd_riptide_dev_free(struct snd_device *device)
1816{
1817	struct snd_riptide *chip = device->device_data;
1818
1819	return snd_riptide_free(chip);
1820}
1821
1822static int
1823snd_riptide_create(struct snd_card *card, struct pci_dev *pci,
1824		   struct snd_riptide **rchip)
1825{
1826	struct snd_riptide *chip;
1827	struct riptideport *hwport;
1828	int err;
1829	static const struct snd_device_ops ops = {
1830		.dev_free = snd_riptide_dev_free,
1831	};
1832
1833	*rchip = NULL;
1834	if ((err = pci_enable_device(pci)) < 0)
1835		return err;
1836	if (!(chip = kzalloc(sizeof(struct snd_riptide), GFP_KERNEL)))
1837		return -ENOMEM;
1838
1839	spin_lock_init(&chip->lock);
1840	chip->card = card;
1841	chip->pci = pci;
1842	chip->irq = -1;
1843	chip->openstreams = 0;
1844	chip->port = pci_resource_start(pci, 0);
1845	chip->received_irqs = 0;
1846	chip->handled_irqs = 0;
1847	chip->cif = NULL;
1848
1849	if ((chip->res_port =
1850	     request_region(chip->port, 64, "RIPTIDE")) == NULL) {
1851		snd_printk(KERN_ERR
1852			   "Riptide: unable to grab region 0x%lx-0x%lx\n",
1853			   chip->port, chip->port + 64 - 1);
1854		snd_riptide_free(chip);
1855		return -EBUSY;
1856	}
1857	hwport = (struct riptideport *)chip->port;
1858	UNSET_AIE(hwport);
1859
1860	if (request_threaded_irq(pci->irq, snd_riptide_interrupt,
1861				 riptide_handleirq, IRQF_SHARED,
1862				 KBUILD_MODNAME, chip)) {
1863		snd_printk(KERN_ERR "Riptide: unable to grab IRQ %d\n",
1864			   pci->irq);
1865		snd_riptide_free(chip);
1866		return -EBUSY;
1867	}
1868	chip->irq = pci->irq;
1869	card->sync_irq = chip->irq;
1870	chip->device_id = pci->device;
1871	pci_set_master(pci);
1872	if ((err = snd_riptide_initialize(chip)) < 0) {
1873		snd_riptide_free(chip);
1874		return err;
1875	}
1876
1877	if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
1878		snd_riptide_free(chip);
1879		return err;
1880	}
1881
1882	*rchip = chip;
1883	return 0;
1884}
1885
1886static void
1887snd_riptide_proc_read(struct snd_info_entry *entry,
1888		      struct snd_info_buffer *buffer)
1889{
1890	struct snd_riptide *chip = entry->private_data;
1891	struct pcmhw *data;
1892	int i;
1893	struct cmdif *cif = NULL;
1894	unsigned char p[256];
1895	unsigned short rval = 0, lval = 0;
1896	unsigned int rate;
1897
1898	if (!chip)
1899		return;
1900
1901	snd_iprintf(buffer, "%s\n\n", chip->card->longname);
1902	snd_iprintf(buffer, "Device ID: 0x%x\nReceived IRQs: (%ld)%ld\nPorts:",
1903		    chip->device_id, chip->handled_irqs, chip->received_irqs);
1904	for (i = 0; i < 64; i += 4)
1905		snd_iprintf(buffer, "%c%02x: %08x",
1906			    (i % 16) ? ' ' : '\n', i, inl(chip->port + i));
1907	if ((cif = chip->cif)) {
1908		snd_iprintf(buffer,
1909			    "\nVersion: ASIC: %d CODEC: %d AUXDSP: %d PROG: %d",
1910			    chip->firmware.firmware.ASIC,
1911			    chip->firmware.firmware.CODEC,
1912			    chip->firmware.firmware.AUXDSP,
1913			    chip->firmware.firmware.PROG);
1914		snd_iprintf(buffer, "\nDigital mixer:");
1915		for (i = 0; i < 12; i++) {
1916			getmixer(cif, i, &rval, &lval);
1917			snd_iprintf(buffer, "\n %d: %d %d", i, rval, lval);
1918		}
1919		snd_iprintf(buffer,
1920			    "\nARM Commands num: %d failed: %d time: %d max: %d min: %d",
1921			    cif->cmdcnt, cif->errcnt,
1922			    cif->cmdtime, cif->cmdtimemax, cif->cmdtimemin);
1923	}
1924	snd_iprintf(buffer, "\nOpen streams %d:\n", chip->openstreams);
1925	for (i = 0; i < PLAYBACK_SUBSTREAMS; i++) {
1926		if (chip->playback_substream[i]
1927		    && chip->playback_substream[i]->runtime
1928		    && (data =
1929			chip->playback_substream[i]->runtime->private_data)) {
1930			snd_iprintf(buffer,
1931				    "stream: %d mixer: %d source: %d (%d,%d)\n",
1932				    data->id, data->mixer, data->source,
1933				    data->intdec[0], data->intdec[1]);
1934			if (!(getsamplerate(cif, data->intdec, &rate)))
1935				snd_iprintf(buffer, "rate: %d\n", rate);
1936		}
1937	}
1938	if (chip->capture_substream
1939	    && chip->capture_substream->runtime
1940	    && (data = chip->capture_substream->runtime->private_data)) {
1941		snd_iprintf(buffer,
1942			    "stream: %d mixer: %d source: %d (%d,%d)\n",
1943			    data->id, data->mixer,
1944			    data->source, data->intdec[0], data->intdec[1]);
1945		if (!(getsamplerate(cif, data->intdec, &rate)))
1946			snd_iprintf(buffer, "rate: %d\n", rate);
1947	}
1948	snd_iprintf(buffer, "Paths:\n");
1949	i = getpaths(cif, p);
1950	while (i >= 2) {
1951		i -= 2;
1952		snd_iprintf(buffer, "%x->%x ", p[i], p[i + 1]);
1953	}
1954	snd_iprintf(buffer, "\n");
1955}
1956
1957static void snd_riptide_proc_init(struct snd_riptide *chip)
1958{
1959	snd_card_ro_proc_new(chip->card, "riptide", chip,
1960			     snd_riptide_proc_read);
1961}
1962
1963static int snd_riptide_mixer(struct snd_riptide *chip)
1964{
1965	struct snd_ac97_bus *pbus;
1966	struct snd_ac97_template ac97;
1967	int err = 0;
1968	static const struct snd_ac97_bus_ops ops = {
1969		.write = snd_riptide_codec_write,
1970		.read = snd_riptide_codec_read,
1971	};
1972
1973	memset(&ac97, 0, sizeof(ac97));
1974	ac97.private_data = chip;
1975	ac97.scaps = AC97_SCAP_SKIP_MODEM;
1976
1977	if ((err = snd_ac97_bus(chip->card, 0, &ops, chip, &pbus)) < 0)
1978		return err;
1979
1980	chip->ac97_bus = pbus;
1981	ac97.pci = chip->pci;
1982	if ((err = snd_ac97_mixer(pbus, &ac97, &chip->ac97)) < 0)
1983		return err;
1984	return err;
1985}
1986
1987#ifdef SUPPORT_JOYSTICK
1988
1989static int
1990snd_riptide_joystick_probe(struct pci_dev *pci, const struct pci_device_id *id)
1991{
1992	static int dev;
1993	struct gameport *gameport;
1994	int ret;
1995
1996	if (dev >= SNDRV_CARDS)
1997		return -ENODEV;
1998
1999	if (!enable[dev]) {
2000		ret = -ENOENT;
2001		goto inc_dev;
2002	}
2003
2004	if (!joystick_port[dev]) {
2005		ret = 0;
2006		goto inc_dev;
2007	}
2008
2009	gameport = gameport_allocate_port();
2010	if (!gameport) {
2011		ret = -ENOMEM;
2012		goto inc_dev;
2013	}
2014	if (!request_region(joystick_port[dev], 8, "Riptide gameport")) {
2015		snd_printk(KERN_WARNING
2016			   "Riptide: cannot grab gameport 0x%x\n",
2017			   joystick_port[dev]);
2018		gameport_free_port(gameport);
2019		ret = -EBUSY;
2020		goto inc_dev;
2021	}
2022
2023	gameport->io = joystick_port[dev];
2024	gameport_register_port(gameport);
2025	pci_set_drvdata(pci, gameport);
2026
2027	ret = 0;
2028inc_dev:
2029	dev++;
2030	return ret;
2031}
2032
2033static void snd_riptide_joystick_remove(struct pci_dev *pci)
2034{
2035	struct gameport *gameport = pci_get_drvdata(pci);
2036	if (gameport) {
2037		release_region(gameport->io, 8);
2038		gameport_unregister_port(gameport);
2039	}
2040}
2041#endif
2042
2043static int
2044snd_card_riptide_probe(struct pci_dev *pci, const struct pci_device_id *pci_id)
2045{
2046	static int dev;
2047	struct snd_card *card;
2048	struct snd_riptide *chip;
2049	unsigned short val;
2050	int err;
2051
2052	if (dev >= SNDRV_CARDS)
2053		return -ENODEV;
2054	if (!enable[dev]) {
2055		dev++;
2056		return -ENOENT;
2057	}
2058
2059	err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE,
2060			   0, &card);
2061	if (err < 0)
2062		return err;
2063	err = snd_riptide_create(card, pci, &chip);
2064	if (err < 0)
2065		goto error;
2066	card->private_data = chip;
2067	err = snd_riptide_pcm(chip, 0);
2068	if (err < 0)
2069		goto error;
2070	err = snd_riptide_mixer(chip);
2071	if (err < 0)
2072		goto error;
2073
2074	val = LEGACY_ENABLE_ALL;
2075	if (opl3_port[dev])
2076		val |= LEGACY_ENABLE_FM;
2077#ifdef SUPPORT_JOYSTICK
2078	if (joystick_port[dev])
2079		val |= LEGACY_ENABLE_GAMEPORT;
2080#endif
2081	if (mpu_port[dev])
2082		val |= LEGACY_ENABLE_MPU_INT | LEGACY_ENABLE_MPU;
2083	val |= (chip->irq << 4) & 0xf0;
2084	pci_write_config_word(chip->pci, PCI_EXT_Legacy_Mask, val);
2085	if (mpu_port[dev]) {
2086		val = mpu_port[dev];
2087		pci_write_config_word(chip->pci, PCI_EXT_MPU_Base, val);
2088		err = snd_mpu401_uart_new(card, 0, MPU401_HW_RIPTIDE,
2089					  val, MPU401_INFO_IRQ_HOOK, -1,
2090					  &chip->rmidi);
2091		if (err < 0)
2092			snd_printk(KERN_WARNING
2093				   "Riptide: Can't Allocate MPU at 0x%x\n",
2094				   val);
2095		else
2096			chip->mpuaddr = val;
2097	}
2098	if (opl3_port[dev]) {
2099		val = opl3_port[dev];
2100		pci_write_config_word(chip->pci, PCI_EXT_FM_Base, val);
2101		err = snd_opl3_create(card, val, val + 2,
2102				      OPL3_HW_RIPTIDE, 0, &chip->opl3);
2103		if (err < 0)
2104			snd_printk(KERN_WARNING
2105				   "Riptide: Can't Allocate OPL3 at 0x%x\n",
2106				   val);
2107		else {
2108			chip->opladdr = val;
2109			err = snd_opl3_hwdep_new(chip->opl3, 0, 1, NULL);
2110			if (err < 0)
2111				snd_printk(KERN_WARNING
2112					   "Riptide: Can't Allocate OPL3-HWDEP\n");
2113		}
2114	}
2115#ifdef SUPPORT_JOYSTICK
2116	if (joystick_port[dev]) {
2117		val = joystick_port[dev];
2118		pci_write_config_word(chip->pci, PCI_EXT_Game_Base, val);
2119		chip->gameaddr = val;
2120	}
2121#endif
2122
2123	strcpy(card->driver, "RIPTIDE");
2124	strcpy(card->shortname, "Riptide");
2125#ifdef SUPPORT_JOYSTICK
2126	snprintf(card->longname, sizeof(card->longname),
2127		 "%s at 0x%lx, irq %i mpu 0x%x opl3 0x%x gameport 0x%x",
2128		 card->shortname, chip->port, chip->irq, chip->mpuaddr,
2129		 chip->opladdr, chip->gameaddr);
2130#else
2131	snprintf(card->longname, sizeof(card->longname),
2132		 "%s at 0x%lx, irq %i mpu 0x%x opl3 0x%x",
2133		 card->shortname, chip->port, chip->irq, chip->mpuaddr,
2134		 chip->opladdr);
2135#endif
2136	snd_riptide_proc_init(chip);
2137	err = snd_card_register(card);
2138	if (err < 0)
2139		goto error;
2140	pci_set_drvdata(pci, card);
2141	dev++;
2142	return 0;
2143
2144 error:
2145	snd_card_free(card);
2146	return err;
2147}
2148
2149static void snd_card_riptide_remove(struct pci_dev *pci)
2150{
2151	snd_card_free(pci_get_drvdata(pci));
2152}
2153
2154static struct pci_driver driver = {
2155	.name = KBUILD_MODNAME,
2156	.id_table = snd_riptide_ids,
2157	.probe = snd_card_riptide_probe,
2158	.remove = snd_card_riptide_remove,
2159	.driver = {
2160		.pm = RIPTIDE_PM_OPS,
2161	},
2162};
2163
2164#ifdef SUPPORT_JOYSTICK
2165static struct pci_driver joystick_driver = {
2166	.name = KBUILD_MODNAME "-joystick",
2167	.id_table = snd_riptide_joystick_ids,
2168	.probe = snd_riptide_joystick_probe,
2169	.remove = snd_riptide_joystick_remove,
2170};
2171#endif
2172
2173static int __init alsa_card_riptide_init(void)
2174{
2175	int err;
2176	err = pci_register_driver(&driver);
2177	if (err < 0)
2178		return err;
2179#if defined(SUPPORT_JOYSTICK)
2180	err = pci_register_driver(&joystick_driver);
2181	/* On failure unregister formerly registered audio driver */
2182	if (err < 0)
2183		pci_unregister_driver(&driver);
2184#endif
2185	return err;
2186}
2187
2188static void __exit alsa_card_riptide_exit(void)
2189{
2190	pci_unregister_driver(&driver);
2191#if defined(SUPPORT_JOYSTICK)
2192	pci_unregister_driver(&joystick_driver);
2193#endif
2194}
2195
2196module_init(alsa_card_riptide_init);
2197module_exit(alsa_card_riptide_exit);
2198