control.c 49.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2
/*
 *  Routines for driver control interface
3
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
L
Linus Torvalds 已提交
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 *
 *   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/threads.h>
#include <linux/interrupt.h>
24
#include <linux/module.h>
L
Linus Torvalds 已提交
25 26 27 28 29 30 31 32 33 34
#include <linux/slab.h>
#include <linux/vmalloc.h>
#include <linux/time.h>
#include <sound/core.h>
#include <sound/minors.h>
#include <sound/info.h>
#include <sound/control.h>

/* max number of user-defined controls */
#define MAX_USER_CONTROLS	32
35
#define MAX_CONTROL_COUNT	1028
L
Linus Torvalds 已提交
36

37
struct snd_kctl_ioctl {
L
Linus Torvalds 已提交
38 39
	struct list_head list;		/* list of all ioctls */
	snd_kctl_ioctl_func_t fioctl;
40
};
L
Linus Torvalds 已提交
41 42 43 44 45 46 47 48 49 50

static DECLARE_RWSEM(snd_ioctl_rwsem);
static LIST_HEAD(snd_control_ioctls);
#ifdef CONFIG_COMPAT
static LIST_HEAD(snd_control_compat_ioctls);
#endif

static int snd_ctl_open(struct inode *inode, struct file *file)
{
	unsigned long flags;
51 52
	struct snd_card *card;
	struct snd_ctl_file *ctl;
53
	int i, err;
L
Linus Torvalds 已提交
54

T
Takashi Iwai 已提交
55 56 57 58
	err = nonseekable_open(inode, file);
	if (err < 0)
		return err;

59
	card = snd_lookup_minor_data(iminor(inode), SNDRV_DEVICE_TYPE_CONTROL);
L
Linus Torvalds 已提交
60 61 62 63 64 65 66 67 68 69 70 71 72
	if (!card) {
		err = -ENODEV;
		goto __error1;
	}
	err = snd_card_file_add(card, file);
	if (err < 0) {
		err = -ENODEV;
		goto __error1;
	}
	if (!try_module_get(card->module)) {
		err = -EFAULT;
		goto __error2;
	}
73
	ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
L
Linus Torvalds 已提交
74 75 76 77 78 79 80 81
	if (ctl == NULL) {
		err = -ENOMEM;
		goto __error;
	}
	INIT_LIST_HEAD(&ctl->events);
	init_waitqueue_head(&ctl->change_sleep);
	spin_lock_init(&ctl->read_lock);
	ctl->card = card;
82 83
	for (i = 0; i < SND_CTL_SUBDEV_ITEMS; i++)
		ctl->preferred_subdevice[i] = -1;
84
	ctl->pid = get_pid(task_pid(current));
L
Linus Torvalds 已提交
85 86 87 88
	file->private_data = ctl;
	write_lock_irqsave(&card->ctl_files_rwlock, flags);
	list_add_tail(&ctl->list, &card->ctl_files);
	write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
89
	snd_card_unref(card);
L
Linus Torvalds 已提交
90 91 92 93 94 95 96
	return 0;

      __error:
	module_put(card->module);
      __error2:
	snd_card_file_remove(card, file);
      __error1:
97 98
	if (card)
		snd_card_unref(card);
L
Linus Torvalds 已提交
99 100 101
      	return err;
}

102
static void snd_ctl_empty_read_queue(struct snd_ctl_file * ctl)
L
Linus Torvalds 已提交
103
{
104
	unsigned long flags;
105
	struct snd_kctl_event *cread;
L
Linus Torvalds 已提交
106
	
107
	spin_lock_irqsave(&ctl->read_lock, flags);
L
Linus Torvalds 已提交
108 109 110 111 112
	while (!list_empty(&ctl->events)) {
		cread = snd_kctl_event(ctl->events.next);
		list_del(&cread->list);
		kfree(cread);
	}
113
	spin_unlock_irqrestore(&ctl->read_lock, flags);
L
Linus Torvalds 已提交
114 115 116 117 118
}

static int snd_ctl_release(struct inode *inode, struct file *file)
{
	unsigned long flags;
119 120 121
	struct snd_card *card;
	struct snd_ctl_file *ctl;
	struct snd_kcontrol *control;
L
Linus Torvalds 已提交
122 123 124 125 126 127 128 129 130
	unsigned int idx;

	ctl = file->private_data;
	file->private_data = NULL;
	card = ctl->card;
	write_lock_irqsave(&card->ctl_files_rwlock, flags);
	list_del(&ctl->list);
	write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
	down_write(&card->controls_rwsem);
131
	list_for_each_entry(control, &card->controls, list)
L
Linus Torvalds 已提交
132 133 134 135 136
		for (idx = 0; idx < control->count; idx++)
			if (control->vd[idx].owner == ctl)
				control->vd[idx].owner = NULL;
	up_write(&card->controls_rwsem);
	snd_ctl_empty_read_queue(ctl);
137
	put_pid(ctl->pid);
L
Linus Torvalds 已提交
138 139 140 141 142 143
	kfree(ctl);
	module_put(card->module);
	snd_card_file_remove(card, file);
	return 0;
}

144 145 146 147 148 149 150 151 152 153
/**
 * snd_ctl_notify - Send notification to user-space for a control change
 * @card: the card to send notification
 * @mask: the event mask, SNDRV_CTL_EVENT_*
 * @id: the ctl element id to send notification
 *
 * This function adds an event record with the given id and mask, appends
 * to the list and wakes up the user-space for notification.  This can be
 * called in the atomic context.
 */
154 155
void snd_ctl_notify(struct snd_card *card, unsigned int mask,
		    struct snd_ctl_elem_id *id)
L
Linus Torvalds 已提交
156 157
{
	unsigned long flags;
158 159
	struct snd_ctl_file *ctl;
	struct snd_kctl_event *ev;
L
Linus Torvalds 已提交
160
	
161 162
	if (snd_BUG_ON(!card || !id))
		return;
L
Linus Torvalds 已提交
163
	read_lock(&card->ctl_files_rwlock);
T
Takashi Iwai 已提交
164
#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
L
Linus Torvalds 已提交
165 166
	card->mixer_oss_change_count++;
#endif
167
	list_for_each_entry(ctl, &card->ctl_files, list) {
L
Linus Torvalds 已提交
168 169 170
		if (!ctl->subscribed)
			continue;
		spin_lock_irqsave(&ctl->read_lock, flags);
171
		list_for_each_entry(ev, &ctl->events, list) {
L
Linus Torvalds 已提交
172 173 174 175 176
			if (ev->id.numid == id->numid) {
				ev->mask |= mask;
				goto _found;
			}
		}
177
		ev = kzalloc(sizeof(*ev), GFP_ATOMIC);
L
Linus Torvalds 已提交
178 179 180 181 182
		if (ev) {
			ev->id = *id;
			ev->mask = mask;
			list_add_tail(&ev->list, &ctl->events);
		} else {
183
			dev_err(card->dev, "No memory available to allocate event\n");
L
Linus Torvalds 已提交
184 185 186 187 188 189 190 191
		}
	_found:
		wake_up(&ctl->change_sleep);
		spin_unlock_irqrestore(&ctl->read_lock, flags);
		kill_fasync(&ctl->fasync, SIGIO, POLL_IN);
	}
	read_unlock(&card->ctl_files_rwlock);
}
192 193
EXPORT_SYMBOL(snd_ctl_notify);

L
Linus Torvalds 已提交
194
/**
195 196 197 198 199
 * snd_ctl_new - create a new control instance with some elements
 * @kctl: the pointer to store new control instance
 * @count: the number of elements in this control
 * @access: the default access flags for elements in this control
 * @file: given when locking these elements
L
Linus Torvalds 已提交
200
 *
201 202 203
 * Allocates a memory object for a new control instance. The instance has
 * elements as many as the given number (@count). Each element has given
 * access permissions (@access). Each element is locked when @file is given.
L
Linus Torvalds 已提交
204
 *
205
 * Return: 0 on success, error code on failure
L
Linus Torvalds 已提交
206
 */
207 208
static int snd_ctl_new(struct snd_kcontrol **kctl, unsigned int count,
		       unsigned int access, struct snd_ctl_file *file)
L
Linus Torvalds 已提交
209
{
210
	unsigned int size;
L
Linus Torvalds 已提交
211 212
	unsigned int idx;
	
213 214
	if (count == 0 || count > MAX_CONTROL_COUNT)
		return -EINVAL;
215

216 217
	size  = sizeof(struct snd_kcontrol);
	size += sizeof(struct snd_kcontrol_volatile) * count;
218

219
	*kctl = kzalloc(size, GFP_KERNEL);
220
	if (!*kctl)
221 222 223 224 225 226 227 228 229
		return -ENOMEM;

	for (idx = 0; idx < count; idx++) {
		(*kctl)->vd[idx].access = access;
		(*kctl)->vd[idx].owner = file;
	}
	(*kctl)->count = count;

	return 0;
L
Linus Torvalds 已提交
230 231 232 233 234 235 236
}

