[linux.git] / sound / core / hwdep.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  Hardware dependent layer
 *  Copyright (c) by Jaroslav Kysela <[email protected]>
 */

#include <linux/major.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/time.h>
#include <linux/mutex.h>
#include <linux/module.h>
#include <linux/sched/signal.h>
#include <sound/core.h>
#include <sound/control.h>
#include <sound/minors.h>
#include <sound/hwdep.h>
#include <sound/info.h>

MODULE_AUTHOR("Jaroslav Kysela <[email protected]>");
MODULE_DESCRIPTION("Hardware dependent layer");
MODULE_LICENSE("GPL");

static LIST_HEAD(snd_hwdep_devices);
static DEFINE_MUTEX(register_mutex);

static int snd_hwdep_dev_free(struct snd_device *device);
static int snd_hwdep_dev_register(struct snd_device *device);
static int snd_hwdep_dev_disconnect(struct snd_device *device);


static struct snd_hwdep *snd_hwdep_search(struct snd_card *card, int device)
{
	struct snd_hwdep *hwdep;

	list_for_each_entry(hwdep, &snd_hwdep_devices, list)
		if (hwdep->card == card && hwdep->device == device)
			return hwdep;
	return NULL;
}

static loff_t snd_hwdep_llseek(struct file * file, loff_t offset, int orig)
{
	struct snd_hwdep *hw = file->private_data;
	if (hw->ops.llseek)
		return hw->ops.llseek(hw, file, offset, orig);
	return -ENXIO;
}

static ssize_t snd_hwdep_read(struct file * file, char __user *buf,
			      size_t count, loff_t *offset)
{
	struct snd_hwdep *hw = file->private_data;
	if (hw->ops.read)
		return hw->ops.read(hw, buf, count, offset);
	return -ENXIO;	
}

static ssize_t snd_hwdep_write(struct file * file, const char __user *buf,
			       size_t count, loff_t *offset)
{
	struct snd_hwdep *hw = file->private_data;
	if (hw->ops.write)
		return hw->ops.write(hw, buf, count, offset);
	return -ENXIO;	
}

static int snd_hwdep_open(struct inode *inode, struct file * file)
{
	int major = imajor(inode);
	struct snd_hwdep *hw;
	int err;
	wait_queue_entry_t wait;

	if (major == snd_major) {
		hw = snd_lookup_minor_data(iminor(inode),
					   SNDRV_DEVICE_TYPE_HWDEP);
#ifdef CONFIG_SND_OSSEMUL
	} else if (major == SOUND_MAJOR) {
		hw = snd_lookup_oss_minor_data(iminor(inode),
					       SNDRV_OSS_DEVICE_TYPE_DMFM);
#endif
	} else
		return -ENXIO;
	if (hw == NULL)
		return -ENODEV;

	if (!try_module_get(hw->card->module)) {
		snd_card_unref(hw->card);
		return -EFAULT;
	}

	init_waitqueue_entry(&wait, current);
	add_wait_queue(&hw->open_wait, &wait);
	mutex_lock(&hw->open_mutex);
	while (1) {
		if (hw->exclusive && hw->used > 0) {
			err = -EBUSY;
			break;
		}
		if (!hw->ops.open) {
			err = 0;
			break;
		}
		err = hw->ops.open(hw, file);
		if (err >= 0)
			break;
		if (err == -EAGAIN) {
			if (file->f_flags & O_NONBLOCK) {
				err = -EBUSY;
				break;
			}
		} else
			break;
		set_current_state(TASK_INTERRUPTIBLE);
		mutex_unlock(&hw->open_mutex);
		schedule();
		mutex_lock(&hw->open_mutex);
		if (hw->card->shutdown) {
			err = -ENODEV;
			break;
		}
		if (signal_pending(current)) {
			err = -ERESTARTSYS;
			break;
		}
	}
	remove_wait_queue(&hw->open_wait, &wait);
	if (err >= 0) {
		err = snd_card_file_add(hw->card, file);
		if (err >= 0) {
			file->private_data = hw;
			hw->used++;
		} else {
			if (hw->ops.release)
				hw->ops.release(hw, file);
		}
	}
	mutex_unlock(&hw->open_mutex);
	if (err < 0)
		module_put(hw->card->module);
	snd_card_unref(hw->card);
	return err;
}

static int snd_hwdep_release(struct inode *inode, struct file * file)
{
	int err = 0;
	struct snd_hwdep *hw = file->private_data;
	struct module *mod = hw->card->module;

	mutex_lock(&hw->open_mutex);
	if (hw->ops.release)
		err = hw->ops.release(hw, file);
	if (hw->used > 0)
		hw->used--;
	mutex_unlock(&hw->open_mutex);
	wake_up(&hw->open_wait);

	snd_card_file_remove(hw->card, file);
	module_put(mod);
	return err;
}

static __poll_t snd_hwdep_poll(struct file * file, poll_table * wait)
{
	struct snd_hwdep *hw = file->private_data;
	if (hw->ops.poll)
		return hw->ops.poll(hw, file, wait);
	return 0;
}

static int snd_hwdep_info(struct snd_hwdep *hw,
			  struct snd_hwdep_info __user *_info)
{
	struct snd_hwdep_info info;
	
