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 card
= snd_lookup_minor_data(iminor(inode
), SNDRV_DEVICE_TYPE_CONTROL
);
58 err
= snd_card_file_add(card
, file
);
63 if (!try_module_get(card
->module
)) {
67 ctl
= kzalloc(sizeof(*ctl
), GFP_KERNEL
);
72 INIT_LIST_HEAD(&ctl
->events
);
73 init_waitqueue_head(&ctl
->change_sleep
);
74 spin_lock_init(&ctl
->read_lock
);
76 ctl
->prefer_pcm_subdevice
= -1;
77 ctl
->prefer_rawmidi_subdevice
= -1;
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
)
96 struct snd_kctl_event
*cread
;
98 spin_lock_irqsave(&ctl
->read_lock
, flags
);
99 while (!list_empty(&ctl
->events
)) {
100 cread
= snd_kctl_event(ctl
->events
.next
);
101 list_del(&cread
->list
);
104 spin_unlock_irqrestore(&ctl
->read_lock
, flags
);
107 static int snd_ctl_release(struct inode
*inode
, struct file
*file
)
110 struct snd_card
*card
;
111 struct snd_ctl_file
*ctl
;
112 struct snd_kcontrol
*control
;
115 ctl
= file
->private_data
;
116 fasync_helper(-1, file
, 0, &ctl
->fasync
);
117 file
->private_data
= NULL
;
119 write_lock_irqsave(&card
->ctl_files_rwlock
, flags
);
120 list_del(&ctl
->list
);
121 write_unlock_irqrestore(&card
->ctl_files_rwlock
, flags
);
122 down_write(&card
->controls_rwsem
);
123 list_for_each_entry(control
, &card
->controls
, list
)
124 for (idx
= 0; idx
< control
->count
; idx
++)
125 if (control
->vd
[idx
].owner
== ctl
)
126 control
->vd
[idx
].owner
= NULL
;
127 up_write(&card
->controls_rwsem
);
128 snd_ctl_empty_read_queue(ctl
);
130 module_put(card
->module
);
131 snd_card_file_remove(card
, file
);
135 void snd_ctl_notify(struct snd_card
*card
, unsigned int mask
,
136 struct snd_ctl_elem_id
*id
)
139 struct snd_ctl_file
*ctl
;
140 struct snd_kctl_event
*ev
;
142 snd_assert(card
!= NULL
&& id
!= NULL
, return);
143 read_lock(&card
->ctl_files_rwlock
);
144 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
145 card
->mixer_oss_change_count
++;
147 list_for_each_entry(ctl
, &card
->ctl_files
, list
) {
148 if (!ctl
->subscribed
)
150 spin_lock_irqsave(&ctl
->read_lock
, flags
);
151 list_for_each_entry(ev
, &ctl
->events
, list
) {
152 if (ev
->id
.numid
== id
->numid
) {
157 ev
= kzalloc(sizeof(*ev
), GFP_ATOMIC
);
161 list_add_tail(&ev
->list
, &ctl
->events
);
163 snd_printk(KERN_ERR
"No memory available to allocate event\n");
166 wake_up(&ctl
->change_sleep
);
167 spin_unlock_irqrestore(&ctl
->read_lock
, flags
);
168 kill_fasync(&ctl
->fasync
, SIGIO
, POLL_IN
);
170 read_unlock(&card
->ctl_files_rwlock
);
173 EXPORT_SYMBOL(snd_ctl_notify
);
176 * snd_ctl_new - create a control instance from the template
177 * @control: the control template
178 * @access: the default control access
180 * Allocates a new struct snd_kcontrol instance and copies the given template
181 * to the new instance. It does not copy volatile data (access).
183 * Returns the pointer of the new instance, or NULL on failure.
185 static struct snd_kcontrol
*snd_ctl_new(struct snd_kcontrol
*control
,
188 struct snd_kcontrol
*kctl
;
191 snd_assert(control
!= NULL
, return NULL
);
192 snd_assert(control
->count
> 0, return NULL
);
193 kctl
= kzalloc(sizeof(*kctl
) + sizeof(struct snd_kcontrol_volatile
) * control
->count
, GFP_KERNEL
);
195 snd_printk(KERN_ERR
"Cannot allocate control instance\n");
199 for (idx
= 0; idx
< kctl
->count
; idx
++)
200 kctl
->vd
[idx
].access
= access
;
205 * snd_ctl_new1 - create a control instance from the template
206 * @ncontrol: the initialization record
207 * @private_data: the private data to set
209 * Allocates a new struct snd_kcontrol instance and initialize from the given
210 * template. When the access field of ncontrol is 0, it's assumed as
211 * READWRITE access. When the count field is 0, it's assumes as one.
213 * Returns the pointer of the newly generated instance, or NULL on failure.
215 struct snd_kcontrol
*snd_ctl_new1(const struct snd_kcontrol_new
*ncontrol
,
218 struct snd_kcontrol kctl
;
221 snd_assert(ncontrol
!= NULL
, return NULL
);
222 snd_assert(ncontrol
->info
!= NULL
, return NULL
);
223 memset(&kctl
, 0, sizeof(kctl
));
224 kctl
.id
.iface
= ncontrol
->iface
;
225 kctl
.id
.device
= ncontrol
->device
;
226 kctl
.id
.subdevice
= ncontrol
->subdevice
;
228 strlcpy(kctl
.id
.name
, ncontrol
->name
, sizeof(kctl
.id
.name
));
229 kctl
.id
.index
= ncontrol
->index
;
230 kctl
.count
= ncontrol
->count
? ncontrol
->count
: 1;
231 access
= ncontrol
->access
== 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE
:
232 (ncontrol
->access
& (SNDRV_CTL_ELEM_ACCESS_READWRITE
|
233 SNDRV_CTL_ELEM_ACCESS_INACTIVE
|
234 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
|
235 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
));
236 kctl
.info
= ncontrol
->info
;
237 kctl
.get
= ncontrol
->get
;
238 kctl
.put
= ncontrol
->put
;
239 kctl
.tlv
.p
= ncontrol
->tlv
.p
;
240 kctl
.private_value
= ncontrol
->private_value
;
241 kctl
.private_data
= private_data
;
242 return snd_ctl_new(&kctl
, access
);
245 EXPORT_SYMBOL(snd_ctl_new1
);
248 * snd_ctl_free_one - release the control instance
249 * @kcontrol: the control instance
251 * Releases the control instance created via snd_ctl_new()
253 * Don't call this after the control was added to the card.
255 void snd_ctl_free_one(struct snd_kcontrol
*kcontrol
)
258 if (kcontrol
->private_free
)
259 kcontrol
->private_free(kcontrol
);
264 EXPORT_SYMBOL(snd_ctl_free_one
);
266 static unsigned int snd_ctl_hole_check(struct snd_card
*card
,
269 struct snd_kcontrol
*kctl
;
271 list_for_each_entry(kctl
, &card
->controls
, list
) {
272 if ((kctl
->id
.numid
<= card
->last_numid
&&
273 kctl
->id
.numid
+ kctl
->count
> card
->last_numid
) ||
274 (kctl
->id
.numid
<= card
->last_numid
+ count
- 1 &&
275 kctl
->id
.numid
+ kctl
->count
> card
->last_numid
+ count
- 1))
276 return card
->last_numid
= kctl
->id
.numid
+ kctl
->count
- 1;
278 return card
->last_numid
;
281 static int snd_ctl_find_hole(struct snd_card
*card
, unsigned int count
)
283 unsigned int last_numid
, iter
= 100000;
285 last_numid
= card
->last_numid
;
286 while (last_numid
!= snd_ctl_hole_check(card
, count
)) {
288 /* this situation is very unlikely */
289 snd_printk(KERN_ERR
"unable to allocate new control numid\n");
292 last_numid
= card
->last_numid
;
298 * snd_ctl_add - add the control instance to the card
299 * @card: the card instance
300 * @kcontrol: the control instance to add
302 * Adds the control instance created via snd_ctl_new() or
303 * snd_ctl_new1() to the given card. Assigns also an unique
304 * numid used for fast search.
306 * Returns zero if successful, or a negative error code on failure.
308 * It frees automatically the control which cannot be added.
310 int snd_ctl_add(struct snd_card
*card
, struct snd_kcontrol
*kcontrol
)
312 struct snd_ctl_elem_id id
;
318 snd_assert(card
!= NULL
, goto error
);
319 snd_assert(kcontrol
->info
!= NULL
, goto error
);
321 down_write(&card
->controls_rwsem
);
322 if (snd_ctl_find_id(card
, &id
)) {
323 up_write(&card
->controls_rwsem
);
324 snd_printd(KERN_ERR
"control %i:%i:%i:%s:%i is already present\n",
333 if (snd_ctl_find_hole(card
, kcontrol
->count
) < 0) {
334 up_write(&card
->controls_rwsem
);
338 list_add_tail(&kcontrol
->list
, &card
->controls
);
339 card
->controls_count
+= kcontrol
->count
;
340 kcontrol
->id
.numid
= card
->last_numid
+ 1;
341 card
->last_numid
+= kcontrol
->count
;
342 up_write(&card
->controls_rwsem
);
343 for (idx
= 0; idx
< kcontrol
->count
; idx
++, id
.index
++, id
.numid
++)
344 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_ADD
, &id
);
348 snd_ctl_free_one(kcontrol
);
352 EXPORT_SYMBOL(snd_ctl_add
);
355 * snd_ctl_remove - remove the control from the card and release it
356 * @card: the card instance
357 * @kcontrol: the control instance to remove
359 * Removes the control from the card and then releases the instance.
360 * You don't need to call snd_ctl_free_one(). You must be in
361 * the write lock - down_write(&card->controls_rwsem).
363 * Returns 0 if successful, or a negative error code on failure.
365 int snd_ctl_remove(struct snd_card
*card
, struct snd_kcontrol
*kcontrol
)
367 struct snd_ctl_elem_id id
;
370 snd_assert(card
!= NULL
&& kcontrol
!= NULL
, return -EINVAL
);
371 list_del(&kcontrol
->list
);
372 card
->controls_count
-= kcontrol
->count
;
374 for (idx
= 0; idx
< kcontrol
->count
; idx
++, id
.index
++, id
.numid
++)
375 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_REMOVE
, &id
);
376 snd_ctl_free_one(kcontrol
);
380 EXPORT_SYMBOL(snd_ctl_remove
);
383 * snd_ctl_remove_id - remove the control of the given id and release it
384 * @card: the card instance
385 * @id: the control id to remove
387 * Finds the control instance with the given id, removes it from the
388 * card list and releases it.
390 * Returns 0 if successful, or a negative error code on failure.
392 int snd_ctl_remove_id(struct snd_card
*card
, struct snd_ctl_elem_id
*id
)
394 struct snd_kcontrol
*kctl
;
397 down_write(&card
->controls_rwsem
);
398 kctl
= snd_ctl_find_id(card
, id
);
400 up_write(&card
->controls_rwsem
);
403 ret
= snd_ctl_remove(card
, kctl
);
404 up_write(&card
->controls_rwsem
);
408 EXPORT_SYMBOL(snd_ctl_remove_id
);
411 * snd_ctl_remove_unlocked_id - remove the unlocked control of the given id and release it
412 * @file: active control handle
413 * @id: the control id to remove
415 * Finds the control instance with the given id, removes it from the
416 * card list and releases it.
418 * Returns 0 if successful, or a negative error code on failure.
420 static int snd_ctl_remove_unlocked_id(struct snd_ctl_file
* file
,
421 struct snd_ctl_elem_id
*id
)
423 struct snd_card
*card
= file
->card
;
424 struct snd_kcontrol
*kctl
;
427 down_write(&card
->controls_rwsem
);
428 kctl
= snd_ctl_find_id(card
, id
);
430 up_write(&card
->controls_rwsem
);
433 for (idx
= 0; idx
< kctl
->count
; idx
++)
434 if (kctl
->vd
[idx
].owner
!= NULL
&& kctl
->vd
[idx
].owner
!= file
) {
435 up_write(&card
->controls_rwsem
);
438 ret
= snd_ctl_remove(card
, kctl
);
439 up_write(&card
->controls_rwsem
);
444 * snd_ctl_rename_id - replace the id of a control on the card
445 * @card: the card instance
446 * @src_id: the old id
447 * @dst_id: the new id
449 * Finds the control with the old id from the card, and replaces the
450 * id with the new one.
452 * Returns zero if successful, or a negative error code on failure.
454 int snd_ctl_rename_id(struct snd_card
*card
, struct snd_ctl_elem_id
*src_id
,
455 struct snd_ctl_elem_id
*dst_id
)
457 struct snd_kcontrol
*kctl
;
459 down_write(&card
->controls_rwsem
);
460 kctl
= snd_ctl_find_id(card
, src_id
);
462 up_write(&card
->controls_rwsem
);
466 kctl
->id
.numid
= card
->last_numid
+ 1;
467 card
->last_numid
+= kctl
->count
;
468 up_write(&card
->controls_rwsem
);
472 EXPORT_SYMBOL(snd_ctl_rename_id
);
475 * snd_ctl_find_numid - find the control instance with the given number-id
476 * @card: the card instance
477 * @numid: the number-id to search
479 * Finds the control instance with the given number-id from the card.
481 * Returns the pointer of the instance if found, or NULL if not.
483 * The caller must down card->controls_rwsem before calling this function
484 * (if the race condition can happen).
486 struct snd_kcontrol
*snd_ctl_find_numid(struct snd_card
*card
, unsigned int numid
)
488 struct snd_kcontrol
*kctl
;
490 snd_assert(card
!= NULL
&& numid
!= 0, return NULL
);
491 list_for_each_entry(kctl
, &card
->controls
, list
) {
492 if (kctl
->id
.numid
<= numid
&& kctl
->id
.numid
+ kctl
->count
> numid
)
498 EXPORT_SYMBOL(snd_ctl_find_numid
);
501 * snd_ctl_find_id - find the control instance with the given id
502 * @card: the card instance
503 * @id: the id to search
505 * Finds the control instance with the given id from the card.
507 * Returns the pointer of the instance if found, or NULL if not.
509 * The caller must down card->controls_rwsem before calling this function
510 * (if the race condition can happen).
512 struct snd_kcontrol
*snd_ctl_find_id(struct snd_card
*card
,
513 struct snd_ctl_elem_id
*id
)
515 struct snd_kcontrol
*kctl
;
517 snd_assert(card
!= NULL
&& id
!= NULL
, return NULL
);
519 return snd_ctl_find_numid(card
, id
->numid
);
520 list_for_each_entry(kctl
, &card
->controls
, list
) {
521 if (kctl
->id
.iface
!= id
->iface
)
523 if (kctl
->id
.device
!= id
->device
)
525 if (kctl
->id
.subdevice
!= id
->subdevice
)
527 if (strncmp(kctl
->id
.name
, id
->name
, sizeof(kctl
->id
.name
)))
529 if (kctl
->id
.index
> id
->index
)
531 if (kctl
->id
.index
+ kctl
->count
<= id
->index
)
538 EXPORT_SYMBOL(snd_ctl_find_id
);
540 static int snd_ctl_card_info(struct snd_card
*card
, struct snd_ctl_file
* ctl
,
541 unsigned int cmd
, void __user
*arg
)
543 struct snd_ctl_card_info
*info
;
545 info
= kzalloc(sizeof(*info
), GFP_KERNEL
);
548 down_read(&snd_ioctl_rwsem
);
549 info
->card
= card
->number
;
550 strlcpy(info
->id
, card
->id
, sizeof(info
->id
));
551 strlcpy(info
->driver
, card
->driver
, sizeof(info
->driver
));
552 strlcpy(info
->name
, card
->shortname
, sizeof(info
->name
));
553 strlcpy(info
->longname
, card
->longname
, sizeof(info
->longname
));
554 strlcpy(info
->mixername
, card
->mixername
, sizeof(info
->mixername
));
555 strlcpy(info
->components
, card
->components
, sizeof(info
->components
));
556 up_read(&snd_ioctl_rwsem
);
557 if (copy_to_user(arg
, info
, sizeof(struct snd_ctl_card_info
))) {
565 static int snd_ctl_elem_list(struct snd_card
*card
,
566 struct snd_ctl_elem_list __user
*_list
)
568 struct list_head
*plist
;
569 struct snd_ctl_elem_list list
;
570 struct snd_kcontrol
*kctl
;
571 struct snd_ctl_elem_id
*dst
, *id
;
572 unsigned int offset
, space
, first
, jidx
;
574 if (copy_from_user(&list
, _list
, sizeof(list
)))
576 offset
= list
.offset
;
579 /* try limit maximum space */
583 /* allocate temporary buffer for atomic operation */
584 dst
= vmalloc(space
* sizeof(struct snd_ctl_elem_id
));
587 down_read(&card
->controls_rwsem
);
588 list
.count
= card
->controls_count
;
589 plist
= card
->controls
.next
;
590 while (plist
!= &card
->controls
) {
593 kctl
= snd_kcontrol(plist
);
594 if (offset
< kctl
->count
)
596 offset
-= kctl
->count
;
601 while (space
> 0 && plist
!= &card
->controls
) {
602 kctl
= snd_kcontrol(plist
);
603 for (jidx
= offset
; space
> 0 && jidx
< kctl
->count
; jidx
++) {
604 snd_ctl_build_ioff(id
, kctl
, jidx
);
612 up_read(&card
->controls_rwsem
);
614 copy_to_user(list
.pids
, dst
,
615 list
.used
* sizeof(struct snd_ctl_elem_id
))) {
621 down_read(&card
->controls_rwsem
);
622 list
.count
= card
->controls_count
;
623 up_read(&card
->controls_rwsem
);
625 if (copy_to_user(_list
, &list
, sizeof(list
)))
630 static int snd_ctl_elem_info(struct snd_ctl_file
*ctl
,
631 struct snd_ctl_elem_info
*info
)
633 struct snd_card
*card
= ctl
->card
;
634 struct snd_kcontrol
*kctl
;
635 struct snd_kcontrol_volatile
*vd
;
636 unsigned int index_offset
;
639 down_read(&card
->controls_rwsem
);
640 kctl
= snd_ctl_find_id(card
, &info
->id
);
642 up_read(&card
->controls_rwsem
);
645 #ifdef CONFIG_SND_DEBUG
648 result
= kctl
->info(kctl
, info
);
650 snd_assert(info
->access
== 0, );
651 index_offset
= snd_ctl_get_ioff(kctl
, &info
->id
);
652 vd
= &kctl
->vd
[index_offset
];
653 snd_ctl_build_ioff(&info
->id
, kctl
, index_offset
);
654 info
->access
= vd
->access
;
656 info
->access
|= SNDRV_CTL_ELEM_ACCESS_LOCK
;
657 if (vd
->owner
== ctl
)
658 info
->access
|= SNDRV_CTL_ELEM_ACCESS_OWNER
;
659 info
->owner
= vd
->owner_pid
;
664 up_read(&card
->controls_rwsem
);
668 static int snd_ctl_elem_info_user(struct snd_ctl_file
*ctl
,
669 struct snd_ctl_elem_info __user
*_info
)
671 struct snd_ctl_elem_info info
;
674 if (copy_from_user(&info
, _info
, sizeof(info
)))
676 snd_power_lock(ctl
->card
);
677 result
= snd_power_wait(ctl
->card
, SNDRV_CTL_POWER_D0
);
679 result
= snd_ctl_elem_info(ctl
, &info
);
680 snd_power_unlock(ctl
->card
);
682 if (copy_to_user(_info
, &info
, sizeof(info
)))
687 int snd_ctl_elem_read(struct snd_card
*card
, struct snd_ctl_elem_value
*control
)
689 struct snd_kcontrol
*kctl
;
690 struct snd_kcontrol_volatile
*vd
;
691 unsigned int index_offset
;
694 down_read(&card
->controls_rwsem
);
695 kctl
= snd_ctl_find_id(card
, &control
->id
);
699 index_offset
= snd_ctl_get_ioff(kctl
, &control
->id
);
700 vd
= &kctl
->vd
[index_offset
];
701 if ((vd
->access
& SNDRV_CTL_ELEM_ACCESS_READ
) &&
703 snd_ctl_build_ioff(&control
->id
, kctl
, index_offset
);
704 result
= kctl
->get(kctl
, control
);
708 up_read(&card
->controls_rwsem
);
712 static int snd_ctl_elem_read_user(struct snd_card
*card
,
713 struct snd_ctl_elem_value __user
*_control
)
715 struct snd_ctl_elem_value
*control
;
718 control
= kmalloc(sizeof(*control
), GFP_KERNEL
);
721 if (copy_from_user(control
, _control
, sizeof(*control
))) {
725 snd_power_lock(card
);
726 result
= snd_power_wait(card
, SNDRV_CTL_POWER_D0
);
728 result
= snd_ctl_elem_read(card
, control
);
729 snd_power_unlock(card
);
731 if (copy_to_user(_control
, control
, sizeof(*control
)))
737 int snd_ctl_elem_write(struct snd_card
*card
, struct snd_ctl_file
*file
,
738 struct snd_ctl_elem_value
*control
)
740 struct snd_kcontrol
*kctl
;
741 struct snd_kcontrol_volatile
*vd
;
742 unsigned int index_offset
;
745 down_read(&card
->controls_rwsem
);
746 kctl
= snd_ctl_find_id(card
, &control
->id
);
750 index_offset
= snd_ctl_get_ioff(kctl
, &control
->id
);
751 vd
= &kctl
->vd
[index_offset
];
752 if (!(vd
->access
& SNDRV_CTL_ELEM_ACCESS_WRITE
) ||
754 (file
&& vd
->owner
&& vd
->owner
!= file
)) {
757 snd_ctl_build_ioff(&control
->id
, kctl
, index_offset
);
758 result
= kctl
->put(kctl
, control
);
761 up_read(&card
->controls_rwsem
);
762 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_VALUE
,
767 up_read(&card
->controls_rwsem
);
771 static int snd_ctl_elem_write_user(struct snd_ctl_file
*file
,
772 struct snd_ctl_elem_value __user
*_control
)
774 struct snd_ctl_elem_value
*control
;
775 struct snd_card
*card
;
778 control
= kmalloc(sizeof(*control
), GFP_KERNEL
);
781 if (copy_from_user(control
, _control
, sizeof(*control
))) {
786 snd_power_lock(card
);
787 result
= snd_power_wait(card
, SNDRV_CTL_POWER_D0
);
789 result
= snd_ctl_elem_write(card
, file
, control
);
790 snd_power_unlock(card
);
792 if (copy_to_user(_control
, control
, sizeof(*control
)))
798 static int snd_ctl_elem_lock(struct snd_ctl_file
*file
,
799 struct snd_ctl_elem_id __user
*_id
)
801 struct snd_card
*card
= file
->card
;
802 struct snd_ctl_elem_id id
;
803 struct snd_kcontrol
*kctl
;
804 struct snd_kcontrol_volatile
*vd
;
807 if (copy_from_user(&id
, _id
, sizeof(id
)))
809 down_write(&card
->controls_rwsem
);
810 kctl
= snd_ctl_find_id(card
, &id
);
814 vd
= &kctl
->vd
[snd_ctl_get_ioff(kctl
, &id
)];
815 if (vd
->owner
!= NULL
)
819 vd
->owner_pid
= current
->pid
;
823 up_write(&card
->controls_rwsem
);
827 static int snd_ctl_elem_unlock(struct snd_ctl_file
*file
,
828 struct snd_ctl_elem_id __user
*_id
)
830 struct snd_card
*card
= file
->card
;
831 struct snd_ctl_elem_id id
;
832 struct snd_kcontrol
*kctl
;
833 struct snd_kcontrol_volatile
*vd
;
836 if (copy_from_user(&id
, _id
, sizeof(id
)))
838 down_write(&card
->controls_rwsem
);
839 kctl
= snd_ctl_find_id(card
, &id
);
843 vd
= &kctl
->vd
[snd_ctl_get_ioff(kctl
, &id
)];
844 if (vd
->owner
== NULL
)
846 else if (vd
->owner
!= file
)
854 up_write(&card
->controls_rwsem
);
858 struct user_element
{
859 struct snd_ctl_elem_info info
;
860 void *elem_data
; /* element data */
861 unsigned long elem_data_size
; /* size of element data in bytes */
862 void *tlv_data
; /* TLV data */
863 unsigned long tlv_data_size
; /* TLV data size */
864 void *priv_data
; /* private data (like strings for enumerated type) */
865 unsigned long priv_data_size
; /* size of private data in bytes */
868 static int snd_ctl_elem_user_info(struct snd_kcontrol
*kcontrol
,
869 struct snd_ctl_elem_info
*uinfo
)
871 struct user_element
*ue
= kcontrol
->private_data
;
877 static int snd_ctl_elem_user_get(struct snd_kcontrol
*kcontrol
,
878 struct snd_ctl_elem_value
*ucontrol
)
880 struct user_element
*ue
= kcontrol
->private_data
;
882 memcpy(&ucontrol
->value
, ue
->elem_data
, ue
->elem_data_size
);
886 static int snd_ctl_elem_user_put(struct snd_kcontrol
*kcontrol
,
887 struct snd_ctl_elem_value
*ucontrol
)
890 struct user_element
*ue
= kcontrol
->private_data
;
892 change
= memcmp(&ucontrol
->value
, ue
->elem_data
, ue
->elem_data_size
) != 0;
894 memcpy(ue
->elem_data
, &ucontrol
->value
, ue
->elem_data_size
);
898 static int snd_ctl_elem_user_tlv(struct snd_kcontrol
*kcontrol
,
901 unsigned int __user
*tlv
)
903 struct user_element
*ue
= kcontrol
->private_data
;
908 if (size
> 1024 * 128) /* sane value */
910 new_data
= kmalloc(size
, GFP_KERNEL
);
911 if (new_data
== NULL
)
913 if (copy_from_user(new_data
, tlv
, size
)) {
917 change
= ue
->tlv_data_size
!= size
;
919 change
= memcmp(ue
->tlv_data
, new_data
, size
);
921 ue
->tlv_data
= new_data
;
922 ue
->tlv_data_size
= size
;
924 if (! ue
->tlv_data_size
|| ! ue
->tlv_data
)
926 if (size
< ue
->tlv_data_size
)
928 if (copy_to_user(tlv
, ue
->tlv_data
, ue
->tlv_data_size
))
934 static void snd_ctl_elem_user_free(struct snd_kcontrol
*kcontrol
)
936 struct user_element
*ue
= kcontrol
->private_data
;
942 static int snd_ctl_elem_add(struct snd_ctl_file
*file
,
943 struct snd_ctl_elem_info
*info
, int replace
)
945 struct snd_card
*card
= file
->card
;
946 struct snd_kcontrol kctl
, *_kctl
;
949 struct user_element
*ue
;
952 if (card
->user_ctl_count
>= MAX_USER_CONTROLS
)
954 if (info
->count
> 1024)
956 access
= info
->access
== 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE
:
957 (info
->access
& (SNDRV_CTL_ELEM_ACCESS_READWRITE
|
958 SNDRV_CTL_ELEM_ACCESS_INACTIVE
|
959 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
));
961 memset(&kctl
, 0, sizeof(kctl
));
962 down_write(&card
->controls_rwsem
);
963 _kctl
= snd_ctl_find_id(card
, &info
->id
);
967 err
= snd_ctl_remove(card
, _kctl
);
974 up_write(&card
->controls_rwsem
);
977 memcpy(&kctl
.id
, &info
->id
, sizeof(info
->id
));
978 kctl
.count
= info
->owner
? info
->owner
: 1;
979 access
|= SNDRV_CTL_ELEM_ACCESS_USER
;
980 kctl
.info
= snd_ctl_elem_user_info
;
981 if (access
& SNDRV_CTL_ELEM_ACCESS_READ
)
982 kctl
.get
= snd_ctl_elem_user_get
;
983 if (access
& SNDRV_CTL_ELEM_ACCESS_WRITE
)
984 kctl
.put
= snd_ctl_elem_user_put
;
985 if (access
& SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
) {
986 kctl
.tlv
.c
= snd_ctl_elem_user_tlv
;
987 access
|= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
;
989 switch (info
->type
) {
990 case SNDRV_CTL_ELEM_TYPE_BOOLEAN
:
991 case SNDRV_CTL_ELEM_TYPE_INTEGER
:
992 private_size
= sizeof(long);
993 if (info
->count
> 128)
996 case SNDRV_CTL_ELEM_TYPE_INTEGER64
:
997 private_size
= sizeof(long long);
998 if (info
->count
> 64)
1001 case SNDRV_CTL_ELEM_TYPE_BYTES
:
1002 private_size
= sizeof(unsigned char);
1003 if (info
->count
> 512)
1006 case SNDRV_CTL_ELEM_TYPE_IEC958
:
1007 private_size
= sizeof(struct snd_aes_iec958
);
1008 if (info
->count
!= 1)
1014 private_size
*= info
->count
;
1015 ue
= kzalloc(sizeof(struct user_element
) + private_size
, GFP_KERNEL
);
1019 ue
->info
.access
= 0;
1020 ue
->elem_data
= (char *)ue
+ sizeof(*ue
);
1021 ue
->elem_data_size
= private_size
;
1022 kctl
.private_free
= snd_ctl_elem_user_free
;
1023 _kctl
= snd_ctl_new(&kctl
, access
);
1024 if (_kctl
== NULL
) {
1028 _kctl
->private_data
= ue
;
1029 for (idx
= 0; idx
< _kctl
->count
; idx
++)
1030 _kctl
->vd
[idx
].owner
= file
;
1031 err
= snd_ctl_add(card
, _kctl
);
1035 down_write(&card
->controls_rwsem
);
1036 card
->user_ctl_count
++;
1037 up_write(&card
->controls_rwsem
);
1042 static int snd_ctl_elem_add_user(struct snd_ctl_file
*file
,
1043 struct snd_ctl_elem_info __user
*_info
, int replace
)
1045 struct snd_ctl_elem_info info
;
1046 if (copy_from_user(&info
, _info
, sizeof(info
)))
1048 return snd_ctl_elem_add(file
, &info
, replace
);
1051 static int snd_ctl_elem_remove(struct snd_ctl_file
*file
,
1052 struct snd_ctl_elem_id __user
*_id
)
1054 struct snd_ctl_elem_id id
;
1057 if (copy_from_user(&id
, _id
, sizeof(id
)))
1059 err
= snd_ctl_remove_unlocked_id(file
, &id
);
1061 struct snd_card
*card
= file
->card
;
1062 down_write(&card
->controls_rwsem
);
1063 card
->user_ctl_count
--;
1064 up_write(&card
->controls_rwsem
);
1069 static int snd_ctl_subscribe_events(struct snd_ctl_file
*file
, int __user
*ptr
)
1072 if (get_user(subscribe
, ptr
))
1074 if (subscribe
< 0) {
1075 subscribe
= file
->subscribed
;
1076 if (put_user(subscribe
, ptr
))
1081 file
->subscribed
= 1;
1083 } else if (file
->subscribed
) {
1084 snd_ctl_empty_read_queue(file
);
1085 file
->subscribed
= 0;
1090 static int snd_ctl_tlv_ioctl(struct snd_ctl_file
*file
,
1091 struct snd_ctl_tlv __user
*_tlv
,
1094 struct snd_card
*card
= file
->card
;
1095 struct snd_ctl_tlv tlv
;
1096 struct snd_kcontrol
*kctl
;
1097 struct snd_kcontrol_volatile
*vd
;
1101 if (copy_from_user(&tlv
, _tlv
, sizeof(tlv
)))
1103 if (tlv
.length
< sizeof(unsigned int) * 3)
1105 down_read(&card
->controls_rwsem
);
1106 kctl
= snd_ctl_find_numid(card
, tlv
.numid
);
1111 if (kctl
->tlv
.p
== NULL
) {
1115 vd
= &kctl
->vd
[tlv
.numid
- kctl
->id
.numid
];
1116 if ((op_flag
== 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_READ
) == 0) ||
1117 (op_flag
> 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_WRITE
) == 0) ||
1118 (op_flag
< 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND
) == 0)) {
1122 if (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
) {
1123 if (file
&& vd
->owner
!= NULL
&& vd
->owner
!= file
) {
1127 err
= kctl
->tlv
.c(kctl
, op_flag
, tlv
.length
, _tlv
->tlv
);
1129 up_read(&card
->controls_rwsem
);
1130 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_TLV
, &kctl
->id
);
1138 len
= kctl
->tlv
.p
[1] + 2 * sizeof(unsigned int);
1139 if (tlv
.length
< len
) {
1143 if (copy_to_user(_tlv
->tlv
, kctl
->tlv
.p
, len
))
1147 up_read(&card
->controls_rwsem
);
1151 static long snd_ctl_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
1153 struct snd_ctl_file
*ctl
;
1154 struct snd_card
*card
;
1155 struct snd_kctl_ioctl
*p
;
1156 void __user
*argp
= (void __user
*)arg
;
1157 int __user
*ip
= argp
;
1160 ctl
= file
->private_data
;
1162 snd_assert(card
!= NULL
, return -ENXIO
);
1164 case SNDRV_CTL_IOCTL_PVERSION
:
1165 return put_user(SNDRV_CTL_VERSION
, ip
) ? -EFAULT
: 0;
1166 case SNDRV_CTL_IOCTL_CARD_INFO
:
1167 return snd_ctl_card_info(card
, ctl
, cmd
, argp
);
1168 case SNDRV_CTL_IOCTL_ELEM_LIST
:
1169 return snd_ctl_elem_list(card
, argp
);
1170 case SNDRV_CTL_IOCTL_ELEM_INFO
:
1171 return snd_ctl_elem_info_user(ctl
, argp
);
1172 case SNDRV_CTL_IOCTL_ELEM_READ
:
1173 return snd_ctl_elem_read_user(card
, argp
);
1174 case SNDRV_CTL_IOCTL_ELEM_WRITE
:
1175 return snd_ctl_elem_write_user(ctl
, argp
);
1176 case SNDRV_CTL_IOCTL_ELEM_LOCK
:
1177 return snd_ctl_elem_lock(ctl
, argp
);
1178 case SNDRV_CTL_IOCTL_ELEM_UNLOCK
:
1179 return snd_ctl_elem_unlock(ctl
, argp
);
1180 case SNDRV_CTL_IOCTL_ELEM_ADD
:
1181 return snd_ctl_elem_add_user(ctl
, argp
, 0);
1182 case SNDRV_CTL_IOCTL_ELEM_REPLACE
:
1183 return snd_ctl_elem_add_user(ctl
, argp
, 1);
1184 case SNDRV_CTL_IOCTL_ELEM_REMOVE
:
1185 return snd_ctl_elem_remove(ctl
, argp
);
1186 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS
:
1187 return snd_ctl_subscribe_events(ctl
, ip
);
1188 case SNDRV_CTL_IOCTL_TLV_READ
:
1189 return snd_ctl_tlv_ioctl(ctl
, argp
, 0);
1190 case SNDRV_CTL_IOCTL_TLV_WRITE
:
1191 return snd_ctl_tlv_ioctl(ctl
, argp
, 1);
1192 case SNDRV_CTL_IOCTL_TLV_COMMAND
:
1193 return snd_ctl_tlv_ioctl(ctl
, argp
, -1);
1194 case SNDRV_CTL_IOCTL_POWER
:
1195 return -ENOPROTOOPT
;
1196 case SNDRV_CTL_IOCTL_POWER_STATE
:
1198 return put_user(card
->power_state
, ip
) ? -EFAULT
: 0;
1200 return put_user(SNDRV_CTL_POWER_D0
, ip
) ? -EFAULT
: 0;
1203 down_read(&snd_ioctl_rwsem
);
1204 list_for_each_entry(p
, &snd_control_ioctls
, list
) {
1205 err
= p
->fioctl(card
, ctl
, cmd
, arg
);
1206 if (err
!= -ENOIOCTLCMD
) {
1207 up_read(&snd_ioctl_rwsem
);
1211 up_read(&snd_ioctl_rwsem
);
1212 snd_printdd("unknown ioctl = 0x%x\n", cmd
);
1216 static ssize_t
snd_ctl_read(struct file
*file
, char __user
*buffer
,
1217 size_t count
, loff_t
* offset
)
1219 struct snd_ctl_file
*ctl
;
1223 ctl
= file
->private_data
;
1224 snd_assert(ctl
!= NULL
&& ctl
->card
!= NULL
, return -ENXIO
);
1225 if (!ctl
->subscribed
)
1227 if (count
< sizeof(struct snd_ctl_event
))
1229 spin_lock_irq(&ctl
->read_lock
);
1230 while (count
>= sizeof(struct snd_ctl_event
)) {
1231 struct snd_ctl_event ev
;
1232 struct snd_kctl_event
*kev
;
1233 while (list_empty(&ctl
->events
)) {
1235 if ((file
->f_flags
& O_NONBLOCK
) != 0 || result
> 0) {
1239 init_waitqueue_entry(&wait
, current
);
1240 add_wait_queue(&ctl
->change_sleep
, &wait
);
1241 set_current_state(TASK_INTERRUPTIBLE
);
1242 spin_unlock_irq(&ctl
->read_lock
);
1244 remove_wait_queue(&ctl
->change_sleep
, &wait
);
1245 if (signal_pending(current
))
1246 return -ERESTARTSYS
;
1247 spin_lock_irq(&ctl
->read_lock
);
1249 kev
= snd_kctl_event(ctl
->events
.next
);
1250 ev
.type
= SNDRV_CTL_EVENT_ELEM
;
1251 ev
.data
.elem
.mask
= kev
->mask
;
1252 ev
.data
.elem
.id
= kev
->id
;
1253 list_del(&kev
->list
);
1254 spin_unlock_irq(&ctl
->read_lock
);
1256 if (copy_to_user(buffer
, &ev
, sizeof(struct snd_ctl_event
))) {
1260 spin_lock_irq(&ctl
->read_lock
);
1261 buffer
+= sizeof(struct snd_ctl_event
);
1262 count
-= sizeof(struct snd_ctl_event
);
1263 result
+= sizeof(struct snd_ctl_event
);
1266 spin_unlock_irq(&ctl
->read_lock
);
1268 return result
> 0 ? result
: err
;
1271 static unsigned int snd_ctl_poll(struct file
*file
, poll_table
* wait
)
1274 struct snd_ctl_file
*ctl
;
1276 ctl
= file
->private_data
;
1277 if (!ctl
->subscribed
)
1279 poll_wait(file
, &ctl
->change_sleep
, wait
);
1282 if (!list_empty(&ctl
->events
))
1283 mask
|= POLLIN
| POLLRDNORM
;
1289 * register the device-specific control-ioctls.
1290 * called from each device manager like pcm.c, hwdep.c, etc.
1292 static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn
, struct list_head
*lists
)
1294 struct snd_kctl_ioctl
*pn
;
1296 pn
= kzalloc(sizeof(struct snd_kctl_ioctl
), GFP_KERNEL
);
1300 down_write(&snd_ioctl_rwsem
);
1301 list_add_tail(&pn
->list
, lists
);
1302 up_write(&snd_ioctl_rwsem
);
1306 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn
)
1308 return _snd_ctl_register_ioctl(fcn
, &snd_control_ioctls
);
1311 EXPORT_SYMBOL(snd_ctl_register_ioctl
);
1313 #ifdef CONFIG_COMPAT
1314 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn
)
1316 return _snd_ctl_register_ioctl(fcn
, &snd_control_compat_ioctls
);
1319 EXPORT_SYMBOL(snd_ctl_register_ioctl_compat
);
1323 * de-register the device-specific control-ioctls.
1325 static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn
,
1326 struct list_head
*lists
)
1328 struct snd_kctl_ioctl
*p
;
1330 snd_assert(fcn
!= NULL
, return -EINVAL
);
1331 down_write(&snd_ioctl_rwsem
);
1332 list_for_each_entry(p
, lists
, list
) {
1333 if (p
->fioctl
== fcn
) {
1335 up_write(&snd_ioctl_rwsem
);
1340 up_write(&snd_ioctl_rwsem
);
1345 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn
)
1347 return _snd_ctl_unregister_ioctl(fcn
, &snd_control_ioctls
);
1350 EXPORT_SYMBOL(snd_ctl_unregister_ioctl
);
1352 #ifdef CONFIG_COMPAT
1353 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn
)
1355 return _snd_ctl_unregister_ioctl(fcn
, &snd_control_compat_ioctls
);
1358 EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat
);
1361 static int snd_ctl_fasync(int fd
, struct file
* file
, int on
)
1363 struct snd_ctl_file
*ctl
;
1365 ctl
= file
->private_data
;
1366 err
= fasync_helper(fd
, file
, on
, &ctl
->fasync
);
1375 #ifdef CONFIG_COMPAT
1376 #include "control_compat.c"
1378 #define snd_ctl_ioctl_compat NULL
1385 static const struct file_operations snd_ctl_f_ops
=
1387 .owner
= THIS_MODULE
,
1388 .read
= snd_ctl_read
,
1389 .open
= snd_ctl_open
,
1390 .release
= snd_ctl_release
,
1391 .poll
= snd_ctl_poll
,
1392 .unlocked_ioctl
= snd_ctl_ioctl
,
1393 .compat_ioctl
= snd_ctl_ioctl_compat
,
1394 .fasync
= snd_ctl_fasync
,
1398 * registration of the control device
1400 static int snd_ctl_dev_register(struct snd_device
*device
)
1402 struct snd_card
*card
= device
->device_data
;
1406 snd_assert(card
!= NULL
, return -ENXIO
);
1407 cardnum
= card
->number
;
1408 snd_assert(cardnum
>= 0 && cardnum
< SNDRV_CARDS
, return -ENXIO
);
1409 sprintf(name
, "controlC%i", cardnum
);
1410 if ((err
= snd_register_device(SNDRV_DEVICE_TYPE_CONTROL
, card
, -1,
1411 &snd_ctl_f_ops
, card
, name
)) < 0)
1417 * disconnection of the control device
1419 static int snd_ctl_dev_disconnect(struct snd_device
*device
)
1421 struct snd_card
*card
= device
->device_data
;
1422 struct snd_ctl_file
*ctl
;
1425 snd_assert(card
!= NULL
, return -ENXIO
);
1426 cardnum
= card
->number
;
1427 snd_assert(cardnum
>= 0 && cardnum
< SNDRV_CARDS
, return -ENXIO
);
1429 down_read(&card
->controls_rwsem
);
1430 list_for_each_entry(ctl
, &card
->ctl_files
, list
) {
1431 wake_up(&ctl
->change_sleep
);
1432 kill_fasync(&ctl
->fasync
, SIGIO
, POLL_ERR
);
1434 up_read(&card
->controls_rwsem
);
1436 if ((err
= snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL
,
1445 static int snd_ctl_dev_free(struct snd_device
*device
)
1447 struct snd_card
*card
= device
->device_data
;
1448 struct snd_kcontrol
*control
;
1450 down_write(&card
->controls_rwsem
);
1451 while (!list_empty(&card
->controls
)) {
1452 control
= snd_kcontrol(card
->controls
.next
);
1453 snd_ctl_remove(card
, control
);
1455 up_write(&card
->controls_rwsem
);
1460 * create control core:
1461 * called from init.c
1463 int snd_ctl_create(struct snd_card
*card
)
1465 static struct snd_device_ops ops
= {
1466 .dev_free
= snd_ctl_dev_free
,
1467 .dev_register
= snd_ctl_dev_register
,
1468 .dev_disconnect
= snd_ctl_dev_disconnect
,
1471 snd_assert(card
!= NULL
, return -ENXIO
);
1472 return snd_device_new(card
, SNDRV_DEV_CONTROL
, card
, &ops
);
1476 * Frequently used control callbacks
1478 int snd_ctl_boolean_mono_info(struct snd_kcontrol
*kcontrol
,
1479 struct snd_ctl_elem_info
*uinfo
)
1481 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1483 uinfo
->value
.integer
.min
= 0;
1484 uinfo
->value
.integer
.max
= 1;
1488 EXPORT_SYMBOL(snd_ctl_boolean_mono_info
);
1490 int snd_ctl_boolean_stereo_info(struct snd_kcontrol
*kcontrol
,
1491 struct snd_ctl_elem_info
*uinfo
)
1493 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1495 uinfo
->value
.integer
.min
= 0;
1496 uinfo
->value
.integer
.max
= 1;
1500 EXPORT_SYMBOL(snd_ctl_boolean_stereo_info
);