ALSA: bebob: Add hwdep interface
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Fri, 25 Apr 2014 13:45:20 +0000 (22:45 +0900)
committerTakashi Iwai <tiwai@suse.de>
Mon, 26 May 2014 12:31:03 +0000 (14:31 +0200)
This interface is designed for mixer/control application. By using hwdep
interface, the application can get information about firewire node, can
lock/unlock kernel streaming and can get notification at starting/stopping
kernel streaming.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
include/uapi/sound/asound.h
include/uapi/sound/firewire.h
sound/firewire/Kconfig
sound/firewire/bebob/Makefile
sound/firewire/bebob/bebob.c
sound/firewire/bebob/bebob.h
sound/firewire/bebob/bebob_hwdep.c [new file with mode: 0644]
sound/firewire/bebob/bebob_midi.c
sound/firewire/bebob/bebob_pcm.c
sound/firewire/bebob/bebob_stream.c

index 5dfbfdfd2d1242d46e813d0e664552046126060b..224948342f141c81ce5751e40adf1cf66b956376 100644 (file)
@@ -95,9 +95,10 @@ enum {
        SNDRV_HWDEP_IFACE_USB_STREAM,   /* direct access to usb stream */
        SNDRV_HWDEP_IFACE_FW_DICE,      /* TC DICE FireWire device */
        SNDRV_HWDEP_IFACE_FW_FIREWORKS, /* Echo Audio Fireworks based device */
+       SNDRV_HWDEP_IFACE_FW_BEBOB,     /* BridgeCo BeBoB based device */
 
        /* Don't forget to change the following: */
-       SNDRV_HWDEP_IFACE_LAST = SNDRV_HWDEP_IFACE_FW_FIREWORKS
+       SNDRV_HWDEP_IFACE_LAST = SNDRV_HWDEP_IFACE_FW_BEBOB
 };
 
 struct snd_hwdep_info {
index bfc0e23e47a2832d5b25b43e9aee487597813d44..af4bd136c75d1fd47ef107c2d394486346ee360e 100644 (file)
@@ -54,6 +54,7 @@ union snd_firewire_event {
 
 #define SNDRV_FIREWIRE_TYPE_DICE       1
 #define SNDRV_FIREWIRE_TYPE_FIREWORKS  2
+#define SNDRV_FIREWIRE_TYPE_BEBOB      3
 /* AV/C, RME, MOTU, ... */
 
 struct snd_firewire_get_info {
index d55fd5fd16ca847852cddce473b8fa0d2f1251ac..21750649e14e35cc7a18b5fe36254f3cdbd9c8aa 100644 (file)
@@ -84,6 +84,7 @@ config SND_BEBOB
        select SND_FIREWIRE_LIB
        select SND_RAWMIDI
        select SND_PCM
+       select SND_HWDEP
         help
         Say Y here to include support for FireWire devices based
         on BridgeCo DM1000/DM1100/DM1500 with BeBoB firmware:
index 533718a5c1e5c3327a151c93865bbfaaf4626756..78087772a02243f5080e4568f1a39ae7e0b8c28c 100644 (file)
@@ -1,4 +1,4 @@
 snd-bebob-objs := bebob_command.o bebob_stream.o bebob_proc.o bebob_midi.o \
-                 bebob_pcm.o \
+                 bebob_pcm.o bebob_hwdep.o \
                  bebob.o
 obj-m += snd-bebob.o
index dbd12c36004662e376b1838d213970a83ac27728..b7d70c2e4e8710792c7a5f66bcad894c4ce98d7f 100644 (file)
@@ -153,6 +153,7 @@ bebob_probe(struct fw_unit *unit,
        bebob->unit = unit;
        mutex_init(&bebob->mutex);
        spin_lock_init(&bebob->lock);
+       init_waitqueue_head(&bebob->hwdep_wait);
 
        err = name_device(bebob, entry->vendor_id);
        if (err < 0)
@@ -175,6 +176,10 @@ bebob_probe(struct fw_unit *unit,
        if (err < 0)
                goto error;
 
+       err = snd_bebob_create_hwdep_device(bebob);
+       if (err < 0)
+               goto error;
+
        err = snd_bebob_stream_init_duplex(bebob);
        if (err < 0)
                goto error;
index b41bb913bac55910706125192012714e9b41b7cc..e8a5e447ff17a995e4744c1a561571d87dffc195 100644 (file)
@@ -24,6 +24,8 @@
 #include <sound/rawmidi.h>
 #include <sound/pcm.h>
 #include <sound/pcm_params.h>
+#include <sound/firewire.h>
+#include <sound/hwdep.h>
 
 #include "../lib.h"
 #include "../fcp.h"
@@ -75,6 +77,11 @@ struct snd_bebob {
                rx_stream_formations[SND_BEBOB_STRM_FMT_ENTRIES];
 
        int sync_input_plug;
+
+       /* for uapi */
+       int dev_lock_count;
+       bool dev_lock_changed;
+       wait_queue_head_t hwdep_wait;
 };
 
 static inline int
@@ -175,12 +182,18 @@ void snd_bebob_stream_stop_duplex(struct snd_bebob *bebob);
 void snd_bebob_stream_update_duplex(struct snd_bebob *bebob);
 void snd_bebob_stream_destroy_duplex(struct snd_bebob *bebob);
 
+void snd_bebob_stream_lock_changed(struct snd_bebob *bebob);
+int snd_bebob_stream_lock_try(struct snd_bebob *bebob);
+void snd_bebob_stream_lock_release(struct snd_bebob *bebob);
+
 void snd_bebob_proc_init(struct snd_bebob *bebob);
 
 int snd_bebob_create_midi_devices(struct snd_bebob *bebob);
 
 int snd_bebob_create_pcm_devices(struct snd_bebob *bebob);
 
+int snd_bebob_create_hwdep_device(struct snd_bebob *bebob);
+
 #define SND_BEBOB_DEV_ENTRY(vendor, model) \
 { \
        .match_flags    = IEEE1394_MATCH_VENDOR_ID | \
diff --git a/sound/firewire/bebob/bebob_hwdep.c b/sound/firewire/bebob/bebob_hwdep.c
new file mode 100644 (file)
index 0000000..ce731f4
--- /dev/null
@@ -0,0 +1,199 @@
+/*
+ * bebob_hwdep.c - a part of driver for BeBoB based devices
+ *
+ * Copyright (c) 2013-2014 Takashi Sakamoto
+ *
+ * Licensed under the terms of the GNU General Public License, version 2.
+ */
+
+/*
+ * This codes give three functionality.
+ *
+ * 1.get firewire node infomation
+ * 2.get notification about starting/stopping stream
+ * 3.lock/unlock stream
+ */
+
+#include "bebob.h"
+
+static long
+hwdep_read(struct snd_hwdep *hwdep, char __user *buf,  long count,
+          loff_t *offset)
+{
+       struct snd_bebob *bebob = hwdep->private_data;
+       DEFINE_WAIT(wait);
+       union snd_firewire_event event;
+
+       spin_lock_irq(&bebob->lock);
+
+       while (!bebob->dev_lock_changed) {
+               prepare_to_wait(&bebob->hwdep_wait, &wait, TASK_INTERRUPTIBLE);
+               spin_unlock_irq(&bebob->lock);
+               schedule();
+               finish_wait(&bebob->hwdep_wait, &wait);
+               if (signal_pending(current))
+                       return -ERESTARTSYS;
+               spin_lock_irq(&bebob->lock);
+       }
+
+       memset(&event, 0, sizeof(event));
+       if (bebob->dev_lock_changed) {
+               event.lock_status.type = SNDRV_FIREWIRE_EVENT_LOCK_STATUS;
+               event.lock_status.status = (bebob->dev_lock_count > 0);
+               bebob->dev_lock_changed = false;
+
+               count = min_t(long, count, sizeof(event.lock_status));
+       }
+
+       spin_unlock_irq(&bebob->lock);
+
+       if (copy_to_user(buf, &event, count))
+               return -EFAULT;
+
+       return count;
+}
+
+static unsigned int
+hwdep_poll(struct snd_hwdep *hwdep, struct file *file, poll_table *wait)
+{
+       struct snd_bebob *bebob = hwdep->private_data;
+       unsigned int events;
+
+       poll_wait(file, &bebob->hwdep_wait, wait);
+
+       spin_lock_irq(&bebob->lock);
+       if (bebob->dev_lock_changed)
+               events = POLLIN | POLLRDNORM;
+       else
+               events = 0;
+       spin_unlock_irq(&bebob->lock);
+
+       return events;
+}
+
+static int
+hwdep_get_info(struct snd_bebob *bebob, void __user *arg)
+{
+       struct fw_device *dev = fw_parent_device(bebob->unit);
+       struct snd_firewire_get_info info;
+
+       memset(&info, 0, sizeof(info));
+       info.type = SNDRV_FIREWIRE_TYPE_BEBOB;
+       info.card = dev->card->index;
+       *(__be32 *)&info.guid[0] = cpu_to_be32(dev->config_rom[3]);
+       *(__be32 *)&info.guid[4] = cpu_to_be32(dev->config_rom[4]);
+       strlcpy(info.device_name, dev_name(&dev->device),
+               sizeof(info.device_name));
+
+       if (copy_to_user(arg, &info, sizeof(info)))
+               return -EFAULT;
+
+       return 0;
+}
+
+static int
+hwdep_lock(struct snd_bebob *bebob)
+{
+       int err;
+
+       spin_lock_irq(&bebob->lock);
+
+       if (bebob->dev_lock_count == 0) {
+               bebob->dev_lock_count = -1;
+               err = 0;
+       } else {
+               err = -EBUSY;
+       }
+
+       spin_unlock_irq(&bebob->lock);
+
+       return err;
+}
+
+static int
+hwdep_unlock(struct snd_bebob *bebob)
+{
+       int err;
+
+       spin_lock_irq(&bebob->lock);
+
+       if (bebob->dev_lock_count == -1) {
+               bebob->dev_lock_count = 0;
+               err = 0;
+       } else {
+               err = -EBADFD;
+       }
+
+       spin_unlock_irq(&bebob->lock);
+
+       return err;
+}
+
+static int
+hwdep_release(struct snd_hwdep *hwdep, struct file *file)
+{
+       struct snd_bebob *bebob = hwdep->private_data;
+
+       spin_lock_irq(&bebob->lock);
+       if (bebob->dev_lock_count == -1)
+               bebob->dev_lock_count = 0;
+       spin_unlock_irq(&bebob->lock);
+
+       return 0;
+}
+
+static int
+hwdep_ioctl(struct snd_hwdep *hwdep, struct file *file,
+           unsigned int cmd, unsigned long arg)
+{
+       struct snd_bebob *bebob = hwdep->private_data;
+
+       switch (cmd) {
+       case SNDRV_FIREWIRE_IOCTL_GET_INFO:
+               return hwdep_get_info(bebob, (void __user *)arg);
+       case SNDRV_FIREWIRE_IOCTL_LOCK:
+               return hwdep_lock(bebob);
+       case SNDRV_FIREWIRE_IOCTL_UNLOCK:
+               return hwdep_unlock(bebob);
+       default:
+               return -ENOIOCTLCMD;
+       }
+}
+
+#ifdef CONFIG_COMPAT
+static int
+hwdep_compat_ioctl(struct snd_hwdep *hwdep, struct file *file,
+                  unsigned int cmd, unsigned long arg)
+{
+       return hwdep_ioctl(hwdep, file, cmd,
+                          (unsigned long)compat_ptr(arg));
+}
+#else
+#define hwdep_compat_ioctl NULL
+#endif
+
+static const struct snd_hwdep_ops hwdep_ops = {
+       .read           = hwdep_read,
+       .release        = hwdep_release,
+       .poll           = hwdep_poll,
+       .ioctl          = hwdep_ioctl,
+       .ioctl_compat   = hwdep_compat_ioctl,
+};
+
+int snd_bebob_create_hwdep_device(struct snd_bebob *bebob)
+{
+       struct snd_hwdep *hwdep;
+       int err;
+
+       err = snd_hwdep_new(bebob->card, "BeBoB", 0, &hwdep);
+       if (err < 0)
+               goto end;
+       strcpy(hwdep->name, "BeBoB");
+       hwdep->iface = SNDRV_HWDEP_IFACE_FW_BEBOB;
+       hwdep->ops = hwdep_ops;
+       hwdep->private_data = bebob;
+       hwdep->exclusive = true;
+end:
+       return err;
+}
+
index 120a61b90c5945ace1e82ca0383d70ffa75159cf..c04cea2c19a686f348b973375daa15a17a86018d 100644 (file)
 static int midi_capture_open(struct snd_rawmidi_substream *substream)
 {
        struct snd_bebob *bebob = substream->rmidi->private_data;
+       int err;
+
+       err = snd_bebob_stream_lock_try(bebob);
+       if (err < 0)
+               goto end;
 
        atomic_inc(&bebob->capture_substreams);
-       return snd_bebob_stream_start_duplex(bebob, 0);
+       err = snd_bebob_stream_start_duplex(bebob, 0);
+       if (err < 0)
+               snd_bebob_stream_lock_release(bebob);
+end:
+       return err;
 }
 
 static int midi_playback_open(struct snd_rawmidi_substream *substream)
 {
        struct snd_bebob *bebob = substream->rmidi->private_data;
+       int err;
+
+       err = snd_bebob_stream_lock_try(bebob);
+       if (err < 0)
+               goto end;
 
        atomic_inc(&bebob->playback_substreams);
-       return snd_bebob_stream_start_duplex(bebob, 0);
+       err = snd_bebob_stream_start_duplex(bebob, 0);
+       if (err < 0)
+               snd_bebob_stream_lock_release(bebob);
+end:
+       return err;
 }
 
 static int midi_capture_close(struct snd_rawmidi_substream *substream)
@@ -31,6 +49,7 @@ static int midi_capture_close(struct snd_rawmidi_substream *substream)
        atomic_dec(&bebob->capture_substreams);
        snd_bebob_stream_stop_duplex(bebob);
 
+       snd_bebob_stream_lock_release(bebob);
        return 0;
 }
 
@@ -41,6 +60,7 @@ static int midi_playback_close(struct snd_rawmidi_substream *substream)
        atomic_dec(&bebob->playback_substreams);
        snd_bebob_stream_stop_duplex(bebob);
 
+       snd_bebob_stream_lock_release(bebob);
        return 0;
 }
 
index 7474309dad87a25cd9dfd00b39259d540c18954e..9d868171db4e9ea49ea6ad18d7b8bfbada7516c4 100644 (file)
@@ -159,13 +159,17 @@ pcm_open(struct snd_pcm_substream *substream)
        bool internal;
        int err;
 
-       err = pcm_init_hw_params(bebob, substream);
+       err = snd_bebob_stream_lock_try(bebob);
        if (err < 0)
                goto end;
 
+       err = pcm_init_hw_params(bebob, substream);
+       if (err < 0)
+               goto err_locked;
+
        err = snd_bebob_stream_check_internal_clock(bebob, &internal);
        if (err < 0)
-               goto end;
+               goto err_locked;
 
        /*
         * When source of clock is internal or any PCM stream are running,
@@ -178,7 +182,7 @@ pcm_open(struct snd_pcm_substream *substream)
                if (err < 0) {
                        dev_err(&bebob->unit->device,
                                "fail to get sampling rate: %d\n", err);
-                       goto end;
+                       goto err_locked;
                }
 
                substream->runtime->hw.rate_min = sampling_rate;
@@ -186,14 +190,18 @@ pcm_open(struct snd_pcm_substream *substream)
        }
 
        snd_pcm_set_sync(substream);
-
 end:
        return err;
+err_locked:
+       snd_bebob_stream_lock_release(bebob);
+       return err;
 }
 
 static int
 pcm_close(struct snd_pcm_substream *substream)
 {
+       struct snd_bebob *bebob = substream->private_data;
+       snd_bebob_stream_lock_release(bebob);
        return 0;
 }
 
index 46b056c8f2a8cf12afb361c67c1e7c731069e368..85b4fd661787e6412ee74bf06e62ec8b269d2486 100644 (file)
@@ -912,3 +912,42 @@ int snd_bebob_stream_discover(struct snd_bebob *bebob)
 end:
        return err;
 }
+
+void snd_bebob_stream_lock_changed(struct snd_bebob *bebob)
+{
+       bebob->dev_lock_changed = true;
+       wake_up(&bebob->hwdep_wait);
+}
+
+int snd_bebob_stream_lock_try(struct snd_bebob *bebob)
+{
+       int err;
+
+       spin_lock_irq(&bebob->lock);
+
+       /* user land lock this */
+       if (bebob->dev_lock_count < 0) {
+               err = -EBUSY;
+               goto end;
+       }
+
+       /* this is the first time */
+       if (bebob->dev_lock_count++ == 0)
+               snd_bebob_stream_lock_changed(bebob);
+       err = 0;
+end:
+       spin_unlock_irq(&bebob->lock);
+       return err;
+}
+
+void snd_bebob_stream_lock_release(struct snd_bebob *bebob)
+{
+       spin_lock_irq(&bebob->lock);
+
+       if (WARN_ON(bebob->dev_lock_count <= 0))
+               goto end;
+       if (--bebob->dev_lock_count == 0)
+               snd_bebob_stream_lock_changed(bebob);
+end:
+       spin_unlock_irq(&bebob->lock);
+}