	memset(&info, 0, sizeof(info));
	info.card = hw->card->number;
	strscpy(info.id, hw->id, sizeof(info.id));
	strscpy(info.name, hw->name, sizeof(info.name));
	info.iface = hw->iface;
	if (copy_to_user(_info, &info, sizeof(info)))
		return -EFAULT;
	return 0;
}

static int snd_hwdep_dsp_status(struct snd_hwdep *hw,
				struct snd_hwdep_dsp_status __user *_info)
{
	struct snd_hwdep_dsp_status info;
	int err;
	
	if (! hw->ops.dsp_status)
		return -ENXIO;
	memset(&info, 0, sizeof(info));
	info.dsp_loaded = hw->dsp_loaded;
	err = hw->ops.dsp_status(hw, &info);
	if (err < 0)
		return err;
	if (copy_to_user(_info, &info, sizeof(info)))
		return -EFAULT;
	return 0;
}

static int snd_hwdep_dsp_load(struct snd_hwdep *hw,
			      struct snd_hwdep_dsp_image *info)
{
	int err;
	
	if (! hw->ops.dsp_load)
		return -ENXIO;
	if (info->index >= 32)
		return -EINVAL;
	/* check whether the dsp was already loaded */
	if (hw->dsp_loaded & (1u << info->index))
		return -EBUSY;
	err = hw->ops.dsp_load(hw, info);
	if (err < 0)
		return err;
	hw->dsp_loaded |= (1u << info->index);
	return 0;
}

static int snd_hwdep_dsp_load_user(struct snd_hwdep *hw,
				   struct snd_hwdep_dsp_image __user *_info)
{
	struct snd_hwdep_dsp_image info = {};

	if (copy_from_user(&info, _info, sizeof(info)))
		return -EFAULT;
	return snd_hwdep_dsp_load(hw, &info);
}


static long snd_hwdep_ioctl(struct file * file, unsigned int cmd,
			    unsigned long arg)
{
	struct snd_hwdep *hw = file->private_data;
	void __user *argp = (void __user *)arg;
	switch (cmd) {
	case SNDRV_HWDEP_IOCTL_PVERSION:
		return put_user(SNDRV_HWDEP_VERSION, (int __user *)argp);
	case SNDRV_HWDEP_IOCTL_INFO:
		return snd_hwdep_info(hw, argp);
	case SNDRV_HWDEP_IOCTL_DSP_STATUS:
		return snd_hwdep_dsp_status(hw, argp);
	case SNDRV_HWDEP_IOCTL_DSP_LOAD:
		return snd_hwdep_dsp_load_user(hw, argp);
	}
	if (hw->ops.ioctl)
		return hw->ops.ioctl(hw, file, cmd, arg);
	return -ENOTTY;
}

static int snd_hwdep_mmap(struct file * file, struct vm_area_struct * vma)
{
	struct snd_hwdep *hw = file->private_data;
	if (hw->ops.mmap)
		return hw->ops.mmap(hw, file, vma);
	return -ENXIO;
}

static int snd_hwdep_control_ioctl(struct snd_card *card,
				   struct snd_ctl_file * control,
				   unsigned int cmd, unsigned long arg)
{
	switch (cmd) {
	case SNDRV_CTL_IOCTL_HWDEP_NEXT_DEVICE:
		{
			int device;

			if (get_user(device, (int __user *)arg))
				return -EFAULT;
			mutex_lock(&register_mutex);

			if (device < 0)
				device = 0;
			else if (device < SNDRV_MINOR_HWDEPS)
				device++;
			else
				device = SNDRV_MINOR_HWDEPS;

			while (device < SNDRV_MINOR_HWDEPS) {
				if (snd_hwdep_search(card, device))
					break;
				device++;
			}
			if (device >= SNDRV_MINOR_HWDEPS)
				device = -1;
			mutex_unlock(&register_mutex);
			if (put_user(device, (int __user *)arg))
				return -EFAULT;
			return 0;
		}
	case SNDRV_CTL_IOCTL_HWDEP_INFO:
		{
			struct snd_hwdep_info __user *info = (struct snd_hwdep_info __user *)arg;
			int device, err;
			struct snd_hwdep *hwdep;

			if (get_user(device, &info->device))
				return -EFAULT;
			mutex_lock(&register_mutex);
			hwdep = snd_hwdep_search(card, device);
			if (hwdep)
				err = snd_hwdep_info(hwdep, info);
			else
				err = -ENXIO;
			mutex_unlock(&register_mutex);
			return err;
		}
	}
	return -ENOIOCTLCMD;
}

#ifdef CONFIG_COMPAT
#include "hwdep_compat.c"
#else
#define snd_hwdep_ioctl_compat	NULL
#endif

/*

 */

static const struct file_operations snd_hwdep_f_ops =
{
	.owner = 	THIS_MODULE,
	.llseek =	snd_hwdep_llseek,
	.read = 	snd_hwdep_read,
	.write =	snd_hwdep_write,
	.open =		snd_hwdep_open,
	.release =	snd_hwdep_release,
	.poll =		snd_hwdep_poll,
	.unlocked_ioctl =	snd_hwdep_ioctl,
	.compat_ioctl =	snd_hwdep_ioctl_compat,
	.mmap =		snd_hwdep_mmap,
};

static void release_hwdep_device(struct device *dev)
{
	kfree(container_of(dev, struct snd_hwdep, dev));
}

