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
35 struct snd_kctl_ioctl
{
36 struct list_head list
; /* list of all ioctls */
37 snd_kctl_ioctl_func_t fioctl
;
40 static DECLARE_RWSEM(snd_ioctl_rwsem
);
41 static LIST_HEAD(snd_control_ioctls
);
43 static LIST_HEAD(snd_control_compat_ioctls
);
46 static int snd_ctl_open(struct inode
*inode
, struct file
*file
)
49 struct snd_card
*card
;
50 struct snd_ctl_file
*ctl
;
53 err
= nonseekable_open(inode
, file
);
57 card
= snd_lookup_minor_data(iminor(inode
), SNDRV_DEVICE_TYPE_CONTROL
);
62 err
= snd_card_file_add(card
, file
);
67 if (!try_module_get(card
->module
)) {
71 ctl
= kzalloc(sizeof(*ctl
), GFP_KERNEL
);
76 INIT_LIST_HEAD(&ctl
->events
);
77 init_waitqueue_head(&ctl
->change_sleep
);
78 spin_lock_init(&ctl
->read_lock
);
80 ctl
->prefer_pcm_subdevice
= -1;
81 ctl
->prefer_rawmidi_subdevice
= -1;
82 ctl
->pid
= get_pid(task_pid(current
));
83 file
->private_data
= ctl
;
84 write_lock_irqsave(&card
->ctl_files_rwlock
, flags
);
85 list_add_tail(&ctl
->list
, &card
->ctl_files
);
86 write_unlock_irqrestore(&card
->ctl_files_rwlock
, flags
);
90 module_put(card
->module
);
92 snd_card_file_remove(card
, file
);
97 static void snd_ctl_empty_read_queue(struct snd_ctl_file
* ctl
)
100 struct snd_kctl_event
*cread
;
102 spin_lock_irqsave(&ctl
->read_lock
, flags
);
103 while (!list_empty(&ctl
->events
)) {
104 cread
= snd_kctl_event(ctl
->events
.next
);
105 list_del(&cread
->list
);
108 spin_unlock_irqrestore(&ctl
->read_lock
, flags
);
111 static int snd_ctl_release(struct inode
*inode
, struct file
*file
)
114 struct snd_card
*card
;
115 struct snd_ctl_file
*ctl
;
116 struct snd_kcontrol
*control
;
119 ctl
= file
->private_data
;
120 file
->private_data
= NULL
;
122 write_lock_irqsave(&card
->ctl_files_rwlock
, flags
);
123 list_del(&ctl
->list
);
124 write_unlock_irqrestore(&card
->ctl_files_rwlock
, flags
);
125 down_write(&card
->controls_rwsem
);
126 list_for_each_entry(control
, &card
->controls
, list
)
127 for (idx
= 0; idx
< control
->count
; idx
++)
128 if (control
->vd
[idx
].owner
== ctl
)
129 control
->vd
[idx
].owner
= NULL
;
130 up_write(&card
->controls_rwsem
);
131 snd_ctl_empty_read_queue(ctl
);
134 module_put(card
->module
);
135 snd_card_file_remove(card
, file
);
139 void snd_ctl_notify(struct snd_card
*card
, unsigned int mask
,
140 struct snd_ctl_elem_id
*id
)
143 struct snd_ctl_file
*ctl
;
144 struct snd_kctl_event
*ev
;
146 if (snd_BUG_ON(!card
|| !id
))
148 read_lock(&card
->ctl_files_rwlock
);
149 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
150 card
->mixer_oss_change_count
++;
152 list_for_each_entry(ctl
, &card
->ctl_files
, list
) {
153 if (!ctl
->subscribed
)
155 spin_lock_irqsave(&ctl
->read_lock
, flags
);
156 list_for_each_entry(ev
, &ctl
->events
, list
) {
157 if (ev
->id
.numid
== id
->numid
) {
162 ev
= kzalloc(sizeof(*ev
), GFP_ATOMIC
);
166 list_add_tail(&ev
->list
, &ctl
->events
);
168 snd_printk(KERN_ERR
"No memory available to allocate event\n");
171 wake_up(&ctl
->change_sleep
);
172 spin_unlock_irqrestore(&ctl
->read_lock
, flags
);
173 kill_fasync(&ctl
->fasync
, SIGIO
, POLL_IN
);
175 read_unlock(&card
->ctl_files_rwlock
);
178 EXPORT_SYMBOL(snd_ctl_notify
);
181 * snd_ctl_new - create a control instance from the template
182 * @control: the control template
183 * @access: the default control access
185 * Allocates a new struct snd_kcontrol instance and copies the given template
186 * to the new instance. It does not copy volatile data (access).
188 * Returns the pointer of the new instance, or NULL on failure.
190 static struct snd_kcontrol
*snd_ctl_new(struct snd_kcontrol
*control
,
193 struct snd_kcontrol
*kctl
;
196 if (snd_BUG_ON(!control
|| !control
->count
))
198 kctl
= kzalloc(sizeof(*kctl
) + sizeof(struct snd_kcontrol_volatile
) * control
->count
, GFP_KERNEL
);
200 snd_printk(KERN_ERR
"Cannot allocate control instance\n");
204 for (idx
= 0; idx
< kctl
->count
; idx
++)
205 kctl
->vd
[idx
].access
= access
;
210 * snd_ctl_new1 - create a control instance from the template
211 * @ncontrol: the initialization record
212 * @private_data: the private data to set
214 * Allocates a new struct snd_kcontrol instance and initialize from the given
215 * template. When the access field of ncontrol is 0, it's assumed as
216 * READWRITE access. When the count field is 0, it's assumes as one.
218 * Returns the pointer of the newly generated instance, or NULL on failure.
220 struct snd_kcontrol
*snd_ctl_new1(const struct snd_kcontrol_new
*ncontrol
,
223 struct snd_kcontrol kctl
;
226 if (snd_BUG_ON(!ncontrol
|| !ncontrol
->info
))
228 memset(&kctl
, 0, sizeof(kctl
));
229 kctl
.id
.iface
= ncontrol
->iface
;
230 kctl
.id
.device
= ncontrol
->device
;
231 kctl
.id
.subdevice
= ncontrol
->subdevice
;
232 if (ncontrol
->name
) {
233 strlcpy(kctl
.id
.name
, ncontrol
->name
, sizeof(kctl
.id
.name
));
234 if (strcmp(ncontrol
->name
, kctl
.id
.name
) != 0)
235 snd_printk(KERN_WARNING
236 "Control name '%s' truncated to '%s'\n",
237 ncontrol
->name
, kctl
.id
.name
);
239 kctl
.id
.index
= ncontrol
->index
;
240 kctl
.count
= ncontrol
->count
? ncontrol
->count
: 1;
241 access
= ncontrol
->access
== 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE
:
242 (ncontrol
->access
& (SNDRV_CTL_ELEM_ACCESS_READWRITE
|
243 SNDRV_CTL_ELEM_ACCESS_INACTIVE
|
244 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
|
245 SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND
|
246 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
));
247 kctl
.info
= ncontrol
->info
;
248 kctl
.get
= ncontrol
->get
;
249 kctl
.put
= ncontrol
->put
;
250 kctl
.tlv
.p
= ncontrol
->tlv
.p
;
251 kctl
.private_value
= ncontrol
->private_value
;
252 kctl
.private_data
= private_data
;
253 return snd_ctl_new(&kctl
, access
);
256 EXPORT_SYMBOL(snd_ctl_new1
);
259 * snd_ctl_free_one - release the control instance
260 * @kcontrol: the control instance
262 * Releases the control instance created via snd_ctl_new()
264 * Don't call this after the control was added to the card.
266 void snd_ctl_free_one(struct snd_kcontrol
*kcontrol
)
269 if (kcontrol
->private_free
)
270 kcontrol
->private_free(kcontrol
);
275 EXPORT_SYMBOL(snd_ctl_free_one
);
277 static unsigned int snd_ctl_hole_check(struct snd_card
*card
,
280 struct snd_kcontrol
*kctl
;
282 list_for_each_entry(kctl
, &card
->controls
, list
) {
283 if ((kctl
->id
.numid
<= card
->last_numid
&&
284 kctl
->id
.numid
+ kctl
->count
> card
->last_numid
) ||
285 (kctl
->id
.numid
<= card
->last_numid
+ count
- 1 &&
286 kctl
->id
.numid
+ kctl
->count
> card
->last_numid
+ count
- 1))
287 return card
->last_numid
= kctl
->id
.numid
+ kctl
->count
- 1;
289 return card
->last_numid
;
292 static int snd_ctl_find_hole(struct snd_card
*card
, unsigned int count
)
294 unsigned int last_numid
, iter
= 100000;
296 last_numid
= card
->last_numid
;
297 while (last_numid
!= snd_ctl_hole_check(card
, count
)) {
299 /* this situation is very unlikely */
300 snd_printk(KERN_ERR
"unable to allocate new control numid\n");
303 last_numid
= card
->last_numid
;
309 * snd_ctl_add - add the control instance to the card
310 * @card: the card instance
311 * @kcontrol: the control instance to add
313 * Adds the control instance created via snd_ctl_new() or
314 * snd_ctl_new1() to the given card. Assigns also an unique
315 * numid used for fast search.
317 * Returns zero if successful, or a negative error code on failure.
319 * It frees automatically the control which cannot be added.
321 int snd_ctl_add(struct snd_card
*card
, struct snd_kcontrol
*kcontrol
)
323 struct snd_ctl_elem_id id
;
329 if (snd_BUG_ON(!card
|| !kcontrol
->info
))
332 down_write(&card
->controls_rwsem
);
333 if (snd_ctl_find_id(card
, &id
)) {
334 up_write(&card
->controls_rwsem
);
335 snd_printd(KERN_ERR
"control %i:%i:%i:%s:%i is already present\n",
344 if (snd_ctl_find_hole(card
, kcontrol
->count
) < 0) {
345 up_write(&card
->controls_rwsem
);
349 list_add_tail(&kcontrol
->list
, &card
->controls
);
350 card
->controls_count
+= kcontrol
->count
;
351 kcontrol
->id
.numid
= card
->last_numid
+ 1;
352 card
->last_numid
+= kcontrol
->count
;
353 up_write(&card
->controls_rwsem
);
354 for (idx
= 0; idx
< kcontrol
->count
; idx
++, id
.index
++, id
.numid
++)
355 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_ADD
, &id
);
359 snd_ctl_free_one(kcontrol
);
363 EXPORT_SYMBOL(snd_ctl_add
);
366 * snd_ctl_remove - remove the control from the card and release it
367 * @card: the card instance
368 * @kcontrol: the control instance to remove
370 * Removes the control from the card and then releases the instance.
371 * You don't need to call snd_ctl_free_one(). You must be in
372 * the write lock - down_write(&card->controls_rwsem).
374 * Returns 0 if successful, or a negative error code on failure.
376 int snd_ctl_remove(struct snd_card
*card
, struct snd_kcontrol
*kcontrol
)
378 struct snd_ctl_elem_id id
;
381 if (snd_BUG_ON(!card
|| !kcontrol
))
383 list_del(&kcontrol
->list
);
384 card
->controls_count
-= kcontrol
->count
;
386 for (idx
= 0; idx
< kcontrol
->count
; idx
++, id
.index
++, id
.numid
++)
387 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_REMOVE
, &id
);
388 snd_ctl_free_one(kcontrol
);
392 EXPORT_SYMBOL(snd_ctl_remove
);
395 * snd_ctl_remove_id - remove the control of the given id and release it
396 * @card: the card instance
397 * @id: the control id to remove
399 * Finds the control instance with the given id, removes it from the
400 * card list and releases it.
402 * Returns 0 if successful, or a negative error code on failure.
404 int snd_ctl_remove_id(struct snd_card
*card
, struct snd_ctl_elem_id
*id
)
406 struct snd_kcontrol
*kctl
;
409 down_write(&card
->controls_rwsem
);
410 kctl
= snd_ctl_find_id(card
, id
);
412 up_write(&card
->controls_rwsem
);
415 ret
= snd_ctl_remove(card
, kctl
);
416 up_write(&card
->controls_rwsem
);
420 EXPORT_SYMBOL(snd_ctl_remove_id
);
423 * snd_ctl_remove_user_ctl - remove and release the unlocked user control
424 * @file: active control handle
425 * @id: the control id to remove
427 * Finds the control instance with the given id, removes it from the
428 * card list and releases it.
430 * Returns 0 if successful, or a negative error code on failure.
432 static int snd_ctl_remove_user_ctl(struct snd_ctl_file
* file
,
433 struct snd_ctl_elem_id
*id
)
435 struct snd_card
*card
= file
->card
;
436 struct snd_kcontrol
*kctl
;
439 down_write(&card
->controls_rwsem
);
440 kctl
= snd_ctl_find_id(card
, id
);
445 if (!(kctl
->vd
[0].access
& SNDRV_CTL_ELEM_ACCESS_USER
)) {
449 for (idx
= 0; idx
< kctl
->count
; idx
++)
450 if (kctl
->vd
[idx
].owner
!= NULL
&& kctl
->vd
[idx
].owner
!= file
) {
454 ret
= snd_ctl_remove(card
, kctl
);
457 card
->user_ctl_count
--;
459 up_write(&card
->controls_rwsem
);
464 * snd_ctl_rename_id - replace the id of a control on the card
465 * @card: the card instance
466 * @src_id: the old id
467 * @dst_id: the new id
469 * Finds the control with the old id from the card, and replaces the
470 * id with the new one.
472 * Returns zero if successful, or a negative error code on failure.
474 int snd_ctl_rename_id(struct snd_card
*card
, struct snd_ctl_elem_id
*src_id
,
475 struct snd_ctl_elem_id
*dst_id
)
477 struct snd_kcontrol
*kctl
;
479 down_write(&card
->controls_rwsem
);
480 kctl
= snd_ctl_find_id(card
, src_id
);
482 up_write(&card
->controls_rwsem
);
486 kctl
->id
.numid
= card
->last_numid
+ 1;
487 card
->last_numid
+= kctl
->count
;
488 up_write(&card
->controls_rwsem
);
492 EXPORT_SYMBOL(snd_ctl_rename_id
);
495 * snd_ctl_find_numid - find the control instance with the given number-id
496 * @card: the card instance
497 * @numid: the number-id to search
499 * Finds the control instance with the given number-id from the card.
501 * Returns the pointer of the instance if found, or NULL if not.
503 * The caller must down card->controls_rwsem before calling this function
504 * (if the race condition can happen).
506 struct snd_kcontrol
*snd_ctl_find_numid(struct snd_card
*card
, unsigned int numid
)
508 struct snd_kcontrol
*kctl
;
510 if (snd_BUG_ON(!card
|| !numid
))
512 list_for_each_entry(kctl
, &card
->controls
, list
) {
513 if (kctl
->id
.numid
<= numid
&& kctl
->id
.numid
+ kctl
->count
> numid
)
519 EXPORT_SYMBOL(snd_ctl_find_numid
);
522 * snd_ctl_find_id - find the control instance with the given id
523 * @card: the card instance
524 * @id: the id to search
526 * Finds the control instance with the given id from the card.
528 * Returns the pointer of the instance if found, or NULL if not.
530 * The caller must down card->controls_rwsem before calling this function
531 * (if the race condition can happen).
533 struct snd_kcontrol
*snd_ctl_find_id(struct snd_card
*card
,
534 struct snd_ctl_elem_id
*id
)
536 struct snd_kcontrol
*kctl
;
538 if (snd_BUG_ON(!card
|| !id
))
541 return snd_ctl_find_numid(card
, id
->numid
);
542 list_for_each_entry(kctl
, &card
->controls
, list
) {
543 if (kctl
->id
.iface
!= id
->iface
)
545 if (kctl
->id
.device
!= id
->device
)
547 if (kctl
->id
.subdevice
!= id
->subdevice
)
549 if (strncmp(kctl
->id
.name
, id
->name
, sizeof(kctl
->id
.name
)))
551 if (kctl
->id
.index
> id
->index
)
553 if (kctl
->id
.index
+ kctl
->count
<= id
->index
)
560 EXPORT_SYMBOL(snd_ctl_find_id
);
562 static int snd_ctl_card_info(struct snd_card
*card
, struct snd_ctl_file
* ctl
,
563 unsigned int cmd
, void __user
*arg
)
565 struct snd_ctl_card_info
*info
;
567 info
= kzalloc(sizeof(*info
), GFP_KERNEL
);
570 down_read(&snd_ioctl_rwsem
);
571 info
->card
= card
->number
;
572 strlcpy(info
->id
, card
->id
, sizeof(info
->id
));
573 strlcpy(info
->driver
, card
->driver
, sizeof(info
->driver
));
574 strlcpy(info
->name
, card
->shortname
, sizeof(info
->name
));
575 strlcpy(info
->longname
, card
->longname
, sizeof(info
->longname
));
576 strlcpy(info
->mixername
, card
->mixername
, sizeof(info
->mixername
));
577 strlcpy(info
->components
, card
->components
, sizeof(info
->components
));
578 up_read(&snd_ioctl_rwsem
);
579 if (copy_to_user(arg
, info
, sizeof(struct snd_ctl_card_info
))) {
587 static int snd_ctl_elem_list(struct snd_card
*card
,
588 struct snd_ctl_elem_list __user
*_list
)
590 struct list_head
*plist
;
591 struct snd_ctl_elem_list list
;
592 struct snd_kcontrol
*kctl
;
593 struct snd_ctl_elem_id
*dst
, *id
;
594 unsigned int offset
, space
, first
, jidx
;
596 if (copy_from_user(&list
, _list
, sizeof(list
)))
598 offset
= list
.offset
;
601 /* try limit maximum space */
605 /* allocate temporary buffer for atomic operation */
606 dst
= vmalloc(space
* sizeof(struct snd_ctl_elem_id
));
609 down_read(&card
->controls_rwsem
);
610 list
.count
= card
->controls_count
;
611 plist
= card
->controls
.next
;
612 while (plist
!= &card
->controls
) {
615 kctl
= snd_kcontrol(plist
);
616 if (offset
< kctl
->count
)
618 offset
-= kctl
->count
;
623 while (space
> 0 && plist
!= &card
->controls
) {
624 kctl
= snd_kcontrol(plist
);
625 for (jidx
= offset
; space
> 0 && jidx
< kctl
->count
; jidx
++) {
626 snd_ctl_build_ioff(id
, kctl
, jidx
);
634 up_read(&card
->controls_rwsem
);
636 copy_to_user(list
.pids
, dst
,
637 list
.used
* sizeof(struct snd_ctl_elem_id
))) {
643 down_read(&card
->controls_rwsem
);
644 list
.count
= card
->controls_count
;
645 up_read(&card
->controls_rwsem
);
647 if (copy_to_user(_list
, &list
, sizeof(list
)))
652 static int snd_ctl_elem_info(struct snd_ctl_file
*ctl
,
653 struct snd_ctl_elem_info
*info
)
655 struct snd_card
*card
= ctl
->card
;
656 struct snd_kcontrol
*kctl
;
657 struct snd_kcontrol_volatile
*vd
;
658 unsigned int index_offset
;
661 down_read(&card
->controls_rwsem
);
662 kctl
= snd_ctl_find_id(card
, &info
->id
);
664 up_read(&card
->controls_rwsem
);
667 #ifdef CONFIG_SND_DEBUG
670 result
= kctl
->info(kctl
, info
);
672 snd_BUG_ON(info
->access
);
673 index_offset
= snd_ctl_get_ioff(kctl
, &info
->id
);
674 vd
= &kctl
->vd
[index_offset
];
675 snd_ctl_build_ioff(&info
->id
, kctl
, index_offset
);
676 info
->access
= vd
->access
;
678 info
->access
|= SNDRV_CTL_ELEM_ACCESS_LOCK
;
679 if (vd
->owner
== ctl
)
680 info
->access
|= SNDRV_CTL_ELEM_ACCESS_OWNER
;
681 info
->owner
= pid_vnr(vd
->owner
->pid
);
686 up_read(&card
->controls_rwsem
);
690 static int snd_ctl_elem_info_user(struct snd_ctl_file
*ctl
,
691 struct snd_ctl_elem_info __user
*_info
)
693 struct snd_ctl_elem_info info
;
696 if (copy_from_user(&info
, _info
, sizeof(info
)))
698 snd_power_lock(ctl
->card
);
699 result
= snd_power_wait(ctl
->card
, SNDRV_CTL_POWER_D0
);
701 result
= snd_ctl_elem_info(ctl
, &info
);
702 snd_power_unlock(ctl
->card
);
704 if (copy_to_user(_info
, &info
, sizeof(info
)))
709 static int snd_ctl_elem_read(struct snd_card
*card
,
710 struct snd_ctl_elem_value
*control
)
712 struct snd_kcontrol
*kctl
;
713 struct snd_kcontrol_volatile
*vd
;
714 unsigned int index_offset
;
717 down_read(&card
->controls_rwsem
);
718 kctl
= snd_ctl_find_id(card
, &control
->id
);
722 index_offset
= snd_ctl_get_ioff(kctl
, &control
->id
);
723 vd
= &kctl
->vd
[index_offset
];
724 if ((vd
->access
& SNDRV_CTL_ELEM_ACCESS_READ
) &&
726 snd_ctl_build_ioff(&control
->id
, kctl
, index_offset
);
727 result
= kctl
->get(kctl
, control
);
731 up_read(&card
->controls_rwsem
);
735 static int snd_ctl_elem_read_user(struct snd_card
*card
,
736 struct snd_ctl_elem_value __user
*_control
)
738 struct snd_ctl_elem_value
*control
;
741 control
= memdup_user(_control
, sizeof(*control
));
743 return PTR_ERR(control
);
745 snd_power_lock(card
);
746 result
= snd_power_wait(card
, SNDRV_CTL_POWER_D0
);
748 result
= snd_ctl_elem_read(card
, control
);
749 snd_power_unlock(card
);
751 if (copy_to_user(_control
, control
, sizeof(*control
)))
757 static int snd_ctl_elem_write(struct snd_card
*card
, struct snd_ctl_file
*file
,
758 struct snd_ctl_elem_value
*control
)
760 struct snd_kcontrol
*kctl
;
761 struct snd_kcontrol_volatile
*vd
;
762 unsigned int index_offset
;
765 down_read(&card
->controls_rwsem
);
766 kctl
= snd_ctl_find_id(card
, &control
->id
);
770 index_offset
= snd_ctl_get_ioff(kctl
, &control
->id
);
771 vd
= &kctl
->vd
[index_offset
];
772 if (!(vd
->access
& SNDRV_CTL_ELEM_ACCESS_WRITE
) ||
774 (file
&& vd
->owner
&& vd
->owner
!= file
)) {
777 snd_ctl_build_ioff(&control
->id
, kctl
, index_offset
);
778 result
= kctl
->put(kctl
, control
);
781 up_read(&card
->controls_rwsem
);
782 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_VALUE
,
787 up_read(&card
->controls_rwsem
);
791 static int snd_ctl_elem_write_user(struct snd_ctl_file
*file
,
792 struct snd_ctl_elem_value __user
*_control
)
794 struct snd_ctl_elem_value
*control
;
795 struct snd_card
*card
;
798 control
= memdup_user(_control
, sizeof(*control
));
800 return PTR_ERR(control
);
803 snd_power_lock(card
);
804 result
= snd_power_wait(card
, SNDRV_CTL_POWER_D0
);
806 result
= snd_ctl_elem_write(card
, file
, control
);
807 snd_power_unlock(card
);
809 if (copy_to_user(_control
, control
, sizeof(*control
)))
815 static int snd_ctl_elem_lock(struct snd_ctl_file
*file
,
816 struct snd_ctl_elem_id __user
*_id
)
818 struct snd_card
*card
= file
->card
;
819 struct snd_ctl_elem_id id
;
820 struct snd_kcontrol
*kctl
;
821 struct snd_kcontrol_volatile
*vd
;
824 if (copy_from_user(&id
, _id
, sizeof(id
)))
826 down_write(&card
->controls_rwsem
);
827 kctl
= snd_ctl_find_id(card
, &id
);
831 vd
= &kctl
->vd
[snd_ctl_get_ioff(kctl
, &id
)];
832 if (vd
->owner
!= NULL
)
839 up_write(&card
->controls_rwsem
);
843 static int snd_ctl_elem_unlock(struct snd_ctl_file
*file
,
844 struct snd_ctl_elem_id __user
*_id
)
846 struct snd_card
*card
= file
->card
;
847 struct snd_ctl_elem_id id
;
848 struct snd_kcontrol
*kctl
;
849 struct snd_kcontrol_volatile
*vd
;
852 if (copy_from_user(&id
, _id
, sizeof(id
)))
854 down_write(&card
->controls_rwsem
);
855 kctl
= snd_ctl_find_id(card
, &id
);
859 vd
= &kctl
->vd
[snd_ctl_get_ioff(kctl
, &id
)];
860 if (vd
->owner
== NULL
)
862 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 */
926 new_data
= memdup_user(tlv
, size
);
927 if (IS_ERR(new_data
))
928 return PTR_ERR(new_data
);
929 change
= ue
->tlv_data_size
!= size
;
931 change
= memcmp(ue
->tlv_data
, new_data
, size
);
933 ue
->tlv_data
= new_data
;
934 ue
->tlv_data_size
= size
;
936 if (! ue
->tlv_data_size
|| ! ue
->tlv_data
)
938 if (size
< ue
->tlv_data_size
)
940 if (copy_to_user(tlv
, ue
->tlv_data
, ue
->tlv_data_size
))
946 static void snd_ctl_elem_user_free(struct snd_kcontrol
*kcontrol
)
948 struct user_element
*ue
= kcontrol
->private_data
;
954 static int snd_ctl_elem_add(struct snd_ctl_file
*file
,
955 struct snd_ctl_elem_info
*info
, int replace
)
957 struct snd_card
*card
= file
->card
;
958 struct snd_kcontrol kctl
, *_kctl
;
961 struct user_element
*ue
;
964 if (card
->user_ctl_count
>= MAX_USER_CONTROLS
)
968 access
= info
->access
== 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE
:
969 (info
->access
& (SNDRV_CTL_ELEM_ACCESS_READWRITE
|
970 SNDRV_CTL_ELEM_ACCESS_INACTIVE
|
971 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
));
973 memset(&kctl
, 0, sizeof(kctl
));
974 down_write(&card
->controls_rwsem
);
975 _kctl
= snd_ctl_find_id(card
, &info
->id
);
979 err
= snd_ctl_remove(card
, _kctl
);
986 up_write(&card
->controls_rwsem
);
989 memcpy(&kctl
.id
, &info
->id
, sizeof(info
->id
));
990 kctl
.count
= info
->owner
? info
->owner
: 1;
991 access
|= SNDRV_CTL_ELEM_ACCESS_USER
;
992 kctl
.info
= snd_ctl_elem_user_info
;
993 if (access
& SNDRV_CTL_ELEM_ACCESS_READ
)
994 kctl
.get
= snd_ctl_elem_user_get
;
995 if (access
& SNDRV_CTL_ELEM_ACCESS_WRITE
)
996 kctl
.put
= snd_ctl_elem_user_put
;
997 if (access
& SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
) {
998 kctl
.tlv
.c
= snd_ctl_elem_user_tlv
;
999 access
|= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
;
1001 switch (info
->type
) {
1002 case SNDRV_CTL_ELEM_TYPE_BOOLEAN
:
1003 case SNDRV_CTL_ELEM_TYPE_INTEGER
:
1004 private_size
= sizeof(long);
1005 if (info
->count
> 128)
1008 case SNDRV_CTL_ELEM_TYPE_INTEGER64
:
1009 private_size
= sizeof(long long);
1010 if (info
->count
> 64)
1013 case SNDRV_CTL_ELEM_TYPE_BYTES
:
1014 private_size
= sizeof(unsigned char);
1015 if (info
->count
> 512)
1018 case SNDRV_CTL_ELEM_TYPE_IEC958
:
1019 private_size
= sizeof(struct snd_aes_iec958
);
1020 if (info
->count
!= 1)
1026 private_size
*= info
->count
;
1027 ue
= kzalloc(sizeof(struct user_element
) + private_size
, GFP_KERNEL
);
1031 ue
->info
.access
= 0;
1032 ue
->elem_data
= (char *)ue
+ sizeof(*ue
);
1033 ue
->elem_data_size
= private_size
;
1034 kctl
.private_free
= snd_ctl_elem_user_free
;
1035 _kctl
= snd_ctl_new(&kctl
, access
);
1036 if (_kctl
== NULL
) {
1040 _kctl
->private_data
= ue
;
1041 for (idx
= 0; idx
< _kctl
->count
; idx
++)
1042 _kctl
->vd
[idx
].owner
= file
;
1043 err
= snd_ctl_add(card
, _kctl
);
1047 down_write(&card
->controls_rwsem
);
1048 card
->user_ctl_count
++;
1049 up_write(&card
->controls_rwsem
);
1054 static int snd_ctl_elem_add_user(struct snd_ctl_file
*file
,
1055 struct snd_ctl_elem_info __user
*_info
, int replace
)
1057 struct snd_ctl_elem_info info
;
1058 if (copy_from_user(&info
, _info
, sizeof(info
)))
1060 return snd_ctl_elem_add(file
, &info
, replace
);
1063 static int snd_ctl_elem_remove(struct snd_ctl_file
*file
,
1064 struct snd_ctl_elem_id __user
*_id
)
1066 struct snd_ctl_elem_id id
;
1068 if (copy_from_user(&id
, _id
, sizeof(id
)))
1070 return snd_ctl_remove_user_ctl(file
, &id
);
1073 static int snd_ctl_subscribe_events(struct snd_ctl_file
*file
, int __user
*ptr
)
1076 if (get_user(subscribe
, ptr
))
1078 if (subscribe
< 0) {
1079 subscribe
= file
->subscribed
;
1080 if (put_user(subscribe
, ptr
))
1085 file
->subscribed
= 1;
1087 } else if (file
->subscribed
) {
1088 snd_ctl_empty_read_queue(file
);
1089 file
->subscribed
= 0;
1094 static int snd_ctl_tlv_ioctl(struct snd_ctl_file
*file
,
1095 struct snd_ctl_tlv __user
*_tlv
,
1098 struct snd_card
*card
= file
->card
;
1099 struct snd_ctl_tlv tlv
;
1100 struct snd_kcontrol
*kctl
;
1101 struct snd_kcontrol_volatile
*vd
;
1105 if (copy_from_user(&tlv
, _tlv
, sizeof(tlv
)))
1107 if (tlv
.length
< sizeof(unsigned int) * 2)
1109 down_read(&card
->controls_rwsem
);
1110 kctl
= snd_ctl_find_numid(card
, tlv
.numid
);
1115 if (kctl
->tlv
.p
== NULL
) {
1119 vd
= &kctl
->vd
[tlv
.numid
- kctl
->id
.numid
];
1120 if ((op_flag
== 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_READ
) == 0) ||
1121 (op_flag
> 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_WRITE
) == 0) ||
1122 (op_flag
< 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND
) == 0)) {
1126 if (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
) {
1127 if (vd
->owner
!= NULL
&& vd
->owner
!= file
) {
1131 err
= kctl
->tlv
.c(kctl
, op_flag
, tlv
.length
, _tlv
->tlv
);
1133 up_read(&card
->controls_rwsem
);
1134 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_TLV
, &kctl
->id
);
1142 len
= kctl
->tlv
.p
[1] + 2 * sizeof(unsigned int);
1143 if (tlv
.length
< len
) {
1147 if (copy_to_user(_tlv
->tlv
, kctl
->tlv
.p
, len
))
1151 up_read(&card
->controls_rwsem
);
1155 static long snd_ctl_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
1157 struct snd_ctl_file
*ctl
;
1158 struct snd_card
*card
;
1159 struct snd_kctl_ioctl
*p
;
1160 void __user
*argp
= (void __user
*)arg
;
1161 int __user
*ip
= argp
;
1164 ctl
= file
->private_data
;
1166 if (snd_BUG_ON(!card
))
1169 case SNDRV_CTL_IOCTL_PVERSION
:
1170 return put_user(SNDRV_CTL_VERSION
, ip
) ? -EFAULT
: 0;
1171 case SNDRV_CTL_IOCTL_CARD_INFO
:
1172 return snd_ctl_card_info(card
, ctl
, cmd
, argp
);
1173 case SNDRV_CTL_IOCTL_ELEM_LIST
:
1174 return snd_ctl_elem_list(card
, argp
);
1175 case SNDRV_CTL_IOCTL_ELEM_INFO
:
1176 return snd_ctl_elem_info_user(ctl
, argp
);
1177 case SNDRV_CTL_IOCTL_ELEM_READ
:
1178 return snd_ctl_elem_read_user(card
, argp
);
1179 case SNDRV_CTL_IOCTL_ELEM_WRITE
:
1180 return snd_ctl_elem_write_user(ctl
, argp
);
1181 case SNDRV_CTL_IOCTL_ELEM_LOCK
:
1182 return snd_ctl_elem_lock(ctl
, argp
);
1183 case SNDRV_CTL_IOCTL_ELEM_UNLOCK
:
1184 return snd_ctl_elem_unlock(ctl
, argp
);
1185 case SNDRV_CTL_IOCTL_ELEM_ADD
:
1186 return snd_ctl_elem_add_user(ctl
, argp
, 0);
1187 case SNDRV_CTL_IOCTL_ELEM_REPLACE
:
1188 return snd_ctl_elem_add_user(ctl
, argp
, 1);
1189 case SNDRV_CTL_IOCTL_ELEM_REMOVE
:
1190 return snd_ctl_elem_remove(ctl
, argp
);
1191 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS
:
1192 return snd_ctl_subscribe_events(ctl
, ip
);
1193 case SNDRV_CTL_IOCTL_TLV_READ
:
1194 return snd_ctl_tlv_ioctl(ctl
, argp
, 0);
1195 case SNDRV_CTL_IOCTL_TLV_WRITE
:
1196 return snd_ctl_tlv_ioctl(ctl
, argp
, 1);
1197 case SNDRV_CTL_IOCTL_TLV_COMMAND
:
1198 return snd_ctl_tlv_ioctl(ctl
, argp
, -1);
1199 case SNDRV_CTL_IOCTL_POWER
:
1200 return -ENOPROTOOPT
;
1201 case SNDRV_CTL_IOCTL_POWER_STATE
:
1203 return put_user(card
->power_state
, ip
) ? -EFAULT
: 0;
1205 return put_user(SNDRV_CTL_POWER_D0
, ip
) ? -EFAULT
: 0;
1208 down_read(&snd_ioctl_rwsem
);
1209 list_for_each_entry(p
, &snd_control_ioctls
, list
) {
1210 err
= p
->fioctl(card
, ctl
, cmd
, arg
);
1211 if (err
!= -ENOIOCTLCMD
) {
1212 up_read(&snd_ioctl_rwsem
);
1216 up_read(&snd_ioctl_rwsem
);
1217 snd_printdd("unknown ioctl = 0x%x\n", cmd
);
1221 static ssize_t
snd_ctl_read(struct file
*file
, char __user
*buffer
,
1222 size_t count
, loff_t
* offset
)
1224 struct snd_ctl_file
*ctl
;
1228 ctl
= file
->private_data
;
1229 if (snd_BUG_ON(!ctl
|| !ctl
->card
))
1231 if (!ctl
->subscribed
)
1233 if (count
< sizeof(struct snd_ctl_event
))
1235 spin_lock_irq(&ctl
->read_lock
);
1236 while (count
>= sizeof(struct snd_ctl_event
)) {
1237 struct snd_ctl_event ev
;
1238 struct snd_kctl_event
*kev
;
1239 while (list_empty(&ctl
->events
)) {
1241 if ((file
->f_flags
& O_NONBLOCK
) != 0 || result
> 0) {
1245 init_waitqueue_entry(&wait
, current
);
1246 add_wait_queue(&ctl
->change_sleep
, &wait
);
1247 set_current_state(TASK_INTERRUPTIBLE
);
1248 spin_unlock_irq(&ctl
->read_lock
);
1250 remove_wait_queue(&ctl
->change_sleep
, &wait
);
1251 if (signal_pending(current
))
1252 return -ERESTARTSYS
;
1253 spin_lock_irq(&ctl
->read_lock
);
1255 kev
= snd_kctl_event(ctl
->events
.next
);
1256 ev
.type
= SNDRV_CTL_EVENT_ELEM
;
1257 ev
.data
.elem
.mask
= kev
->mask
;
1258 ev
.data
.elem
.id
= kev
->id
;
1259 list_del(&kev
->list
);
1260 spin_unlock_irq(&ctl
->read_lock
);
1262 if (copy_to_user(buffer
, &ev
, sizeof(struct snd_ctl_event
))) {
1266 spin_lock_irq(&ctl
->read_lock
);
1267 buffer
+= sizeof(struct snd_ctl_event
);
1268 count
-= sizeof(struct snd_ctl_event
);
1269 result
+= sizeof(struct snd_ctl_event
);
1272 spin_unlock_irq(&ctl
->read_lock
);
1274 return result
> 0 ? result
: err
;
1277 static unsigned int snd_ctl_poll(struct file
*file
, poll_table
* wait
)
1280 struct snd_ctl_file
*ctl
;
1282 ctl
= file
->private_data
;
1283 if (!ctl
->subscribed
)
1285 poll_wait(file
, &ctl
->change_sleep
, wait
);
1288 if (!list_empty(&ctl
->events
))
1289 mask
|= POLLIN
| POLLRDNORM
;
1295 * register the device-specific control-ioctls.
1296 * called from each device manager like pcm.c, hwdep.c, etc.
1298 static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn
, struct list_head
*lists
)
1300 struct snd_kctl_ioctl
*pn
;
1302 pn
= kzalloc(sizeof(struct snd_kctl_ioctl
), GFP_KERNEL
);
1306 down_write(&snd_ioctl_rwsem
);
1307 list_add_tail(&pn
->list
, lists
);
1308 up_write(&snd_ioctl_rwsem
);
1312 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn
)
1314 return _snd_ctl_register_ioctl(fcn
, &snd_control_ioctls
);
1317 EXPORT_SYMBOL(snd_ctl_register_ioctl
);
1319 #ifdef CONFIG_COMPAT
1320 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn
)
1322 return _snd_ctl_register_ioctl(fcn
, &snd_control_compat_ioctls
);
1325 EXPORT_SYMBOL(snd_ctl_register_ioctl_compat
);
1329 * de-register the device-specific control-ioctls.
1331 static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn
,
1332 struct list_head
*lists
)
1334 struct snd_kctl_ioctl
*p
;
1336 if (snd_BUG_ON(!fcn
))
1338 down_write(&snd_ioctl_rwsem
);
1339 list_for_each_entry(p
, lists
, list
) {
1340 if (p
->fioctl
== fcn
) {
1342 up_write(&snd_ioctl_rwsem
);
1347 up_write(&snd_ioctl_rwsem
);
1352 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn
)
1354 return _snd_ctl_unregister_ioctl(fcn
, &snd_control_ioctls
);
1357 EXPORT_SYMBOL(snd_ctl_unregister_ioctl
);
1359 #ifdef CONFIG_COMPAT
1360 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn
)
1362 return _snd_ctl_unregister_ioctl(fcn
, &snd_control_compat_ioctls
);
1365 EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat
);
1368 static int snd_ctl_fasync(int fd
, struct file
* file
, int on
)
1370 struct snd_ctl_file
*ctl
;
1372 ctl
= file
->private_data
;
1373 return fasync_helper(fd
, file
, on
, &ctl
->fasync
);
1379 #ifdef CONFIG_COMPAT
1380 #include "control_compat.c"
1382 #define snd_ctl_ioctl_compat NULL
1389 static const struct file_operations snd_ctl_f_ops
=
1391 .owner
= THIS_MODULE
,
1392 .read
= snd_ctl_read
,
1393 .open
= snd_ctl_open
,
1394 .release
= snd_ctl_release
,
1395 .llseek
= no_llseek
,
1396 .poll
= snd_ctl_poll
,
1397 .unlocked_ioctl
= snd_ctl_ioctl
,
1398 .compat_ioctl
= snd_ctl_ioctl_compat
,
1399 .fasync
= snd_ctl_fasync
,
1403 * registration of the control device
1405 static int snd_ctl_dev_register(struct snd_device
*device
)
1407 struct snd_card
*card
= device
->device_data
;
1411 if (snd_BUG_ON(!card
))
1413 cardnum
= card
->number
;
1414 if (snd_BUG_ON(cardnum
< 0 || cardnum
>= SNDRV_CARDS
))
1416 sprintf(name
, "controlC%i", cardnum
);
1417 if ((err
= snd_register_device(SNDRV_DEVICE_TYPE_CONTROL
, card
, -1,
1418 &snd_ctl_f_ops
, card
, name
)) < 0)
1424 * disconnection of the control device
1426 static int snd_ctl_dev_disconnect(struct snd_device
*device
)
1428 struct snd_card
*card
= device
->device_data
;
1429 struct snd_ctl_file
*ctl
;
1432 if (snd_BUG_ON(!card
))
1434 cardnum
= card
->number
;
1435 if (snd_BUG_ON(cardnum
< 0 || cardnum
>= SNDRV_CARDS
))
1438 read_lock(&card
->ctl_files_rwlock
);
1439 list_for_each_entry(ctl
, &card
->ctl_files
, list
) {
1440 wake_up(&ctl
->change_sleep
);
1441 kill_fasync(&ctl
->fasync
, SIGIO
, POLL_ERR
);
1443 read_unlock(&card
->ctl_files_rwlock
);
1445 if ((err
= snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL
,
1454 static int snd_ctl_dev_free(struct snd_device
*device
)
1456 struct snd_card
*card
= device
->device_data
;
1457 struct snd_kcontrol
*control
;
1459 down_write(&card
->controls_rwsem
);
1460 while (!list_empty(&card
->controls
)) {
1461 control
= snd_kcontrol(card
->controls
.next
);
1462 snd_ctl_remove(card
, control
);
1464 up_write(&card
->controls_rwsem
);
1469 * create control core:
1470 * called from init.c
1472 int snd_ctl_create(struct snd_card
*card
)
1474 static struct snd_device_ops ops
= {
1475 .dev_free
= snd_ctl_dev_free
,
1476 .dev_register
= snd_ctl_dev_register
,
1477 .dev_disconnect
= snd_ctl_dev_disconnect
,
1480 if (snd_BUG_ON(!card
))
1482 return snd_device_new(card
, SNDRV_DEV_CONTROL
, card
, &ops
);
1486 * Frequently used control callbacks
1488 int snd_ctl_boolean_mono_info(struct snd_kcontrol
*kcontrol
,
1489 struct snd_ctl_elem_info
*uinfo
)
1491 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1493 uinfo
->value
.integer
.min
= 0;
1494 uinfo
->value
.integer
.max
= 1;
1498 EXPORT_SYMBOL(snd_ctl_boolean_mono_info
);
1500 int snd_ctl_boolean_stereo_info(struct snd_kcontrol
*kcontrol
,
1501 struct snd_ctl_elem_info
*uinfo
)
1503 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1505 uinfo
->value
.integer
.min
= 0;
1506 uinfo
->value
.integer
.max
= 1;
1510 EXPORT_SYMBOL(snd_ctl_boolean_stereo_info
);