[ALSA] add CMI8788 driver

Add the snd-oxygen driver for the C-Media CMI8788 (Oxygen) chip, used on
the Asound A-8788, AuzenTech X-Meridian, Bgears b-Enspirer,
Club3D Theatron DTS, HT-Omega Claro, Razer Barracuda AC-1,
Sondigo Inferno, and TempoTec HIFIER sound cards.

Signed-off-by: Clemens Ladisch <clemens@ladisch.de>
Signed-off-by: Jaroslav Kysela <perex@perex.cz>

1 files changed, 361 insertions, 0 deletions

diff --git a/sound/pci/oxygen/oxygen_lib.c b/sound/pci/oxygen/oxygen_lib.c
new file mode 100644
index 000000000000..6180cc858e60
--- /dev/null
+++ b/sound/pci/oxygen/oxygen_lib.c
@@ -0,0 +1,361 @@
+/*
+ * C-Media CMI8788 driver - main driver module
+ *
+ * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
+ *
+ *
+ *  This driver is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License, version 2.
+ *
+ *  This driver is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this driver; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+ */
+
+#include <sound/driver.h>
+#include <linux/delay.h>
+#include <linux/interrupt.h>
+#include <linux/mutex.h>
+#include <linux/pci.h>
+#include <sound/ac97_codec.h>
+#include <sound/asoundef.h>
+#include <sound/core.h>
+#include <sound/info.h>
+#include <sound/mpu401.h>
+#include <sound/pcm.h>
+#include "oxygen.h"
+
+MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
+MODULE_DESCRIPTION("C-Media CMI8788 helper library");
+MODULE_LICENSE("GPL");
+
+
+static irqreturn_t oxygen_interrupt(int dummy, void *dev_id)
+{
+        struct oxygen *chip = dev_id;
+        unsigned int status, clear, elapsed_streams, i;
+
+        status = oxygen_read16(chip, OXYGEN_INTERRUPT_STATUS);
+        if (!status)
+                return IRQ_NONE;
+
+        spin_lock(&chip->reg_lock);
+
+        clear = status & (OXYGEN_CHANNEL_A |
+                          OXYGEN_CHANNEL_B |
+                          OXYGEN_CHANNEL_C |
+                          OXYGEN_CHANNEL_SPDIF |
+                          OXYGEN_CHANNEL_MULTICH |
+                          OXYGEN_CHANNEL_AC97 |
+                          OXYGEN_INT_SPDIF_IN_CHANGE |
+                          OXYGEN_INT_GPIO);
+        if (clear) {
+                if (clear & OXYGEN_INT_SPDIF_IN_CHANGE)
+                        chip->interrupt_mask &= ~OXYGEN_INT_SPDIF_IN_CHANGE;
+                oxygen_write16(chip, OXYGEN_INTERRUPT_MASK,
+                               chip->interrupt_mask & ~clear);
+                oxygen_write16(chip, OXYGEN_INTERRUPT_MASK,
+                               chip->interrupt_mask);
+        }
+
+        elapsed_streams = status & chip->pcm_running;
+
+        spin_unlock(&chip->reg_lock);
+
+        for (i = 0; i < PCM_COUNT; ++i)
+                if ((elapsed_streams & (1 << i)) && chip->streams[i])
+                        snd_pcm_period_elapsed(chip->streams[i]);
+
+        if (status & OXYGEN_INT_SPDIF_IN_CHANGE) {
+                spin_lock(&chip->reg_lock);
+                i = oxygen_read32(chip, OXYGEN_SPDIF_CONTROL);
+                if (i & OXYGEN_SPDIF_IN_CHANGE) {
+                        oxygen_write32(chip, OXYGEN_SPDIF_CONTROL, i);
+                        schedule_work(&chip->spdif_input_bits_work);
+                }
+                spin_unlock(&chip->reg_lock);
+        }
+
+        if (status & OXYGEN_INT_GPIO)
+                ;
+
+        if ((status & OXYGEN_INT_MIDI) && chip->midi)
+                snd_mpu401_uart_interrupt(0, chip->midi->private_data);
+
+        return IRQ_HANDLED;
+}
+
+static void oxygen_spdif_input_bits_changed(struct work_struct *work)
+{
+        struct oxygen *chip = container_of(work, struct oxygen,
+                                           spdif_input_bits_work);
+
+        spin_lock_irq(&chip->reg_lock);
+        oxygen_clear_bits32(chip, OXYGEN_SPDIF_CONTROL, OXYGEN_SPDIF_IN_INVERT);
+        spin_unlock_irq(&chip->reg_lock);
+        msleep(1);
+        if (!(oxygen_read32(chip, OXYGEN_SPDIF_CONTROL)
+              & OXYGEN_SPDIF_IN_VALID)) {
+                spin_lock_irq(&chip->reg_lock);
+                oxygen_set_bits32(chip, OXYGEN_SPDIF_CONTROL,
+                                  OXYGEN_SPDIF_IN_INVERT);
+                spin_unlock_irq(&chip->reg_lock);
+                msleep(1);
+                if (!(oxygen_read32(chip, OXYGEN_SPDIF_CONTROL)
+                      & OXYGEN_SPDIF_IN_VALID)) {
+                        spin_lock_irq(&chip->reg_lock);
+                        oxygen_clear_bits32(chip, OXYGEN_SPDIF_CONTROL,
+                                            OXYGEN_SPDIF_IN_INVERT);
+                        spin_unlock_irq(&chip->reg_lock);
+                }
+        }
+
+        if (chip->spdif_input_bits_ctl) {
+                spin_lock_irq(&chip->reg_lock);
+                chip->interrupt_mask |= OXYGEN_INT_SPDIF_IN_CHANGE;
+                oxygen_write16(chip, OXYGEN_INTERRUPT_MASK,
+                               chip->interrupt_mask);
+                spin_unlock_irq(&chip->reg_lock);
+
+                snd_ctl_notify(chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
+                               &chip->spdif_input_bits_ctl->id);
+        }
+}
+
+#ifdef CONFIG_PROC_FS
+static void oxygen_proc_read(struct snd_info_entry *entry,
+                             struct snd_info_buffer *buffer)
+{
+        struct oxygen *chip = entry->private_data;
+        int i, j;
+
+        snd_iprintf(buffer, "CMI8788\n\n");
+        for (i = 0; i < 0x100; i += 0x10) {
+                snd_iprintf(buffer, "%02x:", i);
+                for (j = 0; j < 0x10; ++j)
+                        snd_iprintf(buffer, " %02x", oxygen_read8(chip, i + j));
+                snd_iprintf(buffer, "\n");
+        }
+        if (mutex_lock_interruptible(&chip->mutex) < 0)
+                return;
+        snd_iprintf(buffer, "\nAC97\n");
+        for (i = 0; i < 0x80; i += 0x10) {
+                snd_iprintf(buffer, "%02x:", i);
+                for (j = 0; j < 0x10; j += 2)
+                        snd_iprintf(buffer, " %04x",
+                                    oxygen_read_ac97(chip, 0, i + j));
+                snd_iprintf(buffer, "\n");
+        }
+        mutex_unlock(&chip->mutex);
+}
+
+static void __devinit oxygen_proc_init(struct oxygen *chip)
+{
+        struct snd_info_entry *entry;
+
+        if (!snd_card_proc_new(chip->card, "cmi8788", &entry))
+                snd_info_set_text_ops(entry, chip, oxygen_proc_read);
+}
+#else
+#define oxygen_proc_init(chip)
+#endif
+
+static void __devinit oxygen_init(struct oxygen *chip)
+{
+        unsigned int i;
+
+        chip->dac_routing = 1;
+        for (i = 0; i < 8; ++i)
+                chip->dac_volume[i] = 0xff;
+        chip->spdif_playback_enable = 1;
+        chip->spdif_bits = OXYGEN_SPDIF_C | OXYGEN_SPDIF_ORIGINAL |
+                (IEC958_AES1_CON_PCM_CODER << OXYGEN_SPDIF_CATEGORY_SHIFT);
+        chip->spdif_pcm_bits = chip->spdif_bits;
+
+        if (oxygen_read8(chip, OXYGEN_REVISION) & OXYGEN_REVISION_2)
+                chip->revision = 2;
+        else
+                chip->revision = 1;
+
+        if (chip->revision == 1)
+                oxygen_set_bits8(chip, OXYGEN_MISC, OXYGEN_MISC_MAGIC);
+
+        oxygen_set_bits8(chip, OXYGEN_FUNCTION,
+                         OXYGEN_FUNCTION_RESET_CODEC |
+                         OXYGEN_FUNCTION_ENABLE_SPI_4_5);
+        oxygen_write16(chip, OXYGEN_I2S_MULTICH_FORMAT, 0x010a);
+        oxygen_write16(chip, OXYGEN_I2S_A_FORMAT, 0x010a);
+        oxygen_write16(chip, OXYGEN_I2S_B_FORMAT, 0x010a);
+        oxygen_write16(chip, OXYGEN_I2S_C_FORMAT, 0x010a);
+        oxygen_set_bits32(chip, OXYGEN_SPDIF_CONTROL, OXYGEN_SPDIF_MAGIC2);
+        oxygen_write32(chip, OXYGEN_SPDIF_OUTPUT_BITS, chip->spdif_bits);
+        oxygen_write16(chip, OXYGEN_PLAY_ROUTING, 0x6c00);
+        oxygen_write8(chip, OXYGEN_REC_ROUTING, 0x10);
+        oxygen_write8(chip, OXYGEN_ADC_MONITOR, 0x00);
+        oxygen_write8(chip, OXYGEN_A_MONITOR_ROUTING, 0xe4);
+
+        oxygen_write16(chip, OXYGEN_INTERRUPT_MASK, 0);
+        oxygen_write16(chip, OXYGEN_DMA_STATUS, 0);
+
+        oxygen_write8(chip, OXYGEN_AC97_INTERRUPT_MASK, 0x00);
+        oxygen_clear_bits16(chip, OXYGEN_AC97_OUT_CONFIG,
+                            OXYGEN_AC97_OUT_MAGIC3);
+        oxygen_set_bits16(chip, OXYGEN_AC97_IN_CONFIG,
+                          OXYGEN_AC97_IN_MAGIC3);
+        oxygen_write_ac97(chip, 0, AC97_RESET, 0);
+        msleep(1);
+        oxygen_ac97_set_bits(chip, 0, 0x70, 0x0300);
+        oxygen_ac97_set_bits(chip, 0, 0x64, 0x8043);
+        oxygen_ac97_set_bits(chip, 0, 0x62, 0x180f);
+        oxygen_write_ac97(chip, 0, AC97_MASTER, 0x0000);
+        oxygen_write_ac97(chip, 0, AC97_PC_BEEP, 0x8000);
+        oxygen_write_ac97(chip, 0, AC97_MIC, 0x8808);
+        oxygen_write_ac97(chip, 0, AC97_LINE, 0x0808);
+        oxygen_write_ac97(chip, 0, AC97_CD, 0x8808);
+        oxygen_write_ac97(chip, 0, AC97_VIDEO, 0x8808);
+        oxygen_write_ac97(chip, 0, AC97_AUX, 0x8808);
+        oxygen_write_ac97(chip, 0, AC97_REC_GAIN, 0x8000);
+        oxygen_write_ac97(chip, 0, AC97_CENTER_LFE_MASTER, 0x8080);
+        oxygen_write_ac97(chip, 0, AC97_SURROUND_MASTER, 0x8080);
+        oxygen_ac97_clear_bits(chip, 0, 0x72, 0x0001);
+        /* power down unused ADCs and DACs */
+        oxygen_ac97_set_bits(chip, 0, AC97_POWERDOWN,
+                             AC97_PD_PR0 | AC97_PD_PR1);
+        oxygen_ac97_set_bits(chip, 0, AC97_EXTENDED_STATUS,
+                             AC97_EA_PRI | AC97_EA_PRJ | AC97_EA_PRK);
+}
+
+static void oxygen_card_free(struct snd_card *card)
+{
+        struct oxygen *chip = card->private_data;
+
+        spin_lock_irq(&chip->reg_lock);
+        chip->interrupt_mask = 0;
+        chip->pcm_running = 0;
+        oxygen_write16(chip, OXYGEN_DMA_STATUS, 0);
+        oxygen_write16(chip, OXYGEN_INTERRUPT_MASK, 0);
+        spin_unlock_irq(&chip->reg_lock);
+        if (chip->irq >= 0) {
+                free_irq(chip->irq, chip);
+                synchronize_irq(chip->irq);
+        }
+        flush_scheduled_work();
+        chip->model->cleanup(chip);
+        mutex_destroy(&chip->mutex);
+        pci_release_regions(chip->pci);
+        pci_disable_device(chip->pci);
+}
+
+int __devinit oxygen_pci_probe(struct pci_dev *pci, int index, char *id,
+                               const struct oxygen_model *model)
+{
+        struct snd_card *card;
+        struct oxygen *chip;
+        int err;
+
+        card = snd_card_new(index, id, model->owner, sizeof *chip);
+        if (!card)
+                return -ENOMEM;
+
+        chip = card->private_data;
+        chip->card = card;
+        chip->pci = pci;
+        chip->irq = -1;
+        chip->model = model;
+        spin_lock_init(&chip->reg_lock);
+        mutex_init(&chip->mutex);
+        INIT_WORK(&chip->spdif_input_bits_work,
+                  oxygen_spdif_input_bits_changed);
+
+        err = pci_enable_device(pci);
+        if (err < 0)
+                goto err_card;
+
+        err = pci_request_regions(pci, model->chip);
+        if (err < 0) {
+                snd_printk(KERN_ERR "cannot reserve PCI resources\n");
+                goto err_pci_enable;
+        }
+
+        if (!(pci_resource_flags(pci, 0) & IORESOURCE_IO) ||
+            pci_resource_len(pci, 0) < 0x100) {
+                snd_printk(KERN_ERR "invalid PCI I/O range\n");
+                err = -ENXIO;
+                goto err_pci_regions;
+        }
+        chip->addr = pci_resource_start(pci, 0);
+
+        pci_set_master(pci);
+        snd_card_set_dev(card, &pci->dev);
+        card->private_free = oxygen_card_free;
+
+        oxygen_init(chip);
+        model->init(chip);
+
+        err = request_irq(pci->irq, oxygen_interrupt, IRQF_SHARED,
+                          model->chip, chip);
+        if (err < 0) {
+                snd_printk(KERN_ERR "cannot grab interrupt %d\n", pci->irq);
+                goto err_card;
+        }
+        chip->irq = pci->irq;
+
+        strcpy(card->driver, model->chip);
+        strcpy(card->shortname, model->shortname);
+        sprintf(card->longname, "%s (rev %u) at %#lx, irq %i",
+                model->longname, chip->revision, chip->addr, chip->irq);
+        strcpy(card->mixername, model->chip);
+        snd_component_add(card, model->chip);
+
+        err = oxygen_pcm_init(chip);
+        if (err < 0)
+                goto err_card;
+
+        err = oxygen_mixer_init(chip);
+        if (err < 0)
+                goto err_card;
+
+        if (oxygen_read8(chip, OXYGEN_MISC) & OXYGEN_MISC_MIDI) {
+                err = snd_mpu401_uart_new(card, 0, MPU401_HW_CMIPCI,
+                                          chip->addr + OXYGEN_MPU401,
+                                          MPU401_INFO_INTEGRATED, 0, 0,
+                                          &chip->midi);
+                if (err < 0)
+                        goto err_card;
+        }
+
+        oxygen_proc_init(chip);
+
+        spin_lock_irq(&chip->reg_lock);
+        chip->interrupt_mask |= OXYGEN_INT_SPDIF_IN_CHANGE;
+        oxygen_write16(chip, OXYGEN_INTERRUPT_MASK, chip->interrupt_mask);
+        spin_unlock_irq(&chip->reg_lock);
+
+        err = snd_card_register(card);
+        if (err < 0)
+                goto err_card;
+
+        pci_set_drvdata(pci, card);
+        return 0;
+
+err_pci_regions:
+        pci_release_regions(pci);
+err_pci_enable:
+        pci_disable_device(pci);
+err_card:
+        snd_card_free(card);
+        return err;
+}
+EXPORT_SYMBOL(oxygen_pci_probe);
+
+void __devexit oxygen_pci_remove(struct pci_dev *pci)
+{
+        snd_card_free(pci_get_drvdata(pci));
+        pci_set_drvdata(pci, NULL);
+}
+EXPORT_SYMBOL(oxygen_pci_remove);