/**
 * snd_hwdep_new - create a new hwdep instance
 * @card: the card instance
 * @id: the id string
 * @device: the device index (zero-based)
 * @rhwdep: the pointer to store the new hwdep instance
 *
 * Creates a new hwdep instance with the given index on the card.
 * The callbacks (hwdep->ops) must be set on the returned instance
 * after this call manually by the caller.
 *
 * Return: Zero if successful, or a negative error code on failure.
 */
int snd_hwdep_new(struct snd_card *card, char *id, int device,
		  struct snd_hwdep **rhwdep)
{
	struct snd_hwdep *hwdep;
	int err;
	static const struct snd_device_ops ops = {
		.dev_free = snd_hwdep_dev_free,
		.dev_register = snd_hwdep_dev_register,
		.dev_disconnect = snd_hwdep_dev_disconnect,
	};

	if (snd_BUG_ON(!card))
		return -ENXIO;
	if (rhwdep)
		*rhwdep = NULL;
	hwdep = kzalloc(sizeof(*hwdep), GFP_KERNEL);
	if (!hwdep)
		return -ENOMEM;

	init_waitqueue_head(&hwdep->open_wait);
	mutex_init(&hwdep->open_mutex);
	hwdep->card = card;
	hwdep->device = device;
	if (id)
		strscpy(hwdep->id, id, sizeof(hwdep->id));

	snd_device_initialize(&hwdep->dev, card);
	hwdep->dev.release = release_hwdep_device;
	dev_set_name(&hwdep->dev, "hwC%iD%i", card->number, device);
#ifdef CONFIG_SND_OSSEMUL
	hwdep->oss_type = -1;
#endif

	err = snd_device_new(card, SNDRV_DEV_HWDEP, hwdep, &ops);
	if (err < 0) {
		put_device(&hwdep->dev);
		return err;
	}

	if (rhwdep)
		*rhwdep = hwdep;
	return 0;
}
EXPORT_SYMBOL(snd_hwdep_new);

static int snd_hwdep_dev_free(struct snd_device *device)
{
	struct snd_hwdep *hwdep = device->device_data;
	if (!hwdep)
		return 0;
	if (hwdep->private_free)
		hwdep->private_free(hwdep);
	put_device(&hwdep->dev);
	return 0;
}

static int snd_hwdep_dev_register(struct snd_device *device)
{
	struct snd_hwdep *hwdep = device->device_data;
	struct snd_card *card = hwdep->card;
	int err;

	mutex_lock(&register_mutex);
	if (snd_hwdep_search(card, hwdep->device)) {
		mutex_unlock(&register_mutex);
		return -EBUSY;
	}
	list_add_tail(&hwdep->list, &snd_hwdep_devices);
	err = snd_register_device(SNDRV_DEVICE_TYPE_HWDEP,
				  hwdep->card, hwdep->device,
				  &snd_hwdep_f_ops, hwdep, &hwdep->dev);
	if (err < 0) {
		dev_err(&hwdep->dev, "unable to register\n");
		list_del(&hwdep->list);
		mutex_unlock(&register_mutex);
		return err;
	}

#ifdef CONFIG_SND_OSSEMUL
	hwdep->ossreg = 0;
	if (hwdep->oss_type >= 0) {
		if (hwdep->oss_type == SNDRV_OSS_DEVICE_TYPE_DMFM &&
		    hwdep->device)
			dev_warn(&hwdep->dev,
				 "only hwdep device 0 can be registered as OSS direct FM device!\n");
		else if (snd_register_oss_device(hwdep->oss_type,
						 card, hwdep->device,
						 &snd_hwdep_f_ops, hwdep) < 0)
			dev_warn(&hwdep->dev,
				 "unable to register OSS compatibility device\n");
		else
			hwdep->ossreg = 1;
	}
#endif
	mutex_unlock(&register_mutex);
	return 0;
}

static int snd_hwdep_dev_disconnect(struct snd_device *device)
{
	struct snd_hwdep *hwdep = device->device_data;

	if (snd_BUG_ON(!hwdep))
		return -ENXIO;
	mutex_lock(&register_mutex);
	if (snd_hwdep_search(hwdep->card, hwdep->device) != hwdep) {
		mutex_unlock(&register_mutex);
		return -EINVAL;
	}
	mutex_lock(&hwdep->open_mutex);
	wake_up(&hwdep->open_wait);
#ifdef CONFIG_SND_OSSEMUL
	if (hwdep->ossreg)
		snd_unregister_oss_device(hwdep->oss_type, hwdep->card, hwdep->device);
#endif
	snd_unregister_device(&hwdep->dev);
	list_del_init(&hwdep->list);
	mutex_unlock(&hwdep->open_mutex);
	mutex_unlock(&register_mutex);
	return 0;
}

#ifdef CONFIG_SND_PROC_FS
/*
 *  Info interface
 */

static void snd_hwdep_proc_read(struct snd_info_entry *entry,
				struct snd_info_buffer *buffer)
{
	struct snd_hwdep *hwdep;

	mutex_lock(&register_mutex);
	list_for_each_entry(hwdep, &snd_hwdep_devices, list)
		snd_iprintf(buffer, "%02i-%02i: %s\n",
			    hwdep->card->number, hwdep->device, hwdep->name);
	mutex_unlock(&register_mutex);
}

static struct snd_info_entry *snd_hwdep_proc_entry;

