[ALSA] AC97 bus interface for ad-hoc drivers

AC97 Codec,PCI drivers
I've made the review changes and as requested I've pasted the RFC by
Nicolas below:-

'I would like to know what people think of the following patch.  It
allows for a codec on an AC97 bus to be shared with other drivers which
are completely unrelated to audio.  It registers a new bus type, and
whenever a codec instance is created then a device for it is also
registered with the driver model using that bus type.  This allows, for
example, to use the extra features of the UCB1400 like the touchscreen
interface and the additional GPIOs and ADCs available on that chip for
battery monitoring.  I have a working UCB1400 touchscreen driver here
that simply registers with the driver model happily working alongside
with audio features using this.'

Changes over RFC:-

  o Now matches codec name within codec group.
  o Added ac97_dev_release() to stop kernel complaining about no release
method for device.
  o Added 'config SND_AC97_BUS' to sound/pci/Kconfig and moved 'config
SND_AC97_CODEC' out with the PCI=n statement.
  o module is now called snd-ac97-bus

Signed-off-by: Liam Girdwood <liam.girdwood@wolfsonmicro.com>
Signed-off-by: Nicolas Pitre <nico@cam.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>

5 files changed, 129 insertions, 3 deletions

diff --git a/include/sound/ac97_codec.h b/include/sound/ac97_codec.h
index cbe72e06c469..2857cf0472df 100644
--- a/include/sound/ac97_codec.h
+++ b/include/sound/ac97_codec.h
@@ -26,6 +26,7 @@
  */
 
 #include <linux/bitops.h>
+#include <linux/device.h>
 #include "pcm.h"
 #include "control.h"
 #include "info.h"
@@ -523,6 +524,7 @@ struct _snd_ac97 {
         /* jack-sharing info */
         unsigned char indep_surround;
         unsigned char channel_mode;
+        struct device dev;
 };
 
 /* conditions */
@@ -602,4 +604,8 @@ struct ac97_enum {
         unsigned short mask;
         const char **texts;
 };
+
+/* ad hoc AC97 device driver access */
+extern struct bus_type ac97_bus_type;
+
 #endif /* __SOUND_AC97_CODEC_H */
diff --git a/sound/pci/Kconfig b/sound/pci/Kconfig
index 26b42bb20a0a..1e458919cce6 100644
--- a/sound/pci/Kconfig
+++ b/sound/pci/Kconfig
@@ -1,11 +1,15 @@
 # ALSA PCI drivers
 
-menu "PCI devices"
-        depends on SND!=n && PCI
-
 config SND_AC97_CODEC
         tristate
         select SND_PCM
+        select SND_AC97_BUS
+
+config SND_AC97_BUS
+        tristate
+
+menu "PCI devices"
+        depends on SND!=n && PCI
 
 config SND_ALI5451
         tristate "ALi M5451 PCI Audio Controller"
diff --git a/sound/pci/ac97/Makefile b/sound/pci/ac97/Makefile
index 3c3222122d8b..77b3482cb133 100644
--- a/sound/pci/ac97/Makefile
+++ b/sound/pci/ac97/Makefile
@@ -10,9 +10,11 @@ snd-ac97-codec-objs += ac97_proc.o
 endif
 
 snd-ak4531-codec-objs := ak4531_codec.o
+snd-ac97-bus-objs := ac97_bus.o
 
 # Toplevel Module Dependency
 obj-$(CONFIG_SND_AC97_CODEC) += snd-ac97-codec.o
 obj-$(CONFIG_SND_ENS1370) += snd-ak4531-codec.o
+obj-$(CONFIG_SND_AC97_BUS) += snd-ac97-bus.o
 
 obj-m := $(sort $(obj-m))