/**
 * snd_ctl_new1 - create a control instance from the template
 * @ncontrol: the initialization record
 * @private_data: the private data to set
 *
237
 * Allocates a new struct snd_kcontrol instance and initialize from the given 
L
Linus Torvalds 已提交
238 239 240
 * template.  When the access field of ncontrol is 0, it's assumed as
 * READWRITE access. When the count field is 0, it's assumes as one.
 *
241
 * Return: The pointer of the newly generated instance, or %NULL on failure.
L
Linus Torvalds 已提交
242
 */
243 244
struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new *ncontrol,
				  void *private_data)
L
Linus Torvalds 已提交
245
{
246 247
	struct snd_kcontrol *kctl;
	unsigned int count;
L
Linus Torvalds 已提交
248
	unsigned int access;
249
	int err;
L
Linus Torvalds 已提交
250
	
251 252
	if (snd_BUG_ON(!ncontrol || !ncontrol->info))
		return NULL;
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275

	count = ncontrol->count;
	if (count == 0)
		count = 1;

	access = ncontrol->access;
	if (access == 0)
		access = SNDRV_CTL_ELEM_ACCESS_READWRITE;
	access &= (SNDRV_CTL_ELEM_ACCESS_READWRITE |
		   SNDRV_CTL_ELEM_ACCESS_VOLATILE |
		   SNDRV_CTL_ELEM_ACCESS_INACTIVE |
		   SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE |
		   SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND |
		   SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);

	err = snd_ctl_new(&kctl, count, access, NULL);
	if (err < 0)
		return NULL;

	/* The 'numid' member is decided when calling snd_ctl_add(). */
	kctl->id.iface = ncontrol->iface;
	kctl->id.device = ncontrol->device;
	kctl->id.subdevice = ncontrol->subdevice;
276
	if (ncontrol->name) {
277 278
		strlcpy(kctl->id.name, ncontrol->name, sizeof(kctl->id.name));
		if (strcmp(ncontrol->name, kctl->id.name) != 0)
279
			pr_warn("ALSA: Control name '%s' truncated to '%s'\n",
280
				ncontrol->name, kctl->id.name);
281
	}
282 283 284 285 286 287 288 289 290 291 292
	kctl->id.index = ncontrol->index;

	kctl->info = ncontrol->info;
	kctl->get = ncontrol->get;
	kctl->put = ncontrol->put;
	kctl->tlv.p = ncontrol->tlv.p;

	kctl->private_value = ncontrol->private_value;
	kctl->private_data = private_data;

	return kctl;
L
Linus Torvalds 已提交
293
}
294 295
EXPORT_SYMBOL(snd_ctl_new1);

L
Linus Torvalds 已提交
296 297 298 299 300 301 302 303
/**
 * snd_ctl_free_one - release the control instance
 * @kcontrol: the control instance
 *
 * Releases the control instance created via snd_ctl_new()
 * or snd_ctl_new1().
 * Don't call this after the control was added to the card.
 */
304
void snd_ctl_free_one(struct snd_kcontrol *kcontrol)
L
Linus Torvalds 已提交
305 306 307 308 309 310 311
{
	if (kcontrol) {
		if (kcontrol->private_free)
			kcontrol->private_free(kcontrol);
		kfree(kcontrol);
	}
}
312 313
EXPORT_SYMBOL(snd_ctl_free_one);

314 315
static bool snd_ctl_remove_numid_conflict(struct snd_card *card,
					  unsigned int count)
L
Linus Torvalds 已提交
316
{
317
	struct snd_kcontrol *kctl;
L
Linus Torvalds 已提交
318

319 320 321 322
	/* Make sure that the ids assigned to the control do not wrap around */
	if (card->last_numid >= UINT_MAX - count)
		card->last_numid = 0;

323
	list_for_each_entry(kctl, &card->controls, list) {
324
		if (kctl->id.numid < card->last_numid + 1 + count &&
325 326 327 328
		    kctl->id.numid + kctl->count > card->last_numid + 1) {
		    	card->last_numid = kctl->id.numid + kctl->count - 1;
			return true;
		}
L
Linus Torvalds 已提交
329
	}
330
	return false;
L
Linus Torvalds 已提交
331 332
}

333
static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
L
Linus Torvalds 已提交
334
{
335
	unsigned int iter = 100000;
L
Linus Torvalds 已提交
336

337
	while (snd_ctl_remove_numid_conflict(card, count)) {
L
Linus Torvalds 已提交
338 339
		if (--iter == 0) {
			/* this situation is very unlikely */
340
			dev_err(card->dev, "unable to allocate new control numid\n");
L
Linus Torvalds 已提交
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
			return -ENOMEM;
		}
	}
	return 0;
}

/**
 * snd_ctl_add - add the control instance to the card
 * @card: the card instance
 * @kcontrol: the control instance to add
 *
 * Adds the control instance created via snd_ctl_new() or
 * snd_ctl_new1() to the given card. Assigns also an unique
 * numid used for fast search.
 *
 * It frees automatically the control which cannot be added.
357 358 359
 *
 * Return: Zero if successful, or a negative error code on failure.
 *
L
Linus Torvalds 已提交
360
 */
361
int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
L
Linus Torvalds 已提交
362
{
363
	struct snd_ctl_elem_id id;
L
Linus Torvalds 已提交
364
	unsigned int idx;
365
	unsigned int count;
366
	int err = -EINVAL;
L
Linus Torvalds 已提交
367

T
Takashi Iwai 已提交
368
	if (! kcontrol)
369
		return err;
370 371
	if (snd_BUG_ON(!card || !kcontrol->info))
		goto error;
L
Linus Torvalds 已提交
372
	id = kcontrol->id;
373 374 375
	if (id.index > UINT_MAX - kcontrol->count)
		goto error;

L
Linus Torvalds 已提交
376 377 378
	down_write(&card->controls_rwsem);
	if (snd_ctl_find_id(card, &id)) {
		up_write(&card->controls_rwsem);
379
		dev_err(card->dev, "control %i:%i:%i:%s:%i is already present\n",
L
Linus Torvalds 已提交
380 381 382 383 384
					id.iface,
					id.device,
					id.subdevice,
					id.name,
					id.index);
385 386
		err = -EBUSY;
		goto error;
L
Linus Torvalds 已提交
387 388 389
	}
	if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
		up_write(&card->controls_rwsem);
390 391
		err = -ENOMEM;
		goto error;
L
Linus Torvalds 已提交
392 393 394 395 396
	}
	list_add_tail(&kcontrol->list, &card->controls);
	card->controls_count += kcontrol->count;
	kcontrol->id.numid = card->last_numid + 1;
	card->last_numid += kcontrol->count;
397
	id = kcontrol->id;
398
	count = kcontrol->count;
L
Linus Torvalds 已提交
399
	up_write(&card->controls_rwsem);
400
	for (idx = 0; idx < count; idx++, id.index++, id.numid++)
L
Linus Torvalds 已提交
401 402
		snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
	return 0;
403 404 405 406

 error:
	snd_ctl_free_one(kcontrol);
	return err;
L
Linus Torvalds 已提交
407
}
408 409
EXPORT_SYMBOL(snd_ctl_add);

410 411 412 413 414 415 416 417 418 419 420
/**
 * snd_ctl_replace - replace the control instance of the card
 * @card: the card instance
 * @kcontrol: the control instance to replace
 * @add_on_replace: add the control if not already added
 *
 * Replaces the given control.  If the given control does not exist
 * and the add_on_replace flag is set, the control is added.  If the
 * control exists, it is destroyed first.
 *
 * It frees automatically the control which cannot be added or replaced.
421 422
 *
 * Return: Zero if successful, or a negative error code on failure.
423 424 425 426 427
 */
int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol,
		    bool add_on_replace)
{
	struct snd_ctl_elem_id id;
428
	unsigned int count;
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
	unsigned int idx;
	struct snd_kcontrol *old;
	int ret;

	if (!kcontrol)
		return -EINVAL;
	if (snd_BUG_ON(!card || !kcontrol->info)) {
		ret = -EINVAL;
		goto error;
	}
	id = kcontrol->id;
	down_write(&card->controls_rwsem);
	old = snd_ctl_find_id(card, &id);
	if (!old) {
		if (add_on_replace)
			goto add;
		up_write(&card->controls_rwsem);
		ret = -EINVAL;
		goto error;
	}
	ret = snd_ctl_remove(card, old);
	if (ret < 0) {
		up_write(&card->controls_rwsem);
		goto error;
	}
add:
	if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
		up_write(&card->controls_rwsem);
		ret = -ENOMEM;
		goto error;
	}
	list_add_tail(&kcontrol->list, &card->controls);
	card->controls_count += kcontrol->count;
	kcontrol->id.numid = card->last_numid + 1;
	card->last_numid += kcontrol->count;
464
	id = kcontrol->id;
465
	count = kcontrol->count;
466
	up_write(&card->controls_rwsem);
467
	for (idx = 0; idx < count; idx++, id.index++, id.numid++)
468 469 470 471 472 473 474 475 476
		snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
	return 0;

error:
	snd_ctl_free_one(kcontrol);
	return ret;
}
EXPORT_SYMBOL(snd_ctl_replace);