static void __init snd_hwdep_proc_init(void)
{
	struct snd_info_entry *entry;

	entry = snd_info_create_module_entry(THIS_MODULE, "hwdep", NULL);
	if (entry) {
		entry->c.text.read = snd_hwdep_proc_read;
		if (snd_info_register(entry) < 0) {
			snd_info_free_entry(entry);
			entry = NULL;
		}
	}
	snd_hwdep_proc_entry = entry;
}

static void __exit snd_hwdep_proc_done(void)
{
	snd_info_free_entry(snd_hwdep_proc_entry);
}
#else /* !CONFIG_SND_PROC_FS */
#define snd_hwdep_proc_init()
#define snd_hwdep_proc_done()
#endif /* CONFIG_SND_PROC_FS */


/*
 *  ENTRY functions
 */

static int __init alsa_hwdep_init(void)
{
	snd_hwdep_proc_init();
	snd_ctl_register_ioctl(snd_hwdep_control_ioctl);
	snd_ctl_register_ioctl_compat(snd_hwdep_control_ioctl);
	return 0;
}

static void __exit alsa_hwdep_exit(void)
{
	snd_ctl_unregister_ioctl(snd_hwdep_control_ioctl);
	snd_ctl_unregister_ioctl_compat(snd_hwdep_control_ioctl);
	snd_hwdep_proc_done();
}

module_init(alsa_hwdep_init)
module_exit(alsa_hwdep_exit)
Commit	Line	Data
1a59d1b8	1	// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4 LT	2	/*
1da177e4 LT	3	* Hardware dependent layer
c1017a4c	4	* Copyright (c) by Jaroslav Kysela <[email protected]>
1da177e4 LT	5	*/
1da177e4 LT	6
1da177e4 LT	7	#include <linux/major.h>
1da177e4 LT	8	#include <linux/init.h>
1da177e4 LT	9	#include <linux/slab.h>
1da177e4 LT	10	#include <linux/time.h>
1a60d4c5	11	#include <linux/mutex.h>
da155d5b	12	#include <linux/module.h>
174cd4b1	13	#include <linux/sched/signal.h>
1da177e4 LT	14	#include <sound/core.h>
	15	#include <sound/control.h>
	16	#include <sound/minors.h>
	17	#include <sound/hwdep.h>
	18	#include <sound/info.h>
	19
c1017a4c	20	MODULE_AUTHOR("Jaroslav Kysela <[email protected]>");
1da177e4 LT	21	MODULE_DESCRIPTION("Hardware dependent layer");
	22	MODULE_LICENSE("GPL");
	23
f87135f5	24	static LIST_HEAD(snd_hwdep_devices);
1a60d4c5	25	static DEFINE_MUTEX(register_mutex);
1da177e4	26
d9a98de2 TI	27	static int snd_hwdep_dev_free(struct snd_device *device);
d9a98de2 TI	28	static int snd_hwdep_dev_register(struct snd_device *device);
c461482c	29	static int snd_hwdep_dev_disconnect(struct snd_device *device);
1da177e4	30
1da177e4	31
f87135f5 CL	32	static struct snd_hwdep snd_hwdep_search(struct snd_card card, int device)
f87135f5 CL	33	{
f87135f5 CL	34	struct snd_hwdep *hwdep;
f87135f5 CL	35
9244b2c3	36	list_for_each_entry(hwdep, &snd_hwdep_devices, list)
f87135f5 CL	37	if (hwdep->card == card && hwdep->device == device)
f87135f5 CL	38	return hwdep;
f87135f5 CL	39	return NULL;
f87135f5 CL	40	}
1da177e4 LT	41
	42	static loff_t snd_hwdep_llseek(struct file * file, loff_t offset, int orig)
	43	{
d9a98de2	44	struct snd_hwdep *hw = file->private_data;
1da177e4 LT	45	if (hw->ops.llseek)
	46	return hw->ops.llseek(hw, file, offset, orig);
	47	return -ENXIO;
	48	}
	49
d9a98de2 TI	50	static ssize_t snd_hwdep_read(struct file * file, char __user *buf,
d9a98de2 TI	51	size_t count, loff_t *offset)
1da177e4	52	{
d9a98de2	53	struct snd_hwdep *hw = file->private_data;
1da177e4 LT	54	if (hw->ops.read)
	55	return hw->ops.read(hw, buf, count, offset);
	56	return -ENXIO;
	57	}
	58
