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 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 if (control->count > MAX_CONTROL_COUNT)
196 kctl = kzalloc(sizeof(*kctl) + sizeof(struct snd_kcontrol_volatile) * control->count, GFP_KERNEL);
198 snd_printk(KERN_ERR "Cannot allocate control instance\n");
202 for (idx = 0; idx < kctl->count; idx++)
203 kctl->vd[idx].access = access;
208 * snd_ctl_new1 - create a control instance from the template
209 * @ncontrol: the initialization record
210 * @private_data: the private data to set
212 * Allocates a new struct snd_kcontrol instance and initialize from the given
213 * template. When the access field of ncontrol is 0, it's assumed as
214 * READWRITE access. When the count field is 0, it's assumes as one.
216 * Returns the pointer of the newly generated instance, or NULL on failure.
218 struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new *ncontrol,
221 struct snd_kcontrol kctl;
224 snd_assert(ncontrol != NULL, return NULL);
225 snd_assert(ncontrol->info != NULL, return NULL);
226 memset(&kctl, 0, sizeof(kctl));
227 kctl.id.iface = ncontrol->iface;
228 kctl.id.device = ncontrol->device;
229 kctl.id.subdevice = ncontrol->subdevice;
231 strlcpy(kctl.id.name, ncontrol->name, sizeof(kctl.id.name));
232 kctl.id.index = ncontrol->index;
233 kctl.count = ncontrol->count ? ncontrol->count : 1;
234 access = ncontrol->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
235 (ncontrol->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
236 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
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 static int snd_ctl_elem_read(struct snd_card *card,
691 struct snd_ctl_elem_value *control)
693 struct snd_kcontrol *kctl;
694 struct snd_kcontrol_volatile *vd;
695 unsigned int index_offset;
698 down_read(&card->controls_rwsem);
699 kctl = snd_ctl_find_id(card, &control->id);
703 index_offset = snd_ctl_get_ioff(kctl, &control->id);
704 vd = &kctl->vd[index_offset];
705 if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) &&
707 snd_ctl_build_ioff(&control->id, kctl, index_offset);
708 result = kctl->get(kctl, control);
712 up_read(&card->controls_rwsem);
716 static int snd_ctl_elem_read_user(struct snd_card *card,
717 struct snd_ctl_elem_value __user *_control)
719 struct snd_ctl_elem_value *control;
722 control = kmalloc(sizeof(*control), GFP_KERNEL);
725 if (copy_from_user(control, _control, sizeof(*control))) {
729 snd_power_lock(card);
730 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
732 result = snd_ctl_elem_read(card, control);
733 snd_power_unlock(card);
735 if (copy_to_user(_control, control, sizeof(*control)))
741 static int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
742 struct snd_ctl_elem_value *control)
744 struct snd_kcontrol *kctl;
745 struct snd_kcontrol_volatile *vd;
746 unsigned int index_offset;
749 down_read(&card->controls_rwsem);
750 kctl = snd_ctl_find_id(card, &control->id);
754 index_offset = snd_ctl_get_ioff(kctl, &control->id);
755 vd = &kctl->vd[index_offset];
756 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
758 (file && vd->owner && vd->owner != file)) {
761 snd_ctl_build_ioff(&control->id, kctl, index_offset);
762 result = kctl->put(kctl, control);
765 up_read(&card->controls_rwsem);
766 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
771 up_read(&card->controls_rwsem);
775 static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
776 struct snd_ctl_elem_value __user *_control)
778 struct snd_ctl_elem_value *control;
779 struct snd_card *card;
782 control = kmalloc(sizeof(*control), GFP_KERNEL);
785 if (copy_from_user(control, _control, sizeof(*control))) {
790 snd_power_lock(card);
791 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
793 result = snd_ctl_elem_write(card, file, control);
794 snd_power_unlock(card);
796 if (copy_to_user(_control, control, sizeof(*control)))
802 static int snd_ctl_elem_lock(struct snd_ctl_file *file,
803 struct snd_ctl_elem_id __user *_id)
805 struct snd_card *card = file->card;
806 struct snd_ctl_elem_id id;
807 struct snd_kcontrol *kctl;
808 struct snd_kcontrol_volatile *vd;
811 if (copy_from_user(&id, _id, sizeof(id)))
813 down_write(&card->controls_rwsem);
814 kctl = snd_ctl_find_id(card, &id);
818 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
819 if (vd->owner != NULL)
823 vd->owner_pid = current->pid;
827 up_write(&card->controls_rwsem);
831 static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
832 struct snd_ctl_elem_id __user *_id)
834 struct snd_card *card = file->card;
835 struct snd_ctl_elem_id id;
836 struct snd_kcontrol *kctl;
837 struct snd_kcontrol_volatile *vd;
840 if (copy_from_user(&id, _id, sizeof(id)))
842 down_write(&card->controls_rwsem);
843 kctl = snd_ctl_find_id(card, &id);
847 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
848 if (vd->owner == NULL)
850 else if (vd->owner != file)
858 up_write(&card->controls_rwsem);
862 struct user_element {
863 struct snd_ctl_elem_info info;
864 void *elem_data; /* element data */
865 unsigned long elem_data_size; /* size of element data in bytes */
866 void *tlv_data; /* TLV data */
867 unsigned long tlv_data_size; /* TLV data size */
868 void *priv_data; /* private data (like strings for enumerated type) */
869 unsigned long priv_data_size; /* size of private data in bytes */
872 static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
873 struct snd_ctl_elem_info *uinfo)
875 struct user_element *ue = kcontrol->private_data;
881 static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
882 struct snd_ctl_elem_value *ucontrol)
884 struct user_element *ue = kcontrol->private_data;
886 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
890 static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
891 struct snd_ctl_elem_value *ucontrol)
894 struct user_element *ue = kcontrol->private_data;
896 change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
898 memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
902 static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
905 unsigned int __user *tlv)
907 struct user_element *ue = kcontrol->private_data;
912 if (size > 1024 * 128) /* sane value */
914 new_data = kmalloc(size, GFP_KERNEL);
915 if (new_data == NULL)
917 if (copy_from_user(new_data, tlv, size)) {
921 change = ue->tlv_data_size != size;
923 change = memcmp(ue->tlv_data, new_data, size);
925 ue->tlv_data = new_data;
926 ue->tlv_data_size = size;
928 if (! ue->tlv_data_size || ! ue->tlv_data)
930 if (size < ue->tlv_data_size)
932 if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
938 static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
940 struct user_element *ue = kcontrol->private_data;
946 static int snd_ctl_elem_add(struct snd_ctl_file *file,
947 struct snd_ctl_elem_info *info, int replace)
949 struct snd_card *card = file->card;
950 struct snd_kcontrol kctl, *_kctl;
953 struct user_element *ue;
956 if (card->user_ctl_count >= MAX_USER_CONTROLS)
958 if (info->count > 1024)
960 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
961 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
962 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
963 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
965 memset(&kctl, 0, sizeof(kctl));
966 down_write(&card->controls_rwsem);
967 _kctl = snd_ctl_find_id(card, &info->id);
971 err = snd_ctl_remove(card, _kctl);
978 up_write(&card->controls_rwsem);
981 memcpy(&kctl.id, &info->id, sizeof(info->id));
982 kctl.count = info->owner ? info->owner : 1;
983 access |= SNDRV_CTL_ELEM_ACCESS_USER;
984 kctl.info = snd_ctl_elem_user_info;
985 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
986 kctl.get = snd_ctl_elem_user_get;
987 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
988 kctl.put = snd_ctl_elem_user_put;
989 if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
990 kctl.tlv.c = snd_ctl_elem_user_tlv;
991 access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
993 switch (info->type) {
994 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
995 case SNDRV_CTL_ELEM_TYPE_INTEGER:
996 private_size = sizeof(long);
997 if (info->count > 128)
1000 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1001 private_size = sizeof(long long);
1002 if (info->count > 64)
1005 case SNDRV_CTL_ELEM_TYPE_BYTES:
1006 private_size = sizeof(unsigned char);
1007 if (info->count > 512)
1010 case SNDRV_CTL_ELEM_TYPE_IEC958:
1011 private_size = sizeof(struct snd_aes_iec958);
1012 if (info->count != 1)
1018 private_size *= info->count;
1019 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
1023 ue->info.access = 0;
1024 ue->elem_data = (char *)ue + sizeof(*ue);
1025 ue->elem_data_size = private_size;
1026 kctl.private_free = snd_ctl_elem_user_free;
1027 _kctl = snd_ctl_new(&kctl, access);
1028 if (_kctl == NULL) {
1032 _kctl->private_data = ue;
1033 for (idx = 0; idx < _kctl->count; idx++)
1034 _kctl->vd[idx].owner = file;
1035 err = snd_ctl_add(card, _kctl);
1039 down_write(&card->controls_rwsem);
1040 card->user_ctl_count++;
1041 up_write(&card->controls_rwsem);
1046 static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1047 struct snd_ctl_elem_info __user *_info, int replace)
1049 struct snd_ctl_elem_info info;
1050 if (copy_from_user(&info, _info, sizeof(info)))
1052 return snd_ctl_elem_add(file, &info, replace);
1055 static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1056 struct snd_ctl_elem_id __user *_id)
1058 struct snd_ctl_elem_id id;
1061 if (copy_from_user(&id, _id, sizeof(id)))
1063 err = snd_ctl_remove_unlocked_id(file, &id);
1065 struct snd_card *card = file->card;
1066 down_write(&card->controls_rwsem);
1067 card->user_ctl_count--;
1068 up_write(&card->controls_rwsem);
1073 static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
1076 if (get_user(subscribe, ptr))
1078 if (subscribe < 0) {
1079 subscribe = file->subscribed;
1080 if (put_user(subscribe, ptr))
1085 file->subscribed = 1;
1087 } else if (file->subscribed) {
1088 snd_ctl_empty_read_queue(file);
1089 file->subscribed = 0;
1094 static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1095 struct snd_ctl_tlv __user *_tlv,
1098 struct snd_card *card = file->card;
1099 struct snd_ctl_tlv tlv;
1100 struct snd_kcontrol *kctl;
1101 struct snd_kcontrol_volatile *vd;
1105 if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1107 if (tlv.length < sizeof(unsigned int) * 3)
1109 down_read(&card->controls_rwsem);
1110 kctl = snd_ctl_find_numid(card, tlv.numid);
1115 if (kctl->tlv.p == NULL) {
1119 vd = &kctl->vd[tlv.numid - kctl->id.numid];
1120 if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1121 (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1122 (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1126 if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
1127 if (file && vd->owner != NULL && vd->owner != file) {
1131 err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
1133 up_read(&card->controls_rwsem);
1134 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &kctl->id);
1142 len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1143 if (tlv.length < len) {
1147 if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1151 up_read(&card->controls_rwsem);
1155 static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1157 struct snd_ctl_file *ctl;
1158 struct snd_card *card;
1159 struct snd_kctl_ioctl *p;
1160 void __user *argp = (void __user *)arg;
1161 int __user *ip = argp;
1164 ctl = file->private_data;
1166 snd_assert(card != NULL, return -ENXIO);
1168 case SNDRV_CTL_IOCTL_PVERSION:
1169 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1170 case SNDRV_CTL_IOCTL_CARD_INFO:
1171 return snd_ctl_card_info(card, ctl, cmd, argp);
1172 case SNDRV_CTL_IOCTL_ELEM_LIST:
1173 return snd_ctl_elem_list(card, argp);
1174 case SNDRV_CTL_IOCTL_ELEM_INFO:
1175 return snd_ctl_elem_info_user(ctl, argp);
1176 case SNDRV_CTL_IOCTL_ELEM_READ:
1177 return snd_ctl_elem_read_user(card, argp);
1178 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1179 return snd_ctl_elem_write_user(ctl, argp);
1180 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1181 return snd_ctl_elem_lock(ctl, argp);
1182 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1183 return snd_ctl_elem_unlock(ctl, argp);
1184 case SNDRV_CTL_IOCTL_ELEM_ADD:
1185 return snd_ctl_elem_add_user(ctl, argp, 0);
1186 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1187 return snd_ctl_elem_add_user(ctl, argp, 1);
1188 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1189 return snd_ctl_elem_remove(ctl, argp);
1190 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1191 return snd_ctl_subscribe_events(ctl, ip);
1192 case SNDRV_CTL_IOCTL_TLV_READ:
1193 return snd_ctl_tlv_ioctl(ctl, argp, 0);
1194 case SNDRV_CTL_IOCTL_TLV_WRITE:
1195 return snd_ctl_tlv_ioctl(ctl, argp, 1);
1196 case SNDRV_CTL_IOCTL_TLV_COMMAND:
1197 return snd_ctl_tlv_ioctl(ctl, argp, -1);
1198 case SNDRV_CTL_IOCTL_POWER:
1199 return -ENOPROTOOPT;
1200 case SNDRV_CTL_IOCTL_POWER_STATE:
1202 return put_user(card->power_state, ip) ? -EFAULT : 0;
1204 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1207 down_read(&snd_ioctl_rwsem);
1208 list_for_each_entry(p, &snd_control_ioctls, list) {
1209 err = p->fioctl(card, ctl, cmd, arg);
1210 if (err != -ENOIOCTLCMD) {
1211 up_read(&snd_ioctl_rwsem);
1215 up_read(&snd_ioctl_rwsem);
1216 snd_printdd("unknown ioctl = 0x%x\n", cmd);
1220 static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1221 size_t count, loff_t * offset)
1223 struct snd_ctl_file *ctl;
1227 ctl = file->private_data;
1228 snd_assert(ctl != NULL && ctl->card != NULL, return -ENXIO);
1229 if (!ctl->subscribed)
1231 if (count < sizeof(struct snd_ctl_event))
1233 spin_lock_irq(&ctl->read_lock);
1234 while (count >= sizeof(struct snd_ctl_event)) {
1235 struct snd_ctl_event ev;
1236 struct snd_kctl_event *kev;
1237 while (list_empty(&ctl->events)) {
1239 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1243 init_waitqueue_entry(&wait, current);
1244 add_wait_queue(&ctl->change_sleep, &wait);
1245 set_current_state(TASK_INTERRUPTIBLE);
1246 spin_unlock_irq(&ctl->read_lock);
1248 remove_wait_queue(&ctl->change_sleep, &wait);
1249 if (signal_pending(current))
1250 return -ERESTARTSYS;
1251 spin_lock_irq(&ctl->read_lock);
1253 kev = snd_kctl_event(ctl->events.next);
1254 ev.type = SNDRV_CTL_EVENT_ELEM;
1255 ev.data.elem.mask = kev->mask;
1256 ev.data.elem.id = kev->id;
1257 list_del(&kev->list);
1258 spin_unlock_irq(&ctl->read_lock);
1260 if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
1264 spin_lock_irq(&ctl->read_lock);
1265 buffer += sizeof(struct snd_ctl_event);
1266 count -= sizeof(struct snd_ctl_event);
1267 result += sizeof(struct snd_ctl_event);
1270 spin_unlock_irq(&ctl->read_lock);
1272 return result > 0 ? result : err;
1275 static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1278 struct snd_ctl_file *ctl;
1280 ctl = file->private_data;
1281 if (!ctl->subscribed)
1283 poll_wait(file, &ctl->change_sleep, wait);
1286 if (!list_empty(&ctl->events))
1287 mask |= POLLIN | POLLRDNORM;
1293 * register the device-specific control-ioctls.
1294 * called from each device manager like pcm.c, hwdep.c, etc.
1296 static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1298 struct snd_kctl_ioctl *pn;
1300 pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
1304 down_write(&snd_ioctl_rwsem);
1305 list_add_tail(&pn->list, lists);
1306 up_write(&snd_ioctl_rwsem);
1310 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1312 return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1315 EXPORT_SYMBOL(snd_ctl_register_ioctl);
1317 #ifdef CONFIG_COMPAT
1318 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1320 return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1323 EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
1327 * de-register the device-specific control-ioctls.
1329 static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1330 struct list_head *lists)
1332 struct snd_kctl_ioctl *p;
1334 snd_assert(fcn != NULL, return -EINVAL);
1335 down_write(&snd_ioctl_rwsem);
1336 list_for_each_entry(p, lists, list) {
1337 if (p->fioctl == fcn) {
1339 up_write(&snd_ioctl_rwsem);
1344 up_write(&snd_ioctl_rwsem);
1349 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1351 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1354 EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1356 #ifdef CONFIG_COMPAT
1357 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1359 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1362 EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
1365 static int snd_ctl_fasync(int fd, struct file * file, int on)
1367 struct snd_ctl_file *ctl;
1369 ctl = file->private_data;
1370 err = fasync_helper(fd, file, on, &ctl->fasync);
1379 #ifdef CONFIG_COMPAT
1380 #include "control_compat.c"
1382 #define snd_ctl_ioctl_compat NULL
1389 static const struct file_operations snd_ctl_f_ops =
1391 .owner = THIS_MODULE,
1392 .read = snd_ctl_read,
1393 .open = snd_ctl_open,
1394 .release = snd_ctl_release,
1395 .poll = snd_ctl_poll,
1396 .unlocked_ioctl = snd_ctl_ioctl,
1397 .compat_ioctl = snd_ctl_ioctl_compat,
1398 .fasync = snd_ctl_fasync,
1402 * registration of the control device
1404 static int snd_ctl_dev_register(struct snd_device *device)
1406 struct snd_card *card = device->device_data;
1410 snd_assert(card != NULL, return -ENXIO);
1411 cardnum = card->number;
1412 snd_assert(cardnum >= 0 && cardnum < SNDRV_CARDS, return -ENXIO);
1413 sprintf(name, "controlC%i", cardnum);
1414 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1415 &snd_ctl_f_ops, card, name)) < 0)
1421 * disconnection of the control device
1423 static int snd_ctl_dev_disconnect(struct snd_device *device)
1425 struct snd_card *card = device->device_data;
1426 struct snd_ctl_file *ctl;
1429 snd_assert(card != NULL, return -ENXIO);
1430 cardnum = card->number;
1431 snd_assert(cardnum >= 0 && cardnum < SNDRV_CARDS, return -ENXIO);
1433 read_lock(&card->ctl_files_rwlock);
1434 list_for_each_entry(ctl, &card->ctl_files, list) {
1435 wake_up(&ctl->change_sleep);
1436 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1438 read_unlock(&card->ctl_files_rwlock);
1440 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1449 static int snd_ctl_dev_free(struct snd_device *device)
1451 struct snd_card *card = device->device_data;
1452 struct snd_kcontrol *control;
1454 down_write(&card->controls_rwsem);
1455 while (!list_empty(&card->controls)) {
1456 control = snd_kcontrol(card->controls.next);
1457 snd_ctl_remove(card, control);
1459 up_write(&card->controls_rwsem);
1464 * create control core:
1465 * called from init.c
1467 int snd_ctl_create(struct snd_card *card)
1469 static struct snd_device_ops ops = {
1470 .dev_free = snd_ctl_dev_free,
1471 .dev_register = snd_ctl_dev_register,
1472 .dev_disconnect = snd_ctl_dev_disconnect,
1475 snd_assert(card != NULL, return -ENXIO);
1476 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
1480 * Frequently used control callbacks
1482 int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
1483 struct snd_ctl_elem_info *uinfo)
1485 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1487 uinfo->value.integer.min = 0;
1488 uinfo->value.integer.max = 1;
1492 EXPORT_SYMBOL(snd_ctl_boolean_mono_info);
1494 int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
1495 struct snd_ctl_elem_info *uinfo)
1497 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1499 uinfo->value.integer.min = 0;
1500 uinfo->value.integer.max = 1;
1504 EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);