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/smp_lock.h>
26 #include <linux/slab.h>
27 #include <linux/vmalloc.h>
28 #include <linux/time.h>
29 #include <sound/core.h>
30 #include <sound/minors.h>
31 #include <sound/info.h>
32 #include <sound/control.h>
34 /* max number of user-defined controls */
35 #define MAX_USER_CONTROLS 32
37 struct snd_kctl_ioctl {
38 struct list_head list; /* list of all ioctls */
39 snd_kctl_ioctl_func_t fioctl;
42 static DECLARE_RWSEM(snd_ioctl_rwsem);
43 static LIST_HEAD(snd_control_ioctls);
45 static LIST_HEAD(snd_control_compat_ioctls);
48 static int snd_ctl_open(struct inode *inode, struct file *file)
51 struct snd_card *card;
52 struct snd_ctl_file *ctl;
55 card = snd_lookup_minor_data(iminor(inode), SNDRV_DEVICE_TYPE_CONTROL);
60 err = snd_card_file_add(card, file);
65 if (!try_module_get(card->module)) {
69 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
74 INIT_LIST_HEAD(&ctl->events);
75 init_waitqueue_head(&ctl->change_sleep);
76 spin_lock_init(&ctl->read_lock);
78 ctl->pid = current->pid;
79 file->private_data = ctl;
80 write_lock_irqsave(&card->ctl_files_rwlock, flags);
81 list_add_tail(&ctl->list, &card->ctl_files);
82 write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
86 module_put(card->module);
88 snd_card_file_remove(card, file);
93 static void snd_ctl_empty_read_queue(struct snd_ctl_file * ctl)
95 struct snd_kctl_event *cread;
97 spin_lock(&ctl->read_lock);
98 while (!list_empty(&ctl->events)) {
99 cread = snd_kctl_event(ctl->events.next);
100 list_del(&cread->list);
103 spin_unlock(&ctl->read_lock);
106 static int snd_ctl_release(struct inode *inode, struct file *file)
109 struct list_head *list;
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(list, &card->controls) {
124 control = snd_kcontrol(list);
125 for (idx = 0; idx < control->count; idx++)
126 if (control->vd[idx].owner == ctl)
127 control->vd[idx].owner = NULL;
129 up_write(&card->controls_rwsem);
130 snd_ctl_empty_read_queue(ctl);
132 module_put(card->module);
133 snd_card_file_remove(card, file);
137 void snd_ctl_notify(struct snd_card *card, unsigned int mask,
138 struct snd_ctl_elem_id *id)
141 struct list_head *flist;
142 struct snd_ctl_file *ctl;
143 struct snd_kctl_event *ev;
145 snd_assert(card != NULL && id != NULL, return);
146 read_lock(&card->ctl_files_rwlock);
147 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
148 card->mixer_oss_change_count++;
150 list_for_each(flist, &card->ctl_files) {
151 struct list_head *elist;
152 ctl = snd_ctl_file(flist);
153 if (!ctl->subscribed)
155 spin_lock_irqsave(&ctl->read_lock, flags);
156 list_for_each(elist, &ctl->events) {
157 ev = snd_kctl_event(elist);
158 if (ev->id.numid == id->numid) {
163 ev = kzalloc(sizeof(*ev), GFP_ATOMIC);
167 list_add_tail(&ev->list, &ctl->events);
169 snd_printk(KERN_ERR "No memory available to allocate event\n");
172 wake_up(&ctl->change_sleep);
173 spin_unlock_irqrestore(&ctl->read_lock, flags);
174 kill_fasync(&ctl->fasync, SIGIO, POLL_IN);
176 read_unlock(&card->ctl_files_rwlock);
180 * snd_ctl_new - create a control instance from the template
181 * @control: the control template
182 * @access: the default control access
184 * Allocates a new struct snd_kcontrol instance and copies the given template
185 * to the new instance. It does not copy volatile data (access).
187 * Returns the pointer of the new instance, or NULL on failure.
189 struct snd_kcontrol *snd_ctl_new(struct snd_kcontrol *control, unsigned int access)
191 struct snd_kcontrol *kctl;
194 snd_assert(control != NULL, return NULL);
195 snd_assert(control->count > 0, return NULL);
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|SNDRV_CTL_ELEM_ACCESS_INACTIVE|
236 SNDRV_CTL_ELEM_ACCESS_DINDIRECT|SNDRV_CTL_ELEM_ACCESS_INDIRECT));
237 kctl.info = ncontrol->info;
238 kctl.get = ncontrol->get;
239 kctl.put = ncontrol->put;
240 kctl.private_value = ncontrol->private_value;
241 kctl.private_data = private_data;
242 return snd_ctl_new(&kctl, access);
246 * snd_ctl_free_one - release the control instance
247 * @kcontrol: the control instance
249 * Releases the control instance created via snd_ctl_new()
251 * Don't call this after the control was added to the card.
253 void snd_ctl_free_one(struct snd_kcontrol *kcontrol)
256 if (kcontrol->private_free)
257 kcontrol->private_free(kcontrol);
262 static unsigned int snd_ctl_hole_check(struct snd_card *card,
265 struct list_head *list;
266 struct snd_kcontrol *kctl;
268 list_for_each(list, &card->controls) {
269 kctl = snd_kcontrol(list);
270 if ((kctl->id.numid <= card->last_numid &&
271 kctl->id.numid + kctl->count > card->last_numid) ||
272 (kctl->id.numid <= card->last_numid + count - 1 &&
273 kctl->id.numid + kctl->count > card->last_numid + count - 1))
274 return card->last_numid = kctl->id.numid + kctl->count - 1;
276 return card->last_numid;
279 static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
281 unsigned int last_numid, iter = 100000;
283 last_numid = card->last_numid;
284 while (last_numid != snd_ctl_hole_check(card, count)) {
286 /* this situation is very unlikely */
287 snd_printk(KERN_ERR "unable to allocate new control numid\n");
290 last_numid = card->last_numid;
296 * snd_ctl_add - add the control instance to the card
297 * @card: the card instance
298 * @kcontrol: the control instance to add
300 * Adds the control instance created via snd_ctl_new() or
301 * snd_ctl_new1() to the given card. Assigns also an unique
302 * numid used for fast search.
304 * Returns zero if successful, or a negative error code on failure.
306 * It frees automatically the control which cannot be added.
308 int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
310 struct snd_ctl_elem_id id;
316 snd_assert(card != NULL, goto error);
317 snd_assert(kcontrol->info != NULL, goto error);
319 down_write(&card->controls_rwsem);
320 if (snd_ctl_find_id(card, &id)) {
321 up_write(&card->controls_rwsem);
322 snd_printd(KERN_ERR "control %i:%i:%i:%s:%i is already present\n",
331 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
332 up_write(&card->controls_rwsem);
336 list_add_tail(&kcontrol->list, &card->controls);
337 card->controls_count += kcontrol->count;
338 kcontrol->id.numid = card->last_numid + 1;
339 card->last_numid += kcontrol->count;
340 up_write(&card->controls_rwsem);
341 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
342 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
346 snd_ctl_free_one(kcontrol);
351 * snd_ctl_remove - remove the control from the card and release it
352 * @card: the card instance
353 * @kcontrol: the control instance to remove
355 * Removes the control from the card and then releases the instance.
356 * You don't need to call snd_ctl_free_one(). You must be in
357 * the write lock - down_write(&card->controls_rwsem).
359 * Returns 0 if successful, or a negative error code on failure.
361 int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
363 struct snd_ctl_elem_id id;
366 snd_assert(card != NULL && kcontrol != NULL, return -EINVAL);
367 list_del(&kcontrol->list);
368 card->controls_count -= kcontrol->count;
370 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
371 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
372 snd_ctl_free_one(kcontrol);
377 * snd_ctl_remove_id - remove the control of the given id and release it
378 * @card: the card instance
379 * @id: the control id to remove
381 * Finds the control instance with the given id, removes it from the
382 * card list and releases it.
384 * Returns 0 if successful, or a negative error code on failure.
386 int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
388 struct snd_kcontrol *kctl;
391 down_write(&card->controls_rwsem);
392 kctl = snd_ctl_find_id(card, id);
394 up_write(&card->controls_rwsem);
397 ret = snd_ctl_remove(card, kctl);
398 up_write(&card->controls_rwsem);
403 * snd_ctl_remove_unlocked_id - remove the unlocked control of the given id and release it
404 * @file: active control handle
405 * @id: the control id to remove
407 * Finds the control instance with the given id, removes it from the
408 * card list and releases it.
410 * Returns 0 if successful, or a negative error code on failure.
412 static int snd_ctl_remove_unlocked_id(struct snd_ctl_file * file,
413 struct snd_ctl_elem_id *id)
415 struct snd_card *card = file->card;
416 struct snd_kcontrol *kctl;
419 down_write(&card->controls_rwsem);
420 kctl = snd_ctl_find_id(card, id);
422 up_write(&card->controls_rwsem);
425 for (idx = 0; idx < kctl->count; idx++)
426 if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
427 up_write(&card->controls_rwsem);
430 ret = snd_ctl_remove(card, kctl);
431 up_write(&card->controls_rwsem);
436 * snd_ctl_rename_id - replace the id of a control on the card
437 * @card: the card instance
438 * @src_id: the old id
439 * @dst_id: the new id
441 * Finds the control with the old id from the card, and replaces the
442 * id with the new one.
444 * Returns zero if successful, or a negative error code on failure.
446 int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
447 struct snd_ctl_elem_id *dst_id)
449 struct snd_kcontrol *kctl;
451 down_write(&card->controls_rwsem);
452 kctl = snd_ctl_find_id(card, src_id);
454 up_write(&card->controls_rwsem);
458 kctl->id.numid = card->last_numid + 1;
459 card->last_numid += kctl->count;
460 up_write(&card->controls_rwsem);
465 * snd_ctl_find_numid - find the control instance with the given number-id
466 * @card: the card instance
467 * @numid: the number-id to search
469 * Finds the control instance with the given number-id from the card.
471 * Returns the pointer of the instance if found, or NULL if not.
473 * The caller must down card->controls_rwsem before calling this function
474 * (if the race condition can happen).
476 struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
478 struct list_head *list;
479 struct snd_kcontrol *kctl;
481 snd_assert(card != NULL && numid != 0, return NULL);
482 list_for_each(list, &card->controls) {
483 kctl = snd_kcontrol(list);
484 if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
491 * snd_ctl_find_id - find the control instance with the given id
492 * @card: the card instance
493 * @id: the id to search
495 * Finds the control instance with the given id from the card.
497 * Returns the pointer of the instance if found, or NULL if not.
499 * The caller must down card->controls_rwsem before calling this function
500 * (if the race condition can happen).
502 struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
503 struct snd_ctl_elem_id *id)
505 struct list_head *list;
506 struct snd_kcontrol *kctl;
508 snd_assert(card != NULL && id != NULL, return NULL);
510 return snd_ctl_find_numid(card, id->numid);
511 list_for_each(list, &card->controls) {
512 kctl = snd_kcontrol(list);
513 if (kctl->id.iface != id->iface)
515 if (kctl->id.device != id->device)
517 if (kctl->id.subdevice != id->subdevice)
519 if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
521 if (kctl->id.index > id->index)
523 if (kctl->id.index + kctl->count <= id->index)
530 static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
531 unsigned int cmd, void __user *arg)
533 struct snd_ctl_card_info *info;
535 info = kzalloc(sizeof(*info), GFP_KERNEL);
538 down_read(&snd_ioctl_rwsem);
539 info->card = card->number;
540 strlcpy(info->id, card->id, sizeof(info->id));
541 strlcpy(info->driver, card->driver, sizeof(info->driver));
542 strlcpy(info->name, card->shortname, sizeof(info->name));
543 strlcpy(info->longname, card->longname, sizeof(info->longname));
544 strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
545 strlcpy(info->components, card->components, sizeof(info->components));
546 up_read(&snd_ioctl_rwsem);
547 if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
555 static int snd_ctl_elem_list(struct snd_card *card,
556 struct snd_ctl_elem_list __user *_list)
558 struct list_head *plist;
559 struct snd_ctl_elem_list list;
560 struct snd_kcontrol *kctl;
561 struct snd_ctl_elem_id *dst, *id;
562 unsigned int offset, space, first, jidx;
564 if (copy_from_user(&list, _list, sizeof(list)))
566 offset = list.offset;
569 /* try limit maximum space */
573 /* allocate temporary buffer for atomic operation */
574 dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
577 down_read(&card->controls_rwsem);
578 list.count = card->controls_count;
579 plist = card->controls.next;
580 while (plist != &card->controls) {
583 kctl = snd_kcontrol(plist);
584 if (offset < kctl->count)
586 offset -= kctl->count;
591 while (space > 0 && plist != &card->controls) {
592 kctl = snd_kcontrol(plist);
593 for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
594 snd_ctl_build_ioff(id, kctl, jidx);
602 up_read(&card->controls_rwsem);
604 copy_to_user(list.pids, dst,
605 list.used * sizeof(struct snd_ctl_elem_id))) {
611 down_read(&card->controls_rwsem);
612 list.count = card->controls_count;
613 up_read(&card->controls_rwsem);
615 if (copy_to_user(_list, &list, sizeof(list)))
620 static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
621 struct snd_ctl_elem_info *info)
623 struct snd_card *card = ctl->card;
624 struct snd_kcontrol *kctl;
625 struct snd_kcontrol_volatile *vd;
626 unsigned int index_offset;
629 down_read(&card->controls_rwsem);
630 kctl = snd_ctl_find_id(card, &info->id);
632 up_read(&card->controls_rwsem);
635 #ifdef CONFIG_SND_DEBUG
638 result = kctl->info(kctl, info);
640 snd_assert(info->access == 0, );
641 index_offset = snd_ctl_get_ioff(kctl, &info->id);
642 vd = &kctl->vd[index_offset];
643 snd_ctl_build_ioff(&info->id, kctl, index_offset);
644 info->access = vd->access;
646 info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
647 if (vd->owner == ctl)
648 info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
649 info->owner = vd->owner_pid;
654 up_read(&card->controls_rwsem);
658 static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
659 struct snd_ctl_elem_info __user *_info)
661 struct snd_ctl_elem_info info;
664 if (copy_from_user(&info, _info, sizeof(info)))
666 snd_power_lock(ctl->card);
667 result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
669 result = snd_ctl_elem_info(ctl, &info);
670 snd_power_unlock(ctl->card);
672 if (copy_to_user(_info, &info, sizeof(info)))
677 int snd_ctl_elem_read(struct snd_card *card, struct snd_ctl_elem_value *control)
679 struct snd_kcontrol *kctl;
680 struct snd_kcontrol_volatile *vd;
681 unsigned int index_offset;
682 int result, indirect;
684 down_read(&card->controls_rwsem);
685 kctl = snd_ctl_find_id(card, &control->id);
689 index_offset = snd_ctl_get_ioff(kctl, &control->id);
690 vd = &kctl->vd[index_offset];
691 indirect = vd->access & SNDRV_CTL_ELEM_ACCESS_INDIRECT ? 1 : 0;
692 if (control->indirect != indirect) {
695 if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) && kctl->get != NULL) {
696 snd_ctl_build_ioff(&control->id, kctl, index_offset);
697 result = kctl->get(kctl, control);
703 up_read(&card->controls_rwsem);
707 static int snd_ctl_elem_read_user(struct snd_card *card,
708 struct snd_ctl_elem_value __user *_control)
710 struct snd_ctl_elem_value *control;
713 control = kmalloc(sizeof(*control), GFP_KERNEL);
716 if (copy_from_user(control, _control, sizeof(*control))) {
720 snd_power_lock(card);
721 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
723 result = snd_ctl_elem_read(card, control);
724 snd_power_unlock(card);
726 if (copy_to_user(_control, control, sizeof(*control)))
732 int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
733 struct snd_ctl_elem_value *control)
735 struct snd_kcontrol *kctl;
736 struct snd_kcontrol_volatile *vd;
737 unsigned int index_offset;
738 int result, indirect;
740 down_read(&card->controls_rwsem);
741 kctl = snd_ctl_find_id(card, &control->id);
745 index_offset = snd_ctl_get_ioff(kctl, &control->id);
746 vd = &kctl->vd[index_offset];
747 indirect = vd->access & SNDRV_CTL_ELEM_ACCESS_INDIRECT ? 1 : 0;
748 if (control->indirect != indirect) {
751 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
753 (file && vd->owner != NULL && vd->owner != file)) {
756 snd_ctl_build_ioff(&control->id, kctl, index_offset);
757 result = kctl->put(kctl, control);
760 up_read(&card->controls_rwsem);
761 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE, &control->id);
766 up_read(&card->controls_rwsem);
770 static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
771 struct snd_ctl_elem_value __user *_control)
773 struct snd_ctl_elem_value *control;
774 struct snd_card *card;
777 control = kmalloc(sizeof(*control), GFP_KERNEL);
780 if (copy_from_user(control, _control, sizeof(*control))) {
785 snd_power_lock(card);
786 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
788 result = snd_ctl_elem_write(card, file, control);
789 snd_power_unlock(card);
791 if (copy_to_user(_control, control, sizeof(*control)))
797 static int snd_ctl_elem_lock(struct snd_ctl_file *file,
798 struct snd_ctl_elem_id __user *_id)
800 struct snd_card *card = file->card;
801 struct snd_ctl_elem_id id;
802 struct snd_kcontrol *kctl;
803 struct snd_kcontrol_volatile *vd;
806 if (copy_from_user(&id, _id, sizeof(id)))
808 down_write(&card->controls_rwsem);
809 kctl = snd_ctl_find_id(card, &id);
813 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
814 if (vd->owner != NULL)
818 vd->owner_pid = current->pid;
822 up_write(&card->controls_rwsem);
826 static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
827 struct snd_ctl_elem_id __user *_id)
829 struct snd_card *card = file->card;
830 struct snd_ctl_elem_id id;
831 struct snd_kcontrol *kctl;
832 struct snd_kcontrol_volatile *vd;
835 if (copy_from_user(&id, _id, sizeof(id)))
837 down_write(&card->controls_rwsem);
838 kctl = snd_ctl_find_id(card, &id);
842 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
843 if (vd->owner == NULL)
845 else if (vd->owner != file)
853 up_write(&card->controls_rwsem);
857 struct user_element {
858 struct snd_ctl_elem_info info;
859 void *elem_data; /* element data */
860 unsigned long elem_data_size; /* size of element data in bytes */
861 void *priv_data; /* private data (like strings for enumerated type) */
862 unsigned long priv_data_size; /* size of private data in bytes */
865 static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
866 struct snd_ctl_elem_info *uinfo)
868 struct user_element *ue = kcontrol->private_data;
874 static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
875 struct snd_ctl_elem_value *ucontrol)
877 struct user_element *ue = kcontrol->private_data;
879 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
883 static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
884 struct snd_ctl_elem_value *ucontrol)
887 struct user_element *ue = kcontrol->private_data;
889 change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
891 memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
895 static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
897 kfree(kcontrol->private_data);
900 static int snd_ctl_elem_add(struct snd_ctl_file *file,
901 struct snd_ctl_elem_info *info, int replace)
903 struct snd_card *card = file->card;
904 struct snd_kcontrol kctl, *_kctl;
907 struct user_element *ue;
910 if (card->user_ctl_count >= MAX_USER_CONTROLS)
912 if (info->count > 1024)
914 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
915 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
916 SNDRV_CTL_ELEM_ACCESS_INACTIVE));
918 memset(&kctl, 0, sizeof(kctl));
919 down_write(&card->controls_rwsem);
920 _kctl = snd_ctl_find_id(card, &info->id);
924 err = snd_ctl_remove(card, _kctl);
931 up_write(&card->controls_rwsem);
934 memcpy(&kctl.id, &info->id, sizeof(info->id));
935 kctl.count = info->owner ? info->owner : 1;
936 access |= SNDRV_CTL_ELEM_ACCESS_USER;
937 kctl.info = snd_ctl_elem_user_info;
938 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
939 kctl.get = snd_ctl_elem_user_get;
940 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
941 kctl.put = snd_ctl_elem_user_put;
942 switch (info->type) {
943 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
944 private_size = sizeof(char);
945 if (info->count > 128)
948 case SNDRV_CTL_ELEM_TYPE_INTEGER:
949 private_size = sizeof(long);
950 if (info->count > 128)
953 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
954 private_size = sizeof(long long);
955 if (info->count > 64)
958 case SNDRV_CTL_ELEM_TYPE_BYTES:
959 private_size = sizeof(unsigned char);
960 if (info->count > 512)
963 case SNDRV_CTL_ELEM_TYPE_IEC958:
964 private_size = sizeof(struct snd_aes_iec958);
965 if (info->count != 1)
971 private_size *= info->count;
972 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
976 ue->elem_data = (char *)ue + sizeof(*ue);
977 ue->elem_data_size = private_size;
978 kctl.private_free = snd_ctl_elem_user_free;
979 _kctl = snd_ctl_new(&kctl, access);
984 _kctl->private_data = ue;
985 for (idx = 0; idx < _kctl->count; idx++)
986 _kctl->vd[idx].owner = file;
987 err = snd_ctl_add(card, _kctl);
991 down_write(&card->controls_rwsem);
992 card->user_ctl_count++;
993 up_write(&card->controls_rwsem);
998 static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
999 struct snd_ctl_elem_info __user *_info, int replace)
1001 struct snd_ctl_elem_info info;
1002 if (copy_from_user(&info, _info, sizeof(info)))
1004 return snd_ctl_elem_add(file, &info, replace);
1007 static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1008 struct snd_ctl_elem_id __user *_id)
1010 struct snd_ctl_elem_id id;
1013 if (copy_from_user(&id, _id, sizeof(id)))
1015 err = snd_ctl_remove_unlocked_id(file, &id);
1017 struct snd_card *card = file->card;
1018 down_write(&card->controls_rwsem);
1019 card->user_ctl_count--;
1020 up_write(&card->controls_rwsem);
1025 static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
1028 if (get_user(subscribe, ptr))
1030 if (subscribe < 0) {
1031 subscribe = file->subscribed;
1032 if (put_user(subscribe, ptr))
1037 file->subscribed = 1;
1039 } else if (file->subscribed) {
1040 snd_ctl_empty_read_queue(file);
1041 file->subscribed = 0;
1046 static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1048 struct snd_ctl_file *ctl;
1049 struct snd_card *card;
1050 struct list_head *list;
1051 struct snd_kctl_ioctl *p;
1052 void __user *argp = (void __user *)arg;
1053 int __user *ip = argp;
1056 ctl = file->private_data;
1058 snd_assert(card != NULL, return -ENXIO);
1060 case SNDRV_CTL_IOCTL_PVERSION:
1061 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1062 case SNDRV_CTL_IOCTL_CARD_INFO:
1063 return snd_ctl_card_info(card, ctl, cmd, argp);
1064 case SNDRV_CTL_IOCTL_ELEM_LIST:
1065 return snd_ctl_elem_list(ctl->card, argp);
1066 case SNDRV_CTL_IOCTL_ELEM_INFO:
1067 return snd_ctl_elem_info_user(ctl, argp);
1068 case SNDRV_CTL_IOCTL_ELEM_READ:
1069 return snd_ctl_elem_read_user(ctl->card, argp);
1070 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1071 return snd_ctl_elem_write_user(ctl, argp);
1072 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1073 return snd_ctl_elem_lock(ctl, argp);
1074 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1075 return snd_ctl_elem_unlock(ctl, argp);
1076 case SNDRV_CTL_IOCTL_ELEM_ADD:
1077 return snd_ctl_elem_add_user(ctl, argp, 0);
1078 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1079 return snd_ctl_elem_add_user(ctl, argp, 1);
1080 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1081 return snd_ctl_elem_remove(ctl, argp);
1082 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1083 return snd_ctl_subscribe_events(ctl, ip);
1084 case SNDRV_CTL_IOCTL_POWER:
1085 return -ENOPROTOOPT;
1086 case SNDRV_CTL_IOCTL_POWER_STATE:
1088 return put_user(card->power_state, ip) ? -EFAULT : 0;
1090 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1093 down_read(&snd_ioctl_rwsem);
1094 list_for_each(list, &snd_control_ioctls) {
1095 p = list_entry(list, struct snd_kctl_ioctl, list);
1096 err = p->fioctl(card, ctl, cmd, arg);
1097 if (err != -ENOIOCTLCMD) {
1098 up_read(&snd_ioctl_rwsem);
1102 up_read(&snd_ioctl_rwsem);
1103 snd_printdd("unknown ioctl = 0x%x\n", cmd);
1107 static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1108 size_t count, loff_t * offset)
1110 struct snd_ctl_file *ctl;
1114 ctl = file->private_data;
1115 snd_assert(ctl != NULL && ctl->card != NULL, return -ENXIO);
1116 if (!ctl->subscribed)
1118 if (count < sizeof(struct snd_ctl_event))
1120 spin_lock_irq(&ctl->read_lock);
1121 while (count >= sizeof(struct snd_ctl_event)) {
1122 struct snd_ctl_event ev;
1123 struct snd_kctl_event *kev;
1124 while (list_empty(&ctl->events)) {
1126 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1130 init_waitqueue_entry(&wait, current);
1131 add_wait_queue(&ctl->change_sleep, &wait);
1132 set_current_state(TASK_INTERRUPTIBLE);
1133 spin_unlock_irq(&ctl->read_lock);
1135 remove_wait_queue(&ctl->change_sleep, &wait);
1136 if (signal_pending(current))
1137 return result > 0 ? result : -ERESTARTSYS;
1138 spin_lock_irq(&ctl->read_lock);
1140 kev = snd_kctl_event(ctl->events.next);
1141 ev.type = SNDRV_CTL_EVENT_ELEM;
1142 ev.data.elem.mask = kev->mask;
1143 ev.data.elem.id = kev->id;
1144 list_del(&kev->list);
1145 spin_unlock_irq(&ctl->read_lock);
1147 if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
1151 spin_lock_irq(&ctl->read_lock);
1152 buffer += sizeof(struct snd_ctl_event);
1153 count -= sizeof(struct snd_ctl_event);
1154 result += sizeof(struct snd_ctl_event);
1157 spin_unlock_irq(&ctl->read_lock);
1159 return result > 0 ? result : err;
1162 static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1165 struct snd_ctl_file *ctl;
1167 ctl = file->private_data;
1168 if (!ctl->subscribed)
1170 poll_wait(file, &ctl->change_sleep, wait);
1173 if (!list_empty(&ctl->events))
1174 mask |= POLLIN | POLLRDNORM;
1180 * register the device-specific control-ioctls.
1181 * called from each device manager like pcm.c, hwdep.c, etc.
1183 static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1185 struct snd_kctl_ioctl *pn;
1187 pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
1191 down_write(&snd_ioctl_rwsem);
1192 list_add_tail(&pn->list, lists);
1193 up_write(&snd_ioctl_rwsem);
1197 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1199 return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1202 #ifdef CONFIG_COMPAT
1203 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1205 return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1210 * de-register the device-specific control-ioctls.
1212 static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1213 struct list_head *lists)
1215 struct list_head *list;
1216 struct snd_kctl_ioctl *p;
1218 snd_assert(fcn != NULL, return -EINVAL);
1219 down_write(&snd_ioctl_rwsem);
1220 list_for_each(list, lists) {
1221 p = list_entry(list, struct snd_kctl_ioctl, list);
1222 if (p->fioctl == fcn) {
1224 up_write(&snd_ioctl_rwsem);
1229 up_write(&snd_ioctl_rwsem);
1234 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1236 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1239 #ifdef CONFIG_COMPAT
1240 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1242 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1247 static int snd_ctl_fasync(int fd, struct file * file, int on)
1249 struct snd_ctl_file *ctl;
1251 ctl = file->private_data;
1252 err = fasync_helper(fd, file, on, &ctl->fasync);
1261 #ifdef CONFIG_COMPAT
1262 #include "control_compat.c"
1264 #define snd_ctl_ioctl_compat NULL
1271 static struct file_operations snd_ctl_f_ops =
1273 .owner = THIS_MODULE,
1274 .read = snd_ctl_read,
1275 .open = snd_ctl_open,
1276 .release = snd_ctl_release,
1277 .poll = snd_ctl_poll,
1278 .unlocked_ioctl = snd_ctl_ioctl,
1279 .compat_ioctl = snd_ctl_ioctl_compat,
1280 .fasync = snd_ctl_fasync,
1284 * registration of the control device
1286 static int snd_ctl_dev_register(struct snd_device *device)
1288 struct snd_card *card = device->device_data;
1292 snd_assert(card != NULL, return -ENXIO);
1293 cardnum = card->number;
1294 snd_assert(cardnum >= 0 && cardnum < SNDRV_CARDS, return -ENXIO);
1295 sprintf(name, "controlC%i", cardnum);
1296 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1297 &snd_ctl_f_ops, card, name)) < 0)
1303 * disconnection of the control device
1305 static int snd_ctl_dev_disconnect(struct snd_device *device)
1307 struct snd_card *card = device->device_data;
1308 struct list_head *flist;
1309 struct snd_ctl_file *ctl;
1311 down_read(&card->controls_rwsem);
1312 list_for_each(flist, &card->ctl_files) {
1313 ctl = snd_ctl_file(flist);
1314 wake_up(&ctl->change_sleep);
1315 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1317 up_read(&card->controls_rwsem);
1324 static int snd_ctl_dev_free(struct snd_device *device)
1326 struct snd_card *card = device->device_data;
1327 struct snd_kcontrol *control;
1329 down_write(&card->controls_rwsem);
1330 while (!list_empty(&card->controls)) {
1331 control = snd_kcontrol(card->controls.next);
1332 snd_ctl_remove(card, control);
1334 up_write(&card->controls_rwsem);
1339 * de-registration of the control device
1341 static int snd_ctl_dev_unregister(struct snd_device *device)
1343 struct snd_card *card = device->device_data;
1346 snd_assert(card != NULL, return -ENXIO);
1347 cardnum = card->number;
1348 snd_assert(cardnum >= 0 && cardnum < SNDRV_CARDS, return -ENXIO);
1349 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1352 return snd_ctl_dev_free(device);
1356 * create control core:
1357 * called from init.c
1359 int snd_ctl_create(struct snd_card *card)
1361 static struct snd_device_ops ops = {
1362 .dev_free = snd_ctl_dev_free,
1363 .dev_register = snd_ctl_dev_register,
1364 .dev_disconnect = snd_ctl_dev_disconnect,
1365 .dev_unregister = snd_ctl_dev_unregister
1368 snd_assert(card != NULL, return -ENXIO);
1369 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);