[ALSA] add TempoTec HiFier driver

Add a driver for the MediaTek/TempoTec HiFier Fantasia sound card.

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

7 files changed, 276 insertions, 42 deletions

diff --git a/Documentation/sound/alsa/ALSA-Configuration.txt b/Documentation/sound/alsa/ALSA-Configuration.txt
index 07317da87bd1..67256bd431d6 100644
--- a/Documentation/sound/alsa/ALSA-Configuration.txt
+++ b/Documentation/sound/alsa/ALSA-Configuration.txt
@@ -1092,6 +1092,15 @@ Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
 
     See hdspm.txt for details.
 
+  Module snd-hifier
+  -----------------
+
+    Module for the MediaTek/TempoTec HiFier Fantasia sound card.
+
+    This module supports autoprobe and multiple cards.
+
+    Power management is _not_ supported.
+
   Module snd-ice1712
   ------------------
 
diff --git a/sound/pci/Kconfig b/sound/pci/Kconfig
index 10c36947517e..812085d521f1 100644
--- a/sound/pci/Kconfig
+++ b/sound/pci/Kconfig
@@ -647,6 +647,17 @@ config SND_HDSPM
           To compile this driver as a module, choose M here: the module
           will be called snd-hdspm.
 
+config SND_HIFIER
+        tristate "TempoTec HiFier Fantasia"
+        depends on SND
+        select SND_OXYGEN_LIB
+        help
+          Say Y here to include support for the MediaTek/TempoTec HiFier
+          Fantasia sound card.
+
+          To compile this driver as a module, choose M here: the module
+          will be called snd-hifier.
+
 config SND_ICE1712
         tristate "ICEnsemble ICE1712 (Envy24)"
         depends on SND
diff --git a/sound/pci/oxygen/Makefile b/sound/pci/oxygen/Makefile
index 98d5bc039aa6..4ba07d42fd1d 100644
--- a/sound/pci/oxygen/Makefile
+++ b/sound/pci/oxygen/Makefile
@@ -1,7 +1,9 @@
 snd-oxygen-lib-objs := oxygen_io.o oxygen_lib.o oxygen_mixer.o oxygen_pcm.o
+snd-hifier-objs := hifier.o
 snd-oxygen-objs := oxygen.o
 snd-virtuoso-objs := virtuoso.o
 
 obj-$(CONFIG_SND_OXYGEN_LIB) += snd-oxygen-lib.o
+obj-$(CONFIG_SND_HIFIER) += snd-hifier.o
 obj-$(CONFIG_SND_OXYGEN) += snd-oxygen.o
 obj-$(CONFIG_SND_VIRTUOSO) += snd-virtuoso.o