L
Linus Torvalds 已提交
477 478 479 480 481 482 483 484
/**
 * snd_ctl_remove - remove the control from the card and release it
 * @card: the card instance
 * @kcontrol: the control instance to remove
 *
 * Removes the control from the card and then releases the instance.
 * You don't need to call snd_ctl_free_one(). You must be in
 * the write lock - down_write(&card->controls_rwsem).
485 486
 *
 * Return: 0 if successful, or a negative error code on failure.
L
Linus Torvalds 已提交
487
 */
488
int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
L
Linus Torvalds 已提交
489
{
490
	struct snd_ctl_elem_id id;
L
Linus Torvalds 已提交
491 492
	unsigned int idx;

493 494
	if (snd_BUG_ON(!card || !kcontrol))
		return -EINVAL;
L
Linus Torvalds 已提交
495 496 497 498 499 500 501 502
	list_del(&kcontrol->list);
	card->controls_count -= kcontrol->count;
	id = kcontrol->id;
	for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
		snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
	snd_ctl_free_one(kcontrol);
	return 0;
}
503 504
EXPORT_SYMBOL(snd_ctl_remove);

L
Linus Torvalds 已提交
505 506 507 508 509 510 511
/**
 * snd_ctl_remove_id - remove the control of the given id and release it
 * @card: the card instance
 * @id: the control id to remove
 *
 * Finds the control instance with the given id, removes it from the
 * card list and releases it.
512 513
 *
 * Return: 0 if successful, or a negative error code on failure.
L
Linus Torvalds 已提交
514
 */
515
int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
L
Linus Torvalds 已提交
516
{
517
	struct snd_kcontrol *kctl;
L
Linus Torvalds 已提交
518 519 520 521 522 523 524 525 526 527 528 529
	int ret;

	down_write(&card->controls_rwsem);
	kctl = snd_ctl_find_id(card, id);
	if (kctl == NULL) {
		up_write(&card->controls_rwsem);
		return -ENOENT;
	}
	ret = snd_ctl_remove(card, kctl);
	up_write(&card->controls_rwsem);
	return ret;
}
530 531
EXPORT_SYMBOL(snd_ctl_remove_id);

L
Linus Torvalds 已提交
532
/**
533
 * snd_ctl_remove_user_ctl - remove and release the unlocked user control
L
Linus Torvalds 已提交
534 535 536 537 538
 * @file: active control handle
 * @id: the control id to remove
 *
 * Finds the control instance with the given id, removes it from the
 * card list and releases it.
539 540
 *
 * Return: 0 if successful, or a negative error code on failure.
L
Linus Torvalds 已提交
541
 */
542 543
static int snd_ctl_remove_user_ctl(struct snd_ctl_file * file,
				   struct snd_ctl_elem_id *id)
L
Linus Torvalds 已提交
544
{
545 546
	struct snd_card *card = file->card;
	struct snd_kcontrol *kctl;
L
Linus Torvalds 已提交
547 548 549 550 551
	int idx, ret;

	down_write(&card->controls_rwsem);
	kctl = snd_ctl_find_id(card, id);
	if (kctl == NULL) {
552 553
		ret = -ENOENT;
		goto error;
L
Linus Torvalds 已提交
554
	}
555 556 557 558
	if (!(kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_USER)) {
		ret = -EINVAL;
		goto error;
	}
L
Linus Torvalds 已提交
559 560
	for (idx = 0; idx < kctl->count; idx++)
		if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
561 562
			ret = -EBUSY;
			goto error;
L
Linus Torvalds 已提交
563 564
		}
	ret = snd_ctl_remove(card, kctl);
565 566 567
	if (ret < 0)
		goto error;
	card->user_ctl_count--;
568
error:
L
Linus Torvalds 已提交
569 570 571 572
	up_write(&card->controls_rwsem);
	return ret;
}

T
Takashi Iwai 已提交
573 574 575 576 577 578 579 580
/**
 * snd_ctl_activate_id - activate/inactivate the control of the given id
 * @card: the card instance
 * @id: the control id to activate/inactivate
 * @active: non-zero to activate
 *
 * Finds the control instance with the given id, and activate or
 * inactivate the control together with notification, if changed.
581
 * The given ID data is filled with full information.
T
Takashi Iwai 已提交
582
 *
583
 * Return: 0 if unchanged, 1 if changed, or a negative error code on failure.
T
Takashi Iwai 已提交
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
 */
int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
			int active)
{
	struct snd_kcontrol *kctl;
	struct snd_kcontrol_volatile *vd;
	unsigned int index_offset;
	int ret;

	down_write(&card->controls_rwsem);
	kctl = snd_ctl_find_id(card, id);
	if (kctl == NULL) {
		ret = -ENOENT;
		goto unlock;
	}
599
	index_offset = snd_ctl_get_ioff(kctl, id);
T
Takashi Iwai 已提交
600 601 602 603 604 605 606 607 608 609 610
	vd = &kctl->vd[index_offset];
	ret = 0;
	if (active) {
		if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE))
			goto unlock;
		vd->access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
	} else {
		if (vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE)
			goto unlock;
		vd->access |= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
	}
611
	snd_ctl_build_ioff(id, kctl, index_offset);
T
Takashi Iwai 已提交
612 613 614 615 616 617 618 619 620
	ret = 1;
 unlock:
	up_write(&card->controls_rwsem);
	if (ret > 0)
		snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_INFO, id);
	return ret;
}
EXPORT_SYMBOL_GPL(snd_ctl_activate_id);

L
Linus Torvalds 已提交
621 622 623 624 625 626 627 628 629
/**
 * snd_ctl_rename_id - replace the id of a control on the card
 * @card: the card instance
 * @src_id: the old id
 * @dst_id: the new id
 *
 * Finds the control with the old id from the card, and replaces the
 * id with the new one.
 *
630
 * Return: Zero if successful, or a negative error code on failure.
L
Linus Torvalds 已提交
631
 */
632 633
int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
		      struct snd_ctl_elem_id *dst_id)
L
Linus Torvalds 已提交
634
{
635
	struct snd_kcontrol *kctl;
L
Linus Torvalds 已提交
636 637 638 639 640 641 642 643 644 645 646 647 648

	down_write(&card->controls_rwsem);
	kctl = snd_ctl_find_id(card, src_id);
	if (kctl == NULL) {
		up_write(&card->controls_rwsem);
		return -ENOENT;
	}
	kctl->id = *dst_id;
	kctl->id.numid = card->last_numid + 1;
	card->last_numid += kctl->count;
	up_write(&card->controls_rwsem);
	return 0;
}
649 650
EXPORT_SYMBOL(snd_ctl_rename_id);

L
Linus Torvalds 已提交
651 652 653 654 655 656 657 658 659
/**
 * snd_ctl_find_numid - find the control instance with the given number-id
 * @card: the card instance
 * @numid: the number-id to search
 *
 * Finds the control instance with the given number-id from the card.
 *
 * The caller must down card->controls_rwsem before calling this function
 * (if the race condition can happen).
660 661 662
 *
 * Return: The pointer of the instance if found, or %NULL if not.
 *
L
Linus Torvalds 已提交
663
 */
664
struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
L
Linus Torvalds 已提交
665
{
666
	struct snd_kcontrol *kctl;
L
Linus Torvalds 已提交
667

668 669
	if (snd_BUG_ON(!card || !numid))
		return NULL;
670
	list_for_each_entry(kctl, &card->controls, list) {
L
Linus Torvalds 已提交
671 672 673 674 675
		if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
			return kctl;
	}
	return NULL;
}
676 677
EXPORT_SYMBOL(snd_ctl_find_numid);

L
Linus Torvalds 已提交
678 679 680 681 682 683 684 685 686
/**
 * snd_ctl_find_id - find the control instance with the given id
 * @card: the card instance
 * @id: the id to search
 *
 * Finds the control instance with the given id from the card.
 *
 * The caller must down card->controls_rwsem before calling this function
 * (if the race condition can happen).
687 688 689
 *
 * Return: The pointer of the instance if found, or %NULL if not.
 *
L
Linus Torvalds 已提交
690
 */
691 692
struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
				     struct snd_ctl_elem_id *id)
L
Linus Torvalds 已提交
693
{
694
	struct snd_kcontrol *kctl;
L
Linus Torvalds 已提交
695

696 697
	if (snd_BUG_ON(!card || !id))
		return NULL;
L
Linus Torvalds 已提交
698 699
	if (id->numid != 0)
		return snd_ctl_find_numid(card, id->numid);
700
	list_for_each_entry(kctl, &card->controls, list) {
L
Linus Torvalds 已提交
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
		if (kctl->id.iface != id->iface)
			continue;
		if (kctl->id.device != id->device)
			continue;
		if (kctl->id.subdevice != id->subdevice)
			continue;
		if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
			continue;
		if (kctl->id.index > id->index)
			continue;
		if (kctl->id.index + kctl->count <= id->index)
			continue;
		return kctl;
	}
	return NULL;
}
717 718
EXPORT_SYMBOL(snd_ctl_find_id);