diff --git a/sound/pci/ac97/ac97_bus.c b/sound/pci/ac97/ac97_bus.c
new file mode 100644
index 000000000000..227f8b9f67ce
--- /dev/null
+++ b/sound/pci/ac97/ac97_bus.c
@@ -0,0 +1,79 @@
+/*
+ * Linux driver model AC97 bus interface
+ *
+ * Author:      Nicolas Pitre
+ * Created:     Jan 14, 2005
+ * Copyright:   (C) MontaVista Software Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ */
+
+#include <linux/module.h>
+#include <linux/init.h>
+#include <linux/device.h>
+#include <linux/string.h>
+
+/*
+ * Codec families have names seperated by commas, so we search for an
+ * individual codec name within the family string. 
+ */
+static int ac97_bus_match(struct device *dev, struct device_driver *drv)
+{
+        return (strstr(dev->bus_id, drv->name) != NULL);
+}
+
+static int ac97_bus_suspend(struct device *dev, pm_message_t state)
+{
+        int ret = 0;
+
+        if (dev->driver && dev->driver->suspend) {
+                ret = dev->driver->suspend(dev, state, SUSPEND_DISABLE);
+                if (ret == 0)
+                        ret = dev->driver->suspend(dev, state, SUSPEND_SAVE_STATE);
+                if (ret == 0)
+                        ret = dev->driver->suspend(dev, state, SUSPEND_POWER_DOWN);
+        }
+        return ret;
+}
+
+static int ac97_bus_resume(struct device *dev)
+{
+        int ret = 0;
+
+        if (dev->driver && dev->driver->resume) {
+                ret = dev->driver->resume(dev, RESUME_POWER_ON);
+                if (ret == 0)
+                        ret = dev->driver->resume(dev, RESUME_RESTORE_STATE);
+                if (ret == 0)
+                        ret = dev->driver->resume(dev, RESUME_ENABLE);
+        }
+        return ret;
+}
+
+struct bus_type ac97_bus_type = {
+        .name           = "ac97",
+        .match          = ac97_bus_match,
+        .suspend        = ac97_bus_suspend,
+        .resume         = ac97_bus_resume,
+};
+
+static int __init ac97_bus_init(void)
+{
+        return bus_register(&ac97_bus_type);
+}
+
+subsys_initcall(ac97_bus_init);
+
+static void __exit ac97_bus_exit(void)
+{
+        bus_unregister(&ac97_bus_type);
+}
+
+module_exit(ac97_bus_exit);
+
+EXPORT_SYMBOL(ac97_bus_type);
+
+MODULE_LICENSE("GPL");
diff --git a/sound/pci/ac97/ac97_codec.c b/sound/pci/ac97/ac97_codec.c
index cbf790270c30..33dba10f03e8 100644
--- a/sound/pci/ac97/ac97_codec.c
+++ b/sound/pci/ac97/ac97_codec.c
@@ -1813,6 +1813,39 @@ int snd_ac97_bus(snd_card_t *card, int num, ac97_bus_ops_t *ops,
         return 0;
 }
 
+/* stop no dev release warning */
+static void ac97_device_release(struct device * dev)
+{
+}
+
+/* register ac97 codec to bus */
+static int snd_ac97_dev_register(snd_device_t *device)
+{
+        ac97_t *ac97 = device->device_data;
+        int err;
+
+        ac97->dev.bus = &ac97_bus_type;
+        ac97->dev.parent = ac97->bus->card->dev;
+        ac97->dev.platform_data = ac97;
+        ac97->dev.release = ac97_device_release;
+        strncpy(ac97->dev.bus_id, snd_ac97_get_short_name(ac97), BUS_ID_SIZE);
+        if ((err = device_register(&ac97->dev)) < 0) {
+                snd_printk(KERN_ERR "Can't register ac97 bus\n");
+                ac97->dev.bus = NULL;
+                return err;
+        }
+        return 0;
+}
+
+/* unregister ac97 codec */
+static int snd_ac97_dev_unregister(snd_device_t *device)
+{
+        ac97_t *ac97 = device->device_data;
+        if (ac97->dev.bus)
+                device_unregister(&ac97->dev);
+        return snd_ac97_free(ac97);
+}
+
 /* build_ops to do nothing */
 static struct snd_ac97_build_ops null_build_ops;
 
@@ -1846,6 +1879,8 @@ int snd_ac97_mixer(ac97_bus_t *bus, ac97_template_t *template, ac97_t **rac97)
         const ac97_codec_id_t *pid;
         static snd_device_ops_t ops = {
                 .dev_free =     snd_ac97_dev_free,
+                .dev_register = snd_ac97_dev_register,
+                .dev_unregister =       snd_ac97_dev_unregister,
         };
 
         snd_assert(rac97 != NULL, return -EINVAL);