xref: /openbmc/linux/sound/core/control.c (revision 54525552)
1 /*
2  *  Routines for driver control interface
3  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
4  *
5  *
6  *   This program is free software; you can redistribute it and/or modify
7  *   it under the terms of the GNU General Public License as published by
8  *   the Free Software Foundation; either version 2 of the License, or
9  *   (at your option) any later version.
10  *
11  *   This program is distributed in the hope that it will be useful,
12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *   GNU General Public License for more details.
15  *
16  *   You should have received a copy of the GNU General Public License
17  *   along with this program; if not, write to the Free Software
18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19  *
20  */
21 
22 #include <linux/threads.h>
23 #include <linux/interrupt.h>
24 #include <linux/slab.h>
25 #include <linux/vmalloc.h>
26 #include <linux/time.h>
27 #include <sound/core.h>
28 #include <sound/minors.h>
29 #include <sound/info.h>
30 #include <sound/control.h>
31 
32 /* max number of user-defined controls */
33 #define MAX_USER_CONTROLS	32
34 #define MAX_CONTROL_COUNT	1028
35 
36 struct snd_kctl_ioctl {
37 	struct list_head list;		/* list of all ioctls */
38 	snd_kctl_ioctl_func_t fioctl;
39 };
40 
41 static DECLARE_RWSEM(snd_ioctl_rwsem);
42 static LIST_HEAD(snd_control_ioctls);
43 #ifdef CONFIG_COMPAT
44 static LIST_HEAD(snd_control_compat_ioctls);
45 #endif
46 
47 static int snd_ctl_open(struct inode *inode, struct file *file)
48 {
49 	unsigned long flags;
50 	struct snd_card *card;
51 	struct snd_ctl_file *ctl;
52 	int err;
53 
54 	err = nonseekable_open(inode, file);
55 	if (err < 0)
56 		return err;
57 
58 	card = snd_lookup_minor_data(iminor(inode), SNDRV_DEVICE_TYPE_CONTROL);
59 	if (!card) {
60 		err = -ENODEV;
61 		goto __error1;
62 	}
63 	err = snd_card_file_add(card, file);
64 	if (err < 0) {
65 		err = -ENODEV;
66 		goto __error1;
67 	}
68 	if (!try_module_get(card->module)) {
69 		err = -EFAULT;
70 		goto __error2;
71 	}
72 	ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
73 	if (ctl == NULL) {
74 		err = -ENOMEM;
75 		goto __error;
76 	}
77 	INIT_LIST_HEAD(&ctl->events);
78 	init_waitqueue_head(&ctl->change_sleep);
79 	spin_lock_init(&ctl->read_lock);
80 	ctl->card = card;
81 	ctl->prefer_pcm_subdevice = -1;
82 	ctl->prefer_rawmidi_subdevice = -1;
83 	ctl->pid = get_pid(task_pid(current));
84 	file->private_data = ctl;
85 	write_lock_irqsave(&card->ctl_files_rwlock, flags);
86 	list_add_tail(&ctl->list, &card->ctl_files);
87 	write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
88 	return 0;
89 
90       __error:
91 	module_put(card->module);
92       __error2:
93 	snd_card_file_remove(card, file);
94       __error1:
95       	return err;
96 }
97 
98 static void snd_ctl_empty_read_queue(struct snd_ctl_file * ctl)
99 {
100 	unsigned long flags;
101 	struct snd_kctl_event *cread;
102 
103 	spin_lock_irqsave(&ctl->read_lock, flags);
104 	while (!list_empty(&ctl->events)) {
105 		cread = snd_kctl_event(ctl->events.next);
106 		list_del(&cread->list);
107 		kfree(cread);
108 	}
109 	spin_unlock_irqrestore(&ctl->read_lock, flags);
110 }
111 
112 static int snd_ctl_release(struct inode *inode, struct file *file)
113 {
114 	unsigned long flags;
115 	struct snd_card *card;
116 	struct snd_ctl_file *ctl;
117 	struct snd_kcontrol *control;
118 	unsigned int idx;
119 
120 	ctl = file->private_data;
121 	file->private_data = NULL;
122 	card = ctl->card;
123 	write_lock_irqsave(&card->ctl_files_rwlock, flags);
124 	list_del(&ctl->list);
125 	write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
126 	down_write(&card->controls_rwsem);
127 	list_for_each_entry(control, &card->controls, list)
128 		for (idx = 0; idx < control->count; idx++)
129 			if (control->vd[idx].owner == ctl)
130 				control->vd[idx].owner = NULL;
131 	up_write(&card->controls_rwsem);
132 	snd_ctl_empty_read_queue(ctl);
133 	put_pid(ctl->pid);
134 	kfree(ctl);
135 	module_put(card->module);
136 	snd_card_file_remove(card, file);
137 	return 0;
138 }
139 
140 void snd_ctl_notify(struct snd_card *card, unsigned int mask,
141 		    struct snd_ctl_elem_id *id)
142 {
143 	unsigned long flags;
144 	struct snd_ctl_file *ctl;
145 	struct snd_kctl_event *ev;
146 
147 	if (snd_BUG_ON(!card || !id))
148 		return;
149 	read_lock(&card->ctl_files_rwlock);
150 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
151 	card->mixer_oss_change_count++;
152 #endif
153 	list_for_each_entry(ctl, &card->ctl_files, list) {
154 		if (!ctl->subscribed)
155 			continue;
156 		spin_lock_irqsave(&ctl->read_lock, flags);
157 		list_for_each_entry(ev, &ctl->events, list) {
158 			if (ev->id.numid == id->numid) {
159 				ev->mask |= mask;
160 				goto _found;
161 			}
162 		}
163 		ev = kzalloc(sizeof(*ev), GFP_ATOMIC);
164 		if (ev) {
165 			ev->id = *id;
166 			ev->mask = mask;
167 			list_add_tail(&ev->list, &ctl->events);
168 		} else {
169 			snd_printk(KERN_ERR "No memory available to allocate event\n");
170 		}
171 	_found:
172 		wake_up(&ctl->change_sleep);
173 		spin_unlock_irqrestore(&ctl->read_lock, flags);
174 		kill_fasync(&ctl->fasync, SIGIO, POLL_IN);
175 	}
176 	read_unlock(&card->ctl_files_rwlock);
177 }
178 
179 EXPORT_SYMBOL(snd_ctl_notify);
180 
181 /**
182  * snd_ctl_new - create a control instance from the template
183  * @control: the control template
184  * @access: the default control access
185  *
186  * Allocates a new struct snd_kcontrol instance and copies the given template
187  * to the new instance. It does not copy volatile data (access).
188  *
189  * Returns the pointer of the new instance, or NULL on failure.
190  */
191 static struct snd_kcontrol *snd_ctl_new(struct snd_kcontrol *control,
192 					unsigned int access)
193 {
194 	struct snd_kcontrol *kctl;
195 	unsigned int idx;
196 
197 	if (snd_BUG_ON(!control || !control->count))
198 		return NULL;
199 
200 	if (control->count > MAX_CONTROL_COUNT)
201 		return NULL;
202 
203 	kctl = kzalloc(sizeof(*kctl) + sizeof(struct snd_kcontrol_volatile) * control->count, GFP_KERNEL);
204 	if (kctl == NULL) {
205 		snd_printk(KERN_ERR "Cannot allocate control instance\n");
206 		return NULL;
207 	}
208 	*kctl = *control;
209 	for (idx = 0; idx < kctl->count; idx++)
210 		kctl->vd[idx].access = access;
211 	return kctl;
212 }
213 
214 /**
215  * snd_ctl_new1 - create a control instance from the template
216  * @ncontrol: the initialization record
217  * @private_data: the private data to set
218  *
219  * Allocates a new struct snd_kcontrol instance and initialize from the given
220  * template.  When the access field of ncontrol is 0, it's assumed as
221  * READWRITE access. When the count field is 0, it's assumes as one.
222  *
223  * Returns the pointer of the newly generated instance, or NULL on failure.
224  */
225 struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new *ncontrol,
226 				  void *private_data)
227 {
228 	struct snd_kcontrol kctl;
229 	unsigned int access;
230 
231 	if (snd_BUG_ON(!ncontrol || !ncontrol->info))
232 		return NULL;
233 	memset(&kctl, 0, sizeof(kctl));
234 	kctl.id.iface = ncontrol->iface;
235 	kctl.id.device = ncontrol->device;
236 	kctl.id.subdevice = ncontrol->subdevice;
237 	if (ncontrol->name) {
238 		strlcpy(kctl.id.name, ncontrol->name, sizeof(kctl.id.name));
239 		if (strcmp(ncontrol->name, kctl.id.name) != 0)
240 			snd_printk(KERN_WARNING
241 				   "Control name '%s' truncated to '%s'\n",
242 				   ncontrol->name, kctl.id.name);
243 	}
244 	kctl.id.index = ncontrol->index;
245 	kctl.count = ncontrol->count ? ncontrol->count : 1;
246 	access = ncontrol->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
247 		 (ncontrol->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
248 				      SNDRV_CTL_ELEM_ACCESS_INACTIVE|
249 				      SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE|
250 				      SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND|
251 				      SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK));
252 	kctl.info = ncontrol->info;
253 	kctl.get = ncontrol->get;
254 	kctl.put = ncontrol->put;
255 	kctl.tlv.p = ncontrol->tlv.p;
256 	kctl.private_value = ncontrol->private_value;
257 	kctl.private_data = private_data;
258 	return snd_ctl_new(&kctl, access);
259 }
260 
261 EXPORT_SYMBOL(snd_ctl_new1);
262 
263 /**
264  * snd_ctl_free_one - release the control instance
265  * @kcontrol: the control instance
266  *
267  * Releases the control instance created via snd_ctl_new()
268  * or snd_ctl_new1().
269  * Don't call this after the control was added to the card.
270  */
271 void snd_ctl_free_one(struct snd_kcontrol *kcontrol)
272 {
273 	if (kcontrol) {
274 		if (kcontrol->private_free)
275 			kcontrol->private_free(kcontrol);
276 		kfree(kcontrol);
277 	}
278 }
279 
280 EXPORT_SYMBOL(snd_ctl_free_one);
281 
282 static bool snd_ctl_remove_numid_conflict(struct snd_card *card,
283 					  unsigned int count)
284 {
285 	struct snd_kcontrol *kctl;
286 
287 	list_for_each_entry(kctl, &card->controls, list) {
288 		if (kctl->id.numid < card->last_numid + 1 + count &&
289 		    kctl->id.numid + kctl->count > card->last_numid + 1) {
290 		    	card->last_numid = kctl->id.numid + kctl->count - 1;
291 			return true;
292 		}
293 	}
294 	return false;
295 }
296 
297 static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
298 {
299 	unsigned int iter = 100000;
300 
301 	while (snd_ctl_remove_numid_conflict(card, count)) {
302 		if (--iter == 0) {
303 			/* this situation is very unlikely */
304 			snd_printk(KERN_ERR "unable to allocate new control numid\n");
305 			return -ENOMEM;
306 		}
307 	}
308 	return 0;
309 }
310 
311 /**
312  * snd_ctl_add - add the control instance to the card
313  * @card: the card instance
314  * @kcontrol: the control instance to add
315  *
316  * Adds the control instance created via snd_ctl_new() or
317  * snd_ctl_new1() to the given card. Assigns also an unique
318  * numid used for fast search.
319  *
320  * Returns zero if successful, or a negative error code on failure.
321  *
322  * It frees automatically the control which cannot be added.
323  */
324 int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
325 {
326 	struct snd_ctl_elem_id id;
327 	unsigned int idx;
328 	int err = -EINVAL;
329 
330 	if (! kcontrol)
331 		return err;
332 	if (snd_BUG_ON(!card || !kcontrol->info))
333 		goto error;
334 	id = kcontrol->id;
335 	down_write(&card->controls_rwsem);
336 	if (snd_ctl_find_id(card, &id)) {
337 		up_write(&card->controls_rwsem);
338 		snd_printd(KERN_ERR "control %i:%i:%i:%s:%i is already present\n",
339 					id.iface,
340 					id.device,
341 					id.subdevice,
342 					id.name,
343 					id.index);
344 		err = -EBUSY;
345 		goto error;
346 	}
347 	if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
348 		up_write(&card->controls_rwsem);
349 		err = -ENOMEM;
350 		goto error;
351 	}
352 	list_add_tail(&kcontrol->list, &card->controls);
353 	card->controls_count += kcontrol->count;
354 	kcontrol->id.numid = card->last_numid + 1;
355 	card->last_numid += kcontrol->count;
356 	up_write(&card->controls_rwsem);
357 	for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
358 		snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
359 	return 0;
360 
361  error:
362 	snd_ctl_free_one(kcontrol);
363 	return err;
364 }
365 
366 EXPORT_SYMBOL(snd_ctl_add);
367 
368 /**
369  * snd_ctl_replace - replace the control instance of the card
370  * @card: the card instance
371  * @kcontrol: the control instance to replace
372  * @add_on_replace: add the control if not already added
373  *
374  * Replaces the given control.  If the given control does not exist
375  * and the add_on_replace flag is set, the control is added.  If the
376  * control exists, it is destroyed first.
377  *
378  * Returns zero if successful, or a negative error code on failure.
379  *
380  * It frees automatically the control which cannot be added or replaced.
381  */
382 int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol,
383 		    bool add_on_replace)
384 {
385 	struct snd_ctl_elem_id id;
386 	unsigned int idx;
387 	struct snd_kcontrol *old;
388 	int ret;
389 
390 	if (!kcontrol)
391 		return -EINVAL;
392 	if (snd_BUG_ON(!card || !kcontrol->info)) {
393 		ret = -EINVAL;
394 		goto error;
395 	}
396 	id = kcontrol->id;
397 	down_write(&card->controls_rwsem);
398 	old = snd_ctl_find_id(card, &id);
399 	if (!old) {
400 		if (add_on_replace)
401 			goto add;
402 		up_write(&card->controls_rwsem);
403 		ret = -EINVAL;
404 		goto error;
405 	}
406 	ret = snd_ctl_remove(card, old);
407 	if (ret < 0) {
408 		up_write(&card->controls_rwsem);
409 		goto error;
410 	}
411 add:
412 	if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
413 		up_write(&card->controls_rwsem);
414 		ret = -ENOMEM;
415 		goto error;
416 	}
417 	list_add_tail(&kcontrol->list, &card->controls);
418 	card->controls_count += kcontrol->count;
419 	kcontrol->id.numid = card->last_numid + 1;
420 	card->last_numid += kcontrol->count;
421 	up_write(&card->controls_rwsem);
422 	for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
423 		snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
424 	return 0;
425 
426 error:
427 	snd_ctl_free_one(kcontrol);
428 	return ret;
429 }
430 EXPORT_SYMBOL(snd_ctl_replace);
431 
432 /**
433  * snd_ctl_remove - remove the control from the card and release it
434  * @card: the card instance
435  * @kcontrol: the control instance to remove
436  *
437  * Removes the control from the card and then releases the instance.
438  * You don't need to call snd_ctl_free_one(). You must be in
439  * the write lock - down_write(&card->controls_rwsem).
440  *
441  * Returns 0 if successful, or a negative error code on failure.
442  */
443 int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
444 {
445 	struct snd_ctl_elem_id id;
446 	unsigned int idx;
447 
448 	if (snd_BUG_ON(!card || !kcontrol))
449 		return -EINVAL;
450 	list_del(&kcontrol->list);
451 	card->controls_count -= kcontrol->count;
452 	id = kcontrol->id;
453 	for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
454 		snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
455 	snd_ctl_free_one(kcontrol);
456 	return 0;
457 }
458 
459 EXPORT_SYMBOL(snd_ctl_remove);
460 
461 /**
462  * snd_ctl_remove_id - remove the control of the given id and release it
463  * @card: the card instance
464  * @id: the control id to remove
465  *
466  * Finds the control instance with the given id, removes it from the
467  * card list and releases it.
468  *
469  * Returns 0 if successful, or a negative error code on failure.
470  */
471 int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
472 {
473 	struct snd_kcontrol *kctl;
474 	int ret;
475 
476 	down_write(&card->controls_rwsem);
477 	kctl = snd_ctl_find_id(card, id);
478 	if (kctl == NULL) {
479 		up_write(&card->controls_rwsem);
480 		return -ENOENT;
481 	}
482 	ret = snd_ctl_remove(card, kctl);
483 	up_write(&card->controls_rwsem);
484 	return ret;
485 }
486 
487 EXPORT_SYMBOL(snd_ctl_remove_id);
488 
489 /**
490  * snd_ctl_remove_user_ctl - remove and release the unlocked user control
491  * @file: active control handle
492  * @id: the control id to remove
493  *
494  * Finds the control instance with the given id, removes it from the
495  * card list and releases it.
496  *
497  * Returns 0 if successful, or a negative error code on failure.
498  */
499 static int snd_ctl_remove_user_ctl(struct snd_ctl_file * file,
500 				   struct snd_ctl_elem_id *id)
501 {
502 	struct snd_card *card = file->card;
503 	struct snd_kcontrol *kctl;
504 	int idx, ret;
505 
506 	down_write(&card->controls_rwsem);
507 	kctl = snd_ctl_find_id(card, id);
508 	if (kctl == NULL) {
509 		ret = -ENOENT;
510 		goto error;
511 	}
512 	if (!(kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_USER)) {
513 		ret = -EINVAL;
514 		goto error;
515 	}
516 	for (idx = 0; idx < kctl->count; idx++)
517 		if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
518 			ret = -EBUSY;
519 			goto error;
520 		}
521 	ret = snd_ctl_remove(card, kctl);
522 	if (ret < 0)
523 		goto error;
524 	card->user_ctl_count--;
525 error:
526 	up_write(&card->controls_rwsem);
527 	return ret;
528 }
529 
530 /**
531  * snd_ctl_activate_id - activate/inactivate the control of the given id
532  * @card: the card instance
533  * @id: the control id to activate/inactivate
534  * @active: non-zero to activate
535  *
536  * Finds the control instance with the given id, and activate or
537  * inactivate the control together with notification, if changed.
538  *
539  * Returns 0 if unchanged, 1 if changed, or a negative error code on failure.
540  */
541 int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
542 			int active)
543 {
544 	struct snd_kcontrol *kctl;
545 	struct snd_kcontrol_volatile *vd;
546 	unsigned int index_offset;
547 	int ret;
548 
549 	down_write(&card->controls_rwsem);
550 	kctl = snd_ctl_find_id(card, id);
551 	if (kctl == NULL) {
552 		ret = -ENOENT;
553 		goto unlock;
554 	}
555 	index_offset = snd_ctl_get_ioff(kctl, &kctl->id);
556 	vd = &kctl->vd[index_offset];
557 	ret = 0;
558 	if (active) {
559 		if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE))
560 			goto unlock;
561 		vd->access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
562 	} else {
563 		if (vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE)
564 			goto unlock;
565 		vd->access |= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
566 	}
567 	ret = 1;
568  unlock:
569 	up_write(&card->controls_rwsem);
570 	if (ret > 0)
571 		snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_INFO, id);
572 	return ret;
573 }
574 EXPORT_SYMBOL_GPL(snd_ctl_activate_id);
575 
576 /**
577  * snd_ctl_rename_id - replace the id of a control on the card
578  * @card: the card instance
579  * @src_id: the old id
580  * @dst_id: the new id
581  *
582  * Finds the control with the old id from the card, and replaces the
583  * id with the new one.
584  *
585  * Returns zero if successful, or a negative error code on failure.
586  */
587 int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
588 		      struct snd_ctl_elem_id *dst_id)
589 {
590 	struct snd_kcontrol *kctl;
591 
592 	down_write(&card->controls_rwsem);
593 	kctl = snd_ctl_find_id(card, src_id);
594 	if (kctl == NULL) {
595 		up_write(&card->controls_rwsem);
596 		return -ENOENT;
597 	}
598 	kctl->id = *dst_id;
599 	kctl->id.numid = card->last_numid + 1;
600 	card->last_numid += kctl->count;
601 	up_write(&card->controls_rwsem);
602 	return 0;
603 }
604 
605 EXPORT_SYMBOL(snd_ctl_rename_id);
606 
607 /**
608  * snd_ctl_find_numid - find the control instance with the given number-id
609  * @card: the card instance
610  * @numid: the number-id to search
611  *
612  * Finds the control instance with the given number-id from the card.
613  *
614  * Returns the pointer of the instance if found, or NULL if not.
615  *
616  * The caller must down card->controls_rwsem before calling this function
617  * (if the race condition can happen).
618  */
619 struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
620 {
621 	struct snd_kcontrol *kctl;
622 
623 	if (snd_BUG_ON(!card || !numid))
624 		return NULL;
625 	list_for_each_entry(kctl, &card->controls, list) {
626 		if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
627 			return kctl;
628 	}
629 	return NULL;
630 }
631 
632 EXPORT_SYMBOL(snd_ctl_find_numid);
633 
634 /**
635  * snd_ctl_find_id - find the control instance with the given id
636  * @card: the card instance
637  * @id: the id to search
638  *
639  * Finds the control instance with the given id from the card.
640  *
641  * Returns the pointer of the instance if found, or NULL if not.
642  *
643  * The caller must down card->controls_rwsem before calling this function
644  * (if the race condition can happen).
645  */
646 struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
647 				     struct snd_ctl_elem_id *id)
648 {
649 	struct snd_kcontrol *kctl;
650 
651 	if (snd_BUG_ON(!card || !id))
652 		return NULL;
653 	if (id->numid != 0)
654 		return snd_ctl_find_numid(card, id->numid);
655 	list_for_each_entry(kctl, &card->controls, list) {
656 		if (kctl->id.iface != id->iface)
657 			continue;
658 		if (kctl->id.device != id->device)
659 			continue;
660 		if (kctl->id.subdevice != id->subdevice)
661 			continue;
662 		if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
663 			continue;
664 		if (kctl->id.index > id->index)
665 			continue;
666 		if (kctl->id.index + kctl->count <= id->index)
667 			continue;
668 		return kctl;
669 	}
670 	return NULL;
671 }
672 
673 EXPORT_SYMBOL(snd_ctl_find_id);
674 
675 static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
676 			     unsigned int cmd, void __user *arg)
677 {
678 	struct snd_ctl_card_info *info;
679 
680 	info = kzalloc(sizeof(*info), GFP_KERNEL);
681 	if (! info)
682 		return -ENOMEM;
683 	down_read(&snd_ioctl_rwsem);
684 	info->card = card->number;
685 	strlcpy(info->id, card->id, sizeof(info->id));
686 	strlcpy(info->driver, card->driver, sizeof(info->driver));
687 	strlcpy(info->name, card->shortname, sizeof(info->name));
688 	strlcpy(info->longname, card->longname, sizeof(info->longname));
689 	strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
690 	strlcpy(info->components, card->components, sizeof(info->components));
691 	up_read(&snd_ioctl_rwsem);
692 	if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
693 		kfree(info);
694 		return -EFAULT;
695 	}
696 	kfree(info);
697 	return 0;
698 }
699 
700 static int snd_ctl_elem_list(struct snd_card *card,
701 			     struct snd_ctl_elem_list __user *_list)
702 {
703 	struct list_head *plist;
704 	struct snd_ctl_elem_list list;
705 	struct snd_kcontrol *kctl;
706 	struct snd_ctl_elem_id *dst, *id;
707 	unsigned int offset, space, first, jidx;
708 
709 	if (copy_from_user(&list, _list, sizeof(list)))
710 		return -EFAULT;
711 	offset = list.offset;
712 	space = list.space;
713 	first = 0;
714 	/* try limit maximum space */
715 	if (space > 16384)
716 		return -ENOMEM;
717 	if (space > 0) {
718 		/* allocate temporary buffer for atomic operation */
719 		dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
720 		if (dst == NULL)
721 			return -ENOMEM;
722 		down_read(&card->controls_rwsem);
723 		list.count = card->controls_count;
724 		plist = card->controls.next;
725 		while (plist != &card->controls) {
726 			if (offset == 0)
727 				break;
728 			kctl = snd_kcontrol(plist);
729 			if (offset < kctl->count)
730 				break;
731 			offset -= kctl->count;
732 			plist = plist->next;
733 		}
734 		list.used = 0;
735 		id = dst;
736 		while (space > 0 && plist != &card->controls) {
737 			kctl = snd_kcontrol(plist);
738 			for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
739 				snd_ctl_build_ioff(id, kctl, jidx);
740 				id++;
741 				space--;
742 				list.used++;
743 			}
744 			plist = plist->next;
745 			offset = 0;
746 		}
747 		up_read(&card->controls_rwsem);
748 		if (list.used > 0 &&
749 		    copy_to_user(list.pids, dst,
750 				 list.used * sizeof(struct snd_ctl_elem_id))) {
751 			vfree(dst);
752 			return -EFAULT;
753 		}
754 		vfree(dst);
755 	} else {
756 		down_read(&card->controls_rwsem);
757 		list.count = card->controls_count;
758 		up_read(&card->controls_rwsem);
759 	}
760 	if (copy_to_user(_list, &list, sizeof(list)))
761 		return -EFAULT;
762 	return 0;
763 }
764 
765 static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
766 			     struct snd_ctl_elem_info *info)
767 {
768 	struct snd_card *card = ctl->card;
769 	struct snd_kcontrol *kctl;
770 	struct snd_kcontrol_volatile *vd;
771 	unsigned int index_offset;
772 	int result;
773 
774 	down_read(&card->controls_rwsem);
775 	kctl = snd_ctl_find_id(card, &info->id);
776 	if (kctl == NULL) {
777 		up_read(&card->controls_rwsem);
778 		return -ENOENT;
779 	}
780 #ifdef CONFIG_SND_DEBUG
781 	info->access = 0;
782 #endif
783 	result = kctl->info(kctl, info);
784 	if (result >= 0) {
785 		snd_BUG_ON(info->access);
786 		index_offset = snd_ctl_get_ioff(kctl, &info->id);
787 		vd = &kctl->vd[index_offset];
788 		snd_ctl_build_ioff(&info->id, kctl, index_offset);
789 		info->access = vd->access;
790 		if (vd->owner) {
791 			info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
792 			if (vd->owner == ctl)
793 				info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
794 			info->owner = pid_vnr(vd->owner->pid);
795 		} else {
796 			info->owner = -1;
797 		}
798 	}
799 	up_read(&card->controls_rwsem);
800 	return result;
801 }
802 
803 static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
804 				  struct snd_ctl_elem_info __user *_info)
805 {
806 	struct snd_ctl_elem_info info;
807 	int result;
808 
809 	if (copy_from_user(&info, _info, sizeof(info)))
810 		return -EFAULT;
811 	snd_power_lock(ctl->card);
812 	result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
813 	if (result >= 0)
814 		result = snd_ctl_elem_info(ctl, &info);
815 	snd_power_unlock(ctl->card);
816 	if (result >= 0)
817 		if (copy_to_user(_info, &info, sizeof(info)))
818 			return -EFAULT;
819 	return result;
820 }
821 
822 static int snd_ctl_elem_read(struct snd_card *card,
823 			     struct snd_ctl_elem_value *control)
824 {
825 	struct snd_kcontrol *kctl;
826 	struct snd_kcontrol_volatile *vd;
827 	unsigned int index_offset;
828 	int result;
829 
830 	down_read(&card->controls_rwsem);
831 	kctl = snd_ctl_find_id(card, &control->id);
832 	if (kctl == NULL) {
833 		result = -ENOENT;
834 	} else {
835 		index_offset = snd_ctl_get_ioff(kctl, &control->id);
836 		vd = &kctl->vd[index_offset];
837 		if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) &&
838 		    kctl->get != NULL) {
839 			snd_ctl_build_ioff(&control->id, kctl, index_offset);
840 			result = kctl->get(kctl, control);
841 		} else
842 			result = -EPERM;
843 	}
844 	up_read(&card->controls_rwsem);
845 	return result;
846 }
847 
848 static int snd_ctl_elem_read_user(struct snd_card *card,
849 				  struct snd_ctl_elem_value __user *_control)
850 {
851 	struct snd_ctl_elem_value *control;
852 	int result;
853 
854 	control = memdup_user(_control, sizeof(*control));
855 	if (IS_ERR(control))
856 		return PTR_ERR(control);
857 
858 	snd_power_lock(card);
859 	result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
860 	if (result >= 0)
861 		result = snd_ctl_elem_read(card, control);
862 	snd_power_unlock(card);
863 	if (result >= 0)
864 		if (copy_to_user(_control, control, sizeof(*control)))
865 			result = -EFAULT;
866 	kfree(control);
867 	return result;
868 }
869 
870 static int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
871 			      struct snd_ctl_elem_value *control)
872 {
873 	struct snd_kcontrol *kctl;
874 	struct snd_kcontrol_volatile *vd;
875 	unsigned int index_offset;
876 	int result;
877 
878 	down_read(&card->controls_rwsem);
879 	kctl = snd_ctl_find_id(card, &control->id);
880 	if (kctl == NULL) {
881 		result = -ENOENT;
882 	} else {
883 		index_offset = snd_ctl_get_ioff(kctl, &control->id);
884 		vd = &kctl->vd[index_offset];
885 		if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
886 		    kctl->put == NULL ||
887 		    (file && vd->owner && vd->owner != file)) {
888 			result = -EPERM;
889 		} else {
890 			snd_ctl_build_ioff(&control->id, kctl, index_offset);
891 			result = kctl->put(kctl, control);
892 		}
893 		if (result > 0) {
894 			up_read(&card->controls_rwsem);
895 			snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
896 				       &control->id);
897 			return 0;
898 		}
899 	}
900 	up_read(&card->controls_rwsem);
901 	return result;
902 }
903 
904 static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
905 				   struct snd_ctl_elem_value __user *_control)
906 {
907 	struct snd_ctl_elem_value *control;
908 	struct snd_card *card;
909 	int result;
910 
911 	control = memdup_user(_control, sizeof(*control));
912 	if (IS_ERR(control))
913 		return PTR_ERR(control);
914 
915 	card = file->card;
916 	snd_power_lock(card);
917 	result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
918 	if (result >= 0)
919 		result = snd_ctl_elem_write(card, file, control);
920 	snd_power_unlock(card);
921 	if (result >= 0)
922 		if (copy_to_user(_control, control, sizeof(*control)))
923 			result = -EFAULT;
924 	kfree(control);
925 	return result;
926 }
927 
928 static int snd_ctl_elem_lock(struct snd_ctl_file *file,
929 			     struct snd_ctl_elem_id __user *_id)
930 {
931 	struct snd_card *card = file->card;
932 	struct snd_ctl_elem_id id;
933 	struct snd_kcontrol *kctl;
934 	struct snd_kcontrol_volatile *vd;
935 	int result;
936 
937 	if (copy_from_user(&id, _id, sizeof(id)))
938 		return -EFAULT;
939 	down_write(&card->controls_rwsem);
940 	kctl = snd_ctl_find_id(card, &id);
941 	if (kctl == NULL) {
942 		result = -ENOENT;
943 	} else {
944 		vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
945 		if (vd->owner != NULL)
946 			result = -EBUSY;
947 		else {
948 			vd->owner = file;
949 			result = 0;
950 		}
951 	}
952 	up_write(&card->controls_rwsem);
953 	return result;
954 }
955 
956 static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
957 			       struct snd_ctl_elem_id __user *_id)
958 {
959 	struct snd_card *card = file->card;
960 	struct snd_ctl_elem_id id;
961 	struct snd_kcontrol *kctl;
962 	struct snd_kcontrol_volatile *vd;
963 	int result;
964 
965 	if (copy_from_user(&id, _id, sizeof(id)))
966 		return -EFAULT;
967 	down_write(&card->controls_rwsem);
968 	kctl = snd_ctl_find_id(card, &id);
969 	if (kctl == NULL) {
970 		result = -ENOENT;
971 	} else {
972 		vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
973 		if (vd->owner == NULL)
974 			result = -EINVAL;
975 		else if (vd->owner != file)
976 			result = -EPERM;
977 		else {
978 			vd->owner = NULL;
979 			result = 0;
980 		}
981 	}
982 	up_write(&card->controls_rwsem);
983 	return result;
984 }
985 
986 struct user_element {
987 	struct snd_ctl_elem_info info;
988 	void *elem_data;		/* element data */
989 	unsigned long elem_data_size;	/* size of element data in bytes */
990 	void *tlv_data;			/* TLV data */
991 	unsigned long tlv_data_size;	/* TLV data size */
992 	void *priv_data;		/* private data (like strings for enumerated type) */
993 	unsigned long priv_data_size;	/* size of private data in bytes */
994 };
995 
996 static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
997 				  struct snd_ctl_elem_info *uinfo)
998 {
999 	struct user_element *ue = kcontrol->private_data;
1000 
1001 	*uinfo = ue->info;
1002 	return 0;
1003 }
1004 
1005 static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
1006 				 struct snd_ctl_elem_value *ucontrol)
1007 {
1008 	struct user_element *ue = kcontrol->private_data;
1009 
1010 	memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
1011 	return 0;
1012 }
1013 
1014 static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
1015 				 struct snd_ctl_elem_value *ucontrol)
1016 {
1017 	int change;
1018 	struct user_element *ue = kcontrol->private_data;
1019 
1020 	change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
1021 	if (change)
1022 		memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
1023 	return change;
1024 }
1025 
1026 static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
1027 				 int op_flag,
1028 				 unsigned int size,
1029 				 unsigned int __user *tlv)
1030 {
1031 	struct user_element *ue = kcontrol->private_data;
1032 	int change = 0;
1033 	void *new_data;
1034 
1035 	if (op_flag > 0) {
1036 		if (size > 1024 * 128)	/* sane value */
1037 			return -EINVAL;
1038 
1039 		new_data = memdup_user(tlv, size);
1040 		if (IS_ERR(new_data))
1041 			return PTR_ERR(new_data);
1042 		change = ue->tlv_data_size != size;
1043 		if (!change)
1044 			change = memcmp(ue->tlv_data, new_data, size);
1045 		kfree(ue->tlv_data);
1046 		ue->tlv_data = new_data;
1047 		ue->tlv_data_size = size;
1048 	} else {
1049 		if (! ue->tlv_data_size || ! ue->tlv_data)
1050 			return -ENXIO;
1051 		if (size < ue->tlv_data_size)
1052 			return -ENOSPC;
1053 		if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
1054 			return -EFAULT;
1055 	}
1056 	return change;
1057 }
1058 
1059 static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
1060 {
1061 	struct user_element *ue = kcontrol->private_data;
1062 	if (ue->tlv_data)
1063 		kfree(ue->tlv_data);
1064 	kfree(ue);
1065 }
1066 
1067 static int snd_ctl_elem_add(struct snd_ctl_file *file,
1068 			    struct snd_ctl_elem_info *info, int replace)
1069 {
1070 	struct snd_card *card = file->card;
1071 	struct snd_kcontrol kctl, *_kctl;
1072 	unsigned int access;
1073 	long private_size;
1074 	struct user_element *ue;
1075 	int idx, err;
1076 
1077 	if (card->user_ctl_count >= MAX_USER_CONTROLS)
1078 		return -ENOMEM;
1079 	if (info->count < 1)
1080 		return -EINVAL;
1081 	access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
1082 		(info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
1083 				 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
1084 				 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
1085 	info->id.numid = 0;
1086 	memset(&kctl, 0, sizeof(kctl));
1087 	down_write(&card->controls_rwsem);
1088 	_kctl = snd_ctl_find_id(card, &info->id);
1089 	err = 0;
1090 	if (_kctl) {
1091 		if (replace)
1092 			err = snd_ctl_remove(card, _kctl);
1093 		else
1094 			err = -EBUSY;
1095 	} else {
1096 		if (replace)
1097 			err = -ENOENT;
1098 	}
1099 	up_write(&card->controls_rwsem);
1100 	if (err < 0)
1101 		return err;
1102 	memcpy(&kctl.id, &info->id, sizeof(info->id));
1103 	kctl.count = info->owner ? info->owner : 1;
1104 	access |= SNDRV_CTL_ELEM_ACCESS_USER;
1105 	kctl.info = snd_ctl_elem_user_info;
1106 	if (access & SNDRV_CTL_ELEM_ACCESS_READ)
1107 		kctl.get = snd_ctl_elem_user_get;
1108 	if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
1109 		kctl.put = snd_ctl_elem_user_put;
1110 	if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
1111 		kctl.tlv.c = snd_ctl_elem_user_tlv;
1112 		access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1113 	}
1114 	switch (info->type) {
1115 	case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
1116 	case SNDRV_CTL_ELEM_TYPE_INTEGER:
1117 		private_size = sizeof(long);
1118 		if (info->count > 128)
1119 			return -EINVAL;
1120 		break;
1121 	case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1122 		private_size = sizeof(long long);
1123 		if (info->count > 64)
1124 			return -EINVAL;
1125 		break;
1126 	case SNDRV_CTL_ELEM_TYPE_BYTES:
1127 		private_size = sizeof(unsigned char);
1128 		if (info->count > 512)
1129 			return -EINVAL;
1130 		break;
1131 	case SNDRV_CTL_ELEM_TYPE_IEC958:
1132 		private_size = sizeof(struct snd_aes_iec958);
1133 		if (info->count != 1)
1134 			return -EINVAL;
1135 		break;
1136 	default:
1137 		return -EINVAL;
1138 	}
1139 	private_size *= info->count;
1140 	ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
1141 	if (ue == NULL)
1142 		return -ENOMEM;
1143 	ue->info = *info;
1144 	ue->info.access = 0;
1145 	ue->elem_data = (char *)ue + sizeof(*ue);
1146 	ue->elem_data_size = private_size;
1147 	kctl.private_free = snd_ctl_elem_user_free;
1148 	_kctl = snd_ctl_new(&kctl, access);
1149 	if (_kctl == NULL) {
1150 		kfree(ue);
1151 		return -ENOMEM;
1152 	}
1153 	_kctl->private_data = ue;
1154 	for (idx = 0; idx < _kctl->count; idx++)
1155 		_kctl->vd[idx].owner = file;
1156 	err = snd_ctl_add(card, _kctl);
1157 	if (err < 0)
1158 		return err;
1159 
1160 	down_write(&card->controls_rwsem);
1161 	card->user_ctl_count++;
1162 	up_write(&card->controls_rwsem);
1163 
1164 	return 0;
1165 }
1166 
1167 static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1168 				 struct snd_ctl_elem_info __user *_info, int replace)
1169 {
1170 	struct snd_ctl_elem_info info;
1171 	if (copy_from_user(&info, _info, sizeof(info)))
1172 		return -EFAULT;
1173 	return snd_ctl_elem_add(file, &info, replace);
1174 }
1175 
1176 static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1177 			       struct snd_ctl_elem_id __user *_id)
1178 {
1179 	struct snd_ctl_elem_id id;
1180 
1181 	if (copy_from_user(&id, _id, sizeof(id)))
1182 		return -EFAULT;
1183 	return snd_ctl_remove_user_ctl(file, &id);
1184 }
1185 
1186 static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
1187 {
1188 	int subscribe;
1189 	if (get_user(subscribe, ptr))
1190 		return -EFAULT;
1191 	if (subscribe < 0) {
1192 		subscribe = file->subscribed;
1193 		if (put_user(subscribe, ptr))
1194 			return -EFAULT;
1195 		return 0;
1196 	}
1197 	if (subscribe) {
1198 		file->subscribed = 1;
1199 		return 0;
1200 	} else if (file->subscribed) {
1201 		snd_ctl_empty_read_queue(file);
1202 		file->subscribed = 0;
1203 	}
1204 	return 0;
1205 }
1206 
1207 static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1208                              struct snd_ctl_tlv __user *_tlv,
1209                              int op_flag)
1210 {
1211 	struct snd_card *card = file->card;
1212 	struct snd_ctl_tlv tlv;
1213 	struct snd_kcontrol *kctl;
1214 	struct snd_kcontrol_volatile *vd;
1215 	unsigned int len;
1216 	int err = 0;
1217 
1218 	if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1219 		return -EFAULT;
1220 	if (tlv.length < sizeof(unsigned int) * 2)
1221 		return -EINVAL;
1222 	down_read(&card->controls_rwsem);
1223 	kctl = snd_ctl_find_numid(card, tlv.numid);
1224 	if (kctl == NULL) {
1225 		err = -ENOENT;
1226 		goto __kctl_end;
1227 	}
1228 	if (kctl->tlv.p == NULL) {
1229 		err = -ENXIO;
1230 		goto __kctl_end;
1231 	}
1232 	vd = &kctl->vd[tlv.numid - kctl->id.numid];
1233 	if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1234 	    (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1235 	    (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1236 	    	err = -ENXIO;
1237 	    	goto __kctl_end;
1238 	}
1239 	if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
1240 		if (vd->owner != NULL && vd->owner != file) {
1241 			err = -EPERM;
1242 			goto __kctl_end;
1243 		}
1244 		err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
1245 		if (err > 0) {
1246 			up_read(&card->controls_rwsem);
1247 			snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &kctl->id);
1248 			return 0;
1249 		}
1250 	} else {
1251 		if (op_flag) {
1252 			err = -ENXIO;
1253 			goto __kctl_end;
1254 		}
1255 		len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1256 		if (tlv.length < len) {
1257 			err = -ENOMEM;
1258 			goto __kctl_end;
1259 		}
1260 		if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1261 			err = -EFAULT;
1262 	}
1263       __kctl_end:
1264 	up_read(&card->controls_rwsem);
1265 	return err;
1266 }
1267 
1268 static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1269 {
1270 	struct snd_ctl_file *ctl;
1271 	struct snd_card *card;
1272 	struct snd_kctl_ioctl *p;
1273 	void __user *argp = (void __user *)arg;
1274 	int __user *ip = argp;
1275 	int err;
1276 
1277 	ctl = file->private_data;
1278 	card = ctl->card;
1279 	if (snd_BUG_ON(!card))
1280 		return -ENXIO;
1281 	switch (cmd) {
1282 	case SNDRV_CTL_IOCTL_PVERSION:
1283 		return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1284 	case SNDRV_CTL_IOCTL_CARD_INFO:
1285 		return snd_ctl_card_info(card, ctl, cmd, argp);
1286 	case SNDRV_CTL_IOCTL_ELEM_LIST:
1287 		return snd_ctl_elem_list(card, argp);
1288 	case SNDRV_CTL_IOCTL_ELEM_INFO:
1289 		return snd_ctl_elem_info_user(ctl, argp);
1290 	case SNDRV_CTL_IOCTL_ELEM_READ:
1291 		return snd_ctl_elem_read_user(card, argp);
1292 	case SNDRV_CTL_IOCTL_ELEM_WRITE:
1293 		return snd_ctl_elem_write_user(ctl, argp);
1294 	case SNDRV_CTL_IOCTL_ELEM_LOCK:
1295 		return snd_ctl_elem_lock(ctl, argp);
1296 	case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1297 		return snd_ctl_elem_unlock(ctl, argp);
1298 	case SNDRV_CTL_IOCTL_ELEM_ADD:
1299 		return snd_ctl_elem_add_user(ctl, argp, 0);
1300 	case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1301 		return snd_ctl_elem_add_user(ctl, argp, 1);
1302 	case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1303 		return snd_ctl_elem_remove(ctl, argp);
1304 	case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1305 		return snd_ctl_subscribe_events(ctl, ip);
1306 	case SNDRV_CTL_IOCTL_TLV_READ:
1307 		return snd_ctl_tlv_ioctl(ctl, argp, 0);
1308 	case SNDRV_CTL_IOCTL_TLV_WRITE:
1309 		return snd_ctl_tlv_ioctl(ctl, argp, 1);
1310 	case SNDRV_CTL_IOCTL_TLV_COMMAND:
1311 		return snd_ctl_tlv_ioctl(ctl, argp, -1);
1312 	case SNDRV_CTL_IOCTL_POWER:
1313 		return -ENOPROTOOPT;
1314 	case SNDRV_CTL_IOCTL_POWER_STATE:
1315 #ifdef CONFIG_PM
1316 		return put_user(card->power_state, ip) ? -EFAULT : 0;
1317 #else
1318 		return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1319 #endif
1320 	}
1321 	down_read(&snd_ioctl_rwsem);
1322 	list_for_each_entry(p, &snd_control_ioctls, list) {
1323 		err = p->fioctl(card, ctl, cmd, arg);
1324 		if (err != -ENOIOCTLCMD) {
1325 			up_read(&snd_ioctl_rwsem);
1326 			return err;
1327 		}
1328 	}
1329 	up_read(&snd_ioctl_rwsem);
1330 	snd_printdd("unknown ioctl = 0x%x\n", cmd);
1331 	return -ENOTTY;
1332 }
1333 
1334 static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1335 			    size_t count, loff_t * offset)
1336 {
1337 	struct snd_ctl_file *ctl;
1338 	int err = 0;
1339 	ssize_t result = 0;
1340 
1341 	ctl = file->private_data;
1342 	if (snd_BUG_ON(!ctl || !ctl->card))
1343 		return -ENXIO;
1344 	if (!ctl->subscribed)
1345 		return -EBADFD;
1346 	if (count < sizeof(struct snd_ctl_event))
1347 		return -EINVAL;
1348 	spin_lock_irq(&ctl->read_lock);
1349 	while (count >= sizeof(struct snd_ctl_event)) {
1350 		struct snd_ctl_event ev;
1351 		struct snd_kctl_event *kev;
1352 		while (list_empty(&ctl->events)) {
1353 			wait_queue_t wait;
1354 			if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1355 				err = -EAGAIN;
1356 				goto __end_lock;
1357 			}
1358 			init_waitqueue_entry(&wait, current);
1359 			add_wait_queue(&ctl->change_sleep, &wait);
1360 			set_current_state(TASK_INTERRUPTIBLE);
1361 			spin_unlock_irq(&ctl->read_lock);
1362 			schedule();
1363 			remove_wait_queue(&ctl->change_sleep, &wait);
1364 			if (signal_pending(current))
1365 				return -ERESTARTSYS;
1366 			spin_lock_irq(&ctl->read_lock);
1367 		}
1368 		kev = snd_kctl_event(ctl->events.next);
1369 		ev.type = SNDRV_CTL_EVENT_ELEM;
1370 		ev.data.elem.mask = kev->mask;
1371 		ev.data.elem.id = kev->id;
1372 		list_del(&kev->list);
1373 		spin_unlock_irq(&ctl->read_lock);
1374 		kfree(kev);
1375 		if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
1376 			err = -EFAULT;
1377 			goto __end;
1378 		}
1379 		spin_lock_irq(&ctl->read_lock);
1380 		buffer += sizeof(struct snd_ctl_event);
1381 		count -= sizeof(struct snd_ctl_event);
1382 		result += sizeof(struct snd_ctl_event);
1383 	}
1384       __end_lock:
1385 	spin_unlock_irq(&ctl->read_lock);
1386       __end:
1387       	return result > 0 ? result : err;
1388 }
1389 
1390 static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1391 {
1392 	unsigned int mask;
1393 	struct snd_ctl_file *ctl;
1394 
1395 	ctl = file->private_data;
1396 	if (!ctl->subscribed)
1397 		return 0;
1398 	poll_wait(file, &ctl->change_sleep, wait);
1399 
1400 	mask = 0;
1401 	if (!list_empty(&ctl->events))
1402 		mask |= POLLIN | POLLRDNORM;
1403 
1404 	return mask;
1405 }
1406 
1407 /*
1408  * register the device-specific control-ioctls.
1409  * called from each device manager like pcm.c, hwdep.c, etc.
1410  */
1411 static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1412 {
1413 	struct snd_kctl_ioctl *pn;
1414 
1415 	pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
1416 	if (pn == NULL)
1417 		return -ENOMEM;
1418 	pn->fioctl = fcn;
1419 	down_write(&snd_ioctl_rwsem);
1420 	list_add_tail(&pn->list, lists);
1421 	up_write(&snd_ioctl_rwsem);
1422 	return 0;
1423 }
1424 
1425 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1426 {
1427 	return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1428 }
1429 
1430 EXPORT_SYMBOL(snd_ctl_register_ioctl);
1431 
1432 #ifdef CONFIG_COMPAT
1433 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1434 {
1435 	return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1436 }
1437 
1438 EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
1439 #endif
1440 
1441 /*
1442  * de-register the device-specific control-ioctls.
1443  */
1444 static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1445 				     struct list_head *lists)
1446 {
1447 	struct snd_kctl_ioctl *p;
1448 
1449 	if (snd_BUG_ON(!fcn))
1450 		return -EINVAL;
1451 	down_write(&snd_ioctl_rwsem);
1452 	list_for_each_entry(p, lists, list) {
1453 		if (p->fioctl == fcn) {
1454 			list_del(&p->list);
1455 			up_write(&snd_ioctl_rwsem);
1456 			kfree(p);
1457 			return 0;
1458 		}
1459 	}
1460 	up_write(&snd_ioctl_rwsem);
1461 	snd_BUG();
1462 	return -EINVAL;
1463 }
1464 
1465 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1466 {
1467 	return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1468 }
1469 
1470 EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1471 
1472 #ifdef CONFIG_COMPAT
1473 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1474 {
1475 	return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1476 }
1477 
1478 EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
1479 #endif
1480 
1481 static int snd_ctl_fasync(int fd, struct file * file, int on)
1482 {
1483 	struct snd_ctl_file *ctl;
1484 
1485 	ctl = file->private_data;
1486 	return fasync_helper(fd, file, on, &ctl->fasync);
1487 }
1488 
1489 /*
1490  * ioctl32 compat
1491  */
1492 #ifdef CONFIG_COMPAT
1493 #include "control_compat.c"
1494 #else
1495 #define snd_ctl_ioctl_compat	NULL
1496 #endif
1497 
1498 /*
1499  *  INIT PART
1500  */
1501 
1502 static const struct file_operations snd_ctl_f_ops =
1503 {
1504 	.owner =	THIS_MODULE,
1505 	.read =		snd_ctl_read,
1506 	.open =		snd_ctl_open,
1507 	.release =	snd_ctl_release,
1508 	.llseek =	no_llseek,
1509 	.poll =		snd_ctl_poll,
1510 	.unlocked_ioctl =	snd_ctl_ioctl,
1511 	.compat_ioctl =	snd_ctl_ioctl_compat,
1512 	.fasync =	snd_ctl_fasync,
1513 };
1514 
1515 /*
1516  * registration of the control device
1517  */
1518 static int snd_ctl_dev_register(struct snd_device *device)
1519 {
1520 	struct snd_card *card = device->device_data;
1521 	int err, cardnum;
1522 	char name[16];
1523 
1524 	if (snd_BUG_ON(!card))
1525 		return -ENXIO;
1526 	cardnum = card->number;
1527 	if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1528 		return -ENXIO;
1529 	sprintf(name, "controlC%i", cardnum);
1530 	if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1531 				       &snd_ctl_f_ops, card, name)) < 0)
1532 		return err;
1533 	return 0;
1534 }
1535 
1536 /*
1537  * disconnection of the control device
1538  */
1539 static int snd_ctl_dev_disconnect(struct snd_device *device)
1540 {
1541 	struct snd_card *card = device->device_data;
1542 	struct snd_ctl_file *ctl;
1543 	int err, cardnum;
1544 
1545 	if (snd_BUG_ON(!card))
1546 		return -ENXIO;
1547 	cardnum = card->number;
1548 	if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1549 		return -ENXIO;
1550 
1551 	read_lock(&card->ctl_files_rwlock);
1552 	list_for_each_entry(ctl, &card->ctl_files, list) {
1553 		wake_up(&ctl->change_sleep);
1554 		kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1555 	}
1556 	read_unlock(&card->ctl_files_rwlock);
1557 
1558 	if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1559 					 card, -1)) < 0)
1560 		return err;
1561 	return 0;
1562 }
1563 
1564 /*
1565  * free all controls
1566  */
1567 static int snd_ctl_dev_free(struct snd_device *device)
1568 {
1569 	struct snd_card *card = device->device_data;
1570 	struct snd_kcontrol *control;
1571 
1572 	down_write(&card->controls_rwsem);
1573 	while (!list_empty(&card->controls)) {
1574 		control = snd_kcontrol(card->controls.next);
1575 		snd_ctl_remove(card, control);
1576 	}
1577 	up_write(&card->controls_rwsem);
1578 	return 0;
1579 }
1580 
1581 /*
1582  * create control core:
1583  * called from init.c
1584  */
1585 int snd_ctl_create(struct snd_card *card)
1586 {
1587 	static struct snd_device_ops ops = {
1588 		.dev_free = snd_ctl_dev_free,
1589 		.dev_register =	snd_ctl_dev_register,
1590 		.dev_disconnect = snd_ctl_dev_disconnect,
1591 	};
1592 
1593 	if (snd_BUG_ON(!card))
1594 		return -ENXIO;
1595 	return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
1596 }
1597 
1598 /*
1599  * Frequently used control callbacks/helpers
1600  */
1601 int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
1602 			      struct snd_ctl_elem_info *uinfo)
1603 {
1604 	uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1605 	uinfo->count = 1;
1606 	uinfo->value.integer.min = 0;
1607 	uinfo->value.integer.max = 1;
1608 	return 0;
1609 }
1610 
1611 EXPORT_SYMBOL(snd_ctl_boolean_mono_info);
1612 
1613 int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
1614 				struct snd_ctl_elem_info *uinfo)
1615 {
1616 	uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1617 	uinfo->count = 2;
1618 	uinfo->value.integer.min = 0;
1619 	uinfo->value.integer.max = 1;
1620 	return 0;
1621 }
1622 
1623 EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);
1624 
1625 /**
1626  * snd_ctl_enum_info - fills the info structure for an enumerated control
1627  * @info: the structure to be filled
1628  * @channels: the number of the control's channels; often one
1629  * @items: the number of control values; also the size of @names
1630  * @names: an array containing the names of all control values
1631  *
1632  * Sets all required fields in @info to their appropriate values.
1633  * If the control's accessibility is not the default (readable and writable),
1634  * the caller has to fill @info->access.
1635  */
1636 int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
1637 		      unsigned int items, const char *const names[])
1638 {
1639 	info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1640 	info->count = channels;
1641 	info->value.enumerated.items = items;
1642 	if (info->value.enumerated.item >= items)
1643 		info->value.enumerated.item = items - 1;
1644 	strlcpy(info->value.enumerated.name,
1645 		names[info->value.enumerated.item],
1646 		sizeof(info->value.enumerated.name));
1647 	return 0;
1648 }
1649 EXPORT_SYMBOL(snd_ctl_enum_info);
1650