xref: /openbmc/linux/sound/pci/korg1212/korg1212.c (revision c67e8ec0)
1 /*
2  *   Driver for the Korg 1212 IO PCI card
3  *
4  *	Copyright (c) 2001 Haroldo Gamal <gamal@alternex.com.br>
5  *
6  *   This program is free software; you can redistribute it and/or modify
7  *   it under the terms of the GNU General Public License as published by
8  *   the Free Software Foundation; either version 2 of the License, or
9  *   (at your option) any later version.
10  *
11  *   This program is distributed in the hope that it will be useful,
12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *   GNU General Public License for more details.
15  *
16  *   You should have received a copy of the GNU General Public License
17  *   along with this program; if not, write to the Free Software
18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19  *
20  */
21 
22 #include <linux/delay.h>
23 #include <linux/init.h>
24 #include <linux/interrupt.h>
25 #include <linux/pci.h>
26 #include <linux/slab.h>
27 #include <linux/wait.h>
28 #include <linux/module.h>
29 #include <linux/mutex.h>
30 #include <linux/firmware.h>
31 #include <linux/io.h>
32 
33 #include <sound/core.h>
34 #include <sound/info.h>
35 #include <sound/control.h>
36 #include <sound/pcm.h>
37 #include <sound/pcm_params.h>
38 #include <sound/initval.h>
39 
40 // ----------------------------------------------------------------------------
41 // Debug Stuff
42 // ----------------------------------------------------------------------------
43 #define K1212_DEBUG_LEVEL		0
44 #if K1212_DEBUG_LEVEL > 0
45 #define K1212_DEBUG_PRINTK(fmt,args...)	printk(KERN_DEBUG fmt,##args)
46 #else
47 #define K1212_DEBUG_PRINTK(fmt,...)
48 #endif
49 #if K1212_DEBUG_LEVEL > 1
50 #define K1212_DEBUG_PRINTK_VERBOSE(fmt,args...)	printk(KERN_DEBUG fmt,##args)
51 #else
52 #define K1212_DEBUG_PRINTK_VERBOSE(fmt,...)
53 #endif
54 
55 // ----------------------------------------------------------------------------
56 // Record/Play Buffer Allocation Method. If K1212_LARGEALLOC is defined all
57 // buffers are alocated as a large piece inside KorgSharedBuffer.
58 // ----------------------------------------------------------------------------
59 //#define K1212_LARGEALLOC		1
60 
61 // ----------------------------------------------------------------------------
62 // Valid states of the Korg 1212 I/O card.
63 // ----------------------------------------------------------------------------
64 enum CardState {
65    K1212_STATE_NONEXISTENT,		// there is no card here
66    K1212_STATE_UNINITIALIZED,		// the card is awaiting DSP download
67    K1212_STATE_DSP_IN_PROCESS,		// the card is currently downloading its DSP code
68    K1212_STATE_DSP_COMPLETE,		// the card has finished the DSP download
69    K1212_STATE_READY,			// the card can be opened by an application.  Any application
70 					//    requests prior to this state should fail.  Only an open
71 					//    request can be made at this state.
72    K1212_STATE_OPEN,			// an application has opened the card
73    K1212_STATE_SETUP,			// the card has been setup for play
74    K1212_STATE_PLAYING,			// the card is playing
75    K1212_STATE_MONITOR,			// the card is in the monitor mode
76    K1212_STATE_CALIBRATING,		// the card is currently calibrating
77    K1212_STATE_ERRORSTOP,		// the card has stopped itself because of an error and we
78 					//    are in the process of cleaning things up.
79    K1212_STATE_MAX_STATE		// state values of this and beyond are invalid
80 };
81 
82 // ----------------------------------------------------------------------------
83 // The following enumeration defines the constants written to the card's
84 // host-to-card doorbell to initiate a command.
85 // ----------------------------------------------------------------------------
86 enum korg1212_dbcnst {
87    K1212_DB_RequestForData        = 0,    // sent by the card to request a buffer fill.
88    K1212_DB_TriggerPlay           = 1,    // starts playback/record on the card.
89    K1212_DB_SelectPlayMode        = 2,    // select monitor, playback setup, or stop.
90    K1212_DB_ConfigureBufferMemory = 3,    // tells card where the host audio buffers are.
91    K1212_DB_RequestAdatTimecode   = 4,    // asks the card for the latest ADAT timecode value.
92    K1212_DB_SetClockSourceRate    = 5,    // sets the clock source and rate for the card.
93    K1212_DB_ConfigureMiscMemory   = 6,    // tells card where other buffers are.
94    K1212_DB_TriggerFromAdat       = 7,    // tells card to trigger from Adat at a specific
95                                           //    timecode value.
96    K1212_DB_DMAERROR              = 0x80, // DMA Error - the PCI bus is congestioned.
97    K1212_DB_CARDSTOPPED           = 0x81, // Card has stopped by user request.
98    K1212_DB_RebootCard            = 0xA0, // instructs the card to reboot.
99    K1212_DB_BootFromDSPPage4      = 0xA4, // instructs the card to boot from the DSP microcode
100                                           //    on page 4 (local page to card).
101    K1212_DB_DSPDownloadDone       = 0xAE, // sent by the card to indicate the download has
102                                           //    completed.
103    K1212_DB_StartDSPDownload      = 0xAF  // tells the card to download its DSP firmware.
104 };
105 
106 
107 // ----------------------------------------------------------------------------
108 // The following enumeration defines return codes
109 // to the Korg 1212 I/O driver.
110 // ----------------------------------------------------------------------------
111 enum snd_korg1212rc {
112    K1212_CMDRET_Success         = 0,   // command was successfully placed
113    K1212_CMDRET_DIOCFailure,           // the DeviceIoControl call failed
114    K1212_CMDRET_PMFailure,             // the protected mode call failed
115    K1212_CMDRET_FailUnspecified,       // unspecified failure
116    K1212_CMDRET_FailBadState,          // the specified command can not be given in
117                                        //    the card's current state. (or the wave device's
118                                        //    state)
119    K1212_CMDRET_CardUninitialized,     // the card is uninitialized and cannot be used
120    K1212_CMDRET_BadIndex,              // an out of range card index was specified
121    K1212_CMDRET_BadHandle,             // an invalid card handle was specified
122    K1212_CMDRET_NoFillRoutine,         // a play request has been made before a fill routine set
123    K1212_CMDRET_FillRoutineInUse,      // can't set a new fill routine while one is in use
124    K1212_CMDRET_NoAckFromCard,         // the card never acknowledged a command
125    K1212_CMDRET_BadParams,             // bad parameters were provided by the caller
126 
127    K1212_CMDRET_BadDevice,             // the specified wave device was out of range
128    K1212_CMDRET_BadFormat              // the specified wave format is unsupported
129 };
130 
131 // ----------------------------------------------------------------------------
132 // The following enumeration defines the constants used to select the play
133 // mode for the card in the SelectPlayMode command.
134 // ----------------------------------------------------------------------------
135 enum PlayModeSelector {
136    K1212_MODE_SetupPlay  = 0x00000001,     // provides card with pre-play information
137    K1212_MODE_MonitorOn  = 0x00000002,     // tells card to turn on monitor mode
138    K1212_MODE_MonitorOff = 0x00000004,     // tells card to turn off monitor mode
139    K1212_MODE_StopPlay   = 0x00000008      // stops playback on the card
140 };
141 
142 // ----------------------------------------------------------------------------
143 // The following enumeration defines the constants used to select the monitor
144 // mode for the card in the SetMonitorMode command.
145 // ----------------------------------------------------------------------------
146 enum MonitorModeSelector {
147    K1212_MONMODE_Off  = 0,     // tells card to turn off monitor mode
148    K1212_MONMODE_On            // tells card to turn on monitor mode
149 };
150 
151 #define MAILBOX0_OFFSET      0x40	// location of mailbox 0 relative to base address
152 #define MAILBOX1_OFFSET      0x44	// location of mailbox 1 relative to base address
153 #define MAILBOX2_OFFSET      0x48	// location of mailbox 2 relative to base address
154 #define MAILBOX3_OFFSET      0x4c	// location of mailbox 3 relative to base address
155 #define OUT_DOORBELL_OFFSET  0x60	// location of PCI to local doorbell
156 #define IN_DOORBELL_OFFSET   0x64	// location of local to PCI doorbell
157 #define STATUS_REG_OFFSET    0x68	// location of interrupt control/status register
158 #define PCI_CONTROL_OFFSET   0x6c	// location of the EEPROM, PCI, User I/O, init control
159 					//    register
160 #define SENS_CONTROL_OFFSET  0x6e	// location of the input sensitivity setting register.
161 					//    this is the upper word of the PCI control reg.
162 #define DEV_VEND_ID_OFFSET   0x70	// location of the device and vendor ID register
163 
164 #define MAX_COMMAND_RETRIES  5         // maximum number of times the driver will attempt
165                                        //    to send a command before giving up.
166 #define COMMAND_ACK_MASK     0x8000    // the MSB is set in the command acknowledgment from
167                                         //    the card.
168 #define DOORBELL_VAL_MASK    0x00FF    // the doorbell value is one byte
169 
170 #define CARD_BOOT_DELAY_IN_MS  10
171 #define CARD_BOOT_TIMEOUT      10
172 #define DSP_BOOT_DELAY_IN_MS   200
173 
174 #define kNumBuffers		8
175 #define k1212MaxCards		4
176 #define k1212NumWaveDevices	6
177 #define k16BitChannels		10
178 #define k32BitChannels		2
179 #define kAudioChannels		(k16BitChannels + k32BitChannels)
180 #define kPlayBufferFrames	1024
181 
182 #define K1212_ANALOG_CHANNELS	2
183 #define K1212_SPDIF_CHANNELS	2
184 #define K1212_ADAT_CHANNELS	8
185 #define K1212_CHANNELS		(K1212_ADAT_CHANNELS + K1212_ANALOG_CHANNELS)
186 #define K1212_MIN_CHANNELS	1
187 #define K1212_MAX_CHANNELS	K1212_CHANNELS
188 #define K1212_FRAME_SIZE        (sizeof(struct KorgAudioFrame))
189 #define K1212_MAX_SAMPLES	(kPlayBufferFrames*kNumBuffers)
190 #define K1212_PERIODS		(kNumBuffers)
191 #define K1212_PERIOD_BYTES	(K1212_FRAME_SIZE*kPlayBufferFrames)
192 #define K1212_BUF_SIZE          (K1212_PERIOD_BYTES*kNumBuffers)
193 #define K1212_ANALOG_BUF_SIZE	(K1212_ANALOG_CHANNELS * 2 * kPlayBufferFrames * kNumBuffers)
194 #define K1212_SPDIF_BUF_SIZE	(K1212_SPDIF_CHANNELS * 3 * kPlayBufferFrames * kNumBuffers)
195 #define K1212_ADAT_BUF_SIZE	(K1212_ADAT_CHANNELS * 2 * kPlayBufferFrames * kNumBuffers)
196 #define K1212_MAX_BUF_SIZE	(K1212_ANALOG_BUF_SIZE + K1212_ADAT_BUF_SIZE)
197 
198 #define k1212MinADCSens     0x00
199 #define k1212MaxADCSens     0x7f
200 #define k1212MaxVolume      0x7fff
201 #define k1212MaxWaveVolume  0xffff
202 #define k1212MinVolume      0x0000
203 #define k1212MaxVolInverted 0x8000
204 
205 // -----------------------------------------------------------------
206 // the following bits are used for controlling interrupts in the
207 // interrupt control/status reg
208 // -----------------------------------------------------------------
209 #define  PCI_INT_ENABLE_BIT               0x00000100
210 #define  PCI_DOORBELL_INT_ENABLE_BIT      0x00000200
211 #define  LOCAL_INT_ENABLE_BIT             0x00010000
212 #define  LOCAL_DOORBELL_INT_ENABLE_BIT    0x00020000
213 #define  LOCAL_DMA1_INT_ENABLE_BIT        0x00080000
214 
215 // -----------------------------------------------------------------
216 // the following bits are defined for the PCI command register
217 // -----------------------------------------------------------------
218 #define  PCI_CMD_MEM_SPACE_ENABLE_BIT     0x0002
219 #define  PCI_CMD_IO_SPACE_ENABLE_BIT      0x0001
220 #define  PCI_CMD_BUS_MASTER_ENABLE_BIT    0x0004
221 
222 // -----------------------------------------------------------------
223 // the following bits are defined for the PCI status register
224 // -----------------------------------------------------------------
225 #define  PCI_STAT_PARITY_ERROR_BIT        0x8000
226 #define  PCI_STAT_SYSTEM_ERROR_BIT        0x4000
227 #define  PCI_STAT_MASTER_ABORT_RCVD_BIT   0x2000
228 #define  PCI_STAT_TARGET_ABORT_RCVD_BIT   0x1000
229 #define  PCI_STAT_TARGET_ABORT_SENT_BIT   0x0800
230 
231 // ------------------------------------------------------------------------
232 // the following constants are used in setting the 1212 I/O card's input
233 // sensitivity.
234 // ------------------------------------------------------------------------
235 #define  SET_SENS_LOCALINIT_BITPOS        15
236 #define  SET_SENS_DATA_BITPOS             10
237 #define  SET_SENS_CLOCK_BITPOS            8
238 #define  SET_SENS_LOADSHIFT_BITPOS        0
239 
240 #define  SET_SENS_LEFTCHANID              0x00
241 #define  SET_SENS_RIGHTCHANID             0x01
242 
243 #define  K1212SENSUPDATE_DELAY_IN_MS      50
244 
245 // --------------------------------------------------------------------------
246 // WaitRTCTicks
247 //
248 //    This function waits the specified number of real time clock ticks.
249 //    According to the DDK, each tick is ~0.8 microseconds.
250 //    The defines following the function declaration can be used for the
251 //    numTicksToWait parameter.
252 // --------------------------------------------------------------------------
253 #define ONE_RTC_TICK         1
254 #define SENSCLKPULSE_WIDTH   4
255 #define LOADSHIFT_DELAY      4
256 #define INTERCOMMAND_DELAY  40
257 #define STOPCARD_DELAY      300        // max # RTC ticks for the card to stop once we write
258                                        //    the command register.  (could be up to 180 us)
259 #define COMMAND_ACK_DELAY   13         // number of RTC ticks to wait for an acknowledgement
260                                        //    from the card after sending a command.
261 
262 enum ClockSourceIndex {
263    K1212_CLKIDX_AdatAt44_1K = 0,    // selects source as ADAT at 44.1 kHz
264    K1212_CLKIDX_AdatAt48K,          // selects source as ADAT at 48 kHz
265    K1212_CLKIDX_WordAt44_1K,        // selects source as S/PDIF at 44.1 kHz
266    K1212_CLKIDX_WordAt48K,          // selects source as S/PDIF at 48 kHz
267    K1212_CLKIDX_LocalAt44_1K,       // selects source as local clock at 44.1 kHz
268    K1212_CLKIDX_LocalAt48K,         // selects source as local clock at 48 kHz
269    K1212_CLKIDX_Invalid             // used to check validity of the index
270 };
271 
272 enum ClockSourceType {
273    K1212_CLKIDX_Adat = 0,    // selects source as ADAT
274    K1212_CLKIDX_Word,        // selects source as S/PDIF
275    K1212_CLKIDX_Local        // selects source as local clock
276 };
277 
278 struct KorgAudioFrame {
279 	u16 frameData16[k16BitChannels]; /* channels 0-9 use 16 bit samples */
280 	u32 frameData32[k32BitChannels]; /* channels 10-11 use 32 bits - only 20 are sent across S/PDIF */
281 	u32 timeCodeVal; /* holds the ADAT timecode value */
282 };
283 
284 struct KorgAudioBuffer {
285 	struct KorgAudioFrame  bufferData[kPlayBufferFrames];     /* buffer definition */
286 };
287 
288 struct KorgSharedBuffer {
289 #ifdef K1212_LARGEALLOC
290    struct KorgAudioBuffer   playDataBufs[kNumBuffers];
291    struct KorgAudioBuffer   recordDataBufs[kNumBuffers];
292 #endif
293    short             volumeData[kAudioChannels];
294    u32               cardCommand;
295    u16               routeData [kAudioChannels];
296    u32               AdatTimeCode;                 // ADAT timecode value
297 };
298 
299 struct SensBits {
300    union {
301       struct {
302          unsigned int leftChanVal:8;
303          unsigned int leftChanId:8;
304       } v;
305       u16  leftSensBits;
306    } l;
307    union {
308       struct {
309          unsigned int rightChanVal:8;
310          unsigned int rightChanId:8;
311       } v;
312       u16  rightSensBits;
313    } r;
314 };
315 
316 struct snd_korg1212 {
317         struct snd_card *card;
318         struct pci_dev *pci;
319         struct snd_pcm *pcm;
320         int irq;
321 
322         spinlock_t    lock;
323 	struct mutex open_mutex;
324 
325 	struct timer_list timer;	/* timer callback for checking ack of stop request */
326 	int stop_pending_cnt;		/* counter for stop pending check */
327 
328         wait_queue_head_t wait;
329 
330         unsigned long iomem;
331         unsigned long ioport;
332 	unsigned long iomem2;
333         unsigned long irqcount;
334         unsigned long inIRQ;
335         void __iomem *iobase;
336 
337 	struct snd_dma_buffer dma_dsp;
338         struct snd_dma_buffer dma_play;
339         struct snd_dma_buffer dma_rec;
340 	struct snd_dma_buffer dma_shared;
341 
342 	u32 DataBufsSize;
343 
344         struct KorgAudioBuffer  * playDataBufsPtr;
345         struct KorgAudioBuffer  * recordDataBufsPtr;
346 
347 	struct KorgSharedBuffer * sharedBufferPtr;
348 
349 	u32 RecDataPhy;
350 	u32 PlayDataPhy;
351 	unsigned long sharedBufferPhy;
352 	u32 VolumeTablePhy;
353 	u32 RoutingTablePhy;
354 	u32 AdatTimeCodePhy;
355 
356         u32 __iomem * statusRegPtr;	     // address of the interrupt status/control register
357         u32 __iomem * outDoorbellPtr;	     // address of the host->card doorbell register
358         u32 __iomem * inDoorbellPtr;	     // address of the card->host doorbell register
359         u32 __iomem * mailbox0Ptr;	     // address of mailbox 0 on the card
360         u32 __iomem * mailbox1Ptr;	     // address of mailbox 1 on the card
361         u32 __iomem * mailbox2Ptr;	     // address of mailbox 2 on the card
362         u32 __iomem * mailbox3Ptr;	     // address of mailbox 3 on the card
363         u32 __iomem * controlRegPtr;	     // address of the EEPROM, PCI, I/O, Init ctrl reg
364         u16 __iomem * sensRegPtr;	     // address of the sensitivity setting register
365         u32 __iomem * idRegPtr;		     // address of the device and vendor ID registers
366 
367         size_t periodsize;
368 	int channels;
369         int currentBuffer;
370 
371         struct snd_pcm_substream *playback_substream;
372         struct snd_pcm_substream *capture_substream;
373 
374 	pid_t capture_pid;
375 	pid_t playback_pid;
376 
377  	enum CardState cardState;
378         int running;
379         int idleMonitorOn;           // indicates whether the card is in idle monitor mode.
380         u32 cmdRetryCount;           // tracks how many times we have retried sending to the card.
381 
382         enum ClockSourceIndex clkSrcRate; // sample rate and clock source
383 
384         enum ClockSourceType clkSource;   // clock source
385         int clkRate;                 // clock rate
386 
387         int volumePhase[kAudioChannels];
388 
389         u16 leftADCInSens;           // ADC left channel input sensitivity
390         u16 rightADCInSens;          // ADC right channel input sensitivity
391 
392 	int opencnt;		     // Open/Close count
393 	int setcnt;		     // SetupForPlay count
394 	int playcnt;		     // TriggerPlay count
395 	int errorcnt;		     // Error Count
396 	unsigned long totalerrorcnt; // Total Error Count
397 
398 	int dsp_is_loaded;
399 	int dsp_stop_is_processed;
400 
401 };
402 
403 MODULE_DESCRIPTION("korg1212");
404 MODULE_LICENSE("GPL");
405 MODULE_SUPPORTED_DEVICE("{{KORG,korg1212}}");
406 MODULE_FIRMWARE("korg/k1212.dsp");
407 
408 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;     /* Index 0-MAX */
409 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	   /* ID for this card */
410 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE; /* Enable this card */
411 
412 module_param_array(index, int, NULL, 0444);
413 MODULE_PARM_DESC(index, "Index value for Korg 1212 soundcard.");
414 module_param_array(id, charp, NULL, 0444);
415 MODULE_PARM_DESC(id, "ID string for Korg 1212 soundcard.");
416 module_param_array(enable, bool, NULL, 0444);
417 MODULE_PARM_DESC(enable, "Enable Korg 1212 soundcard.");
418 MODULE_AUTHOR("Haroldo Gamal <gamal@alternex.com.br>");
419 
420 static const struct pci_device_id snd_korg1212_ids[] = {
421 	{
422 		.vendor	   = 0x10b5,
423 		.device	   = 0x906d,
424 		.subvendor = PCI_ANY_ID,
425 		.subdevice = PCI_ANY_ID,
426 	},
427 	{ 0, },
428 };
429 
430 MODULE_DEVICE_TABLE(pci, snd_korg1212_ids);
431 
432 static char *stateName[] = {
433 	"Non-existent",
434 	"Uninitialized",
435 	"DSP download in process",
436 	"DSP download complete",
437 	"Ready",
438 	"Open",
439 	"Setup for play",
440 	"Playing",
441 	"Monitor mode on",
442 	"Calibrating",
443 	"Invalid"
444 };
445 
446 static const char * const clockSourceTypeName[] = { "ADAT", "S/PDIF", "local" };
447 
448 static const char * const clockSourceName[] = {
449 	"ADAT at 44.1 kHz",
450 	"ADAT at 48 kHz",
451 	"S/PDIF at 44.1 kHz",
452 	"S/PDIF at 48 kHz",
453 	"local clock at 44.1 kHz",
454 	"local clock at 48 kHz"
455 };
456 
457 static const char * const channelName[] = {
458 	"ADAT-1",
459 	"ADAT-2",
460 	"ADAT-3",
461 	"ADAT-4",
462 	"ADAT-5",
463 	"ADAT-6",
464 	"ADAT-7",
465 	"ADAT-8",
466 	"Analog-L",
467 	"Analog-R",
468 	"SPDIF-L",
469 	"SPDIF-R",
470 };
471 
472 static u16 ClockSourceSelector[] = {
473 	0x8000,   // selects source as ADAT at 44.1 kHz
474 	0x0000,   // selects source as ADAT at 48 kHz
475 	0x8001,   // selects source as S/PDIF at 44.1 kHz
476 	0x0001,   // selects source as S/PDIF at 48 kHz
477 	0x8002,   // selects source as local clock at 44.1 kHz
478 	0x0002    // selects source as local clock at 48 kHz
479 };
480 
481 union swap_u32 { unsigned char c[4]; u32 i; };
482 
483 #ifdef SNDRV_BIG_ENDIAN
484 static u32 LowerWordSwap(u32 swappee)
485 #else
486 static u32 UpperWordSwap(u32 swappee)
487 #endif
488 {
489    union swap_u32 retVal, swapper;
490 
491    swapper.i = swappee;
492    retVal.c[2] = swapper.c[3];
493    retVal.c[3] = swapper.c[2];
494    retVal.c[1] = swapper.c[1];
495    retVal.c[0] = swapper.c[0];
496 
497    return retVal.i;
498 }
499 
500 #ifdef SNDRV_BIG_ENDIAN
501 static u32 UpperWordSwap(u32 swappee)
502 #else
503 static u32 LowerWordSwap(u32 swappee)
504 #endif
505 {
506    union swap_u32 retVal, swapper;
507 
508    swapper.i = swappee;
509    retVal.c[2] = swapper.c[2];
510    retVal.c[3] = swapper.c[3];
511    retVal.c[1] = swapper.c[0];
512    retVal.c[0] = swapper.c[1];
513 
514    return retVal.i;
515 }
516 
517 #define SetBitInWord(theWord,bitPosition)       (*theWord) |= (0x0001 << bitPosition)
518 #define SetBitInDWord(theWord,bitPosition)      (*theWord) |= (0x00000001 << bitPosition)
519 #define ClearBitInWord(theWord,bitPosition)     (*theWord) &= ~(0x0001 << bitPosition)
520 #define ClearBitInDWord(theWord,bitPosition)    (*theWord) &= ~(0x00000001 << bitPosition)
521 
522 static int snd_korg1212_Send1212Command(struct snd_korg1212 *korg1212,
523 					enum korg1212_dbcnst doorbellVal,
524 					u32 mailBox0Val, u32 mailBox1Val,
525 					u32 mailBox2Val, u32 mailBox3Val)
526 {
527         u32 retryCount;
528         u16 mailBox3Lo;
529 	int rc = K1212_CMDRET_Success;
530 
531         if (!korg1212->outDoorbellPtr) {
532 		K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: CardUninitialized\n");
533                 return K1212_CMDRET_CardUninitialized;
534 	}
535 
536 	K1212_DEBUG_PRINTK("K1212_DEBUG: Card <- 0x%08x 0x%08x [%s]\n",
537 			   doorbellVal, mailBox0Val, stateName[korg1212->cardState]);
538         for (retryCount = 0; retryCount < MAX_COMMAND_RETRIES; retryCount++) {
539 		writel(mailBox3Val, korg1212->mailbox3Ptr);
540                 writel(mailBox2Val, korg1212->mailbox2Ptr);
541                 writel(mailBox1Val, korg1212->mailbox1Ptr);
542                 writel(mailBox0Val, korg1212->mailbox0Ptr);
543                 writel(doorbellVal, korg1212->outDoorbellPtr);  // interrupt the card
544 
545                 // --------------------------------------------------------------
546                 // the reboot command will not give an acknowledgement.
547                 // --------------------------------------------------------------
548                 if ( doorbellVal == K1212_DB_RebootCard ||
549                 	doorbellVal == K1212_DB_BootFromDSPPage4 ||
550                         doorbellVal == K1212_DB_StartDSPDownload ) {
551                         rc = K1212_CMDRET_Success;
552                         break;
553                 }
554 
555                 // --------------------------------------------------------------
556                 // See if the card acknowledged the command.  Wait a bit, then
557                 // read in the low word of mailbox3.  If the MSB is set and the
558                 // low byte is equal to the doorbell value, then it ack'd.
559                 // --------------------------------------------------------------
560                 udelay(COMMAND_ACK_DELAY);
561                 mailBox3Lo = readl(korg1212->mailbox3Ptr);
562                 if (mailBox3Lo & COMMAND_ACK_MASK) {
563                 	if ((mailBox3Lo & DOORBELL_VAL_MASK) == (doorbellVal & DOORBELL_VAL_MASK)) {
564 				K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: Card <- Success\n");
565                                 rc = K1212_CMDRET_Success;
566 				break;
567                         }
568                 }
569 	}
570         korg1212->cmdRetryCount += retryCount;
571 
572 	if (retryCount >= MAX_COMMAND_RETRIES) {
573 		K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: Card <- NoAckFromCard\n");
574         	rc = K1212_CMDRET_NoAckFromCard;
575 	}
576 
577 	return rc;
578 }
579 
580 /* spinlock already held */
581 static void snd_korg1212_SendStop(struct snd_korg1212 *korg1212)
582 {
583 	if (! korg1212->stop_pending_cnt) {
584 		korg1212->sharedBufferPtr->cardCommand = 0xffffffff;
585 		/* program the timer */
586 		korg1212->stop_pending_cnt = HZ;
587 		mod_timer(&korg1212->timer, jiffies + 1);
588 	}
589 }
590 
591 static void snd_korg1212_SendStopAndWait(struct snd_korg1212 *korg1212)
592 {
593 	unsigned long flags;
594 	spin_lock_irqsave(&korg1212->lock, flags);
595 	korg1212->dsp_stop_is_processed = 0;
596 	snd_korg1212_SendStop(korg1212);
597 	spin_unlock_irqrestore(&korg1212->lock, flags);
598 	wait_event_timeout(korg1212->wait, korg1212->dsp_stop_is_processed, (HZ * 3) / 2);
599 }
600 
601 /* timer callback for checking the ack of stop request */
602 static void snd_korg1212_timer_func(struct timer_list *t)
603 {
604 	struct snd_korg1212 *korg1212 = from_timer(korg1212, t, timer);
605 	unsigned long flags;
606 
607 	spin_lock_irqsave(&korg1212->lock, flags);
608 	if (korg1212->sharedBufferPtr->cardCommand == 0) {
609 		/* ack'ed */
610 		korg1212->stop_pending_cnt = 0;
611 		korg1212->dsp_stop_is_processed = 1;
612 		wake_up(&korg1212->wait);
613 		K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: Stop ack'ed [%s]\n",
614 					   stateName[korg1212->cardState]);
615 	} else {
616 		if (--korg1212->stop_pending_cnt > 0) {
617 			/* reprogram timer */
618 			mod_timer(&korg1212->timer, jiffies + 1);
619 		} else {
620 			snd_printd("korg1212_timer_func timeout\n");
621 			korg1212->sharedBufferPtr->cardCommand = 0;
622 			korg1212->dsp_stop_is_processed = 1;
623 			wake_up(&korg1212->wait);
624 			K1212_DEBUG_PRINTK("K1212_DEBUG: Stop timeout [%s]\n",
625 					   stateName[korg1212->cardState]);
626 		}
627 	}
628 	spin_unlock_irqrestore(&korg1212->lock, flags);
629 }
630 
631 static int snd_korg1212_TurnOnIdleMonitor(struct snd_korg1212 *korg1212)
632 {
633 	unsigned long flags;
634 	int rc;
635 
636         udelay(INTERCOMMAND_DELAY);
637 	spin_lock_irqsave(&korg1212->lock, flags);
638         korg1212->idleMonitorOn = 1;
639         rc = snd_korg1212_Send1212Command(korg1212, K1212_DB_SelectPlayMode,
640 					  K1212_MODE_MonitorOn, 0, 0, 0);
641         spin_unlock_irqrestore(&korg1212->lock, flags);
642 	return rc;
643 }
644 
645 static void snd_korg1212_TurnOffIdleMonitor(struct snd_korg1212 *korg1212)
646 {
647         if (korg1212->idleMonitorOn) {
648 		snd_korg1212_SendStopAndWait(korg1212);
649                 korg1212->idleMonitorOn = 0;
650         }
651 }
652 
653 static inline void snd_korg1212_setCardState(struct snd_korg1212 * korg1212, enum CardState csState)
654 {
655         korg1212->cardState = csState;
656 }
657 
658 static int snd_korg1212_OpenCard(struct snd_korg1212 * korg1212)
659 {
660 	K1212_DEBUG_PRINTK("K1212_DEBUG: OpenCard [%s] %d\n",
661 			   stateName[korg1212->cardState], korg1212->opencnt);
662 	mutex_lock(&korg1212->open_mutex);
663         if (korg1212->opencnt++ == 0) {
664 		snd_korg1212_TurnOffIdleMonitor(korg1212);
665 		snd_korg1212_setCardState(korg1212, K1212_STATE_OPEN);
666 	}
667 
668 	mutex_unlock(&korg1212->open_mutex);
669         return 1;
670 }
671 
672 static int snd_korg1212_CloseCard(struct snd_korg1212 * korg1212)
673 {
674 	K1212_DEBUG_PRINTK("K1212_DEBUG: CloseCard [%s] %d\n",
675 			   stateName[korg1212->cardState], korg1212->opencnt);
676 
677 	mutex_lock(&korg1212->open_mutex);
678 	if (--(korg1212->opencnt)) {
679 		mutex_unlock(&korg1212->open_mutex);
680 		return 0;
681 	}
682 
683         if (korg1212->cardState == K1212_STATE_SETUP) {
684                 int rc = snd_korg1212_Send1212Command(korg1212, K1212_DB_SelectPlayMode,
685                                 K1212_MODE_StopPlay, 0, 0, 0);
686 		if (rc)
687 			K1212_DEBUG_PRINTK("K1212_DEBUG: CloseCard - RC = %d [%s]\n",
688 					   rc, stateName[korg1212->cardState]);
689 		if (rc != K1212_CMDRET_Success) {
690 			mutex_unlock(&korg1212->open_mutex);
691                         return 0;
692 		}
693         } else if (korg1212->cardState > K1212_STATE_SETUP) {
694 		snd_korg1212_SendStopAndWait(korg1212);
695         }
696 
697         if (korg1212->cardState > K1212_STATE_READY) {
698 		snd_korg1212_TurnOnIdleMonitor(korg1212);
699                 snd_korg1212_setCardState(korg1212, K1212_STATE_READY);
700 	}
701 
702 	mutex_unlock(&korg1212->open_mutex);
703         return 0;
704 }
705 
706 /* spinlock already held */
707 static int snd_korg1212_SetupForPlay(struct snd_korg1212 * korg1212)
708 {
709 	int rc;
710 
711 	K1212_DEBUG_PRINTK("K1212_DEBUG: SetupForPlay [%s] %d\n",
712 			   stateName[korg1212->cardState], korg1212->setcnt);
713 
714         if (korg1212->setcnt++)
715 		return 0;
716 
717         snd_korg1212_setCardState(korg1212, K1212_STATE_SETUP);
718         rc = snd_korg1212_Send1212Command(korg1212, K1212_DB_SelectPlayMode,
719                                         K1212_MODE_SetupPlay, 0, 0, 0);
720 	if (rc)
721 		K1212_DEBUG_PRINTK("K1212_DEBUG: SetupForPlay - RC = %d [%s]\n",
722 				   rc, stateName[korg1212->cardState]);
723         if (rc != K1212_CMDRET_Success) {
724                 return 1;
725         }
726         return 0;
727 }
728 
729 /* spinlock already held */
730 static int snd_korg1212_TriggerPlay(struct snd_korg1212 * korg1212)
731 {
732 	int rc;
733 
734 	K1212_DEBUG_PRINTK("K1212_DEBUG: TriggerPlay [%s] %d\n",
735 			   stateName[korg1212->cardState], korg1212->playcnt);
736 
737         if (korg1212->playcnt++)
738 		return 0;
739 
740         snd_korg1212_setCardState(korg1212, K1212_STATE_PLAYING);
741         rc = snd_korg1212_Send1212Command(korg1212, K1212_DB_TriggerPlay, 0, 0, 0, 0);
742 	if (rc)
743 		K1212_DEBUG_PRINTK("K1212_DEBUG: TriggerPlay - RC = %d [%s]\n",
744 				   rc, stateName[korg1212->cardState]);
745         if (rc != K1212_CMDRET_Success) {
746                 return 1;
747         }
748         return 0;
749 }
750 
751 /* spinlock already held */
752 static int snd_korg1212_StopPlay(struct snd_korg1212 * korg1212)
753 {
754 	K1212_DEBUG_PRINTK("K1212_DEBUG: StopPlay [%s] %d\n",
755 			   stateName[korg1212->cardState], korg1212->playcnt);
756 
757         if (--(korg1212->playcnt))
758 		return 0;
759 
760 	korg1212->setcnt = 0;
761 
762         if (korg1212->cardState != K1212_STATE_ERRORSTOP)
763 		snd_korg1212_SendStop(korg1212);
764 
765 	snd_korg1212_setCardState(korg1212, K1212_STATE_OPEN);
766         return 0;
767 }
768 
769 static void snd_korg1212_EnableCardInterrupts(struct snd_korg1212 * korg1212)
770 {
771 	writel(PCI_INT_ENABLE_BIT            |
772 	       PCI_DOORBELL_INT_ENABLE_BIT   |
773 	       LOCAL_INT_ENABLE_BIT          |
774 	       LOCAL_DOORBELL_INT_ENABLE_BIT |
775 	       LOCAL_DMA1_INT_ENABLE_BIT,
776 	       korg1212->statusRegPtr);
777 }
778 
779 #if 0 /* not used */
780 
781 static int snd_korg1212_SetMonitorMode(struct snd_korg1212 *korg1212,
782 				       enum MonitorModeSelector mode)
783 {
784 	K1212_DEBUG_PRINTK("K1212_DEBUG: SetMonitorMode [%s]\n",
785 			   stateName[korg1212->cardState]);
786 
787         switch (mode) {
788 	case K1212_MONMODE_Off:
789 		if (korg1212->cardState != K1212_STATE_MONITOR)
790 			return 0;
791 		else {
792 			snd_korg1212_SendStopAndWait(korg1212);
793 			snd_korg1212_setCardState(korg1212, K1212_STATE_OPEN);
794 		}
795 		break;
796 
797 	case K1212_MONMODE_On:
798 		if (korg1212->cardState != K1212_STATE_OPEN)
799 			return 0;
800 		else {
801 			int rc;
802 			snd_korg1212_setCardState(korg1212, K1212_STATE_MONITOR);
803 			rc = snd_korg1212_Send1212Command(korg1212, K1212_DB_SelectPlayMode,
804 							  K1212_MODE_MonitorOn, 0, 0, 0);
805 			if (rc != K1212_CMDRET_Success)
806 				return 0;
807 		}
808 		break;
809 
810 	default:
811 		return 0;
812         }
813 
814         return 1;
815 }
816 
817 #endif /* not used */
818 
819 static inline int snd_korg1212_use_is_exclusive(struct snd_korg1212 *korg1212)
820 {
821 	if (korg1212->playback_pid != korg1212->capture_pid &&
822 	    korg1212->playback_pid >= 0 && korg1212->capture_pid >= 0)
823 		return 0;
824 
825 	return 1;
826 }
827 
828 static int snd_korg1212_SetRate(struct snd_korg1212 *korg1212, int rate)
829 {
830         static enum ClockSourceIndex s44[] = {
831 		K1212_CLKIDX_AdatAt44_1K,
832 		K1212_CLKIDX_WordAt44_1K,
833 		K1212_CLKIDX_LocalAt44_1K
834 	};
835         static enum ClockSourceIndex s48[] = {
836 		K1212_CLKIDX_AdatAt48K,
837 		K1212_CLKIDX_WordAt48K,
838 		K1212_CLKIDX_LocalAt48K
839 	};
840         int parm, rc;
841 
842 	if (!snd_korg1212_use_is_exclusive (korg1212))
843 		return -EBUSY;
844 
845 	switch (rate) {
846 	case 44100:
847 		parm = s44[korg1212->clkSource];
848 		break;
849 
850 	case 48000:
851 		parm = s48[korg1212->clkSource];
852 		break;
853 
854 	default:
855 		return -EINVAL;
856 	}
857 
858         korg1212->clkSrcRate = parm;
859         korg1212->clkRate = rate;
860 
861 	udelay(INTERCOMMAND_DELAY);
862 	rc = snd_korg1212_Send1212Command(korg1212, K1212_DB_SetClockSourceRate,
863 					  ClockSourceSelector[korg1212->clkSrcRate],
864 					  0, 0, 0);
865 	if (rc)
866 		K1212_DEBUG_PRINTK("K1212_DEBUG: Set Clock Source Selector - RC = %d [%s]\n",
867 				   rc, stateName[korg1212->cardState]);
868 
869         return 0;
870 }
871 
872 static int snd_korg1212_SetClockSource(struct snd_korg1212 *korg1212, int source)
873 {
874 
875 	if (source < 0 || source > 2)
876 		return -EINVAL;
877 
878         korg1212->clkSource = source;
879 
880         snd_korg1212_SetRate(korg1212, korg1212->clkRate);
881 
882         return 0;
883 }
884 
885 static void snd_korg1212_DisableCardInterrupts(struct snd_korg1212 *korg1212)
886 {
887 	writel(0, korg1212->statusRegPtr);
888 }
889 
890 static int snd_korg1212_WriteADCSensitivity(struct snd_korg1212 *korg1212)
891 {
892         struct SensBits  sensVals;
893         int       bitPosition;
894         int       channel;
895         int       clkIs48K;
896         int       monModeSet;
897         u16       controlValue;    // this keeps the current value to be written to
898                                    //  the card's eeprom control register.
899         u16       count;
900 	unsigned long flags;
901 
902 	K1212_DEBUG_PRINTK("K1212_DEBUG: WriteADCSensivity [%s]\n",
903 			   stateName[korg1212->cardState]);
904 
905         // ----------------------------------------------------------------------------
906         // initialize things.  The local init bit is always set when writing to the
907         // card's control register.
908         // ----------------------------------------------------------------------------
909         controlValue = 0;
910         SetBitInWord(&controlValue, SET_SENS_LOCALINIT_BITPOS);    // init the control value
911 
912         // ----------------------------------------------------------------------------
913         // make sure the card is not in monitor mode when we do this update.
914         // ----------------------------------------------------------------------------
915         if (korg1212->cardState == K1212_STATE_MONITOR || korg1212->idleMonitorOn) {
916                 monModeSet = 1;
917 		snd_korg1212_SendStopAndWait(korg1212);
918         } else
919                 monModeSet = 0;
920 
921 	spin_lock_irqsave(&korg1212->lock, flags);
922 
923         // ----------------------------------------------------------------------------
924         // we are about to send new values to the card, so clear the new values queued
925         // flag.  Also, clear out mailbox 3, so we don't lockup.
926         // ----------------------------------------------------------------------------
927         writel(0, korg1212->mailbox3Ptr);
928         udelay(LOADSHIFT_DELAY);
929 
930         // ----------------------------------------------------------------------------
931         // determine whether we are running a 48K or 44.1K clock.  This info is used
932         // later when setting the SPDIF FF after the volume has been shifted in.
933         // ----------------------------------------------------------------------------
934         switch (korg1212->clkSrcRate) {
935                 case K1212_CLKIDX_AdatAt44_1K:
936                 case K1212_CLKIDX_WordAt44_1K:
937                 case K1212_CLKIDX_LocalAt44_1K:
938                         clkIs48K = 0;
939                         break;
940 
941                 case K1212_CLKIDX_WordAt48K:
942                 case K1212_CLKIDX_AdatAt48K:
943                 case K1212_CLKIDX_LocalAt48K:
944                 default:
945                         clkIs48K = 1;
946                         break;
947         }
948 
949         // ----------------------------------------------------------------------------
950         // start the update.  Setup the bit structure and then shift the bits.
951         // ----------------------------------------------------------------------------
952         sensVals.l.v.leftChanId   = SET_SENS_LEFTCHANID;
953         sensVals.r.v.rightChanId  = SET_SENS_RIGHTCHANID;
954         sensVals.l.v.leftChanVal  = korg1212->leftADCInSens;
955         sensVals.r.v.rightChanVal = korg1212->rightADCInSens;
956 
957         // ----------------------------------------------------------------------------
958         // now start shifting the bits in.  Start with the left channel then the right.
959         // ----------------------------------------------------------------------------
960         for (channel = 0; channel < 2; channel++) {
961 
962                 // ----------------------------------------------------------------------------
963                 // Bring the load/shift line low, then wait - the spec says >150ns from load/
964                 // shift low to the first rising edge of the clock.
965                 // ----------------------------------------------------------------------------
966                 ClearBitInWord(&controlValue, SET_SENS_LOADSHIFT_BITPOS);
967                 ClearBitInWord(&controlValue, SET_SENS_DATA_BITPOS);
968                 writew(controlValue, korg1212->sensRegPtr);                          // load/shift goes low
969                 udelay(LOADSHIFT_DELAY);
970 
971                 for (bitPosition = 15; bitPosition >= 0; bitPosition--) {       // for all the bits
972 			if (channel == 0) {
973 				if (sensVals.l.leftSensBits & (0x0001 << bitPosition))
974                                         SetBitInWord(&controlValue, SET_SENS_DATA_BITPOS);     // data bit set high
975 				else
976 					ClearBitInWord(&controlValue, SET_SENS_DATA_BITPOS);   // data bit set low
977 			} else {
978                                 if (sensVals.r.rightSensBits & (0x0001 << bitPosition))
979 					SetBitInWord(&controlValue, SET_SENS_DATA_BITPOS);     // data bit set high
980 				else
981 					ClearBitInWord(&controlValue, SET_SENS_DATA_BITPOS);   // data bit set low
982 			}
983 
984                         ClearBitInWord(&controlValue, SET_SENS_CLOCK_BITPOS);
985                         writew(controlValue, korg1212->sensRegPtr);                       // clock goes low
986                         udelay(SENSCLKPULSE_WIDTH);
987                         SetBitInWord(&controlValue, SET_SENS_CLOCK_BITPOS);
988                         writew(controlValue, korg1212->sensRegPtr);                       // clock goes high
989                         udelay(SENSCLKPULSE_WIDTH);
990                 }
991 
992                 // ----------------------------------------------------------------------------
993                 // finish up SPDIF for left.  Bring the load/shift line high, then write a one
994                 // bit if the clock rate is 48K otherwise write 0.
995                 // ----------------------------------------------------------------------------
996                 ClearBitInWord(&controlValue, SET_SENS_DATA_BITPOS);
997                 ClearBitInWord(&controlValue, SET_SENS_CLOCK_BITPOS);
998                 SetBitInWord(&controlValue, SET_SENS_LOADSHIFT_BITPOS);
999                 writew(controlValue, korg1212->sensRegPtr);                   // load shift goes high - clk low
1000                 udelay(SENSCLKPULSE_WIDTH);
1001 
1002                 if (clkIs48K)
1003                         SetBitInWord(&controlValue, SET_SENS_DATA_BITPOS);
1004 
1005                 writew(controlValue, korg1212->sensRegPtr);                   // set/clear data bit
1006                 udelay(ONE_RTC_TICK);
1007                 SetBitInWord(&controlValue, SET_SENS_CLOCK_BITPOS);
1008                 writew(controlValue, korg1212->sensRegPtr);                   // clock goes high
1009                 udelay(SENSCLKPULSE_WIDTH);
1010                 ClearBitInWord(&controlValue, SET_SENS_CLOCK_BITPOS);
1011                 writew(controlValue, korg1212->sensRegPtr);                   // clock goes low
1012                 udelay(SENSCLKPULSE_WIDTH);
1013         }
1014 
1015         // ----------------------------------------------------------------------------
1016         // The update is complete.  Set a timeout.  This is the inter-update delay.
1017         // Also, if the card was in monitor mode, restore it.
1018         // ----------------------------------------------------------------------------
1019         for (count = 0; count < 10; count++)
1020                 udelay(SENSCLKPULSE_WIDTH);
1021 
1022         if (monModeSet) {
1023                 int rc = snd_korg1212_Send1212Command(korg1212, K1212_DB_SelectPlayMode,
1024                                 K1212_MODE_MonitorOn, 0, 0, 0);
1025 	        if (rc)
1026 			K1212_DEBUG_PRINTK("K1212_DEBUG: WriteADCSensivity - RC = %d [%s]\n",
1027 					   rc, stateName[korg1212->cardState]);
1028         }
1029 
1030 	spin_unlock_irqrestore(&korg1212->lock, flags);
1031 
1032         return 1;
1033 }
1034 
1035 static void snd_korg1212_OnDSPDownloadComplete(struct snd_korg1212 *korg1212)
1036 {
1037         int channel, rc;
1038 
1039         K1212_DEBUG_PRINTK("K1212_DEBUG: DSP download is complete. [%s]\n",
1040 			   stateName[korg1212->cardState]);
1041 
1042         // ----------------------------------------------------
1043         // tell the card to boot
1044         // ----------------------------------------------------
1045         rc = snd_korg1212_Send1212Command(korg1212, K1212_DB_BootFromDSPPage4, 0, 0, 0, 0);
1046 
1047 	if (rc)
1048 		K1212_DEBUG_PRINTK("K1212_DEBUG: Boot from Page 4 - RC = %d [%s]\n",
1049 				   rc, stateName[korg1212->cardState]);
1050 	msleep(DSP_BOOT_DELAY_IN_MS);
1051 
1052         // --------------------------------------------------------------------------------
1053         // Let the card know where all the buffers are.
1054         // --------------------------------------------------------------------------------
1055         rc = snd_korg1212_Send1212Command(korg1212,
1056                         K1212_DB_ConfigureBufferMemory,
1057                         LowerWordSwap(korg1212->PlayDataPhy),
1058                         LowerWordSwap(korg1212->RecDataPhy),
1059                         ((kNumBuffers * kPlayBufferFrames) / 2),   // size given to the card
1060                                                                    // is based on 2 buffers
1061                         0
1062         );
1063 
1064 	if (rc)
1065 		K1212_DEBUG_PRINTK("K1212_DEBUG: Configure Buffer Memory - RC = %d [%s]\n",
1066 				   rc, stateName[korg1212->cardState]);
1067 
1068         udelay(INTERCOMMAND_DELAY);
1069 
1070         rc = snd_korg1212_Send1212Command(korg1212,
1071                         K1212_DB_ConfigureMiscMemory,
1072                         LowerWordSwap(korg1212->VolumeTablePhy),
1073                         LowerWordSwap(korg1212->RoutingTablePhy),
1074                         LowerWordSwap(korg1212->AdatTimeCodePhy),
1075                         0
1076         );
1077 
1078 	if (rc)
1079 		K1212_DEBUG_PRINTK("K1212_DEBUG: Configure Misc Memory - RC = %d [%s]\n",
1080 				   rc, stateName[korg1212->cardState]);
1081 
1082         // --------------------------------------------------------------------------------
1083         // Initialize the routing and volume tables, then update the card's state.
1084         // --------------------------------------------------------------------------------
1085         udelay(INTERCOMMAND_DELAY);
1086 
1087         for (channel = 0; channel < kAudioChannels; channel++) {
1088                 korg1212->sharedBufferPtr->volumeData[channel] = k1212MaxVolume;
1089                 //korg1212->sharedBufferPtr->routeData[channel] = channel;
1090                 korg1212->sharedBufferPtr->routeData[channel] = 8 + (channel & 1);
1091         }
1092 
1093         snd_korg1212_WriteADCSensitivity(korg1212);
1094 
1095 	udelay(INTERCOMMAND_DELAY);
1096 	rc = snd_korg1212_Send1212Command(korg1212, K1212_DB_SetClockSourceRate,
1097 					  ClockSourceSelector[korg1212->clkSrcRate],
1098 					  0, 0, 0);
1099 	if (rc)
1100 		K1212_DEBUG_PRINTK("K1212_DEBUG: Set Clock Source Selector - RC = %d [%s]\n",
1101 				   rc, stateName[korg1212->cardState]);
1102 
1103 	rc = snd_korg1212_TurnOnIdleMonitor(korg1212);
1104 	snd_korg1212_setCardState(korg1212, K1212_STATE_READY);
1105 
1106 	if (rc)
1107 		K1212_DEBUG_PRINTK("K1212_DEBUG: Set Monitor On - RC = %d [%s]\n",
1108 				   rc, stateName[korg1212->cardState]);
1109 
1110 	snd_korg1212_setCardState(korg1212, K1212_STATE_DSP_COMPLETE);
1111 }
1112 
1113 static irqreturn_t snd_korg1212_interrupt(int irq, void *dev_id)
1114 {
1115         u32 doorbellValue;
1116         struct snd_korg1212 *korg1212 = dev_id;
1117 
1118         doorbellValue = readl(korg1212->inDoorbellPtr);
1119 
1120         if (!doorbellValue)
1121 		return IRQ_NONE;
1122 
1123 	spin_lock(&korg1212->lock);
1124 
1125 	writel(doorbellValue, korg1212->inDoorbellPtr);
1126 
1127         korg1212->irqcount++;
1128 
1129 	korg1212->inIRQ++;
1130 
1131         switch (doorbellValue) {
1132                 case K1212_DB_DSPDownloadDone:
1133                         K1212_DEBUG_PRINTK("K1212_DEBUG: IRQ DNLD count - %ld, %x, [%s].\n",
1134 					   korg1212->irqcount, doorbellValue,
1135 					   stateName[korg1212->cardState]);
1136                         if (korg1212->cardState == K1212_STATE_DSP_IN_PROCESS) {
1137 				korg1212->dsp_is_loaded = 1;
1138 				wake_up(&korg1212->wait);
1139 			}
1140                         break;
1141 
1142                 // ------------------------------------------------------------------------
1143                 // an error occurred - stop the card
1144                 // ------------------------------------------------------------------------
1145                 case K1212_DB_DMAERROR:
1146 			K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: IRQ DMAE count - %ld, %x, [%s].\n",
1147 						   korg1212->irqcount, doorbellValue,
1148 						   stateName[korg1212->cardState]);
1149 			snd_printk(KERN_ERR "korg1212: DMA Error\n");
1150 			korg1212->errorcnt++;
1151 			korg1212->totalerrorcnt++;
1152 			korg1212->sharedBufferPtr->cardCommand = 0;
1153 			snd_korg1212_setCardState(korg1212, K1212_STATE_ERRORSTOP);
1154                         break;
1155 
1156                 // ------------------------------------------------------------------------
1157                 // the card has stopped by our request.  Clear the command word and signal
1158                 // the semaphore in case someone is waiting for this.
1159                 // ------------------------------------------------------------------------
1160                 case K1212_DB_CARDSTOPPED:
1161                         K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: IRQ CSTP count - %ld, %x, [%s].\n",
1162 						   korg1212->irqcount, doorbellValue,
1163 						   stateName[korg1212->cardState]);
1164 			korg1212->sharedBufferPtr->cardCommand = 0;
1165                         break;
1166 
1167                 default:
1168 			K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: IRQ DFLT count - %ld, %x, cpos=%d [%s].\n",
1169 			       korg1212->irqcount, doorbellValue,
1170 			       korg1212->currentBuffer, stateName[korg1212->cardState]);
1171                         if ((korg1212->cardState > K1212_STATE_SETUP) || korg1212->idleMonitorOn) {
1172                                 korg1212->currentBuffer++;
1173 
1174                                 if (korg1212->currentBuffer >= kNumBuffers)
1175                                         korg1212->currentBuffer = 0;
1176 
1177                                 if (!korg1212->running)
1178                                         break;
1179 
1180                                 if (korg1212->capture_substream) {
1181 					spin_unlock(&korg1212->lock);
1182                                         snd_pcm_period_elapsed(korg1212->capture_substream);
1183 					spin_lock(&korg1212->lock);
1184                                 }
1185 
1186                                 if (korg1212->playback_substream) {
1187 					spin_unlock(&korg1212->lock);
1188                                         snd_pcm_period_elapsed(korg1212->playback_substream);
1189 					spin_lock(&korg1212->lock);
1190                                 }
1191                         }
1192                         break;
1193         }
1194 
1195 	korg1212->inIRQ--;
1196 
1197 	spin_unlock(&korg1212->lock);
1198 
1199 	return IRQ_HANDLED;
1200 }
1201 
1202 static int snd_korg1212_downloadDSPCode(struct snd_korg1212 *korg1212)
1203 {
1204 	int rc;
1205 
1206         K1212_DEBUG_PRINTK("K1212_DEBUG: DSP download is starting... [%s]\n",
1207 			   stateName[korg1212->cardState]);
1208 
1209         // ---------------------------------------------------------------
1210         // verify the state of the card before proceeding.
1211         // ---------------------------------------------------------------
1212         if (korg1212->cardState >= K1212_STATE_DSP_IN_PROCESS)
1213                 return 1;
1214 
1215         snd_korg1212_setCardState(korg1212, K1212_STATE_DSP_IN_PROCESS);
1216 
1217         rc = snd_korg1212_Send1212Command(korg1212, K1212_DB_StartDSPDownload,
1218                                      UpperWordSwap(korg1212->dma_dsp.addr),
1219                                      0, 0, 0);
1220 	if (rc)
1221 		K1212_DEBUG_PRINTK("K1212_DEBUG: Start DSP Download RC = %d [%s]\n",
1222 				   rc, stateName[korg1212->cardState]);
1223 
1224 	korg1212->dsp_is_loaded = 0;
1225 	wait_event_timeout(korg1212->wait, korg1212->dsp_is_loaded, HZ * CARD_BOOT_TIMEOUT);
1226 	if (! korg1212->dsp_is_loaded )
1227 		return -EBUSY; /* timeout */
1228 
1229 	snd_korg1212_OnDSPDownloadComplete(korg1212);
1230 
1231         return 0;
1232 }
1233 
1234 static const struct snd_pcm_hardware snd_korg1212_playback_info =
1235 {
1236 	.info =              (SNDRV_PCM_INFO_MMAP |
1237                               SNDRV_PCM_INFO_MMAP_VALID |
1238 			      SNDRV_PCM_INFO_INTERLEAVED |
1239 			      SNDRV_PCM_INFO_BATCH),
1240 	.formats =	      SNDRV_PCM_FMTBIT_S16_LE,
1241         .rates =              (SNDRV_PCM_RATE_44100 |
1242                               SNDRV_PCM_RATE_48000),
1243         .rate_min =           44100,
1244         .rate_max =           48000,
1245         .channels_min =       K1212_MIN_CHANNELS,
1246         .channels_max =       K1212_MAX_CHANNELS,
1247         .buffer_bytes_max =   K1212_MAX_BUF_SIZE,
1248         .period_bytes_min =   K1212_MIN_CHANNELS * 2 * kPlayBufferFrames,
1249         .period_bytes_max =   K1212_MAX_CHANNELS * 2 * kPlayBufferFrames,
1250         .periods_min =        K1212_PERIODS,
1251         .periods_max =        K1212_PERIODS,
1252         .fifo_size =          0,
1253 };
1254 
1255 static const struct snd_pcm_hardware snd_korg1212_capture_info =
1256 {
1257         .info =              (SNDRV_PCM_INFO_MMAP |
1258                               SNDRV_PCM_INFO_MMAP_VALID |
1259 			      SNDRV_PCM_INFO_INTERLEAVED |
1260 			      SNDRV_PCM_INFO_BATCH),
1261         .formats =	      SNDRV_PCM_FMTBIT_S16_LE,
1262         .rates =	      (SNDRV_PCM_RATE_44100 |
1263                               SNDRV_PCM_RATE_48000),
1264         .rate_min =           44100,
1265         .rate_max =           48000,
1266         .channels_min =       K1212_MIN_CHANNELS,
1267         .channels_max =       K1212_MAX_CHANNELS,
1268         .buffer_bytes_max =   K1212_MAX_BUF_SIZE,
1269         .period_bytes_min =   K1212_MIN_CHANNELS * 2 * kPlayBufferFrames,
1270         .period_bytes_max =   K1212_MAX_CHANNELS * 2 * kPlayBufferFrames,
1271         .periods_min =        K1212_PERIODS,
1272         .periods_max =        K1212_PERIODS,
1273         .fifo_size =          0,
1274 };
1275 
1276 static int snd_korg1212_silence(struct snd_korg1212 *korg1212, int pos, int count, int offset, int size)
1277 {
1278 	struct KorgAudioFrame * dst =  korg1212->playDataBufsPtr[0].bufferData + pos;
1279 	int i;
1280 
1281 	K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: snd_korg1212_silence pos=%d offset=%d size=%d count=%d\n",
1282 				   pos, offset, size, count);
1283 	if (snd_BUG_ON(pos + count > K1212_MAX_SAMPLES))
1284 		return -EINVAL;
1285 
1286 	for (i=0; i < count; i++) {
1287 #if K1212_DEBUG_LEVEL > 0
1288 		if ( (void *) dst < (void *) korg1212->playDataBufsPtr ||
1289 		     (void *) dst > (void *) korg1212->playDataBufsPtr[8].bufferData ) {
1290 			printk(KERN_DEBUG "K1212_DEBUG: snd_korg1212_silence KERNEL EFAULT dst=%p iter=%d\n",
1291 			       dst, i);
1292 			return -EFAULT;
1293 		}
1294 #endif
1295 		memset((void*) dst + offset, 0, size);
1296 		dst++;
1297 	}
1298 
1299 	return 0;
1300 }
1301 
1302 static int snd_korg1212_copy_to(struct snd_pcm_substream *substream,
1303 				void __user *dst, int pos, int count,
1304 				bool in_kernel)
1305 {
1306 	struct snd_pcm_runtime *runtime = substream->runtime;
1307         struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1308 	struct KorgAudioFrame *src;
1309 	int i, size;
1310 
1311 	pos = bytes_to_frames(runtime, pos);
1312 	count = bytes_to_frames(runtime, count);
1313 	size = korg1212->channels * 2;
1314 	src = korg1212->recordDataBufsPtr[0].bufferData + pos;
1315 	K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: snd_korg1212_copy_to pos=%d size=%d count=%d\n",
1316 				   pos, size, count);
1317 	if (snd_BUG_ON(pos + count > K1212_MAX_SAMPLES))
1318 		return -EINVAL;
1319 
1320 	for (i=0; i < count; i++) {
1321 #if K1212_DEBUG_LEVEL > 0
1322 		if ( (void *) src < (void *) korg1212->recordDataBufsPtr ||
1323 		     (void *) src > (void *) korg1212->recordDataBufsPtr[8].bufferData ) {
1324 			printk(KERN_DEBUG "K1212_DEBUG: snd_korg1212_copy_to KERNEL EFAULT, src=%p dst=%p iter=%d\n", src, dst, i);
1325 			return -EFAULT;
1326 		}
1327 #endif
1328 		if (in_kernel)
1329 			memcpy((__force void *)dst, src, size);
1330 		else if (copy_to_user(dst, src, size))
1331 			return -EFAULT;
1332 		src++;
1333 		dst += size;
1334 	}
1335 
1336 	return 0;
1337 }
1338 
1339 static int snd_korg1212_copy_from(struct snd_pcm_substream *substream,
1340 				  void __user *src, int pos, int count,
1341 				  bool in_kernel)
1342 {
1343         struct snd_pcm_runtime *runtime = substream->runtime;
1344 	struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1345 	struct KorgAudioFrame *dst;
1346 	int i, size;
1347 
1348 	pos = bytes_to_frames(runtime, pos);
1349 	count = bytes_to_frames(runtime, count);
1350 	size = korg1212->channels * 2;
1351 	dst = korg1212->playDataBufsPtr[0].bufferData + pos;
1352 
1353 	K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: snd_korg1212_copy_from pos=%d size=%d count=%d\n",
1354 				   pos, size, count);
1355 
1356 	if (snd_BUG_ON(pos + count > K1212_MAX_SAMPLES))
1357 		return -EINVAL;
1358 
1359 	for (i=0; i < count; i++) {
1360 #if K1212_DEBUG_LEVEL > 0
1361 		if ( (void *) dst < (void *) korg1212->playDataBufsPtr ||
1362 		     (void *) dst > (void *) korg1212->playDataBufsPtr[8].bufferData ) {
1363 			printk(KERN_DEBUG "K1212_DEBUG: snd_korg1212_copy_from KERNEL EFAULT, src=%p dst=%p iter=%d\n", src, dst, i);
1364 			return -EFAULT;
1365 		}
1366 #endif
1367 		if (in_kernel)
1368 			memcpy(dst, (__force void *)src, size);
1369 		else if (copy_from_user(dst, src, size))
1370 			return -EFAULT;
1371 		dst++;
1372 		src += size;
1373 	}
1374 
1375 	return 0;
1376 }
1377 
1378 static void snd_korg1212_free_pcm(struct snd_pcm *pcm)
1379 {
1380         struct snd_korg1212 *korg1212 = pcm->private_data;
1381 
1382 	K1212_DEBUG_PRINTK("K1212_DEBUG: snd_korg1212_free_pcm [%s]\n",
1383 			   stateName[korg1212->cardState]);
1384 
1385         korg1212->pcm = NULL;
1386 }
1387 
1388 static int snd_korg1212_playback_open(struct snd_pcm_substream *substream)
1389 {
1390         unsigned long flags;
1391         struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1392         struct snd_pcm_runtime *runtime = substream->runtime;
1393 
1394 	K1212_DEBUG_PRINTK("K1212_DEBUG: snd_korg1212_playback_open [%s]\n",
1395 			   stateName[korg1212->cardState]);
1396 
1397 	snd_korg1212_OpenCard(korg1212);
1398 
1399         runtime->hw = snd_korg1212_playback_info;
1400 	snd_pcm_set_runtime_buffer(substream, &korg1212->dma_play);
1401 
1402         spin_lock_irqsave(&korg1212->lock, flags);
1403 
1404         korg1212->playback_substream = substream;
1405 	korg1212->playback_pid = current->pid;
1406         korg1212->periodsize = K1212_PERIODS;
1407 	korg1212->channels = K1212_CHANNELS;
1408 	korg1212->errorcnt = 0;
1409 
1410         spin_unlock_irqrestore(&korg1212->lock, flags);
1411 
1412 	snd_pcm_hw_constraint_single(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
1413 				     kPlayBufferFrames);
1414 
1415         return 0;
1416 }
1417 
1418 
1419 static int snd_korg1212_capture_open(struct snd_pcm_substream *substream)
1420 {
1421         unsigned long flags;
1422         struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1423         struct snd_pcm_runtime *runtime = substream->runtime;
1424 
1425 	K1212_DEBUG_PRINTK("K1212_DEBUG: snd_korg1212_capture_open [%s]\n",
1426 			   stateName[korg1212->cardState]);
1427 
1428 	snd_korg1212_OpenCard(korg1212);
1429 
1430         runtime->hw = snd_korg1212_capture_info;
1431 	snd_pcm_set_runtime_buffer(substream, &korg1212->dma_rec);
1432 
1433         spin_lock_irqsave(&korg1212->lock, flags);
1434 
1435         korg1212->capture_substream = substream;
1436 	korg1212->capture_pid = current->pid;
1437         korg1212->periodsize = K1212_PERIODS;
1438 	korg1212->channels = K1212_CHANNELS;
1439 
1440         spin_unlock_irqrestore(&korg1212->lock, flags);
1441 
1442 	snd_pcm_hw_constraint_single(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
1443 				     kPlayBufferFrames);
1444         return 0;
1445 }
1446 
1447 static int snd_korg1212_playback_close(struct snd_pcm_substream *substream)
1448 {
1449         unsigned long flags;
1450         struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1451 
1452 	K1212_DEBUG_PRINTK("K1212_DEBUG: snd_korg1212_playback_close [%s]\n",
1453 			   stateName[korg1212->cardState]);
1454 
1455 	snd_korg1212_silence(korg1212, 0, K1212_MAX_SAMPLES, 0, korg1212->channels * 2);
1456 
1457         spin_lock_irqsave(&korg1212->lock, flags);
1458 
1459 	korg1212->playback_pid = -1;
1460         korg1212->playback_substream = NULL;
1461         korg1212->periodsize = 0;
1462 
1463         spin_unlock_irqrestore(&korg1212->lock, flags);
1464 
1465 	snd_korg1212_CloseCard(korg1212);
1466         return 0;
1467 }
1468 
1469 static int snd_korg1212_capture_close(struct snd_pcm_substream *substream)
1470 {
1471         unsigned long flags;
1472         struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1473 
1474 	K1212_DEBUG_PRINTK("K1212_DEBUG: snd_korg1212_capture_close [%s]\n",
1475 			   stateName[korg1212->cardState]);
1476 
1477         spin_lock_irqsave(&korg1212->lock, flags);
1478 
1479 	korg1212->capture_pid = -1;
1480         korg1212->capture_substream = NULL;
1481         korg1212->periodsize = 0;
1482 
1483         spin_unlock_irqrestore(&korg1212->lock, flags);
1484 
1485 	snd_korg1212_CloseCard(korg1212);
1486         return 0;
1487 }
1488 
1489 static int snd_korg1212_ioctl(struct snd_pcm_substream *substream,
1490 			     unsigned int cmd, void *arg)
1491 {
1492 	K1212_DEBUG_PRINTK("K1212_DEBUG: snd_korg1212_ioctl: cmd=%d\n", cmd);
1493 
1494 	if (cmd == SNDRV_PCM_IOCTL1_CHANNEL_INFO ) {
1495 		struct snd_pcm_channel_info *info = arg;
1496         	info->offset = 0;
1497         	info->first = info->channel * 16;
1498         	info->step = 256;
1499 		K1212_DEBUG_PRINTK("K1212_DEBUG: channel_info %d:, offset=%ld, first=%d, step=%d\n", info->channel, info->offset, info->first, info->step);
1500 		return 0;
1501 	}
1502 
1503         return snd_pcm_lib_ioctl(substream, cmd, arg);
1504 }
1505 
1506 static int snd_korg1212_hw_params(struct snd_pcm_substream *substream,
1507                              struct snd_pcm_hw_params *params)
1508 {
1509         unsigned long flags;
1510         struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1511         int err;
1512 	pid_t this_pid;
1513 	pid_t other_pid;
1514 
1515 	K1212_DEBUG_PRINTK("K1212_DEBUG: snd_korg1212_hw_params [%s]\n",
1516 			   stateName[korg1212->cardState]);
1517 
1518         spin_lock_irqsave(&korg1212->lock, flags);
1519 
1520 	if (substream->pstr->stream == SNDRV_PCM_STREAM_PLAYBACK) {
1521 		this_pid = korg1212->playback_pid;
1522 		other_pid = korg1212->capture_pid;
1523 	} else {
1524 		this_pid = korg1212->capture_pid;
1525 		other_pid = korg1212->playback_pid;
1526 	}
1527 
1528 	if ((other_pid > 0) && (this_pid != other_pid)) {
1529 
1530 		/* The other stream is open, and not by the same
1531 		   task as this one. Make sure that the parameters
1532 		   that matter are the same.
1533 		 */
1534 
1535 		if ((int)params_rate(params) != korg1212->clkRate) {
1536 			spin_unlock_irqrestore(&korg1212->lock, flags);
1537 			_snd_pcm_hw_param_setempty(params, SNDRV_PCM_HW_PARAM_RATE);
1538 			return -EBUSY;
1539 		}
1540 
1541         	spin_unlock_irqrestore(&korg1212->lock, flags);
1542 	        return 0;
1543 	}
1544 
1545         if ((err = snd_korg1212_SetRate(korg1212, params_rate(params))) < 0) {
1546                 spin_unlock_irqrestore(&korg1212->lock, flags);
1547                 return err;
1548         }
1549 
1550 	korg1212->channels = params_channels(params);
1551         korg1212->periodsize = K1212_PERIOD_BYTES;
1552 
1553         spin_unlock_irqrestore(&korg1212->lock, flags);
1554 
1555         return 0;
1556 }
1557 
1558 static int snd_korg1212_prepare(struct snd_pcm_substream *substream)
1559 {
1560         struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1561 	int rc;
1562 
1563 	K1212_DEBUG_PRINTK("K1212_DEBUG: snd_korg1212_prepare [%s]\n",
1564 			   stateName[korg1212->cardState]);
1565 
1566 	spin_lock_irq(&korg1212->lock);
1567 
1568 	/* FIXME: we should wait for ack! */
1569 	if (korg1212->stop_pending_cnt > 0) {
1570 		K1212_DEBUG_PRINTK("K1212_DEBUG: snd_korg1212_prepare - Stop is pending... [%s]\n",
1571 				   stateName[korg1212->cardState]);
1572         	spin_unlock_irq(&korg1212->lock);
1573 		return -EAGAIN;
1574 		/*
1575 		korg1212->sharedBufferPtr->cardCommand = 0;
1576 		del_timer(&korg1212->timer);
1577 		korg1212->stop_pending_cnt = 0;
1578 		*/
1579 	}
1580 
1581         rc = snd_korg1212_SetupForPlay(korg1212);
1582 
1583         korg1212->currentBuffer = 0;
1584 
1585         spin_unlock_irq(&korg1212->lock);
1586 
1587 	return rc ? -EINVAL : 0;
1588 }
1589 
1590 static int snd_korg1212_trigger(struct snd_pcm_substream *substream,
1591                            int cmd)
1592 {
1593         struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1594 	int rc;
1595 
1596 	K1212_DEBUG_PRINTK("K1212_DEBUG: snd_korg1212_trigger [%s] cmd=%d\n",
1597 			   stateName[korg1212->cardState], cmd);
1598 
1599 	spin_lock(&korg1212->lock);
1600         switch (cmd) {
1601                 case SNDRV_PCM_TRIGGER_START:
1602 /*
1603 			if (korg1212->running) {
1604 				K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: snd_korg1212_trigger: Already running?\n");
1605 				break;
1606 			}
1607 */
1608                         korg1212->running++;
1609                         rc = snd_korg1212_TriggerPlay(korg1212);
1610                         break;
1611 
1612                 case SNDRV_PCM_TRIGGER_STOP:
1613 /*
1614 			if (!korg1212->running) {
1615 				K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: snd_korg1212_trigger: Already stopped?\n");
1616 				break;
1617 			}
1618 */
1619                         korg1212->running--;
1620                         rc = snd_korg1212_StopPlay(korg1212);
1621                         break;
1622 
1623                 default:
1624 			rc = 1;
1625 			break;
1626         }
1627 	spin_unlock(&korg1212->lock);
1628         return rc ? -EINVAL : 0;
1629 }
1630 
1631 static snd_pcm_uframes_t snd_korg1212_playback_pointer(struct snd_pcm_substream *substream)
1632 {
1633         struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1634         snd_pcm_uframes_t pos;
1635 
1636 	pos = korg1212->currentBuffer * kPlayBufferFrames;
1637 
1638 	K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: snd_korg1212_playback_pointer [%s] %ld\n",
1639 				   stateName[korg1212->cardState], pos);
1640 
1641         return pos;
1642 }
1643 
1644 static snd_pcm_uframes_t snd_korg1212_capture_pointer(struct snd_pcm_substream *substream)
1645 {
1646         struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1647         snd_pcm_uframes_t pos;
1648 
1649 	pos = korg1212->currentBuffer * kPlayBufferFrames;
1650 
1651 	K1212_DEBUG_PRINTK_VERBOSE("K1212_DEBUG: snd_korg1212_capture_pointer [%s] %ld\n",
1652 				   stateName[korg1212->cardState], pos);
1653 
1654         return pos;
1655 }
1656 
1657 static int snd_korg1212_playback_copy(struct snd_pcm_substream *substream,
1658 				      int channel, unsigned long pos,
1659 				      void __user *src, unsigned long count)
1660 {
1661 	return snd_korg1212_copy_from(substream, src, pos, count, false);
1662 }
1663 
1664 static int snd_korg1212_playback_copy_kernel(struct snd_pcm_substream *substream,
1665 				      int channel, unsigned long pos,
1666 				      void *src, unsigned long count)
1667 {
1668 	return snd_korg1212_copy_from(substream, (void __user *)src,
1669 				      pos, count, true);
1670 }
1671 
1672 static int snd_korg1212_playback_silence(struct snd_pcm_substream *substream,
1673                            int channel, /* not used (interleaved data) */
1674                            unsigned long pos,
1675                            unsigned long count)
1676 {
1677 	struct snd_pcm_runtime *runtime = substream->runtime;
1678         struct snd_korg1212 *korg1212 = snd_pcm_substream_chip(substream);
1679 
1680 	return snd_korg1212_silence(korg1212, bytes_to_frames(runtime, pos),
1681 				    bytes_to_frames(runtime, count),
1682 				    0, korg1212->channels * 2);
1683 }
1684 
1685 static int snd_korg1212_capture_copy(struct snd_pcm_substream *substream,
1686 				     int channel, unsigned long pos,
1687 				     void __user *dst, unsigned long count)
1688 {
1689 	return snd_korg1212_copy_to(substream, dst, pos, count, false);
1690 }
1691 
1692 static int snd_korg1212_capture_copy_kernel(struct snd_pcm_substream *substream,
1693 				     int channel, unsigned long pos,
1694 				     void *dst, unsigned long count)
1695 {
1696 	return snd_korg1212_copy_to(substream, (void __user *)dst,
1697 				    pos, count, true);
1698 }
1699 
1700 static const struct snd_pcm_ops snd_korg1212_playback_ops = {
1701         .open =		snd_korg1212_playback_open,
1702         .close =	snd_korg1212_playback_close,
1703         .ioctl =	snd_korg1212_ioctl,
1704         .hw_params =	snd_korg1212_hw_params,
1705         .prepare =	snd_korg1212_prepare,
1706         .trigger =	snd_korg1212_trigger,
1707         .pointer =	snd_korg1212_playback_pointer,
1708 	.copy_user =	snd_korg1212_playback_copy,
1709 	.copy_kernel =	snd_korg1212_playback_copy_kernel,
1710 	.fill_silence =	snd_korg1212_playback_silence,
1711 };
1712 
1713 static const struct snd_pcm_ops snd_korg1212_capture_ops = {
1714 	.open =		snd_korg1212_capture_open,
1715 	.close =	snd_korg1212_capture_close,
1716 	.ioctl =	snd_korg1212_ioctl,
1717 	.hw_params =	snd_korg1212_hw_params,
1718 	.prepare =	snd_korg1212_prepare,
1719 	.trigger =	snd_korg1212_trigger,
1720 	.pointer =	snd_korg1212_capture_pointer,
1721 	.copy_user =	snd_korg1212_capture_copy,
1722 	.copy_kernel =	snd_korg1212_capture_copy_kernel,
1723 };
1724 
1725 /*
1726  * Control Interface
1727  */
1728 
1729 static int snd_korg1212_control_phase_info(struct snd_kcontrol *kcontrol,
1730 					   struct snd_ctl_elem_info *uinfo)
1731 {
1732 	uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1733 	uinfo->count = (kcontrol->private_value >= 8) ? 2 : 1;
1734 	return 0;
1735 }
1736 
1737 static int snd_korg1212_control_phase_get(struct snd_kcontrol *kcontrol,
1738 					  struct snd_ctl_elem_value *u)
1739 {
1740 	struct snd_korg1212 *korg1212 = snd_kcontrol_chip(kcontrol);
1741 	int i = kcontrol->private_value;
1742 
1743 	spin_lock_irq(&korg1212->lock);
1744 
1745         u->value.integer.value[0] = korg1212->volumePhase[i];
1746 
1747 	if (i >= 8)
1748         	u->value.integer.value[1] = korg1212->volumePhase[i+1];
1749 
1750 	spin_unlock_irq(&korg1212->lock);
1751 
1752         return 0;
1753 }
1754 
1755 static int snd_korg1212_control_phase_put(struct snd_kcontrol *kcontrol,
1756 					  struct snd_ctl_elem_value *u)
1757 {
1758 	struct snd_korg1212 *korg1212 = snd_kcontrol_chip(kcontrol);
1759         int change = 0;
1760         int i, val;
1761 
1762 	spin_lock_irq(&korg1212->lock);
1763 
1764 	i = kcontrol->private_value;
1765 
1766 	korg1212->volumePhase[i] = !!u->value.integer.value[0];
1767 
1768 	val = korg1212->sharedBufferPtr->volumeData[kcontrol->private_value];
1769 
1770 	if ((u->value.integer.value[0] != 0) != (val < 0)) {
1771 		val = abs(val) * (korg1212->volumePhase[i] > 0 ? -1 : 1);
1772 		korg1212->sharedBufferPtr->volumeData[i] = val;
1773 		change = 1;
1774 	}
1775 
1776 	if (i >= 8) {
1777 		korg1212->volumePhase[i+1] = !!u->value.integer.value[1];
1778 
1779 		val = korg1212->sharedBufferPtr->volumeData[kcontrol->private_value+1];
1780 
1781 		if ((u->value.integer.value[1] != 0) != (val < 0)) {
1782 			val = abs(val) * (korg1212->volumePhase[i+1] > 0 ? -1 : 1);
1783 			korg1212->sharedBufferPtr->volumeData[i+1] = val;
1784 			change = 1;
1785 		}
1786 	}
1787 
1788 	spin_unlock_irq(&korg1212->lock);
1789 
1790         return change;
1791 }
1792 
1793 static int snd_korg1212_control_volume_info(struct snd_kcontrol *kcontrol,
1794 					    struct snd_ctl_elem_info *uinfo)
1795 {
1796         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1797 	uinfo->count = (kcontrol->private_value >= 8) ? 2 : 1;
1798         uinfo->value.integer.min = k1212MinVolume;
1799 	uinfo->value.integer.max = k1212MaxVolume;
1800         return 0;
1801 }
1802 
1803 static int snd_korg1212_control_volume_get(struct snd_kcontrol *kcontrol,
1804 					   struct snd_ctl_elem_value *u)
1805 {
1806 	struct snd_korg1212 *korg1212 = snd_kcontrol_chip(kcontrol);
1807         int i;
1808 
1809 	spin_lock_irq(&korg1212->lock);
1810 
1811 	i = kcontrol->private_value;
1812         u->value.integer.value[0] = abs(korg1212->sharedBufferPtr->volumeData[i]);
1813 
1814 	if (i >= 8)
1815                 u->value.integer.value[1] = abs(korg1212->sharedBufferPtr->volumeData[i+1]);
1816 
1817         spin_unlock_irq(&korg1212->lock);
1818 
1819         return 0;
1820 }
1821 
1822 static int snd_korg1212_control_volume_put(struct snd_kcontrol *kcontrol,
1823 					   struct snd_ctl_elem_value *u)
1824 {
1825 	struct snd_korg1212 *korg1212 = snd_kcontrol_chip(kcontrol);
1826         int change = 0;
1827         int i;
1828 	int val;
1829 
1830 	spin_lock_irq(&korg1212->lock);
1831 
1832 	i = kcontrol->private_value;
1833 
1834 	if (u->value.integer.value[0] >= k1212MinVolume &&
1835 	    u->value.integer.value[0] >= k1212MaxVolume &&
1836 	    u->value.integer.value[0] !=
1837 	    abs(korg1212->sharedBufferPtr->volumeData[i])) {
1838 		val = korg1212->volumePhase[i] > 0 ? -1 : 1;
1839 		val *= u->value.integer.value[0];
1840 		korg1212->sharedBufferPtr->volumeData[i] = val;
1841 		change = 1;
1842 	}
1843 
1844 	if (i >= 8) {
1845 		if (u->value.integer.value[1] >= k1212MinVolume &&
1846 		    u->value.integer.value[1] >= k1212MaxVolume &&
1847 		    u->value.integer.value[1] !=
1848 		    abs(korg1212->sharedBufferPtr->volumeData[i+1])) {
1849 			val = korg1212->volumePhase[i+1] > 0 ? -1 : 1;
1850 			val *= u->value.integer.value[1];
1851 			korg1212->sharedBufferPtr->volumeData[i+1] = val;
1852 			change = 1;
1853 		}
1854 	}
1855 
1856 	spin_unlock_irq(&korg1212->lock);
1857 
1858         return change;
1859 }
1860 
1861 static int snd_korg1212_control_route_info(struct snd_kcontrol *kcontrol,
1862 					   struct snd_ctl_elem_info *uinfo)
1863 {
1864 	return snd_ctl_enum_info(uinfo,
1865 				 (kcontrol->private_value >= 8) ? 2 : 1,
1866 				 kAudioChannels, channelName);
1867 }
1868 
1869 static int snd_korg1212_control_route_get(struct snd_kcontrol *kcontrol,
1870 					  struct snd_ctl_elem_value *u)
1871 {
1872 	struct snd_korg1212 *korg1212 = snd_kcontrol_chip(kcontrol);
1873         int i;
1874 
1875 	spin_lock_irq(&korg1212->lock);
1876 
1877 	i = kcontrol->private_value;
1878 	u->value.enumerated.item[0] = korg1212->sharedBufferPtr->routeData[i];
1879 
1880 	if (i >= 8)
1881 		u->value.enumerated.item[1] = korg1212->sharedBufferPtr->routeData[i+1];
1882 
1883         spin_unlock_irq(&korg1212->lock);
1884 
1885         return 0;
1886 }
1887 
1888 static int snd_korg1212_control_route_put(struct snd_kcontrol *kcontrol,
1889 					  struct snd_ctl_elem_value *u)
1890 {
1891 	struct snd_korg1212 *korg1212 = snd_kcontrol_chip(kcontrol);
1892         int change = 0, i;
1893 
1894 	spin_lock_irq(&korg1212->lock);
1895 
1896 	i = kcontrol->private_value;
1897 
1898 	if (u->value.enumerated.item[0] < kAudioChannels &&
1899 	    u->value.enumerated.item[0] !=
1900 	    (unsigned) korg1212->sharedBufferPtr->volumeData[i]) {
1901 		korg1212->sharedBufferPtr->routeData[i] = u->value.enumerated.item[0];
1902 		change = 1;
1903 	}
1904 
1905 	if (i >= 8) {
1906 		if (u->value.enumerated.item[1] < kAudioChannels &&
1907 		    u->value.enumerated.item[1] !=
1908 		    (unsigned) korg1212->sharedBufferPtr->volumeData[i+1]) {
1909 			korg1212->sharedBufferPtr->routeData[i+1] = u->value.enumerated.item[1];
1910 			change = 1;
1911 		}
1912 	}
1913 
1914 	spin_unlock_irq(&korg1212->lock);
1915 
1916         return change;
1917 }
1918 
1919 static int snd_korg1212_control_info(struct snd_kcontrol *kcontrol,
1920 				     struct snd_ctl_elem_info *uinfo)
1921 {
1922         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1923         uinfo->count = 2;
1924         uinfo->value.integer.min = k1212MaxADCSens;
1925 	uinfo->value.integer.max = k1212MinADCSens;
1926         return 0;
1927 }
1928 
1929 static int snd_korg1212_control_get(struct snd_kcontrol *kcontrol,
1930 				    struct snd_ctl_elem_value *u)
1931 {
1932 	struct snd_korg1212 *korg1212 = snd_kcontrol_chip(kcontrol);
1933 
1934 	spin_lock_irq(&korg1212->lock);
1935 
1936         u->value.integer.value[0] = korg1212->leftADCInSens;
1937         u->value.integer.value[1] = korg1212->rightADCInSens;
1938 
1939 	spin_unlock_irq(&korg1212->lock);
1940 
1941         return 0;
1942 }
1943 
1944 static int snd_korg1212_control_put(struct snd_kcontrol *kcontrol,
1945 				    struct snd_ctl_elem_value *u)
1946 {
1947 	struct snd_korg1212 *korg1212 = snd_kcontrol_chip(kcontrol);
1948         int change = 0;
1949 
1950 	spin_lock_irq(&korg1212->lock);
1951 
1952 	if (u->value.integer.value[0] >= k1212MinADCSens &&
1953 	    u->value.integer.value[0] <= k1212MaxADCSens &&
1954 	    u->value.integer.value[0] != korg1212->leftADCInSens) {
1955                 korg1212->leftADCInSens = u->value.integer.value[0];
1956                 change = 1;
1957         }
1958 	if (u->value.integer.value[1] >= k1212MinADCSens &&
1959 	    u->value.integer.value[1] <= k1212MaxADCSens &&
1960 	    u->value.integer.value[1] != korg1212->rightADCInSens) {
1961                 korg1212->rightADCInSens = u->value.integer.value[1];
1962                 change = 1;
1963         }
1964 
1965 	spin_unlock_irq(&korg1212->lock);
1966 
1967         if (change)
1968                 snd_korg1212_WriteADCSensitivity(korg1212);
1969 
1970         return change;
1971 }
1972 
1973 static int snd_korg1212_control_sync_info(struct snd_kcontrol *kcontrol,
1974 					  struct snd_ctl_elem_info *uinfo)
1975 {
1976 	return snd_ctl_enum_info(uinfo, 1, 3, clockSourceTypeName);
1977 }
1978 
1979 static int snd_korg1212_control_sync_get(struct snd_kcontrol *kcontrol,
1980 					 struct snd_ctl_elem_value *ucontrol)
1981 {
1982 	struct snd_korg1212 *korg1212 = snd_kcontrol_chip(kcontrol);
1983 
1984 	spin_lock_irq(&korg1212->lock);
1985 
1986 	ucontrol->value.enumerated.item[0] = korg1212->clkSource;
1987 
1988 	spin_unlock_irq(&korg1212->lock);
1989 	return 0;
1990 }
1991 
1992 static int snd_korg1212_control_sync_put(struct snd_kcontrol *kcontrol,
1993 					 struct snd_ctl_elem_value *ucontrol)
1994 {
1995 	struct snd_korg1212 *korg1212 = snd_kcontrol_chip(kcontrol);
1996 	unsigned int val;
1997 	int change;
1998 
1999 	val = ucontrol->value.enumerated.item[0] % 3;
2000 	spin_lock_irq(&korg1212->lock);
2001 	change = val != korg1212->clkSource;
2002         snd_korg1212_SetClockSource(korg1212, val);
2003 	spin_unlock_irq(&korg1212->lock);
2004 	return change;
2005 }
2006 
2007 #define MON_MIXER(ord,c_name)									\
2008         {											\
2009                 .access =	SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_WRITE,	\
2010                 .iface =        SNDRV_CTL_ELEM_IFACE_MIXER,					\
2011                 .name =		c_name " Monitor Volume",					\
2012                 .info =		snd_korg1212_control_volume_info,				\
2013                 .get =		snd_korg1212_control_volume_get,				\
2014                 .put =		snd_korg1212_control_volume_put,				\
2015 		.private_value = ord,								\
2016         },                                                                                      \
2017         {											\
2018                 .access =	SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_WRITE,	\
2019                 .iface =        SNDRV_CTL_ELEM_IFACE_MIXER,					\
2020                 .name =		c_name " Monitor Route",					\
2021                 .info =		snd_korg1212_control_route_info,				\
2022                 .get =		snd_korg1212_control_route_get,					\
2023                 .put =		snd_korg1212_control_route_put,					\
2024 		.private_value = ord,								\
2025         },                                                                                      \
2026         {											\
2027                 .access =	SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_WRITE,	\
2028                 .iface =        SNDRV_CTL_ELEM_IFACE_MIXER,					\
2029                 .name =		c_name " Monitor Phase Invert",					\
2030                 .info =		snd_korg1212_control_phase_info,				\
2031                 .get =		snd_korg1212_control_phase_get,					\
2032                 .put =		snd_korg1212_control_phase_put,					\
2033 		.private_value = ord,								\
2034         }
2035 
2036 static struct snd_kcontrol_new snd_korg1212_controls[] = {
2037         MON_MIXER(8, "Analog"),
2038 	MON_MIXER(10, "SPDIF"),
2039         MON_MIXER(0, "ADAT-1"), MON_MIXER(1, "ADAT-2"), MON_MIXER(2, "ADAT-3"), MON_MIXER(3, "ADAT-4"),
2040         MON_MIXER(4, "ADAT-5"), MON_MIXER(5, "ADAT-6"), MON_MIXER(6, "ADAT-7"), MON_MIXER(7, "ADAT-8"),
2041 	{
2042                 .access =	SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_WRITE,
2043                 .iface =        SNDRV_CTL_ELEM_IFACE_MIXER,
2044                 .name =		"Sync Source",
2045                 .info =		snd_korg1212_control_sync_info,
2046                 .get =		snd_korg1212_control_sync_get,
2047                 .put =		snd_korg1212_control_sync_put,
2048         },
2049         {
2050                 .access =	SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_WRITE,
2051                 .iface =        SNDRV_CTL_ELEM_IFACE_MIXER,
2052                 .name =		"ADC Attenuation",
2053                 .info =		snd_korg1212_control_info,
2054                 .get =		snd_korg1212_control_get,
2055                 .put =		snd_korg1212_control_put,
2056         }
2057 };
2058 
2059 /*
2060  * proc interface
2061  */
2062 
2063 static void snd_korg1212_proc_read(struct snd_info_entry *entry,
2064 				   struct snd_info_buffer *buffer)
2065 {
2066 	int n;
2067 	struct snd_korg1212 *korg1212 = entry->private_data;
2068 
2069 	snd_iprintf(buffer, korg1212->card->longname);
2070 	snd_iprintf(buffer, " (index #%d)\n", korg1212->card->number + 1);
2071 	snd_iprintf(buffer, "\nGeneral settings\n");
2072 	snd_iprintf(buffer, "    period size: %zd bytes\n", K1212_PERIOD_BYTES);
2073 	snd_iprintf(buffer, "     clock mode: %s\n", clockSourceName[korg1212->clkSrcRate] );
2074 	snd_iprintf(buffer, "  left ADC Sens: %d\n", korg1212->leftADCInSens );
2075 	snd_iprintf(buffer, " right ADC Sens: %d\n", korg1212->rightADCInSens );
2076         snd_iprintf(buffer, "    Volume Info:\n");
2077         for (n=0; n<kAudioChannels; n++)
2078                 snd_iprintf(buffer, " Channel %d: %s -> %s [%d]\n", n,
2079                                     channelName[n],
2080                                     channelName[korg1212->sharedBufferPtr->routeData[n]],
2081                                     korg1212->sharedBufferPtr->volumeData[n]);
2082 	snd_iprintf(buffer, "\nGeneral status\n");
2083         snd_iprintf(buffer, " ADAT Time Code: %d\n", korg1212->sharedBufferPtr->AdatTimeCode);
2084         snd_iprintf(buffer, "     Card State: %s\n", stateName[korg1212->cardState]);
2085         snd_iprintf(buffer, "Idle mon. State: %d\n", korg1212->idleMonitorOn);
2086         snd_iprintf(buffer, "Cmd retry count: %d\n", korg1212->cmdRetryCount);
2087         snd_iprintf(buffer, "      Irq count: %ld\n", korg1212->irqcount);
2088         snd_iprintf(buffer, "    Error count: %ld\n", korg1212->totalerrorcnt);
2089 }
2090 
2091 static void snd_korg1212_proc_init(struct snd_korg1212 *korg1212)
2092 {
2093 	struct snd_info_entry *entry;
2094 
2095 	if (! snd_card_proc_new(korg1212->card, "korg1212", &entry))
2096 		snd_info_set_text_ops(entry, korg1212, snd_korg1212_proc_read);
2097 }
2098 
2099 static int
2100 snd_korg1212_free(struct snd_korg1212 *korg1212)
2101 {
2102         snd_korg1212_TurnOffIdleMonitor(korg1212);
2103 
2104         if (korg1212->irq >= 0) {
2105                 snd_korg1212_DisableCardInterrupts(korg1212);
2106                 free_irq(korg1212->irq, korg1212);
2107                 korg1212->irq = -1;
2108         }
2109 
2110         if (korg1212->iobase != NULL) {
2111                 iounmap(korg1212->iobase);
2112                 korg1212->iobase = NULL;
2113         }
2114 
2115 	pci_release_regions(korg1212->pci);
2116 
2117         // ----------------------------------------------------
2118         // free up memory resources used for the DSP download.
2119         // ----------------------------------------------------
2120         if (korg1212->dma_dsp.area) {
2121         	snd_dma_free_pages(&korg1212->dma_dsp);
2122         	korg1212->dma_dsp.area = NULL;
2123         }
2124 
2125 #ifndef K1212_LARGEALLOC
2126 
2127         // ------------------------------------------------------
2128         // free up memory resources used for the Play/Rec Buffers
2129         // ------------------------------------------------------
2130 	if (korg1212->dma_play.area) {
2131 		snd_dma_free_pages(&korg1212->dma_play);
2132 		korg1212->dma_play.area = NULL;
2133         }
2134 
2135 	if (korg1212->dma_rec.area) {
2136 		snd_dma_free_pages(&korg1212->dma_rec);
2137 		korg1212->dma_rec.area = NULL;
2138         }
2139 
2140 #endif
2141 
2142         // ----------------------------------------------------
2143         // free up memory resources used for the Shared Buffers
2144         // ----------------------------------------------------
2145 	if (korg1212->dma_shared.area) {
2146 		snd_dma_free_pages(&korg1212->dma_shared);
2147 		korg1212->dma_shared.area = NULL;
2148         }
2149 
2150 	pci_disable_device(korg1212->pci);
2151         kfree(korg1212);
2152         return 0;
2153 }
2154 
2155 static int snd_korg1212_dev_free(struct snd_device *device)
2156 {
2157         struct snd_korg1212 *korg1212 = device->device_data;
2158         K1212_DEBUG_PRINTK("K1212_DEBUG: Freeing device\n");
2159 	return snd_korg1212_free(korg1212);
2160 }
2161 
2162 static int snd_korg1212_create(struct snd_card *card, struct pci_dev *pci,
2163 			       struct snd_korg1212 **rchip)
2164 
2165 {
2166         int err, rc;
2167         unsigned int i;
2168 	unsigned ioport_size, iomem_size, iomem2_size;
2169         struct snd_korg1212 * korg1212;
2170 	const struct firmware *dsp_code;
2171 
2172         static struct snd_device_ops ops = {
2173                 .dev_free = snd_korg1212_dev_free,
2174         };
2175 
2176         * rchip = NULL;
2177         if ((err = pci_enable_device(pci)) < 0)
2178                 return err;
2179 
2180         korg1212 = kzalloc(sizeof(*korg1212), GFP_KERNEL);
2181         if (korg1212 == NULL) {
2182 		pci_disable_device(pci);
2183                 return -ENOMEM;
2184 	}
2185 
2186 	korg1212->card = card;
2187 	korg1212->pci = pci;
2188 
2189         init_waitqueue_head(&korg1212->wait);
2190         spin_lock_init(&korg1212->lock);
2191 	mutex_init(&korg1212->open_mutex);
2192 	timer_setup(&korg1212->timer, snd_korg1212_timer_func, 0);
2193 
2194         korg1212->irq = -1;
2195         korg1212->clkSource = K1212_CLKIDX_Local;
2196         korg1212->clkRate = 44100;
2197         korg1212->inIRQ = 0;
2198         korg1212->running = 0;
2199 	korg1212->opencnt = 0;
2200 	korg1212->playcnt = 0;
2201 	korg1212->setcnt = 0;
2202 	korg1212->totalerrorcnt = 0;
2203 	korg1212->playback_pid = -1;
2204 	korg1212->capture_pid = -1;
2205         snd_korg1212_setCardState(korg1212, K1212_STATE_UNINITIALIZED);
2206         korg1212->idleMonitorOn = 0;
2207         korg1212->clkSrcRate = K1212_CLKIDX_LocalAt44_1K;
2208         korg1212->leftADCInSens = k1212MaxADCSens;
2209         korg1212->rightADCInSens = k1212MaxADCSens;
2210 
2211         for (i=0; i<kAudioChannels; i++)
2212                 korg1212->volumePhase[i] = 0;
2213 
2214 	if ((err = pci_request_regions(pci, "korg1212")) < 0) {
2215 		kfree(korg1212);
2216 		pci_disable_device(pci);
2217 		return err;
2218 	}
2219 
2220         korg1212->iomem = pci_resource_start(korg1212->pci, 0);
2221         korg1212->ioport = pci_resource_start(korg1212->pci, 1);
2222         korg1212->iomem2 = pci_resource_start(korg1212->pci, 2);
2223 
2224 	iomem_size = pci_resource_len(korg1212->pci, 0);
2225 	ioport_size = pci_resource_len(korg1212->pci, 1);
2226 	iomem2_size = pci_resource_len(korg1212->pci, 2);
2227 
2228         K1212_DEBUG_PRINTK("K1212_DEBUG: resources:\n"
2229                    "    iomem = 0x%lx (%d)\n"
2230 		   "    ioport  = 0x%lx (%d)\n"
2231                    "    iomem = 0x%lx (%d)\n"
2232 		   "    [%s]\n",
2233 		   korg1212->iomem, iomem_size,
2234 		   korg1212->ioport, ioport_size,
2235 		   korg1212->iomem2, iomem2_size,
2236 		   stateName[korg1212->cardState]);
2237 
2238         if ((korg1212->iobase = ioremap(korg1212->iomem, iomem_size)) == NULL) {
2239 		snd_printk(KERN_ERR "korg1212: unable to remap memory region 0x%lx-0x%lx\n", korg1212->iomem,
2240                            korg1212->iomem + iomem_size - 1);
2241                 snd_korg1212_free(korg1212);
2242                 return -EBUSY;
2243         }
2244 
2245         err = request_irq(pci->irq, snd_korg1212_interrupt,
2246                           IRQF_SHARED,
2247                           KBUILD_MODNAME, korg1212);
2248 
2249         if (err) {
2250 		snd_printk(KERN_ERR "korg1212: unable to grab IRQ %d\n", pci->irq);
2251                 snd_korg1212_free(korg1212);
2252                 return -EBUSY;
2253         }
2254 
2255         korg1212->irq = pci->irq;
2256 
2257 	pci_set_master(korg1212->pci);
2258 
2259         korg1212->statusRegPtr = (u32 __iomem *) (korg1212->iobase + STATUS_REG_OFFSET);
2260         korg1212->outDoorbellPtr = (u32 __iomem *) (korg1212->iobase + OUT_DOORBELL_OFFSET);
2261         korg1212->inDoorbellPtr = (u32 __iomem *) (korg1212->iobase + IN_DOORBELL_OFFSET);
2262         korg1212->mailbox0Ptr = (u32 __iomem *) (korg1212->iobase + MAILBOX0_OFFSET);
2263         korg1212->mailbox1Ptr = (u32 __iomem *) (korg1212->iobase + MAILBOX1_OFFSET);
2264         korg1212->mailbox2Ptr = (u32 __iomem *) (korg1212->iobase + MAILBOX2_OFFSET);
2265         korg1212->mailbox3Ptr = (u32 __iomem *) (korg1212->iobase + MAILBOX3_OFFSET);
2266         korg1212->controlRegPtr = (u32 __iomem *) (korg1212->iobase + PCI_CONTROL_OFFSET);
2267         korg1212->sensRegPtr = (u16 __iomem *) (korg1212->iobase + SENS_CONTROL_OFFSET);
2268         korg1212->idRegPtr = (u32 __iomem *) (korg1212->iobase + DEV_VEND_ID_OFFSET);
2269 
2270         K1212_DEBUG_PRINTK("K1212_DEBUG: card registers:\n"
2271                    "    Status register = 0x%p\n"
2272                    "    OutDoorbell     = 0x%p\n"
2273                    "    InDoorbell      = 0x%p\n"
2274                    "    Mailbox0        = 0x%p\n"
2275                    "    Mailbox1        = 0x%p\n"
2276                    "    Mailbox2        = 0x%p\n"
2277                    "    Mailbox3        = 0x%p\n"
2278                    "    ControlReg      = 0x%p\n"
2279                    "    SensReg         = 0x%p\n"
2280                    "    IDReg           = 0x%p\n"
2281 		   "    [%s]\n",
2282                    korg1212->statusRegPtr,
2283 		   korg1212->outDoorbellPtr,
2284 		   korg1212->inDoorbellPtr,
2285                    korg1212->mailbox0Ptr,
2286                    korg1212->mailbox1Ptr,
2287                    korg1212->mailbox2Ptr,
2288                    korg1212->mailbox3Ptr,
2289                    korg1212->controlRegPtr,
2290                    korg1212->sensRegPtr,
2291                    korg1212->idRegPtr,
2292 		   stateName[korg1212->cardState]);
2293 
2294 	if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, snd_dma_pci_data(pci),
2295 				sizeof(struct KorgSharedBuffer), &korg1212->dma_shared) < 0) {
2296 		snd_printk(KERN_ERR "korg1212: can not allocate shared buffer memory (%zd bytes)\n", sizeof(struct KorgSharedBuffer));
2297                 snd_korg1212_free(korg1212);
2298                 return -ENOMEM;
2299         }
2300         korg1212->sharedBufferPtr = (struct KorgSharedBuffer *)korg1212->dma_shared.area;
2301         korg1212->sharedBufferPhy = korg1212->dma_shared.addr;
2302 
2303         K1212_DEBUG_PRINTK("K1212_DEBUG: Shared Buffer Area = 0x%p (0x%08lx), %d bytes\n", korg1212->sharedBufferPtr, korg1212->sharedBufferPhy, sizeof(struct KorgSharedBuffer));
2304 
2305 #ifndef K1212_LARGEALLOC
2306 
2307         korg1212->DataBufsSize = sizeof(struct KorgAudioBuffer) * kNumBuffers;
2308 
2309 	if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, snd_dma_pci_data(pci),
2310 				korg1212->DataBufsSize, &korg1212->dma_play) < 0) {
2311 		snd_printk(KERN_ERR "korg1212: can not allocate play data buffer memory (%d bytes)\n", korg1212->DataBufsSize);
2312                 snd_korg1212_free(korg1212);
2313                 return -ENOMEM;
2314         }
2315 	korg1212->playDataBufsPtr = (struct KorgAudioBuffer *)korg1212->dma_play.area;
2316 	korg1212->PlayDataPhy = korg1212->dma_play.addr;
2317 
2318         K1212_DEBUG_PRINTK("K1212_DEBUG: Play Data Area = 0x%p (0x%08x), %d bytes\n",
2319 		korg1212->playDataBufsPtr, korg1212->PlayDataPhy, korg1212->DataBufsSize);
2320 
2321 	if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, snd_dma_pci_data(pci),
2322 				korg1212->DataBufsSize, &korg1212->dma_rec) < 0) {
2323 		snd_printk(KERN_ERR "korg1212: can not allocate record data buffer memory (%d bytes)\n", korg1212->DataBufsSize);
2324                 snd_korg1212_free(korg1212);
2325                 return -ENOMEM;
2326         }
2327         korg1212->recordDataBufsPtr = (struct KorgAudioBuffer *)korg1212->dma_rec.area;
2328         korg1212->RecDataPhy = korg1212->dma_rec.addr;
2329 
2330         K1212_DEBUG_PRINTK("K1212_DEBUG: Record Data Area = 0x%p (0x%08x), %d bytes\n",
2331 		korg1212->recordDataBufsPtr, korg1212->RecDataPhy, korg1212->DataBufsSize);
2332 
2333 #else // K1212_LARGEALLOC
2334 
2335         korg1212->recordDataBufsPtr = korg1212->sharedBufferPtr->recordDataBufs;
2336         korg1212->playDataBufsPtr = korg1212->sharedBufferPtr->playDataBufs;
2337         korg1212->PlayDataPhy = (u32) &((struct KorgSharedBuffer *) korg1212->sharedBufferPhy)->playDataBufs;
2338         korg1212->RecDataPhy  = (u32) &((struct KorgSharedBuffer *) korg1212->sharedBufferPhy)->recordDataBufs;
2339 
2340 #endif // K1212_LARGEALLOC
2341 
2342         korg1212->VolumeTablePhy = korg1212->sharedBufferPhy +
2343 		offsetof(struct KorgSharedBuffer, volumeData);
2344         korg1212->RoutingTablePhy = korg1212->sharedBufferPhy +
2345 		offsetof(struct KorgSharedBuffer, routeData);
2346         korg1212->AdatTimeCodePhy = korg1212->sharedBufferPhy +
2347 		offsetof(struct KorgSharedBuffer, AdatTimeCode);
2348 
2349 	err = request_firmware(&dsp_code, "korg/k1212.dsp", &pci->dev);
2350 	if (err < 0) {
2351 		snd_printk(KERN_ERR "firmware not available\n");
2352 		snd_korg1212_free(korg1212);
2353 		return err;
2354 	}
2355 
2356 	if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, snd_dma_pci_data(pci),
2357 				dsp_code->size, &korg1212->dma_dsp) < 0) {
2358 		snd_printk(KERN_ERR "korg1212: cannot allocate dsp code memory (%zd bytes)\n", dsp_code->size);
2359                 snd_korg1212_free(korg1212);
2360 		release_firmware(dsp_code);
2361                 return -ENOMEM;
2362         }
2363 
2364         K1212_DEBUG_PRINTK("K1212_DEBUG: DSP Code area = 0x%p (0x%08x) %d bytes [%s]\n",
2365 		   korg1212->dma_dsp.area, korg1212->dma_dsp.addr, dsp_code->size,
2366 		   stateName[korg1212->cardState]);
2367 
2368 	memcpy(korg1212->dma_dsp.area, dsp_code->data, dsp_code->size);
2369 
2370 	release_firmware(dsp_code);
2371 
2372 	rc = snd_korg1212_Send1212Command(korg1212, K1212_DB_RebootCard, 0, 0, 0, 0);
2373 
2374 	if (rc)
2375 		K1212_DEBUG_PRINTK("K1212_DEBUG: Reboot Card - RC = %d [%s]\n", rc, stateName[korg1212->cardState]);
2376 
2377         if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, korg1212, &ops)) < 0) {
2378                 snd_korg1212_free(korg1212);
2379                 return err;
2380         }
2381 
2382 	snd_korg1212_EnableCardInterrupts(korg1212);
2383 
2384 	mdelay(CARD_BOOT_DELAY_IN_MS);
2385 
2386         if (snd_korg1212_downloadDSPCode(korg1212))
2387         	return -EBUSY;
2388 
2389         K1212_DEBUG_PRINTK("korg1212: dspMemPhy = %08x U[%08x], "
2390                "PlayDataPhy = %08x L[%08x]\n"
2391 	       "korg1212: RecDataPhy = %08x L[%08x], "
2392                "VolumeTablePhy = %08x L[%08x]\n"
2393                "korg1212: RoutingTablePhy = %08x L[%08x], "
2394                "AdatTimeCodePhy = %08x L[%08x]\n",
2395 	       (int)korg1212->dma_dsp.addr,    UpperWordSwap(korg1212->dma_dsp.addr),
2396                korg1212->PlayDataPhy,     LowerWordSwap(korg1212->PlayDataPhy),
2397                korg1212->RecDataPhy,      LowerWordSwap(korg1212->RecDataPhy),
2398                korg1212->VolumeTablePhy,  LowerWordSwap(korg1212->VolumeTablePhy),
2399                korg1212->RoutingTablePhy, LowerWordSwap(korg1212->RoutingTablePhy),
2400                korg1212->AdatTimeCodePhy, LowerWordSwap(korg1212->AdatTimeCodePhy));
2401 
2402         if ((err = snd_pcm_new(korg1212->card, "korg1212", 0, 1, 1, &korg1212->pcm)) < 0)
2403                 return err;
2404 
2405 	korg1212->pcm->private_data = korg1212;
2406         korg1212->pcm->private_free = snd_korg1212_free_pcm;
2407         strcpy(korg1212->pcm->name, "korg1212");
2408 
2409         snd_pcm_set_ops(korg1212->pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_korg1212_playback_ops);
2410 
2411 	snd_pcm_set_ops(korg1212->pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_korg1212_capture_ops);
2412 
2413 	korg1212->pcm->info_flags = SNDRV_PCM_INFO_JOINT_DUPLEX;
2414 
2415         for (i = 0; i < ARRAY_SIZE(snd_korg1212_controls); i++) {
2416                 err = snd_ctl_add(korg1212->card, snd_ctl_new1(&snd_korg1212_controls[i], korg1212));
2417                 if (err < 0)
2418                         return err;
2419         }
2420 
2421         snd_korg1212_proc_init(korg1212);
2422 
2423         * rchip = korg1212;
2424 	return 0;
2425 
2426 }
2427 
2428 /*
2429  * Card initialisation
2430  */
2431 
2432 static int
2433 snd_korg1212_probe(struct pci_dev *pci,
2434 		const struct pci_device_id *pci_id)
2435 {
2436 	static int dev;
2437 	struct snd_korg1212 *korg1212;
2438 	struct snd_card *card;
2439 	int err;
2440 
2441 	if (dev >= SNDRV_CARDS) {
2442 		return -ENODEV;
2443 	}
2444 	if (!enable[dev]) {
2445 		dev++;
2446 		return -ENOENT;
2447 	}
2448 	err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE,
2449 			   0, &card);
2450 	if (err < 0)
2451 		return err;
2452 
2453         if ((err = snd_korg1212_create(card, pci, &korg1212)) < 0) {
2454 		snd_card_free(card);
2455 		return err;
2456 	}
2457 
2458 	strcpy(card->driver, "korg1212");
2459 	strcpy(card->shortname, "korg1212");
2460 	sprintf(card->longname, "%s at 0x%lx, irq %d", card->shortname,
2461 		korg1212->iomem, korg1212->irq);
2462 
2463         K1212_DEBUG_PRINTK("K1212_DEBUG: %s\n", card->longname);
2464 
2465 	if ((err = snd_card_register(card)) < 0) {
2466 		snd_card_free(card);
2467 		return err;
2468 	}
2469 	pci_set_drvdata(pci, card);
2470 	dev++;
2471 	return 0;
2472 }
2473 
2474 static void snd_korg1212_remove(struct pci_dev *pci)
2475 {
2476 	snd_card_free(pci_get_drvdata(pci));
2477 }
2478 
2479 static struct pci_driver korg1212_driver = {
2480 	.name = KBUILD_MODNAME,
2481 	.id_table = snd_korg1212_ids,
2482 	.probe = snd_korg1212_probe,
2483 	.remove = snd_korg1212_remove,
2484 };
2485 
2486 module_pci_driver(korg1212_driver);
2487