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
= get_pid(task_pid(current
));
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 file
->private_data
= NULL
;
118 write_lock_irqsave(&card
->ctl_files_rwlock
, flags
);
119 list_del(&ctl
->list
);
120 write_unlock_irqrestore(&card
->ctl_files_rwlock
, flags
);
121 down_write(&card
->controls_rwsem
);
122 list_for_each_entry(control
, &card
->controls
, list
)
123 for (idx
= 0; idx
< control
->count
; idx
++)
124 if (control
->vd
[idx
].owner
== ctl
)
125 control
->vd
[idx
].owner
= NULL
;
126 up_write(&card
->controls_rwsem
);
127 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 if (snd_BUG_ON(!card
|| !id
))
144 read_lock(&card
->ctl_files_rwlock
);
145 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
146 card
->mixer_oss_change_count
++;
148 list_for_each_entry(ctl
, &card
->ctl_files
, list
) {
149 if (!ctl
->subscribed
)
151 spin_lock_irqsave(&ctl
->read_lock
, flags
);
152 list_for_each_entry(ev
, &ctl
->events
, list
) {
153 if (ev
->id
.numid
== id
->numid
) {
158 ev
= kzalloc(sizeof(*ev
), GFP_ATOMIC
);
162 list_add_tail(&ev
->list
, &ctl
->events
);
164 snd_printk(KERN_ERR
"No memory available to allocate event\n");
167 wake_up(&ctl
->change_sleep
);
168 spin_unlock_irqrestore(&ctl
->read_lock
, flags
);
169 kill_fasync(&ctl
->fasync
, SIGIO
, POLL_IN
);
171 read_unlock(&card
->ctl_files_rwlock
);
174 EXPORT_SYMBOL(snd_ctl_notify
);
177 * snd_ctl_new - create a control instance from the template
178 * @control: the control template
179 * @access: the default control access
181 * Allocates a new struct snd_kcontrol instance and copies the given template
182 * to the new instance. It does not copy volatile data (access).
184 * Returns the pointer of the new instance, or NULL on failure.
186 static struct snd_kcontrol
*snd_ctl_new(struct snd_kcontrol
*control
,
189 struct snd_kcontrol
*kctl
;
192 if (snd_BUG_ON(!control
|| !control
->count
))
194 kctl
= kzalloc(sizeof(*kctl
) + sizeof(struct snd_kcontrol_volatile
) * control
->count
, GFP_KERNEL
);
196 snd_printk(KERN_ERR
"Cannot allocate control instance\n");
200 for (idx
= 0; idx
< kctl
->count
; idx
++)
201 kctl
->vd
[idx
].access
= access
;
206 * snd_ctl_new1 - create a control instance from the template
207 * @ncontrol: the initialization record
208 * @private_data: the private data to set
210 * Allocates a new struct snd_kcontrol instance and initialize from the given
211 * template. When the access field of ncontrol is 0, it's assumed as
212 * READWRITE access. When the count field is 0, it's assumes as one.
214 * Returns the pointer of the newly generated instance, or NULL on failure.
216 struct snd_kcontrol
*snd_ctl_new1(const struct snd_kcontrol_new
*ncontrol
,
219 struct snd_kcontrol kctl
;
222 if (snd_BUG_ON(!ncontrol
|| !ncontrol
->info
))
224 memset(&kctl
, 0, sizeof(kctl
));
225 kctl
.id
.iface
= ncontrol
->iface
;
226 kctl
.id
.device
= ncontrol
->device
;
227 kctl
.id
.subdevice
= ncontrol
->subdevice
;
228 if (ncontrol
->name
) {
229 strlcpy(kctl
.id
.name
, ncontrol
->name
, sizeof(kctl
.id
.name
));
230 if (strcmp(ncontrol
->name
, kctl
.id
.name
) != 0)
231 snd_printk(KERN_WARNING
232 "Control name '%s' truncated to '%s'\n",
233 ncontrol
->name
, kctl
.id
.name
);
235 kctl
.id
.index
= ncontrol
->index
;
236 kctl
.count
= ncontrol
->count
? ncontrol
->count
: 1;
237 access
= ncontrol
->access
== 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE
:
238 (ncontrol
->access
& (SNDRV_CTL_ELEM_ACCESS_READWRITE
|
239 SNDRV_CTL_ELEM_ACCESS_INACTIVE
|
240 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
|
241 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
));
242 kctl
.info
= ncontrol
->info
;
243 kctl
.get
= ncontrol
->get
;
244 kctl
.put
= ncontrol
->put
;
245 kctl
.tlv
.p
= ncontrol
->tlv
.p
;
246 kctl
.private_value
= ncontrol
->private_value
;
247 kctl
.private_data
= private_data
;
248 return snd_ctl_new(&kctl
, access
);
251 EXPORT_SYMBOL(snd_ctl_new1
);
254 * snd_ctl_free_one - release the control instance
255 * @kcontrol: the control instance
257 * Releases the control instance created via snd_ctl_new()
259 * Don't call this after the control was added to the card.
261 void snd_ctl_free_one(struct snd_kcontrol
*kcontrol
)
264 if (kcontrol
->private_free
)
265 kcontrol
->private_free(kcontrol
);
270 EXPORT_SYMBOL(snd_ctl_free_one
);
272 static unsigned int snd_ctl_hole_check(struct snd_card
*card
,
275 struct snd_kcontrol
*kctl
;
277 list_for_each_entry(kctl
, &card
->controls
, list
) {
278 if ((kctl
->id
.numid
<= card
->last_numid
&&
279 kctl
->id
.numid
+ kctl
->count
> card
->last_numid
) ||
280 (kctl
->id
.numid
<= card
->last_numid
+ count
- 1 &&
281 kctl
->id
.numid
+ kctl
->count
> card
->last_numid
+ count
- 1))
282 return card
->last_numid
= kctl
->id
.numid
+ kctl
->count
- 1;
284 return card
->last_numid
;
287 static int snd_ctl_find_hole(struct snd_card
*card
, unsigned int count
)
289 unsigned int last_numid
, iter
= 100000;
291 last_numid
= card
->last_numid
;
292 while (last_numid
!= snd_ctl_hole_check(card
, count
)) {
294 /* this situation is very unlikely */
295 snd_printk(KERN_ERR
"unable to allocate new control numid\n");
298 last_numid
= card
->last_numid
;
304 * snd_ctl_add - add the control instance to the card
305 * @card: the card instance
306 * @kcontrol: the control instance to add
308 * Adds the control instance created via snd_ctl_new() or
309 * snd_ctl_new1() to the given card. Assigns also an unique
310 * numid used for fast search.
312 * Returns zero if successful, or a negative error code on failure.
314 * It frees automatically the control which cannot be added.
316 int snd_ctl_add(struct snd_card
*card
, struct snd_kcontrol
*kcontrol
)
318 struct snd_ctl_elem_id id
;
324 if (snd_BUG_ON(!card
|| !kcontrol
->info
))
327 down_write(&card
->controls_rwsem
);
328 if (snd_ctl_find_id(card
, &id
)) {
329 up_write(&card
->controls_rwsem
);
330 snd_printd(KERN_ERR
"control %i:%i:%i:%s:%i is already present\n",
339 if (snd_ctl_find_hole(card
, kcontrol
->count
) < 0) {
340 up_write(&card
->controls_rwsem
);
344 list_add_tail(&kcontrol
->list
, &card
->controls
);
345 card
->controls_count
+= kcontrol
->count
;
346 kcontrol
->id
.numid
= card
->last_numid
+ 1;
347 card
->last_numid
+= kcontrol
->count
;
348 up_write(&card
->controls_rwsem
);
349 for (idx
= 0; idx
< kcontrol
->count
; idx
++, id
.index
++, id
.numid
++)
350 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_ADD
, &id
);
354 snd_ctl_free_one(kcontrol
);
358 EXPORT_SYMBOL(snd_ctl_add
);
361 * snd_ctl_remove - remove the control from the card and release it
362 * @card: the card instance
363 * @kcontrol: the control instance to remove
365 * Removes the control from the card and then releases the instance.
366 * You don't need to call snd_ctl_free_one(). You must be in
367 * the write lock - down_write(&card->controls_rwsem).
369 * Returns 0 if successful, or a negative error code on failure.
371 int snd_ctl_remove(struct snd_card
*card
, struct snd_kcontrol
*kcontrol
)
373 struct snd_ctl_elem_id id
;
376 if (snd_BUG_ON(!card
|| !kcontrol
))
378 list_del(&kcontrol
->list
);
379 card
->controls_count
-= kcontrol
->count
;
381 for (idx
= 0; idx
< kcontrol
->count
; idx
++, id
.index
++, id
.numid
++)
382 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_REMOVE
, &id
);
383 snd_ctl_free_one(kcontrol
);
387 EXPORT_SYMBOL(snd_ctl_remove
);
390 * snd_ctl_remove_id - remove the control of the given id and release it
391 * @card: the card instance
392 * @id: the control id to remove
394 * Finds the control instance with the given id, removes it from the
395 * card list and releases it.
397 * Returns 0 if successful, or a negative error code on failure.
399 int snd_ctl_remove_id(struct snd_card
*card
, struct snd_ctl_elem_id
*id
)
401 struct snd_kcontrol
*kctl
;
404 down_write(&card
->controls_rwsem
);
405 kctl
= snd_ctl_find_id(card
, id
);
407 up_write(&card
->controls_rwsem
);
410 ret
= snd_ctl_remove(card
, kctl
);
411 up_write(&card
->controls_rwsem
);
415 EXPORT_SYMBOL(snd_ctl_remove_id
);
418 * snd_ctl_remove_user_ctl - remove and release the unlocked user control
419 * @file: active control handle
420 * @id: the control id to remove
422 * Finds the control instance with the given id, removes it from the
423 * card list and releases it.
425 * Returns 0 if successful, or a negative error code on failure.
427 static int snd_ctl_remove_user_ctl(struct snd_ctl_file
* file
,
428 struct snd_ctl_elem_id
*id
)
430 struct snd_card
*card
= file
->card
;
431 struct snd_kcontrol
*kctl
;
434 down_write(&card
->controls_rwsem
);
435 kctl
= snd_ctl_find_id(card
, id
);
440 if (!(kctl
->vd
[0].access
& SNDRV_CTL_ELEM_ACCESS_USER
)) {
444 for (idx
= 0; idx
< kctl
->count
; idx
++)
445 if (kctl
->vd
[idx
].owner
!= NULL
&& kctl
->vd
[idx
].owner
!= file
) {
449 ret
= snd_ctl_remove(card
, kctl
);
452 card
->user_ctl_count
--;
454 up_write(&card
->controls_rwsem
);
459 * snd_ctl_rename_id - replace the id of a control on the card
460 * @card: the card instance
461 * @src_id: the old id
462 * @dst_id: the new id
464 * Finds the control with the old id from the card, and replaces the
465 * id with the new one.
467 * Returns zero if successful, or a negative error code on failure.
469 int snd_ctl_rename_id(struct snd_card
*card
, struct snd_ctl_elem_id
*src_id
,
470 struct snd_ctl_elem_id
*dst_id
)
472 struct snd_kcontrol
*kctl
;
474 down_write(&card
->controls_rwsem
);
475 kctl
= snd_ctl_find_id(card
, src_id
);
477 up_write(&card
->controls_rwsem
);
481 kctl
->id
.numid
= card
->last_numid
+ 1;
482 card
->last_numid
+= kctl
->count
;
483 up_write(&card
->controls_rwsem
);
487 EXPORT_SYMBOL(snd_ctl_rename_id
);
490 * snd_ctl_find_numid - find the control instance with the given number-id
491 * @card: the card instance
492 * @numid: the number-id to search
494 * Finds the control instance with the given number-id from the card.
496 * Returns the pointer of the instance if found, or NULL if not.
498 * The caller must down card->controls_rwsem before calling this function
499 * (if the race condition can happen).
501 struct snd_kcontrol
*snd_ctl_find_numid(struct snd_card
*card
, unsigned int numid
)
503 struct snd_kcontrol
*kctl
;
505 if (snd_BUG_ON(!card
|| !numid
))
507 list_for_each_entry(kctl
, &card
->controls
, list
) {
508 if (kctl
->id
.numid
<= numid
&& kctl
->id
.numid
+ kctl
->count
> numid
)
514 EXPORT_SYMBOL(snd_ctl_find_numid
);
517 * snd_ctl_find_id - find the control instance with the given id
518 * @card: the card instance
519 * @id: the id to search
521 * Finds the control instance with the given id from the card.
523 * Returns the pointer of the instance if found, or NULL if not.
525 * The caller must down card->controls_rwsem before calling this function
526 * (if the race condition can happen).
528 struct snd_kcontrol
*snd_ctl_find_id(struct snd_card
*card
,
529 struct snd_ctl_elem_id
*id
)
531 struct snd_kcontrol
*kctl
;
533 if (snd_BUG_ON(!card
|| !id
))
536 return snd_ctl_find_numid(card
, id
->numid
);
537 list_for_each_entry(kctl
, &card
->controls
, list
) {
538 if (kctl
->id
.iface
!= id
->iface
)
540 if (kctl
->id
.device
!= id
->device
)
542 if (kctl
->id
.subdevice
!= id
->subdevice
)
544 if (strncmp(kctl
->id
.name
, id
->name
, sizeof(kctl
->id
.name
)))
546 if (kctl
->id
.index
> id
->index
)
548 if (kctl
->id
.index
+ kctl
->count
<= id
->index
)
555 EXPORT_SYMBOL(snd_ctl_find_id
);
557 static int snd_ctl_card_info(struct snd_card
*card
, struct snd_ctl_file
* ctl
,
558 unsigned int cmd
, void __user
*arg
)
560 struct snd_ctl_card_info
*info
;
562 info
= kzalloc(sizeof(*info
), GFP_KERNEL
);
565 down_read(&snd_ioctl_rwsem
);
566 info
->card
= card
->number
;
567 strlcpy(info
->id
, card
->id
, sizeof(info
->id
));
568 strlcpy(info
->driver
, card
->driver
, sizeof(info
->driver
));
569 strlcpy(info
->name
, card
->shortname
, sizeof(info
->name
));
570 strlcpy(info
->longname
, card
->longname
, sizeof(info
->longname
));
571 strlcpy(info
->mixername
, card
->mixername
, sizeof(info
->mixername
));
572 strlcpy(info
->components
, card
->components
, sizeof(info
->components
));
573 up_read(&snd_ioctl_rwsem
);
574 if (copy_to_user(arg
, info
, sizeof(struct snd_ctl_card_info
))) {
582 static int snd_ctl_elem_list(struct snd_card
*card
,
583 struct snd_ctl_elem_list __user
*_list
)
585 struct list_head
*plist
;
586 struct snd_ctl_elem_list list
;
587 struct snd_kcontrol
*kctl
;
588 struct snd_ctl_elem_id
*dst
, *id
;
589 unsigned int offset
, space
, first
, jidx
;
591 if (copy_from_user(&list
, _list
, sizeof(list
)))
593 offset
= list
.offset
;
596 /* try limit maximum space */
600 /* allocate temporary buffer for atomic operation */
601 dst
= vmalloc(space
* sizeof(struct snd_ctl_elem_id
));
604 down_read(&card
->controls_rwsem
);
605 list
.count
= card
->controls_count
;
606 plist
= card
->controls
.next
;
607 while (plist
!= &card
->controls
) {
610 kctl
= snd_kcontrol(plist
);
611 if (offset
< kctl
->count
)
613 offset
-= kctl
->count
;
618 while (space
> 0 && plist
!= &card
->controls
) {
619 kctl
= snd_kcontrol(plist
);
620 for (jidx
= offset
; space
> 0 && jidx
< kctl
->count
; jidx
++) {
621 snd_ctl_build_ioff(id
, kctl
, jidx
);
629 up_read(&card
->controls_rwsem
);
631 copy_to_user(list
.pids
, dst
,
632 list
.used
* sizeof(struct snd_ctl_elem_id
))) {
638 down_read(&card
->controls_rwsem
);
639 list
.count
= card
->controls_count
;
640 up_read(&card
->controls_rwsem
);
642 if (copy_to_user(_list
, &list
, sizeof(list
)))
647 static int snd_ctl_elem_info(struct snd_ctl_file
*ctl
,
648 struct snd_ctl_elem_info
*info
)
650 struct snd_card
*card
= ctl
->card
;
651 struct snd_kcontrol
*kctl
;
652 struct snd_kcontrol_volatile
*vd
;
653 unsigned int index_offset
;
656 down_read(&card
->controls_rwsem
);
657 kctl
= snd_ctl_find_id(card
, &info
->id
);
659 up_read(&card
->controls_rwsem
);
662 #ifdef CONFIG_SND_DEBUG
665 result
= kctl
->info(kctl
, info
);
667 snd_BUG_ON(info
->access
);
668 index_offset
= snd_ctl_get_ioff(kctl
, &info
->id
);
669 vd
= &kctl
->vd
[index_offset
];
670 snd_ctl_build_ioff(&info
->id
, kctl
, index_offset
);
671 info
->access
= vd
->access
;
673 info
->access
|= SNDRV_CTL_ELEM_ACCESS_LOCK
;
674 if (vd
->owner
== ctl
)
675 info
->access
|= SNDRV_CTL_ELEM_ACCESS_OWNER
;
676 info
->owner
= pid_vnr(vd
->owner
->pid
);
681 up_read(&card
->controls_rwsem
);
685 static int snd_ctl_elem_info_user(struct snd_ctl_file
*ctl
,
686 struct snd_ctl_elem_info __user
*_info
)
688 struct snd_ctl_elem_info info
;
691 if (copy_from_user(&info
, _info
, sizeof(info
)))
693 snd_power_lock(ctl
->card
);
694 result
= snd_power_wait(ctl
->card
, SNDRV_CTL_POWER_D0
);
696 result
= snd_ctl_elem_info(ctl
, &info
);
697 snd_power_unlock(ctl
->card
);
699 if (copy_to_user(_info
, &info
, sizeof(info
)))
704 static int snd_ctl_elem_read(struct snd_card
*card
,
705 struct snd_ctl_elem_value
*control
)
707 struct snd_kcontrol
*kctl
;
708 struct snd_kcontrol_volatile
*vd
;
709 unsigned int index_offset
;
712 down_read(&card
->controls_rwsem
);
713 kctl
= snd_ctl_find_id(card
, &control
->id
);
717 index_offset
= snd_ctl_get_ioff(kctl
, &control
->id
);
718 vd
= &kctl
->vd
[index_offset
];
719 if ((vd
->access
& SNDRV_CTL_ELEM_ACCESS_READ
) &&
721 snd_ctl_build_ioff(&control
->id
, kctl
, index_offset
);
722 result
= kctl
->get(kctl
, control
);
726 up_read(&card
->controls_rwsem
);
730 static int snd_ctl_elem_read_user(struct snd_card
*card
,
731 struct snd_ctl_elem_value __user
*_control
)
733 struct snd_ctl_elem_value
*control
;
736 control
= memdup_user(_control
, sizeof(*control
));
738 return PTR_ERR(control
);
740 snd_power_lock(card
);
741 result
= snd_power_wait(card
, SNDRV_CTL_POWER_D0
);
743 result
= snd_ctl_elem_read(card
, control
);
744 snd_power_unlock(card
);
746 if (copy_to_user(_control
, control
, sizeof(*control
)))
752 static int snd_ctl_elem_write(struct snd_card
*card
, struct snd_ctl_file
*file
,
753 struct snd_ctl_elem_value
*control
)
755 struct snd_kcontrol
*kctl
;
756 struct snd_kcontrol_volatile
*vd
;
757 unsigned int index_offset
;
760 down_read(&card
->controls_rwsem
);
761 kctl
= snd_ctl_find_id(card
, &control
->id
);
765 index_offset
= snd_ctl_get_ioff(kctl
, &control
->id
);
766 vd
= &kctl
->vd
[index_offset
];
767 if (!(vd
->access
& SNDRV_CTL_ELEM_ACCESS_WRITE
) ||
769 (file
&& vd
->owner
&& vd
->owner
!= file
)) {
772 snd_ctl_build_ioff(&control
->id
, kctl
, index_offset
);
773 result
= kctl
->put(kctl
, control
);
776 up_read(&card
->controls_rwsem
);
777 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_VALUE
,
782 up_read(&card
->controls_rwsem
);
786 static int snd_ctl_elem_write_user(struct snd_ctl_file
*file
,
787 struct snd_ctl_elem_value __user
*_control
)
789 struct snd_ctl_elem_value
*control
;
790 struct snd_card
*card
;
793 control
= memdup_user(_control
, sizeof(*control
));
795 return PTR_ERR(control
);
798 snd_power_lock(card
);
799 result
= snd_power_wait(card
, SNDRV_CTL_POWER_D0
);
801 result
= snd_ctl_elem_write(card
, file
, control
);
802 snd_power_unlock(card
);
804 if (copy_to_user(_control
, control
, sizeof(*control
)))
810 static int snd_ctl_elem_lock(struct snd_ctl_file
*file
,
811 struct snd_ctl_elem_id __user
*_id
)
813 struct snd_card
*card
= file
->card
;
814 struct snd_ctl_elem_id id
;
815 struct snd_kcontrol
*kctl
;
816 struct snd_kcontrol_volatile
*vd
;
819 if (copy_from_user(&id
, _id
, sizeof(id
)))
821 down_write(&card
->controls_rwsem
);
822 kctl
= snd_ctl_find_id(card
, &id
);
826 vd
= &kctl
->vd
[snd_ctl_get_ioff(kctl
, &id
)];
827 if (vd
->owner
!= NULL
)
834 up_write(&card
->controls_rwsem
);
838 static int snd_ctl_elem_unlock(struct snd_ctl_file
*file
,
839 struct snd_ctl_elem_id __user
*_id
)
841 struct snd_card
*card
= file
->card
;
842 struct snd_ctl_elem_id id
;
843 struct snd_kcontrol
*kctl
;
844 struct snd_kcontrol_volatile
*vd
;
847 if (copy_from_user(&id
, _id
, sizeof(id
)))
849 down_write(&card
->controls_rwsem
);
850 kctl
= snd_ctl_find_id(card
, &id
);
854 vd
= &kctl
->vd
[snd_ctl_get_ioff(kctl
, &id
)];
855 if (vd
->owner
== NULL
)
857 else if (vd
->owner
!= file
)
864 up_write(&card
->controls_rwsem
);
868 struct user_element
{
869 struct snd_ctl_elem_info info
;
870 void *elem_data
; /* element data */
871 unsigned long elem_data_size
; /* size of element data in bytes */
872 void *tlv_data
; /* TLV data */
873 unsigned long tlv_data_size
; /* TLV data size */
874 void *priv_data
; /* private data (like strings for enumerated type) */
875 unsigned long priv_data_size
; /* size of private data in bytes */
878 static int snd_ctl_elem_user_info(struct snd_kcontrol
*kcontrol
,
879 struct snd_ctl_elem_info
*uinfo
)
881 struct user_element
*ue
= kcontrol
->private_data
;
887 static int snd_ctl_elem_user_get(struct snd_kcontrol
*kcontrol
,
888 struct snd_ctl_elem_value
*ucontrol
)
890 struct user_element
*ue
= kcontrol
->private_data
;
892 memcpy(&ucontrol
->value
, ue
->elem_data
, ue
->elem_data_size
);
896 static int snd_ctl_elem_user_put(struct snd_kcontrol
*kcontrol
,
897 struct snd_ctl_elem_value
*ucontrol
)
900 struct user_element
*ue
= kcontrol
->private_data
;
902 change
= memcmp(&ucontrol
->value
, ue
->elem_data
, ue
->elem_data_size
) != 0;
904 memcpy(ue
->elem_data
, &ucontrol
->value
, ue
->elem_data_size
);
908 static int snd_ctl_elem_user_tlv(struct snd_kcontrol
*kcontrol
,
911 unsigned int __user
*tlv
)
913 struct user_element
*ue
= kcontrol
->private_data
;
918 if (size
> 1024 * 128) /* sane value */
921 new_data
= memdup_user(tlv
, size
);
922 if (IS_ERR(new_data
))
923 return PTR_ERR(new_data
);
924 change
= ue
->tlv_data_size
!= size
;
926 change
= memcmp(ue
->tlv_data
, new_data
, size
);
928 ue
->tlv_data
= new_data
;
929 ue
->tlv_data_size
= size
;
931 if (! ue
->tlv_data_size
|| ! ue
->tlv_data
)
933 if (size
< ue
->tlv_data_size
)
935 if (copy_to_user(tlv
, ue
->tlv_data
, ue
->tlv_data_size
))
941 static void snd_ctl_elem_user_free(struct snd_kcontrol
*kcontrol
)
943 struct user_element
*ue
= kcontrol
->private_data
;
949 static int snd_ctl_elem_add(struct snd_ctl_file
*file
,
950 struct snd_ctl_elem_info
*info
, int replace
)
952 struct snd_card
*card
= file
->card
;
953 struct snd_kcontrol kctl
, *_kctl
;
956 struct user_element
*ue
;
959 if (card
->user_ctl_count
>= MAX_USER_CONTROLS
)
963 access
= info
->access
== 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE
:
964 (info
->access
& (SNDRV_CTL_ELEM_ACCESS_READWRITE
|
965 SNDRV_CTL_ELEM_ACCESS_INACTIVE
|
966 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
));
968 memset(&kctl
, 0, sizeof(kctl
));
969 down_write(&card
->controls_rwsem
);
970 _kctl
= snd_ctl_find_id(card
, &info
->id
);
974 err
= snd_ctl_remove(card
, _kctl
);
981 up_write(&card
->controls_rwsem
);
984 memcpy(&kctl
.id
, &info
->id
, sizeof(info
->id
));
985 kctl
.count
= info
->owner
? info
->owner
: 1;
986 access
|= SNDRV_CTL_ELEM_ACCESS_USER
;
987 kctl
.info
= snd_ctl_elem_user_info
;
988 if (access
& SNDRV_CTL_ELEM_ACCESS_READ
)
989 kctl
.get
= snd_ctl_elem_user_get
;
990 if (access
& SNDRV_CTL_ELEM_ACCESS_WRITE
)
991 kctl
.put
= snd_ctl_elem_user_put
;
992 if (access
& SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
) {
993 kctl
.tlv
.c
= snd_ctl_elem_user_tlv
;
994 access
|= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
;
996 switch (info
->type
) {
997 case SNDRV_CTL_ELEM_TYPE_BOOLEAN
:
998 case SNDRV_CTL_ELEM_TYPE_INTEGER
:
999 private_size
= sizeof(long);
1000 if (info
->count
> 128)
1003 case SNDRV_CTL_ELEM_TYPE_INTEGER64
:
1004 private_size
= sizeof(long long);
1005 if (info
->count
> 64)
1008 case SNDRV_CTL_ELEM_TYPE_BYTES
:
1009 private_size
= sizeof(unsigned char);
1010 if (info
->count
> 512)
1013 case SNDRV_CTL_ELEM_TYPE_IEC958
:
1014 private_size
= sizeof(struct snd_aes_iec958
);
1015 if (info
->count
!= 1)
1021 private_size
*= info
->count
;
1022 ue
= kzalloc(sizeof(struct user_element
) + private_size
, GFP_KERNEL
);
1026 ue
->info
.access
= 0;
1027 ue
->elem_data
= (char *)ue
+ sizeof(*ue
);
1028 ue
->elem_data_size
= private_size
;
1029 kctl
.private_free
= snd_ctl_elem_user_free
;
1030 _kctl
= snd_ctl_new(&kctl
, access
);
1031 if (_kctl
== NULL
) {
1035 _kctl
->private_data
= ue
;
1036 for (idx
= 0; idx
< _kctl
->count
; idx
++)
1037 _kctl
->vd
[idx
].owner
= file
;
1038 err
= snd_ctl_add(card
, _kctl
);
1042 down_write(&card
->controls_rwsem
);
1043 card
->user_ctl_count
++;
1044 up_write(&card
->controls_rwsem
);
1049 static int snd_ctl_elem_add_user(struct snd_ctl_file
*file
,
1050 struct snd_ctl_elem_info __user
*_info
, int replace
)
1052 struct snd_ctl_elem_info info
;
1053 if (copy_from_user(&info
, _info
, sizeof(info
)))
1055 return snd_ctl_elem_add(file
, &info
, replace
);
1058 static int snd_ctl_elem_remove(struct snd_ctl_file
*file
,
1059 struct snd_ctl_elem_id __user
*_id
)
1061 struct snd_ctl_elem_id id
;
1063 if (copy_from_user(&id
, _id
, sizeof(id
)))
1065 return snd_ctl_remove_user_ctl(file
, &id
);
1068 static int snd_ctl_subscribe_events(struct snd_ctl_file
*file
, int __user
*ptr
)
1071 if (get_user(subscribe
, ptr
))
1073 if (subscribe
< 0) {
1074 subscribe
= file
->subscribed
;
1075 if (put_user(subscribe
, ptr
))
1080 file
->subscribed
= 1;
1082 } else if (file
->subscribed
) {
1083 snd_ctl_empty_read_queue(file
);
1084 file
->subscribed
= 0;
1089 static int snd_ctl_tlv_ioctl(struct snd_ctl_file
*file
,
1090 struct snd_ctl_tlv __user
*_tlv
,
1093 struct snd_card
*card
= file
->card
;
1094 struct snd_ctl_tlv tlv
;
1095 struct snd_kcontrol
*kctl
;
1096 struct snd_kcontrol_volatile
*vd
;
1100 if (copy_from_user(&tlv
, _tlv
, sizeof(tlv
)))
1102 if (tlv
.length
< sizeof(unsigned int) * 3)
1104 down_read(&card
->controls_rwsem
);
1105 kctl
= snd_ctl_find_numid(card
, tlv
.numid
);
1110 if (kctl
->tlv
.p
== NULL
) {
1114 vd
= &kctl
->vd
[tlv
.numid
- kctl
->id
.numid
];
1115 if ((op_flag
== 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_READ
) == 0) ||
1116 (op_flag
> 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_WRITE
) == 0) ||
1117 (op_flag
< 0 && (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND
) == 0)) {
1121 if (vd
->access
& SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK
) {
1122 if (vd
->owner
!= NULL
&& vd
->owner
!= file
) {
1126 err
= kctl
->tlv
.c(kctl
, op_flag
, tlv
.length
, _tlv
->tlv
);
1128 up_read(&card
->controls_rwsem
);
1129 snd_ctl_notify(card
, SNDRV_CTL_EVENT_MASK_TLV
, &kctl
->id
);
1137 len
= kctl
->tlv
.p
[1] + 2 * sizeof(unsigned int);
1138 if (tlv
.length
< len
) {
1142 if (copy_to_user(_tlv
->tlv
, kctl
->tlv
.p
, len
))
1146 up_read(&card
->controls_rwsem
);
1150 static long snd_ctl_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
1152 struct snd_ctl_file
*ctl
;
1153 struct snd_card
*card
;
1154 struct snd_kctl_ioctl
*p
;
1155 void __user
*argp
= (void __user
*)arg
;
1156 int __user
*ip
= argp
;
1159 ctl
= file
->private_data
;
1161 if (snd_BUG_ON(!card
))
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 if (snd_BUG_ON(!ctl
|| !ctl
->card
))
1226 if (!ctl
->subscribed
)
1228 if (count
< sizeof(struct snd_ctl_event
))
1230 spin_lock_irq(&ctl
->read_lock
);
1231 while (count
>= sizeof(struct snd_ctl_event
)) {
1232 struct snd_ctl_event ev
;
1233 struct snd_kctl_event
*kev
;
1234 while (list_empty(&ctl
->events
)) {
1236 if ((file
->f_flags
& O_NONBLOCK
) != 0 || result
> 0) {
1240 init_waitqueue_entry(&wait
, current
);
1241 add_wait_queue(&ctl
->change_sleep
, &wait
);
1242 set_current_state(TASK_INTERRUPTIBLE
);
1243 spin_unlock_irq(&ctl
->read_lock
);
1245 remove_wait_queue(&ctl
->change_sleep
, &wait
);
1246 if (signal_pending(current
))
1247 return -ERESTARTSYS
;
1248 spin_lock_irq(&ctl
->read_lock
);
1250 kev
= snd_kctl_event(ctl
->events
.next
);
1251 ev
.type
= SNDRV_CTL_EVENT_ELEM
;
1252 ev
.data
.elem
.mask
= kev
->mask
;
1253 ev
.data
.elem
.id
= kev
->id
;
1254 list_del(&kev
->list
);
1255 spin_unlock_irq(&ctl
->read_lock
);
1257 if (copy_to_user(buffer
, &ev
, sizeof(struct snd_ctl_event
))) {
1261 spin_lock_irq(&ctl
->read_lock
);
1262 buffer
+= sizeof(struct snd_ctl_event
);
1263 count
-= sizeof(struct snd_ctl_event
);
1264 result
+= sizeof(struct snd_ctl_event
);
1267 spin_unlock_irq(&ctl
->read_lock
);
1269 return result
> 0 ? result
: err
;
1272 static unsigned int snd_ctl_poll(struct file
*file
, poll_table
* wait
)
1275 struct snd_ctl_file
*ctl
;
1277 ctl
= file
->private_data
;
1278 if (!ctl
->subscribed
)
1280 poll_wait(file
, &ctl
->change_sleep
, wait
);
1283 if (!list_empty(&ctl
->events
))
1284 mask
|= POLLIN
| POLLRDNORM
;
1290 * register the device-specific control-ioctls.
1291 * called from each device manager like pcm.c, hwdep.c, etc.
1293 static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn
, struct list_head
*lists
)
1295 struct snd_kctl_ioctl
*pn
;
1297 pn
= kzalloc(sizeof(struct snd_kctl_ioctl
), GFP_KERNEL
);
1301 down_write(&snd_ioctl_rwsem
);
1302 list_add_tail(&pn
->list
, lists
);
1303 up_write(&snd_ioctl_rwsem
);
1307 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn
)
1309 return _snd_ctl_register_ioctl(fcn
, &snd_control_ioctls
);
1312 EXPORT_SYMBOL(snd_ctl_register_ioctl
);
1314 #ifdef CONFIG_COMPAT
1315 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn
)
1317 return _snd_ctl_register_ioctl(fcn
, &snd_control_compat_ioctls
);
1320 EXPORT_SYMBOL(snd_ctl_register_ioctl_compat
);
1324 * de-register the device-specific control-ioctls.
1326 static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn
,
1327 struct list_head
*lists
)
1329 struct snd_kctl_ioctl
*p
;
1331 if (snd_BUG_ON(!fcn
))
1333 down_write(&snd_ioctl_rwsem
);
1334 list_for_each_entry(p
, lists
, list
) {
1335 if (p
->fioctl
== fcn
) {
1337 up_write(&snd_ioctl_rwsem
);
1342 up_write(&snd_ioctl_rwsem
);
1347 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn
)
1349 return _snd_ctl_unregister_ioctl(fcn
, &snd_control_ioctls
);
1352 EXPORT_SYMBOL(snd_ctl_unregister_ioctl
);
1354 #ifdef CONFIG_COMPAT
1355 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn
)
1357 return _snd_ctl_unregister_ioctl(fcn
, &snd_control_compat_ioctls
);
1360 EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat
);
1363 static int snd_ctl_fasync(int fd
, struct file
* file
, int on
)
1365 struct snd_ctl_file
*ctl
;
1367 ctl
= file
->private_data
;
1368 return fasync_helper(fd
, file
, on
, &ctl
->fasync
);
1374 #ifdef CONFIG_COMPAT
1375 #include "control_compat.c"
1377 #define snd_ctl_ioctl_compat NULL
1384 static const struct file_operations snd_ctl_f_ops
=
1386 .owner
= THIS_MODULE
,
1387 .read
= snd_ctl_read
,
1388 .open
= snd_ctl_open
,
1389 .release
= snd_ctl_release
,
1390 .poll
= snd_ctl_poll
,
1391 .unlocked_ioctl
= snd_ctl_ioctl
,
1392 .compat_ioctl
= snd_ctl_ioctl_compat
,
1393 .fasync
= snd_ctl_fasync
,
1397 * registration of the control device
1399 static int snd_ctl_dev_register(struct snd_device
*device
)
1401 struct snd_card
*card
= device
->device_data
;
1405 if (snd_BUG_ON(!card
))
1407 cardnum
= card
->number
;
1408 if (snd_BUG_ON(cardnum
< 0 || cardnum
>= SNDRV_CARDS
))
1410 sprintf(name
, "controlC%i", cardnum
);
1411 if ((err
= snd_register_device(SNDRV_DEVICE_TYPE_CONTROL
, card
, -1,
1412 &snd_ctl_f_ops
, card
, name
)) < 0)
1418 * disconnection of the control device
1420 static int snd_ctl_dev_disconnect(struct snd_device
*device
)
1422 struct snd_card
*card
= device
->device_data
;
1423 struct snd_ctl_file
*ctl
;
1426 if (snd_BUG_ON(!card
))
1428 cardnum
= card
->number
;
1429 if (snd_BUG_ON(cardnum
< 0 || cardnum
>= SNDRV_CARDS
))
1432 read_lock(&card
->ctl_files_rwlock
);
1433 list_for_each_entry(ctl
, &card
->ctl_files
, list
) {
1434 wake_up(&ctl
->change_sleep
);
1435 kill_fasync(&ctl
->fasync
, SIGIO
, POLL_ERR
);
1437 read_unlock(&card
->ctl_files_rwlock
);
1439 if ((err
= snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL
,
1448 static int snd_ctl_dev_free(struct snd_device
*device
)
1450 struct snd_card
*card
= device
->device_data
;
1451 struct snd_kcontrol
*control
;
1453 down_write(&card
->controls_rwsem
);
1454 while (!list_empty(&card
->controls
)) {
1455 control
= snd_kcontrol(card
->controls
.next
);
1456 snd_ctl_remove(card
, control
);
1458 up_write(&card
->controls_rwsem
);
1463 * create control core:
1464 * called from init.c
1466 int snd_ctl_create(struct snd_card
*card
)
1468 static struct snd_device_ops ops
= {
1469 .dev_free
= snd_ctl_dev_free
,
1470 .dev_register
= snd_ctl_dev_register
,
1471 .dev_disconnect
= snd_ctl_dev_disconnect
,
1474 if (snd_BUG_ON(!card
))
1476 return snd_device_new(card
, SNDRV_DEV_CONTROL
, card
, &ops
);
1480 * Frequently used control callbacks
1482 int snd_ctl_boolean_mono_info(struct snd_kcontrol
*kcontrol
,
1483 struct snd_ctl_elem_info
*uinfo
)
1485 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1487 uinfo
->value
.integer
.min
= 0;
1488 uinfo
->value
.integer
.max
= 1;
1492 EXPORT_SYMBOL(snd_ctl_boolean_mono_info
);
1494 int snd_ctl_boolean_stereo_info(struct snd_kcontrol
*kcontrol
,
1495 struct snd_ctl_elem_info
*uinfo
)
1497 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_BOOLEAN
;
1499 uinfo
->value
.integer
.min
= 0;
1500 uinfo
->value
.integer
.max
= 1;
1504 EXPORT_SYMBOL(snd_ctl_boolean_stereo_info
);