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