2 * Routines for driver control interface
3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
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.
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.
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
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>
32 /* max number of user-defined controls */
33 #define MAX_USER_CONTROLS 32
35 struct snd_kctl_ioctl {
36 struct list_head list; /* list of all ioctls */
37 snd_kctl_ioctl_func_t fioctl;
40 static DECLARE_RWSEM(snd_ioctl_rwsem);
41 static LIST_HEAD(snd_control_ioctls);
43 static LIST_HEAD(snd_control_compat_ioctls);
46 static int snd_ctl_open(struct inode *inode, struct file *file)
49 struct snd_card *card;
50 struct snd_ctl_file *ctl;
53 card = snd_lookup_minor_data(iminor(inode), SNDRV_DEVICE_TYPE_CONTROL);
58 err = snd_card_file_add(card, file);
63 if (!try_module_get(card->module)) {
67 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
72 INIT_LIST_HEAD(&ctl->events);
73 init_waitqueue_head(&ctl->change_sleep);
74 spin_lock_init(&ctl->read_lock);
76 ctl->prefer_pcm_subdevice = -1;
77 ctl->prefer_rawmidi_subdevice = -1;
78 ctl->pid = current->pid;
79 file->private_data = ctl;
80 write_lock_irqsave(&card->ctl_files_rwlock, flags);
81 list_add_tail(&ctl->list, &card->ctl_files);
82 write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
86 module_put(card->module);
88 snd_card_file_remove(card, file);
93 static void snd_ctl_empty_read_queue(struct snd_ctl_file * ctl)
96 struct snd_kctl_event *cread;
98 spin_lock_irqsave(&ctl->read_lock, flags);
99 while (!list_empty(&ctl->events)) {
100 cread = snd_kctl_event(ctl->events.next);
101 list_del(&cread->list);
104 spin_unlock_irqrestore(&ctl->read_lock, flags);
107 static int snd_ctl_release(struct inode *inode, struct file *file)
110 struct snd_card *card;
111 struct snd_ctl_file *ctl;
112 struct snd_kcontrol *control;
115 ctl = file->private_data;
116 fasync_helper(-1, file, 0, &ctl->fasync);
117 file->private_data = NULL;
119 write_lock_irqsave(&card->ctl_files_rwlock, flags);
120 list_del(&ctl->list);
121 write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
122 down_write(&card->controls_rwsem);
123 list_for_each_entry(control, &card->controls, list)
124 for (idx = 0; idx < control->count; idx++)
125 if (control->vd[idx].owner == ctl)
126 control->vd[idx].owner = NULL;
127 up_write(&card->controls_rwsem);
128 snd_ctl_empty_read_queue(ctl);
130 module_put(card->module);
131 snd_card_file_remove(card, file);
135 void snd_ctl_notify(struct snd_card *card, unsigned int mask,
136 struct snd_ctl_elem_id *id)
139 struct snd_ctl_file *ctl;
140 struct snd_kctl_event *ev;
142 if (snd_BUG_ON(!card || !id))
144 read_lock(&card->ctl_files_rwlock);
145 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
146 card->mixer_oss_change_count++;
148 list_for_each_entry(ctl, &card->ctl_files, list) {
149 if (!ctl->subscribed)
151 spin_lock_irqsave(&ctl->read_lock, flags);
152 list_for_each_entry(ev, &ctl->events, list) {
153 if (ev->id.numid == id->numid) {
158 ev = kzalloc(sizeof(*ev), GFP_ATOMIC);
162 list_add_tail(&ev->list, &ctl->events);
164 snd_printk(KERN_ERR "No memory available to allocate event\n");
167 wake_up(&ctl->change_sleep);
168 spin_unlock_irqrestore(&ctl->read_lock, flags);
169 kill_fasync(&ctl->fasync, SIGIO, POLL_IN);
171 read_unlock(&card->ctl_files_rwlock);
174 EXPORT_SYMBOL(snd_ctl_notify);
177 * snd_ctl_new - create a control instance from the template
178 * @control: the control template
179 * @access: the default control access
181 * Allocates a new struct snd_kcontrol instance and copies the given template
182 * to the new instance. It does not copy volatile data (access).
184 * Returns the pointer of the new instance, or NULL on failure.
186 static struct snd_kcontrol *snd_ctl_new(struct snd_kcontrol *control,
189 struct snd_kcontrol *kctl;
192 if (snd_BUG_ON(!control || !control->count))
194 kctl = kzalloc(sizeof(*kctl) + sizeof(struct snd_kcontrol_volatile) * control->count, GFP_KERNEL);
196 snd_printk(KERN_ERR "Cannot allocate control instance\n");
200 for (idx = 0; idx < kctl->count; idx++)
201 kctl->vd[idx].access = access;
206 * snd_ctl_new1 - create a control instance from the template
207 * @ncontrol: the initialization record
208 * @private_data: the private data to set
210 * Allocates a new struct snd_kcontrol instance and initialize from the given
211 * template. When the access field of ncontrol is 0, it's assumed as
212 * READWRITE access. When the count field is 0, it's assumes as one.
214 * Returns the pointer of the newly generated instance, or NULL on failure.
216 struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new *ncontrol,
219 struct snd_kcontrol kctl;
222 if (snd_BUG_ON(!ncontrol || !ncontrol->info))
224 memset(&kctl, 0, sizeof(kctl));
225 kctl.id.iface = ncontrol->iface;
226 kctl.id.device = ncontrol->device;
227 kctl.id.subdevice = ncontrol->subdevice;
228 if (ncontrol->name) {
229 strlcpy(kctl.id.name, ncontrol->name, sizeof(kctl.id.name));
230 if (strcmp(ncontrol->name, kctl.id.name) != 0)
231 snd_printk(KERN_WARNING
232 "Control name '%s' truncated to '%s'\n",
233 ncontrol->name, kctl.id.name);
235 kctl.id.index = ncontrol->index;
236 kctl.count = ncontrol->count ? ncontrol->count : 1;
237 access = ncontrol->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
238 (ncontrol->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
239 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
240 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE|
241 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK));
242 kctl.info = ncontrol->info;
243 kctl.get = ncontrol->get;
244 kctl.put = ncontrol->put;
245 kctl.tlv.p = ncontrol->tlv.p;
246 kctl.private_value = ncontrol->private_value;
247 kctl.private_data = private_data;
248 return snd_ctl_new(&kctl, access);
251 EXPORT_SYMBOL(snd_ctl_new1);
254 * snd_ctl_free_one - release the control instance
255 * @kcontrol: the control instance
257 * Releases the control instance created via snd_ctl_new()
259 * Don't call this after the control was added to the card.
261 void snd_ctl_free_one(struct snd_kcontrol *kcontrol)
264 if (kcontrol->private_free)
265 kcontrol->private_free(kcontrol);
270 EXPORT_SYMBOL(snd_ctl_free_one);
272 static unsigned int snd_ctl_hole_check(struct snd_card *card,
275 struct snd_kcontrol *kctl;
277 list_for_each_entry(kctl, &card->controls, list) {
278 if ((kctl->id.numid <= card->last_numid &&
279 kctl->id.numid + kctl->count > card->last_numid) ||
280 (kctl->id.numid <= card->last_numid + count - 1 &&
281 kctl->id.numid + kctl->count > card->last_numid + count - 1))
282 return card->last_numid = kctl->id.numid + kctl->count - 1;
284 return card->last_numid;
287 static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
289 unsigned int last_numid, iter = 100000;
291 last_numid = card->last_numid;
292 while (last_numid != snd_ctl_hole_check(card, count)) {
294 /* this situation is very unlikely */
295 snd_printk(KERN_ERR "unable to allocate new control numid\n");
298 last_numid = card->last_numid;
304 * snd_ctl_add - add the control instance to the card
305 * @card: the card instance
306 * @kcontrol: the control instance to add
308 * Adds the control instance created via snd_ctl_new() or
309 * snd_ctl_new1() to the given card. Assigns also an unique
310 * numid used for fast search.
312 * Returns zero if successful, or a negative error code on failure.
314 * It frees automatically the control which cannot be added.
316 int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
318 struct snd_ctl_elem_id id;
324 if (snd_BUG_ON(!card || !kcontrol->info))
327 down_write(&card->controls_rwsem);
328 if (snd_ctl_find_id(card, &id)) {
329 up_write(&card->controls_rwsem);
330 snd_printd(KERN_ERR "control %i:%i:%i:%s:%i is already present\n",
339 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
340 up_write(&card->controls_rwsem);
344 list_add_tail(&kcontrol->list, &card->controls);
345 card->controls_count += kcontrol->count;
346 kcontrol->id.numid = card->last_numid + 1;
347 card->last_numid += kcontrol->count;
348 up_write(&card->controls_rwsem);
349 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
350 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
354 snd_ctl_free_one(kcontrol);
358 EXPORT_SYMBOL(snd_ctl_add);
361 * snd_ctl_remove - remove the control from the card and release it
362 * @card: the card instance
363 * @kcontrol: the control instance to remove
365 * Removes the control from the card and then releases the instance.
366 * You don't need to call snd_ctl_free_one(). You must be in
367 * the write lock - down_write(&card->controls_rwsem).
369 * Returns 0 if successful, or a negative error code on failure.
371 int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
373 struct snd_ctl_elem_id id;
376 if (snd_BUG_ON(!card || !kcontrol))
378 list_del(&kcontrol->list);
379 card->controls_count -= kcontrol->count;
381 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
382 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
383 snd_ctl_free_one(kcontrol);
387 EXPORT_SYMBOL(snd_ctl_remove);
390 * snd_ctl_remove_id - remove the control of the given id and release it
391 * @card: the card instance
392 * @id: the control id to remove
394 * Finds the control instance with the given id, removes it from the
395 * card list and releases it.
397 * Returns 0 if successful, or a negative error code on failure.
399 int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
401 struct snd_kcontrol *kctl;
404 down_write(&card->controls_rwsem);
405 kctl = snd_ctl_find_id(card, id);
407 up_write(&card->controls_rwsem);
410 ret = snd_ctl_remove(card, kctl);
411 up_write(&card->controls_rwsem);
415 EXPORT_SYMBOL(snd_ctl_remove_id);
418 * snd_ctl_remove_unlocked_id - remove the unlocked control of the given id and release it
419 * @file: active control handle
420 * @id: the control id to remove
422 * Finds the control instance with the given id, removes it from the
423 * card list and releases it.
425 * Returns 0 if successful, or a negative error code on failure.
427 static int snd_ctl_remove_unlocked_id(struct snd_ctl_file * file,
428 struct snd_ctl_elem_id *id)
430 struct snd_card *card = file->card;
431 struct snd_kcontrol *kctl;
434 down_write(&card->controls_rwsem);
435 kctl = snd_ctl_find_id(card, id);
437 up_write(&card->controls_rwsem);
440 for (idx = 0; idx < kctl->count; idx++)
441 if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
442 up_write(&card->controls_rwsem);
445 ret = snd_ctl_remove(card, kctl);
446 up_write(&card->controls_rwsem);
451 * snd_ctl_rename_id - replace the id of a control on the card
452 * @card: the card instance
453 * @src_id: the old id
454 * @dst_id: the new id
456 * Finds the control with the old id from the card, and replaces the
457 * id with the new one.
459 * Returns zero if successful, or a negative error code on failure.
461 int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
462 struct snd_ctl_elem_id *dst_id)
464 struct snd_kcontrol *kctl;
466 down_write(&card->controls_rwsem);
467 kctl = snd_ctl_find_id(card, src_id);
469 up_write(&card->controls_rwsem);
473 kctl->id.numid = card->last_numid + 1;
474 card->last_numid += kctl->count;
475 up_write(&card->controls_rwsem);
479 EXPORT_SYMBOL(snd_ctl_rename_id);
482 * snd_ctl_find_numid - find the control instance with the given number-id
483 * @card: the card instance
484 * @numid: the number-id to search
486 * Finds the control instance with the given number-id from the card.
488 * Returns the pointer of the instance if found, or NULL if not.
490 * The caller must down card->controls_rwsem before calling this function
491 * (if the race condition can happen).
493 struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
495 struct snd_kcontrol *kctl;
497 if (snd_BUG_ON(!card || !numid))
499 list_for_each_entry(kctl, &card->controls, list) {
500 if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
506 EXPORT_SYMBOL(snd_ctl_find_numid);
509 * snd_ctl_find_id - find the control instance with the given id
510 * @card: the card instance
511 * @id: the id to search
513 * Finds the control instance with the given id from the card.
515 * Returns the pointer of the instance if found, or NULL if not.
517 * The caller must down card->controls_rwsem before calling this function
518 * (if the race condition can happen).
520 struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
521 struct snd_ctl_elem_id *id)
523 struct snd_kcontrol *kctl;
525 if (snd_BUG_ON(!card || !id))
528 return snd_ctl_find_numid(card, id->numid);
529 list_for_each_entry(kctl, &card->controls, list) {
530 if (kctl->id.iface != id->iface)
532 if (kctl->id.device != id->device)
534 if (kctl->id.subdevice != id->subdevice)
536 if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
538 if (kctl->id.index > id->index)
540 if (kctl->id.index + kctl->count <= id->index)
547 EXPORT_SYMBOL(snd_ctl_find_id);
549 static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
550 unsigned int cmd, void __user *arg)
552 struct snd_ctl_card_info *info;
554 info = kzalloc(sizeof(*info), GFP_KERNEL);
557 down_read(&snd_ioctl_rwsem);
558 info->card = card->number;
559 strlcpy(info->id, card->id, sizeof(info->id));
560 strlcpy(info->driver, card->driver, sizeof(info->driver));
561 strlcpy(info->name, card->shortname, sizeof(info->name));
562 strlcpy(info->longname, card->longname, sizeof(info->longname));
563 strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
564 strlcpy(info->components, card->components, sizeof(info->components));
565 up_read(&snd_ioctl_rwsem);
566 if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
574 static int snd_ctl_elem_list(struct snd_card *card,
575 struct snd_ctl_elem_list __user *_list)
577 struct list_head *plist;
578 struct snd_ctl_elem_list list;
579 struct snd_kcontrol *kctl;
580 struct snd_ctl_elem_id *dst, *id;
581 unsigned int offset, space, first, jidx;
583 if (copy_from_user(&list, _list, sizeof(list)))
585 offset = list.offset;
588 /* try limit maximum space */
592 /* allocate temporary buffer for atomic operation */
593 dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
596 down_read(&card->controls_rwsem);
597 list.count = card->controls_count;
598 plist = card->controls.next;
599 while (plist != &card->controls) {
602 kctl = snd_kcontrol(plist);
603 if (offset < kctl->count)
605 offset -= kctl->count;
610 while (space > 0 && plist != &card->controls) {
611 kctl = snd_kcontrol(plist);
612 for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
613 snd_ctl_build_ioff(id, kctl, jidx);
621 up_read(&card->controls_rwsem);
623 copy_to_user(list.pids, dst,
624 list.used * sizeof(struct snd_ctl_elem_id))) {
630 down_read(&card->controls_rwsem);
631 list.count = card->controls_count;
632 up_read(&card->controls_rwsem);
634 if (copy_to_user(_list, &list, sizeof(list)))
639 static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
640 struct snd_ctl_elem_info *info)
642 struct snd_card *card = ctl->card;
643 struct snd_kcontrol *kctl;
644 struct snd_kcontrol_volatile *vd;
645 unsigned int index_offset;
648 down_read(&card->controls_rwsem);
649 kctl = snd_ctl_find_id(card, &info->id);
651 up_read(&card->controls_rwsem);
654 #ifdef CONFIG_SND_DEBUG
657 result = kctl->info(kctl, info);
659 snd_BUG_ON(info->access);
660 index_offset = snd_ctl_get_ioff(kctl, &info->id);
661 vd = &kctl->vd[index_offset];
662 snd_ctl_build_ioff(&info->id, kctl, index_offset);
663 info->access = vd->access;
665 info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
666 if (vd->owner == ctl)
667 info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
668 info->owner = vd->owner_pid;
673 up_read(&card->controls_rwsem);
677 static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
678 struct snd_ctl_elem_info __user *_info)
680 struct snd_ctl_elem_info info;
683 if (copy_from_user(&info, _info, sizeof(info)))
685 snd_power_lock(ctl->card);
686 result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
688 result = snd_ctl_elem_info(ctl, &info);
689 snd_power_unlock(ctl->card);
691 if (copy_to_user(_info, &info, sizeof(info)))
696 static int snd_ctl_elem_read(struct snd_card *card,
697 struct snd_ctl_elem_value *control)
699 struct snd_kcontrol *kctl;
700 struct snd_kcontrol_volatile *vd;
701 unsigned int index_offset;
704 down_read(&card->controls_rwsem);
705 kctl = snd_ctl_find_id(card, &control->id);
709 index_offset = snd_ctl_get_ioff(kctl, &control->id);
710 vd = &kctl->vd[index_offset];
711 if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) &&
713 snd_ctl_build_ioff(&control->id, kctl, index_offset);
714 result = kctl->get(kctl, control);
718 up_read(&card->controls_rwsem);
722 static int snd_ctl_elem_read_user(struct snd_card *card,
723 struct snd_ctl_elem_value __user *_control)
725 struct snd_ctl_elem_value *control;
728 control = kmalloc(sizeof(*control), GFP_KERNEL);
731 if (copy_from_user(control, _control, sizeof(*control))) {
735 snd_power_lock(card);
736 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
738 result = snd_ctl_elem_read(card, control);
739 snd_power_unlock(card);
741 if (copy_to_user(_control, control, sizeof(*control)))
747 static int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
748 struct snd_ctl_elem_value *control)
750 struct snd_kcontrol *kctl;
751 struct snd_kcontrol_volatile *vd;
752 unsigned int index_offset;
755 down_read(&card->controls_rwsem);
756 kctl = snd_ctl_find_id(card, &control->id);
760 index_offset = snd_ctl_get_ioff(kctl, &control->id);
761 vd = &kctl->vd[index_offset];
762 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
764 (file && vd->owner && vd->owner != file)) {
767 snd_ctl_build_ioff(&control->id, kctl, index_offset);
768 result = kctl->put(kctl, control);
771 up_read(&card->controls_rwsem);
772 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
777 up_read(&card->controls_rwsem);
781 static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
782 struct snd_ctl_elem_value __user *_control)
784 struct snd_ctl_elem_value *control;
785 struct snd_card *card;
788 control = kmalloc(sizeof(*control), GFP_KERNEL);
791 if (copy_from_user(control, _control, sizeof(*control))) {
796 snd_power_lock(card);
797 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
799 result = snd_ctl_elem_write(card, file, control);
800 snd_power_unlock(card);
802 if (copy_to_user(_control, control, sizeof(*control)))
808 static int snd_ctl_elem_lock(struct snd_ctl_file *file,
809 struct snd_ctl_elem_id __user *_id)
811 struct snd_card *card = file->card;
812 struct snd_ctl_elem_id id;
813 struct snd_kcontrol *kctl;
814 struct snd_kcontrol_volatile *vd;
817 if (copy_from_user(&id, _id, sizeof(id)))
819 down_write(&card->controls_rwsem);
820 kctl = snd_ctl_find_id(card, &id);
824 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
825 if (vd->owner != NULL)
829 vd->owner_pid = current->pid;
833 up_write(&card->controls_rwsem);
837 static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
838 struct snd_ctl_elem_id __user *_id)
840 struct snd_card *card = file->card;
841 struct snd_ctl_elem_id id;
842 struct snd_kcontrol *kctl;
843 struct snd_kcontrol_volatile *vd;
846 if (copy_from_user(&id, _id, sizeof(id)))
848 down_write(&card->controls_rwsem);
849 kctl = snd_ctl_find_id(card, &id);
853 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
854 if (vd->owner == NULL)
856 else if (vd->owner != file)
864 up_write(&card->controls_rwsem);
868 struct user_element {
869 struct snd_ctl_elem_info info;
870 void *elem_data; /* element data */
871 unsigned long elem_data_size; /* size of element data in bytes */
872 void *tlv_data; /* TLV data */
873 unsigned long tlv_data_size; /* TLV data size */
874 void *priv_data; /* private data (like strings for enumerated type) */
875 unsigned long priv_data_size; /* size of private data in bytes */
878 static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
879 struct snd_ctl_elem_info *uinfo)
881 struct user_element *ue = kcontrol->private_data;
887 static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
888 struct snd_ctl_elem_value *ucontrol)
890 struct user_element *ue = kcontrol->private_data;
892 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
896 static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
897 struct snd_ctl_elem_value *ucontrol)
900 struct user_element *ue = kcontrol->private_data;
902 change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
904 memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
908 static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
911 unsigned int __user *tlv)
913 struct user_element *ue = kcontrol->private_data;
918 if (size > 1024 * 128) /* sane value */
920 new_data = kmalloc(size, GFP_KERNEL);
921 if (new_data == NULL)
923 if (copy_from_user(new_data, tlv, size)) {
927 change = ue->tlv_data_size != size;
929 change = memcmp(ue->tlv_data, new_data, size);
931 ue->tlv_data = new_data;
932 ue->tlv_data_size = size;
934 if (! ue->tlv_data_size || ! ue->tlv_data)
936 if (size < ue->tlv_data_size)
938 if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
944 static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
946 struct user_element *ue = kcontrol->private_data;
952 static int snd_ctl_elem_add(struct snd_ctl_file *file,
953 struct snd_ctl_elem_info *info, int replace)
955 struct snd_card *card = file->card;
956 struct snd_kcontrol kctl, *_kctl;
959 struct user_element *ue;
962 if (card->user_ctl_count >= MAX_USER_CONTROLS)
964 if (info->count > 1024)
966 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
967 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
968 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
969 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
971 memset(&kctl, 0, sizeof(kctl));
972 down_write(&card->controls_rwsem);
973 _kctl = snd_ctl_find_id(card, &info->id);
977 err = snd_ctl_remove(card, _kctl);
984 up_write(&card->controls_rwsem);
987 memcpy(&kctl.id, &info->id, sizeof(info->id));
988 kctl.count = info->owner ? info->owner : 1;
989 access |= SNDRV_CTL_ELEM_ACCESS_USER;
990 kctl.info = snd_ctl_elem_user_info;
991 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
992 kctl.get = snd_ctl_elem_user_get;
993 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
994 kctl.put = snd_ctl_elem_user_put;
995 if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
996 kctl.tlv.c = snd_ctl_elem_user_tlv;
997 access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
999 switch (info->type) {
1000 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
1001 case SNDRV_CTL_ELEM_TYPE_INTEGER:
1002 private_size = sizeof(long);
1003 if (info->count > 128)
1006 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1007 private_size = sizeof(long long);
1008 if (info->count > 64)
1011 case SNDRV_CTL_ELEM_TYPE_BYTES:
1012 private_size = sizeof(unsigned char);
1013 if (info->count > 512)
1016 case SNDRV_CTL_ELEM_TYPE_IEC958:
1017 private_size = sizeof(struct snd_aes_iec958);
1018 if (info->count != 1)
1024 private_size *= info->count;
1025 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
1029 ue->info.access = 0;
1030 ue->elem_data = (char *)ue + sizeof(*ue);
1031 ue->elem_data_size = private_size;
1032 kctl.private_free = snd_ctl_elem_user_free;
1033 _kctl = snd_ctl_new(&kctl, access);
1034 if (_kctl == NULL) {
1038 _kctl->private_data = ue;
1039 for (idx = 0; idx < _kctl->count; idx++)
1040 _kctl->vd[idx].owner = file;
1041 err = snd_ctl_add(card, _kctl);
1045 down_write(&card->controls_rwsem);
1046 card->user_ctl_count++;
1047 up_write(&card->controls_rwsem);
1052 static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1053 struct snd_ctl_elem_info __user *_info, int replace)
1055 struct snd_ctl_elem_info info;
1056 if (copy_from_user(&info, _info, sizeof(info)))
1058 return snd_ctl_elem_add(file, &info, replace);
1061 static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1062 struct snd_ctl_elem_id __user *_id)
1064 struct snd_ctl_elem_id id;
1067 if (copy_from_user(&id, _id, sizeof(id)))
1069 err = snd_ctl_remove_unlocked_id(file, &id);
1071 struct snd_card *card = file->card;
1072 down_write(&card->controls_rwsem);
1073 card->user_ctl_count--;
1074 up_write(&card->controls_rwsem);
1079 static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
1082 if (get_user(subscribe, ptr))
1084 if (subscribe < 0) {
1085 subscribe = file->subscribed;
1086 if (put_user(subscribe, ptr))
1091 file->subscribed = 1;
1093 } else if (file->subscribed) {
1094 snd_ctl_empty_read_queue(file);
1095 file->subscribed = 0;
1100 static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1101 struct snd_ctl_tlv __user *_tlv,
1104 struct snd_card *card = file->card;
1105 struct snd_ctl_tlv tlv;
1106 struct snd_kcontrol *kctl;
1107 struct snd_kcontrol_volatile *vd;
1111 if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1113 if (tlv.length < sizeof(unsigned int) * 3)
1115 down_read(&card->controls_rwsem);
1116 kctl = snd_ctl_find_numid(card, tlv.numid);
1121 if (kctl->tlv.p == NULL) {
1125 vd = &kctl->vd[tlv.numid - kctl->id.numid];
1126 if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1127 (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1128 (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1132 if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
1133 if (file && vd->owner != NULL && vd->owner != file) {
1137 err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
1139 up_read(&card->controls_rwsem);
1140 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &kctl->id);
1148 len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1149 if (tlv.length < len) {
1153 if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1157 up_read(&card->controls_rwsem);
1161 static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1163 struct snd_ctl_file *ctl;
1164 struct snd_card *card;
1165 struct snd_kctl_ioctl *p;
1166 void __user *argp = (void __user *)arg;
1167 int __user *ip = argp;
1170 ctl = file->private_data;
1172 if (snd_BUG_ON(!card))
1175 case SNDRV_CTL_IOCTL_PVERSION:
1176 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1177 case SNDRV_CTL_IOCTL_CARD_INFO:
1178 return snd_ctl_card_info(card, ctl, cmd, argp);
1179 case SNDRV_CTL_IOCTL_ELEM_LIST:
1180 return snd_ctl_elem_list(card, argp);
1181 case SNDRV_CTL_IOCTL_ELEM_INFO:
1182 return snd_ctl_elem_info_user(ctl, argp);
1183 case SNDRV_CTL_IOCTL_ELEM_READ:
1184 return snd_ctl_elem_read_user(card, argp);
1185 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1186 return snd_ctl_elem_write_user(ctl, argp);
1187 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1188 return snd_ctl_elem_lock(ctl, argp);
1189 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1190 return snd_ctl_elem_unlock(ctl, argp);
1191 case SNDRV_CTL_IOCTL_ELEM_ADD:
1192 return snd_ctl_elem_add_user(ctl, argp, 0);
1193 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1194 return snd_ctl_elem_add_user(ctl, argp, 1);
1195 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1196 return snd_ctl_elem_remove(ctl, argp);
1197 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1198 return snd_ctl_subscribe_events(ctl, ip);
1199 case SNDRV_CTL_IOCTL_TLV_READ:
1200 return snd_ctl_tlv_ioctl(ctl, argp, 0);
1201 case SNDRV_CTL_IOCTL_TLV_WRITE:
1202 return snd_ctl_tlv_ioctl(ctl, argp, 1);
1203 case SNDRV_CTL_IOCTL_TLV_COMMAND:
1204 return snd_ctl_tlv_ioctl(ctl, argp, -1);
1205 case SNDRV_CTL_IOCTL_POWER:
1206 return -ENOPROTOOPT;
1207 case SNDRV_CTL_IOCTL_POWER_STATE:
1209 return put_user(card->power_state, ip) ? -EFAULT : 0;
1211 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1214 down_read(&snd_ioctl_rwsem);
1215 list_for_each_entry(p, &snd_control_ioctls, list) {
1216 err = p->fioctl(card, ctl, cmd, arg);
1217 if (err != -ENOIOCTLCMD) {
1218 up_read(&snd_ioctl_rwsem);
1222 up_read(&snd_ioctl_rwsem);
1223 snd_printdd("unknown ioctl = 0x%x\n", cmd);
1227 static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1228 size_t count, loff_t * offset)
1230 struct snd_ctl_file *ctl;
1234 ctl = file->private_data;
1235 if (snd_BUG_ON(!ctl || !ctl->card))
1237 if (!ctl->subscribed)
1239 if (count < sizeof(struct snd_ctl_event))
1241 spin_lock_irq(&ctl->read_lock);
1242 while (count >= sizeof(struct snd_ctl_event)) {
1243 struct snd_ctl_event ev;
1244 struct snd_kctl_event *kev;
1245 while (list_empty(&ctl->events)) {
1247 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1251 init_waitqueue_entry(&wait, current);
1252 add_wait_queue(&ctl->change_sleep, &wait);
1253 set_current_state(TASK_INTERRUPTIBLE);
1254 spin_unlock_irq(&ctl->read_lock);
1256 remove_wait_queue(&ctl->change_sleep, &wait);
1257 if (signal_pending(current))
1258 return -ERESTARTSYS;
1259 spin_lock_irq(&ctl->read_lock);
1261 kev = snd_kctl_event(ctl->events.next);
1262 ev.type = SNDRV_CTL_EVENT_ELEM;
1263 ev.data.elem.mask = kev->mask;
1264 ev.data.elem.id = kev->id;
1265 list_del(&kev->list);
1266 spin_unlock_irq(&ctl->read_lock);
1268 if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
1272 spin_lock_irq(&ctl->read_lock);
1273 buffer += sizeof(struct snd_ctl_event);
1274 count -= sizeof(struct snd_ctl_event);
1275 result += sizeof(struct snd_ctl_event);
1278 spin_unlock_irq(&ctl->read_lock);
1280 return result > 0 ? result : err;
1283 static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1286 struct snd_ctl_file *ctl;
1288 ctl = file->private_data;
1289 if (!ctl->subscribed)
1291 poll_wait(file, &ctl->change_sleep, wait);
1294 if (!list_empty(&ctl->events))
1295 mask |= POLLIN | POLLRDNORM;
1301 * register the device-specific control-ioctls.
1302 * called from each device manager like pcm.c, hwdep.c, etc.
1304 static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1306 struct snd_kctl_ioctl *pn;
1308 pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
1312 down_write(&snd_ioctl_rwsem);
1313 list_add_tail(&pn->list, lists);
1314 up_write(&snd_ioctl_rwsem);
1318 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1320 return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1323 EXPORT_SYMBOL(snd_ctl_register_ioctl);
1325 #ifdef CONFIG_COMPAT
1326 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1328 return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1331 EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
1335 * de-register the device-specific control-ioctls.
1337 static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1338 struct list_head *lists)
1340 struct snd_kctl_ioctl *p;
1342 if (snd_BUG_ON(!fcn))
1344 down_write(&snd_ioctl_rwsem);
1345 list_for_each_entry(p, lists, list) {
1346 if (p->fioctl == fcn) {
1348 up_write(&snd_ioctl_rwsem);
1353 up_write(&snd_ioctl_rwsem);
1358 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1360 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1363 EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1365 #ifdef CONFIG_COMPAT
1366 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1368 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1371 EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
1374 static int snd_ctl_fasync(int fd, struct file * file, int on)
1376 struct snd_ctl_file *ctl;
1378 ctl = file->private_data;
1379 err = fasync_helper(fd, file, on, &ctl->fasync);
1388 #ifdef CONFIG_COMPAT
1389 #include "control_compat.c"
1391 #define snd_ctl_ioctl_compat NULL
1398 static const struct file_operations snd_ctl_f_ops =
1400 .owner = THIS_MODULE,
1401 .read = snd_ctl_read,
1402 .open = snd_ctl_open,
1403 .release = snd_ctl_release,
1404 .poll = snd_ctl_poll,
1405 .unlocked_ioctl = snd_ctl_ioctl,
1406 .compat_ioctl = snd_ctl_ioctl_compat,
1407 .fasync = snd_ctl_fasync,
1411 * registration of the control device
1413 static int snd_ctl_dev_register(struct snd_device *device)
1415 struct snd_card *card = device->device_data;
1419 if (snd_BUG_ON(!card))
1421 cardnum = card->number;
1422 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1424 sprintf(name, "controlC%i", cardnum);
1425 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1426 &snd_ctl_f_ops, card, name)) < 0)
1432 * disconnection of the control device
1434 static int snd_ctl_dev_disconnect(struct snd_device *device)
1436 struct snd_card *card = device->device_data;
1437 struct snd_ctl_file *ctl;
1440 if (snd_BUG_ON(!card))
1442 cardnum = card->number;
1443 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1446 read_lock(&card->ctl_files_rwlock);
1447 list_for_each_entry(ctl, &card->ctl_files, list) {
1448 wake_up(&ctl->change_sleep);
1449 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1451 read_unlock(&card->ctl_files_rwlock);
1453 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1462 static int snd_ctl_dev_free(struct snd_device *device)
1464 struct snd_card *card = device->device_data;
1465 struct snd_kcontrol *control;
1467 down_write(&card->controls_rwsem);
1468 while (!list_empty(&card->controls)) {
1469 control = snd_kcontrol(card->controls.next);
1470 snd_ctl_remove(card, control);
1472 up_write(&card->controls_rwsem);
1477 * create control core:
1478 * called from init.c
1480 int snd_ctl_create(struct snd_card *card)
1482 static struct snd_device_ops ops = {
1483 .dev_free = snd_ctl_dev_free,
1484 .dev_register = snd_ctl_dev_register,
1485 .dev_disconnect = snd_ctl_dev_disconnect,
1488 if (snd_BUG_ON(!card))
1490 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
1494 * Frequently used control callbacks
1496 int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
1497 struct snd_ctl_elem_info *uinfo)
1499 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1501 uinfo->value.integer.min = 0;
1502 uinfo->value.integer.max = 1;
1506 EXPORT_SYMBOL(snd_ctl_boolean_mono_info);
1508 int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
1509 struct snd_ctl_elem_info *uinfo)
1511 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1513 uinfo->value.integer.min = 0;
1514 uinfo->value.integer.max = 1;
1518 EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);