719
static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
L
Linus Torvalds 已提交
720 721
			     unsigned int cmd, void __user *arg)
{
722
	struct snd_ctl_card_info *info;
L
Linus Torvalds 已提交
723

724
	info = kzalloc(sizeof(*info), GFP_KERNEL);
L
Linus Torvalds 已提交
725 726 727 728 729 730 731 732 733 734 735
	if (! info)
		return -ENOMEM;
	down_read(&snd_ioctl_rwsem);
	info->card = card->number;
	strlcpy(info->id, card->id, sizeof(info->id));
	strlcpy(info->driver, card->driver, sizeof(info->driver));
	strlcpy(info->name, card->shortname, sizeof(info->name));
	strlcpy(info->longname, card->longname, sizeof(info->longname));
	strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
	strlcpy(info->components, card->components, sizeof(info->components));
	up_read(&snd_ioctl_rwsem);
736
	if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
L
Linus Torvalds 已提交
737 738 739 740 741 742 743
		kfree(info);
		return -EFAULT;
	}
	kfree(info);
	return 0;
}

744 745
static int snd_ctl_elem_list(struct snd_card *card,
			     struct snd_ctl_elem_list __user *_list)
L
Linus Torvalds 已提交
746 747
{
	struct list_head *plist;
748 749 750
	struct snd_ctl_elem_list list;
	struct snd_kcontrol *kctl;
	struct snd_ctl_elem_id *dst, *id;
751
	unsigned int offset, space, jidx;
L
Linus Torvalds 已提交
752 753 754 755 756 757 758 759 760 761
	
	if (copy_from_user(&list, _list, sizeof(list)))
		return -EFAULT;
	offset = list.offset;
	space = list.space;
	/* try limit maximum space */
	if (space > 16384)
		return -ENOMEM;
	if (space > 0) {
		/* allocate temporary buffer for atomic operation */
762
		dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
L
Linus Torvalds 已提交
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
		if (dst == NULL)
			return -ENOMEM;
		down_read(&card->controls_rwsem);
		list.count = card->controls_count;
		plist = card->controls.next;
		while (plist != &card->controls) {
			if (offset == 0)
				break;
			kctl = snd_kcontrol(plist);
			if (offset < kctl->count)
				break;
			offset -= kctl->count;
			plist = plist->next;
		}
		list.used = 0;
		id = dst;
		while (space > 0 && plist != &card->controls) {
			kctl = snd_kcontrol(plist);
			for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
				snd_ctl_build_ioff(id, kctl, jidx);
				id++;
				space--;
				list.used++;
			}
			plist = plist->next;
			offset = 0;
		}
		up_read(&card->controls_rwsem);
791 792 793
		if (list.used > 0 &&
		    copy_to_user(list.pids, dst,
				 list.used * sizeof(struct snd_ctl_elem_id))) {
L
Linus Torvalds 已提交
794 795 796 797 798 799 800 801 802 803 804 805 806 807
			vfree(dst);
			return -EFAULT;
		}
		vfree(dst);
	} else {
		down_read(&card->controls_rwsem);
		list.count = card->controls_count;
		up_read(&card->controls_rwsem);
	}
	if (copy_to_user(_list, &list, sizeof(list)))
		return -EFAULT;
	return 0;
}

808 809
static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
			     struct snd_ctl_elem_info *info)
L
Linus Torvalds 已提交
810
{
811 812 813
	struct snd_card *card = ctl->card;
	struct snd_kcontrol *kctl;
	struct snd_kcontrol_volatile *vd;
L
Linus Torvalds 已提交
814 815 816 817 818 819 820 821 822 823 824 825 826 827
	unsigned int index_offset;
	int result;
	
	down_read(&card->controls_rwsem);
	kctl = snd_ctl_find_id(card, &info->id);
	if (kctl == NULL) {
		up_read(&card->controls_rwsem);
		return -ENOENT;
	}
#ifdef CONFIG_SND_DEBUG
	info->access = 0;
#endif
	result = kctl->info(kctl, info);
	if (result >= 0) {
828
		snd_BUG_ON(info->access);
L
Linus Torvalds 已提交
829 830 831 832 833 834 835 836
		index_offset = snd_ctl_get_ioff(kctl, &info->id);
		vd = &kctl->vd[index_offset];
		snd_ctl_build_ioff(&info->id, kctl, index_offset);
		info->access = vd->access;
		if (vd->owner) {
			info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
			if (vd->owner == ctl)
				info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
837
			info->owner = pid_vnr(vd->owner->pid);
L
Linus Torvalds 已提交
838 839 840 841 842 843 844 845
		} else {
			info->owner = -1;
		}
	}
	up_read(&card->controls_rwsem);
	return result;
}

846 847
static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
				  struct snd_ctl_elem_info __user *_info)
L
Linus Torvalds 已提交
848
{
849
	struct snd_ctl_elem_info info;
L
Linus Torvalds 已提交
850 851 852 853
	int result;

	if (copy_from_user(&info, _info, sizeof(info)))
		return -EFAULT;
854
	snd_power_lock(ctl->card);
855
	result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
856 857 858
	if (result >= 0)
		result = snd_ctl_elem_info(ctl, &info);
	snd_power_unlock(ctl->card);
L
Linus Torvalds 已提交
859 860 861 862 863 864
	if (result >= 0)
		if (copy_to_user(_info, &info, sizeof(info)))
			return -EFAULT;
	return result;
}

865 866
static int snd_ctl_elem_read(struct snd_card *card,
			     struct snd_ctl_elem_value *control)
L
Linus Torvalds 已提交
867
{
868 869
	struct snd_kcontrol *kctl;
	struct snd_kcontrol_volatile *vd;
L
Linus Torvalds 已提交
870
	unsigned int index_offset;
871
	int result;
L
Linus Torvalds 已提交
872 873 874 875 876 877 878 879

	down_read(&card->controls_rwsem);
	kctl = snd_ctl_find_id(card, &control->id);
	if (kctl == NULL) {
		result = -ENOENT;
	} else {
		index_offset = snd_ctl_get_ioff(kctl, &control->id);
		vd = &kctl->vd[index_offset];
880 881 882 883 884 885
		if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) &&
		    kctl->get != NULL) {
			snd_ctl_build_ioff(&control->id, kctl, index_offset);
			result = kctl->get(kctl, control);
		} else
			result = -EPERM;
L
Linus Torvalds 已提交
886 887 888 889 890
	}
	up_read(&card->controls_rwsem);
	return result;
}

891 892
static int snd_ctl_elem_read_user(struct snd_card *card,
				  struct snd_ctl_elem_value __user *_control)
L
Linus Torvalds 已提交
893
{
894
	struct snd_ctl_elem_value *control;
L
Linus Torvalds 已提交
895
	int result;
L
Li Zefan 已提交
896 897 898 899 900

	control = memdup_user(_control, sizeof(*control));
	if (IS_ERR(control))
		return PTR_ERR(control);

901
	snd_power_lock(card);
902
	result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
903 904 905
	if (result >= 0)
		result = snd_ctl_elem_read(card, control);
	snd_power_unlock(card);
L
Linus Torvalds 已提交
906 907 908 909 910 911 912
	if (result >= 0)
		if (copy_to_user(_control, control, sizeof(*control)))
			result = -EFAULT;
	kfree(control);
	return result;
}

913 914
static int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
			      struct snd_ctl_elem_value *control)
L
Linus Torvalds 已提交
915
{
916 917
	struct snd_kcontrol *kctl;
	struct snd_kcontrol_volatile *vd;
L
Linus Torvalds 已提交
918
	unsigned int index_offset;
919
	int result;
L
Linus Torvalds 已提交
920 921 922 923 924 925 926 927

	down_read(&card->controls_rwsem);
	kctl = snd_ctl_find_id(card, &control->id);
	if (kctl == NULL) {
		result = -ENOENT;
	} else {
		index_offset = snd_ctl_get_ioff(kctl, &control->id);
		vd = &kctl->vd[index_offset];
928 929 930 931
		if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
		    kctl->put == NULL ||
		    (file && vd->owner && vd->owner != file)) {
			result = -EPERM;
L
Linus Torvalds 已提交
932
		} else {
933 934 935 936
			snd_ctl_build_ioff(&control->id, kctl, index_offset);
			result = kctl->put(kctl, control);
		}
		if (result > 0) {
937
			struct snd_ctl_elem_id id = control->id;
938
			up_read(&card->controls_rwsem);
939
			snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE, &id);
940
			return 0;
L
Linus Torvalds 已提交
941 942 943 944 945 946
		}
	}
	up_read(&card->controls_rwsem);
	return result;
}

947 948
static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
				   struct snd_ctl_elem_value __user *_control)
L
Linus Torvalds 已提交
949
{
950
	struct snd_ctl_elem_value *control;
951
	struct snd_card *card;
L
Linus Torvalds 已提交
952 953
	int result;

L
Li Zefan 已提交
954 955 956 957
	control = memdup_user(_control, sizeof(*control));
	if (IS_ERR(control))
		return PTR_ERR(control);

958 959
	card = file->card;
	snd_power_lock(card);
960
	result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
961 962 963
	if (result >= 0)
		result = snd_ctl_elem_write(card, file, control);
	snd_power_unlock(card);
L
Linus Torvalds 已提交
964 965 966 967 968 969 970
	if (result >= 0)
		if (copy_to_user(_control, control, sizeof(*control)))
			result = -EFAULT;
	kfree(control);
	return result;
}