d9a98de2 TI	59	static ssize_t snd_hwdep_write(struct file * file, const char __user *buf,
d9a98de2 TI	60	size_t count, loff_t *offset)
1da177e4	61	{
d9a98de2	62	struct snd_hwdep *hw = file->private_data;
1da177e4 LT	63	if (hw->ops.write)
	64	return hw->ops.write(hw, buf, count, offset);
	65	return -ENXIO;
	66	}
	67
	68	static int snd_hwdep_open(struct inode inode, struct file file)
	69	{
	70	int major = imajor(inode);
d9a98de2	71	struct snd_hwdep *hw;
1da177e4	72	int err;
ac6424b9	73	wait_queue_entry_t wait;
1da177e4	74
f1902860	75	if (major == snd_major) {
f87135f5 CL	76	hw = snd_lookup_minor_data(iminor(inode),
f87135f5 CL	77	SNDRV_DEVICE_TYPE_HWDEP);
1da177e4	78	#ifdef CONFIG_SND_OSSEMUL
f1902860	79	} else if (major == SOUND_MAJOR) {
f87135f5 CL	80	hw = snd_lookup_oss_minor_data(iminor(inode),
f87135f5 CL	81	SNDRV_OSS_DEVICE_TYPE_DMFM);
1da177e4	82	#endif
f1902860	83	} else
1da177e4	84	return -ENXIO;
1da177e4 LT	85	if (hw == NULL)
	86	return -ENODEV;
	87
a0830dbd TI	88	if (!try_module_get(hw->card->module)) {
a0830dbd TI	89	snd_card_unref(hw->card);
1da177e4	90	return -EFAULT;
a0830dbd	91	}
1da177e4 LT	92
	93	init_waitqueue_entry(&wait, current);
	94	add_wait_queue(&hw->open_wait, &wait);
1a60d4c5	95	mutex_lock(&hw->open_mutex);
1da177e4 LT	96	while (1) {
	97	if (hw->exclusive && hw->used > 0) {
	98	err = -EBUSY;
	99	break;
	100	}
345d0b19 TI	101	if (!hw->ops.open) {
	102	err = 0;
	103	break;
	104	}
1da177e4 LT	105	err = hw->ops.open(hw, file);
	106	if (err >= 0)
	107	break;
	108	if (err == -EAGAIN) {
	109	if (file->f_flags & O_NONBLOCK) {
	110	err = -EBUSY;
	111	break;
	112	}
	113	} else
	114	break;
	115	set_current_state(TASK_INTERRUPTIBLE);
1a60d4c5	116	mutex_unlock(&hw->open_mutex);
1da177e4	117	schedule();
1a60d4c5	118	mutex_lock(&hw->open_mutex);
0914f796 TI	119	if (hw->card->shutdown) {
	120	err = -ENODEV;
	121	break;
	122	}
1da177e4 LT	123	if (signal_pending(current)) {
	124	err = -ERESTARTSYS;
	125	break;
	126	}
	127	}
	128	remove_wait_queue(&hw->open_wait, &wait);
	129	if (err >= 0) {
	130	err = snd_card_file_add(hw->card, file);
	131	if (err >= 0) {
	132	file->private_data = hw;
	133	hw->used++;
	134	} else {
	135	if (hw->ops.release)
	136	hw->ops.release(hw, file);
	137	}
	138	}
1a60d4c5	139	mutex_unlock(&hw->open_mutex);
1da177e4 LT	140	if (err < 0)
1da177e4 LT	141	module_put(hw->card->module);
a0830dbd	142	snd_card_unref(hw->card);
1da177e4 LT	143	return err;
	144	}
	145
	146	static int snd_hwdep_release(struct inode inode, struct file file)
	147	{
345d0b19	148	int err = 0;
d9a98de2	149	struct snd_hwdep *hw = file->private_data;
104326f8	150	struct module *mod = hw->card->module;
8fa58af7	151
1a60d4c5	152	mutex_lock(&hw->open_mutex);
8fa58af7	153	if (hw->ops.release)
1da177e4	154	err = hw->ops.release(hw, file);
1da177e4 LT	155	if (hw->used > 0)
1da177e4 LT	156	hw->used--;
1a60d4c5	157	mutex_unlock(&hw->open_mutex);
8fa58af7 KW	158	wake_up(&hw->open_wait);
	159
	160	snd_card_file_remove(hw->card, file);
104326f8	161	module_put(mod);
1da177e4 LT	162	return err;
	163	}
	164
680ef72a	165	static __poll_t snd_hwdep_poll(struct file * file, poll_table * wait)
1da177e4	166	{
d9a98de2	167	struct snd_hwdep *hw = file->private_data;
1da177e4 LT	168	if (hw->ops.poll)
	169	return hw->ops.poll(hw, file, wait);
	170	return 0;
	171	}
	172
d9a98de2 TI	173	static int snd_hwdep_info(struct snd_hwdep *hw,
d9a98de2 TI	174	struct snd_hwdep_info __user *_info)
1da177e4	175	{
d9a98de2	176	struct snd_hwdep_info info;
1da177e4 LT	177
	178	memset(&info, 0, sizeof(info));
	179	info.card = hw->card->number;
75b1a8f9 JP	180	strscpy(info.id, hw->id, sizeof(info.id));
75b1a8f9 JP	181	strscpy(info.name, hw->name, sizeof(info.name));
1da177e4 LT	182	info.iface = hw->iface;
	183	if (copy_to_user(_info, &info, sizeof(info)))
	184	return -EFAULT;
	185	return 0;
	186	}
	187
d9a98de2 TI	188	static int snd_hwdep_dsp_status(struct snd_hwdep *hw,
d9a98de2 TI	189	struct snd_hwdep_dsp_status __user *_info)
1da177e4	190	{
d9a98de2	191	struct snd_hwdep_dsp_status info;
1da177e4 LT	192	int err;
	193
	194	if (! hw->ops.dsp_status)
	195	return -ENXIO;
	196	memset(&info, 0, sizeof(info));
	197	info.dsp_loaded = hw->dsp_loaded;
e3ded899 TI	198	err = hw->ops.dsp_status(hw, &info);
e3ded899 TI	199	if (err < 0)
1da177e4 LT	200	return err;
	201	if (copy_to_user(_info, &info, sizeof(info)))
	202	return -EFAULT;
	203	return 0;
	204	}
	205
