ALSA: Add jack reporting API

Currently very few systems provide information about jack status to user
space, even though many have hardware facilities to do detection. Those
systems that do use an input device with the existing SW_HEADPHONE_INSERT
switch type to do so, often independently of ALSA.

This patch introduces a standard method for representing jacks to user
space into ALSA. It allows drivers to register jacks for a sound card with
the input subsystem, binding the input device to the card to help user
space associate the input devices with their sound cards. The created
input devices are named in the form "card longname jack" where jack is
provided by the driver when allocating a jack. By default the parent for
the input device is the sound card but this can be overridden by the
card driver.

The existing user space API with SW_HEADPHONE_INSERT is preserved.

Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
Signed-off-by: Jaroslav Kysela <perex@perex.cz>

3 files changed, 239 insertions, 0 deletions

diff --git a/include/sound/core.h b/include/sound/core.h
index 558b96284bd2..1a4ff0bdcf6a 100644
--- a/include/sound/core.h
+++ b/include/sound/core.h
@@ -63,6 +63,7 @@ typedef int __bitwise snd_device_type_t;
 #define SNDRV_DEV_INFO          ((__force snd_device_type_t) 0x1006)
 #define SNDRV_DEV_BUS           ((__force snd_device_type_t) 0x1007)
 #define SNDRV_DEV_CODEC         ((__force snd_device_type_t) 0x1008)
+#define SNDRV_DEV_JACK          ((__force snd_device_type_t) 0x1009)
 #define SNDRV_DEV_LOWLEVEL      ((__force snd_device_type_t) 0x2000)
 
 typedef int __bitwise snd_device_state_t;
