2 * Low-level ALSA driver for the ENSONIQ SoundScape PnP
3 * Copyright (c) by Chris Rankin
5 * This driver was written in part using information obtained from
6 * the OSS/Free SoundScape driver, written by Hannu Savolainen.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <sound/driver.h>
25 #include <linux/init.h>
26 #include <linux/delay.h>
27 #include <linux/pnp.h>
28 #include <linux/spinlock.h>
30 #include <sound/core.h>
31 #include <sound/hwdep.h>
32 #include <sound/cs4231.h>
33 #include <sound/mpu401.h>
35 #include <sound/initval.h>
37 #include <sound/sscape_ioctl.h>
39 #define chip_t cs4231_t
42 MODULE_AUTHOR("Chris Rankin");
43 MODULE_DESCRIPTION("ENSONIQ SoundScape PnP driver");
44 MODULE_LICENSE("GPL");
46 static int index[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IDX;
47 static char* id[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_STR;
48 static long port[SNDRV_CARDS] __devinitdata = { [0 ... (SNDRV_CARDS-1)] = SNDRV_AUTO_PORT };
49 static int irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ;
50 static int mpu_irq[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_IRQ;
51 static int dma[SNDRV_CARDS] __devinitdata = SNDRV_DEFAULT_DMA;
53 MODULE_PARM(index, "1-" __MODULE_STRING(SNDRV_CARDS) "i");
54 MODULE_PARM_DESC(index, "Index number for SoundScape soundcard");
55 MODULE_PARM_SYNTAX(index, SNDRV_INDEX_DESC);
57 MODULE_PARM(id, "1-" __MODULE_STRING(SNDRV_CARDS) "s");
58 MODULE_PARM_DESC(id, "Description for SoundScape card");
59 MODULE_PARM_SYNTAX(id, SNDRV_ID_DESC);
61 MODULE_PARM(port, "1-" __MODULE_STRING(SNDRV_CARDS) "l");
62 MODULE_PARM_DESC(port, "Port # for SoundScape driver.");
63 MODULE_PARM_SYNTAX(port, SNDRV_ENABLED);
65 MODULE_PARM(irq, "1-" __MODULE_STRING(SNDRV_CARDS) "i");
66 MODULE_PARM_DESC(irq, "IRQ # for SoundScape driver.");
67 MODULE_PARM_SYNTAX(irq, SNDRV_IRQ_DESC);
69 MODULE_PARM(mpu_irq, "1-" __MODULE_STRING(SNDRV_CARDS) "i");
70 MODULE_PARM_DESC(mpu_irq, "MPU401 IRQ # for SoundScape driver.");
71 MODULE_PARM_SYNTAX(mpu_irq, SNDRV_IRQ_DESC);
73 MODULE_PARM(dma, "1-" __MODULE_STRING(SNDRV_CARDS) "i");
74 MODULE_PARM_DESC(dma, "DMA # for SoundScape driver.");
75 MODULE_PARM_SYNTAX(dma, SNDRV_DMA8_DESC);
78 static struct pnp_card_device_id sscape_pnpids[] = {
79 { .id = "ENS3081", .devs = { { "ENS0000" } } },
80 { .id = "" } /* end */
83 MODULE_DEVICE_TABLE(pnp_card, sscape_pnpids);
86 static snd_card_t *sscape_card[SNDRV_CARDS];
89 #define MPU401_IO(i) ((i) + 0)
90 #define MIDI_DATA_IO(i) ((i) + 0)
91 #define MIDI_CTRL_IO(i) ((i) + 1)
92 #define HOST_CTRL_IO(i) ((i) + 2)
93 #define HOST_DATA_IO(i) ((i) + 3)
94 #define ODIE_ADDR_IO(i) ((i) + 4)
95 #define ODIE_DATA_IO(i) ((i) + 5)
96 #define CODEC_IO(i) ((i) + 8)
101 #define RX_READY 0x01
102 #define TX_READY 0x02
105 #define CMD_SET_MIDI_VOL 0x84
106 #define CMD_GET_MIDI_VOL 0x85
107 #define CMD_XXX_MIDI_VOL 0x86
108 #define CMD_SET_EXTMIDI 0x8a
109 #define CMD_GET_EXTMIDI 0x8b
110 #define CMD_SET_MT32 0x8c
111 #define CMD_GET_MT32 0x8d
126 #define DMA_8BIT 0x80
129 #define AD1845_FREQ_SEL_MSB 0x16
130 #define AD1845_FREQ_SEL_LSB 0x17
137 struct resource *io_res;
143 * The MIDI device won't work until we've loaded
144 * its firmware via a hardware-dependent device IOCTL
148 unsigned long midi_usage;
149 unsigned char midi_vol;
152 #define INVALID_IRQ ((unsigned)-1)
155 static inline struct soundscape *get_card_soundscape(snd_card_t * c)
157 return (struct soundscape *) (c->private_data);
160 static inline struct soundscape *get_mpu401_soundscape(mpu401_t * mpu)
162 return (struct soundscape *) (mpu->private_data);
165 static inline struct soundscape *get_hwdep_soundscape(snd_hwdep_t * hw)
167 return (struct soundscape *) (hw->private_data);
172 * Allocates some kernel memory that we can use for DMA.
173 * I think this means that the memory has to map to
174 * contiguous pages of physical memory.
176 static struct snd_dma_buffer *get_dmabuf(struct snd_dma_buffer *buf, unsigned long size)
179 struct snd_dma_device dev;
180 memset(&dev, 0, sizeof(dev));
181 dev.type = SNDRV_DMA_TYPE_DEV;
182 dev.dev = snd_dma_isa_data();
183 if (snd_dma_alloc_pages_fallback(&dev, size, buf) < 0) {
184 snd_printk(KERN_ERR "sscape: Failed to allocate %lu bytes for DMA\n", size);
193 * Release the DMA-able kernel memory ...
195 static void free_dmabuf(struct snd_dma_buffer *buf)
197 if (buf && buf->area) {
198 struct snd_dma_device dev;
199 memset(&dev, 0, sizeof(dev));
200 dev.type = SNDRV_DMA_TYPE_DEV;
201 dev.dev = snd_dma_isa_data();
202 snd_dma_free_pages(&dev, buf);
208 * This function writes to the SoundScape's control registers,
209 * but doesn't do any locking. It's up to the caller to do that.
210 * This is why this function is "unsafe" ...
212 static inline void sscape_write_unsafe(unsigned io_base, enum GA_REG reg, unsigned char val)
214 outb(reg, ODIE_ADDR_IO(io_base));
215 outb(val, ODIE_DATA_IO(io_base));
219 * Write to the SoundScape's control registers, and do the
220 * necessary locking ...
222 static void sscape_write(struct soundscape *s, enum GA_REG reg, unsigned char val)
226 spin_lock_irqsave(&s->lock, flags);
227 sscape_write_unsafe(s->io_base, reg, val);
228 spin_unlock_irqrestore(&s->lock, flags);
232 * Read from the SoundScape's control registers, but leave any
233 * locking to the caller. This is why the function is "unsafe" ...
235 static inline unsigned char sscape_read_unsafe(unsigned io_base, enum GA_REG reg)
237 outb(reg, ODIE_ADDR_IO(io_base));
238 return inb(ODIE_DATA_IO(io_base));
242 * Puts the SoundScape into "host" mode, as compared to "MIDI" mode
244 static inline void set_host_mode_unsafe(unsigned io_base)
246 outb(0x0, HOST_CTRL_IO(io_base));
250 * Puts the SoundScape into "MIDI" mode, as compared to "host" mode
252 static inline void set_midi_mode_unsafe(unsigned io_base)
254 outb(0x3, HOST_CTRL_IO(io_base));
258 * Read the SoundScape's host-mode control register, but leave
259 * any locking issues to the caller ...
261 static inline int host_read_unsafe(unsigned io_base)
264 if ((inb(HOST_CTRL_IO(io_base)) & RX_READY) != 0) {
265 data = inb(HOST_DATA_IO(io_base));
272 * Read the SoundScape's host-mode control register, performing
273 * a limited amount of busy-waiting if the register isn't ready.
274 * Also leaves all locking-issues to the caller ...
276 static int host_read_ctrl_unsafe(unsigned io_base, unsigned timeout)
280 while (((data = host_read_unsafe(io_base)) < 0) && (timeout != 0)) {
289 * Write to the SoundScape's host-mode control registers, but
290 * leave any locking issues to the caller ...
292 static inline int host_write_unsafe(unsigned io_base, unsigned char data)
294 if ((inb(HOST_CTRL_IO(io_base)) & TX_READY) != 0) {
295 outb(data, HOST_DATA_IO(io_base));
303 * Write to the SoundScape's host-mode control registers, performing
304 * a limited amount of busy-waiting if the register isn't ready.
305 * Also leaves all locking-issues to the caller ...
307 static int host_write_ctrl_unsafe(unsigned io_base, unsigned char data,
312 while (!(err = host_write_unsafe(io_base, data)) && (timeout != 0)) {
322 * Check that the MIDI subsystem is operational. If it isn't,
323 * then we will hang the computer if we try to use it ...
325 * NOTE: This check is based upon observation, not documentation.
327 static inline int verify_mpu401(const mpu401_t * mpu)
329 return ((inb(MIDI_CTRL_IO(mpu->port)) & 0xc0) == 0x80);
333 * This is apparently the standard way to initailise an MPU-401
335 static inline void initialise_mpu401(const mpu401_t * mpu)
337 outb(0, MIDI_DATA_IO(mpu->port));
341 * Tell the SoundScape to activate the AD1845 chip (I think).
342 * The AD1845 detection fails if we *don't* do this, so I
343 * think that this is a good idea ...
345 static inline void activate_ad1845_unsafe(unsigned io_base)
347 sscape_write_unsafe(io_base, GA_HMCTL_REG, (sscape_read_unsafe(io_base, GA_HMCTL_REG) & 0xcf) | 0x10);
348 sscape_write_unsafe(io_base, GA_CDCFG_REG, 0x80);
352 * Do the necessary ALSA-level cleanup to deallocate our driver ...
354 static void soundscape_free(snd_card_t * c)
356 register struct soundscape *sscape = get_card_soundscape(c);
357 release_resource(sscape->io_res);
358 kfree_nocheck(sscape->io_res);
359 free_dma(sscape->chip->dma1);
363 * Put this process into an idle wait-state for a certain number
364 * of "jiffies". The process can almost certainly be rescheduled
365 * while we're waiting, and so we must NOT be holding any spinlocks
366 * when we call this function. If we are then we risk DEADLOCK in
367 * SMP (Ha!) or pre-emptible kernels.
369 static inline void sleep(long jiffs, int state)
371 set_current_state(state);
372 schedule_timeout(jiffs);
376 * Tell the SoundScape to begin a DMA tranfer using the given channel.
377 * All locking issues are left to the caller.
379 static inline void sscape_start_dma_unsafe(unsigned io_base, enum GA_REG reg)
381 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) | 0x01);
382 sscape_write_unsafe(io_base, reg, sscape_read_unsafe(io_base, reg) & 0xfe);
386 * Wait for a DMA transfer to complete. This is a "limited busy-wait",
387 * and all locking issues are left to the caller.
389 static int sscape_wait_dma_unsafe(unsigned io_base, enum GA_REG reg, unsigned timeout)
391 while (!(sscape_read_unsafe(io_base, reg) & 0x01) && (timeout != 0)) {
396 return (sscape_read_unsafe(io_base, reg) & 0x01);
400 * Wait for the On-Board Processor to return its start-up
401 * acknowledgement sequence. This wait is too long for
402 * us to perform "busy-waiting", and so we must sleep.
403 * This in turn means that we must not be holding any
404 * spinlocks when we call this function.
406 static int obp_startup_ack(struct soundscape *s, unsigned timeout)
408 while (timeout != 0) {
412 sleep(1, TASK_INTERRUPTIBLE);
414 spin_lock_irqsave(&s->lock, flags);
415 x = inb(HOST_DATA_IO(s->io_base));
416 spin_unlock_irqrestore(&s->lock, flags);
417 if ((x & 0xfe) == 0xfe)
427 * Wait for the host to return its start-up acknowledgement
428 * sequence. This wait is too long for us to perform
429 * "busy-waiting", and so we must sleep. This in turn means
430 * that we must not be holding any spinlocks when we call
433 static int host_startup_ack(struct soundscape *s, unsigned timeout)
435 while (timeout != 0) {
439 sleep(1, TASK_INTERRUPTIBLE);
441 spin_lock_irqsave(&s->lock, flags);
442 x = inb(HOST_DATA_IO(s->io_base));
443 spin_unlock_irqrestore(&s->lock, flags);
454 * Upload a byte-stream into the SoundScape using DMA channel A.
456 static int upload_dma_data(struct soundscape *s,
457 const unsigned char *data,
461 struct snd_dma_buffer dma;
464 if (!get_dmabuf(&dma, PAGE_ALIGN(size)))
467 spin_lock_irqsave(&s->lock, flags);
470 * Reset the board ...
472 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) & 0x3f);
475 * Enable the DMA channels and configure them ...
477 sscape_write_unsafe(s->io_base, GA_DMACFG_REG, 0x50);
478 sscape_write_unsafe(s->io_base, GA_DMAA_REG, (s->chip->dma1 << 4) | DMA_8BIT);
479 sscape_write_unsafe(s->io_base, GA_DMAB_REG, 0x20);
482 * Take the board out of reset ...
484 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x80);
487 * Upload the user's data (firmware?) to the SoundScape
488 * board through the DMA channel ...
494 * Apparently, copying to/from userspace can sleep.
495 * We are therefore forbidden from holding any
496 * spinlocks while we copy ...
498 spin_unlock_irqrestore(&s->lock, flags);
501 * Remember that the data that we want to DMA
502 * comes from USERSPACE. We have already verified
503 * the userspace pointer ...
505 len = min(size, dma.bytes);
506 __copy_from_user(dma.area, data, len);
511 * Grab that spinlock again, now that we've
514 spin_lock_irqsave(&s->lock, flags);
516 snd_dma_program(s->chip->dma1, dma.addr, len, DMA_MODE_WRITE);
517 sscape_start_dma_unsafe(s->io_base, GA_DMAA_REG);
518 if (!sscape_wait_dma_unsafe(s->io_base, GA_DMAA_REG, 5000)) {
520 * Don't forget to release this spinlock we're holding ...
522 spin_unlock_irqrestore(&s->lock, flags);
524 snd_printk(KERN_ERR "sscape: DMA upload has timed out\n");
530 set_host_mode_unsafe(s->io_base);
533 * Boot the board ... (I think)
535 sscape_write_unsafe(s->io_base, GA_HMCTL_REG, sscape_read_unsafe(s->io_base, GA_HMCTL_REG) | 0x40);
536 spin_unlock_irqrestore(&s->lock, flags);
539 * If all has gone well, then the board should acknowledge
540 * the new upload and tell us that it has rebooted OK. We
541 * give it 5 seconds (max) ...
544 if (!obp_startup_ack(s, 5)) {
545 snd_printk(KERN_ERR "sscape: No response from on-board processor after upload\n");
547 } else if (!host_startup_ack(s, 5)) {
548 snd_printk(KERN_ERR "sscape: SoundScape failed to initialise\n");
554 * NOTE!!! We are NOT holding any spinlocks at this point !!!
556 sscape_write(s, GA_DMAA_REG, (s->ic_type == IC_ODIE ? 0x70 : 0x40));
563 * Upload the bootblock(?) into the SoundScape. The only
564 * purpose of this block of code seems to be to tell
565 * us which version of the microcode we should be using.
567 * NOTE: The boot-block data resides in USER-SPACE!!!
568 * However, we have already verified its memory
569 * addresses by the time we get here.
571 static int sscape_upload_bootblock(struct soundscape *sscape, struct sscape_bootblock *bb)
577 ret = upload_dma_data(sscape, bb->code, sizeof(bb->code));
579 spin_lock_irqsave(&sscape->lock, flags);
581 data = host_read_ctrl_unsafe(sscape->io_base, 100);
583 set_midi_mode_unsafe(sscape->io_base);
584 spin_unlock_irqrestore(&sscape->lock, flags);
588 snd_printk(KERN_ERR "sscape: timeout reading firmware version\n");
591 __copy_to_user(&bb->version, &data, sizeof(bb->version));
599 * Upload the microcode into the SoundScape. The
600 * microcode is 64K of data, and if we try to copy
601 * it into a local variable then we will SMASH THE
602 * KERNEL'S STACK! We therefore leave it in USER
603 * SPACE, and save ourselves from copying it at all.
605 static int sscape_upload_microcode(struct soundscape *sscape,
606 const struct sscape_microcode *mc)
613 * We are going to have to copy this data into a special
614 * DMA-able buffer before we can upload it. We shall therefore
615 * just check that the data pointer is valid for now.
617 * NOTE: This buffer is 64K long! That's WAY too big to
618 * copy into a stack-temporary anyway.
620 if (get_user(code, &mc->code))
622 if ((err = verify_area(VERIFY_READ, code, SSCAPE_MICROCODE_SIZE)) != 0)
625 if ((ret = upload_dma_data(sscape, code, SSCAPE_MICROCODE_SIZE)) == 0) {
626 snd_printk(KERN_INFO "sscape: MIDI firmware loaded\n");
629 spin_lock_irqsave(&sscape->lock, flags);
630 set_midi_mode_unsafe(sscape->io_base);
631 spin_unlock_irqrestore(&sscape->lock, flags);
633 initialise_mpu401(sscape->mpu);
639 * Hardware-specific device functions, to implement special
640 * IOCTLs for the SoundScape card. This is how we upload
641 * the microcode into the card, for example, and so we
642 * must ensure that no two processes can open this device
643 * simultaneously, and that we can't open it at all if
644 * someone is using the MIDI device.
646 static int sscape_hw_open(snd_hwdep_t * hw, struct file *file)
648 register struct soundscape *sscape = get_hwdep_soundscape(hw);
652 spin_lock_irqsave(&sscape->fwlock, flags);
654 if ((sscape->midi_usage != 0) || sscape->hw_in_use) {
657 sscape->hw_in_use = 1;
661 spin_unlock_irqrestore(&sscape->fwlock, flags);
665 static int sscape_hw_release(snd_hwdep_t * hw, struct file *file)
667 register struct soundscape *sscape = get_hwdep_soundscape(hw);
670 spin_lock_irqsave(&sscape->fwlock, flags);
671 sscape->hw_in_use = 0;
672 spin_unlock_irqrestore(&sscape->fwlock, flags);
676 static int sscape_hw_ioctl(snd_hwdep_t * hw, struct file *file,
677 unsigned int cmd, unsigned long arg)
679 struct soundscape *sscape = get_hwdep_soundscape(hw);
683 case SND_SSCAPE_LOAD_BOOTB:
685 register struct sscape_bootblock *bb = (struct sscape_bootblock *) arg;
688 * We are going to have to copy this data into a special
689 * DMA-able buffer before we can upload it. We shall therefore
690 * just check that the data pointer is valid for now ...
692 if ((err = verify_area(VERIFY_READ, bb->code, sizeof(bb->code))) != 0)
696 * Now check that we can write the firmware version number too...
698 if ((err = verify_area(VERIFY_WRITE, &bb->version, sizeof(bb->version))) != 0)
701 err = sscape_upload_bootblock(sscape, bb);
705 case SND_SSCAPE_LOAD_MCODE:
707 register const struct sscape_microcode *mc = (const struct sscape_microcode *) arg;
709 err = sscape_upload_microcode(sscape, mc);
723 * Mixer control for the SoundScape's MIDI device.
725 static int sscape_midi_info(snd_kcontrol_t * ctl,
726 snd_ctl_elem_info_t * uinfo)
728 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
730 uinfo->value.integer.min = 0;
731 uinfo->value.integer.max = 127;
735 static int sscape_midi_get(snd_kcontrol_t * kctl,
736 snd_ctl_elem_value_t * uctl)
738 cs4231_t *chip = snd_kcontrol_chip(kctl);
739 snd_card_t *card = chip->card;
740 register struct soundscape *s = get_card_soundscape(card);
743 spin_lock_irqsave(&s->lock, flags);
744 set_host_mode_unsafe(s->io_base);
746 if (host_write_ctrl_unsafe(s->io_base, CMD_GET_MIDI_VOL, 100)) {
747 uctl->value.integer.value[0] = host_read_ctrl_unsafe(s->io_base, 100);
750 set_midi_mode_unsafe(s->io_base);
751 spin_unlock_irqrestore(&s->lock, flags);
755 static int sscape_midi_put(snd_kcontrol_t * kctl,
756 snd_ctl_elem_value_t * uctl)
758 cs4231_t *chip = snd_kcontrol_chip(kctl);
759 snd_card_t *card = chip->card;
760 register struct soundscape *s = get_card_soundscape(card);
764 spin_lock_irqsave(&s->lock, flags);
767 * We need to put the board into HOST mode before we
768 * can send any volume-changing HOST commands ...
770 set_host_mode_unsafe(s->io_base);
773 * To successfully change the MIDI volume setting, you seem to
774 * have to write a volume command, write the new volume value,
775 * and then perform another volume-related command. Perhaps the
776 * first command is an "open" and the second command is a "close"?
778 if (s->midi_vol == ((unsigned char) uctl->value.integer. value[0] & 127)) {
782 change = (host_write_ctrl_unsafe(s->io_base, CMD_SET_MIDI_VOL, 100)
783 && host_write_ctrl_unsafe(s->io_base, ((unsigned char) uctl->value.integer. value[0]) & 127, 100)
784 && host_write_ctrl_unsafe(s->io_base, CMD_XXX_MIDI_VOL, 100));
788 * Take the board out of HOST mode and back into MIDI mode ...
790 set_midi_mode_unsafe(s->io_base);
792 spin_unlock_irqrestore(&s->lock, flags);
796 static snd_kcontrol_new_t midi_mixer_ctl = {
797 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
799 .info = sscape_midi_info,
800 .get = sscape_midi_get,
801 .put = sscape_midi_put
805 * The SoundScape can use two IRQs from a possible set of four.
806 * These IRQs are encoded as bit patterns so that they can be
807 * written to the control registers.
809 static unsigned __devinit get_irq_config(int irq)
811 static const int valid_irq[] = { 9, 5, 7, 10 };
814 for (cfg = 0; cfg < ARRAY_SIZE(valid_irq); ++cfg) {
815 if (irq == valid_irq[cfg])
824 * Perform certain arcane port-checks to see whether there
825 * is a SoundScape board lurking behind the given ports.
827 static int __devinit detect_sscape(struct soundscape *s)
833 spin_lock_irqsave(&s->lock, flags);
836 * The following code is lifted from the original OSS driver,
837 * and as I don't have a datasheet I cannot really comment
838 * on what it is doing...
840 if ((inb(HOST_CTRL_IO(s->io_base)) & 0x78) != 0)
843 d = inb(ODIE_ADDR_IO(s->io_base)) & 0xf0;
849 s->ic_type = IC_ODIE;
850 } else if ((d & 0x60) != 0) {
852 s->ic_type = IC_OPUS;
856 outb(0xfa, ODIE_ADDR_IO(s->io_base));
857 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0a)
860 outb(0xfe, ODIE_ADDR_IO(s->io_base));
861 if ((inb(ODIE_ADDR_IO(s->io_base)) & 0x9f) != 0x0e)
863 if ((inb(ODIE_DATA_IO(s->io_base)) & 0x9f) != 0x0e)
867 * SoundScape successfully detected!
872 spin_unlock_irqrestore(&s->lock, flags);
877 * ALSA callback function, called when attempting to open the MIDI device.
878 * Check that the MIDI firmware has been loaded, because we don't want
879 * to crash the machine. Also check that someone isn't using the hardware
882 static int mpu401_open(mpu401_t * mpu)
886 if (!verify_mpu401(mpu)) {
887 snd_printk(KERN_ERR "sscape: MIDI disabled, please load firmware\n");
890 register struct soundscape *sscape = get_mpu401_soundscape(mpu);
893 spin_lock_irqsave(&sscape->fwlock, flags);
895 if (sscape->hw_in_use || (sscape->midi_usage == ULONG_MAX)) {
898 ++(sscape->midi_usage);
902 spin_unlock_irqrestore(&sscape->fwlock, flags);
908 static void mpu401_close(mpu401_t * mpu)
910 register struct soundscape *sscape = get_mpu401_soundscape(mpu);
913 spin_lock_irqsave(&sscape->fwlock, flags);
914 --(sscape->midi_usage);
915 spin_unlock_irqrestore(&sscape->fwlock, flags);
919 * Initialse an MPU-401 subdevice for MIDI support on the SoundScape.
921 static int __devinit create_mpu401(snd_card_t * card, int devnum, unsigned long port, int irq)
923 struct soundscape *sscape = get_card_soundscape(card);
924 snd_rawmidi_t *rawmidi;
927 #define MPU401_SHARE_HARDWARE 1
928 if ((err = snd_mpu401_uart_new(card, devnum,
930 port, MPU401_SHARE_HARDWARE,
933 mpu401_t *mpu = (mpu401_t *) rawmidi->private_data;
934 mpu->open_input = mpu401_open;
935 mpu->open_output = mpu401_open;
936 mpu->close_input = mpu401_close;
937 mpu->close_output = mpu401_close;
938 mpu->private_data = sscape;
941 initialise_mpu401(mpu);
949 * Override for the CS4231 playback format function.
950 * The AD1845 has much simpler format and rate selection.
952 static void ad1845_playback_format(cs4231_t * chip, snd_pcm_hw_params_t * params, unsigned char format)
955 unsigned rate = params_rate(params);
958 * The AD1845 can't handle sample frequencies
959 * outside of 4 kHZ to 50 kHZ
963 else if (rate < 4000)
966 spin_lock_irqsave(&chip->reg_lock, flags);
969 * Program the AD1845 correctly for the playback stream.
970 * Note that we do NOT need to toggle the MCE bit because
971 * the PLAYBACK_ENABLE bit of the Interface Configuration
974 * NOTE: We seem to need to write to the MSB before the LSB
975 * to get the correct sample frequency.
977 snd_cs4231_out(chip, CS4231_PLAYBK_FORMAT, (format & 0xf0));
978 snd_cs4231_out(chip, AD1845_FREQ_SEL_MSB, (unsigned char) (rate >> 8));
979 snd_cs4231_out(chip, AD1845_FREQ_SEL_LSB, (unsigned char) rate);
981 spin_unlock_irqrestore(&chip->reg_lock, flags);
985 * Override for the CS4231 capture format function.
986 * The AD1845 has much simpler format and rate selection.
988 static void ad1845_capture_format(cs4231_t * chip, snd_pcm_hw_params_t * params, unsigned char format)
991 unsigned rate = params_rate(params);
994 * The AD1845 can't handle sample frequencies
995 * outside of 4 kHZ to 50 kHZ
999 else if (rate < 4000)
1002 spin_lock_irqsave(&chip->reg_lock, flags);
1005 * Program the AD1845 correctly for the playback stream.
1006 * Note that we do NOT need to toggle the MCE bit because
1007 * the CAPTURE_ENABLE bit of the Interface Configuration
1010 * NOTE: We seem to need to write to the MSB before the LSB
1011 * to get the correct sample frequency.
1013 snd_cs4231_out(chip, CS4231_REC_FORMAT, (format & 0xf0));
1014 snd_cs4231_out(chip, AD1845_FREQ_SEL_MSB, (unsigned char) (rate >> 8));
1015 snd_cs4231_out(chip, AD1845_FREQ_SEL_LSB, (unsigned char) rate);
1017 spin_unlock_irqrestore(&chip->reg_lock, flags);
1021 * Create an AD1845 PCM subdevice on the SoundScape. The AD1845
1022 * is very much like a CS4231, with a few extra bits. We will
1023 * try to support at least some of the extra bits by overriding
1024 * some of the CS4231 callback.
1026 static int __devinit create_ad1845(snd_card_t * card, unsigned port, int irq, int dma1)
1028 register struct soundscape *sscape = get_card_soundscape(card);
1032 #define CS4231_SHARE_HARDWARE (CS4231_HWSHARE_DMA1 | CS4231_HWSHARE_DMA2)
1034 * The AD1845 PCM device is only half-duplex, and so
1035 * we only give it one DMA channel ...
1037 if ((err = snd_cs4231_create(card,
1038 port, -1, irq, dma1, dma1,
1040 CS4231_HWSHARE_DMA1, &chip)) == 0) {
1041 unsigned long flags;
1044 #define AD1845_FREQ_SEL_ENABLE 0x08
1046 #define AD1845_PWR_DOWN_CTRL 0x1b
1047 #define AD1845_CRYS_CLOCK_SEL 0x1d
1050 * It turns out that the PLAYBACK_ENABLE bit is set
1051 * by the lowlevel driver ...
1053 #define AD1845_IFACE_CONFIG \
1054 (CS4231_AUTOCALIB | CS4231_RECORD_ENABLE | CS4231_PLAYBACK_ENABLE)
1055 snd_cs4231_mce_up(chip);
1056 spin_lock_irqsave(&chip->reg_lock, flags);
1057 snd_cs4231_out(chip, CS4231_IFACE_CTRL, AD1845_IFACE_CONFIG);
1058 spin_unlock_irqrestore(&chip->reg_lock, flags);
1059 snd_cs4231_mce_down(chip);
1063 * The input clock frequency on the SoundScape must
1064 * be 14.31818 MHz, because we must set this register
1065 * to get the playback to sound correct ...
1067 snd_cs4231_mce_up(chip);
1068 spin_lock_irqsave(&chip->reg_lock, flags);
1069 snd_cs4231_out(chip, AD1845_CRYS_CLOCK_SEL, 0x20);
1070 spin_unlock_irqrestore(&chip->reg_lock, flags);
1071 snd_cs4231_mce_down(chip);
1074 * More custom configuration:
1075 * a) select "mode 2", and provide a current drive of 8 mA
1076 * b) enable frequency selection (for capture/playback)
1078 spin_lock_irqsave(&chip->reg_lock, flags);
1079 snd_cs4231_out(chip, CS4231_MISC_INFO, (CS4231_MODE2 | 0x10));
1080 snd_cs4231_out(chip, AD1845_PWR_DOWN_CTRL, snd_cs4231_in(chip, AD1845_PWR_DOWN_CTRL) | AD1845_FREQ_SEL_ENABLE);
1081 spin_unlock_irqrestore(&chip->reg_lock, flags);
1083 if ((err = snd_cs4231_pcm(chip, 0, &pcm)) < 0) {
1084 snd_printk(KERN_ERR "sscape: No PCM device for AD1845 chip\n");
1088 if ((err = snd_cs4231_mixer(chip)) < 0) {
1089 snd_printk(KERN_ERR "sscape: No mixer device for AD1845 chip\n");
1093 if ((err = snd_ctl_add(card, snd_ctl_new1(&midi_mixer_ctl, chip))) < 0) {
1094 snd_printk(KERN_ERR "sscape: Could not create MIDI mixer control\n");
1098 strcpy(card->driver, "SoundScape");
1099 strcpy(card->shortname, pcm->name);
1100 snprintf(card->longname, sizeof(card->longname),
1101 "%s at 0x%lx, IRQ %d, DMA %d\n",
1102 pcm->name, chip->port, chip->irq, chip->dma1);
1103 chip->set_playback_format = ad1845_playback_format;
1104 chip->set_capture_format = ad1845_capture_format;
1105 sscape->chip = chip;
1124 static inline struct params*
1125 init_params(struct params *params,
1133 params->index = index;
1135 params->port = port;
1137 params->mpu_irq = mpu_irq;
1138 params->dma1 = (dma1 & 0x03);
1145 * Create an ALSA soundcard entry for the SoundScape, using
1146 * the given list of port, IRQ and DMA resources.
1148 static int __devinit create_sscape(const struct params *params, snd_card_t **rcardp)
1151 register struct soundscape *sscape;
1152 register unsigned dma_cfg;
1154 unsigned mpu_irq_cfg;
1155 struct resource *io_res;
1156 unsigned long flags;
1160 * Check that the user didn't pass us garbage data ...
1162 irq_cfg = get_irq_config(params->irq);
1163 if (irq_cfg == INVALID_IRQ) {
1164 snd_printk(KERN_ERR "sscape: Invalid IRQ %d\n", params->irq);
1168 mpu_irq_cfg = get_irq_config(params->mpu_irq);
1169 if (mpu_irq_cfg == INVALID_IRQ) {
1170 printk(KERN_ERR "sscape: Invalid IRQ %d\n", params->mpu_irq);
1175 * Grab IO ports that we will need to probe so that we
1176 * can detect and control this hardware ...
1178 if ((io_res = request_region(params->port, 8, "SoundScape")) == NULL) {
1179 snd_printk(KERN_ERR "sscape: can't grab port 0x%x\n", params->port);
1184 * Grab both DMA channels (OK, only one for now) ...
1186 if ((err = request_dma(params->dma1, "SoundScape")) < 0) {
1187 snd_printk(KERN_ERR "sscape: can't grab DMA %d\n", params->dma1);
1188 goto _release_region;
1192 * Create a new ALSA sound card entry, in anticipation
1193 * of detecting our hardware ...
1195 if ((card = snd_card_new(params->index, params->id, THIS_MODULE, sizeof(struct soundscape))) == NULL) {
1200 sscape = get_card_soundscape(card);
1201 spin_lock_init(&sscape->lock);
1202 spin_lock_init(&sscape->fwlock);
1203 sscape->io_res = io_res;
1204 sscape->io_base = params->port;
1206 if (!detect_sscape(sscape)) {
1207 printk(KERN_ERR "sscape: hardware not detected at 0x%x\n", sscape->io_base);
1212 printk(KERN_INFO "sscape: hardware detected at 0x%x, using IRQ %d, DMA %d\n",
1213 sscape->io_base, params->irq, params->dma1);
1216 * Now create the hardware-specific device so that we can
1217 * load the microcode into the on-board processor.
1218 * We cannot use the MPU-401 MIDI system until this firmware
1219 * has been loaded into the card.
1221 if ((err = snd_hwdep_new(card, "MC68EC000", 0, &(sscape->hw))) < 0) {
1222 printk(KERN_ERR "sscape: Failed to create firmware device\n");
1225 strlcpy(sscape->hw->name, "SoundScape M68K", sizeof(sscape->hw->name));
1226 sscape->hw->name[sizeof(sscape->hw->name) - 1] = '\0';
1227 sscape->hw->iface = SNDRV_HWDEP_IFACE_SSCAPE;
1228 sscape->hw->ops.open = sscape_hw_open;
1229 sscape->hw->ops.release = sscape_hw_release;
1230 sscape->hw->ops.ioctl = sscape_hw_ioctl;
1231 sscape->hw->private_data = sscape;
1234 * Tell the on-board devices where their resources are (I think -
1235 * I can't be sure without a datasheet ... So many magic values!)
1237 spin_lock_irqsave(&sscape->lock, flags);
1239 activate_ad1845_unsafe(sscape->io_base);
1241 sscape_write_unsafe(sscape->io_base, GA_INTENA_REG, 0x00); /* disable */
1242 sscape_write_unsafe(sscape->io_base, GA_SMCFGA_REG, 0x2e);
1243 sscape_write_unsafe(sscape->io_base, GA_SMCFGB_REG, 0x00);
1246 * Enable and configure the DMA channels ...
1248 sscape_write_unsafe(sscape->io_base, GA_DMACFG_REG, 0x50);
1249 dma_cfg = (sscape->ic_type == IC_ODIE ? 0x70 : 0x40);
1250 sscape_write_unsafe(sscape->io_base, GA_DMAA_REG, dma_cfg);
1251 sscape_write_unsafe(sscape->io_base, GA_DMAB_REG, 0x20);
1253 sscape_write_unsafe(sscape->io_base,
1254 GA_INTCFG_REG, 0xf0 | (mpu_irq_cfg << 2) | mpu_irq_cfg);
1255 sscape_write_unsafe(sscape->io_base,
1256 GA_CDCFG_REG, 0x09 | DMA_8BIT | (params->dma1 << 4) | (irq_cfg << 1));
1258 spin_unlock_irqrestore(&sscape->lock, flags);
1261 * We have now enabled the codec chip, and so we should
1262 * detect the AD1845 device ...
1264 if ((err = create_ad1845(card, CODEC_IO(params->port), params->irq, params->dma1)) < 0) {
1265 printk(KERN_ERR "sscape: No AD1845 device at 0x%x, IRQ %d\n",
1266 CODEC_IO(params->port), params->irq);
1269 #define MIDI_DEVNUM 0
1270 if ((err = create_mpu401(card, MIDI_DEVNUM, MPU401_IO(params->port), params->mpu_irq)) < 0) {
1271 printk(KERN_ERR "sscape: Failed to create MPU-401 device at 0x%x\n",
1272 MPU401_IO(params->port));
1277 * Enable the master IRQ ...
1279 sscape_write(sscape, GA_INTENA_REG, 0x80);
1281 if ((err = snd_card_register(card)) < 0) {
1282 printk(KERN_ERR "sscape: Failed to register sound card\n");
1289 sscape->midi_vol = 0;
1290 host_write_ctrl_unsafe(sscape->io_base, CMD_SET_MIDI_VOL, 100);
1291 host_write_ctrl_unsafe(sscape->io_base, 0, 100);
1292 host_write_ctrl_unsafe(sscape->io_base, CMD_XXX_MIDI_VOL, 100);
1295 * Now that we have successfully created this sound card,
1296 * it is safe to store the pointer.
1297 * NOTE: we only register the sound card's "destructor"
1298 * function now that our "constructor" has completed.
1300 card->private_free = soundscape_free;
1306 snd_card_free(card);
1309 free_dma(params->dma1);
1312 release_resource(io_res);
1313 kfree_nocheck(io_res);
1319 static int sscape_cards __devinitdata;
1320 static struct params sscape_params[SNDRV_CARDS] __devinitdata;
1323 static inline int __devinit get_next_autoindex(int i)
1325 while ((i < SNDRV_CARDS) && (port[i] != SNDRV_AUTO_PORT)) {
1333 static inline int __devinit is_port_known(unsigned io, struct params *params, int cards)
1335 while (--cards >= 0) {
1336 if (params[cards].port == io)
1343 static int __devinit sscape_pnp_detect(struct pnp_card_link *pcard,
1344 const struct pnp_card_device_id *pid)
1346 struct pnp_dev *dev;
1351 * Allow this function to fail *quietly* if all the ISA PnP
1352 * devices were configured using module parameters instead.
1354 if ((idx = get_next_autoindex(idx)) >= SNDRV_CARDS) {
1359 * We have found a candidate ISA PnP card. Now we
1360 * have to check that it has the devices that we
1361 * expect it to have.
1363 * We will NOT try and autoconfigure all of the resources
1364 * needed and then activate the card as we are assuming that
1365 * has already been done at boot-time using /proc/isapnp.
1366 * We shall simply try to give each active card the resources
1367 * that it wants. This is a sensible strategy for a modular
1368 * system where unused modules are unloaded regularly.
1370 * This strategy is utterly useless if we compile the driver
1371 * into the kernel, of course.
1373 // printk(KERN_INFO "sscape: %s\n", card->name);
1376 * Check that we still have room for another sound card ...
1378 if (sscape_cards >= SNDRV_CARDS) {
1379 printk(KERN_ERR "sscape: No room for another ALSA device\n");
1385 dev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
1387 struct params *this;
1388 if (!pnp_is_active(dev)) {
1389 if (pnp_activate_dev(dev) < 0) {
1390 printk(KERN_INFO "sscape: device is inactive\n");
1395 * Read the correct parameters off the ISA PnP bus ...
1397 this = init_params(&sscape_params[sscape_cards],
1400 pnp_port_start(dev, 0),
1406 * Do we know about this sound card already?
1408 if ( !is_port_known(this->port, sscape_params, sscape_cards) ) {
1411 ret = create_sscape(this, &card);
1414 snd_card_set_dev(card, &pcard->card->dev);
1415 pnp_set_card_drvdata(pcard, card);
1424 static void __devexit sscape_pnp_remove(struct pnp_card_link * pcard)
1426 snd_card_t *card = (snd_card_t *) pnp_get_card_drvdata(pcard);
1428 pnp_set_card_drvdata(pcard, NULL);
1429 snd_card_disconnect(card);
1430 snd_card_free_in_thread(card);
1433 static struct pnp_card_driver sscape_pnpc_driver = {
1434 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1436 .id_table = sscape_pnpids,
1437 .probe = sscape_pnp_detect,
1438 .remove = __devexit_p(sscape_pnp_remove),
1441 #endif /* CONFIG_PNP */
1443 static int __init sscape_manual_probe(struct params *params)
1449 for (i = 0; i < SNDRV_CARDS; ++i) {
1451 * We do NOT probe for ports.
1452 * If we're not given a port number for this
1453 * card then we completely ignore this line
1456 if (port[i] == SNDRV_AUTO_PORT)
1460 * Make sure we were given ALL of the other parameters.
1462 if ( (irq[i] == SNDRV_AUTO_IRQ) ||
1463 (mpu_irq[i] == SNDRV_AUTO_IRQ) ||
1464 (dma[i] == SNDRV_AUTO_DMA) ) {
1466 "sscape: insufficient parameters, need IO, IRQ, MPU-IRQ and DMA\n");
1471 * This cards looks OK ...
1473 init_params(params, index[i], id[i], port[i], irq[i], mpu_irq[i], dma[i]);
1475 ret = create_sscape(params, &card);
1479 sscape_card[sscape_cards] = card;
1488 static void sscape_exit(void)
1493 pnp_unregister_card_driver(&sscape_pnpc_driver);
1495 for (i = 0; i < ARRAY_SIZE(sscape_card); ++i) {
1496 snd_card_free(sscape_card[i]);
1501 static int __init sscape_init(void)
1506 * First check whether we were passed any parameters.
1507 * These MUST take precedence over ANY automatic way
1508 * of allocating cards, because the operator is
1509 * S-P-E-L-L-I-N-G it out for us...
1511 ret = sscape_manual_probe(sscape_params);
1514 for (i = 0; i < sscape_cards; ++i)
1515 snd_card_free(sscape_card[i]);
1520 if (sscape_cards < SNDRV_CARDS) {
1521 ret = pnp_register_card_driver(&sscape_pnpc_driver);
1532 module_init(sscape_init);
1533 module_exit(sscape_exit);
1537 /* format is: snd-sscape=index,id,port,irq,mpu_irq,dma */
1539 static int __init builtin_sscape_setup(char *str)
1541 static unsigned __initdata nr_dev;
1543 if (nr_dev >= SNDRV_CARDS)
1546 (void)((get_option(&str, &index[nr_dev]) == 2) &&
1547 (get_id(&str, &id[nr_dev]) == 2) &&
1548 (get_option_long(&str, &port[nr_dev]) == 2) &&
1549 (get_option(&str, &irq[nr_dev]) == 2) &&
1550 (get_option(&str, &mpu_irq[nr_dev]) == 2) &&
1551 (get_option(&str, &dma[nr_dev]) == 2));
1557 __setup("snd-sscape=", builtin_sscape_setup);