diff --git a/sound/pci/oxygen/ak4396.h b/sound/pci/oxygen/ak4396.h
new file mode 100644
index 000000000000..551c1cf8e2e0
--- /dev/null
+++ b/sound/pci/oxygen/ak4396.h
@@ -0,0 +1,44 @@
+#ifndef AK4396_H_INCLUDED
+#define AK4396_H_INCLUDED
+
+#define AK4396_WRITE            0x2000
+
+#define AK4396_CONTROL_1        0
+#define AK4396_CONTROL_2        1
+#define AK4396_CONTROL_3        2
+#define AK4396_LCH_ATT          3
+#define AK4396_RCH_ATT          4
+
+/* control 1 */
+#define AK4396_RSTN             0x01
+#define AK4396_DIF_MASK         0x0e
+#define AK4396_DIF_16_LSB       0x00
+#define AK4396_DIF_20_LSB       0x02
+#define AK4396_DIF_24_MSB       0x04
+#define AK4396_DIF_24_I2S       0x06
+#define AK4396_DIF_24_LSB       0x08
+#define AK4396_ACKS             0x80
+/* control 2 */
+#define AK4396_SMUTE            0x01
+#define AK4396_DEM_MASK         0x06
+#define AK4396_DEM_441          0x00
+#define AK4396_DEM_OFF          0x02
+#define AK4396_DEM_48           0x04
+#define AK4396_DEM_32           0x06
+#define AK4396_DFS_MASK         0x18
+#define AK4396_DFS_NORMAL       0x00
+#define AK4396_DFS_DOUBLE       0x08
+#define AK4396_DFS_QUAD         0x10
+#define AK4396_SLOW             0x20
+#define AK4396_DZFM             0x40
+#define AK4396_DZFE             0x80
+/* control 3 */
+#define AK4396_DZFB             0x04
+#define AK4396_DCKB             0x10
+#define AK4396_DCKS             0x20
+#define AK4396_DSDM             0x40
+#define AK4396_D_P_MASK         0x80
+#define AK4396_PCM              0x00
+#define AK4396_DSD              0x80
+
+#endif
diff --git a/sound/pci/oxygen/hifier.c b/sound/pci/oxygen/hifier.c
new file mode 100644
index 000000000000..05ea2b65843e
--- /dev/null
+++ b/sound/pci/oxygen/hifier.c
@@ -0,0 +1,207 @@
+/*
+ * C-Media CMI8788 driver for the MediaTek/TempoTec HiFier Fantasia
+ *
+ * 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 <linux/pci.h>
+#include <sound/control.h>
+#include <sound/core.h>
+#include <sound/initval.h>
+#include <sound/pcm.h>
+#include <sound/tlv.h>
+#include "oxygen.h"
+#include "ak4396.h"
+
+MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
+MODULE_DESCRIPTION("TempoTec HiFier driver");
+MODULE_LICENSE("GPL");
+
+static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
+static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
+static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
+
+module_param_array(index, int, NULL, 0444);
+MODULE_PARM_DESC(index, "card index");
+module_param_array(id, charp, NULL, 0444);
+MODULE_PARM_DESC(id, "ID string");
+module_param_array(enable, bool, NULL, 0444);
+MODULE_PARM_DESC(enable, "enable card");
+
+static struct pci_device_id hifier_ids[] __devinitdata = {
+        { OXYGEN_PCI_SUBID(0x14c3, 0x1710) },
+        { OXYGEN_PCI_SUBID(0x14c3, 0x1711) },
+        { }
+};
+MODULE_DEVICE_TABLE(pci, hifier_ids);
+
+struct hifier_data {
+        u8 ak4396_ctl2;
+};
+
+static void ak4396_write(struct oxygen *chip, u8 reg, u8 value)
+{
+        oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER  |
+                         OXYGEN_SPI_DATA_LENGTH_2 |
+                         OXYGEN_SPI_CLOCK_320 |
+                         (0 << OXYGEN_SPI_CODEC_SHIFT) |
+                         OXYGEN_SPI_CEN_LATCH_CLOCK_HI,
+                         AK4396_WRITE | (reg << 8) | value);
+}
+
+static void hifier_init(struct oxygen *chip)
+{
+        struct hifier_data *data = chip->model_data;
+
+        data->ak4396_ctl2 = AK4396_DEM_OFF | AK4396_DFS_NORMAL;
+        ak4396_write(chip, AK4396_CONTROL_1, AK4396_DIF_24_MSB | AK4396_RSTN);
+        ak4396_write(chip, AK4396_CONTROL_2, data->ak4396_ctl2);
+        ak4396_write(chip, AK4396_CONTROL_3, AK4396_PCM);
+        ak4396_write(chip, AK4396_LCH_ATT, 0xff);
+        ak4396_write(chip, AK4396_RCH_ATT, 0xff);
+
+        snd_component_add(chip->card, "AK4396");
+        snd_component_add(chip->card, "CS5340");
+}
+
+static void hifier_cleanup(struct oxygen *chip)
+{
+}
+
+static void set_ak4396_params(struct oxygen *chip,
+                               struct snd_pcm_hw_params *params)
+{
+        struct hifier_data *data = chip->model_data;
+        u8 value;
+
+        value = data->ak4396_ctl2 & ~AK4396_DFS_MASK;
+        if (params_rate(params) <= 54000)
+                value |= AK4396_DFS_NORMAL;
+        else if (params_rate(params) < 120000)
+                value |= AK4396_DFS_DOUBLE;
+        else
+                value |= AK4396_DFS_QUAD;
+        data->ak4396_ctl2 = value;
+        ak4396_write(chip, AK4396_CONTROL_1, AK4396_DIF_24_MSB);
+        ak4396_write(chip, AK4396_CONTROL_2, value);
+        ak4396_write(chip, AK4396_CONTROL_1, AK4396_DIF_24_MSB | AK4396_RSTN);
+}
+
+static void update_ak4396_volume(struct oxygen *chip)
+{
+        ak4396_write(chip, AK4396_LCH_ATT, chip->dac_volume[0]);
+        ak4396_write(chip, AK4396_RCH_ATT, chip->dac_volume[1]);
+}
+
+static void update_ak4396_mute(struct oxygen *chip)
+{
+        struct hifier_data *data = chip->model_data;
+        u8 value;
+
+        value = data->ak4396_ctl2 & ~AK4396_SMUTE;
+        if (chip->dac_mute)
+                value |= AK4396_SMUTE;
+        data->ak4396_ctl2 = value;
+        ak4396_write(chip, AK4396_CONTROL_2, value);
+}
+
+static void set_cs5340_params(struct oxygen *chip,
+                              struct snd_pcm_hw_params *params)
+{
+}
+
+static const DECLARE_TLV_DB_LINEAR(ak4396_db_scale, TLV_DB_GAIN_MUTE, 0);
+
+static int hifier_control_filter(struct snd_kcontrol_new *template)
+{
+        if (!strcmp(template->name, "Master Playback Volume")) {
+                template->access |= SNDRV_CTL_ELEM_ACCESS_TLV_READ;
+                template->tlv.p = ak4396_db_scale;
+        } else if (!strcmp(template->name, "Stereo Upmixing")) {
+                return 1; /* stereo only - we don't need upmixing */
+        } else if (!strcmp(template->name,
+                           SNDRV_CTL_NAME_IEC958("", CAPTURE, MASK)) ||
+                   !strcmp(template->name,
+                           SNDRV_CTL_NAME_IEC958("", CAPTURE, DEFAULT))) {
+                return 1; /* no digital input */
+        }
+        return 0;
+}
+
+static int hifier_mixer_init(struct oxygen *chip)
+{
+        return 0;
+}
+
+static const struct oxygen_model model_hifier = {
+        .shortname = "C-Media CMI8787",
+        .longname = "C-Media Oxygen HD Audio",
+        .chip = "CMI8788",
+        .init = hifier_init,
+        .control_filter = hifier_control_filter,
+        .mixer_init = hifier_mixer_init,
+        .cleanup = hifier_cleanup,
+        .set_dac_params = set_ak4396_params,
+        .set_adc_params = set_cs5340_params,
+        .update_dac_volume = update_ak4396_volume,
+        .update_dac_mute = update_ak4396_mute,
+        .model_data_size = sizeof(struct hifier_data),
+        .dac_channels = 2,
+        .used_channels = OXYGEN_CHANNEL_A |
+                         OXYGEN_CHANNEL_SPDIF |
+                         OXYGEN_CHANNEL_MULTICH,
+        .function_flags = 0,
+        .dac_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
+        .adc_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
+};
+
+static int __devinit hifier_probe(struct pci_dev *pci,
+                                  const struct pci_device_id *pci_id)
+{
+        static int dev;
+        int err;
+
+        if (dev >= SNDRV_CARDS)
+                return -ENODEV;
+        if (!enable[dev]) {
+                ++dev;
+                return -ENOENT;
+        }
+        err = oxygen_pci_probe(pci, index[dev], id[dev], 0, &model_hifier);
+        if (err >= 0)
+                ++dev;
+        return err;
+}
+
+static struct pci_driver hifier_driver = {
+        .name = "CMI8787HiFier",
+        .id_table = hifier_ids,
+        .probe = hifier_probe,
+        .remove = __devexit_p(oxygen_pci_remove),
+};
+
+static int __init alsa_card_hifier_init(void)
+{
+        return pci_register_driver(&hifier_driver);
+}
+
+static void __exit alsa_card_hifier_exit(void)
+{
+        pci_unregister_driver(&hifier_driver);
+}
+
+module_init(alsa_card_hifier_init)
+module_exit(alsa_card_hifier_exit)
diff --git a/sound/pci/oxygen/oxygen.c b/sound/pci/oxygen/oxygen.c
index 60af3a7d9824..a0457a570946 100644
--- a/sound/pci/oxygen/oxygen.c
+++ b/sound/pci/oxygen/oxygen.c
@@ -36,6 +36,7 @@
 #include <sound/pcm_params.h>
 #include <sound/tlv.h>
 #include "oxygen.h"