971 972
static int snd_ctl_elem_lock(struct snd_ctl_file *file,
			     struct snd_ctl_elem_id __user *_id)
L
Linus Torvalds 已提交
973
{
974 975 976 977
	struct snd_card *card = file->card;
	struct snd_ctl_elem_id id;
	struct snd_kcontrol *kctl;
	struct snd_kcontrol_volatile *vd;
L
Linus Torvalds 已提交
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
	int result;
	
	if (copy_from_user(&id, _id, sizeof(id)))
		return -EFAULT;
	down_write(&card->controls_rwsem);
	kctl = snd_ctl_find_id(card, &id);
	if (kctl == NULL) {
		result = -ENOENT;
	} else {
		vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
		if (vd->owner != NULL)
			result = -EBUSY;
		else {
			vd->owner = file;
			result = 0;
		}
	}
	up_write(&card->controls_rwsem);
	return result;
}

999 1000
static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
			       struct snd_ctl_elem_id __user *_id)
L
Linus Torvalds 已提交
1001
{
1002 1003 1004 1005
	struct snd_card *card = file->card;
	struct snd_ctl_elem_id id;
	struct snd_kcontrol *kctl;
	struct snd_kcontrol_volatile *vd;
L
Linus Torvalds 已提交
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
	int result;
	
	if (copy_from_user(&id, _id, sizeof(id)))
		return -EFAULT;
	down_write(&card->controls_rwsem);
	kctl = snd_ctl_find_id(card, &id);
	if (kctl == NULL) {
		result = -ENOENT;
	} else {
		vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
		if (vd->owner == NULL)
			result = -EINVAL;
		else if (vd->owner != file)
			result = -EPERM;
		else {
			vd->owner = NULL;
			result = 0;
		}
	}
	up_write(&card->controls_rwsem);
	return result;
}

struct user_element {
1030
	struct snd_ctl_elem_info info;
1031
	struct snd_card *card;
1032
	char *elem_data;		/* element data */
L
Linus Torvalds 已提交
1033
	unsigned long elem_data_size;	/* size of element data in bytes */
1034 1035
	void *tlv_data;			/* TLV data */
	unsigned long tlv_data_size;	/* TLV data size */
L
Linus Torvalds 已提交
1036 1037 1038
	void *priv_data;		/* private data (like strings for enumerated type) */
};

1039 1040
static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
				  struct snd_ctl_elem_info *uinfo)
L
Linus Torvalds 已提交
1041 1042
{
	struct user_element *ue = kcontrol->private_data;
1043
	unsigned int offset;
L
Linus Torvalds 已提交
1044

1045
	offset = snd_ctl_get_ioff(kcontrol, &uinfo->id);
L
Linus Torvalds 已提交
1046
	*uinfo = ue->info;
1047 1048
	snd_ctl_build_ioff(&uinfo->id, kcontrol, offset);

L
Linus Torvalds 已提交
1049 1050 1051
	return 0;
}

1052 1053 1054 1055 1056 1057
static int snd_ctl_elem_user_enum_info(struct snd_kcontrol *kcontrol,
				       struct snd_ctl_elem_info *uinfo)
{
	struct user_element *ue = kcontrol->private_data;
	const char *names;
	unsigned int item;
1058
	unsigned int offset;
1059 1060 1061

	item = uinfo->value.enumerated.item;

1062
	offset = snd_ctl_get_ioff(kcontrol, &uinfo->id);
1063
	*uinfo = ue->info;
1064
	snd_ctl_build_ioff(&uinfo->id, kcontrol, offset);
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076

	item = min(item, uinfo->value.enumerated.items - 1);
	uinfo->value.enumerated.item = item;

	names = ue->priv_data;
	for (; item > 0; --item)
		names += strlen(names) + 1;
	strcpy(uinfo->value.enumerated.name, names);

	return 0;
}

1077 1078
static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
				 struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1079 1080
{
	struct user_element *ue = kcontrol->private_data;
1081 1082 1083
	unsigned int size = ue->elem_data_size;
	char *src = ue->elem_data +
			snd_ctl_get_ioff(kcontrol, &ucontrol->id) * size;
L
Linus Torvalds 已提交
1084

1085
	mutex_lock(&ue->card->user_ctl_lock);
1086
	memcpy(&ucontrol->value, src, size);
1087
	mutex_unlock(&ue->card->user_ctl_lock);
L
Linus Torvalds 已提交
1088 1089 1090
	return 0;
}

1091 1092
static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
				 struct snd_ctl_elem_value *ucontrol)
L
Linus Torvalds 已提交
1093 1094 1095
{
	int change;
	struct user_element *ue = kcontrol->private_data;
1096 1097 1098
	unsigned int size = ue->elem_data_size;
	char *dst = ue->elem_data +
			snd_ctl_get_ioff(kcontrol, &ucontrol->id) * size;
1099 1100

	mutex_lock(&ue->card->user_ctl_lock);
1101
	change = memcmp(&ucontrol->value, dst, size) != 0;
L
Linus Torvalds 已提交
1102
	if (change)
1103
		memcpy(dst, &ucontrol->value, size);
1104
	mutex_unlock(&ue->card->user_ctl_lock);
L
Linus Torvalds 已提交
1105 1106 1107
	return change;
}

1108 1109 1110 1111 1112 1113 1114 1115 1116
static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
				 int op_flag,
				 unsigned int size,
				 unsigned int __user *tlv)
{
	struct user_element *ue = kcontrol->private_data;
	int change = 0;
	void *new_data;

1117
	if (op_flag == SNDRV_CTL_TLV_OP_WRITE) {
1118 1119
		if (size > 1024 * 128)	/* sane value */
			return -EINVAL;
L
Li Zefan 已提交
1120 1121 1122 1123

		new_data = memdup_user(tlv, size);
		if (IS_ERR(new_data))
			return PTR_ERR(new_data);
1124
		mutex_lock(&ue->card->user_ctl_lock);
1125 1126 1127 1128 1129 1130
		change = ue->tlv_data_size != size;
		if (!change)
			change = memcmp(ue->tlv_data, new_data, size);
		kfree(ue->tlv_data);
		ue->tlv_data = new_data;
		ue->tlv_data_size = size;
1131
		mutex_unlock(&ue->card->user_ctl_lock);
1132
	} else {
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
		int ret = 0;

		mutex_lock(&ue->card->user_ctl_lock);
		if (!ue->tlv_data_size || !ue->tlv_data) {
			ret = -ENXIO;
			goto err_unlock;
		}
		if (size < ue->tlv_data_size) {
			ret = -ENOSPC;
			goto err_unlock;
		}
1144
		if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
1145 1146 1147 1148 1149
			ret = -EFAULT;
err_unlock:
		mutex_unlock(&ue->card->user_ctl_lock);
		if (ret)
			return ret;
1150 1151 1152 1153
	}
	return change;
}

1154 1155 1156 1157 1158
static int snd_ctl_elem_init_enum_names(struct user_element *ue)
{
	char *names, *p;
	size_t buf_len, name_len;
	unsigned int i;
1159
	const uintptr_t user_ptrval = ue->info.value.enumerated.names_ptr;
1160 1161 1162 1163

	if (ue->info.value.enumerated.names_length > 64 * 1024)
		return -EINVAL;

1164
	names = memdup_user((const void __user *)user_ptrval,
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
		ue->info.value.enumerated.names_length);
	if (IS_ERR(names))
		return PTR_ERR(names);

	/* check that there are enough valid names */
	buf_len = ue->info.value.enumerated.names_length;
	p = names;
	for (i = 0; i < ue->info.value.enumerated.items; ++i) {
		name_len = strnlen(p, buf_len);
		if (name_len == 0 || name_len >= 64 || name_len == buf_len) {
			kfree(names);
			return -EINVAL;
		}
		p += name_len + 1;
		buf_len -= name_len + 1;
	}

	ue->priv_data = names;
	ue->info.value.enumerated.names_ptr = 0;

	return 0;
}

1188
static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
L
Linus Torvalds 已提交
1189
{
1190
	struct user_element *ue = kcontrol->private_data;
1191 1192 1193

	kfree(ue->tlv_data);
	kfree(ue->priv_data);
1194
	kfree(ue);
L
Linus Torvalds 已提交
1195 1196
}

1197 1198
static int snd_ctl_elem_add(struct snd_ctl_file *file,
			    struct snd_ctl_elem_info *info, int replace)