d9a98de2	206	static int snd_hwdep_dsp_load(struct snd_hwdep *hw,
18d122c0	207	struct snd_hwdep_dsp_image *info)
1da177e4	208	{
1da177e4 LT	209	int err;
	210
	211	if (! hw->ops.dsp_load)
	212	return -ENXIO;
18d122c0	213	if (info->index >= 32)
c4fd4379	214	return -EINVAL;
1da177e4	215	/* check whether the dsp was already loaded */
18d122c0	216	if (hw->dsp_loaded & (1u << info->index))
1da177e4	217	return -EBUSY;
18d122c0	218	err = hw->ops.dsp_load(hw, info);
1da177e4 LT	219	if (err < 0)
1da177e4 LT	220	return err;
18d122c0	221	hw->dsp_loaded \|= (1u << info->index);
1da177e4 LT	222	return 0;
	223	}
	224
18d122c0 AB	225	static int snd_hwdep_dsp_load_user(struct snd_hwdep *hw,
	226	struct snd_hwdep_dsp_image __user *_info)
	227	{
	228	struct snd_hwdep_dsp_image info = {};
	229
	230	if (copy_from_user(&info, _info, sizeof(info)))
	231	return -EFAULT;
	232	return snd_hwdep_dsp_load(hw, &info);
	233	}
	234
	235
d9a98de2 TI	236	static long snd_hwdep_ioctl(struct file * file, unsigned int cmd,
d9a98de2 TI	237	unsigned long arg)
1da177e4	238	{
d9a98de2	239	struct snd_hwdep *hw = file->private_data;
1da177e4 LT	240	void __user argp = (void __user )arg;
	241	switch (cmd) {
	242	case SNDRV_HWDEP_IOCTL_PVERSION:
	243	return put_user(SNDRV_HWDEP_VERSION, (int __user *)argp);
	244	case SNDRV_HWDEP_IOCTL_INFO:
	245	return snd_hwdep_info(hw, argp);
	246	case SNDRV_HWDEP_IOCTL_DSP_STATUS:
	247	return snd_hwdep_dsp_status(hw, argp);
	248	case SNDRV_HWDEP_IOCTL_DSP_LOAD:
18d122c0	249	return snd_hwdep_dsp_load_user(hw, argp);
1da177e4 LT	250	}
	251	if (hw->ops.ioctl)
	252	return hw->ops.ioctl(hw, file, cmd, arg);
	253	return -ENOTTY;
	254	}
	255
	256	static int snd_hwdep_mmap(struct file * file, struct vm_area_struct * vma)
	257	{
d9a98de2	258	struct snd_hwdep *hw = file->private_data;
1da177e4 LT	259	if (hw->ops.mmap)
	260	return hw->ops.mmap(hw, file, vma);
	261	return -ENXIO;
	262	}
	263
d9a98de2 TI	264	static int snd_hwdep_control_ioctl(struct snd_card *card,
d9a98de2 TI	265	struct snd_ctl_file * control,
1da177e4 LT	266	unsigned int cmd, unsigned long arg)
1da177e4 LT	267	{
1da177e4 LT	268	switch (cmd) {
	269	case SNDRV_CTL_IOCTL_HWDEP_NEXT_DEVICE:
	270	{
	271	int device;
	272
	273	if (get_user(device, (int __user *)arg))
	274	return -EFAULT;
1a60d4c5	275	mutex_lock(&register_mutex);
f7b2bb85 DC	276
	277	if (device < 0)
	278	device = 0;
	279	else if (device < SNDRV_MINOR_HWDEPS)
	280	device++;
	281	else
	282	device = SNDRV_MINOR_HWDEPS;
	283
1da177e4	284	while (device < SNDRV_MINOR_HWDEPS) {
f87135f5	285	if (snd_hwdep_search(card, device))
1da177e4 LT	286	break;
	287	device++;
	288	}
	289	if (device >= SNDRV_MINOR_HWDEPS)
	290	device = -1;
1a60d4c5	291	mutex_unlock(&register_mutex);
1da177e4 LT	292	if (put_user(device, (int __user *)arg))
	293	return -EFAULT;
	294	return 0;
	295	}
	296	case SNDRV_CTL_IOCTL_HWDEP_INFO:
	297	{
d9a98de2	298	struct snd_hwdep_info __user info = (struct snd_hwdep_info __user )arg;
f87135f5	299	int device, err;
d9a98de2	300	struct snd_hwdep *hwdep;
1da177e4 LT	301
	302	if (get_user(device, &info->device))
	303	return -EFAULT;
1a60d4c5	304	mutex_lock(&register_mutex);
f87135f5 CL	305	hwdep = snd_hwdep_search(card, device);
	306	if (hwdep)
	307	err = snd_hwdep_info(hwdep, info);
	308	else
	309	err = -ENXIO;
1a60d4c5	310	mutex_unlock(&register_mutex);
f87135f5	311	return err;
1da177e4 LT	312	}
	313	}
	314	return -ENOIOCTLCMD;
	315	}
	316
	317	#ifdef CONFIG_COMPAT
	318	#include "hwdep_compat.c"
	319	#else
	320	#define snd_hwdep_ioctl_compat NULL
	321	#endif
	322
	323	/*
	324
	325	*/
	326