+#include "ak4396.h"
 
 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
 MODULE_DESCRIPTION("C-Media CMI8788 driver");
@@ -61,8 +62,6 @@ static struct pci_device_id oxygen_ids[] __devinitdata = {
         { OXYGEN_PCI_SUBID(0x13f6, 0x0010) },
         { OXYGEN_PCI_SUBID(0x13f6, 0x8788) },
         { OXYGEN_PCI_SUBID(0x147a, 0xa017) },
-        { OXYGEN_PCI_SUBID(0x14c3, 0x1710) },
-        { OXYGEN_PCI_SUBID(0x14c3, 0x1711) },
         { OXYGEN_PCI_SUBID(0x1a58, 0x0910) },
         { OXYGEN_PCI_SUBID(0x415a, 0x5431), .driver_data = 1 },
         { OXYGEN_PCI_SUBID(0x7284, 0x9761) },
@@ -76,46 +75,6 @@ MODULE_DEVICE_TABLE(pci, oxygen_ids);
 #define GPIO_AK5385_DFS_DOUBLE  0x0001
 #define GPIO_AK5385_DFS_QUAD    0x0002
 
-#define AK4396_WRITE    0x2000
-
-#define AK4396_CONTROL_1        0
-#define AK4396_CONTROL_2        1
-#define AK4396_CONTROL_3        2
-#define AK4396_LCH_ATT          3
-#define AK4396_RCH_ATT          4
-
-/* control 1 */
-#define AK4396_RSTN             0x01
-#define AK4396_DIF_MASK         0x0e
-#define AK4396_DIF_16_LSB       0x00
-#define AK4396_DIF_20_LSB       0x02
-#define AK4396_DIF_24_MSB       0x04
-#define AK4396_DIF_24_I2S       0x06
-#define AK4396_DIF_24_LSB       0x08
-#define AK4396_ACKS             0x80
-/* control 2 */
-#define AK4396_SMUTE            0x01
-#define AK4396_DEM_MASK         0x06
-#define AK4396_DEM_441          0x00
-#define AK4396_DEM_OFF          0x02
-#define AK4396_DEM_48           0x04
-#define AK4396_DEM_32           0x06
-#define AK4396_DFS_MASK         0x18
-#define AK4396_DFS_NORMAL       0x00
-#define AK4396_DFS_DOUBLE       0x08
-#define AK4396_DFS_QUAD         0x10
-#define AK4396_SLOW             0x20
-#define AK4396_DZFM             0x40
-#define AK4396_DZFE             0x80
-/* control 3 */
-#define AK4396_DZFB             0x04
-#define AK4396_DCKB             0x10
-#define AK4396_DCKS             0x20
-#define AK4396_DSDM             0x40
-#define AK4396_D_P_MASK         0x80
-#define AK4396_PCM              0x00
-#define AK4396_DSD              0x80
-
 #define WM8785_R0       0
 #define WM8785_R1       1
 #define WM8785_R2       2
diff --git a/sound/pci/oxygen/oxygen_mixer.c b/sound/pci/oxygen/oxygen_mixer.c
index 21b227a94ace..fe53318e94e0 100644
--- a/sound/pci/oxygen/oxygen_mixer.c
+++ b/sound/pci/oxygen/oxygen_mixer.c
@@ -712,6 +712,8 @@ static int add_controls(struct oxygen *chip,
                 err = chip->model->control_filter(&template);
                 if (err < 0)
                         return err;
+                if (err == 1)
+                        continue;
                 ctl = snd_ctl_new1(&template, chip);
                 if (!ctl)
                         return -ENOMEM;