L
Linus Torvalds 已提交
1199
{
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
	/* The capacity of struct snd_ctl_elem_value.value.*/
	static const unsigned int value_sizes[] = {
		[SNDRV_CTL_ELEM_TYPE_BOOLEAN]	= sizeof(long),
		[SNDRV_CTL_ELEM_TYPE_INTEGER]	= sizeof(long),
		[SNDRV_CTL_ELEM_TYPE_ENUMERATED] = sizeof(unsigned int),
		[SNDRV_CTL_ELEM_TYPE_BYTES]	= sizeof(unsigned char),
		[SNDRV_CTL_ELEM_TYPE_IEC958]	= sizeof(struct snd_aes_iec958),
		[SNDRV_CTL_ELEM_TYPE_INTEGER64] = sizeof(long long),
	};
	static const unsigned int max_value_counts[] = {
		[SNDRV_CTL_ELEM_TYPE_BOOLEAN]	= 128,
		[SNDRV_CTL_ELEM_TYPE_INTEGER]	= 128,
		[SNDRV_CTL_ELEM_TYPE_ENUMERATED] = 128,
		[SNDRV_CTL_ELEM_TYPE_BYTES]	= 512,
		[SNDRV_CTL_ELEM_TYPE_IEC958]	= 1,
		[SNDRV_CTL_ELEM_TYPE_INTEGER64] = 64,
	};
1217
	struct snd_card *card = file->card;
1218 1219
	struct snd_kcontrol *kctl;
	unsigned int count;
L
Linus Torvalds 已提交
1220 1221 1222
	unsigned int access;
	long private_size;
	struct user_element *ue;
1223
	unsigned int offset;
1224
	int err;
1225

1226 1227 1228 1229
	if (!*info->id.name)
		return -EINVAL;
	if (strnlen(info->id.name, sizeof(info->id.name)) >= sizeof(info->id.name))
		return -EINVAL;
1230

1231
	/* Delete a control to replace them if needed. */
1232
	if (replace) {
1233
		info->id.numid = 0;
1234 1235 1236
		err = snd_ctl_remove_user_ctl(file, &info->id);
		if (err)
			return err;
L
Linus Torvalds 已提交
1237
	}
1238

1239 1240 1241 1242 1243
	/*
	 * The number of userspace controls are counted control by control,
	 * not element by element.
	 */
	if (card->user_ctl_count + 1 > MAX_USER_CONTROLS)
1244 1245
		return -ENOMEM;

1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
	/* Check the number of elements for this userspace control. */
	count = info->owner;
	if (count == 0)
		count = 1;

	/* Arrange access permissions if needed. */
	access = info->access;
	if (access == 0)
		access = SNDRV_CTL_ELEM_ACCESS_READWRITE;
	access &= (SNDRV_CTL_ELEM_ACCESS_READWRITE |
		   SNDRV_CTL_ELEM_ACCESS_INACTIVE |
		   SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE);
	if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE)
1259
		access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1260
	access |= SNDRV_CTL_ELEM_ACCESS_USER;
1261

1262 1263 1264 1265
	/*
	 * Check information and calculate the size of data specific to
	 * this userspace control.
	 */
1266 1267
	if (info->type < SNDRV_CTL_ELEM_TYPE_BOOLEAN ||
	    info->type > SNDRV_CTL_ELEM_TYPE_INTEGER64)
L
Linus Torvalds 已提交
1268
		return -EINVAL;
1269 1270 1271 1272 1273 1274 1275
	if (info->type == SNDRV_CTL_ELEM_TYPE_ENUMERATED &&
	    info->value.enumerated.items == 0)
		return -EINVAL;
	if (info->count < 1 ||
	    info->count > max_value_counts[info->type])
		return -EINVAL;
	private_size = value_sizes[info->type] * info->count;
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285

	/*
	 * Keep memory object for this userspace control. After passing this
	 * code block, the instance should be freed by snd_ctl_free_one().
	 *
	 * Note that these elements in this control are locked.
	 */
	err = snd_ctl_new(&kctl, count, access, file);
	if (err < 0)
		return err;
1286
	memcpy(&kctl->id, &info->id, sizeof(kctl->id));
1287
	kctl->private_data = kzalloc(sizeof(struct user_element) + private_size * count,
1288 1289 1290
				     GFP_KERNEL);
	if (kctl->private_data == NULL) {
		kfree(kctl);
L
Linus Torvalds 已提交
1291
		return -ENOMEM;
1292 1293 1294 1295 1296
	}
	kctl->private_free = snd_ctl_elem_user_free;

	/* Set private data for this userspace control. */
	ue = (struct user_element *)kctl->private_data;
1297
	ue->card = card;
L
Linus Torvalds 已提交
1298
	ue->info = *info;
1299
	ue->info.access = 0;
L
Linus Torvalds 已提交
1300 1301
	ue->elem_data = (char *)ue + sizeof(*ue);
	ue->elem_data_size = private_size;
1302 1303 1304
	if (ue->info.type == SNDRV_CTL_ELEM_TYPE_ENUMERATED) {
		err = snd_ctl_elem_init_enum_names(ue);
		if (err < 0) {
1305
			snd_ctl_free_one(kctl);
1306 1307 1308
			return err;
		}
	}
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323

	/* Set callback functions. */
	if (info->type == SNDRV_CTL_ELEM_TYPE_ENUMERATED)
		kctl->info = snd_ctl_elem_user_enum_info;
	else
		kctl->info = snd_ctl_elem_user_info;
	if (access & SNDRV_CTL_ELEM_ACCESS_READ)
		kctl->get = snd_ctl_elem_user_get;
	if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
		kctl->put = snd_ctl_elem_user_put;
	if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE)
		kctl->tlv.c = snd_ctl_elem_user_tlv;

	/* This function manage to free the instance on failure. */
	err = snd_ctl_add(card, kctl);
1324
	if (err < 0)
L
Linus Torvalds 已提交
1325
		return err;
1326 1327 1328 1329 1330 1331 1332 1333 1334
	offset = snd_ctl_get_ioff(kctl, &info->id);
	snd_ctl_build_ioff(&info->id, kctl, offset);
	/*
	 * Here we cannot fill any field for the number of elements added by
	 * this operation because there're no specific fields. The usage of
	 * 'owner' field for this purpose may cause any bugs to userspace
	 * applications because the field originally means PID of a process
	 * which locks the element.
	 */
L
Linus Torvalds 已提交
1335 1336 1337 1338 1339 1340 1341 1342

	down_write(&card->controls_rwsem);
	card->user_ctl_count++;
	up_write(&card->controls_rwsem);

	return 0;
}

1343 1344
static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
				 struct snd_ctl_elem_info __user *_info, int replace)
L
Linus Torvalds 已提交
1345
{
1346
	struct snd_ctl_elem_info info;
1347 1348
	int err;

L
Linus Torvalds 已提交
1349 1350
	if (copy_from_user(&info, _info, sizeof(info)))
		return -EFAULT;
1351 1352 1353 1354 1355 1356 1357 1358 1359
	err = snd_ctl_elem_add(file, &info, replace);
	if (err < 0)
		return err;
	if (copy_to_user(_info, &info, sizeof(info))) {
		snd_ctl_remove_user_ctl(file, &info.id);
		return -EFAULT;
	}

	return 0;
L
Linus Torvalds 已提交
1360 1361
}

1362 1363
static int snd_ctl_elem_remove(struct snd_ctl_file *file,
			       struct snd_ctl_elem_id __user *_id)
L
Linus Torvalds 已提交
1364
{
1365
	struct snd_ctl_elem_id id;
L
Linus Torvalds 已提交
1366 1367 1368

	if (copy_from_user(&id, _id, sizeof(id)))
		return -EFAULT;
1369
	return snd_ctl_remove_user_ctl(file, &id);
L
Linus Torvalds 已提交
1370 1371
}

1372
static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
L
Linus Torvalds 已提交
1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392
{
	int subscribe;
	if (get_user(subscribe, ptr))
		return -EFAULT;
	if (subscribe < 0) {
		subscribe = file->subscribed;
		if (put_user(subscribe, ptr))
			return -EFAULT;
		return 0;
	}
	if (subscribe) {
		file->subscribed = 1;
		return 0;
	} else if (file->subscribed) {
		snd_ctl_empty_read_queue(file);
		file->subscribed = 0;
	}
	return 0;
}

1393 1394 1395
static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
                             struct snd_ctl_tlv __user *_tlv,
                             int op_flag)