9c2e08c5	327	static const struct file_operations snd_hwdep_f_ops =
1da177e4 LT	328	{
	329	.owner = THIS_MODULE,
	330	.llseek = snd_hwdep_llseek,
	331	.read = snd_hwdep_read,
	332	.write = snd_hwdep_write,
	333	.open = snd_hwdep_open,
	334	.release = snd_hwdep_release,
	335	.poll = snd_hwdep_poll,
	336	.unlocked_ioctl = snd_hwdep_ioctl,
	337	.compat_ioctl = snd_hwdep_ioctl_compat,
	338	.mmap = snd_hwdep_mmap,
	339	};
	340
7b461600 TI	341	static void release_hwdep_device(struct device *dev)
	342	{
	343	kfree(container_of(dev, struct snd_hwdep, dev));
	344	}
	345
1da177e4 LT	346	/**
	347	* snd_hwdep_new - create a new hwdep instance
	348	* @card: the card instance
	349	* @id: the id string
	350	* @device: the device index (zero-based)
	351	* @rhwdep: the pointer to store the new hwdep instance
	352	*
	353	* Creates a new hwdep instance with the given index on the card.
	354	* The callbacks (hwdep->ops) must be set on the returned instance
	355	* after this call manually by the caller.
	356	*
eb7c06e8	357	* Return: Zero if successful, or a negative error code on failure.
1da177e4	358	*/
d9a98de2 TI	359	int snd_hwdep_new(struct snd_card card, char id, int device,
d9a98de2 TI	360	struct snd_hwdep **rhwdep)
1da177e4	361	{
d9a98de2	362	struct snd_hwdep *hwdep;
1da177e4	363	int err;
f15ee210	364	static const struct snd_device_ops ops = {
1da177e4 LT	365	.dev_free = snd_hwdep_dev_free,
1da177e4 LT	366	.dev_register = snd_hwdep_dev_register,
c461482c	367	.dev_disconnect = snd_hwdep_dev_disconnect,
1da177e4 LT	368	};
1da177e4 LT	369
7eaa943c TI	370	if (snd_BUG_ON(!card))
	371	return -ENXIO;
	372	if (rhwdep)
	373	*rhwdep = NULL;
ca2c0966	374	hwdep = kzalloc(sizeof(*hwdep), GFP_KERNEL);
ec0e9937	375	if (!hwdep)
1da177e4	376	return -ENOMEM;
7b461600 TI	377
	378	init_waitqueue_head(&hwdep->open_wait);
	379	mutex_init(&hwdep->open_mutex);
1da177e4 LT	380	hwdep->card = card;
1da177e4 LT	381	hwdep->device = device;
73e77ba0	382	if (id)
75b1a8f9	383	strscpy(hwdep->id, id, sizeof(hwdep->id));
7b461600 TI	384
	385	snd_device_initialize(&hwdep->dev, card);
	386	hwdep->dev.release = release_hwdep_device;
	387	dev_set_name(&hwdep->dev, "hwC%iD%i", card->number, device);
1da177e4 LT	388	#ifdef CONFIG_SND_OSSEMUL
	389	hwdep->oss_type = -1;
	390	#endif
7b461600 TI	391
	392	err = snd_device_new(card, SNDRV_DEV_HWDEP, hwdep, &ops);
	393	if (err < 0) {
	394	put_device(&hwdep->dev);
1da177e4 LT	395	return err;
1da177e4 LT	396	}
7b461600	397
7eaa943c TI	398	if (rhwdep)
7eaa943c TI	399	*rhwdep = hwdep;
1da177e4 LT	400	return 0;
1da177e4 LT	401	}
6776a5d7	402	EXPORT_SYMBOL(snd_hwdep_new);
1da177e4	403
7b461600	404	static int snd_hwdep_dev_free(struct snd_device *device)
1da177e4	405	{
7b461600	406	struct snd_hwdep *hwdep = device->device_data;
7eaa943c TI	407	if (!hwdep)
7eaa943c TI	408	return 0;
1da177e4 LT	409	if (hwdep->private_free)
1da177e4 LT	410	hwdep->private_free(hwdep);
7b461600	411	put_device(&hwdep->dev);
1da177e4 LT	412	return 0;
	413	}
	414
d9a98de2	415	static int snd_hwdep_dev_register(struct snd_device *device)
1da177e4	416	{
d9a98de2	417	struct snd_hwdep *hwdep = device->device_data;
2ebef69f	418	struct snd_card *card = hwdep->card;
f87135f5	419	int err;
1da177e4	420
1a60d4c5	421	mutex_lock(&register_mutex);
2ebef69f	422	if (snd_hwdep_search(card, hwdep->device)) {
1a60d4c5	423	mutex_unlock(&register_mutex);
1da177e4 LT	424	return -EBUSY;
1da177e4 LT	425	}
f87135f5	426	list_add_tail(&hwdep->list, &snd_hwdep_devices);
40a4b263 TI	427	err = snd_register_device(SNDRV_DEVICE_TYPE_HWDEP,
	428	hwdep->card, hwdep->device,
	429	&snd_hwdep_f_ops, hwdep, &hwdep->dev);
71e2e1c1	430	if (err < 0) {
7b461600	431	dev_err(&hwdep->dev, "unable to register\n");
f87135f5	432	list_del(&hwdep->list);
1a60d4c5	433	mutex_unlock(&register_mutex);
1da177e4 LT	434	return err;
1da177e4 LT	435	}
caa751ba	436
1da177e4 LT	437	#ifdef CONFIG_SND_OSSEMUL
	438	hwdep->ossreg = 0;
	439	if (hwdep->oss_type >= 0) {
7b461600 TI	440	if (hwdep->oss_type == SNDRV_OSS_DEVICE_TYPE_DMFM &&
	441	hwdep->device)
	442	dev_warn(&hwdep->dev,
2ebef69f	443	"only hwdep device 0 can be registered as OSS direct FM device!\n");
7b461600 TI	444	else if (snd_register_oss_device(hwdep->oss_type,
	445	card, hwdep->device,
	446	&snd_hwdep_f_ops, hwdep) < 0)
	447	dev_warn(&hwdep->dev,
	448	"unable to register OSS compatibility device\n");
	449	else
	450	hwdep->ossreg = 1;
1da177e4 LT	451	}
1da177e4 LT	452	#endif
1a60d4c5	453	mutex_unlock(&register_mutex);
1da177e4 LT	454	return 0;
	455	}
	456
