1da607e19SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
271c37977STakashi Sakamoto /*
371c37977STakashi Sakamoto * motu-hwdep.c - a part of driver for MOTU FireWire series
471c37977STakashi Sakamoto *
571c37977STakashi Sakamoto * Copyright (c) 2015-2017 Takashi Sakamoto <o-takashi@sakamocchi.jp>
671c37977STakashi Sakamoto */
771c37977STakashi Sakamoto
871c37977STakashi Sakamoto /*
971c37977STakashi Sakamoto * This codes have five functionalities.
1071c37977STakashi Sakamoto *
1171c37977STakashi Sakamoto * 1.get information about firewire node
1271c37977STakashi Sakamoto * 2.get notification about starting/stopping stream
1371c37977STakashi Sakamoto * 3.lock/unlock streaming
1471c37977STakashi Sakamoto *
1571c37977STakashi Sakamoto */
1671c37977STakashi Sakamoto
1771c37977STakashi Sakamoto #include "motu.h"
1871c37977STakashi Sakamoto
has_dsp_event(struct snd_motu * motu)19d593f78eSTakashi Sakamoto static bool has_dsp_event(struct snd_motu *motu)
20d593f78eSTakashi Sakamoto {
21d593f78eSTakashi Sakamoto if (motu->spec->flags & SND_MOTU_SPEC_REGISTER_DSP)
22d593f78eSTakashi Sakamoto return (snd_motu_register_dsp_message_parser_count_event(motu) > 0);
23d593f78eSTakashi Sakamoto else
24d593f78eSTakashi Sakamoto return false;
25d593f78eSTakashi Sakamoto }
26d593f78eSTakashi Sakamoto
hwdep_read(struct snd_hwdep * hwdep,char __user * buf,long count,loff_t * offset)2771c37977STakashi Sakamoto static long hwdep_read(struct snd_hwdep *hwdep, char __user *buf, long count,
2871c37977STakashi Sakamoto loff_t *offset)
2971c37977STakashi Sakamoto {
3071c37977STakashi Sakamoto struct snd_motu *motu = hwdep->private_data;
3171c37977STakashi Sakamoto DEFINE_WAIT(wait);
3271c37977STakashi Sakamoto union snd_firewire_event event;
3371c37977STakashi Sakamoto
3471c37977STakashi Sakamoto spin_lock_irq(&motu->lock);
3571c37977STakashi Sakamoto
36d593f78eSTakashi Sakamoto while (!motu->dev_lock_changed && motu->msg == 0 && !has_dsp_event(motu)) {
3771c37977STakashi Sakamoto prepare_to_wait(&motu->hwdep_wait, &wait, TASK_INTERRUPTIBLE);
3871c37977STakashi Sakamoto spin_unlock_irq(&motu->lock);
3971c37977STakashi Sakamoto schedule();
4071c37977STakashi Sakamoto finish_wait(&motu->hwdep_wait, &wait);
4171c37977STakashi Sakamoto if (signal_pending(current))
4271c37977STakashi Sakamoto return -ERESTARTSYS;
4371c37977STakashi Sakamoto spin_lock_irq(&motu->lock);
4471c37977STakashi Sakamoto }
4571c37977STakashi Sakamoto
4671c37977STakashi Sakamoto memset(&event, 0, sizeof(event));
4771c37977STakashi Sakamoto if (motu->dev_lock_changed) {
4871c37977STakashi Sakamoto event.lock_status.type = SNDRV_FIREWIRE_EVENT_LOCK_STATUS;
4971c37977STakashi Sakamoto event.lock_status.status = (motu->dev_lock_count > 0);
5071c37977STakashi Sakamoto motu->dev_lock_changed = false;
51634ec0b2STakashi Sakamoto spin_unlock_irq(&motu->lock);
5271c37977STakashi Sakamoto
53634ec0b2STakashi Sakamoto count = min_t(long, count, sizeof(event));
54634ec0b2STakashi Sakamoto if (copy_to_user(buf, &event, count))
55634ec0b2STakashi Sakamoto return -EFAULT;
56634ec0b2STakashi Sakamoto } else if (motu->msg > 0) {
575aaab1bfSTakashi Sakamoto event.motu_notification.type = SNDRV_FIREWIRE_EVENT_MOTU_NOTIFICATION;
585aaab1bfSTakashi Sakamoto event.motu_notification.message = motu->msg;
595aaab1bfSTakashi Sakamoto motu->msg = 0;
60634ec0b2STakashi Sakamoto spin_unlock_irq(&motu->lock);
615aaab1bfSTakashi Sakamoto
62634ec0b2STakashi Sakamoto count = min_t(long, count, sizeof(event));
63634ec0b2STakashi Sakamoto if (copy_to_user(buf, &event, count))
64634ec0b2STakashi Sakamoto return -EFAULT;
65d593f78eSTakashi Sakamoto } else if (has_dsp_event(motu)) {
66634ec0b2STakashi Sakamoto size_t consumed = 0;
67634ec0b2STakashi Sakamoto u32 __user *ptr;
68634ec0b2STakashi Sakamoto u32 ev;
6971c37977STakashi Sakamoto
7071c37977STakashi Sakamoto spin_unlock_irq(&motu->lock);
7171c37977STakashi Sakamoto
72634ec0b2STakashi Sakamoto // Header is filled later.
73634ec0b2STakashi Sakamoto consumed += sizeof(event.motu_register_dsp_change);
74634ec0b2STakashi Sakamoto
75634ec0b2STakashi Sakamoto while (consumed < count &&
76634ec0b2STakashi Sakamoto snd_motu_register_dsp_message_parser_copy_event(motu, &ev)) {
77634ec0b2STakashi Sakamoto ptr = (u32 __user *)(buf + consumed);
78634ec0b2STakashi Sakamoto if (put_user(ev, ptr))
7971c37977STakashi Sakamoto return -EFAULT;
80634ec0b2STakashi Sakamoto consumed += sizeof(ev);
81634ec0b2STakashi Sakamoto }
82634ec0b2STakashi Sakamoto
83634ec0b2STakashi Sakamoto event.motu_register_dsp_change.type = SNDRV_FIREWIRE_EVENT_MOTU_REGISTER_DSP_CHANGE;
84634ec0b2STakashi Sakamoto event.motu_register_dsp_change.count =
85634ec0b2STakashi Sakamoto (consumed - sizeof(event.motu_register_dsp_change)) / 4;
86634ec0b2STakashi Sakamoto if (copy_to_user(buf, &event, sizeof(event.motu_register_dsp_change)))
87634ec0b2STakashi Sakamoto return -EFAULT;
88634ec0b2STakashi Sakamoto
89634ec0b2STakashi Sakamoto count = consumed;
90*c7a806d9STakashi Sakamoto } else {
91*c7a806d9STakashi Sakamoto spin_unlock_irq(&motu->lock);
92*c7a806d9STakashi Sakamoto
93*c7a806d9STakashi Sakamoto count = 0;
94634ec0b2STakashi Sakamoto }
9571c37977STakashi Sakamoto
9671c37977STakashi Sakamoto return count;
9771c37977STakashi Sakamoto }
9871c37977STakashi Sakamoto
hwdep_poll(struct snd_hwdep * hwdep,struct file * file,poll_table * wait)99680ef72aSAl Viro static __poll_t hwdep_poll(struct snd_hwdep *hwdep, struct file *file,
10071c37977STakashi Sakamoto poll_table *wait)
10171c37977STakashi Sakamoto {
10271c37977STakashi Sakamoto struct snd_motu *motu = hwdep->private_data;
103680ef72aSAl Viro __poll_t events;
10471c37977STakashi Sakamoto
10571c37977STakashi Sakamoto poll_wait(file, &motu->hwdep_wait, wait);
10671c37977STakashi Sakamoto
10771c37977STakashi Sakamoto spin_lock_irq(&motu->lock);
108d593f78eSTakashi Sakamoto if (motu->dev_lock_changed || motu->msg || has_dsp_event(motu))
109a9a08845SLinus Torvalds events = EPOLLIN | EPOLLRDNORM;
11071c37977STakashi Sakamoto else
11171c37977STakashi Sakamoto events = 0;
11271c37977STakashi Sakamoto spin_unlock_irq(&motu->lock);
11371c37977STakashi Sakamoto
114a9a08845SLinus Torvalds return events | EPOLLOUT;
11571c37977STakashi Sakamoto }
11671c37977STakashi Sakamoto
hwdep_get_info(struct snd_motu * motu,void __user * arg)11771c37977STakashi Sakamoto static int hwdep_get_info(struct snd_motu *motu, void __user *arg)
11871c37977STakashi Sakamoto {
11971c37977STakashi Sakamoto struct fw_device *dev = fw_parent_device(motu->unit);
12071c37977STakashi Sakamoto struct snd_firewire_get_info info;
12171c37977STakashi Sakamoto
12271c37977STakashi Sakamoto memset(&info, 0, sizeof(info));
12371c37977STakashi Sakamoto info.type = SNDRV_FIREWIRE_TYPE_MOTU;
12471c37977STakashi Sakamoto info.card = dev->card->index;
12571c37977STakashi Sakamoto *(__be32 *)&info.guid[0] = cpu_to_be32(dev->config_rom[3]);
12671c37977STakashi Sakamoto *(__be32 *)&info.guid[4] = cpu_to_be32(dev->config_rom[4]);
12775b1a8f9SJoe Perches strscpy(info.device_name, dev_name(&dev->device),
12871c37977STakashi Sakamoto sizeof(info.device_name));
12971c37977STakashi Sakamoto
13071c37977STakashi Sakamoto if (copy_to_user(arg, &info, sizeof(info)))
13171c37977STakashi Sakamoto return -EFAULT;
13271c37977STakashi Sakamoto
13371c37977STakashi Sakamoto return 0;
13471c37977STakashi Sakamoto }
13571c37977STakashi Sakamoto
hwdep_lock(struct snd_motu * motu)13671c37977STakashi Sakamoto static int hwdep_lock(struct snd_motu *motu)
13771c37977STakashi Sakamoto {
13871c37977STakashi Sakamoto int err;
13971c37977STakashi Sakamoto
14071c37977STakashi Sakamoto spin_lock_irq(&motu->lock);
14171c37977STakashi Sakamoto
14271c37977STakashi Sakamoto if (motu->dev_lock_count == 0) {
14371c37977STakashi Sakamoto motu->dev_lock_count = -1;
14471c37977STakashi Sakamoto err = 0;
14571c37977STakashi Sakamoto } else {
14671c37977STakashi Sakamoto err = -EBUSY;
14771c37977STakashi Sakamoto }
14871c37977STakashi Sakamoto
14971c37977STakashi Sakamoto spin_unlock_irq(&motu->lock);
15071c37977STakashi Sakamoto
15171c37977STakashi Sakamoto return err;
15271c37977STakashi Sakamoto }
15371c37977STakashi Sakamoto
hwdep_unlock(struct snd_motu * motu)15471c37977STakashi Sakamoto static int hwdep_unlock(struct snd_motu *motu)
15571c37977STakashi Sakamoto {
15671c37977STakashi Sakamoto int err;
15771c37977STakashi Sakamoto
15871c37977STakashi Sakamoto spin_lock_irq(&motu->lock);
15971c37977STakashi Sakamoto
16071c37977STakashi Sakamoto if (motu->dev_lock_count == -1) {
16171c37977STakashi Sakamoto motu->dev_lock_count = 0;
16271c37977STakashi Sakamoto err = 0;
16371c37977STakashi Sakamoto } else {
16471c37977STakashi Sakamoto err = -EBADFD;
16571c37977STakashi Sakamoto }
16671c37977STakashi Sakamoto
16771c37977STakashi Sakamoto spin_unlock_irq(&motu->lock);
16871c37977STakashi Sakamoto
16971c37977STakashi Sakamoto return err;
17071c37977STakashi Sakamoto }
17171c37977STakashi Sakamoto
hwdep_release(struct snd_hwdep * hwdep,struct file * file)17271c37977STakashi Sakamoto static int hwdep_release(struct snd_hwdep *hwdep, struct file *file)
17371c37977STakashi Sakamoto {
17471c37977STakashi Sakamoto struct snd_motu *motu = hwdep->private_data;
17571c37977STakashi Sakamoto
17671c37977STakashi Sakamoto spin_lock_irq(&motu->lock);
17771c37977STakashi Sakamoto if (motu->dev_lock_count == -1)
17871c37977STakashi Sakamoto motu->dev_lock_count = 0;
17971c37977STakashi Sakamoto spin_unlock_irq(&motu->lock);
18071c37977STakashi Sakamoto
18171c37977STakashi Sakamoto return 0;
18271c37977STakashi Sakamoto }
18371c37977STakashi Sakamoto
hwdep_ioctl(struct snd_hwdep * hwdep,struct file * file,unsigned int cmd,unsigned long arg)18471c37977STakashi Sakamoto static int hwdep_ioctl(struct snd_hwdep *hwdep, struct file *file,
18571c37977STakashi Sakamoto unsigned int cmd, unsigned long arg)
18671c37977STakashi Sakamoto {
18771c37977STakashi Sakamoto struct snd_motu *motu = hwdep->private_data;
18871c37977STakashi Sakamoto
18971c37977STakashi Sakamoto switch (cmd) {
19071c37977STakashi Sakamoto case SNDRV_FIREWIRE_IOCTL_GET_INFO:
19171c37977STakashi Sakamoto return hwdep_get_info(motu, (void __user *)arg);
19271c37977STakashi Sakamoto case SNDRV_FIREWIRE_IOCTL_LOCK:
19371c37977STakashi Sakamoto return hwdep_lock(motu);
19471c37977STakashi Sakamoto case SNDRV_FIREWIRE_IOCTL_UNLOCK:
19571c37977STakashi Sakamoto return hwdep_unlock(motu);
19658b62ab7STakashi Sakamoto case SNDRV_FIREWIRE_IOCTL_MOTU_REGISTER_DSP_METER:
19758b62ab7STakashi Sakamoto {
19858b62ab7STakashi Sakamoto struct snd_firewire_motu_register_dsp_meter *meter;
19958b62ab7STakashi Sakamoto int err;
20058b62ab7STakashi Sakamoto
20158b62ab7STakashi Sakamoto if (!(motu->spec->flags & SND_MOTU_SPEC_REGISTER_DSP))
20258b62ab7STakashi Sakamoto return -ENXIO;
20358b62ab7STakashi Sakamoto
20458b62ab7STakashi Sakamoto meter = kzalloc(sizeof(*meter), GFP_KERNEL);
20558b62ab7STakashi Sakamoto if (!meter)
20658b62ab7STakashi Sakamoto return -ENOMEM;
20758b62ab7STakashi Sakamoto
20858b62ab7STakashi Sakamoto snd_motu_register_dsp_message_parser_copy_meter(motu, meter);
20958b62ab7STakashi Sakamoto
21058b62ab7STakashi Sakamoto err = copy_to_user((void __user *)arg, meter, sizeof(*meter));
21158b62ab7STakashi Sakamoto kfree(meter);
21258b62ab7STakashi Sakamoto
21358b62ab7STakashi Sakamoto if (err)
21458b62ab7STakashi Sakamoto return -EFAULT;
21558b62ab7STakashi Sakamoto
21658b62ab7STakashi Sakamoto return 0;
21758b62ab7STakashi Sakamoto }
21858b62ab7STakashi Sakamoto case SNDRV_FIREWIRE_IOCTL_MOTU_COMMAND_DSP_METER:
21958b62ab7STakashi Sakamoto {
22058b62ab7STakashi Sakamoto struct snd_firewire_motu_command_dsp_meter *meter;
22158b62ab7STakashi Sakamoto int err;
22258b62ab7STakashi Sakamoto
22358b62ab7STakashi Sakamoto if (!(motu->spec->flags & SND_MOTU_SPEC_COMMAND_DSP))
22458b62ab7STakashi Sakamoto return -ENXIO;
22558b62ab7STakashi Sakamoto
22658b62ab7STakashi Sakamoto meter = kzalloc(sizeof(*meter), GFP_KERNEL);
22758b62ab7STakashi Sakamoto if (!meter)
22858b62ab7STakashi Sakamoto return -ENOMEM;
22958b62ab7STakashi Sakamoto
23058b62ab7STakashi Sakamoto snd_motu_command_dsp_message_parser_copy_meter(motu, meter);
23158b62ab7STakashi Sakamoto
23258b62ab7STakashi Sakamoto err = copy_to_user((void __user *)arg, meter, sizeof(*meter));
23358b62ab7STakashi Sakamoto kfree(meter);
23458b62ab7STakashi Sakamoto
23558b62ab7STakashi Sakamoto if (err)
23658b62ab7STakashi Sakamoto return -EFAULT;
23758b62ab7STakashi Sakamoto
23858b62ab7STakashi Sakamoto return 0;
23958b62ab7STakashi Sakamoto }
240ca15a09cSTakashi Sakamoto case SNDRV_FIREWIRE_IOCTL_MOTU_REGISTER_DSP_PARAMETER:
241ca15a09cSTakashi Sakamoto {
242ca15a09cSTakashi Sakamoto struct snd_firewire_motu_register_dsp_parameter *param;
243ca15a09cSTakashi Sakamoto int err;
244ca15a09cSTakashi Sakamoto
245ca15a09cSTakashi Sakamoto if (!(motu->spec->flags & SND_MOTU_SPEC_REGISTER_DSP))
246ca15a09cSTakashi Sakamoto return -ENXIO;
247ca15a09cSTakashi Sakamoto
248ca15a09cSTakashi Sakamoto param = kzalloc(sizeof(*param), GFP_KERNEL);
249ca15a09cSTakashi Sakamoto if (!param)
250ca15a09cSTakashi Sakamoto return -ENOMEM;
251ca15a09cSTakashi Sakamoto
252ca15a09cSTakashi Sakamoto snd_motu_register_dsp_message_parser_copy_parameter(motu, param);
253ca15a09cSTakashi Sakamoto
254ca15a09cSTakashi Sakamoto err = copy_to_user((void __user *)arg, param, sizeof(*param));
255ca15a09cSTakashi Sakamoto kfree(param);
256ca15a09cSTakashi Sakamoto if (err)
257ca15a09cSTakashi Sakamoto return -EFAULT;
258ca15a09cSTakashi Sakamoto
259ca15a09cSTakashi Sakamoto return 0;
260ca15a09cSTakashi Sakamoto }
26171c37977STakashi Sakamoto default:
26271c37977STakashi Sakamoto return -ENOIOCTLCMD;
26371c37977STakashi Sakamoto }
26471c37977STakashi Sakamoto }
26571c37977STakashi Sakamoto
26671c37977STakashi Sakamoto #ifdef CONFIG_COMPAT
hwdep_compat_ioctl(struct snd_hwdep * hwdep,struct file * file,unsigned int cmd,unsigned long arg)26771c37977STakashi Sakamoto static int hwdep_compat_ioctl(struct snd_hwdep *hwdep, struct file *file,
26871c37977STakashi Sakamoto unsigned int cmd, unsigned long arg)
26971c37977STakashi Sakamoto {
27071c37977STakashi Sakamoto return hwdep_ioctl(hwdep, file, cmd,
27171c37977STakashi Sakamoto (unsigned long)compat_ptr(arg));
27271c37977STakashi Sakamoto }
27371c37977STakashi Sakamoto #else
27471c37977STakashi Sakamoto #define hwdep_compat_ioctl NULL
27571c37977STakashi Sakamoto #endif
27671c37977STakashi Sakamoto
snd_motu_create_hwdep_device(struct snd_motu * motu)27771c37977STakashi Sakamoto int snd_motu_create_hwdep_device(struct snd_motu *motu)
27871c37977STakashi Sakamoto {
27971c37977STakashi Sakamoto static const struct snd_hwdep_ops ops = {
28071c37977STakashi Sakamoto .read = hwdep_read,
28171c37977STakashi Sakamoto .release = hwdep_release,
28271c37977STakashi Sakamoto .poll = hwdep_poll,
28371c37977STakashi Sakamoto .ioctl = hwdep_ioctl,
28471c37977STakashi Sakamoto .ioctl_compat = hwdep_compat_ioctl,
28571c37977STakashi Sakamoto };
28671c37977STakashi Sakamoto struct snd_hwdep *hwdep;
28771c37977STakashi Sakamoto int err;
28871c37977STakashi Sakamoto
28971c37977STakashi Sakamoto err = snd_hwdep_new(motu->card, motu->card->driver, 0, &hwdep);
29071c37977STakashi Sakamoto if (err < 0)
29171c37977STakashi Sakamoto return err;
29271c37977STakashi Sakamoto
29371c37977STakashi Sakamoto strcpy(hwdep->name, "MOTU");
29471c37977STakashi Sakamoto hwdep->iface = SNDRV_HWDEP_IFACE_FW_MOTU;
29571c37977STakashi Sakamoto hwdep->ops = ops;
29671c37977STakashi Sakamoto hwdep->private_data = motu;
29771c37977STakashi Sakamoto hwdep->exclusive = true;
29871c37977STakashi Sakamoto
2994c9eda8fSTakashi Sakamoto motu->hwdep = hwdep;
3004c9eda8fSTakashi Sakamoto
30171c37977STakashi Sakamoto return 0;
30271c37977STakashi Sakamoto }
303