2 * Routines for driver control interface
3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/threads.h>
23 #include <linux/interrupt.h>
24 #include <linux/slab.h>
25 #include <linux/vmalloc.h>
26 #include <linux/time.h>
27 #include <sound/core.h>
28 #include <sound/minors.h>
29 #include <sound/info.h>
30 #include <sound/control.h>
32 /* max number of user-defined controls */
33 #define MAX_USER_CONTROLS 32
34 #define MAX_CONTROL_COUNT 1028
36 struct snd_kctl_ioctl
{
37 struct list_head list
; /* list of all ioctls */
38 snd_kctl_ioctl_func_t fioctl
;
41 static DECLARE_RWSEM(snd_ioctl_rwsem
);
42 static LIST_HEAD(snd_control_ioctls
);
44 static LIST_HEAD(snd_control_compat_ioctls
);
47 static int snd_ctl_open(struct inode
*inode
, struct file
*file
)
50 struct snd_card
*card
;
51 struct snd_ctl_file
*ctl
;
54 err
= nonseekable_open(inode
, file
);
58 card
= snd_lookup_minor_data(iminor(inode
), SNDRV_DEVICE_TYPE_CONTROL
);
63 err
= snd_card_file_add(card
, file
);
68 if (!try_module_get(card
->module
)) {
72 ctl
= kzalloc(sizeof(*ctl
), GFP_KERNEL
);
77 INIT_LIST_HEAD(&ctl
->events
);
78 init_waitqueue_head(&ctl
->change_sleep
);
79 spin_lock_init(&ctl
->read_lock
);
81 ctl
->prefer_pcm_subdevice
= -1;
82 ctl
->prefer_rawmidi_subdevice
= -1;
83 ctl
->pid
= get_pid(task_pid(current
));
84 file
->private_data
= ctl
;
85 write_lock_irqsave(&card
->ctl_files_rwlock
, flags
);
86 list_add_tail(&ctl
->list
, &card
->ctl_files
);
87 write_unlock_irqrestore(&card
->ctl_files_rwlock
, flags
);
91 module_put(card
->module
);
93 snd_card_file_remove(card
, file
);
98 static void snd_ctl_empty_read_queue(struct snd_ctl_file
* ctl
)
101 struct snd_kctl_event
*cread
;
103 spin_lock_irqsave(&ctl
->read_lock
, flags
);
104 while (!list_empty(&ctl
->events
)) {
105 cread
= snd_kctl_event(ctl
->events
.next
);
106 list_del(&cread
->list
);
109 spin_unlock_irqrestore(&ctl
->read_lock
, flags
);
112 static int snd_ctl_release(struct inode
*inode
, struct file
*file
)
115 struct snd_card
*card
;
116 struct snd_ctl_file
*ctl
;
117 struct snd_kcontrol
*control
;
120 ctl
= file
->private_data
;
121 file
->private_data
= NULL
;
123 write_lock_irqsave(&card
->ctl_files_rwlock
, flags
);
124 list_del(&ctl
->list
);
125 write_unlock_irqrestore(&card
->ctl_files_rwlock
, flags
);
126 down_write(&card
->controls_rwsem
);
127 list_for_each_entry(control
, &card
->controls
, list
)
128 for (idx
= 0; idx
< control
->count
; idx
++)
129 if (control
->vd
[idx
].owner
== ctl
)
130 control
->vd
[idx
].owner
= NULL
;
131 up_write(&card
->controls_rwsem
);
132 snd_ctl_empty_read_queue(ctl
);
135 module_put(card
->module
);
136 snd_card_file_remove(card
, file
);
140 void snd_ctl_notify(struct snd_card
*card
, unsigned int mask
,
141 struct snd_ctl_elem_id
*id
)
144 struct snd_ctl_file
*ctl
;
145 struct snd_kctl_event
*ev
;
147 if (snd_BUG_ON(!card
|| !id
))
149 read_lock(&card
->ctl_files_rwlock
);
150 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
151 card
->mixer_oss_change_count
++;
153 list_for_each_entry(ctl
, &card
->ctl_files
, list
) {
154 if (!ctl
->subscribed
)
156 spin_lock_irqsave(&ctl
->read_lock
, flags
);
157 list_for_each_entry(ev
, &ctl
->events
, list
) {
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
);
179 EXPORT_SYMBOL(snd_ctl_notify
);
182 * snd_ctl_new - create a control instance from the template
183 * @control: the control template
184 * @access: the default control access
186 * Allocates a new struct snd_kcontrol instance and copies the given template
187 * to the new instance. It does not copy volatile data (access).
189 * Returns the pointer of the new instance, or NULL on failure.
191 static struct snd_kcontrol
*snd_ctl_new(struct snd_kcontrol
*control
,
194 struct snd_kcontrol
*kctl
;
197 if (snd_BUG_ON(!control
|| !control
->count
))
200 if (control
->count
> MAX_CONTROL_COUNT
)
203 kctl
= kzalloc(sizeof(*kctl
) + sizeof(struct snd_kcontrol_volatile
) * control
->count
, GFP_KERNEL
);
205 snd_printk(KERN_ERR
"Cannot allocate control instance\n");
209 for (idx
= 0; idx
< kctl
->count
; idx
++)
210 kctl
->vd
[idx
].access
= access
;
215 * snd_ctl_new1 - create a control instance from the template
216 * @ncontrol: the initialization record
217 * @private_data: the private data to set
219 * Allocates a new struct snd_kcontrol instance and initialize from the given
220 * template. When the access field of ncontrol is 0, it's assumed as
221 * READWRITE access. When the count field is 0, it's assumes as one.
223 * Returns the pointer of the newly generated instance, or NULL on failure.
225 struct snd_kcontrol
*snd_ctl_new1(const struct snd_kcontrol_new
*ncontrol
,
228 struct snd_kcontrol kctl
;
231 if (snd_BUG_ON(!ncontrol
|| !ncontrol
->info
))
233 memset(&kctl
, 0, sizeof(kctl
));
234 kctl
.id
.iface
= ncontrol
->iface
;
235 kctl
.id
.device
= ncontrol
->device
;
236 kctl
.id
.subdevice
= ncontrol
->subdevice
;
237 if (ncontrol
->name
) {
238 strlcpy(kctl
.id
.name
, ncontrol
->name
, sizeof(kctl
.id
.name
));
239 if (strcmp(ncontrol
->name
, kctl
.id
.name
) != 0)
240 snd_printk(KERN_WARNING
241 "Control name '%s' truncated to '%s'\n",
242 ncontrol
->name
, kctl
.id
.name
);
244 kctl
.id
.index
= ncontrol
->index
;
245 kctl
.count
= ncontrol
->count
? ncontrol
->count
: 1;
246 access
= ncontrol
->access
== 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE
:
247 (ncontrol
->access
& (SNDRV_CTL_ELEM_ACCESS_READWRITE
|
248 SNDRV_CTL_ELEM_ACCESS_INACTIVE
|
249 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
|
250 SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND
|
251 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
));
252 kctl
.info
= ncontrol
->info
;
253 kctl
.get
= ncontrol
->get
;
254 kctl
.put
= ncontrol
->put
;
255 kctl
.tlv
.p
= ncontrol
->tlv
.p
;
256 kctl
.private_value
= ncontrol
->private_value
;
257 kctl
.private_data
= private_data
;
258 return snd_ctl_new(&kctl
, access
);
261 EXPORT_SYMBOL(snd_ctl_new1
);
264 * snd_ctl_free_one - release the control instance
265 * @kcontrol: the control instance
267 * Releases the control instance created via snd_ctl_new()
269 * Don't call this after the control was added to the card.
271 void snd_ctl_free_one(struct snd_kcontrol
*kcontrol
)
274 if (kcontrol
->private_free
)
275 kcontrol
->private_free(kcontrol
);
280 EXPORT_SYMBOL(snd_ctl_free_one
);
282 static unsigned int snd_ctl_hole_check(struct snd_card
*card
,
285 struct snd_kcontrol
*kctl
;
287 list_for_each_entry(kctl
, &card
->controls
, list
) {
288 if ((kctl
->id
.numid
<= card
->last_numid
&&
289 kctl
->id
.numid
+ kctl
->count
> card
->last_numid
) ||
290 (kctl
->id
.numid
<= card
->last_numid
+ count
- 1 &&
291 kctl
->id
.numid
+ kctl
->count
> card
->last_numid
+ count
- 1))
292 return card
->last_numid
= kctl
->id
.numid
+ kctl
->count
- 1;
294 return card
->last_numid
;
297 static int snd_ctl_find_hole(struct snd_card
*card
, unsigned int count
)
299 unsigned int last_numid
, iter
= 100000;
301 last_numid
= card
->last_numid
;
302 while (last_numid
!= snd_ctl_hole_check(card
, count
)) {
304 /* this situation is very unlikely */
305 snd_printk(KERN_ERR
"unable to allocate new control numid\n");
308 last_numid
= card
->last_numid
;
314 * snd_ctl_add - add the control instance to the card
315 * @card: the card instance
316 * @kcontrol: the control instance to add
318 * Adds the control instance created via snd_ctl_new() or
319 * snd_ctl_new1() to the given card. Assigns also an unique
320 * numid used for fast search.
322 * Returns zero if successful, or a negative error code on failure.
324 * It frees automatically the control which cannot be added.
326 int snd_ctl_add(struct snd_card
*card
, struct snd_kcontrol
*kcontrol
)
328 struct snd_ctl_elem_id id
;
334 if (snd_BUG_ON(!card
|| !kcontrol
->info
))
337 down_write(&card
->controls_rwsem
);
338 if (snd_ctl_find_id(card
, &id
)) {
339 up_write(&card
->controls_rwsem
);
340 snd_printd(KERN_ERR
"control %i:%i:%i:%s:%i is already present\n",
349 if (snd_ctl_find_hole(card
, kcontrol
->count
) < 0) {
350 up_write(&card
->controls_rwsem
);
354 list_add_tail(&kcontrol
->list
, &card
->controls
);
355 card
->controls_count
+= kcontrol
->count
;
356 kcontrol
->id
.numid
= card
->last_numid
+ 1;
357 card
->last_numid
+= kcontrol
->count
;
358 up_write(&card
->controls_rwsem
);
359 for (idx
= 0; idx
< kcontrol
->count
; idx
++, id
.index
++, id
.numid
++)
360 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_ADD
, &id
);
364 snd_ctl_free_one(kcontrol
);
368 EXPORT_SYMBOL(snd_ctl_add
);
371 * snd_ctl_remove - remove the control from the card and release it
372 * @card: the card instance
373 * @kcontrol: the control instance to remove
375 * Removes the control from the card and then releases the instance.
376 * You don't need to call snd_ctl_free_one(). You must be in
377 * the write lock - down_write(&card->controls_rwsem).
379 * Returns 0 if successful, or a negative error code on failure.
381 int snd_ctl_remove(struct snd_card
*card
, struct snd_kcontrol
*kcontrol
)
383 struct snd_ctl_elem_id id
;
386 if (snd_BUG_ON(!card
|| !kcontrol
))
388 list_del(&kcontrol
->list
);
389 card
->controls_count
-= kcontrol
->count
;
391 for (idx
= 0; idx
< kcontrol
->count
; idx
++, id
.index
++, id
.numid
++)
392 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_REMOVE
, &id
);
393 snd_ctl_free_one(kcontrol
);
397 EXPORT_SYMBOL(snd_ctl_remove
);
400 * snd_ctl_remove_id - remove the control of the given id and release it
401 * @card: the card instance
402 * @id: the control id to remove
404 * Finds the control instance with the given id, removes it from the
405 * card list and releases it.
407 * Returns 0 if successful, or a negative error code on failure.
409 int snd_ctl_remove_id(struct snd_card
*card
, struct snd_ctl_elem_id
*id
)
411 struct snd_kcontrol
*kctl
;
414 down_write(&card
->controls_rwsem
);
415 kctl
= snd_ctl_find_id(card
, id
);
417 up_write(&card
->controls_rwsem
);
420 ret
= snd_ctl_remove(card
, kctl
);
421 up_write(&card
->controls_rwsem
);
425 EXPORT_SYMBOL(snd_ctl_remove_id
);
428 * snd_ctl_remove_user_ctl - remove and release the unlocked user control
429 * @file: active control handle
430 * @id: the control id to remove
432 * Finds the control instance with the given id, removes it from the
433 * card list and releases it.
435 * Returns 0 if successful, or a negative error code on failure.
437 static int snd_ctl_remove_user_ctl(struct snd_ctl_file
* file
,
438 struct snd_ctl_elem_id
*id
)
440 struct snd_card
*card
= file
->card
;
441 struct snd_kcontrol
*kctl
;
444 down_write(&card
->controls_rwsem
);
445 kctl
= snd_ctl_find_id(card
, id
);
450 if (!(kctl
->vd
[0].access
& SNDRV_CTL_ELEM_ACCESS_USER
)) {
454 for (idx
= 0; idx
< kctl
->count
; idx
++)
455 if (kctl
->vd
[idx
].owner
!= NULL
&& kctl
->vd
[idx
].owner
!= file
) {
459 ret
= snd_ctl_remove(card
, kctl
);
462 card
->user_ctl_count
--;
464 up_write(&card
->controls_rwsem
);
469 * snd_ctl_rename_id - replace the id of a control on the card
470 * @card: the card instance
471 * @src_id: the old id
472 * @dst_id: the new id
474 * Finds the control with the old id from the card, and replaces the
475 * id with the new one.
477 * Returns zero if successful, or a negative error code on failure.
479 int snd_ctl_rename_id(struct snd_card
*card
, struct snd_ctl_elem_id
*src_id
,
480 struct snd_ctl_elem_id
*dst_id
)
482 struct snd_kcontrol
*kctl
;
484 down_write(&card
->controls_rwsem
);
485 kctl
= snd_ctl_find_id(card
, src_id
);
487 up_write(&card
->controls_rwsem
);
491 kctl
->id
.numid
= card
->last_numid
+ 1;
492 card
->last_numid
+= kctl
->count
;
493 up_write(&card
->controls_rwsem
);
497 EXPORT_SYMBOL(snd_ctl_rename_id
);
500 * snd_ctl_find_numid - find the control instance with the given number-id
501 * @card: the card instance
502 * @numid: the number-id to search
504 * Finds the control instance with the given number-id from the card.
506 * Returns the pointer of the instance if found, or NULL if not.
508 * The caller must down card->controls_rwsem before calling this function
509 * (if the race condition can happen).
511 struct snd_kcontrol
*snd_ctl_find_numid(struct snd_card
*card
, unsigned int numid
)
513 struct snd_kcontrol
*kctl
;
515 if (snd_BUG_ON(!card
|| !numid
))
517 list_for_each_entry(kctl
, &card
->controls
, list
) {
518 if (kctl
->id
.numid
<= numid
&& kctl
->id
.numid
+ kctl
->count
> numid
)
524 EXPORT_SYMBOL(snd_ctl_find_numid
);
527 * snd_ctl_find_id - find the control instance with the given id
528 * @card: the card instance
529 * @id: the id to search
531 * Finds the control instance with the given id from the card.
533 * Returns the pointer of the instance if found, or NULL if not.
535 * The caller must down card->controls_rwsem before calling this function
536 * (if the race condition can happen).
538 struct snd_kcontrol
*snd_ctl_find_id(struct snd_card
*card
,
539 struct snd_ctl_elem_id
*id
)
541 struct snd_kcontrol
*kctl
;
543 if (snd_BUG_ON(!card
|| !id
))
546 return snd_ctl_find_numid(card
, id
->numid
);
547 list_for_each_entry(kctl
, &card
->controls
, list
) {
548 if (kctl
->id
.iface
!= id
->iface
)
550 if (kctl
->id
.device
!= id
->device
)
552 if (kctl
->id
.subdevice
!= id
->subdevice
)
554 if (strncmp(kctl
->id
.name
, id
->name
, sizeof(kctl
->id
.name
)))
556 if (kctl
->id
.index
> id
->index
)
558 if (kctl
->id
.index
+ kctl
->count
<= id
->index
)
565 EXPORT_SYMBOL(snd_ctl_find_id
);
567 static int snd_ctl_card_info(struct snd_card
*card
, struct snd_ctl_file
* ctl
,
568 unsigned int cmd
, void __user
*arg
)
570 struct snd_ctl_card_info
*info
;
572 info
= kzalloc(sizeof(*info
), GFP_KERNEL
);
575 down_read(&snd_ioctl_rwsem
);
576 info
->card
= card
->number
;
577 strlcpy(info
->id
, card
->id
, sizeof(info
->id
));
578 strlcpy(info
->driver
, card
->driver
, sizeof(info
->driver
));
579 strlcpy(info
->name
, card
->shortname
, sizeof(info
->name
));
580 strlcpy(info
->longname
, card
->longname
, sizeof(info
->longname
));
581 strlcpy(info
->mixername
, card
->mixername
, sizeof(info
->mixername
));
582 strlcpy(info
->components
, card
->components
, sizeof(info
->components
));
583 up_read(&snd_ioctl_rwsem
);
584 if (copy_to_user(arg
, info
, sizeof(struct snd_ctl_card_info
))) {
592 static int snd_ctl_elem_list(struct snd_card
*card
,
593 struct snd_ctl_elem_list __user
*_list
)
595 struct list_head
*plist
;
596 struct snd_ctl_elem_list list
;
597 struct snd_kcontrol
*kctl
;
598 struct snd_ctl_elem_id
*dst
, *id
;
599 unsigned int offset
, space
, first
, jidx
;
601 if (copy_from_user(&list
, _list
, sizeof(list
)))
603 offset
= list
.offset
;
606 /* try limit maximum space */
610 /* allocate temporary buffer for atomic operation */
611 dst
= vmalloc(space
* sizeof(struct snd_ctl_elem_id
));
614 down_read(&card
->controls_rwsem
);
615 list
.count
= card
->controls_count
;
616 plist
= card
->controls
.next
;
617 while (plist
!= &card
->controls
) {
620 kctl
= snd_kcontrol(plist
);
621 if (offset
< kctl
->count
)
623 offset
-= kctl
->count
;
628 while (space
> 0 && plist
!= &card
->controls
) {
629 kctl
= snd_kcontrol(plist
);
630 for (jidx
= offset
; space
> 0 && jidx
< kctl
->count
; jidx
++) {
631 snd_ctl_build_ioff(id
, kctl
, jidx
);
639 up_read(&card
->controls_rwsem
);
641 copy_to_user(list
.pids
, dst
,
642 list
.used
* sizeof(struct snd_ctl_elem_id
))) {
648 down_read(&card
->controls_rwsem
);
649 list
.count
= card
->controls_count
;
650 up_read(&card
->controls_rwsem
);
652 if (copy_to_user(_list
, &list
, sizeof(list
)))
657 static int snd_ctl_elem_info(struct snd_ctl_file
*ctl
,
658 struct snd_ctl_elem_info
*info
)
660 struct snd_card
*card
= ctl
->card
;
661 struct snd_kcontrol
*kctl
;
662 struct snd_kcontrol_volatile
*vd
;
663 unsigned int index_offset
;
666 down_read(&card
->controls_rwsem
);
667 kctl
= snd_ctl_find_id(card
, &info
->id
);
669 up_read(&card
->controls_rwsem
);
672 #ifdef CONFIG_SND_DEBUG
675 result
= kctl
->info(kctl
, info
);
677 snd_BUG_ON(info
->access
);
678 index_offset
= snd_ctl_get_ioff(kctl
, &info
->id
);
679 vd
= &kctl
->vd
[index_offset
];
680 snd_ctl_build_ioff(&info
->id
, kctl
, index_offset
);
681 info
->access
= vd
->access
;
683 info
->access
|= SNDRV_CTL_ELEM_ACCESS_LOCK
;
684 if (vd
->owner
== ctl
)
685 info
->access
|= SNDRV_CTL_ELEM_ACCESS_OWNER
;
686 info
->owner
= pid_vnr(vd
->owner
->pid
);
691 up_read(&card
->controls_rwsem
);
695 static int snd_ctl_elem_info_user(struct snd_ctl_file
*ctl
,
696 struct snd_ctl_elem_info __user
*_info
)
698 struct snd_ctl_elem_info info
;
701 if (copy_from_user(&info
, _info
, sizeof(info
)))
703 snd_power_lock(ctl
->card
);
704 result
= snd_power_wait(ctl
->card
, SNDRV_CTL_POWER_D0
);
706 result
= snd_ctl_elem_info(ctl
, &info
);
707 snd_power_unlock(ctl
->card
);
709 if (copy_to_user(_info
, &info
, sizeof(info
)))
714 static int snd_ctl_elem_read(struct snd_card
*card
,
715 struct snd_ctl_elem_value
*control
)
717 struct snd_kcontrol
*kctl
;
718 struct snd_kcontrol_volatile
*vd
;
719 unsigned int index_offset
;
722 down_read(&card
->controls_rwsem
);
723 kctl
= snd_ctl_find_id(card
, &control
->id
);
727 index_offset
= snd_ctl_get_ioff(kctl
, &control
->id
);
728 vd
= &kctl
->vd
[index_offset
];
729 if ((vd
->access
& SNDRV_CTL_ELEM_ACCESS_READ
) &&
731 snd_ctl_build_ioff(&control
->id
, kctl
, index_offset
);
732 result
= kctl
->get(kctl
, control
);
736 up_read(&card
->controls_rwsem
);
740 static int snd_ctl_elem_read_user(struct snd_card
*card
,
741 struct snd_ctl_elem_value __user
*_control
)
743 struct snd_ctl_elem_value
*control
;
746 control
= memdup_user(_control
, sizeof(*control
));
748 return PTR_ERR(control
);
750 snd_power_lock(card
);
751 result
= snd_power_wait(card
, SNDRV_CTL_POWER_D0
);
753 result
= snd_ctl_elem_read(card
, control
);
754 snd_power_unlock(card
);
756 if (copy_to_user(_control
, control
, sizeof(*control
)))
762 static int snd_ctl_elem_write(struct snd_card
*card
, struct snd_ctl_file
*file
,
763 struct snd_ctl_elem_value
*control
)
765 struct snd_kcontrol
*kctl
;
766 struct snd_kcontrol_volatile
*vd
;
767 unsigned int index_offset
;
770 down_read(&card
->controls_rwsem
);
771 kctl
= snd_ctl_find_id(card
, &control
->id
);
775 index_offset
= snd_ctl_get_ioff(kctl
, &control
->id
);
776 vd
= &kctl
->vd
[index_offset
];
777 if (!(vd
->access
& SNDRV_CTL_ELEM_ACCESS_WRITE
) ||
779 (file
&& vd
->owner
&& vd
->owner
!= file
)) {
782 snd_ctl_build_ioff(&control
->id
, kctl
, index_offset
);
783 result
= kctl
->put(kctl
, control
);
786 up_read(&card
->controls_rwsem
);
787 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_VALUE
,
792 up_read(&card
->controls_rwsem
);
796 static int snd_ctl_elem_write_user(struct snd_ctl_file
*file
,
797 struct snd_ctl_elem_value __user
*_control
)
799 struct snd_ctl_elem_value
*control
;
800 struct snd_card
*card
;
803 control
= memdup_user(_control
, sizeof(*control
));
805 return PTR_ERR(control
);
808 snd_power_lock(card
);
809 result
= snd_power_wait(card
, SNDRV_CTL_POWER_D0
);
811 result
= snd_ctl_elem_write(card
, file
, control
);
812 snd_power_unlock(card
);
814 if (copy_to_user(_control
, control
, sizeof(*control
)))
820 static int snd_ctl_elem_lock(struct snd_ctl_file
*file
,
821 struct snd_ctl_elem_id __user
*_id
)
823 struct snd_card
*card
= file
->card
;
824 struct snd_ctl_elem_id id
;
825 struct snd_kcontrol
*kctl
;
826 struct snd_kcontrol_volatile
*vd
;
829 if (copy_from_user(&id
, _id
, sizeof(id
)))
831 down_write(&card
->controls_rwsem
);
832 kctl
= snd_ctl_find_id(card
, &id
);
836 vd
= &kctl
->vd
[snd_ctl_get_ioff(kctl
, &id
)];
837 if (vd
->owner
!= NULL
)
844 up_write(&card
->controls_rwsem
);
848 static int snd_ctl_elem_unlock(struct snd_ctl_file
*file
,
849 struct snd_ctl_elem_id __user
*_id
)
851 struct snd_card
*card
= file
->card
;
852 struct snd_ctl_elem_id id
;
853 struct snd_kcontrol
*kctl
;
854 struct snd_kcontrol_volatile
*vd
;
857 if (copy_from_user(&id
, _id
, sizeof(id
)))
859 down_write(&card
->controls_rwsem
);
860 kctl
= snd_ctl_find_id(card
, &id
);
864 vd
= &kctl
->vd
[snd_ctl_get_ioff(kctl
, &id
)];
865 if (vd
->owner
== NULL
)
867 else if (vd
->owner
!= file
)
874 up_write(&card
->controls_rwsem
);
878 struct user_element
{
879 struct snd_ctl_elem_info info
;
880 void *elem_data
; /* element data */
881 unsigned long elem_data_size
; /* size of element data in bytes */
882 void *tlv_data
; /* TLV data */
883 unsigned long tlv_data_size
; /* TLV data size */
884 void *priv_data
; /* private data (like strings for enumerated type) */
885 unsigned long priv_data_size
; /* size of private data in bytes */
888 static int snd_ctl_elem_user_info(struct snd_kcontrol
*kcontrol
,
889 struct snd_ctl_elem_info
*uinfo
)
891 struct user_element
*ue
= kcontrol
->private_data
;
897 static int snd_ctl_elem_user_get(struct snd_kcontrol
*kcontrol
,
898 struct snd_ctl_elem_value
*ucontrol
)
900 struct user_element
*ue
= kcontrol
->private_data
;
902 memcpy(&ucontrol
->value
, ue
->elem_data
, ue
->elem_data_size
);
906 static int snd_ctl_elem_user_put(struct snd_kcontrol
*kcontrol
,
907 struct snd_ctl_elem_value
*ucontrol
)
910 struct user_element
*ue
= kcontrol
->private_data
;
912 change
= memcmp(&ucontrol
->value
, ue
->elem_data
, ue
->elem_data_size
) != 0;
914 memcpy(ue
->elem_data
, &ucontrol
->value
, ue
->elem_data_size
);
918 static int snd_ctl_elem_user_tlv(struct snd_kcontrol
*kcontrol
,
921 unsigned int __user
*tlv
)
923 struct user_element
*ue
= kcontrol
->private_data
;
928 if (size
> 1024 * 128) /* sane value */
931 new_data
= memdup_user(tlv
, size
);
932 if (IS_ERR(new_data
))
933 return PTR_ERR(new_data
);
934 change
= ue
->tlv_data_size
!= size
;
936 change
= memcmp(ue
->tlv_data
, new_data
, size
);
938 ue
->tlv_data
= new_data
;
939 ue
->tlv_data_size
= size
;
941 if (! ue
->tlv_data_size
|| ! ue
->tlv_data
)
943 if (size
< ue
->tlv_data_size
)
945 if (copy_to_user(tlv
, ue
->tlv_data
, ue
->tlv_data_size
))
951 static void snd_ctl_elem_user_free(struct snd_kcontrol
*kcontrol
)
953 struct user_element
*ue
= kcontrol
->private_data
;
959 static int snd_ctl_elem_add(struct snd_ctl_file
*file
,
960 struct snd_ctl_elem_info
*info
, int replace
)
962 struct snd_card
*card
= file
->card
;
963 struct snd_kcontrol kctl
, *_kctl
;
966 struct user_element
*ue
;
969 if (card
->user_ctl_count
>= MAX_USER_CONTROLS
)
973 access
= info
->access
== 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE
:
974 (info
->access
& (SNDRV_CTL_ELEM_ACCESS_READWRITE
|
975 SNDRV_CTL_ELEM_ACCESS_INACTIVE
|
976 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
));
978 memset(&kctl
, 0, sizeof(kctl
));
979 down_write(&card
->controls_rwsem
);
980 _kctl
= snd_ctl_find_id(card
, &info
->id
);
984 err
= snd_ctl_remove(card
, _kctl
);
991 up_write(&card
->controls_rwsem
);
994 memcpy(&kctl
.id
, &info
->id
, sizeof(info
->id
));
995 kctl
.count
= info
->owner
? info
->owner
: 1;
996 access
|= SNDRV_CTL_ELEM_ACCESS_USER
;
997 kctl
.info
= snd_ctl_elem_user_info
;
998 if (access
& SNDRV_CTL_ELEM_ACCESS_READ
)
999 kctl
.get
= snd_ctl_elem_user_get
;
1000 if (access
& SNDRV_CTL_ELEM_ACCESS_WRITE
)
1001 kctl
.put
= snd_ctl_elem_user_put
;
1002 if (access
& SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
) {
1003 kctl
.tlv
.c
= snd_ctl_elem_user_tlv
;
1004 access
|= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
;
1006 switch (info
->type
) {
1007 case SNDRV_CTL_ELEM_TYPE_BOOLEAN
:
1008 case SNDRV_CTL_ELEM_TYPE_INTEGER
:
1009 private_size
= sizeof(long);
1010 if (info
->count
> 128)
1013 case SNDRV_CTL_ELEM_TYPE_INTEGER64
:
1014 private_size
= sizeof(long long);
1015 if (info
->count
> 64)
1018 case SNDRV_CTL_ELEM_TYPE_BYTES
:
1019 private_size
= sizeof(unsigned char);
1020 if (info
->count
> 512)
1023 case SNDRV_CTL_ELEM_TYPE_IEC958
:
1024 private_size
= sizeof(struct snd_aes_iec958
);
1025 if (info
->count
!= 1)
1031 private_size
*= info
->count
;
1032 ue
= kzalloc(sizeof(struct user_element
) + private_size
, GFP_KERNEL
);
1036 ue
->info
.access
= 0;
1037 ue
->elem_data
= (char *)ue
+ sizeof(*ue
);
1038 ue
->elem_data_size
= private_size
;
1039 kctl
.private_free
= snd_ctl_elem_user_free
;
1040 _kctl
= snd_ctl_new(&kctl
, access
);
1041 if (_kctl
== NULL
) {
1045 _kctl
->private_data
= ue
;
1046 for (idx
= 0; idx
< _kctl
->count
; idx
++)
1047 _kctl
->vd
[idx
].owner
= file
;
1048 err
= snd_ctl_add(card
, _kctl
);
1052 down_write(&card
->controls_rwsem
);
1053 card
->user_ctl_count
++;
1054 up_write(&card
->controls_rwsem
);
1059 static int snd_ctl_elem_add_user(struct snd_ctl_file
*file
,
1060 struct snd_ctl_elem_info __user
*_info
, int replace
)
1062 struct snd_ctl_elem_info info
;
1063 if (copy_from_user(&info
, _info
, sizeof(info
)))
1065 return snd_ctl_elem_add(file
, &info
, replace
);
1068 static int snd_ctl_elem_remove(struct snd_ctl_file
*file
,
1069 struct snd_ctl_elem_id __user
*_id
)
1071 struct snd_ctl_elem_id id
;
1073 if (copy_from_user(&id
, _id
, sizeof(id
)))
1075 return snd_ctl_remove_user_ctl(file
, &id
);
1078 static int snd_ctl_subscribe_events(struct snd_ctl_file
*file
, int __user
*ptr
)
1081 if (get_user(subscribe
, ptr
))
1083 if (subscribe
< 0) {
1084 subscribe
= file
->subscribed
;
1085 if (put_user(subscribe
, ptr
))
1090 file
->subscribed
= 1;
1092 } else if (file
->subscribed
) {
1093 snd_ctl_empty_read_queue(file
);
1094 file
->subscribed
= 0;
1099 static int snd_ctl_tlv_ioctl(struct snd_ctl_file
*file
,
1100 struct snd_ctl_tlv __user
*_tlv
,
1103 struct snd_card
*card
= file
->card
;
1104 struct snd_ctl_tlv tlv
;
1105 struct snd_kcontrol
*kctl
;
1106 struct snd_kcontrol_volatile
*vd
;
1110 if (copy_from_user(&tlv
, _tlv
, sizeof(tlv
)))
1112 if (tlv
.length
< sizeof(unsigned int) * 2)
1114 down_read(&card
->controls_rwsem
);
1115 kctl
= snd_ctl_find_numid(card
, tlv
.numid
);
1120 if (kctl
->tlv
.p
== NULL
) {
1124 vd
= &kctl
->vd
[tlv
.numid
- kctl
->id
.numid
];
1125 if ((op_flag
== 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_READ
) == 0) ||
1126 (op_flag
> 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_WRITE
) == 0) ||
1127 (op_flag
< 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND
) == 0)) {
1131 if (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
) {
1132 if (vd
->owner
!= NULL
&& vd
->owner
!= file
) {
1136 err
= kctl
->tlv
.c(kctl
, op_flag
, tlv
.length
, _tlv
->tlv
);
1138 up_read(&card
->controls_rwsem
);
1139 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_TLV
, &kctl
->id
);
1147 len
= kctl
->tlv
.p
[1] + 2 * sizeof(unsigned int);
1148 if (tlv
.length
< len
) {
1152 if (copy_to_user(_tlv
->tlv
, kctl
->tlv
.p
, len
))
1156 up_read(&card
->controls_rwsem
);
1160 static long snd_ctl_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
1162 struct snd_ctl_file
*ctl
;
1163 struct snd_card
*card
;
1164 struct snd_kctl_ioctl
*p
;
1165 void __user
*argp
= (void __user
*)arg
;
1166 int __user
*ip
= argp
;
1169 ctl
= file
->private_data
;
1171 if (snd_BUG_ON(!card
))
1174 case SNDRV_CTL_IOCTL_PVERSION
:
1175 return put_user(SNDRV_CTL_VERSION
, ip
) ? -EFAULT
: 0;
1176 case SNDRV_CTL_IOCTL_CARD_INFO
:
1177 return snd_ctl_card_info(card
, ctl
, cmd
, argp
);
1178 case SNDRV_CTL_IOCTL_ELEM_LIST
:
1179 return snd_ctl_elem_list(card
, argp
);
1180 case SNDRV_CTL_IOCTL_ELEM_INFO
:
1181 return snd_ctl_elem_info_user(ctl
, argp
);
1182 case SNDRV_CTL_IOCTL_ELEM_READ
:
1183 return snd_ctl_elem_read_user(card
, argp
);
1184 case SNDRV_CTL_IOCTL_ELEM_WRITE
:
1185 return snd_ctl_elem_write_user(ctl
, argp
);
1186 case SNDRV_CTL_IOCTL_ELEM_LOCK
:
1187 return snd_ctl_elem_lock(ctl
, argp
);
1188 case SNDRV_CTL_IOCTL_ELEM_UNLOCK
:
1189 return snd_ctl_elem_unlock(ctl
, argp
);
1190 case SNDRV_CTL_IOCTL_ELEM_ADD
:
1191 return snd_ctl_elem_add_user(ctl
, argp
, 0);
1192 case SNDRV_CTL_IOCTL_ELEM_REPLACE
:
1193 return snd_ctl_elem_add_user(ctl
, argp
, 1);
1194 case SNDRV_CTL_IOCTL_ELEM_REMOVE
:
1195 return snd_ctl_elem_remove(ctl
, argp
);
1196 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS
:
1197 return snd_ctl_subscribe_events(ctl
, ip
);
1198 case SNDRV_CTL_IOCTL_TLV_READ
:
1199 return snd_ctl_tlv_ioctl(ctl
, argp
, 0);
1200 case SNDRV_CTL_IOCTL_TLV_WRITE
:
1201 return snd_ctl_tlv_ioctl(ctl
, argp
, 1);
1202 case SNDRV_CTL_IOCTL_TLV_COMMAND
:
1203 return snd_ctl_tlv_ioctl(ctl
, argp
, -1);
1204 case SNDRV_CTL_IOCTL_POWER
:
1205 return -ENOPROTOOPT
;
1206 case SNDRV_CTL_IOCTL_POWER_STATE
:
1208 return put_user(card
->power_state
, ip
) ? -EFAULT
: 0;
1210 return put_user(SNDRV_CTL_POWER_D0
, ip
) ? -EFAULT
: 0;
1213 down_read(&snd_ioctl_rwsem
);
1214 list_for_each_entry(p
, &snd_control_ioctls
, list
) {
1215 err
= p
->fioctl(card
, ctl
, cmd
, arg
);
1216 if (err
!= -ENOIOCTLCMD
) {
1217 up_read(&snd_ioctl_rwsem
);
1221 up_read(&snd_ioctl_rwsem
);
1222 snd_printdd("unknown ioctl = 0x%x\n", cmd
);
1226 static ssize_t
snd_ctl_read(struct file
*file
, char __user
*buffer
,
1227 size_t count
, loff_t
* offset
)
1229 struct snd_ctl_file
*ctl
;
1233 ctl
= file
->private_data
;
1234 if (snd_BUG_ON(!ctl
|| !ctl
->card
))
1236 if (!ctl
->subscribed
)
1238 if (count
< sizeof(struct snd_ctl_event
))
1240 spin_lock_irq(&ctl
->read_lock
);
1241 while (count
>= sizeof(struct snd_ctl_event
)) {
1242 struct snd_ctl_event ev
;
1243 struct snd_kctl_event
*kev
;
1244 while (list_empty(&ctl
->events
)) {
1246 if ((file
->f_flags
& O_NONBLOCK
) != 0 || result
> 0) {
1250 init_waitqueue_entry(&wait
, current
);
1251 add_wait_queue(&ctl
->change_sleep
, &wait
);
1252 set_current_state(TASK_INTERRUPTIBLE
);
1253 spin_unlock_irq(&ctl
->read_lock
);
1255 remove_wait_queue(&ctl
->change_sleep
, &wait
);
1256 if (signal_pending(current
))
1257 return -ERESTARTSYS
;
1258 spin_lock_irq(&ctl
->read_lock
);
1260 kev
= snd_kctl_event(ctl
->events
.next
);
1261 ev
.type
= SNDRV_CTL_EVENT_ELEM
;
1262 ev
.data
.elem
.mask
= kev
->mask
;
1263 ev
.data
.elem
.id
= kev
->id
;
1264 list_del(&kev
->list
);
1265 spin_unlock_irq(&ctl
->read_lock
);
1267 if (copy_to_user(buffer
, &ev
, sizeof(struct snd_ctl_event
))) {
1271 spin_lock_irq(&ctl
->read_lock
);
1272 buffer
+= sizeof(struct snd_ctl_event
);
1273 count
-= sizeof(struct snd_ctl_event
);
1274 result
+= sizeof(struct snd_ctl_event
);
1277 spin_unlock_irq(&ctl
->read_lock
);
1279 return result
> 0 ? result
: err
;
1282 static unsigned int snd_ctl_poll(struct file
*file
, poll_table
* wait
)
1285 struct snd_ctl_file
*ctl
;
1287 ctl
= file
->private_data
;
1288 if (!ctl
->subscribed
)
1290 poll_wait(file
, &ctl
->change_sleep
, wait
);
1293 if (!list_empty(&ctl
->events
))
1294 mask
|= POLLIN
| POLLRDNORM
;
1300 * register the device-specific control-ioctls.
1301 * called from each device manager like pcm.c, hwdep.c, etc.
1303 static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn
, struct list_head
*lists
)
1305 struct snd_kctl_ioctl
*pn
;
1307 pn
= kzalloc(sizeof(struct snd_kctl_ioctl
), GFP_KERNEL
);
1311 down_write(&snd_ioctl_rwsem
);
1312 list_add_tail(&pn
->list
, lists
);
1313 up_write(&snd_ioctl_rwsem
);
1317 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn
)
1319 return _snd_ctl_register_ioctl(fcn
, &snd_control_ioctls
);
1322 EXPORT_SYMBOL(snd_ctl_register_ioctl
);
1324 #ifdef CONFIG_COMPAT
1325 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn
)
1327 return _snd_ctl_register_ioctl(fcn
, &snd_control_compat_ioctls
);
1330 EXPORT_SYMBOL(snd_ctl_register_ioctl_compat
);
1334 * de-register the device-specific control-ioctls.
1336 static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn
,
1337 struct list_head
*lists
)
1339 struct snd_kctl_ioctl
*p
;
1341 if (snd_BUG_ON(!fcn
))
1343 down_write(&snd_ioctl_rwsem
);
1344 list_for_each_entry(p
, lists
, list
) {
1345 if (p
->fioctl
== fcn
) {
1347 up_write(&snd_ioctl_rwsem
);
1352 up_write(&snd_ioctl_rwsem
);
1357 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn
)
1359 return _snd_ctl_unregister_ioctl(fcn
, &snd_control_ioctls
);
1362 EXPORT_SYMBOL(snd_ctl_unregister_ioctl
);
1364 #ifdef CONFIG_COMPAT
1365 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn
)
1367 return _snd_ctl_unregister_ioctl(fcn
, &snd_control_compat_ioctls
);
1370 EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat
);
1373 static int snd_ctl_fasync(int fd
, struct file
* file
, int on
)
1375 struct snd_ctl_file
*ctl
;
1377 ctl
= file
->private_data
;
1378 return fasync_helper(fd
, file
, on
, &ctl
->fasync
);
1384 #ifdef CONFIG_COMPAT
1385 #include "control_compat.c"
1387 #define snd_ctl_ioctl_compat NULL
1394 static const struct file_operations snd_ctl_f_ops
=
1396 .owner
= THIS_MODULE
,
1397 .read
= snd_ctl_read
,
1398 .open
= snd_ctl_open
,
1399 .release
= snd_ctl_release
,
1400 .llseek
= no_llseek
,
1401 .poll
= snd_ctl_poll
,
1402 .unlocked_ioctl
= snd_ctl_ioctl
,
1403 .compat_ioctl
= snd_ctl_ioctl_compat
,
1404 .fasync
= snd_ctl_fasync
,
1408 * registration of the control device
1410 static int snd_ctl_dev_register(struct snd_device
*device
)
1412 struct snd_card
*card
= device
->device_data
;
1416 if (snd_BUG_ON(!card
))
1418 cardnum
= card
->number
;
1419 if (snd_BUG_ON(cardnum
< 0 || cardnum
>= SNDRV_CARDS
))
1421 sprintf(name
, "controlC%i", cardnum
);
1422 if ((err
= snd_register_device(SNDRV_DEVICE_TYPE_CONTROL
, card
, -1,
1423 &snd_ctl_f_ops
, card
, name
)) < 0)
1429 * disconnection of the control device
1431 static int snd_ctl_dev_disconnect(struct snd_device
*device
)
1433 struct snd_card
*card
= device
->device_data
;
1434 struct snd_ctl_file
*ctl
;
1437 if (snd_BUG_ON(!card
))
1439 cardnum
= card
->number
;
1440 if (snd_BUG_ON(cardnum
< 0 || cardnum
>= SNDRV_CARDS
))
1443 read_lock(&card
->ctl_files_rwlock
);
1444 list_for_each_entry(ctl
, &card
->ctl_files
, list
) {
1445 wake_up(&ctl
->change_sleep
);
1446 kill_fasync(&ctl
->fasync
, SIGIO
, POLL_ERR
);
1448 read_unlock(&card
->ctl_files_rwlock
);
1450 if ((err
= snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL
,
1459 static int snd_ctl_dev_free(struct snd_device
*device
)
1461 struct snd_card
*card
= device
->device_data
;
1462 struct snd_kcontrol
*control
;
1464 down_write(&card
->controls_rwsem
);
1465 while (!list_empty(&card
->controls
)) {
1466 control
= snd_kcontrol(card
->controls
.next
);
1467 snd_ctl_remove(card
, control
);
1469 up_write(&card
->controls_rwsem
);
1474 * create control core:
1475 * called from init.c
1477 int snd_ctl_create(struct snd_card
*card
)
1479 static struct snd_device_ops ops
= {
1480 .dev_free
= snd_ctl_dev_free
,
1481 .dev_register
= snd_ctl_dev_register
,
1482 .dev_disconnect
= snd_ctl_dev_disconnect
,
1485 if (snd_BUG_ON(!card
))
1487 return snd_device_new(card
, SNDRV_DEV_CONTROL
, card
, &ops
);
1491 * Frequently used control callbacks/helpers
1493 int snd_ctl_boolean_mono_info(struct snd_kcontrol
*kcontrol
,
1494 struct snd_ctl_elem_info
*uinfo
)
1496 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1498 uinfo
->value
.integer
.min
= 0;
1499 uinfo
->value
.integer
.max
= 1;
1503 EXPORT_SYMBOL(snd_ctl_boolean_mono_info
);
1505 int snd_ctl_boolean_stereo_info(struct snd_kcontrol
*kcontrol
,
1506 struct snd_ctl_elem_info
*uinfo
)
1508 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1510 uinfo
->value
.integer
.min
= 0;
1511 uinfo
->value
.integer
.max
= 1;
1515 EXPORT_SYMBOL(snd_ctl_boolean_stereo_info
);
1518 * snd_ctl_enum_info - fills the info structure for an enumerated control
1519 * @info: the structure to be filled
1520 * @channels: the number of the control's channels; often one
1521 * @items: the number of control values; also the size of @names
1522 * @names: an array containing the names of all control values
1524 * Sets all required fields in @info to their appropriate values.
1525 * If the control's accessibility is not the default (readable and writable),
1526 * the caller has to fill @info->access.
1528 int snd_ctl_enum_info(struct snd_ctl_elem_info
*info
, unsigned int channels
,
1529 unsigned int items
, const char *const names
[])
1531 info
->type
= SNDRV_CTL_ELEM_TYPE_ENUMERATED
;
1532 info
->count
= channels
;
1533 info
->value
.enumerated
.items
= items
;
1534 if (info
->value
.enumerated
.item
>= items
)
1535 info
->value
.enumerated
.item
= items
- 1;
1536 strlcpy(info
->value
.enumerated
.name
,
1537 names
[info
->value
.enumerated
.item
],
1538 sizeof(info
->value
.enumerated
.name
));
1541 EXPORT_SYMBOL(snd_ctl_enum_info
);