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 <sound/driver.h>
23 #include <linux/threads.h>
24 #include <linux/interrupt.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>
33 /* max number of user-defined controls */
34 #define MAX_USER_CONTROLS 32
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 card = snd_lookup_minor_data(iminor(inode), SNDRV_DEVICE_TYPE_CONTROL);
59 err = snd_card_file_add(card, file);
64 if (!try_module_get(card->module)) {
68 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
73 INIT_LIST_HEAD(&ctl->events);
74 init_waitqueue_head(&ctl->change_sleep);
75 spin_lock_init(&ctl->read_lock);
77 ctl->prefer_pcm_subdevice = -1;
78 ctl->prefer_rawmidi_subdevice = -1;
79 ctl->pid = current->pid;
80 file->private_data = ctl;
81 write_lock_irqsave(&card->ctl_files_rwlock, flags);
82 list_add_tail(&ctl->list, &card->ctl_files);
83 write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
87 module_put(card->module);
89 snd_card_file_remove(card, file);
94 static void snd_ctl_empty_read_queue(struct snd_ctl_file * ctl)
97 struct snd_kctl_event *cread;
99 spin_lock_irqsave(&ctl->read_lock, flags);
100 while (!list_empty(&ctl->events)) {
101 cread = snd_kctl_event(ctl->events.next);
102 list_del(&cread->list);
105 spin_unlock_irqrestore(&ctl->read_lock, flags);
108 static int snd_ctl_release(struct inode *inode, struct file *file)
111 struct snd_card *card;
112 struct snd_ctl_file *ctl;
113 struct snd_kcontrol *control;
116 ctl = file->private_data;
117 fasync_helper(-1, file, 0, &ctl->fasync);
118 file->private_data = NULL;
120 write_lock_irqsave(&card->ctl_files_rwlock, flags);
121 list_del(&ctl->list);
122 write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
123 down_write(&card->controls_rwsem);
124 list_for_each_entry(control, &card->controls, list)
125 for (idx = 0; idx < control->count; idx++)
126 if (control->vd[idx].owner == ctl)
127 control->vd[idx].owner = NULL;
128 up_write(&card->controls_rwsem);
129 snd_ctl_empty_read_queue(ctl);
131 module_put(card->module);
132 snd_card_file_remove(card, file);
136 void snd_ctl_notify(struct snd_card *card, unsigned int mask,
137 struct snd_ctl_elem_id *id)
140 struct snd_ctl_file *ctl;
141 struct snd_kctl_event *ev;
143 snd_assert(card != NULL && id != NULL, return);
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 snd_assert(control != NULL, return NULL);
193 snd_assert(control->count > 0, return NULL);
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 snd_assert(ncontrol != NULL, return NULL);
223 snd_assert(ncontrol->info != NULL, return NULL);
224 memset(&kctl, 0, sizeof(kctl));
225 kctl.id.iface = ncontrol->iface;
226 kctl.id.device = ncontrol->device;
227 kctl.id.subdevice = ncontrol->subdevice;
229 strlcpy(kctl.id.name, ncontrol->name, sizeof(kctl.id.name));
230 kctl.id.index = ncontrol->index;
231 kctl.count = ncontrol->count ? ncontrol->count : 1;
232 access = ncontrol->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
233 (ncontrol->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
234 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
235 SNDRV_CTL_ELEM_ACCESS_DINDIRECT|
236 SNDRV_CTL_ELEM_ACCESS_INDIRECT|
237 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE|
238 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK));
239 kctl.info = ncontrol->info;
240 kctl.get = ncontrol->get;
241 kctl.put = ncontrol->put;
242 kctl.tlv.p = ncontrol->tlv.p;
243 kctl.private_value = ncontrol->private_value;
244 kctl.private_data = private_data;
245 return snd_ctl_new(&kctl, access);
248 EXPORT_SYMBOL(snd_ctl_new1);
251 * snd_ctl_free_one - release the control instance
252 * @kcontrol: the control instance
254 * Releases the control instance created via snd_ctl_new()
256 * Don't call this after the control was added to the card.
258 void snd_ctl_free_one(struct snd_kcontrol *kcontrol)
261 if (kcontrol->private_free)
262 kcontrol->private_free(kcontrol);
267 EXPORT_SYMBOL(snd_ctl_free_one);
269 static unsigned int snd_ctl_hole_check(struct snd_card *card,
272 struct snd_kcontrol *kctl;
274 list_for_each_entry(kctl, &card->controls, list) {
275 if ((kctl->id.numid <= card->last_numid &&
276 kctl->id.numid + kctl->count > card->last_numid) ||
277 (kctl->id.numid <= card->last_numid + count - 1 &&
278 kctl->id.numid + kctl->count > card->last_numid + count - 1))
279 return card->last_numid = kctl->id.numid + kctl->count - 1;
281 return card->last_numid;
284 static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
286 unsigned int last_numid, iter = 100000;
288 last_numid = card->last_numid;
289 while (last_numid != snd_ctl_hole_check(card, count)) {
291 /* this situation is very unlikely */
292 snd_printk(KERN_ERR "unable to allocate new control numid\n");
295 last_numid = card->last_numid;
301 * snd_ctl_add - add the control instance to the card
302 * @card: the card instance
303 * @kcontrol: the control instance to add
305 * Adds the control instance created via snd_ctl_new() or
306 * snd_ctl_new1() to the given card. Assigns also an unique
307 * numid used for fast search.
309 * Returns zero if successful, or a negative error code on failure.
311 * It frees automatically the control which cannot be added.
313 int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
315 struct snd_ctl_elem_id id;
321 snd_assert(card != NULL, goto error);
322 snd_assert(kcontrol->info != NULL, goto error);
324 down_write(&card->controls_rwsem);
325 if (snd_ctl_find_id(card, &id)) {
326 up_write(&card->controls_rwsem);
327 snd_printd(KERN_ERR "control %i:%i:%i:%s:%i is already present\n",
336 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
337 up_write(&card->controls_rwsem);
341 list_add_tail(&kcontrol->list, &card->controls);
342 card->controls_count += kcontrol->count;
343 kcontrol->id.numid = card->last_numid + 1;
344 card->last_numid += kcontrol->count;
345 up_write(&card->controls_rwsem);
346 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
347 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
351 snd_ctl_free_one(kcontrol);
355 EXPORT_SYMBOL(snd_ctl_add);
358 * snd_ctl_remove - remove the control from the card and release it
359 * @card: the card instance
360 * @kcontrol: the control instance to remove
362 * Removes the control from the card and then releases the instance.
363 * You don't need to call snd_ctl_free_one(). You must be in
364 * the write lock - down_write(&card->controls_rwsem).
366 * Returns 0 if successful, or a negative error code on failure.
368 int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
370 struct snd_ctl_elem_id id;
373 snd_assert(card != NULL && kcontrol != NULL, return -EINVAL);
374 list_del(&kcontrol->list);
375 card->controls_count -= kcontrol->count;
377 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
378 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
379 snd_ctl_free_one(kcontrol);
383 EXPORT_SYMBOL(snd_ctl_remove);
386 * snd_ctl_remove_id - remove the control of the given id and release it
387 * @card: the card instance
388 * @id: the control id to remove
390 * Finds the control instance with the given id, removes it from the
391 * card list and releases it.
393 * Returns 0 if successful, or a negative error code on failure.
395 int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
397 struct snd_kcontrol *kctl;
400 down_write(&card->controls_rwsem);
401 kctl = snd_ctl_find_id(card, id);
403 up_write(&card->controls_rwsem);
406 ret = snd_ctl_remove(card, kctl);
407 up_write(&card->controls_rwsem);
411 EXPORT_SYMBOL(snd_ctl_remove_id);
414 * snd_ctl_remove_unlocked_id - remove the unlocked control of the given id and release it
415 * @file: active control handle
416 * @id: the control id to remove
418 * Finds the control instance with the given id, removes it from the
419 * card list and releases it.
421 * Returns 0 if successful, or a negative error code on failure.
423 static int snd_ctl_remove_unlocked_id(struct snd_ctl_file * file,
424 struct snd_ctl_elem_id *id)
426 struct snd_card *card = file->card;
427 struct snd_kcontrol *kctl;
430 down_write(&card->controls_rwsem);
431 kctl = snd_ctl_find_id(card, id);
433 up_write(&card->controls_rwsem);
436 for (idx = 0; idx < kctl->count; idx++)
437 if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
438 up_write(&card->controls_rwsem);
441 ret = snd_ctl_remove(card, kctl);
442 up_write(&card->controls_rwsem);
447 * snd_ctl_rename_id - replace the id of a control on the card
448 * @card: the card instance
449 * @src_id: the old id
450 * @dst_id: the new id
452 * Finds the control with the old id from the card, and replaces the
453 * id with the new one.
455 * Returns zero if successful, or a negative error code on failure.
457 int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
458 struct snd_ctl_elem_id *dst_id)
460 struct snd_kcontrol *kctl;
462 down_write(&card->controls_rwsem);
463 kctl = snd_ctl_find_id(card, src_id);
465 up_write(&card->controls_rwsem);
469 kctl->id.numid = card->last_numid + 1;
470 card->last_numid += kctl->count;
471 up_write(&card->controls_rwsem);
475 EXPORT_SYMBOL(snd_ctl_rename_id);
478 * snd_ctl_find_numid - find the control instance with the given number-id
479 * @card: the card instance
480 * @numid: the number-id to search
482 * Finds the control instance with the given number-id from the card.
484 * Returns the pointer of the instance if found, or NULL if not.
486 * The caller must down card->controls_rwsem before calling this function
487 * (if the race condition can happen).
489 struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
491 struct snd_kcontrol *kctl;
493 snd_assert(card != NULL && numid != 0, return NULL);
494 list_for_each_entry(kctl, &card->controls, list) {
495 if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
501 EXPORT_SYMBOL(snd_ctl_find_numid);
504 * snd_ctl_find_id - find the control instance with the given id
505 * @card: the card instance
506 * @id: the id to search
508 * Finds the control instance with the given id from the card.
510 * Returns the pointer of the instance if found, or NULL if not.
512 * The caller must down card->controls_rwsem before calling this function
513 * (if the race condition can happen).
515 struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
516 struct snd_ctl_elem_id *id)
518 struct snd_kcontrol *kctl;
520 snd_assert(card != NULL && id != NULL, return NULL);
522 return snd_ctl_find_numid(card, id->numid);
523 list_for_each_entry(kctl, &card->controls, list) {
524 if (kctl->id.iface != id->iface)
526 if (kctl->id.device != id->device)
528 if (kctl->id.subdevice != id->subdevice)
530 if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
532 if (kctl->id.index > id->index)
534 if (kctl->id.index + kctl->count <= id->index)
541 EXPORT_SYMBOL(snd_ctl_find_id);
543 static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
544 unsigned int cmd, void __user *arg)
546 struct snd_ctl_card_info *info;
548 info = kzalloc(sizeof(*info), GFP_KERNEL);
551 down_read(&snd_ioctl_rwsem);
552 info->card = card->number;
553 strlcpy(info->id, card->id, sizeof(info->id));
554 strlcpy(info->driver, card->driver, sizeof(info->driver));
555 strlcpy(info->name, card->shortname, sizeof(info->name));
556 strlcpy(info->longname, card->longname, sizeof(info->longname));
557 strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
558 strlcpy(info->components, card->components, sizeof(info->components));
559 up_read(&snd_ioctl_rwsem);
560 if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
568 static int snd_ctl_elem_list(struct snd_card *card,
569 struct snd_ctl_elem_list __user *_list)
571 struct list_head *plist;
572 struct snd_ctl_elem_list list;
573 struct snd_kcontrol *kctl;
574 struct snd_ctl_elem_id *dst, *id;
575 unsigned int offset, space, first, jidx;
577 if (copy_from_user(&list, _list, sizeof(list)))
579 offset = list.offset;
582 /* try limit maximum space */
586 /* allocate temporary buffer for atomic operation */
587 dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
590 down_read(&card->controls_rwsem);
591 list.count = card->controls_count;
592 plist = card->controls.next;
593 while (plist != &card->controls) {
596 kctl = snd_kcontrol(plist);
597 if (offset < kctl->count)
599 offset -= kctl->count;
604 while (space > 0 && plist != &card->controls) {
605 kctl = snd_kcontrol(plist);
606 for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
607 snd_ctl_build_ioff(id, kctl, jidx);
615 up_read(&card->controls_rwsem);
617 copy_to_user(list.pids, dst,
618 list.used * sizeof(struct snd_ctl_elem_id))) {
624 down_read(&card->controls_rwsem);
625 list.count = card->controls_count;
626 up_read(&card->controls_rwsem);
628 if (copy_to_user(_list, &list, sizeof(list)))
633 static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
634 struct snd_ctl_elem_info *info)
636 struct snd_card *card = ctl->card;
637 struct snd_kcontrol *kctl;
638 struct snd_kcontrol_volatile *vd;
639 unsigned int index_offset;
642 down_read(&card->controls_rwsem);
643 kctl = snd_ctl_find_id(card, &info->id);
645 up_read(&card->controls_rwsem);
648 #ifdef CONFIG_SND_DEBUG
651 result = kctl->info(kctl, info);
653 snd_assert(info->access == 0, );
654 index_offset = snd_ctl_get_ioff(kctl, &info->id);
655 vd = &kctl->vd[index_offset];
656 snd_ctl_build_ioff(&info->id, kctl, index_offset);
657 info->access = vd->access;
659 info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
660 if (vd->owner == ctl)
661 info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
662 info->owner = vd->owner_pid;
667 up_read(&card->controls_rwsem);
671 static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
672 struct snd_ctl_elem_info __user *_info)
674 struct snd_ctl_elem_info info;
677 if (copy_from_user(&info, _info, sizeof(info)))
679 snd_power_lock(ctl->card);
680 result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
682 result = snd_ctl_elem_info(ctl, &info);
683 snd_power_unlock(ctl->card);
685 if (copy_to_user(_info, &info, sizeof(info)))
690 int snd_ctl_elem_read(struct snd_card *card, struct snd_ctl_elem_value *control)
692 struct snd_kcontrol *kctl;
693 struct snd_kcontrol_volatile *vd;
694 unsigned int index_offset;
695 int result, indirect;
697 down_read(&card->controls_rwsem);
698 kctl = snd_ctl_find_id(card, &control->id);
702 index_offset = snd_ctl_get_ioff(kctl, &control->id);
703 vd = &kctl->vd[index_offset];
704 indirect = vd->access & SNDRV_CTL_ELEM_ACCESS_INDIRECT ? 1 : 0;
705 if (control->indirect != indirect) {
708 if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) && kctl->get != NULL) {
709 snd_ctl_build_ioff(&control->id, kctl, index_offset);
710 result = kctl->get(kctl, control);
716 up_read(&card->controls_rwsem);
720 static int snd_ctl_elem_read_user(struct snd_card *card,
721 struct snd_ctl_elem_value __user *_control)
723 struct snd_ctl_elem_value *control;
726 control = kmalloc(sizeof(*control), GFP_KERNEL);
729 if (copy_from_user(control, _control, sizeof(*control))) {
733 snd_power_lock(card);
734 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
736 result = snd_ctl_elem_read(card, control);
737 snd_power_unlock(card);
739 if (copy_to_user(_control, control, sizeof(*control)))
745 int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
746 struct snd_ctl_elem_value *control)
748 struct snd_kcontrol *kctl;
749 struct snd_kcontrol_volatile *vd;
750 unsigned int index_offset;
751 int result, indirect;
753 down_read(&card->controls_rwsem);
754 kctl = snd_ctl_find_id(card, &control->id);
758 index_offset = snd_ctl_get_ioff(kctl, &control->id);
759 vd = &kctl->vd[index_offset];
760 indirect = vd->access & SNDRV_CTL_ELEM_ACCESS_INDIRECT ? 1 : 0;
761 if (control->indirect != indirect) {
764 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
766 (file && vd->owner != NULL && vd->owner != file)) {
769 snd_ctl_build_ioff(&control->id, kctl, index_offset);
770 result = kctl->put(kctl, control);
773 up_read(&card->controls_rwsem);
774 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE, &control->id);
779 up_read(&card->controls_rwsem);
783 static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
784 struct snd_ctl_elem_value __user *_control)
786 struct snd_ctl_elem_value *control;
787 struct snd_card *card;
790 control = kmalloc(sizeof(*control), GFP_KERNEL);
793 if (copy_from_user(control, _control, sizeof(*control))) {
798 snd_power_lock(card);
799 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
801 result = snd_ctl_elem_write(card, file, control);
802 snd_power_unlock(card);
804 if (copy_to_user(_control, control, sizeof(*control)))
810 static int snd_ctl_elem_lock(struct snd_ctl_file *file,
811 struct snd_ctl_elem_id __user *_id)
813 struct snd_card *card = file->card;
814 struct snd_ctl_elem_id id;
815 struct snd_kcontrol *kctl;
816 struct snd_kcontrol_volatile *vd;
819 if (copy_from_user(&id, _id, sizeof(id)))
821 down_write(&card->controls_rwsem);
822 kctl = snd_ctl_find_id(card, &id);
826 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
827 if (vd->owner != NULL)
831 vd->owner_pid = current->pid;
835 up_write(&card->controls_rwsem);
839 static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
840 struct snd_ctl_elem_id __user *_id)
842 struct snd_card *card = file->card;
843 struct snd_ctl_elem_id id;
844 struct snd_kcontrol *kctl;
845 struct snd_kcontrol_volatile *vd;
848 if (copy_from_user(&id, _id, sizeof(id)))
850 down_write(&card->controls_rwsem);
851 kctl = snd_ctl_find_id(card, &id);
855 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
856 if (vd->owner == NULL)
858 else if (vd->owner != file)
866 up_write(&card->controls_rwsem);
870 struct user_element {
871 struct snd_ctl_elem_info info;
872 void *elem_data; /* element data */
873 unsigned long elem_data_size; /* size of element data in bytes */
874 void *tlv_data; /* TLV data */
875 unsigned long tlv_data_size; /* TLV data size */
876 void *priv_data; /* private data (like strings for enumerated type) */
877 unsigned long priv_data_size; /* size of private data in bytes */
880 static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
881 struct snd_ctl_elem_info *uinfo)
883 struct user_element *ue = kcontrol->private_data;
889 static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
890 struct snd_ctl_elem_value *ucontrol)
892 struct user_element *ue = kcontrol->private_data;
894 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
898 static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
899 struct snd_ctl_elem_value *ucontrol)
902 struct user_element *ue = kcontrol->private_data;
904 change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
906 memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
910 static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
913 unsigned int __user *tlv)
915 struct user_element *ue = kcontrol->private_data;
920 if (size > 1024 * 128) /* sane value */
922 new_data = kmalloc(size, GFP_KERNEL);
923 if (new_data == NULL)
925 if (copy_from_user(new_data, tlv, size)) {
929 change = ue->tlv_data_size != size;
931 change = memcmp(ue->tlv_data, new_data, size);
933 ue->tlv_data = new_data;
934 ue->tlv_data_size = size;
936 if (! ue->tlv_data_size || ! ue->tlv_data)
938 if (size < ue->tlv_data_size)
940 if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
946 static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
948 struct user_element *ue = kcontrol->private_data;
954 static int snd_ctl_elem_add(struct snd_ctl_file *file,
955 struct snd_ctl_elem_info *info, int replace)
957 struct snd_card *card = file->card;
958 struct snd_kcontrol kctl, *_kctl;
961 struct user_element *ue;
964 if (card->user_ctl_count >= MAX_USER_CONTROLS)
966 if (info->count > 1024)
968 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
969 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
970 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
971 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
973 memset(&kctl, 0, sizeof(kctl));
974 down_write(&card->controls_rwsem);
975 _kctl = snd_ctl_find_id(card, &info->id);
979 err = snd_ctl_remove(card, _kctl);
986 up_write(&card->controls_rwsem);
989 memcpy(&kctl.id, &info->id, sizeof(info->id));
990 kctl.count = info->owner ? info->owner : 1;
991 access |= SNDRV_CTL_ELEM_ACCESS_USER;
992 kctl.info = snd_ctl_elem_user_info;
993 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
994 kctl.get = snd_ctl_elem_user_get;
995 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
996 kctl.put = snd_ctl_elem_user_put;
997 if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
998 kctl.tlv.c = snd_ctl_elem_user_tlv;
999 access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1001 switch (info->type) {
1002 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
1003 case SNDRV_CTL_ELEM_TYPE_INTEGER:
1004 private_size = sizeof(long);
1005 if (info->count > 128)
1008 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1009 private_size = sizeof(long long);
1010 if (info->count > 64)
1013 case SNDRV_CTL_ELEM_TYPE_BYTES:
1014 private_size = sizeof(unsigned char);
1015 if (info->count > 512)
1018 case SNDRV_CTL_ELEM_TYPE_IEC958:
1019 private_size = sizeof(struct snd_aes_iec958);
1020 if (info->count != 1)
1026 private_size *= info->count;
1027 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
1031 ue->info.access = 0;
1032 ue->elem_data = (char *)ue + sizeof(*ue);
1033 ue->elem_data_size = private_size;
1034 kctl.private_free = snd_ctl_elem_user_free;
1035 _kctl = snd_ctl_new(&kctl, access);
1036 if (_kctl == NULL) {
1040 _kctl->private_data = ue;
1041 for (idx = 0; idx < _kctl->count; idx++)
1042 _kctl->vd[idx].owner = file;
1043 err = snd_ctl_add(card, _kctl);
1047 down_write(&card->controls_rwsem);
1048 card->user_ctl_count++;
1049 up_write(&card->controls_rwsem);
1054 static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1055 struct snd_ctl_elem_info __user *_info, int replace)
1057 struct snd_ctl_elem_info info;
1058 if (copy_from_user(&info, _info, sizeof(info)))
1060 return snd_ctl_elem_add(file, &info, replace);
1063 static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1064 struct snd_ctl_elem_id __user *_id)
1066 struct snd_ctl_elem_id id;
1069 if (copy_from_user(&id, _id, sizeof(id)))
1071 err = snd_ctl_remove_unlocked_id(file, &id);
1073 struct snd_card *card = file->card;
1074 down_write(&card->controls_rwsem);
1075 card->user_ctl_count--;
1076 up_write(&card->controls_rwsem);
1081 static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
1084 if (get_user(subscribe, ptr))
1086 if (subscribe < 0) {
1087 subscribe = file->subscribed;
1088 if (put_user(subscribe, ptr))
1093 file->subscribed = 1;
1095 } else if (file->subscribed) {
1096 snd_ctl_empty_read_queue(file);
1097 file->subscribed = 0;
1102 static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1103 struct snd_ctl_tlv __user *_tlv,
1106 struct snd_card *card = file->card;
1107 struct snd_ctl_tlv tlv;
1108 struct snd_kcontrol *kctl;
1109 struct snd_kcontrol_volatile *vd;
1113 if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1115 if (tlv.length < sizeof(unsigned int) * 3)
1117 down_read(&card->controls_rwsem);
1118 kctl = snd_ctl_find_numid(card, tlv.numid);
1123 if (kctl->tlv.p == NULL) {
1127 vd = &kctl->vd[tlv.numid - kctl->id.numid];
1128 if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1129 (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1130 (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1134 if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
1135 if (file && vd->owner != NULL && vd->owner != file) {
1139 err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
1141 up_read(&card->controls_rwsem);
1142 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &kctl->id);
1150 len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1151 if (tlv.length < len) {
1155 if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1159 up_read(&card->controls_rwsem);
1163 static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1165 struct snd_ctl_file *ctl;
1166 struct snd_card *card;
1167 struct snd_kctl_ioctl *p;
1168 void __user *argp = (void __user *)arg;
1169 int __user *ip = argp;
1172 ctl = file->private_data;
1174 snd_assert(card != NULL, return -ENXIO);
1176 case SNDRV_CTL_IOCTL_PVERSION:
1177 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1178 case SNDRV_CTL_IOCTL_CARD_INFO:
1179 return snd_ctl_card_info(card, ctl, cmd, argp);
1180 case SNDRV_CTL_IOCTL_ELEM_LIST:
1181 return snd_ctl_elem_list(card, argp);
1182 case SNDRV_CTL_IOCTL_ELEM_INFO:
1183 return snd_ctl_elem_info_user(ctl, argp);
1184 case SNDRV_CTL_IOCTL_ELEM_READ:
1185 return snd_ctl_elem_read_user(card, argp);
1186 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1187 return snd_ctl_elem_write_user(ctl, argp);
1188 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1189 return snd_ctl_elem_lock(ctl, argp);
1190 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1191 return snd_ctl_elem_unlock(ctl, argp);
1192 case SNDRV_CTL_IOCTL_ELEM_ADD:
1193 return snd_ctl_elem_add_user(ctl, argp, 0);
1194 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1195 return snd_ctl_elem_add_user(ctl, argp, 1);
1196 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1197 return snd_ctl_elem_remove(ctl, argp);
1198 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1199 return snd_ctl_subscribe_events(ctl, ip);
1200 case SNDRV_CTL_IOCTL_TLV_READ:
1201 return snd_ctl_tlv_ioctl(ctl, argp, 0);
1202 case SNDRV_CTL_IOCTL_TLV_WRITE:
1203 return snd_ctl_tlv_ioctl(ctl, argp, 1);
1204 case SNDRV_CTL_IOCTL_TLV_COMMAND:
1205 return snd_ctl_tlv_ioctl(ctl, argp, -1);
1206 case SNDRV_CTL_IOCTL_POWER:
1207 return -ENOPROTOOPT;
1208 case SNDRV_CTL_IOCTL_POWER_STATE:
1210 return put_user(card->power_state, ip) ? -EFAULT : 0;
1212 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1215 down_read(&snd_ioctl_rwsem);
1216 list_for_each_entry(p, &snd_control_ioctls, list) {
1217 err = p->fioctl(card, ctl, cmd, arg);
1218 if (err != -ENOIOCTLCMD) {
1219 up_read(&snd_ioctl_rwsem);
1223 up_read(&snd_ioctl_rwsem);
1224 snd_printdd("unknown ioctl = 0x%x\n", cmd);
1228 static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1229 size_t count, loff_t * offset)
1231 struct snd_ctl_file *ctl;
1235 ctl = file->private_data;
1236 snd_assert(ctl != NULL && ctl->card != NULL, return -ENXIO);
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 snd_assert(fcn != NULL, return -EINVAL);
1343 down_write(&snd_ioctl_rwsem);
1344 list_for_each_entry(p, lists, list) {
1345 if (p->fioctl == fcn) {
1347 up_write(&snd_ioctl_rwsem);
1352 up_write(&snd_ioctl_rwsem);
1357 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1359 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1362 EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1364 #ifdef CONFIG_COMPAT
1365 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1367 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1370 EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
1373 static int snd_ctl_fasync(int fd, struct file * file, int on)
1375 struct snd_ctl_file *ctl;
1377 ctl = file->private_data;
1378 err = fasync_helper(fd, file, on, &ctl->fasync);
1387 #ifdef CONFIG_COMPAT
1388 #include "control_compat.c"
1390 #define snd_ctl_ioctl_compat NULL
1397 static const struct file_operations snd_ctl_f_ops =
1399 .owner = THIS_MODULE,
1400 .read = snd_ctl_read,
1401 .open = snd_ctl_open,
1402 .release = snd_ctl_release,
1403 .poll = snd_ctl_poll,
1404 .unlocked_ioctl = snd_ctl_ioctl,
1405 .compat_ioctl = snd_ctl_ioctl_compat,
1406 .fasync = snd_ctl_fasync,
1410 * registration of the control device
1412 static int snd_ctl_dev_register(struct snd_device *device)
1414 struct snd_card *card = device->device_data;
1418 snd_assert(card != NULL, return -ENXIO);
1419 cardnum = card->number;
1420 snd_assert(cardnum >= 0 && cardnum < SNDRV_CARDS, return -ENXIO);
1421 sprintf(name, "controlC%i", cardnum);
1422 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1423 &snd_ctl_f_ops, card, name)) < 0)
1429 * disconnection of the control device
1431 static int snd_ctl_dev_disconnect(struct snd_device *device)
1433 struct snd_card *card = device->device_data;
1434 struct snd_ctl_file *ctl;
1437 snd_assert(card != NULL, return -ENXIO);
1438 cardnum = card->number;
1439 snd_assert(cardnum >= 0 && cardnum < SNDRV_CARDS, return -ENXIO);
1441 down_read(&card->controls_rwsem);
1442 list_for_each_entry(ctl, &card->ctl_files, list) {
1443 wake_up(&ctl->change_sleep);
1444 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1446 up_read(&card->controls_rwsem);
1448 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1457 static int snd_ctl_dev_free(struct snd_device *device)
1459 struct snd_card *card = device->device_data;
1460 struct snd_kcontrol *control;
1462 down_write(&card->controls_rwsem);
1463 while (!list_empty(&card->controls)) {
1464 control = snd_kcontrol(card->controls.next);
1465 snd_ctl_remove(card, control);
1467 up_write(&card->controls_rwsem);
1472 * create control core:
1473 * called from init.c
1475 int snd_ctl_create(struct snd_card *card)
1477 static struct snd_device_ops ops = {
1478 .dev_free = snd_ctl_dev_free,
1479 .dev_register = snd_ctl_dev_register,
1480 .dev_disconnect = snd_ctl_dev_disconnect,
1483 snd_assert(card != NULL, return -ENXIO);
1484 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
1488 * Frequently used control callbacks
1490 int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
1491 struct snd_ctl_elem_info *uinfo)
1493 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1495 uinfo->value.integer.min = 0;
1496 uinfo->value.integer.max = 1;
1500 EXPORT_SYMBOL(snd_ctl_boolean_mono_info);
1502 int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
1503 struct snd_ctl_elem_info *uinfo)
1505 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1507 uinfo->value.integer.min = 0;
1508 uinfo->value.integer.max = 1;
1512 EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);