1396
{
1397
	struct snd_card *card = file->card;
1398 1399
	struct snd_ctl_tlv tlv;
	struct snd_kcontrol *kctl;
1400
	struct snd_kcontrol_volatile *vd;
1401 1402 1403 1404 1405
	unsigned int len;
	int err = 0;

	if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
		return -EFAULT;
1406
	if (tlv.length < sizeof(unsigned int) * 2)
1407
		return -EINVAL;
1408 1409
	if (!tlv.numid)
		return -EINVAL;
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
	down_read(&card->controls_rwsem);
	kctl = snd_ctl_find_numid(card, tlv.numid);
	if (kctl == NULL) {
		err = -ENOENT;
		goto __kctl_end;
	}
	if (kctl->tlv.p == NULL) {
		err = -ENXIO;
		goto __kctl_end;
	}
	vd = &kctl->vd[tlv.numid - kctl->id.numid];
1421 1422 1423 1424 1425 1426
	if ((op_flag == SNDRV_CTL_TLV_OP_READ &&
	     (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
	    (op_flag == SNDRV_CTL_TLV_OP_WRITE &&
	     (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
	    (op_flag == SNDRV_CTL_TLV_OP_CMD &&
	     (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1427 1428 1429 1430
	    	err = -ENXIO;
	    	goto __kctl_end;
	}
	if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
1431
		if (vd->owner != NULL && vd->owner != file) {
1432 1433 1434
			err = -EPERM;
			goto __kctl_end;
		}
1435
		err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
1436
		if (err > 0) {
1437
			struct snd_ctl_elem_id id = kctl->id;
1438
			up_read(&card->controls_rwsem);
1439
			snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &id);
1440 1441 1442
			return 0;
		}
	} else {
1443
		if (op_flag != SNDRV_CTL_TLV_OP_READ) {
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454
			err = -ENXIO;
			goto __kctl_end;
		}
		len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
		if (tlv.length < len) {
			err = -ENOMEM;
			goto __kctl_end;
		}
		if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
			err = -EFAULT;
	}
1455
      __kctl_end:
1456 1457
	up_read(&card->controls_rwsem);
	return err;
1458 1459
}

L
Linus Torvalds 已提交
1460 1461
static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
{
1462 1463 1464
	struct snd_ctl_file *ctl;
	struct snd_card *card;
	struct snd_kctl_ioctl *p;
L
Linus Torvalds 已提交
1465 1466 1467 1468 1469 1470
	void __user *argp = (void __user *)arg;
	int __user *ip = argp;
	int err;

	ctl = file->private_data;
	card = ctl->card;
1471 1472
	if (snd_BUG_ON(!card))
		return -ENXIO;
L
Linus Torvalds 已提交
1473 1474 1475 1476 1477 1478
	switch (cmd) {
	case SNDRV_CTL_IOCTL_PVERSION:
		return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
	case SNDRV_CTL_IOCTL_CARD_INFO:
		return snd_ctl_card_info(card, ctl, cmd, argp);
	case SNDRV_CTL_IOCTL_ELEM_LIST:
1479
		return snd_ctl_elem_list(card, argp);
L
Linus Torvalds 已提交
1480 1481 1482
	case SNDRV_CTL_IOCTL_ELEM_INFO:
		return snd_ctl_elem_info_user(ctl, argp);
	case SNDRV_CTL_IOCTL_ELEM_READ:
1483
		return snd_ctl_elem_read_user(card, argp);
L
Linus Torvalds 已提交
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
	case SNDRV_CTL_IOCTL_ELEM_WRITE:
		return snd_ctl_elem_write_user(ctl, argp);
	case SNDRV_CTL_IOCTL_ELEM_LOCK:
		return snd_ctl_elem_lock(ctl, argp);
	case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
		return snd_ctl_elem_unlock(ctl, argp);
	case SNDRV_CTL_IOCTL_ELEM_ADD:
		return snd_ctl_elem_add_user(ctl, argp, 0);
	case SNDRV_CTL_IOCTL_ELEM_REPLACE:
		return snd_ctl_elem_add_user(ctl, argp, 1);
	case SNDRV_CTL_IOCTL_ELEM_REMOVE:
		return snd_ctl_elem_remove(ctl, argp);
	case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
		return snd_ctl_subscribe_events(ctl, ip);
1498
	case SNDRV_CTL_IOCTL_TLV_READ:
1499
		return snd_ctl_tlv_ioctl(ctl, argp, SNDRV_CTL_TLV_OP_READ);
1500
	case SNDRV_CTL_IOCTL_TLV_WRITE:
1501
		return snd_ctl_tlv_ioctl(ctl, argp, SNDRV_CTL_TLV_OP_WRITE);
1502
	case SNDRV_CTL_IOCTL_TLV_COMMAND:
1503
		return snd_ctl_tlv_ioctl(ctl, argp, SNDRV_CTL_TLV_OP_CMD);
L
Linus Torvalds 已提交
1504
	case SNDRV_CTL_IOCTL_POWER:
T
Takashi Iwai 已提交
1505
		return -ENOPROTOOPT;
L
Linus Torvalds 已提交
1506 1507 1508 1509 1510 1511 1512 1513
	case SNDRV_CTL_IOCTL_POWER_STATE:
#ifdef CONFIG_PM
		return put_user(card->power_state, ip) ? -EFAULT : 0;
#else
		return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
#endif
	}
	down_read(&snd_ioctl_rwsem);
1514
	list_for_each_entry(p, &snd_control_ioctls, list) {
L
Linus Torvalds 已提交
1515 1516 1517 1518 1519 1520 1521
		err = p->fioctl(card, ctl, cmd, arg);
		if (err != -ENOIOCTLCMD) {
			up_read(&snd_ioctl_rwsem);
			return err;
		}
	}
	up_read(&snd_ioctl_rwsem);
1522
	dev_dbg(card->dev, "unknown ioctl = 0x%x\n", cmd);
L
Linus Torvalds 已提交
1523 1524 1525
	return -ENOTTY;
}

1526 1527
static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
			    size_t count, loff_t * offset)
L
Linus Torvalds 已提交
1528
{
1529
	struct snd_ctl_file *ctl;
L
Linus Torvalds 已提交
1530 1531 1532 1533
	int err = 0;
	ssize_t result = 0;

	ctl = file->private_data;
1534 1535
	if (snd_BUG_ON(!ctl || !ctl->card))
		return -ENXIO;
L
Linus Torvalds 已提交
1536 1537
	if (!ctl->subscribed)
		return -EBADFD;
1538
	if (count < sizeof(struct snd_ctl_event))
L
Linus Torvalds 已提交
1539 1540
		return -EINVAL;
	spin_lock_irq(&ctl->read_lock);
1541 1542 1543
	while (count >= sizeof(struct snd_ctl_event)) {
		struct snd_ctl_event ev;
		struct snd_kctl_event *kev;
L
Linus Torvalds 已提交
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
		while (list_empty(&ctl->events)) {
			wait_queue_t wait;
			if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
				err = -EAGAIN;
				goto __end_lock;
			}
			init_waitqueue_entry(&wait, current);
			add_wait_queue(&ctl->change_sleep, &wait);
			set_current_state(TASK_INTERRUPTIBLE);
			spin_unlock_irq(&ctl->read_lock);
			schedule();
			remove_wait_queue(&ctl->change_sleep, &wait);
1556 1557
			if (ctl->card->shutdown)
				return -ENODEV;
L
Linus Torvalds 已提交
1558
			if (signal_pending(current))
1559
				return -ERESTARTSYS;
L
Linus Torvalds 已提交
1560 1561 1562 1563 1564 1565 1566 1567 1568
			spin_lock_irq(&ctl->read_lock);
		}
		kev = snd_kctl_event(ctl->events.next);
		ev.type = SNDRV_CTL_EVENT_ELEM;
		ev.data.elem.mask = kev->mask;
		ev.data.elem.id = kev->id;
		list_del(&kev->list);
		spin_unlock_irq(&ctl->read_lock);
		kfree(kev);
1569
		if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
L
Linus Torvalds 已提交
1570 1571 1572 1573
			err = -EFAULT;
			goto __end;
		}
		spin_lock_irq(&ctl->read_lock);
1574 1575 1576
		buffer += sizeof(struct snd_ctl_event);
		count -= sizeof(struct snd_ctl_event);
		result += sizeof(struct snd_ctl_event);
L
Linus Torvalds 已提交
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
	}
      __end_lock:
	spin_unlock_irq(&ctl->read_lock);
      __end:
      	return result > 0 ? result : err;
}

static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
{
	unsigned int mask;
1587
	struct snd_ctl_file *ctl;
L
Linus Torvalds 已提交
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606

	ctl = file->private_data;
	if (!ctl->subscribed)
		return 0;
	poll_wait(file, &ctl->change_sleep, wait);

	mask = 0;
	if (!list_empty(&ctl->events))
		mask |= POLLIN | POLLRDNORM;

	return mask;
}

/*
 * register the device-specific control-ioctls.
 * called from each device manager like pcm.c, hwdep.c, etc.
 */
static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
{
1607
	struct snd_kctl_ioctl *pn;
L
Linus Torvalds 已提交
1608

1609
	pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
L
Linus Torvalds 已提交
1610 1611 1612 1613 1614 1615 1616 1617 1618
	if (pn == NULL)
		return -ENOMEM;
	pn->fioctl = fcn;
	down_write(&snd_ioctl_rwsem);
	list_add_tail(&pn->list, lists);
	up_write(&snd_ioctl_rwsem);
	return 0;
}

1619 1620 1621 1622 1623 1624
/**
 * snd_ctl_register_ioctl - register the device-specific control-ioctls
 * @fcn: ioctl callback function
 *
 * called from each device manager like pcm.c, hwdep.c, etc.
 */
L
Linus Torvalds 已提交
1625 1626 1627 1628
int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
{
	return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
}
1629 1630
EXPORT_SYMBOL(snd_ctl_register_ioctl);

L
Linus Torvalds 已提交
1631
#ifdef CONFIG_COMPAT
1632 1633 1634 1635 1636
/**
 * snd_ctl_register_ioctl_compat - register the device-specific 32bit compat
 * control-ioctls
 * @fcn: ioctl callback function
 */
L
Linus Torvalds 已提交
1637 1638 1639 1640
int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
{
	return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
}
1641
EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
L
Linus Torvalds 已提交
1642 1643 1644 1645 1646
#endif

/*
 * de-register the device-specific control-ioctls.
 */
1647 1648
static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
				     struct list_head *lists)
