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
34 #define MAX_CONTROL_COUNT 1028
36 struct snd_kctl_ioctl {
37 struct list_head list; /* list of all ioctls */
38 snd_kctl_ioctl_func_t fioctl;
41 static DECLARE_RWSEM(snd_ioctl_rwsem);
42 static LIST_HEAD(snd_control_ioctls);
44 static LIST_HEAD(snd_control_compat_ioctls);
47 static int snd_ctl_open(struct inode *inode, struct file *file)
50 struct snd_card *card;
51 struct snd_ctl_file *ctl;
54 err = nonseekable_open(inode, file);
58 card = snd_lookup_minor_data(iminor(inode), SNDRV_DEVICE_TYPE_CONTROL);
63 err = snd_card_file_add(card, file);
68 if (!try_module_get(card->module)) {
72 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
77 INIT_LIST_HEAD(&ctl->events);
78 init_waitqueue_head(&ctl->change_sleep);
79 spin_lock_init(&ctl->read_lock);
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);
91 module_put(card->module);
93 snd_card_file_remove(card, file);
98 static void snd_ctl_empty_read_queue(struct snd_ctl_file * ctl)
101 struct snd_kctl_event *cread;
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);
109 spin_unlock_irqrestore(&ctl->read_lock, flags);
112 static int snd_ctl_release(struct inode *inode, struct file *file)
115 struct snd_card *card;
116 struct snd_ctl_file *ctl;
117 struct snd_kcontrol *control;
120 ctl = file->private_data;
121 if (snd_BUG_ON(!ctl || !ctl->card))
123 file->private_data = NULL;
125 write_lock_irqsave(&card->ctl_files_rwlock, flags);
126 list_del(&ctl->list);
127 write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
128 down_write(&card->controls_rwsem);
129 list_for_each_entry(control, &card->controls, list)
130 for (idx = 0; idx < control->count; idx++)
131 if (control->vd[idx].owner == ctl)
132 control->vd[idx].owner = NULL;
133 up_write(&card->controls_rwsem);
134 snd_ctl_empty_read_queue(ctl);
137 module_put(card->module);
138 snd_card_file_remove(card, file);
142 void snd_ctl_notify(struct snd_card *card, unsigned int mask,
143 struct snd_ctl_elem_id *id)
146 struct snd_ctl_file *ctl;
147 struct snd_kctl_event *ev;
149 if (snd_BUG_ON(!card || !id))
151 read_lock(&card->ctl_files_rwlock);
152 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
153 card->mixer_oss_change_count++;
155 list_for_each_entry(ctl, &card->ctl_files, list) {
156 if (!ctl->subscribed)
158 spin_lock_irqsave(&ctl->read_lock, flags);
159 list_for_each_entry(ev, &ctl->events, list) {
160 if (ev->id.numid == id->numid) {
165 ev = kzalloc(sizeof(*ev), GFP_ATOMIC);
169 list_add_tail(&ev->list, &ctl->events);
171 snd_printk(KERN_ERR "No memory available to allocate event\n");
174 wake_up(&ctl->change_sleep);
175 spin_unlock_irqrestore(&ctl->read_lock, flags);
176 kill_fasync(&ctl->fasync, SIGIO, POLL_IN);
178 read_unlock(&card->ctl_files_rwlock);
181 EXPORT_SYMBOL(snd_ctl_notify);
184 * snd_ctl_new - create a control instance from the template
185 * @control: the control template
186 * @access: the default control access
188 * Allocates a new struct snd_kcontrol instance and copies the given template
189 * to the new instance. It does not copy volatile data (access).
191 * Returns the pointer of the new instance, or NULL on failure.
193 static struct snd_kcontrol *snd_ctl_new(struct snd_kcontrol *control,
196 struct snd_kcontrol *kctl;
199 if (snd_BUG_ON(!control || !control->count))
202 if (control->count > MAX_CONTROL_COUNT)
205 kctl = kzalloc(sizeof(*kctl) + sizeof(struct snd_kcontrol_volatile) * control->count, GFP_KERNEL);
207 snd_printk(KERN_ERR "Cannot allocate control instance\n");
211 for (idx = 0; idx < kctl->count; idx++)
212 kctl->vd[idx].access = access;
217 * snd_ctl_new1 - create a control instance from the template
218 * @ncontrol: the initialization record
219 * @private_data: the private data to set
221 * Allocates a new struct snd_kcontrol instance and initialize from the given
222 * template. When the access field of ncontrol is 0, it's assumed as
223 * READWRITE access. When the count field is 0, it's assumes as one.
225 * Returns the pointer of the newly generated instance, or NULL on failure.
227 struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new *ncontrol,
230 struct snd_kcontrol kctl;
233 if (snd_BUG_ON(!ncontrol || !ncontrol->info))
235 memset(&kctl, 0, sizeof(kctl));
236 kctl.id.iface = ncontrol->iface;
237 kctl.id.device = ncontrol->device;
238 kctl.id.subdevice = ncontrol->subdevice;
239 if (ncontrol->name) {
240 strlcpy(kctl.id.name, ncontrol->name, sizeof(kctl.id.name));
241 if (strcmp(ncontrol->name, kctl.id.name) != 0)
242 snd_printk(KERN_WARNING
243 "Control name '%s' truncated to '%s'\n",
244 ncontrol->name, kctl.id.name);
246 kctl.id.index = ncontrol->index;
247 kctl.count = ncontrol->count ? ncontrol->count : 1;
248 access = ncontrol->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
249 (ncontrol->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
250 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
251 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE|
252 SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND|
253 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK));
254 kctl.info = ncontrol->info;
255 kctl.get = ncontrol->get;
256 kctl.put = ncontrol->put;
257 kctl.tlv.p = ncontrol->tlv.p;
258 kctl.private_value = ncontrol->private_value;
259 kctl.private_data = private_data;
260 return snd_ctl_new(&kctl, access);
263 EXPORT_SYMBOL(snd_ctl_new1);
266 * snd_ctl_free_one - release the control instance
267 * @kcontrol: the control instance
269 * Releases the control instance created via snd_ctl_new()
271 * Don't call this after the control was added to the card.
273 void snd_ctl_free_one(struct snd_kcontrol *kcontrol)
276 if (kcontrol->private_free)
277 kcontrol->private_free(kcontrol);
282 EXPORT_SYMBOL(snd_ctl_free_one);
284 static bool snd_ctl_remove_numid_conflict(struct snd_card *card,
287 struct snd_kcontrol *kctl;
289 list_for_each_entry(kctl, &card->controls, list) {
290 if (kctl->id.numid < card->last_numid + 1 + count &&
291 kctl->id.numid + kctl->count > card->last_numid + 1) {
292 card->last_numid = kctl->id.numid + kctl->count - 1;
299 static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
301 unsigned int iter = 100000;
303 while (snd_ctl_remove_numid_conflict(card, count)) {
305 /* this situation is very unlikely */
306 snd_printk(KERN_ERR "unable to allocate new control numid\n");
314 * snd_ctl_add - add the control instance to the card
315 * @card: the card instance
316 * @kcontrol: the control instance to add
318 * Adds the control instance created via snd_ctl_new() or
319 * snd_ctl_new1() to the given card. Assigns also an unique
320 * numid used for fast search.
322 * Returns zero if successful, or a negative error code on failure.
324 * It frees automatically the control which cannot be added.
326 int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
328 struct snd_ctl_elem_id id;
334 if (snd_BUG_ON(!card || !kcontrol->info))
337 down_write(&card->controls_rwsem);
338 if (snd_ctl_find_id(card, &id)) {
339 up_write(&card->controls_rwsem);
340 snd_printd(KERN_ERR "control %i:%i:%i:%s:%i is already present\n",
349 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
350 up_write(&card->controls_rwsem);
354 list_add_tail(&kcontrol->list, &card->controls);
355 card->controls_count += kcontrol->count;
356 kcontrol->id.numid = card->last_numid + 1;
357 card->last_numid += kcontrol->count;
358 up_write(&card->controls_rwsem);
359 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
360 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
364 snd_ctl_free_one(kcontrol);
368 EXPORT_SYMBOL(snd_ctl_add);
371 * snd_ctl_replace - replace the control instance of the card
372 * @card: the card instance
373 * @kcontrol: the control instance to replace
374 * @add_on_replace: add the control if not already added
376 * Replaces the given control. If the given control does not exist
377 * and the add_on_replace flag is set, the control is added. If the
378 * control exists, it is destroyed first.
380 * Returns zero if successful, or a negative error code on failure.
382 * It frees automatically the control which cannot be added or replaced.
384 int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol,
387 struct snd_ctl_elem_id id;
389 struct snd_kcontrol *old;
394 if (snd_BUG_ON(!card || !kcontrol->info)) {
399 down_write(&card->controls_rwsem);
400 old = snd_ctl_find_id(card, &id);
404 up_write(&card->controls_rwsem);
408 ret = snd_ctl_remove(card, old);
410 up_write(&card->controls_rwsem);
414 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
415 up_write(&card->controls_rwsem);
419 list_add_tail(&kcontrol->list, &card->controls);
420 card->controls_count += kcontrol->count;
421 kcontrol->id.numid = card->last_numid + 1;
422 card->last_numid += kcontrol->count;
423 up_write(&card->controls_rwsem);
424 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
425 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
429 snd_ctl_free_one(kcontrol);
432 EXPORT_SYMBOL(snd_ctl_replace);
435 * snd_ctl_remove - remove the control from the card and release it
436 * @card: the card instance
437 * @kcontrol: the control instance to remove
439 * Removes the control from the card and then releases the instance.
440 * You don't need to call snd_ctl_free_one(). You must be in
441 * the write lock - down_write(&card->controls_rwsem).
443 * Returns 0 if successful, or a negative error code on failure.
445 int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
447 struct snd_ctl_elem_id id;
450 if (snd_BUG_ON(!card || !kcontrol))
452 list_del(&kcontrol->list);
453 card->controls_count -= kcontrol->count;
455 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
456 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
457 snd_ctl_free_one(kcontrol);
461 EXPORT_SYMBOL(snd_ctl_remove);
464 * snd_ctl_remove_id - remove the control of the given id and release it
465 * @card: the card instance
466 * @id: the control id to remove
468 * Finds the control instance with the given id, removes it from the
469 * card list and releases it.
471 * Returns 0 if successful, or a negative error code on failure.
473 int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
475 struct snd_kcontrol *kctl;
478 down_write(&card->controls_rwsem);
479 kctl = snd_ctl_find_id(card, id);
481 up_write(&card->controls_rwsem);
484 ret = snd_ctl_remove(card, kctl);
485 up_write(&card->controls_rwsem);
489 EXPORT_SYMBOL(snd_ctl_remove_id);
492 * snd_ctl_remove_user_ctl - remove and release the unlocked user control
493 * @file: active control handle
494 * @id: the control id to remove
496 * Finds the control instance with the given id, removes it from the
497 * card list and releases it.
499 * Returns 0 if successful, or a negative error code on failure.
501 static int snd_ctl_remove_user_ctl(struct snd_ctl_file * file,
502 struct snd_ctl_elem_id *id)
504 struct snd_card *card = file->card;
505 struct snd_kcontrol *kctl;
508 down_write(&card->controls_rwsem);
509 kctl = snd_ctl_find_id(card, id);
514 if (!(kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_USER)) {
518 for (idx = 0; idx < kctl->count; idx++)
519 if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
523 ret = snd_ctl_remove(card, kctl);
526 card->user_ctl_count--;
528 up_write(&card->controls_rwsem);
533 * snd_ctl_activate_id - activate/inactivate the control of the given id
534 * @card: the card instance
535 * @id: the control id to activate/inactivate
536 * @active: non-zero to activate
538 * Finds the control instance with the given id, and activate or
539 * inactivate the control together with notification, if changed.
541 * Returns 0 if unchanged, 1 if changed, or a negative error code on failure.
543 int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
546 struct snd_kcontrol *kctl;
547 struct snd_kcontrol_volatile *vd;
548 unsigned int index_offset;
551 down_write(&card->controls_rwsem);
552 kctl = snd_ctl_find_id(card, id);
557 index_offset = snd_ctl_get_ioff(kctl, &kctl->id);
558 vd = &kctl->vd[index_offset];
561 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE))
563 vd->access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
565 if (vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE)
567 vd->access |= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
571 up_write(&card->controls_rwsem);
573 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_INFO, id);
576 EXPORT_SYMBOL_GPL(snd_ctl_activate_id);
579 * snd_ctl_rename_id - replace the id of a control on the card
580 * @card: the card instance
581 * @src_id: the old id
582 * @dst_id: the new id
584 * Finds the control with the old id from the card, and replaces the
585 * id with the new one.
587 * Returns zero if successful, or a negative error code on failure.
589 int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
590 struct snd_ctl_elem_id *dst_id)
592 struct snd_kcontrol *kctl;
594 down_write(&card->controls_rwsem);
595 kctl = snd_ctl_find_id(card, src_id);
597 up_write(&card->controls_rwsem);
601 kctl->id.numid = card->last_numid + 1;
602 card->last_numid += kctl->count;
603 up_write(&card->controls_rwsem);
607 EXPORT_SYMBOL(snd_ctl_rename_id);
610 * snd_ctl_find_numid - find the control instance with the given number-id
611 * @card: the card instance
612 * @numid: the number-id to search
614 * Finds the control instance with the given number-id from the card.
616 * Returns the pointer of the instance if found, or NULL if not.
618 * The caller must down card->controls_rwsem before calling this function
619 * (if the race condition can happen).
621 struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
623 struct snd_kcontrol *kctl;
625 if (snd_BUG_ON(!card || !numid))
627 list_for_each_entry(kctl, &card->controls, list) {
628 if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
634 EXPORT_SYMBOL(snd_ctl_find_numid);
637 * snd_ctl_find_id - find the control instance with the given id
638 * @card: the card instance
639 * @id: the id to search
641 * Finds the control instance with the given id from the card.
643 * Returns the pointer of the instance if found, or NULL if not.
645 * The caller must down card->controls_rwsem before calling this function
646 * (if the race condition can happen).
648 struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
649 struct snd_ctl_elem_id *id)
651 struct snd_kcontrol *kctl;
653 if (snd_BUG_ON(!card || !id))
656 return snd_ctl_find_numid(card, id->numid);
657 list_for_each_entry(kctl, &card->controls, list) {
658 if (kctl->id.iface != id->iface)
660 if (kctl->id.device != id->device)
662 if (kctl->id.subdevice != id->subdevice)
664 if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
666 if (kctl->id.index > id->index)
668 if (kctl->id.index + kctl->count <= id->index)
675 EXPORT_SYMBOL(snd_ctl_find_id);
677 static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
678 unsigned int cmd, void __user *arg)
680 struct snd_ctl_card_info *info;
682 info = kzalloc(sizeof(*info), GFP_KERNEL);
685 down_read(&snd_ioctl_rwsem);
686 info->card = card->number;
687 strlcpy(info->id, card->id, sizeof(info->id));
688 strlcpy(info->driver, card->driver, sizeof(info->driver));
689 strlcpy(info->name, card->shortname, sizeof(info->name));
690 strlcpy(info->longname, card->longname, sizeof(info->longname));
691 strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
692 strlcpy(info->components, card->components, sizeof(info->components));
693 up_read(&snd_ioctl_rwsem);
694 if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
702 static int snd_ctl_elem_list(struct snd_card *card,
703 struct snd_ctl_elem_list __user *_list)
705 struct list_head *plist;
706 struct snd_ctl_elem_list list;
707 struct snd_kcontrol *kctl;
708 struct snd_ctl_elem_id *dst, *id;
709 unsigned int offset, space, jidx;
711 if (copy_from_user(&list, _list, sizeof(list)))
713 offset = list.offset;
715 /* try limit maximum space */
719 /* allocate temporary buffer for atomic operation */
720 dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
723 down_read(&card->controls_rwsem);
724 list.count = card->controls_count;
725 plist = card->controls.next;
726 while (plist != &card->controls) {
729 kctl = snd_kcontrol(plist);
730 if (offset < kctl->count)
732 offset -= kctl->count;
737 while (space > 0 && plist != &card->controls) {
738 kctl = snd_kcontrol(plist);
739 for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
740 snd_ctl_build_ioff(id, kctl, jidx);
748 up_read(&card->controls_rwsem);
750 copy_to_user(list.pids, dst,
751 list.used * sizeof(struct snd_ctl_elem_id))) {
757 down_read(&card->controls_rwsem);
758 list.count = card->controls_count;
759 up_read(&card->controls_rwsem);
761 if (copy_to_user(_list, &list, sizeof(list)))
766 static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
767 struct snd_ctl_elem_info *info)
769 struct snd_card *card = ctl->card;
770 struct snd_kcontrol *kctl;
771 struct snd_kcontrol_volatile *vd;
772 unsigned int index_offset;
775 down_read(&card->controls_rwsem);
776 kctl = snd_ctl_find_id(card, &info->id);
778 up_read(&card->controls_rwsem);
781 #ifdef CONFIG_SND_DEBUG
784 result = kctl->info(kctl, info);
786 snd_BUG_ON(info->access);
787 index_offset = snd_ctl_get_ioff(kctl, &info->id);
788 vd = &kctl->vd[index_offset];
789 snd_ctl_build_ioff(&info->id, kctl, index_offset);
790 info->access = vd->access;
792 info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
793 if (vd->owner == ctl)
794 info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
795 info->owner = pid_vnr(vd->owner->pid);
800 up_read(&card->controls_rwsem);
804 static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
805 struct snd_ctl_elem_info __user *_info)
807 struct snd_ctl_elem_info info;
810 if (copy_from_user(&info, _info, sizeof(info)))
812 snd_power_lock(ctl->card);
813 result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
815 result = snd_ctl_elem_info(ctl, &info);
816 snd_power_unlock(ctl->card);
818 if (copy_to_user(_info, &info, sizeof(info)))
823 static int snd_ctl_elem_read(struct snd_card *card,
824 struct snd_ctl_elem_value *control)
826 struct snd_kcontrol *kctl;
827 struct snd_kcontrol_volatile *vd;
828 unsigned int index_offset;
831 down_read(&card->controls_rwsem);
832 kctl = snd_ctl_find_id(card, &control->id);
836 index_offset = snd_ctl_get_ioff(kctl, &control->id);
837 vd = &kctl->vd[index_offset];
838 if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) &&
840 snd_ctl_build_ioff(&control->id, kctl, index_offset);
841 result = kctl->get(kctl, control);
845 up_read(&card->controls_rwsem);
849 static int snd_ctl_elem_read_user(struct snd_card *card,
850 struct snd_ctl_elem_value __user *_control)
852 struct snd_ctl_elem_value *control;
855 control = memdup_user(_control, sizeof(*control));
857 return PTR_ERR(control);
859 snd_power_lock(card);
860 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
862 result = snd_ctl_elem_read(card, control);
863 snd_power_unlock(card);
865 if (copy_to_user(_control, control, sizeof(*control)))
871 static int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
872 struct snd_ctl_elem_value *control)
874 struct snd_kcontrol *kctl;
875 struct snd_kcontrol_volatile *vd;
876 unsigned int index_offset;
879 down_read(&card->controls_rwsem);
880 kctl = snd_ctl_find_id(card, &control->id);
884 index_offset = snd_ctl_get_ioff(kctl, &control->id);
885 vd = &kctl->vd[index_offset];
886 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
888 (file && vd->owner && vd->owner != file)) {
891 snd_ctl_build_ioff(&control->id, kctl, index_offset);
892 result = kctl->put(kctl, control);
895 up_read(&card->controls_rwsem);
896 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
901 up_read(&card->controls_rwsem);
905 static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
906 struct snd_ctl_elem_value __user *_control)
908 struct snd_ctl_elem_value *control;
909 struct snd_card *card;
912 control = memdup_user(_control, sizeof(*control));
914 return PTR_ERR(control);
917 snd_power_lock(card);
918 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
920 result = snd_ctl_elem_write(card, file, control);
921 snd_power_unlock(card);
923 if (copy_to_user(_control, control, sizeof(*control)))
929 static int snd_ctl_elem_lock(struct snd_ctl_file *file,
930 struct snd_ctl_elem_id __user *_id)
932 struct snd_card *card = file->card;
933 struct snd_ctl_elem_id id;
934 struct snd_kcontrol *kctl;
935 struct snd_kcontrol_volatile *vd;
938 if (copy_from_user(&id, _id, sizeof(id)))
940 down_write(&card->controls_rwsem);
941 kctl = snd_ctl_find_id(card, &id);
945 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
946 if (vd->owner != NULL)
953 up_write(&card->controls_rwsem);
957 static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
958 struct snd_ctl_elem_id __user *_id)
960 struct snd_card *card = file->card;
961 struct snd_ctl_elem_id id;
962 struct snd_kcontrol *kctl;
963 struct snd_kcontrol_volatile *vd;
966 if (copy_from_user(&id, _id, sizeof(id)))
968 down_write(&card->controls_rwsem);
969 kctl = snd_ctl_find_id(card, &id);
973 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
974 if (vd->owner == NULL)
976 else if (vd->owner != file)
983 up_write(&card->controls_rwsem);
987 struct user_element {
988 struct snd_ctl_elem_info info;
989 void *elem_data; /* element data */
990 unsigned long elem_data_size; /* size of element data in bytes */
991 void *tlv_data; /* TLV data */
992 unsigned long tlv_data_size; /* TLV data size */
993 void *priv_data; /* private data (like strings for enumerated type) */
994 unsigned long priv_data_size; /* size of private data in bytes */
997 static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
998 struct snd_ctl_elem_info *uinfo)
1000 struct user_element *ue = kcontrol->private_data;
1006 static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
1007 struct snd_ctl_elem_value *ucontrol)
1009 struct user_element *ue = kcontrol->private_data;
1011 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
1015 static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
1016 struct snd_ctl_elem_value *ucontrol)
1019 struct user_element *ue = kcontrol->private_data;
1021 change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
1023 memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
1027 static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
1030 unsigned int __user *tlv)
1032 struct user_element *ue = kcontrol->private_data;
1037 if (size > 1024 * 128) /* sane value */
1040 new_data = memdup_user(tlv, size);
1041 if (IS_ERR(new_data))
1042 return PTR_ERR(new_data);
1043 change = ue->tlv_data_size != size;
1045 change = memcmp(ue->tlv_data, new_data, size);
1046 kfree(ue->tlv_data);
1047 ue->tlv_data = new_data;
1048 ue->tlv_data_size = size;
1050 if (! ue->tlv_data_size || ! ue->tlv_data)
1052 if (size < ue->tlv_data_size)
1054 if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
1060 static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
1062 struct user_element *ue = kcontrol->private_data;
1064 kfree(ue->tlv_data);
1068 static int snd_ctl_elem_add(struct snd_ctl_file *file,
1069 struct snd_ctl_elem_info *info, int replace)
1071 struct snd_card *card = file->card;
1072 struct snd_kcontrol kctl, *_kctl;
1073 unsigned int access;
1075 struct user_element *ue;
1078 if (card->user_ctl_count >= MAX_USER_CONTROLS)
1080 if (info->count < 1)
1082 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
1083 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
1084 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
1085 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
1087 memset(&kctl, 0, sizeof(kctl));
1088 down_write(&card->controls_rwsem);
1089 _kctl = snd_ctl_find_id(card, &info->id);
1093 err = snd_ctl_remove(card, _kctl);
1100 up_write(&card->controls_rwsem);
1103 memcpy(&kctl.id, &info->id, sizeof(info->id));
1104 kctl.count = info->owner ? info->owner : 1;
1105 access |= SNDRV_CTL_ELEM_ACCESS_USER;
1106 kctl.info = snd_ctl_elem_user_info;
1107 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
1108 kctl.get = snd_ctl_elem_user_get;
1109 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
1110 kctl.put = snd_ctl_elem_user_put;
1111 if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
1112 kctl.tlv.c = snd_ctl_elem_user_tlv;
1113 access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1115 switch (info->type) {
1116 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
1117 case SNDRV_CTL_ELEM_TYPE_INTEGER:
1118 private_size = sizeof(long);
1119 if (info->count > 128)
1122 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1123 private_size = sizeof(long long);
1124 if (info->count > 64)
1127 case SNDRV_CTL_ELEM_TYPE_BYTES:
1128 private_size = sizeof(unsigned char);
1129 if (info->count > 512)
1132 case SNDRV_CTL_ELEM_TYPE_IEC958:
1133 private_size = sizeof(struct snd_aes_iec958);
1134 if (info->count != 1)
1140 private_size *= info->count;
1141 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
1145 ue->info.access = 0;
1146 ue->elem_data = (char *)ue + sizeof(*ue);
1147 ue->elem_data_size = private_size;
1148 kctl.private_free = snd_ctl_elem_user_free;
1149 _kctl = snd_ctl_new(&kctl, access);
1150 if (_kctl == NULL) {
1154 _kctl->private_data = ue;
1155 for (idx = 0; idx < _kctl->count; idx++)
1156 _kctl->vd[idx].owner = file;
1157 err = snd_ctl_add(card, _kctl);
1161 down_write(&card->controls_rwsem);
1162 card->user_ctl_count++;
1163 up_write(&card->controls_rwsem);
1168 static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1169 struct snd_ctl_elem_info __user *_info, int replace)
1171 struct snd_ctl_elem_info info;
1172 if (copy_from_user(&info, _info, sizeof(info)))
1174 return snd_ctl_elem_add(file, &info, replace);
1177 static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1178 struct snd_ctl_elem_id __user *_id)
1180 struct snd_ctl_elem_id id;
1182 if (copy_from_user(&id, _id, sizeof(id)))
1184 return snd_ctl_remove_user_ctl(file, &id);
1187 static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
1190 if (get_user(subscribe, ptr))
1192 if (subscribe < 0) {
1193 subscribe = file->subscribed;
1194 if (put_user(subscribe, ptr))
1199 file->subscribed = 1;
1201 } else if (file->subscribed) {
1202 snd_ctl_empty_read_queue(file);
1203 file->subscribed = 0;
1208 static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1209 struct snd_ctl_tlv __user *_tlv,
1212 struct snd_card *card = file->card;
1213 struct snd_ctl_tlv tlv;
1214 struct snd_kcontrol *kctl;
1215 struct snd_kcontrol_volatile *vd;
1219 if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1221 if (tlv.length < sizeof(unsigned int) * 2)
1223 down_read(&card->controls_rwsem);
1224 kctl = snd_ctl_find_numid(card, tlv.numid);
1229 if (kctl->tlv.p == NULL) {
1233 vd = &kctl->vd[tlv.numid - kctl->id.numid];
1234 if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1235 (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1236 (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1240 if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
1241 if (vd->owner != NULL && vd->owner != file) {
1245 err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
1247 up_read(&card->controls_rwsem);
1248 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &kctl->id);
1256 len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1257 if (tlv.length < len) {
1261 if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1265 up_read(&card->controls_rwsem);
1269 static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1271 struct snd_ctl_file *ctl;
1272 struct snd_card *card;
1273 struct snd_kctl_ioctl *p;
1274 void __user *argp = (void __user *)arg;
1275 int __user *ip = argp;
1278 ctl = file->private_data;
1280 if (snd_BUG_ON(!card))
1283 case SNDRV_CTL_IOCTL_PVERSION:
1284 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1285 case SNDRV_CTL_IOCTL_CARD_INFO:
1286 return snd_ctl_card_info(card, ctl, cmd, argp);
1287 case SNDRV_CTL_IOCTL_ELEM_LIST:
1288 return snd_ctl_elem_list(card, argp);
1289 case SNDRV_CTL_IOCTL_ELEM_INFO:
1290 return snd_ctl_elem_info_user(ctl, argp);
1291 case SNDRV_CTL_IOCTL_ELEM_READ:
1292 return snd_ctl_elem_read_user(card, argp);
1293 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1294 return snd_ctl_elem_write_user(ctl, argp);
1295 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1296 return snd_ctl_elem_lock(ctl, argp);
1297 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1298 return snd_ctl_elem_unlock(ctl, argp);
1299 case SNDRV_CTL_IOCTL_ELEM_ADD:
1300 return snd_ctl_elem_add_user(ctl, argp, 0);
1301 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1302 return snd_ctl_elem_add_user(ctl, argp, 1);
1303 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1304 return snd_ctl_elem_remove(ctl, argp);
1305 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1306 return snd_ctl_subscribe_events(ctl, ip);
1307 case SNDRV_CTL_IOCTL_TLV_READ:
1308 return snd_ctl_tlv_ioctl(ctl, argp, 0);
1309 case SNDRV_CTL_IOCTL_TLV_WRITE:
1310 return snd_ctl_tlv_ioctl(ctl, argp, 1);
1311 case SNDRV_CTL_IOCTL_TLV_COMMAND:
1312 return snd_ctl_tlv_ioctl(ctl, argp, -1);
1313 case SNDRV_CTL_IOCTL_POWER:
1314 return -ENOPROTOOPT;
1315 case SNDRV_CTL_IOCTL_POWER_STATE:
1317 return put_user(card->power_state, ip) ? -EFAULT : 0;
1319 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1322 down_read(&snd_ioctl_rwsem);
1323 list_for_each_entry(p, &snd_control_ioctls, list) {
1324 err = p->fioctl(card, ctl, cmd, arg);
1325 if (err != -ENOIOCTLCMD) {
1326 up_read(&snd_ioctl_rwsem);
1330 up_read(&snd_ioctl_rwsem);
1331 snd_printdd("unknown ioctl = 0x%x\n", cmd);
1335 static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1336 size_t count, loff_t * offset)
1338 struct snd_ctl_file *ctl;
1342 ctl = file->private_data;
1343 if (snd_BUG_ON(!ctl || !ctl->card))
1345 if (!ctl->subscribed)
1347 if (count < sizeof(struct snd_ctl_event))
1349 spin_lock_irq(&ctl->read_lock);
1350 while (count >= sizeof(struct snd_ctl_event)) {
1351 struct snd_ctl_event ev;
1352 struct snd_kctl_event *kev;
1353 while (list_empty(&ctl->events)) {
1355 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1359 init_waitqueue_entry(&wait, current);
1360 add_wait_queue(&ctl->change_sleep, &wait);
1361 set_current_state(TASK_INTERRUPTIBLE);
1362 spin_unlock_irq(&ctl->read_lock);
1364 remove_wait_queue(&ctl->change_sleep, &wait);
1365 if (signal_pending(current))
1366 return -ERESTARTSYS;
1367 spin_lock_irq(&ctl->read_lock);
1369 kev = snd_kctl_event(ctl->events.next);
1370 ev.type = SNDRV_CTL_EVENT_ELEM;
1371 ev.data.elem.mask = kev->mask;
1372 ev.data.elem.id = kev->id;
1373 list_del(&kev->list);
1374 spin_unlock_irq(&ctl->read_lock);
1376 if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
1380 spin_lock_irq(&ctl->read_lock);
1381 buffer += sizeof(struct snd_ctl_event);
1382 count -= sizeof(struct snd_ctl_event);
1383 result += sizeof(struct snd_ctl_event);
1386 spin_unlock_irq(&ctl->read_lock);
1388 return result > 0 ? result : err;
1391 static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1394 struct snd_ctl_file *ctl;
1396 ctl = file->private_data;
1397 if (!ctl->subscribed)
1399 poll_wait(file, &ctl->change_sleep, wait);
1402 if (!list_empty(&ctl->events))
1403 mask |= POLLIN | POLLRDNORM;
1409 * register the device-specific control-ioctls.
1410 * called from each device manager like pcm.c, hwdep.c, etc.
1412 static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1414 struct snd_kctl_ioctl *pn;
1416 pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
1420 down_write(&snd_ioctl_rwsem);
1421 list_add_tail(&pn->list, lists);
1422 up_write(&snd_ioctl_rwsem);
1426 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1428 return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1431 EXPORT_SYMBOL(snd_ctl_register_ioctl);
1433 #ifdef CONFIG_COMPAT
1434 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1436 return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1439 EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
1443 * de-register the device-specific control-ioctls.
1445 static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1446 struct list_head *lists)
1448 struct snd_kctl_ioctl *p;
1450 if (snd_BUG_ON(!fcn))
1452 down_write(&snd_ioctl_rwsem);
1453 list_for_each_entry(p, lists, list) {
1454 if (p->fioctl == fcn) {
1456 up_write(&snd_ioctl_rwsem);
1461 up_write(&snd_ioctl_rwsem);
1466 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1468 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1471 EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1473 #ifdef CONFIG_COMPAT
1474 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1476 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1479 EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
1482 static int snd_ctl_fasync(int fd, struct file * file, int on)
1484 struct snd_ctl_file *ctl;
1486 ctl = file->private_data;
1487 return fasync_helper(fd, file, on, &ctl->fasync);
1493 #ifdef CONFIG_COMPAT
1494 #include "control_compat.c"
1496 #define snd_ctl_ioctl_compat NULL
1503 static const struct file_operations snd_ctl_f_ops =
1505 .owner = THIS_MODULE,
1506 .read = snd_ctl_read,
1507 .open = snd_ctl_open,
1508 .release = snd_ctl_release,
1509 .llseek = no_llseek,
1510 .poll = snd_ctl_poll,
1511 .unlocked_ioctl = snd_ctl_ioctl,
1512 .compat_ioctl = snd_ctl_ioctl_compat,
1513 .fasync = snd_ctl_fasync,
1517 * registration of the control device
1519 static int snd_ctl_dev_register(struct snd_device *device)
1521 struct snd_card *card = device->device_data;
1525 if (snd_BUG_ON(!card))
1527 cardnum = card->number;
1528 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1530 sprintf(name, "controlC%i", cardnum);
1531 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1532 &snd_ctl_f_ops, card, name)) < 0)
1538 * disconnection of the control device
1540 static int snd_ctl_dev_disconnect(struct snd_device *device)
1542 struct snd_card *card = device->device_data;
1543 struct snd_ctl_file *ctl;
1546 if (snd_BUG_ON(!card))
1548 cardnum = card->number;
1549 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1552 read_lock(&card->ctl_files_rwlock);
1553 list_for_each_entry(ctl, &card->ctl_files, list) {
1554 wake_up(&ctl->change_sleep);
1555 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1557 read_unlock(&card->ctl_files_rwlock);
1559 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1568 static int snd_ctl_dev_free(struct snd_device *device)
1570 struct snd_card *card = device->device_data;
1571 struct snd_kcontrol *control;
1573 down_write(&card->controls_rwsem);
1574 while (!list_empty(&card->controls)) {
1575 control = snd_kcontrol(card->controls.next);
1576 snd_ctl_remove(card, control);
1578 up_write(&card->controls_rwsem);
1583 * create control core:
1584 * called from init.c
1586 int snd_ctl_create(struct snd_card *card)
1588 static struct snd_device_ops ops = {
1589 .dev_free = snd_ctl_dev_free,
1590 .dev_register = snd_ctl_dev_register,
1591 .dev_disconnect = snd_ctl_dev_disconnect,
1594 if (snd_BUG_ON(!card))
1596 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
1600 * Frequently used control callbacks/helpers
1602 int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
1603 struct snd_ctl_elem_info *uinfo)
1605 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1607 uinfo->value.integer.min = 0;
1608 uinfo->value.integer.max = 1;
1612 EXPORT_SYMBOL(snd_ctl_boolean_mono_info);
1614 int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
1615 struct snd_ctl_elem_info *uinfo)
1617 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1619 uinfo->value.integer.min = 0;
1620 uinfo->value.integer.max = 1;
1624 EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);
1627 * snd_ctl_enum_info - fills the info structure for an enumerated control
1628 * @info: the structure to be filled
1629 * @channels: the number of the control's channels; often one
1630 * @items: the number of control values; also the size of @names
1631 * @names: an array containing the names of all control values
1633 * Sets all required fields in @info to their appropriate values.
1634 * If the control's accessibility is not the default (readable and writable),
1635 * the caller has to fill @info->access.
1637 int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
1638 unsigned int items, const char *const names[])
1640 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1641 info->count = channels;
1642 info->value.enumerated.items = items;
1643 if (info->value.enumerated.item >= items)
1644 info->value.enumerated.item = items - 1;
1645 strlcpy(info->value.enumerated.name,
1646 names[info->value.enumerated.item],
1647 sizeof(info->value.enumerated.name));
1650 EXPORT_SYMBOL(snd_ctl_enum_info);