2 * Routines for driver control interface
3 * Copyright (c) by Jaroslav Kysela <perex@suse.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)
96 struct snd_kctl_event *cread;
98 spin_lock(&ctl->read_lock);
99 while (!list_empty(&ctl->events)) {
100 cread = snd_kctl_event(ctl->events.next);
101 list_del(&cread->list);
104 spin_unlock(&ctl->read_lock);
107 static int snd_ctl_release(struct inode *inode, struct file *file)
110 struct snd_card *card;
111 struct snd_ctl_file *ctl;
112 struct snd_kcontrol *control;
115 ctl = file->private_data;
116 fasync_helper(-1, file, 0, &ctl->fasync);
117 file->private_data = NULL;
119 write_lock_irqsave(&card->ctl_files_rwlock, flags);
120 list_del(&ctl->list);
121 write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
122 down_write(&card->controls_rwsem);
123 list_for_each_entry(control, &card->controls, list)
124 for (idx = 0; idx < control->count; idx++)
125 if (control->vd[idx].owner == ctl)
126 control->vd[idx].owner = NULL;
127 up_write(&card->controls_rwsem);
128 snd_ctl_empty_read_queue(ctl);
130 module_put(card->module);
131 snd_card_file_remove(card, file);
135 void snd_ctl_notify(struct snd_card *card, unsigned int mask,
136 struct snd_ctl_elem_id *id)
139 struct snd_ctl_file *ctl;
140 struct snd_kctl_event *ev;
142 snd_assert(card != NULL && id != NULL, return);
143 read_lock(&card->ctl_files_rwlock);
144 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
145 card->mixer_oss_change_count++;
147 list_for_each_entry(ctl, &card->ctl_files, list) {
148 if (!ctl->subscribed)
150 spin_lock_irqsave(&ctl->read_lock, flags);
151 list_for_each_entry(ev, &ctl->events, list) {
152 if (ev->id.numid == id->numid) {
157 ev = kzalloc(sizeof(*ev), GFP_ATOMIC);
161 list_add_tail(&ev->list, &ctl->events);
163 snd_printk(KERN_ERR "No memory available to allocate event\n");
166 wake_up(&ctl->change_sleep);
167 spin_unlock_irqrestore(&ctl->read_lock, flags);
168 kill_fasync(&ctl->fasync, SIGIO, POLL_IN);
170 read_unlock(&card->ctl_files_rwlock);
173 EXPORT_SYMBOL(snd_ctl_notify);
176 * snd_ctl_new - create a control instance from the template
177 * @control: the control template
178 * @access: the default control access
180 * Allocates a new struct snd_kcontrol instance and copies the given template
181 * to the new instance. It does not copy volatile data (access).
183 * Returns the pointer of the new instance, or NULL on failure.
185 static struct snd_kcontrol *snd_ctl_new(struct snd_kcontrol *control,
188 struct snd_kcontrol *kctl;
191 snd_assert(control != NULL, return NULL);
192 snd_assert(control->count > 0, return NULL);
193 kctl = kzalloc(sizeof(*kctl) + sizeof(struct snd_kcontrol_volatile) * control->count, GFP_KERNEL);
195 snd_printk(KERN_ERR "Cannot allocate control instance\n");
199 for (idx = 0; idx < kctl->count; idx++)
200 kctl->vd[idx].access = access;
205 * snd_ctl_new1 - create a control instance from the template
206 * @ncontrol: the initialization record
207 * @private_data: the private data to set
209 * Allocates a new struct snd_kcontrol instance and initialize from the given
210 * template. When the access field of ncontrol is 0, it's assumed as
211 * READWRITE access. When the count field is 0, it's assumes as one.
213 * Returns the pointer of the newly generated instance, or NULL on failure.
215 struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new *ncontrol,
218 struct snd_kcontrol kctl;
221 snd_assert(ncontrol != NULL, return NULL);
222 snd_assert(ncontrol->info != NULL, return NULL);
223 memset(&kctl, 0, sizeof(kctl));
224 kctl.id.iface = ncontrol->iface;
225 kctl.id.device = ncontrol->device;
226 kctl.id.subdevice = ncontrol->subdevice;
228 strlcpy(kctl.id.name, ncontrol->name, sizeof(kctl.id.name));
229 kctl.id.index = ncontrol->index;
230 kctl.count = ncontrol->count ? ncontrol->count : 1;
231 access = ncontrol->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
232 (ncontrol->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
233 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
234 SNDRV_CTL_ELEM_ACCESS_DINDIRECT|
235 SNDRV_CTL_ELEM_ACCESS_INDIRECT|
236 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE|
237 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK));
238 kctl.info = ncontrol->info;
239 kctl.get = ncontrol->get;
240 kctl.put = ncontrol->put;
241 kctl.tlv.p = ncontrol->tlv.p;
242 kctl.private_value = ncontrol->private_value;
243 kctl.private_data = private_data;
244 return snd_ctl_new(&kctl, access);
247 EXPORT_SYMBOL(snd_ctl_new1);
250 * snd_ctl_free_one - release the control instance
251 * @kcontrol: the control instance
253 * Releases the control instance created via snd_ctl_new()
255 * Don't call this after the control was added to the card.
257 void snd_ctl_free_one(struct snd_kcontrol *kcontrol)
260 if (kcontrol->private_free)
261 kcontrol->private_free(kcontrol);
266 EXPORT_SYMBOL(snd_ctl_free_one);
268 static unsigned int snd_ctl_hole_check(struct snd_card *card,
271 struct snd_kcontrol *kctl;
273 list_for_each_entry(kctl, &card->controls, list) {
274 if ((kctl->id.numid <= card->last_numid &&
275 kctl->id.numid + kctl->count > card->last_numid) ||
276 (kctl->id.numid <= card->last_numid + count - 1 &&
277 kctl->id.numid + kctl->count > card->last_numid + count - 1))
278 return card->last_numid = kctl->id.numid + kctl->count - 1;
280 return card->last_numid;
283 static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
285 unsigned int last_numid, iter = 100000;
287 last_numid = card->last_numid;
288 while (last_numid != snd_ctl_hole_check(card, count)) {
290 /* this situation is very unlikely */
291 snd_printk(KERN_ERR "unable to allocate new control numid\n");
294 last_numid = card->last_numid;
300 * snd_ctl_add - add the control instance to the card
301 * @card: the card instance
302 * @kcontrol: the control instance to add
304 * Adds the control instance created via snd_ctl_new() or
305 * snd_ctl_new1() to the given card. Assigns also an unique
306 * numid used for fast search.
308 * Returns zero if successful, or a negative error code on failure.
310 * It frees automatically the control which cannot be added.
312 int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
314 struct snd_ctl_elem_id id;
320 snd_assert(card != NULL, goto error);
321 snd_assert(kcontrol->info != NULL, goto error);
323 down_write(&card->controls_rwsem);
324 if (snd_ctl_find_id(card, &id)) {
325 up_write(&card->controls_rwsem);
326 snd_printd(KERN_ERR "control %i:%i:%i:%s:%i is already present\n",
335 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
336 up_write(&card->controls_rwsem);
340 list_add_tail(&kcontrol->list, &card->controls);
341 card->controls_count += kcontrol->count;
342 kcontrol->id.numid = card->last_numid + 1;
343 card->last_numid += kcontrol->count;
344 up_write(&card->controls_rwsem);
345 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
346 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
350 snd_ctl_free_one(kcontrol);
354 EXPORT_SYMBOL(snd_ctl_add);
357 * snd_ctl_remove - remove the control from the card and release it
358 * @card: the card instance
359 * @kcontrol: the control instance to remove
361 * Removes the control from the card and then releases the instance.
362 * You don't need to call snd_ctl_free_one(). You must be in
363 * the write lock - down_write(&card->controls_rwsem).
365 * Returns 0 if successful, or a negative error code on failure.
367 int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
369 struct snd_ctl_elem_id id;
372 snd_assert(card != NULL && kcontrol != NULL, return -EINVAL);
373 list_del(&kcontrol->list);
374 card->controls_count -= kcontrol->count;
376 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
377 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
378 snd_ctl_free_one(kcontrol);
382 EXPORT_SYMBOL(snd_ctl_remove);
385 * snd_ctl_remove_id - remove the control of the given id and release it
386 * @card: the card instance
387 * @id: the control id to remove
389 * Finds the control instance with the given id, removes it from the
390 * card list and releases it.
392 * Returns 0 if successful, or a negative error code on failure.
394 int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
396 struct snd_kcontrol *kctl;
399 down_write(&card->controls_rwsem);
400 kctl = snd_ctl_find_id(card, id);
402 up_write(&card->controls_rwsem);
405 ret = snd_ctl_remove(card, kctl);
406 up_write(&card->controls_rwsem);
410 EXPORT_SYMBOL(snd_ctl_remove_id);
413 * snd_ctl_remove_unlocked_id - remove the unlocked control of the given id and release it
414 * @file: active control handle
415 * @id: the control id to remove
417 * Finds the control instance with the given id, removes it from the
418 * card list and releases it.
420 * Returns 0 if successful, or a negative error code on failure.
422 static int snd_ctl_remove_unlocked_id(struct snd_ctl_file * file,
423 struct snd_ctl_elem_id *id)
425 struct snd_card *card = file->card;
426 struct snd_kcontrol *kctl;
429 down_write(&card->controls_rwsem);
430 kctl = snd_ctl_find_id(card, id);
432 up_write(&card->controls_rwsem);
435 for (idx = 0; idx < kctl->count; idx++)
436 if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
437 up_write(&card->controls_rwsem);
440 ret = snd_ctl_remove(card, kctl);
441 up_write(&card->controls_rwsem);
446 * snd_ctl_rename_id - replace the id of a control on the card
447 * @card: the card instance
448 * @src_id: the old id
449 * @dst_id: the new id
451 * Finds the control with the old id from the card, and replaces the
452 * id with the new one.
454 * Returns zero if successful, or a negative error code on failure.
456 int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
457 struct snd_ctl_elem_id *dst_id)
459 struct snd_kcontrol *kctl;
461 down_write(&card->controls_rwsem);
462 kctl = snd_ctl_find_id(card, src_id);
464 up_write(&card->controls_rwsem);
468 kctl->id.numid = card->last_numid + 1;
469 card->last_numid += kctl->count;
470 up_write(&card->controls_rwsem);
474 EXPORT_SYMBOL(snd_ctl_rename_id);
477 * snd_ctl_find_numid - find the control instance with the given number-id
478 * @card: the card instance
479 * @numid: the number-id to search
481 * Finds the control instance with the given number-id from the card.
483 * Returns the pointer of the instance if found, or NULL if not.
485 * The caller must down card->controls_rwsem before calling this function
486 * (if the race condition can happen).
488 struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
490 struct snd_kcontrol *kctl;
492 snd_assert(card != NULL && numid != 0, return NULL);
493 list_for_each_entry(kctl, &card->controls, list) {
494 if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
500 EXPORT_SYMBOL(snd_ctl_find_numid);
503 * snd_ctl_find_id - find the control instance with the given id
504 * @card: the card instance
505 * @id: the id to search
507 * Finds the control instance with the given id from the card.
509 * Returns the pointer of the instance if found, or NULL if not.
511 * The caller must down card->controls_rwsem before calling this function
512 * (if the race condition can happen).
514 struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
515 struct snd_ctl_elem_id *id)
517 struct snd_kcontrol *kctl;
519 snd_assert(card != NULL && id != NULL, return NULL);
521 return snd_ctl_find_numid(card, id->numid);
522 list_for_each_entry(kctl, &card->controls, list) {
523 if (kctl->id.iface != id->iface)
525 if (kctl->id.device != id->device)
527 if (kctl->id.subdevice != id->subdevice)
529 if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
531 if (kctl->id.index > id->index)
533 if (kctl->id.index + kctl->count <= id->index)
540 EXPORT_SYMBOL(snd_ctl_find_id);
542 static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
543 unsigned int cmd, void __user *arg)
545 struct snd_ctl_card_info *info;
547 info = kzalloc(sizeof(*info), GFP_KERNEL);
550 down_read(&snd_ioctl_rwsem);
551 info->card = card->number;
552 strlcpy(info->id, card->id, sizeof(info->id));
553 strlcpy(info->driver, card->driver, sizeof(info->driver));
554 strlcpy(info->name, card->shortname, sizeof(info->name));
555 strlcpy(info->longname, card->longname, sizeof(info->longname));
556 strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
557 strlcpy(info->components, card->components, sizeof(info->components));
558 up_read(&snd_ioctl_rwsem);
559 if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
567 static int snd_ctl_elem_list(struct snd_card *card,
568 struct snd_ctl_elem_list __user *_list)
570 struct list_head *plist;
571 struct snd_ctl_elem_list list;
572 struct snd_kcontrol *kctl;
573 struct snd_ctl_elem_id *dst, *id;
574 unsigned int offset, space, first, jidx;
576 if (copy_from_user(&list, _list, sizeof(list)))
578 offset = list.offset;
581 /* try limit maximum space */
585 /* allocate temporary buffer for atomic operation */
586 dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
589 down_read(&card->controls_rwsem);
590 list.count = card->controls_count;
591 plist = card->controls.next;
592 while (plist != &card->controls) {
595 kctl = snd_kcontrol(plist);
596 if (offset < kctl->count)
598 offset -= kctl->count;
603 while (space > 0 && plist != &card->controls) {
604 kctl = snd_kcontrol(plist);
605 for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
606 snd_ctl_build_ioff(id, kctl, jidx);
614 up_read(&card->controls_rwsem);
616 copy_to_user(list.pids, dst,
617 list.used * sizeof(struct snd_ctl_elem_id))) {
623 down_read(&card->controls_rwsem);
624 list.count = card->controls_count;
625 up_read(&card->controls_rwsem);
627 if (copy_to_user(_list, &list, sizeof(list)))
632 static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
633 struct snd_ctl_elem_info *info)
635 struct snd_card *card = ctl->card;
636 struct snd_kcontrol *kctl;
637 struct snd_kcontrol_volatile *vd;
638 unsigned int index_offset;
641 down_read(&card->controls_rwsem);
642 kctl = snd_ctl_find_id(card, &info->id);
644 up_read(&card->controls_rwsem);
647 #ifdef CONFIG_SND_DEBUG
650 result = kctl->info(kctl, info);
652 snd_assert(info->access == 0, );
653 index_offset = snd_ctl_get_ioff(kctl, &info->id);
654 vd = &kctl->vd[index_offset];
655 snd_ctl_build_ioff(&info->id, kctl, index_offset);
656 info->access = vd->access;
658 info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
659 if (vd->owner == ctl)
660 info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
661 info->owner = vd->owner_pid;
666 up_read(&card->controls_rwsem);
670 static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
671 struct snd_ctl_elem_info __user *_info)
673 struct snd_ctl_elem_info info;
676 if (copy_from_user(&info, _info, sizeof(info)))
678 snd_power_lock(ctl->card);
679 result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
681 result = snd_ctl_elem_info(ctl, &info);
682 snd_power_unlock(ctl->card);
684 if (copy_to_user(_info, &info, sizeof(info)))
689 int snd_ctl_elem_read(struct snd_card *card, struct snd_ctl_elem_value *control)
691 struct snd_kcontrol *kctl;
692 struct snd_kcontrol_volatile *vd;
693 unsigned int index_offset;
694 int result, indirect;
696 down_read(&card->controls_rwsem);
697 kctl = snd_ctl_find_id(card, &control->id);
701 index_offset = snd_ctl_get_ioff(kctl, &control->id);
702 vd = &kctl->vd[index_offset];
703 indirect = vd->access & SNDRV_CTL_ELEM_ACCESS_INDIRECT ? 1 : 0;
704 if (control->indirect != indirect) {
707 if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) && kctl->get != NULL) {
708 snd_ctl_build_ioff(&control->id, kctl, index_offset);
709 result = kctl->get(kctl, control);
715 up_read(&card->controls_rwsem);
719 EXPORT_SYMBOL(snd_ctl_elem_read);
721 static int snd_ctl_elem_read_user(struct snd_card *card,
722 struct snd_ctl_elem_value __user *_control)
724 struct snd_ctl_elem_value *control;
727 control = kmalloc(sizeof(*control), GFP_KERNEL);
730 if (copy_from_user(control, _control, sizeof(*control))) {
734 snd_power_lock(card);
735 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
737 result = snd_ctl_elem_read(card, control);
738 snd_power_unlock(card);
740 if (copy_to_user(_control, control, sizeof(*control)))
746 int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
747 struct snd_ctl_elem_value *control)
749 struct snd_kcontrol *kctl;
750 struct snd_kcontrol_volatile *vd;
751 unsigned int index_offset;
752 int result, indirect;
754 down_read(&card->controls_rwsem);
755 kctl = snd_ctl_find_id(card, &control->id);
759 index_offset = snd_ctl_get_ioff(kctl, &control->id);
760 vd = &kctl->vd[index_offset];
761 indirect = vd->access & SNDRV_CTL_ELEM_ACCESS_INDIRECT ? 1 : 0;
762 if (control->indirect != indirect) {
765 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
767 (file && vd->owner != NULL && vd->owner != file)) {
770 snd_ctl_build_ioff(&control->id, kctl, index_offset);
771 result = kctl->put(kctl, control);
774 up_read(&card->controls_rwsem);
775 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE, &control->id);
780 up_read(&card->controls_rwsem);
784 EXPORT_SYMBOL(snd_ctl_elem_write);
786 static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
787 struct snd_ctl_elem_value __user *_control)
789 struct snd_ctl_elem_value *control;
790 struct snd_card *card;
793 control = kmalloc(sizeof(*control), GFP_KERNEL);
796 if (copy_from_user(control, _control, sizeof(*control))) {
801 snd_power_lock(card);
802 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
804 result = snd_ctl_elem_write(card, file, control);
805 snd_power_unlock(card);
807 if (copy_to_user(_control, control, sizeof(*control)))
813 static int snd_ctl_elem_lock(struct snd_ctl_file *file,
814 struct snd_ctl_elem_id __user *_id)
816 struct snd_card *card = file->card;
817 struct snd_ctl_elem_id id;
818 struct snd_kcontrol *kctl;
819 struct snd_kcontrol_volatile *vd;
822 if (copy_from_user(&id, _id, sizeof(id)))
824 down_write(&card->controls_rwsem);
825 kctl = snd_ctl_find_id(card, &id);
829 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
830 if (vd->owner != NULL)
834 vd->owner_pid = current->pid;
838 up_write(&card->controls_rwsem);
842 static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
843 struct snd_ctl_elem_id __user *_id)
845 struct snd_card *card = file->card;
846 struct snd_ctl_elem_id id;
847 struct snd_kcontrol *kctl;
848 struct snd_kcontrol_volatile *vd;
851 if (copy_from_user(&id, _id, sizeof(id)))
853 down_write(&card->controls_rwsem);
854 kctl = snd_ctl_find_id(card, &id);
858 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
859 if (vd->owner == NULL)
861 else if (vd->owner != file)
869 up_write(&card->controls_rwsem);
873 struct user_element {
874 struct snd_ctl_elem_info info;
875 void *elem_data; /* element data */
876 unsigned long elem_data_size; /* size of element data in bytes */
877 void *tlv_data; /* TLV data */
878 unsigned long tlv_data_size; /* TLV data size */
879 void *priv_data; /* private data (like strings for enumerated type) */
880 unsigned long priv_data_size; /* size of private data in bytes */
883 static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
884 struct snd_ctl_elem_info *uinfo)
886 struct user_element *ue = kcontrol->private_data;
892 static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
893 struct snd_ctl_elem_value *ucontrol)
895 struct user_element *ue = kcontrol->private_data;
897 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
901 static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
902 struct snd_ctl_elem_value *ucontrol)
905 struct user_element *ue = kcontrol->private_data;
907 change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
909 memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
913 static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
916 unsigned int __user *tlv)
918 struct user_element *ue = kcontrol->private_data;
923 if (size > 1024 * 128) /* sane value */
925 new_data = kmalloc(size, GFP_KERNEL);
926 if (new_data == NULL)
928 if (copy_from_user(new_data, tlv, size)) {
932 change = ue->tlv_data_size != size;
934 change = memcmp(ue->tlv_data, new_data, size);
936 ue->tlv_data = new_data;
937 ue->tlv_data_size = size;
939 if (! ue->tlv_data_size || ! ue->tlv_data)
941 if (size < ue->tlv_data_size)
943 if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
949 static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
951 struct user_element *ue = kcontrol->private_data;
957 static int snd_ctl_elem_add(struct snd_ctl_file *file,
958 struct snd_ctl_elem_info *info, int replace)
960 struct snd_card *card = file->card;
961 struct snd_kcontrol kctl, *_kctl;
964 struct user_element *ue;
967 if (card->user_ctl_count >= MAX_USER_CONTROLS)
969 if (info->count > 1024)
971 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
972 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
973 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
974 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
976 memset(&kctl, 0, sizeof(kctl));
977 down_write(&card->controls_rwsem);
978 _kctl = snd_ctl_find_id(card, &info->id);
982 err = snd_ctl_remove(card, _kctl);
989 up_write(&card->controls_rwsem);
992 memcpy(&kctl.id, &info->id, sizeof(info->id));
993 kctl.count = info->owner ? info->owner : 1;
994 access |= SNDRV_CTL_ELEM_ACCESS_USER;
995 kctl.info = snd_ctl_elem_user_info;
996 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
997 kctl.get = snd_ctl_elem_user_get;
998 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
999 kctl.put = snd_ctl_elem_user_put;
1000 if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
1001 kctl.tlv.c = snd_ctl_elem_user_tlv;
1002 access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1004 switch (info->type) {
1005 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
1006 case SNDRV_CTL_ELEM_TYPE_INTEGER:
1007 private_size = sizeof(long);
1008 if (info->count > 128)
1011 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1012 private_size = sizeof(long long);
1013 if (info->count > 64)
1016 case SNDRV_CTL_ELEM_TYPE_BYTES:
1017 private_size = sizeof(unsigned char);
1018 if (info->count > 512)
1021 case SNDRV_CTL_ELEM_TYPE_IEC958:
1022 private_size = sizeof(struct snd_aes_iec958);
1023 if (info->count != 1)
1029 private_size *= info->count;
1030 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
1034 ue->info.access = 0;
1035 ue->elem_data = (char *)ue + sizeof(*ue);
1036 ue->elem_data_size = private_size;
1037 kctl.private_free = snd_ctl_elem_user_free;
1038 _kctl = snd_ctl_new(&kctl, access);
1039 if (_kctl == NULL) {
1043 _kctl->private_data = ue;
1044 for (idx = 0; idx < _kctl->count; idx++)
1045 _kctl->vd[idx].owner = file;
1046 err = snd_ctl_add(card, _kctl);
1050 down_write(&card->controls_rwsem);
1051 card->user_ctl_count++;
1052 up_write(&card->controls_rwsem);
1057 static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1058 struct snd_ctl_elem_info __user *_info, int replace)
1060 struct snd_ctl_elem_info info;
1061 if (copy_from_user(&info, _info, sizeof(info)))
1063 return snd_ctl_elem_add(file, &info, replace);
1066 static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1067 struct snd_ctl_elem_id __user *_id)
1069 struct snd_ctl_elem_id id;
1072 if (copy_from_user(&id, _id, sizeof(id)))
1074 err = snd_ctl_remove_unlocked_id(file, &id);
1076 struct snd_card *card = file->card;
1077 down_write(&card->controls_rwsem);
1078 card->user_ctl_count--;
1079 up_write(&card->controls_rwsem);
1084 static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
1087 if (get_user(subscribe, ptr))
1089 if (subscribe < 0) {
1090 subscribe = file->subscribed;
1091 if (put_user(subscribe, ptr))
1096 file->subscribed = 1;
1098 } else if (file->subscribed) {
1099 snd_ctl_empty_read_queue(file);
1100 file->subscribed = 0;
1105 static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1106 struct snd_ctl_tlv __user *_tlv,
1109 struct snd_card *card = file->card;
1110 struct snd_ctl_tlv tlv;
1111 struct snd_kcontrol *kctl;
1112 struct snd_kcontrol_volatile *vd;
1116 if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1118 if (tlv.length < sizeof(unsigned int) * 3)
1120 down_read(&card->controls_rwsem);
1121 kctl = snd_ctl_find_numid(card, tlv.numid);
1126 if (kctl->tlv.p == NULL) {
1130 vd = &kctl->vd[tlv.numid - kctl->id.numid];
1131 if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1132 (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1133 (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1137 if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
1138 if (file && vd->owner != NULL && vd->owner != file) {
1142 err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
1144 up_read(&card->controls_rwsem);
1145 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &kctl->id);
1153 len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1154 if (tlv.length < len) {
1158 if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1162 up_read(&card->controls_rwsem);
1166 static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1168 struct snd_ctl_file *ctl;
1169 struct snd_card *card;
1170 struct snd_kctl_ioctl *p;
1171 void __user *argp = (void __user *)arg;
1172 int __user *ip = argp;
1175 ctl = file->private_data;
1177 snd_assert(card != NULL, return -ENXIO);
1179 case SNDRV_CTL_IOCTL_PVERSION:
1180 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1181 case SNDRV_CTL_IOCTL_CARD_INFO:
1182 return snd_ctl_card_info(card, ctl, cmd, argp);
1183 case SNDRV_CTL_IOCTL_ELEM_LIST:
1184 return snd_ctl_elem_list(card, argp);
1185 case SNDRV_CTL_IOCTL_ELEM_INFO:
1186 return snd_ctl_elem_info_user(ctl, argp);
1187 case SNDRV_CTL_IOCTL_ELEM_READ:
1188 return snd_ctl_elem_read_user(card, argp);
1189 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1190 return snd_ctl_elem_write_user(ctl, argp);
1191 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1192 return snd_ctl_elem_lock(ctl, argp);
1193 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1194 return snd_ctl_elem_unlock(ctl, argp);
1195 case SNDRV_CTL_IOCTL_ELEM_ADD:
1196 return snd_ctl_elem_add_user(ctl, argp, 0);
1197 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1198 return snd_ctl_elem_add_user(ctl, argp, 1);
1199 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1200 return snd_ctl_elem_remove(ctl, argp);
1201 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1202 return snd_ctl_subscribe_events(ctl, ip);
1203 case SNDRV_CTL_IOCTL_TLV_READ:
1204 return snd_ctl_tlv_ioctl(ctl, argp, 0);
1205 case SNDRV_CTL_IOCTL_TLV_WRITE:
1206 return snd_ctl_tlv_ioctl(ctl, argp, 1);
1207 case SNDRV_CTL_IOCTL_TLV_COMMAND:
1208 return snd_ctl_tlv_ioctl(ctl, argp, -1);
1209 case SNDRV_CTL_IOCTL_POWER:
1210 return -ENOPROTOOPT;
1211 case SNDRV_CTL_IOCTL_POWER_STATE:
1213 return put_user(card->power_state, ip) ? -EFAULT : 0;
1215 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1218 down_read(&snd_ioctl_rwsem);
1219 list_for_each_entry(p, &snd_control_ioctls, list) {
1220 err = p->fioctl(card, ctl, cmd, arg);
1221 if (err != -ENOIOCTLCMD) {
1222 up_read(&snd_ioctl_rwsem);
1226 up_read(&snd_ioctl_rwsem);
1227 snd_printdd("unknown ioctl = 0x%x\n", cmd);
1231 static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1232 size_t count, loff_t * offset)
1234 struct snd_ctl_file *ctl;
1238 ctl = file->private_data;
1239 snd_assert(ctl != NULL && ctl->card != NULL, return -ENXIO);
1240 if (!ctl->subscribed)
1242 if (count < sizeof(struct snd_ctl_event))
1244 spin_lock_irq(&ctl->read_lock);
1245 while (count >= sizeof(struct snd_ctl_event)) {
1246 struct snd_ctl_event ev;
1247 struct snd_kctl_event *kev;
1248 while (list_empty(&ctl->events)) {
1250 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1254 init_waitqueue_entry(&wait, current);
1255 add_wait_queue(&ctl->change_sleep, &wait);
1256 set_current_state(TASK_INTERRUPTIBLE);
1257 spin_unlock_irq(&ctl->read_lock);
1259 remove_wait_queue(&ctl->change_sleep, &wait);
1260 if (signal_pending(current))
1261 return -ERESTARTSYS;
1262 spin_lock_irq(&ctl->read_lock);
1264 kev = snd_kctl_event(ctl->events.next);
1265 ev.type = SNDRV_CTL_EVENT_ELEM;
1266 ev.data.elem.mask = kev->mask;
1267 ev.data.elem.id = kev->id;
1268 list_del(&kev->list);
1269 spin_unlock_irq(&ctl->read_lock);
1271 if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
1275 spin_lock_irq(&ctl->read_lock);
1276 buffer += sizeof(struct snd_ctl_event);
1277 count -= sizeof(struct snd_ctl_event);
1278 result += sizeof(struct snd_ctl_event);
1281 spin_unlock_irq(&ctl->read_lock);
1283 return result > 0 ? result : err;
1286 static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1289 struct snd_ctl_file *ctl;
1291 ctl = file->private_data;
1292 if (!ctl->subscribed)
1294 poll_wait(file, &ctl->change_sleep, wait);
1297 if (!list_empty(&ctl->events))
1298 mask |= POLLIN | POLLRDNORM;
1304 * register the device-specific control-ioctls.
1305 * called from each device manager like pcm.c, hwdep.c, etc.
1307 static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1309 struct snd_kctl_ioctl *pn;
1311 pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
1315 down_write(&snd_ioctl_rwsem);
1316 list_add_tail(&pn->list, lists);
1317 up_write(&snd_ioctl_rwsem);
1321 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1323 return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1326 EXPORT_SYMBOL(snd_ctl_register_ioctl);
1328 #ifdef CONFIG_COMPAT
1329 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1331 return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1334 EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
1338 * de-register the device-specific control-ioctls.
1340 static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1341 struct list_head *lists)
1343 struct snd_kctl_ioctl *p;
1345 snd_assert(fcn != NULL, return -EINVAL);
1346 down_write(&snd_ioctl_rwsem);
1347 list_for_each_entry(p, lists, list) {
1348 if (p->fioctl == fcn) {
1350 up_write(&snd_ioctl_rwsem);
1355 up_write(&snd_ioctl_rwsem);
1360 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1362 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1365 EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1367 #ifdef CONFIG_COMPAT
1368 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1370 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1373 EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
1376 static int snd_ctl_fasync(int fd, struct file * file, int on)
1378 struct snd_ctl_file *ctl;
1380 ctl = file->private_data;
1381 err = fasync_helper(fd, file, on, &ctl->fasync);
1390 #ifdef CONFIG_COMPAT
1391 #include "control_compat.c"
1393 #define snd_ctl_ioctl_compat NULL
1400 static const struct file_operations snd_ctl_f_ops =
1402 .owner = THIS_MODULE,
1403 .read = snd_ctl_read,
1404 .open = snd_ctl_open,
1405 .release = snd_ctl_release,
1406 .poll = snd_ctl_poll,
1407 .unlocked_ioctl = snd_ctl_ioctl,
1408 .compat_ioctl = snd_ctl_ioctl_compat,
1409 .fasync = snd_ctl_fasync,
1413 * registration of the control device
1415 static int snd_ctl_dev_register(struct snd_device *device)
1417 struct snd_card *card = device->device_data;
1421 snd_assert(card != NULL, return -ENXIO);
1422 cardnum = card->number;
1423 snd_assert(cardnum >= 0 && cardnum < SNDRV_CARDS, return -ENXIO);
1424 sprintf(name, "controlC%i", cardnum);
1425 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1426 &snd_ctl_f_ops, card, name)) < 0)
1432 * disconnection of the control device
1434 static int snd_ctl_dev_disconnect(struct snd_device *device)
1436 struct snd_card *card = device->device_data;
1437 struct snd_ctl_file *ctl;
1440 snd_assert(card != NULL, return -ENXIO);
1441 cardnum = card->number;
1442 snd_assert(cardnum >= 0 && cardnum < SNDRV_CARDS, return -ENXIO);
1444 down_read(&card->controls_rwsem);
1445 list_for_each_entry(ctl, &card->ctl_files, list) {
1446 wake_up(&ctl->change_sleep);
1447 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1449 up_read(&card->controls_rwsem);
1451 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1460 static int snd_ctl_dev_free(struct snd_device *device)
1462 struct snd_card *card = device->device_data;
1463 struct snd_kcontrol *control;
1465 down_write(&card->controls_rwsem);
1466 while (!list_empty(&card->controls)) {
1467 control = snd_kcontrol(card->controls.next);
1468 snd_ctl_remove(card, control);
1470 up_write(&card->controls_rwsem);
1475 * create control core:
1476 * called from init.c
1478 int snd_ctl_create(struct snd_card *card)
1480 static struct snd_device_ops ops = {
1481 .dev_free = snd_ctl_dev_free,
1482 .dev_register = snd_ctl_dev_register,
1483 .dev_disconnect = snd_ctl_dev_disconnect,
1486 snd_assert(card != NULL, return -ENXIO);
1487 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);