L
Linus Torvalds 已提交
1649
{
1650
	struct snd_kctl_ioctl *p;
L
Linus Torvalds 已提交
1651

1652 1653
	if (snd_BUG_ON(!fcn))
		return -EINVAL;
L
Linus Torvalds 已提交
1654
	down_write(&snd_ioctl_rwsem);
1655
	list_for_each_entry(p, lists, list) {
L
Linus Torvalds 已提交
1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
		if (p->fioctl == fcn) {
			list_del(&p->list);
			up_write(&snd_ioctl_rwsem);
			kfree(p);
			return 0;
		}
	}
	up_write(&snd_ioctl_rwsem);
	snd_BUG();
	return -EINVAL;
}

1668 1669 1670 1671
/**
 * snd_ctl_unregister_ioctl - de-register the device-specific control-ioctls
 * @fcn: ioctl callback function to unregister
 */
L
Linus Torvalds 已提交
1672 1673 1674 1675
int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
{
	return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
}
1676 1677
EXPORT_SYMBOL(snd_ctl_unregister_ioctl);

L
Linus Torvalds 已提交
1678
#ifdef CONFIG_COMPAT
1679 1680 1681 1682 1683
/**
 * snd_ctl_unregister_ioctl - de-register the device-specific compat 32bit
 * control-ioctls
 * @fcn: ioctl callback function to unregister
 */
L
Linus Torvalds 已提交
1684 1685 1686 1687
int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
{
	return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
}
1688
EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
L
Linus Torvalds 已提交
1689 1690 1691 1692
#endif

static int snd_ctl_fasync(int fd, struct file * file, int on)
{
1693
	struct snd_ctl_file *ctl;
1694

L
Linus Torvalds 已提交
1695
	ctl = file->private_data;
1696
	return fasync_helper(fd, file, on, &ctl->fasync);
L
Linus Torvalds 已提交
1697 1698
}

1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719
/* return the preferred subdevice number if already assigned;
 * otherwise return -1
 */
int snd_ctl_get_preferred_subdevice(struct snd_card *card, int type)
{
	struct snd_ctl_file *kctl;
	int subdevice = -1;

	read_lock(&card->ctl_files_rwlock);
	list_for_each_entry(kctl, &card->ctl_files, list) {
		if (kctl->pid == task_pid(current)) {
			subdevice = kctl->preferred_subdevice[type];
			if (subdevice != -1)
				break;
		}
	}
	read_unlock(&card->ctl_files_rwlock);
	return subdevice;
}
EXPORT_SYMBOL_GPL(snd_ctl_get_preferred_subdevice);

L
Linus Torvalds 已提交
1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732
/*
 * ioctl32 compat
 */
#ifdef CONFIG_COMPAT
#include "control_compat.c"
#else
#define snd_ctl_ioctl_compat	NULL
#endif

/*
 *  INIT PART
 */

1733
static const struct file_operations snd_ctl_f_ops =
L
Linus Torvalds 已提交
1734 1735 1736 1737 1738
{
	.owner =	THIS_MODULE,
	.read =		snd_ctl_read,
	.open =		snd_ctl_open,
	.release =	snd_ctl_release,
T
Takashi Iwai 已提交
1739
	.llseek =	no_llseek,
L
Linus Torvalds 已提交
1740 1741 1742 1743 1744 1745 1746 1747 1748
	.poll =		snd_ctl_poll,
	.unlocked_ioctl =	snd_ctl_ioctl,
	.compat_ioctl =	snd_ctl_ioctl_compat,
	.fasync =	snd_ctl_fasync,
};

/*
 * registration of the control device
 */
1749
static int snd_ctl_dev_register(struct snd_device *device)
L
Linus Torvalds 已提交
1750
{
1751
	struct snd_card *card = device->device_data;
L
Linus Torvalds 已提交
1752

1753 1754
	return snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
				   &snd_ctl_f_ops, card, &card->ctl_dev);
L
Linus Torvalds 已提交
1755 1756 1757 1758 1759
}

/*
 * disconnection of the control device
 */
1760
static int snd_ctl_dev_disconnect(struct snd_device *device)
L
Linus Torvalds 已提交
1761
{
1762 1763
	struct snd_card *card = device->device_data;
	struct snd_ctl_file *ctl;
L
Linus Torvalds 已提交
1764

1765
	read_lock(&card->ctl_files_rwlock);
1766
	list_for_each_entry(ctl, &card->ctl_files, list) {
L
Linus Torvalds 已提交
1767 1768 1769
		wake_up(&ctl->change_sleep);
		kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
	}
1770
	read_unlock(&card->ctl_files_rwlock);
1771

1772
	return snd_unregister_device(&card->ctl_dev);
L
Linus Torvalds 已提交
1773 1774 1775 1776 1777
}

/*
 * free all controls
 */
1778
static int snd_ctl_dev_free(struct snd_device *device)
L
Linus Torvalds 已提交
1779
{
1780 1781
	struct snd_card *card = device->device_data;
	struct snd_kcontrol *control;
L
Linus Torvalds 已提交
1782 1783 1784 1785 1786 1787 1788

	down_write(&card->controls_rwsem);
	while (!list_empty(&card->controls)) {
		control = snd_kcontrol(card->controls.next);
		snd_ctl_remove(card, control);
	}
	up_write(&card->controls_rwsem);
1789
	put_device(&card->ctl_dev);
L
Linus Torvalds 已提交
1790 1791 1792 1793 1794 1795 1796
	return 0;
}

/*
 * create control core:
 * called from init.c
 */
1797
int snd_ctl_create(struct snd_card *card)
L
Linus Torvalds 已提交
1798
{
1799
	static struct snd_device_ops ops = {
L
Linus Torvalds 已提交
1800 1801 1802 1803
		.dev_free = snd_ctl_dev_free,
		.dev_register =	snd_ctl_dev_register,
		.dev_disconnect = snd_ctl_dev_disconnect,
	};
1804
	int err;
L
Linus Torvalds 已提交
1805

1806 1807
	if (snd_BUG_ON(!card))
		return -ENXIO;
1808 1809 1810 1811 1812 1813 1814 1815 1816 1817
	if (snd_BUG_ON(card->number < 0 || card->number >= SNDRV_CARDS))
		return -ENXIO;

	snd_device_initialize(&card->ctl_dev, card);
	dev_set_name(&card->ctl_dev, "controlC%d", card->number);

	err = snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
	if (err < 0)
		put_device(&card->ctl_dev);
	return err;
L
Linus Torvalds 已提交
1818
}
1819 1820

/*
1821
 * Frequently used control callbacks/helpers
1822
 */
1823 1824 1825 1826 1827 1828 1829 1830 1831 1832

/**
 * snd_ctl_boolean_mono_info - Helper function for a standard boolean info
 * callback with a mono channel
 * @kcontrol: the kcontrol instance
 * @uinfo: info to store
 *
 * This is a function that can be used as info callback for a standard
 * boolean control with a single mono channel.
 */
1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843
int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
			      struct snd_ctl_elem_info *uinfo)
{
	uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
	uinfo->count = 1;
	uinfo->value.integer.min = 0;
	uinfo->value.integer.max = 1;
	return 0;
}
EXPORT_SYMBOL(snd_ctl_boolean_mono_info);

1844 1845 1846 1847 1848 1849 1850 1851 1852
/**
 * snd_ctl_boolean_stereo_info - Helper function for a standard boolean info
 * callback with stereo two channels
 * @kcontrol: the kcontrol instance
 * @uinfo: info to store
 *
 * This is a function that can be used as info callback for a standard
 * boolean control with stereo two channels.
 */
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
				struct snd_ctl_elem_info *uinfo)
{
	uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
	uinfo->count = 2;
	uinfo->value.integer.min = 0;
	uinfo->value.integer.max = 1;
	return 0;
}
EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);
1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873

/**
 * snd_ctl_enum_info - fills the info structure for an enumerated control
 * @info: the structure to be filled
 * @channels: the number of the control's channels; often one
 * @items: the number of control values; also the size of @names
 * @names: an array containing the names of all control values
 *
 * Sets all required fields in @info to their appropriate values.
 * If the control's accessibility is not the default (readable and writable),
 * the caller has to fill @info->access.
1874 1875
 *
 * Return: Zero.
1876 1877 1878 1879 1880 1881 1882
 */
int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
		      unsigned int items, const char *const names[])
{
	info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
	info->count = channels;
	info->value.enumerated.items = items;
1883 1884
	if (!items)
		return 0;
1885 1886
	if (info->value.enumerated.item >= items)
		info->value.enumerated.item = items - 1;
1887 1888 1889
	WARN(strlen(names[info->value.enumerated.item]) >= sizeof(info->value.enumerated.name),
	     "ALSA: too long item name '%s'\n",
	     names[info->value.enumerated.item]);
1890 1891 1892 1893 1894 1895
	strlcpy(info->value.enumerated.name,
		names[info->value.enumerated.item],
		sizeof(info->value.enumerated.name));
	return 0;
}
EXPORT_SYMBOL(snd_ctl_enum_info);