c461482c	457	static int snd_hwdep_dev_disconnect(struct snd_device *device)
1da177e4	458	{
d9a98de2	459	struct snd_hwdep *hwdep = device->device_data;
1da177e4	460
7eaa943c TI	461	if (snd_BUG_ON(!hwdep))
7eaa943c TI	462	return -ENXIO;
1a60d4c5	463	mutex_lock(&register_mutex);
f87135f5	464	if (snd_hwdep_search(hwdep->card, hwdep->device) != hwdep) {
1a60d4c5	465	mutex_unlock(&register_mutex);
1da177e4 LT	466	return -EINVAL;
1da177e4 LT	467	}
0914f796 TI	468	mutex_lock(&hwdep->open_mutex);
0914f796 TI	469	wake_up(&hwdep->open_wait);
1da177e4 LT	470	#ifdef CONFIG_SND_OSSEMUL
	471	if (hwdep->ossreg)
	472	snd_unregister_oss_device(hwdep->oss_type, hwdep->card, hwdep->device);
	473	#endif
40a4b263	474	snd_unregister_device(&hwdep->dev);
c461482c	475	list_del_init(&hwdep->list);
0914f796	476	mutex_unlock(&hwdep->open_mutex);
1a60d4c5	477	mutex_unlock(&register_mutex);
c461482c	478	return 0;
1da177e4 LT	479	}
1da177e4 LT	480
cd6a6503	481	#ifdef CONFIG_SND_PROC_FS
1da177e4 LT	482	/*
	483	* Info interface
	484	*/
	485
d9a98de2 TI	486	static void snd_hwdep_proc_read(struct snd_info_entry *entry,
d9a98de2 TI	487	struct snd_info_buffer *buffer)
1da177e4	488	{
d9a98de2	489	struct snd_hwdep *hwdep;
1da177e4	490
1a60d4c5	491	mutex_lock(&register_mutex);
9244b2c3	492	list_for_each_entry(hwdep, &snd_hwdep_devices, list)
1da177e4	493	snd_iprintf(buffer, "%02i-%02i: %s\n",
f87135f5	494	hwdep->card->number, hwdep->device, hwdep->name);
1a60d4c5	495	mutex_unlock(&register_mutex);
1da177e4 LT	496	}
1da177e4 LT	497
e28563cc	498	static struct snd_info_entry *snd_hwdep_proc_entry;
1da177e4	499
e28563cc	500	static void __init snd_hwdep_proc_init(void)
1da177e4	501	{
d9a98de2	502	struct snd_info_entry *entry;
1da177e4	503
e3ded899 TI	504	entry = snd_info_create_module_entry(THIS_MODULE, "hwdep", NULL);
e3ded899 TI	505	if (entry) {
1da177e4 LT	506	entry->c.text.read = snd_hwdep_proc_read;
	507	if (snd_info_register(entry) < 0) {
	508	snd_info_free_entry(entry);
	509	entry = NULL;
	510	}
	511	}
	512	snd_hwdep_proc_entry = entry;
e28563cc TI	513	}
	514
	515	static void __exit snd_hwdep_proc_done(void)
	516	{
746d4a02	517	snd_info_free_entry(snd_hwdep_proc_entry);
e28563cc	518	}
cd6a6503	519	#else /* !CONFIG_SND_PROC_FS */
e28563cc TI	520	#define snd_hwdep_proc_init()
e28563cc TI	521	#define snd_hwdep_proc_done()
cd6a6503	522	#endif /* CONFIG_SND_PROC_FS */
e28563cc TI	523
	524
	525	/*
	526	* ENTRY functions
	527	*/
	528
	529	static int __init alsa_hwdep_init(void)
	530	{
	531	snd_hwdep_proc_init();
1da177e4 LT	532	snd_ctl_register_ioctl(snd_hwdep_control_ioctl);
	533	snd_ctl_register_ioctl_compat(snd_hwdep_control_ioctl);
	534	return 0;
	535	}
	536
	537	static void __exit alsa_hwdep_exit(void)
	538	{
	539	snd_ctl_unregister_ioctl(snd_hwdep_control_ioctl);
	540	snd_ctl_unregister_ioctl_compat(snd_hwdep_control_ioctl);
e28563cc	541	snd_hwdep_proc_done();
1da177e4 LT	542	}
	543
	544	module_init(alsa_hwdep_init)
	545	module_exit(alsa_hwdep_exit)