2 * Driver for C-Media CMI8328-based soundcards, such as AudioExcel AV500
3 * Copyright (c) 2012 Ondrej Zary
5 * AudioExcel AV500 card consists of:
6 * - CMI8328 - main chip (SB Pro emulation, gameport, OPL3, MPU401, CD-ROM)
7 * - CS4231A - WSS codec
8 * - Dream SAM9233+GMS950400+RAM+ROM: Wavetable MIDI, connected to MPU401
11 #include <linux/init.h>
12 #include <linux/isa.h>
13 #include <linux/module.h>
14 #include <linux/gameport.h>
16 #include <sound/core.h>
17 #include <sound/wss.h>
18 #include <sound/opl3.h>
19 #include <sound/mpu401.h>
20 #define SNDRV_LEGACY_FIND_FREE_IOPORT
21 #define SNDRV_LEGACY_FIND_FREE_IRQ
22 #define SNDRV_LEGACY_FIND_FREE_DMA
23 #include <sound/initval.h>
25 MODULE_AUTHOR("Ondrej Zary <linux@rainbow-software.org>");
26 MODULE_DESCRIPTION("C-Media CMI8328");
27 MODULE_LICENSE("GPL");
29 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
30 #define SUPPORT_JOYSTICK 1
33 /* I/O port is configured by jumpers on the card to one of these */
34 static int cmi8328_ports
[] = { 0x530, 0xe80, 0xf40, 0x604 };
35 #define CMI8328_MAX ARRAY_SIZE(cmi8328_ports)
37 static int index
[CMI8328_MAX
] = {[0 ... (CMI8328_MAX
-1)] = -1};
38 static char *id
[CMI8328_MAX
] = {[0 ... (CMI8328_MAX
-1)] = NULL
};
39 static long port
[CMI8328_MAX
] = {[0 ... (CMI8328_MAX
-1)] = SNDRV_AUTO_PORT
};
40 static int irq
[CMI8328_MAX
] = {[0 ... (CMI8328_MAX
-1)] = SNDRV_AUTO_IRQ
};
41 static int dma1
[CMI8328_MAX
] = {[0 ... (CMI8328_MAX
-1)] = SNDRV_AUTO_DMA
};
42 static int dma2
[CMI8328_MAX
] = {[0 ... (CMI8328_MAX
-1)] = SNDRV_AUTO_DMA
};
43 static long mpuport
[CMI8328_MAX
] = {[0 ... (CMI8328_MAX
-1)] = SNDRV_AUTO_PORT
};
44 static int mpuirq
[CMI8328_MAX
] = {[0 ... (CMI8328_MAX
-1)] = SNDRV_AUTO_IRQ
};
45 #ifdef SUPPORT_JOYSTICK
46 static bool gameport
[CMI8328_MAX
] = {[0 ... (CMI8328_MAX
-1)] = true};
49 module_param_array(index
, int, NULL
, 0444);
50 MODULE_PARM_DESC(index
, "Index value for CMI8328 soundcard.");
51 module_param_array(id
, charp
, NULL
, 0444);
52 MODULE_PARM_DESC(id
, "ID string for CMI8328 soundcard.");
54 module_param_array(port
, long, NULL
, 0444);
55 MODULE_PARM_DESC(port
, "Port # for CMI8328 driver.");
56 module_param_array(irq
, int, NULL
, 0444);
57 MODULE_PARM_DESC(irq
, "IRQ # for CMI8328 driver.");
58 module_param_array(dma1
, int, NULL
, 0444);
59 MODULE_PARM_DESC(dma1
, "DMA1 for CMI8328 driver.");
60 module_param_array(dma2
, int, NULL
, 0444);
61 MODULE_PARM_DESC(dma2
, "DMA2 for CMI8328 driver.");
63 module_param_array(mpuport
, long, NULL
, 0444);
64 MODULE_PARM_DESC(mpuport
, "MPU-401 port # for CMI8328 driver.");
65 module_param_array(mpuirq
, int, NULL
, 0444);
66 MODULE_PARM_DESC(mpuirq
, "IRQ # for CMI8328 MPU-401 port.");
67 #ifdef SUPPORT_JOYSTICK
68 module_param_array(gameport
, bool, NULL
, 0444);
69 MODULE_PARM_DESC(gameport
, "Enable gameport.");
76 struct snd_card
*card
;
78 #ifdef SUPPORT_JOYSTICK
79 struct gameport
*gameport
;
83 /* CMI8328 configuration registers */
85 #define CFG1_SB_DISABLE (1 << 0)
86 #define CFG1_GAMEPORT (1 << 1)
88 * bit 0: SB: 0=enabled, 1=disabled
89 * bit 1: gameport: 0=disabled, 1=enabled
90 * bits 2-4: SB IRQ: 001=3, 010=5, 011=7, 100=9, 101=10, 110=11
91 * bits 5-6: SB DMA: 00=disabled (when SB disabled), 01=DMA0, 10=DMA1, 11=DMA3
92 * bit 7: SB port: 0=0x220, 1=0x240
95 #define CFG2_MPU_ENABLE (1 << 2)
97 * bits 0-1: CD-ROM mode: 00=disabled, 01=Panasonic, 10=Sony/Mitsumi/Wearnes,
99 * bit 2: MPU401: 0=disabled, 1=enabled
100 * bits 3-4: MPU401 IRQ: 00=3, 01=5, 10=7, 11=9,
101 * bits 5-7: MPU401 port: 000=0x300, 001=0x310, 010=0x320, 011=0x330, 100=0x332,
106 * bits 0-2: CD-ROM IRQ: 000=disabled, 001=3, 010=5, 011=7, 100=9, 101=10,
108 * bits 3-4: CD-ROM DMA: 00=disabled, 01=DMA0, 10=DMA1, 11=DMA3
109 * bits 5-7: CD-ROM port: 000=0x300, 001=0x310, 010=0x320, 011=0x330, 100=0x340,
110 101=0x350, 110=0x360, 111=0x370
113 static u8
snd_cmi8328_cfg_read(u16 port
, u8 reg
)
115 outb(0x43, port
+ 3);
116 outb(0x21, port
+ 3);
121 static void snd_cmi8328_cfg_write(u16 port
, u8 reg
, u8 val
)
123 outb(0x43, port
+ 3);
124 outb(0x21, port
+ 3);
126 outb(val
, port
+ 3); /* yes, value goes to the same port as index */
129 static void snd_cmi8328_cfg_save(u16 port
, u8 cfg
[])
131 cfg
[0] = snd_cmi8328_cfg_read(port
, CFG1
);
132 cfg
[1] = snd_cmi8328_cfg_read(port
, CFG2
);
133 cfg
[2] = snd_cmi8328_cfg_read(port
, CFG3
);
136 static void snd_cmi8328_cfg_restore(u16 port
, u8 cfg
[])
138 snd_cmi8328_cfg_write(port
, CFG1
, cfg
[0]);
139 snd_cmi8328_cfg_write(port
, CFG2
, cfg
[1]);
140 snd_cmi8328_cfg_write(port
, CFG3
, cfg
[2]);
143 static int snd_cmi8328_mixer(struct snd_wss
*chip
)
145 struct snd_card
*card
;
146 struct snd_ctl_elem_id id1
, id2
;
151 memset(&id1
, 0, sizeof(id1
));
152 memset(&id2
, 0, sizeof(id2
));
153 id1
.iface
= id2
.iface
= SNDRV_CTL_ELEM_IFACE_MIXER
;
154 /* rename AUX0 switch to CD */
155 strcpy(id1
.name
, "Aux Playback Switch");
156 strcpy(id2
.name
, "CD Playback Switch");
157 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
159 snd_printk(KERN_ERR
"error renaming control\n");
162 /* rename AUX0 volume to CD */
163 strcpy(id1
.name
, "Aux Playback Volume");
164 strcpy(id2
.name
, "CD Playback Volume");
165 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
167 snd_printk(KERN_ERR
"error renaming control\n");
170 /* rename AUX1 switch to Synth */
171 strcpy(id1
.name
, "Aux Playback Switch");
173 strcpy(id2
.name
, "Synth Playback Switch");
174 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
176 snd_printk(KERN_ERR
"error renaming control\n");
179 /* rename AUX1 volume to Synth */
180 strcpy(id1
.name
, "Aux Playback Volume");
182 strcpy(id2
.name
, "Synth Playback Volume");
183 err
= snd_ctl_rename_id(card
, &id1
, &id2
);
185 snd_printk(KERN_ERR
"error renaming control\n");
192 /* find index of an item in "-1"-ended array */
193 int array_find(int array
[], int item
)
197 for (i
= 0; array
[i
] != -1; i
++)
198 if (array
[i
] == item
)
203 /* the same for long */
204 int array_find_l(long array
[], long item
)
208 for (i
= 0; array
[i
] != -1; i
++)
209 if (array
[i
] == item
)
215 static int snd_cmi8328_probe(struct device
*pdev
, unsigned int ndev
)
217 struct snd_card
*card
;
218 struct snd_opl3
*opl3
;
219 struct snd_cmi8328
*cmi
;
220 #ifdef SUPPORT_JOYSTICK
221 struct resource
*res
;
224 static long mpu_ports
[] = { 0x330, 0x300, 0x310, 0x320, 0x332, 0x334,
226 static u8 mpu_port_bits
[] = { 3, 0, 1, 2, 4, 5, 6 };
227 static int mpu_irqs
[] = { 9, 7, 5, 3, -1 };
228 static u8 mpu_irq_bits
[] = { 3, 2, 1, 0 };
229 static int irqs
[] = { 9, 10, 11, 7, -1 };
230 static u8 irq_bits
[] = { 2, 3, 4, 1 };
231 static int dma1s
[] = { 3, 1, 0, -1 };
232 static u8 dma_bits
[] = { 3, 2, 1 };
233 static int dma2s
[][2] = { {1, -1}, {0, -1}, {-1, -1}, {0, -1} };
234 u16 port
= cmi8328_ports
[ndev
];
237 /* 0xff is invalid configuration (but settable - hope it isn't set) */
238 if (snd_cmi8328_cfg_read(port
, CFG1
) == 0xff)
240 /* the SB disable bit must NEVER EVER be cleared or the WSS dies */
241 snd_cmi8328_cfg_write(port
, CFG1
, CFG1_SB_DISABLE
);
242 if (snd_cmi8328_cfg_read(port
, CFG1
) != CFG1_SB_DISABLE
)
244 /* disable everything first */
245 snd_cmi8328_cfg_write(port
, CFG2
, 0); /* disable CDROM and MPU401 */
246 snd_cmi8328_cfg_write(port
, CFG3
, 0); /* disable CDROM IRQ and DMA */
248 if (irq
[ndev
] == SNDRV_AUTO_IRQ
) {
249 irq
[ndev
] = snd_legacy_find_free_irq(irqs
);
251 snd_printk(KERN_ERR
"unable to find a free IRQ\n");
255 if (dma1
[ndev
] == SNDRV_AUTO_DMA
) {
256 dma1
[ndev
] = snd_legacy_find_free_dma(dma1s
);
257 if (dma1
[ndev
] < 0) {
258 snd_printk(KERN_ERR
"unable to find a free DMA1\n");
262 if (dma2
[ndev
] == SNDRV_AUTO_DMA
) {
263 dma2
[ndev
] = snd_legacy_find_free_dma(dma2s
[dma1
[ndev
] % 4]);
264 if (dma2
[ndev
] < 0) {
265 snd_printk(KERN_WARNING
"unable to find a free DMA2, full-duplex will not work\n");
269 /* configure WSS IRQ... */
270 pos
= array_find(irqs
, irq
[ndev
]);
272 snd_printk(KERN_ERR
"invalid IRQ %d\n", irq
[ndev
]);
275 val
= irq_bits
[pos
] << 3;
277 pos
= array_find(dma1s
, dma1
[ndev
]);
279 snd_printk(KERN_ERR
"invalid DMA1 %d\n", dma1
[ndev
]);
282 val
|= dma_bits
[pos
];
284 if (dma2
[ndev
] >= 0 && dma1
[ndev
] != dma2
[ndev
]) {
285 pos
= array_find(dma2s
[dma1
[ndev
]], dma2
[ndev
]);
287 snd_printk(KERN_ERR
"invalid DMA2 %d\n", dma2
[ndev
]);
290 val
|= 0x04; /* enable separate capture DMA */
294 err
= snd_card_create(index
[ndev
], id
[ndev
], THIS_MODULE
,
295 sizeof(struct snd_cmi8328
), &card
);
298 cmi
= card
->private_data
;
302 snd_card_set_dev(card
, pdev
);
304 err
= snd_wss_create(card
, port
+ 4, -1, irq
[ndev
], dma1
[ndev
],
305 dma2
[ndev
], WSS_HW_DETECT
, 0, &cmi
->wss
);
309 err
= snd_wss_pcm(cmi
->wss
, 0, NULL
);
313 err
= snd_wss_mixer(cmi
->wss
);
316 err
= snd_cmi8328_mixer(cmi
->wss
);
320 if (snd_wss_timer(cmi
->wss
, 0, NULL
) < 0)
321 snd_printk(KERN_WARNING
"error initializing WSS timer\n");
323 if (mpuport
[ndev
] == SNDRV_AUTO_PORT
) {
324 mpuport
[ndev
] = snd_legacy_find_free_ioport(mpu_ports
, 2);
325 if (mpuport
[ndev
] < 0)
326 snd_printk(KERN_ERR
"unable to find a free MPU401 port\n");
328 if (mpuirq
[ndev
] == SNDRV_AUTO_IRQ
) {
329 mpuirq
[ndev
] = snd_legacy_find_free_irq(mpu_irqs
);
330 if (mpuirq
[ndev
] < 0)
331 snd_printk(KERN_ERR
"unable to find a free MPU401 IRQ\n");
333 /* enable and configure MPU401 */
334 if (mpuport
[ndev
] > 0 && mpuirq
[ndev
] > 0) {
335 val
= CFG2_MPU_ENABLE
;
336 pos
= array_find_l(mpu_ports
, mpuport
[ndev
]);
338 snd_printk(KERN_WARNING
"invalid MPU401 port 0x%lx\n",
341 val
|= mpu_port_bits
[pos
] << 5;
342 pos
= array_find(mpu_irqs
, mpuirq
[ndev
]);
344 snd_printk(KERN_WARNING
"invalid MPU401 IRQ %d\n",
347 val
|= mpu_irq_bits
[pos
] << 3;
348 snd_cmi8328_cfg_write(port
, CFG2
, val
);
349 if (snd_mpu401_uart_new(card
, 0,
350 MPU401_HW_MPU401
, mpuport
[ndev
],
351 0, mpuirq
[ndev
], NULL
) < 0)
352 snd_printk(KERN_ERR
"error initializing MPU401\n");
356 /* OPL3 is hardwired to 0x388 and cannot be disabled */
357 if (snd_opl3_create(card
, 0x388, 0x38a, OPL3_HW_AUTO
, 0, &opl3
) < 0)
358 snd_printk(KERN_ERR
"error initializing OPL3\n");
360 if (snd_opl3_hwdep_new(opl3
, 0, 1, NULL
) < 0)
361 snd_printk(KERN_WARNING
"error initializing OPL3 hwdep\n");
363 strcpy(card
->driver
, "CMI8328");
364 strcpy(card
->shortname
, "C-Media CMI8328");
365 sprintf(card
->longname
, "%s at 0x%lx, irq %d, dma %d,%d",
366 card
->shortname
, cmi
->wss
->port
, irq
[ndev
], dma1
[ndev
],
367 (dma2
[ndev
] >= 0) ? dma2
[ndev
] : dma1
[ndev
]);
369 dev_set_drvdata(pdev
, card
);
370 err
= snd_card_register(card
);
373 #ifdef SUPPORT_JOYSTICK
376 /* gameport is hardwired to 0x200 */
377 res
= request_region(0x200, 8, "CMI8328 gameport");
379 snd_printk(KERN_WARNING
"unable to allocate gameport I/O port\n");
381 struct gameport
*gp
= cmi
->gameport
= gameport_allocate_port();
383 release_and_free_resource(res
);
385 gameport_set_name(gp
, "CMI8328 Gameport");
386 gameport_set_phys(gp
, "%s/gameport0", dev_name(pdev
));
387 gameport_set_dev_parent(gp
, pdev
);
389 gameport_set_port_data(gp
, res
);
390 /* Enable gameport */
391 snd_cmi8328_cfg_write(port
, CFG1
,
392 CFG1_SB_DISABLE
| CFG1_GAMEPORT
);
393 gameport_register_port(gp
);
404 static int snd_cmi8328_remove(struct device
*pdev
, unsigned int dev
)
406 struct snd_card
*card
= dev_get_drvdata(pdev
);
407 struct snd_cmi8328
*cmi
= card
->private_data
;
409 #ifdef SUPPORT_JOYSTICK
411 struct resource
*res
= gameport_get_port_data(cmi
->gameport
);
412 gameport_unregister_port(cmi
->gameport
);
413 release_and_free_resource(res
);
416 /* disable everything */
417 snd_cmi8328_cfg_write(cmi
->port
, CFG1
, CFG1_SB_DISABLE
);
418 snd_cmi8328_cfg_write(cmi
->port
, CFG2
, 0);
419 snd_cmi8328_cfg_write(cmi
->port
, CFG3
, 0);
425 static int snd_cmi8328_suspend(struct device
*pdev
, unsigned int n
,
428 struct snd_card
*card
= dev_get_drvdata(pdev
);
429 struct snd_cmi8328
*cmi
;
431 if (!card
) /* ignore absent devices */
433 cmi
= card
->private_data
;
434 snd_cmi8328_cfg_save(cmi
->port
, cmi
->cfg
);
435 snd_power_change_state(card
, SNDRV_CTL_POWER_D3hot
);
436 snd_pcm_suspend_all(cmi
->wss
->pcm
);
437 cmi
->wss
->suspend(cmi
->wss
);
442 static int snd_cmi8328_resume(struct device
*pdev
, unsigned int n
)
444 struct snd_card
*card
= dev_get_drvdata(pdev
);
445 struct snd_cmi8328
*cmi
;
447 if (!card
) /* ignore absent devices */
449 cmi
= card
->private_data
;
450 snd_cmi8328_cfg_restore(cmi
->port
, cmi
->cfg
);
451 outb(cmi
->wss_cfg
, cmi
->port
);
452 cmi
->wss
->resume(cmi
->wss
);
453 snd_power_change_state(card
, SNDRV_CTL_POWER_D0
);
459 static struct isa_driver snd_cmi8328_driver
= {
460 .probe
= snd_cmi8328_probe
,
461 .remove
= snd_cmi8328_remove
,
463 .suspend
= snd_cmi8328_suspend
,
464 .resume
= snd_cmi8328_resume
,
471 static int __init
alsa_card_cmi8328_init(void)
473 return isa_register_driver(&snd_cmi8328_driver
, CMI8328_MAX
);
476 static void __exit
alsa_card_cmi8328_exit(void)
478 isa_unregister_driver(&snd_cmi8328_driver
);
481 module_init(alsa_card_cmi8328_init
)
482 module_exit(alsa_card_cmi8328_exit
)