diff --git a/include/sound/jack.h b/include/sound/jack.h
new file mode 100644
index 000000000000..b1b2b8b59adb
--- /dev/null
+++ b/include/sound/jack.h
@@ -0,0 +1,75 @@
+#ifndef __SOUND_JACK_H
+#define __SOUND_JACK_H
+
+/*
+ *  Jack abstraction layer
+ *
+ *  Copyright 2008 Wolfson Microelectronics plc
+ *
+ *
+ *   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.
+ *
+ *   This program 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 program; if not, write to the Free Software
+ *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+ *
+ */
+
+#include <sound/core.h>
+
+struct input_dev;
+
+/**
+ * Jack types which can be reported.  These values are used as a
+ * bitmask.
+ */
+enum snd_jack_types {
+        SND_JACK_HEADPHONE      = 0x0001,
+        SND_JACK_MICROPHONE     = 0x0002,
+        SND_JACK_HEADSET        = SND_JACK_HEADPHONE | SND_JACK_MICROPHONE,
+};
+
+struct snd_jack {
+        struct input_dev *input_dev;
+        int registered;
+        int type;
+        const char *id;
+        char name[100];
+};
+
+#ifdef CONFIG_SND_JACK
+
+int snd_jack_new(struct snd_card *card, const char *id, int type,
+                 struct snd_jack **jack);
+void snd_jack_set_parent(struct snd_jack *jack, struct device *parent);
+
+void snd_jack_report(struct snd_jack *jack, int status);
+
+#else
+
+static inline int snd_jack_new(struct snd_card *card, const char *id, int type,
+                               struct snd_jack **jack)
+{
+        return 0;
+}
+
+static inline void snd_jack_set_parent(struct snd_jack *jack,
+                                       struct device *parent)
+{
+}
+
+static inline void snd_jack_report(struct snd_jack *jack, int status)
+{
+}
+
+#endif
+
+#endif
diff --git a/sound/core/jack.c b/sound/core/jack.c
new file mode 100644
index 000000000000..8133a2b173a5
--- /dev/null
+++ b/sound/core/jack.c
@@ -0,0 +1,163 @@
+/*
+ *  Jack abstraction layer
+ *
+ *  Copyright 2008 Wolfson Microelectronics
+ *
+ *   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.
+ *
+ *   This program 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 program; if not, write to the Free Software
+ *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+ *
+ */
+
+#include <linux/input.h>
+#include <sound/jack.h>
+#include <sound/core.h>
+
+static int snd_jack_dev_free(struct snd_device *device)
+{
+        struct snd_jack *jack = device->device_data;
+
+        /* If the input device is registered with the input subsystem
+         * then we need to use a different deallocator. */
+        if (jack->registered)
+                input_unregister_device(jack->input_dev);
+        else
+                input_free_device(jack->input_dev);
+
+        kfree(jack);
+
+        return 0;
+}
+
+static int snd_jack_dev_register(struct snd_device *device)
+{
+        struct snd_jack *jack = device->device_data;
+        struct snd_card *card = device->card;
+        int err;
+
+        snprintf(jack->name, sizeof(jack->name), "%s %s",
+                 card->longname, jack->id);
+        jack->input_dev->name = jack->name;
+
+        /* Default to the sound card device. */
+        if (!jack->input_dev->dev.parent)
+                jack->input_dev->dev.parent = card->dev;
+
+        err = input_register_device(jack->input_dev);
+        if (err == 0)
+                jack->registered = 1;
+
+        return err;
+}
+
+/**
+ * snd_jack_new - Create a new jack
+ * @card:  the card instance
+ * @id:    an identifying string for this jack
+ * @type:  a bitmask of enum snd_jack_type values that can be detected by
+ *         this jack
+ * @jjack: Used to provide the allocated jack object to the caller.
+ *
+ * Creates a new jack object.
+ *
+ * Returns zero if successful, or a negative error code on failure.
+ * On success jjack will be initialised.
+ */
+int snd_jack_new(struct snd_card *card, const char *id, int type,
+                 struct snd_jack **jjack)
+{
+        struct snd_jack *jack;
+        int err;
+        static struct snd_device_ops ops = {
+                .dev_free = snd_jack_dev_free,
+                .dev_register = snd_jack_dev_register,
+        };
+
+        jack = kzalloc(sizeof(struct snd_jack), GFP_KERNEL);
+        if (jack == NULL)
+                return -ENOMEM;
+
+        jack->id = id;
+
+        jack->input_dev = input_allocate_device();
+        if (jack->input_dev == NULL) {
+                err = -ENOMEM;
+                goto fail_input;
+        }
+
+        jack->input_dev->phys = "ALSA";
+
+        jack->type = type;
+
+        if (type & SND_JACK_HEADPHONE)
+                input_set_capability(jack->input_dev, EV_SW,
+                                     SW_HEADPHONE_INSERT);
+        if (type & SND_JACK_MICROPHONE)
+                input_set_capability(jack->input_dev, EV_SW,
+                                     SW_MICROPHONE_INSERT);
+
+        err = snd_device_new(card, SNDRV_DEV_JACK, jack, &ops);
+        if (err < 0)
+                goto fail_input;
+
+        *jjack = jack;
+
+        return 0;
+
+fail_input:
+        input_free_device(jack->input_dev);
+        kfree(jack);
+        return err;
+}
+EXPORT_SYMBOL(snd_jack_new);
+
+/**
+ * snd_jack_set_parent - Set the parent device for a jack
+ *
+ * @jack:   The jack to configure
+ * @parent: The device to set as parent for the jack.
+ *
+ * Set the parent for the jack input device in the device tree.  This
+ * function is only valid prior to registration of the jack.  If no
+ * parent is configured then the parent device will be the sound card.
+ */
+void snd_jack_set_parent(struct snd_jack *jack, struct device *parent)
+{
+        WARN_ON(jack->registered);
+
+        jack->input_dev->dev.parent = parent;
+}
+EXPORT_SYMBOL(snd_jack_set_parent);
+
+/**
+ * snd_jack_report - Report the current status of a jack
+ *
+ * @jack:   The jack to report status for
+ * @status: The current status of the jack
+ */
+void snd_jack_report(struct snd_jack *jack, int status)
+{
+        if (jack->type & SND_JACK_HEADPHONE)
+                input_report_switch(jack->input_dev, SW_HEADPHONE_INSERT,
+                                    status & SND_JACK_HEADPHONE);
+        if (jack->type & SND_JACK_MICROPHONE)
+                input_report_switch(jack->input_dev, SW_MICROPHONE_INSERT,
+                                    status & SND_JACK_MICROPHONE);
+
+        input_sync(jack->input_dev);
+}
+EXPORT_SYMBOL(snd_jack_report);
+
+MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
+MODULE_DESCRIPTION("Jack detection support for ALSA");
+MODULE_LICENSE("GPL");