blob: 9ce00ed20fba3d9141cb13dd045230412ee86e4c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Routines for driver control interface
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02003 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 *
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.
10 *
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.
15 *
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
19 *
20 */
21
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/threads.h>
23#include <linux/interrupt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#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>
31
32/* max number of user-defined controls */
33#define MAX_USER_CONTROLS 32
Dan Rosenberg5591bf02010-09-28 14:18:20 -040034#define MAX_CONTROL_COUNT 1028
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Takashi Iwai82e9bae2005-11-17 13:53:23 +010036struct snd_kctl_ioctl {
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 struct list_head list; /* list of all ioctls */
38 snd_kctl_ioctl_func_t fioctl;
Takashi Iwai82e9bae2005-11-17 13:53:23 +010039};
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41static DECLARE_RWSEM(snd_ioctl_rwsem);
42static LIST_HEAD(snd_control_ioctls);
43#ifdef CONFIG_COMPAT
44static LIST_HEAD(snd_control_compat_ioctls);
45#endif
46
47static int snd_ctl_open(struct inode *inode, struct file *file)
48{
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 unsigned long flags;
Takashi Iwai82e9bae2005-11-17 13:53:23 +010050 struct snd_card *card;
51 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 int err;
53
Takashi Iwai02f48652010-04-13 11:49:04 +020054 err = nonseekable_open(inode, file);
55 if (err < 0)
56 return err;
57
Clemens Ladischf87135f2005-11-20 14:06:59 +010058 card = snd_lookup_minor_data(iminor(inode), SNDRV_DEVICE_TYPE_CONTROL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 if (!card) {
60 err = -ENODEV;
61 goto __error1;
62 }
63 err = snd_card_file_add(card, file);
64 if (err < 0) {
65 err = -ENODEV;
66 goto __error1;
67 }
68 if (!try_module_get(card->module)) {
69 err = -EFAULT;
70 goto __error2;
71 }
Takashi Iwaica2c0962005-09-09 14:20:23 +020072 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 if (ctl == NULL) {
74 err = -ENOMEM;
75 goto __error;
76 }
77 INIT_LIST_HEAD(&ctl->events);
78 init_waitqueue_head(&ctl->change_sleep);
79 spin_lock_init(&ctl->read_lock);
80 ctl->card = card;
Takashi Iwai2529bba2006-08-04 12:57:19 +020081 ctl->prefer_pcm_subdevice = -1;
82 ctl->prefer_rawmidi_subdevice = -1;
Clemens Ladisch25d27ed2009-11-02 09:35:44 +010083 ctl->pid = get_pid(task_pid(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 file->private_data = ctl;
85 write_lock_irqsave(&card->ctl_files_rwlock, flags);
86 list_add_tail(&ctl->list, &card->ctl_files);
87 write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
88 return 0;
89
90 __error:
91 module_put(card->module);
92 __error2:
93 snd_card_file_remove(card, file);
94 __error1:
95 return err;
96}
97
Takashi Iwai82e9bae2005-11-17 13:53:23 +010098static void snd_ctl_empty_read_queue(struct snd_ctl_file * ctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -070099{
Borislav Petkov7507e8d2007-10-22 17:11:09 +0200100 unsigned long flags;
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100101 struct snd_kctl_event *cread;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Borislav Petkov7507e8d2007-10-22 17:11:09 +0200103 spin_lock_irqsave(&ctl->read_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 while (!list_empty(&ctl->events)) {
105 cread = snd_kctl_event(ctl->events.next);
106 list_del(&cread->list);
107 kfree(cread);
108 }
Borislav Petkov7507e8d2007-10-22 17:11:09 +0200109 spin_unlock_irqrestore(&ctl->read_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110}
111
112static int snd_ctl_release(struct inode *inode, struct file *file)
113{
114 unsigned long flags;
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100115 struct snd_card *card;
116 struct snd_ctl_file *ctl;
117 struct snd_kcontrol *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 unsigned int idx;
119
120 ctl = file->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 file->private_data = NULL;
122 card = ctl->card;
123 write_lock_irqsave(&card->ctl_files_rwlock, flags);
124 list_del(&ctl->list);
125 write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
126 down_write(&card->controls_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +0200127 list_for_each_entry(control, &card->controls, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 for (idx = 0; idx < control->count; idx++)
129 if (control->vd[idx].owner == ctl)
130 control->vd[idx].owner = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 up_write(&card->controls_rwsem);
132 snd_ctl_empty_read_queue(ctl);
Clemens Ladisch25d27ed2009-11-02 09:35:44 +0100133 put_pid(ctl->pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 kfree(ctl);
135 module_put(card->module);
136 snd_card_file_remove(card, file);
137 return 0;
138}
139
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100140void snd_ctl_notify(struct snd_card *card, unsigned int mask,
141 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142{
143 unsigned long flags;
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100144 struct snd_ctl_file *ctl;
145 struct snd_kctl_event *ev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200147 if (snd_BUG_ON(!card || !id))
148 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 read_lock(&card->ctl_files_rwlock);
150#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
151 card->mixer_oss_change_count++;
152#endif
Johannes Berg9244b2c2006-10-05 16:02:22 +0200153 list_for_each_entry(ctl, &card->ctl_files, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 if (!ctl->subscribed)
155 continue;
156 spin_lock_irqsave(&ctl->read_lock, flags);
Johannes Berg9244b2c2006-10-05 16:02:22 +0200157 list_for_each_entry(ev, &ctl->events, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 if (ev->id.numid == id->numid) {
159 ev->mask |= mask;
160 goto _found;
161 }
162 }
Takashi Iwaica2c0962005-09-09 14:20:23 +0200163 ev = kzalloc(sizeof(*ev), GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 if (ev) {
165 ev->id = *id;
166 ev->mask = mask;
167 list_add_tail(&ev->list, &ctl->events);
168 } else {
169 snd_printk(KERN_ERR "No memory available to allocate event\n");
170 }
171 _found:
172 wake_up(&ctl->change_sleep);
173 spin_unlock_irqrestore(&ctl->read_lock, flags);
174 kill_fasync(&ctl->fasync, SIGIO, POLL_IN);
175 }
176 read_unlock(&card->ctl_files_rwlock);
177}
178
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200179EXPORT_SYMBOL(snd_ctl_notify);
180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181/**
182 * snd_ctl_new - create a control instance from the template
183 * @control: the control template
184 * @access: the default control access
185 *
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100186 * Allocates a new struct snd_kcontrol instance and copies the given template
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 * to the new instance. It does not copy volatile data (access).
188 *
189 * Returns the pointer of the new instance, or NULL on failure.
190 */
Adrian Bunk0b51ba02006-11-20 17:50:17 +0100191static struct snd_kcontrol *snd_ctl_new(struct snd_kcontrol *control,
192 unsigned int access)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100194 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 unsigned int idx;
196
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200197 if (snd_BUG_ON(!control || !control->count))
198 return NULL;
Dan Rosenberg5591bf02010-09-28 14:18:20 -0400199
200 if (control->count > MAX_CONTROL_COUNT)
201 return NULL;
202
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100203 kctl = kzalloc(sizeof(*kctl) + sizeof(struct snd_kcontrol_volatile) * control->count, GFP_KERNEL);
Takashi Iwai73e77ba2005-11-17 17:44:01 +0100204 if (kctl == NULL) {
205 snd_printk(KERN_ERR "Cannot allocate control instance\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 return NULL;
Takashi Iwai73e77ba2005-11-17 17:44:01 +0100207 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 *kctl = *control;
209 for (idx = 0; idx < kctl->count; idx++)
210 kctl->vd[idx].access = access;
211 return kctl;
212}
213
214/**
215 * snd_ctl_new1 - create a control instance from the template
216 * @ncontrol: the initialization record
217 * @private_data: the private data to set
218 *
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100219 * Allocates a new struct snd_kcontrol instance and initialize from the given
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 * template. When the access field of ncontrol is 0, it's assumed as
221 * READWRITE access. When the count field is 0, it's assumes as one.
222 *
223 * Returns the pointer of the newly generated instance, or NULL on failure.
224 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100225struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new *ncontrol,
226 void *private_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100228 struct snd_kcontrol kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 unsigned int access;
230
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200231 if (snd_BUG_ON(!ncontrol || !ncontrol->info))
232 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 memset(&kctl, 0, sizeof(kctl));
234 kctl.id.iface = ncontrol->iface;
235 kctl.id.device = ncontrol->device;
236 kctl.id.subdevice = ncontrol->subdevice;
Mark Brown366840d2008-10-29 14:40:30 +0000237 if (ncontrol->name) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 strlcpy(kctl.id.name, ncontrol->name, sizeof(kctl.id.name));
Mark Brown366840d2008-10-29 14:40:30 +0000239 if (strcmp(ncontrol->name, kctl.id.name) != 0)
240 snd_printk(KERN_WARNING
241 "Control name '%s' truncated to '%s'\n",
242 ncontrol->name, kctl.id.name);
243 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 kctl.id.index = ncontrol->index;
245 kctl.count = ncontrol->count ? ncontrol->count : 1;
246 access = ncontrol->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200247 (ncontrol->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
248 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
Clemens Ladischa75d7a42010-02-01 13:29:50 +0100249 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE|
250 SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND|
251 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 kctl.info = ncontrol->info;
253 kctl.get = ncontrol->get;
254 kctl.put = ncontrol->put;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200255 kctl.tlv.p = ncontrol->tlv.p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 kctl.private_value = ncontrol->private_value;
257 kctl.private_data = private_data;
258 return snd_ctl_new(&kctl, access);
259}
260
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200261EXPORT_SYMBOL(snd_ctl_new1);
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263/**
264 * snd_ctl_free_one - release the control instance
265 * @kcontrol: the control instance
266 *
267 * Releases the control instance created via snd_ctl_new()
268 * or snd_ctl_new1().
269 * Don't call this after the control was added to the card.
270 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100271void snd_ctl_free_one(struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272{
273 if (kcontrol) {
274 if (kcontrol->private_free)
275 kcontrol->private_free(kcontrol);
276 kfree(kcontrol);
277 }
278}
279
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200280EXPORT_SYMBOL(snd_ctl_free_one);
281
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100282static unsigned int snd_ctl_hole_check(struct snd_card *card,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 unsigned int count)
284{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100285 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
Johannes Berg9244b2c2006-10-05 16:02:22 +0200287 list_for_each_entry(kctl, &card->controls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 if ((kctl->id.numid <= card->last_numid &&
289 kctl->id.numid + kctl->count > card->last_numid) ||
290 (kctl->id.numid <= card->last_numid + count - 1 &&
291 kctl->id.numid + kctl->count > card->last_numid + count - 1))
292 return card->last_numid = kctl->id.numid + kctl->count - 1;
293 }
294 return card->last_numid;
295}
296
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100297static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298{
299 unsigned int last_numid, iter = 100000;
300
301 last_numid = card->last_numid;
302 while (last_numid != snd_ctl_hole_check(card, count)) {
303 if (--iter == 0) {
304 /* this situation is very unlikely */
305 snd_printk(KERN_ERR "unable to allocate new control numid\n");
306 return -ENOMEM;
307 }
308 last_numid = card->last_numid;
309 }
310 return 0;
311}
312
313/**
314 * snd_ctl_add - add the control instance to the card
315 * @card: the card instance
316 * @kcontrol: the control instance to add
317 *
318 * Adds the control instance created via snd_ctl_new() or
319 * snd_ctl_new1() to the given card. Assigns also an unique
320 * numid used for fast search.
321 *
322 * Returns zero if successful, or a negative error code on failure.
323 *
324 * It frees automatically the control which cannot be added.
325 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100326int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100328 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 unsigned int idx;
Takashi Iwaic6077b32006-03-21 16:07:13 +0100330 int err = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
Takashi Iwai73e77ba2005-11-17 17:44:01 +0100332 if (! kcontrol)
Takashi Iwaic6077b32006-03-21 16:07:13 +0100333 return err;
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200334 if (snd_BUG_ON(!card || !kcontrol->info))
335 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 id = kcontrol->id;
337 down_write(&card->controls_rwsem);
338 if (snd_ctl_find_id(card, &id)) {
339 up_write(&card->controls_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 snd_printd(KERN_ERR "control %i:%i:%i:%s:%i is already present\n",
341 id.iface,
342 id.device,
343 id.subdevice,
344 id.name,
345 id.index);
Takashi Iwaic6077b32006-03-21 16:07:13 +0100346 err = -EBUSY;
347 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 }
349 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
350 up_write(&card->controls_rwsem);
Takashi Iwaic6077b32006-03-21 16:07:13 +0100351 err = -ENOMEM;
352 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 }
354 list_add_tail(&kcontrol->list, &card->controls);
355 card->controls_count += kcontrol->count;
356 kcontrol->id.numid = card->last_numid + 1;
357 card->last_numid += kcontrol->count;
358 up_write(&card->controls_rwsem);
359 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
360 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
361 return 0;
Takashi Iwaic6077b32006-03-21 16:07:13 +0100362
363 error:
364 snd_ctl_free_one(kcontrol);
365 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366}
367
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200368EXPORT_SYMBOL(snd_ctl_add);
369
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370/**
371 * snd_ctl_remove - remove the control from the card and release it
372 * @card: the card instance
373 * @kcontrol: the control instance to remove
374 *
375 * Removes the control from the card and then releases the instance.
376 * You don't need to call snd_ctl_free_one(). You must be in
377 * the write lock - down_write(&card->controls_rwsem).
378 *
379 * Returns 0 if successful, or a negative error code on failure.
380 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100381int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100383 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 unsigned int idx;
385
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200386 if (snd_BUG_ON(!card || !kcontrol))
387 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 list_del(&kcontrol->list);
389 card->controls_count -= kcontrol->count;
390 id = kcontrol->id;
391 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
392 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
393 snd_ctl_free_one(kcontrol);
394 return 0;
395}
396
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200397EXPORT_SYMBOL(snd_ctl_remove);
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399/**
400 * snd_ctl_remove_id - remove the control of the given id and release it
401 * @card: the card instance
402 * @id: the control id to remove
403 *
404 * Finds the control instance with the given id, removes it from the
405 * card list and releases it.
406 *
407 * Returns 0 if successful, or a negative error code on failure.
408 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100409int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100411 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 int ret;
413
414 down_write(&card->controls_rwsem);
415 kctl = snd_ctl_find_id(card, id);
416 if (kctl == NULL) {
417 up_write(&card->controls_rwsem);
418 return -ENOENT;
419 }
420 ret = snd_ctl_remove(card, kctl);
421 up_write(&card->controls_rwsem);
422 return ret;
423}
424
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200425EXPORT_SYMBOL(snd_ctl_remove_id);
426
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427/**
Clemens Ladischf217ac52009-08-17 12:27:22 +0200428 * snd_ctl_remove_user_ctl - remove and release the unlocked user control
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 * @file: active control handle
430 * @id: the control id to remove
431 *
432 * Finds the control instance with the given id, removes it from the
433 * card list and releases it.
434 *
435 * Returns 0 if successful, or a negative error code on failure.
436 */
Clemens Ladischf217ac52009-08-17 12:27:22 +0200437static int snd_ctl_remove_user_ctl(struct snd_ctl_file * file,
438 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100440 struct snd_card *card = file->card;
441 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 int idx, ret;
443
444 down_write(&card->controls_rwsem);
445 kctl = snd_ctl_find_id(card, id);
446 if (kctl == NULL) {
Clemens Ladisch317b8082009-08-17 12:26:34 +0200447 ret = -ENOENT;
448 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 }
Clemens Ladisch18dd0aa2009-08-17 12:28:09 +0200450 if (!(kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_USER)) {
451 ret = -EINVAL;
452 goto error;
453 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 for (idx = 0; idx < kctl->count; idx++)
455 if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
Clemens Ladisch317b8082009-08-17 12:26:34 +0200456 ret = -EBUSY;
457 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 }
459 ret = snd_ctl_remove(card, kctl);
Clemens Ladischf217ac52009-08-17 12:27:22 +0200460 if (ret < 0)
461 goto error;
462 card->user_ctl_count--;
Clemens Ladisch317b8082009-08-17 12:26:34 +0200463error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 up_write(&card->controls_rwsem);
465 return ret;
466}
467
468/**
469 * snd_ctl_rename_id - replace the id of a control on the card
470 * @card: the card instance
471 * @src_id: the old id
472 * @dst_id: the new id
473 *
474 * Finds the control with the old id from the card, and replaces the
475 * id with the new one.
476 *
477 * Returns zero if successful, or a negative error code on failure.
478 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100479int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
480 struct snd_ctl_elem_id *dst_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100482 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
484 down_write(&card->controls_rwsem);
485 kctl = snd_ctl_find_id(card, src_id);
486 if (kctl == NULL) {
487 up_write(&card->controls_rwsem);
488 return -ENOENT;
489 }
490 kctl->id = *dst_id;
491 kctl->id.numid = card->last_numid + 1;
492 card->last_numid += kctl->count;
493 up_write(&card->controls_rwsem);
494 return 0;
495}
496
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200497EXPORT_SYMBOL(snd_ctl_rename_id);
498
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499/**
500 * snd_ctl_find_numid - find the control instance with the given number-id
501 * @card: the card instance
502 * @numid: the number-id to search
503 *
504 * Finds the control instance with the given number-id from the card.
505 *
506 * Returns the pointer of the instance if found, or NULL if not.
507 *
508 * The caller must down card->controls_rwsem before calling this function
509 * (if the race condition can happen).
510 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100511struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100513 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200515 if (snd_BUG_ON(!card || !numid))
516 return NULL;
Johannes Berg9244b2c2006-10-05 16:02:22 +0200517 list_for_each_entry(kctl, &card->controls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
519 return kctl;
520 }
521 return NULL;
522}
523
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200524EXPORT_SYMBOL(snd_ctl_find_numid);
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526/**
527 * snd_ctl_find_id - find the control instance with the given id
528 * @card: the card instance
529 * @id: the id to search
530 *
531 * Finds the control instance with the given id from the card.
532 *
533 * Returns the pointer of the instance if found, or NULL if not.
534 *
535 * The caller must down card->controls_rwsem before calling this function
536 * (if the race condition can happen).
537 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100538struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
539 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100541 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200543 if (snd_BUG_ON(!card || !id))
544 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 if (id->numid != 0)
546 return snd_ctl_find_numid(card, id->numid);
Johannes Berg9244b2c2006-10-05 16:02:22 +0200547 list_for_each_entry(kctl, &card->controls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 if (kctl->id.iface != id->iface)
549 continue;
550 if (kctl->id.device != id->device)
551 continue;
552 if (kctl->id.subdevice != id->subdevice)
553 continue;
554 if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
555 continue;
556 if (kctl->id.index > id->index)
557 continue;
558 if (kctl->id.index + kctl->count <= id->index)
559 continue;
560 return kctl;
561 }
562 return NULL;
563}
564
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200565EXPORT_SYMBOL(snd_ctl_find_id);
566
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100567static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 unsigned int cmd, void __user *arg)
569{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100570 struct snd_ctl_card_info *info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Takashi Iwaica2c0962005-09-09 14:20:23 +0200572 info = kzalloc(sizeof(*info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 if (! info)
574 return -ENOMEM;
575 down_read(&snd_ioctl_rwsem);
576 info->card = card->number;
577 strlcpy(info->id, card->id, sizeof(info->id));
578 strlcpy(info->driver, card->driver, sizeof(info->driver));
579 strlcpy(info->name, card->shortname, sizeof(info->name));
580 strlcpy(info->longname, card->longname, sizeof(info->longname));
581 strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
582 strlcpy(info->components, card->components, sizeof(info->components));
583 up_read(&snd_ioctl_rwsem);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100584 if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 kfree(info);
586 return -EFAULT;
587 }
588 kfree(info);
589 return 0;
590}
591
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100592static int snd_ctl_elem_list(struct snd_card *card,
593 struct snd_ctl_elem_list __user *_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594{
595 struct list_head *plist;
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100596 struct snd_ctl_elem_list list;
597 struct snd_kcontrol *kctl;
598 struct snd_ctl_elem_id *dst, *id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 unsigned int offset, space, first, jidx;
600
601 if (copy_from_user(&list, _list, sizeof(list)))
602 return -EFAULT;
603 offset = list.offset;
604 space = list.space;
605 first = 0;
606 /* try limit maximum space */
607 if (space > 16384)
608 return -ENOMEM;
609 if (space > 0) {
610 /* allocate temporary buffer for atomic operation */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100611 dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 if (dst == NULL)
613 return -ENOMEM;
614 down_read(&card->controls_rwsem);
615 list.count = card->controls_count;
616 plist = card->controls.next;
617 while (plist != &card->controls) {
618 if (offset == 0)
619 break;
620 kctl = snd_kcontrol(plist);
621 if (offset < kctl->count)
622 break;
623 offset -= kctl->count;
624 plist = plist->next;
625 }
626 list.used = 0;
627 id = dst;
628 while (space > 0 && plist != &card->controls) {
629 kctl = snd_kcontrol(plist);
630 for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
631 snd_ctl_build_ioff(id, kctl, jidx);
632 id++;
633 space--;
634 list.used++;
635 }
636 plist = plist->next;
637 offset = 0;
638 }
639 up_read(&card->controls_rwsem);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100640 if (list.used > 0 &&
641 copy_to_user(list.pids, dst,
642 list.used * sizeof(struct snd_ctl_elem_id))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 vfree(dst);
644 return -EFAULT;
645 }
646 vfree(dst);
647 } else {
648 down_read(&card->controls_rwsem);
649 list.count = card->controls_count;
650 up_read(&card->controls_rwsem);
651 }
652 if (copy_to_user(_list, &list, sizeof(list)))
653 return -EFAULT;
654 return 0;
655}
656
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100657static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
658 struct snd_ctl_elem_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100660 struct snd_card *card = ctl->card;
661 struct snd_kcontrol *kctl;
662 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 unsigned int index_offset;
664 int result;
665
666 down_read(&card->controls_rwsem);
667 kctl = snd_ctl_find_id(card, &info->id);
668 if (kctl == NULL) {
669 up_read(&card->controls_rwsem);
670 return -ENOENT;
671 }
672#ifdef CONFIG_SND_DEBUG
673 info->access = 0;
674#endif
675 result = kctl->info(kctl, info);
676 if (result >= 0) {
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200677 snd_BUG_ON(info->access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 index_offset = snd_ctl_get_ioff(kctl, &info->id);
679 vd = &kctl->vd[index_offset];
680 snd_ctl_build_ioff(&info->id, kctl, index_offset);
681 info->access = vd->access;
682 if (vd->owner) {
683 info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
684 if (vd->owner == ctl)
685 info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
Clemens Ladisch25d27ed2009-11-02 09:35:44 +0100686 info->owner = pid_vnr(vd->owner->pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 } else {
688 info->owner = -1;
689 }
690 }
691 up_read(&card->controls_rwsem);
692 return result;
693}
694
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100695static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
696 struct snd_ctl_elem_info __user *_info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100698 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 int result;
700
701 if (copy_from_user(&info, _info, sizeof(info)))
702 return -EFAULT;
Giuliano Pochini64649402006-03-13 14:11:11 +0100703 snd_power_lock(ctl->card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200704 result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100705 if (result >= 0)
706 result = snd_ctl_elem_info(ctl, &info);
707 snd_power_unlock(ctl->card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 if (result >= 0)
709 if (copy_to_user(_info, &info, sizeof(info)))
710 return -EFAULT;
711 return result;
712}
713
Takashi Iwaid3bd67c2008-06-12 18:17:26 +0200714static int snd_ctl_elem_read(struct snd_card *card,
715 struct snd_ctl_elem_value *control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100717 struct snd_kcontrol *kctl;
718 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 unsigned int index_offset;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100720 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
722 down_read(&card->controls_rwsem);
723 kctl = snd_ctl_find_id(card, &control->id);
724 if (kctl == NULL) {
725 result = -ENOENT;
726 } else {
727 index_offset = snd_ctl_get_ioff(kctl, &control->id);
728 vd = &kctl->vd[index_offset];
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100729 if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) &&
730 kctl->get != NULL) {
731 snd_ctl_build_ioff(&control->id, kctl, index_offset);
732 result = kctl->get(kctl, control);
733 } else
734 result = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 }
736 up_read(&card->controls_rwsem);
737 return result;
738}
739
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100740static int snd_ctl_elem_read_user(struct snd_card *card,
741 struct snd_ctl_elem_value __user *_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100743 struct snd_ctl_elem_value *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 int result;
Li Zefanef44a1e2009-04-10 09:43:08 +0800745
746 control = memdup_user(_control, sizeof(*control));
747 if (IS_ERR(control))
748 return PTR_ERR(control);
749
Giuliano Pochini64649402006-03-13 14:11:11 +0100750 snd_power_lock(card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200751 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100752 if (result >= 0)
753 result = snd_ctl_elem_read(card, control);
754 snd_power_unlock(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 if (result >= 0)
756 if (copy_to_user(_control, control, sizeof(*control)))
757 result = -EFAULT;
758 kfree(control);
759 return result;
760}
761
Takashi Iwaid3bd67c2008-06-12 18:17:26 +0200762static int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
763 struct snd_ctl_elem_value *control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100765 struct snd_kcontrol *kctl;
766 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 unsigned int index_offset;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100768 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
770 down_read(&card->controls_rwsem);
771 kctl = snd_ctl_find_id(card, &control->id);
772 if (kctl == NULL) {
773 result = -ENOENT;
774 } else {
775 index_offset = snd_ctl_get_ioff(kctl, &control->id);
776 vd = &kctl->vd[index_offset];
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100777 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
778 kctl->put == NULL ||
779 (file && vd->owner && vd->owner != file)) {
780 result = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 } else {
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100782 snd_ctl_build_ioff(&control->id, kctl, index_offset);
783 result = kctl->put(kctl, control);
784 }
785 if (result > 0) {
786 up_read(&card->controls_rwsem);
787 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
788 &control->id);
789 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 }
791 }
792 up_read(&card->controls_rwsem);
793 return result;
794}
795
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100796static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
797 struct snd_ctl_elem_value __user *_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100799 struct snd_ctl_elem_value *control;
Giuliano Pochini64649402006-03-13 14:11:11 +0100800 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 int result;
802
Li Zefanef44a1e2009-04-10 09:43:08 +0800803 control = memdup_user(_control, sizeof(*control));
804 if (IS_ERR(control))
805 return PTR_ERR(control);
806
Giuliano Pochini64649402006-03-13 14:11:11 +0100807 card = file->card;
808 snd_power_lock(card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200809 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100810 if (result >= 0)
811 result = snd_ctl_elem_write(card, file, control);
812 snd_power_unlock(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 if (result >= 0)
814 if (copy_to_user(_control, control, sizeof(*control)))
815 result = -EFAULT;
816 kfree(control);
817 return result;
818}
819
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100820static int snd_ctl_elem_lock(struct snd_ctl_file *file,
821 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100823 struct snd_card *card = file->card;
824 struct snd_ctl_elem_id id;
825 struct snd_kcontrol *kctl;
826 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 int result;
828
829 if (copy_from_user(&id, _id, sizeof(id)))
830 return -EFAULT;
831 down_write(&card->controls_rwsem);
832 kctl = snd_ctl_find_id(card, &id);
833 if (kctl == NULL) {
834 result = -ENOENT;
835 } else {
836 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
837 if (vd->owner != NULL)
838 result = -EBUSY;
839 else {
840 vd->owner = file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 result = 0;
842 }
843 }
844 up_write(&card->controls_rwsem);
845 return result;
846}
847
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100848static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
849 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100851 struct snd_card *card = file->card;
852 struct snd_ctl_elem_id id;
853 struct snd_kcontrol *kctl;
854 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 int result;
856
857 if (copy_from_user(&id, _id, sizeof(id)))
858 return -EFAULT;
859 down_write(&card->controls_rwsem);
860 kctl = snd_ctl_find_id(card, &id);
861 if (kctl == NULL) {
862 result = -ENOENT;
863 } else {
864 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
865 if (vd->owner == NULL)
866 result = -EINVAL;
867 else if (vd->owner != file)
868 result = -EPERM;
869 else {
870 vd->owner = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 result = 0;
872 }
873 }
874 up_write(&card->controls_rwsem);
875 return result;
876}
877
878struct user_element {
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100879 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 void *elem_data; /* element data */
881 unsigned long elem_data_size; /* size of element data in bytes */
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200882 void *tlv_data; /* TLV data */
883 unsigned long tlv_data_size; /* TLV data size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 void *priv_data; /* private data (like strings for enumerated type) */
885 unsigned long priv_data_size; /* size of private data in bytes */
886};
887
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100888static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
889 struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890{
891 struct user_element *ue = kcontrol->private_data;
892
893 *uinfo = ue->info;
894 return 0;
895}
896
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100897static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
898 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899{
900 struct user_element *ue = kcontrol->private_data;
901
902 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
903 return 0;
904}
905
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100906static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
907 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908{
909 int change;
910 struct user_element *ue = kcontrol->private_data;
911
912 change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
913 if (change)
914 memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
915 return change;
916}
917
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200918static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
919 int op_flag,
920 unsigned int size,
921 unsigned int __user *tlv)
922{
923 struct user_element *ue = kcontrol->private_data;
924 int change = 0;
925 void *new_data;
926
927 if (op_flag > 0) {
928 if (size > 1024 * 128) /* sane value */
929 return -EINVAL;
Li Zefanef44a1e2009-04-10 09:43:08 +0800930
931 new_data = memdup_user(tlv, size);
932 if (IS_ERR(new_data))
933 return PTR_ERR(new_data);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200934 change = ue->tlv_data_size != size;
935 if (!change)
936 change = memcmp(ue->tlv_data, new_data, size);
937 kfree(ue->tlv_data);
938 ue->tlv_data = new_data;
939 ue->tlv_data_size = size;
940 } else {
Takashi Iwai18c1c3f2006-08-25 11:39:34 +0200941 if (! ue->tlv_data_size || ! ue->tlv_data)
942 return -ENXIO;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200943 if (size < ue->tlv_data_size)
944 return -ENOSPC;
945 if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
946 return -EFAULT;
947 }
948 return change;
949}
950
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100951static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952{
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200953 struct user_element *ue = kcontrol->private_data;
954 if (ue->tlv_data)
955 kfree(ue->tlv_data);
956 kfree(ue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957}
958
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100959static int snd_ctl_elem_add(struct snd_ctl_file *file,
960 struct snd_ctl_elem_info *info, int replace)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100962 struct snd_card *card = file->card;
963 struct snd_kcontrol kctl, *_kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 unsigned int access;
965 long private_size;
966 struct user_element *ue;
967 int idx, err;
968
969 if (card->user_ctl_count >= MAX_USER_CONTROLS)
970 return -ENOMEM;
Clemens Ladisch2a031ae2009-08-17 12:25:52 +0200971 if (info->count < 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 return -EINVAL;
973 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100974 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200975 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
976 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 info->id.numid = 0;
978 memset(&kctl, 0, sizeof(kctl));
979 down_write(&card->controls_rwsem);
980 _kctl = snd_ctl_find_id(card, &info->id);
981 err = 0;
982 if (_kctl) {
983 if (replace)
984 err = snd_ctl_remove(card, _kctl);
985 else
986 err = -EBUSY;
987 } else {
988 if (replace)
989 err = -ENOENT;
990 }
991 up_write(&card->controls_rwsem);
992 if (err < 0)
993 return err;
994 memcpy(&kctl.id, &info->id, sizeof(info->id));
995 kctl.count = info->owner ? info->owner : 1;
996 access |= SNDRV_CTL_ELEM_ACCESS_USER;
997 kctl.info = snd_ctl_elem_user_info;
998 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
999 kctl.get = snd_ctl_elem_user_get;
1000 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
1001 kctl.put = snd_ctl_elem_user_put;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001002 if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
1003 kctl.tlv.c = snd_ctl_elem_user_tlv;
1004 access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1005 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 switch (info->type) {
1007 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 case SNDRV_CTL_ELEM_TYPE_INTEGER:
1009 private_size = sizeof(long);
1010 if (info->count > 128)
1011 return -EINVAL;
1012 break;
1013 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1014 private_size = sizeof(long long);
1015 if (info->count > 64)
1016 return -EINVAL;
1017 break;
1018 case SNDRV_CTL_ELEM_TYPE_BYTES:
1019 private_size = sizeof(unsigned char);
1020 if (info->count > 512)
1021 return -EINVAL;
1022 break;
1023 case SNDRV_CTL_ELEM_TYPE_IEC958:
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001024 private_size = sizeof(struct snd_aes_iec958);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 if (info->count != 1)
1026 return -EINVAL;
1027 break;
1028 default:
1029 return -EINVAL;
1030 }
1031 private_size *= info->count;
Takashi Iwaica2c0962005-09-09 14:20:23 +02001032 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 if (ue == NULL)
1034 return -ENOMEM;
1035 ue->info = *info;
Takashi Iwai86148e82006-08-24 12:36:36 +02001036 ue->info.access = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 ue->elem_data = (char *)ue + sizeof(*ue);
1038 ue->elem_data_size = private_size;
1039 kctl.private_free = snd_ctl_elem_user_free;
1040 _kctl = snd_ctl_new(&kctl, access);
1041 if (_kctl == NULL) {
Takashi Iwai2fbf1822006-03-06 15:42:51 -08001042 kfree(ue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 return -ENOMEM;
1044 }
1045 _kctl->private_data = ue;
1046 for (idx = 0; idx < _kctl->count; idx++)
1047 _kctl->vd[idx].owner = file;
1048 err = snd_ctl_add(card, _kctl);
Takashi Iwai2fbf1822006-03-06 15:42:51 -08001049 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051
1052 down_write(&card->controls_rwsem);
1053 card->user_ctl_count++;
1054 up_write(&card->controls_rwsem);
1055
1056 return 0;
1057}
1058
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001059static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1060 struct snd_ctl_elem_info __user *_info, int replace)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001062 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 if (copy_from_user(&info, _info, sizeof(info)))
1064 return -EFAULT;
1065 return snd_ctl_elem_add(file, &info, replace);
1066}
1067
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001068static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1069 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001071 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
1073 if (copy_from_user(&id, _id, sizeof(id)))
1074 return -EFAULT;
Clemens Ladischf217ac52009-08-17 12:27:22 +02001075 return snd_ctl_remove_user_ctl(file, &id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076}
1077
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001078static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079{
1080 int subscribe;
1081 if (get_user(subscribe, ptr))
1082 return -EFAULT;
1083 if (subscribe < 0) {
1084 subscribe = file->subscribed;
1085 if (put_user(subscribe, ptr))
1086 return -EFAULT;
1087 return 0;
1088 }
1089 if (subscribe) {
1090 file->subscribed = 1;
1091 return 0;
1092 } else if (file->subscribed) {
1093 snd_ctl_empty_read_queue(file);
1094 file->subscribed = 0;
1095 }
1096 return 0;
1097}
1098
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001099static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1100 struct snd_ctl_tlv __user *_tlv,
1101 int op_flag)
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001102{
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001103 struct snd_card *card = file->card;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001104 struct snd_ctl_tlv tlv;
1105 struct snd_kcontrol *kctl;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001106 struct snd_kcontrol_volatile *vd;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001107 unsigned int len;
1108 int err = 0;
1109
1110 if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1111 return -EFAULT;
Clemens Ladisch61236372010-02-01 13:30:56 +01001112 if (tlv.length < sizeof(unsigned int) * 2)
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001113 return -EINVAL;
1114 down_read(&card->controls_rwsem);
1115 kctl = snd_ctl_find_numid(card, tlv.numid);
1116 if (kctl == NULL) {
1117 err = -ENOENT;
1118 goto __kctl_end;
1119 }
1120 if (kctl->tlv.p == NULL) {
1121 err = -ENXIO;
1122 goto __kctl_end;
1123 }
1124 vd = &kctl->vd[tlv.numid - kctl->id.numid];
1125 if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1126 (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1127 (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1128 err = -ENXIO;
1129 goto __kctl_end;
1130 }
1131 if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
Dan Carpenterbec145a2009-11-18 10:31:57 +02001132 if (vd->owner != NULL && vd->owner != file) {
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001133 err = -EPERM;
1134 goto __kctl_end;
1135 }
1136 err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
1137 if (err > 0) {
1138 up_read(&card->controls_rwsem);
1139 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &kctl->id);
1140 return 0;
1141 }
1142 } else {
1143 if (op_flag) {
1144 err = -ENXIO;
1145 goto __kctl_end;
1146 }
1147 len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1148 if (tlv.length < len) {
1149 err = -ENOMEM;
1150 goto __kctl_end;
1151 }
1152 if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1153 err = -EFAULT;
1154 }
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001155 __kctl_end:
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001156 up_read(&card->controls_rwsem);
1157 return err;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001158}
1159
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1161{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001162 struct snd_ctl_file *ctl;
1163 struct snd_card *card;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001164 struct snd_kctl_ioctl *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 void __user *argp = (void __user *)arg;
1166 int __user *ip = argp;
1167 int err;
1168
1169 ctl = file->private_data;
1170 card = ctl->card;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001171 if (snd_BUG_ON(!card))
1172 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 switch (cmd) {
1174 case SNDRV_CTL_IOCTL_PVERSION:
1175 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1176 case SNDRV_CTL_IOCTL_CARD_INFO:
1177 return snd_ctl_card_info(card, ctl, cmd, argp);
1178 case SNDRV_CTL_IOCTL_ELEM_LIST:
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001179 return snd_ctl_elem_list(card, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 case SNDRV_CTL_IOCTL_ELEM_INFO:
1181 return snd_ctl_elem_info_user(ctl, argp);
1182 case SNDRV_CTL_IOCTL_ELEM_READ:
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001183 return snd_ctl_elem_read_user(card, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1185 return snd_ctl_elem_write_user(ctl, argp);
1186 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1187 return snd_ctl_elem_lock(ctl, argp);
1188 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1189 return snd_ctl_elem_unlock(ctl, argp);
1190 case SNDRV_CTL_IOCTL_ELEM_ADD:
1191 return snd_ctl_elem_add_user(ctl, argp, 0);
1192 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1193 return snd_ctl_elem_add_user(ctl, argp, 1);
1194 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1195 return snd_ctl_elem_remove(ctl, argp);
1196 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1197 return snd_ctl_subscribe_events(ctl, ip);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001198 case SNDRV_CTL_IOCTL_TLV_READ:
1199 return snd_ctl_tlv_ioctl(ctl, argp, 0);
1200 case SNDRV_CTL_IOCTL_TLV_WRITE:
1201 return snd_ctl_tlv_ioctl(ctl, argp, 1);
1202 case SNDRV_CTL_IOCTL_TLV_COMMAND:
1203 return snd_ctl_tlv_ioctl(ctl, argp, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 case SNDRV_CTL_IOCTL_POWER:
Takashi Iwaia381a7a2005-11-17 15:55:49 +01001205 return -ENOPROTOOPT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 case SNDRV_CTL_IOCTL_POWER_STATE:
1207#ifdef CONFIG_PM
1208 return put_user(card->power_state, ip) ? -EFAULT : 0;
1209#else
1210 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1211#endif
1212 }
1213 down_read(&snd_ioctl_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001214 list_for_each_entry(p, &snd_control_ioctls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 err = p->fioctl(card, ctl, cmd, arg);
1216 if (err != -ENOIOCTLCMD) {
1217 up_read(&snd_ioctl_rwsem);
1218 return err;
1219 }
1220 }
1221 up_read(&snd_ioctl_rwsem);
Takashi Iwai6d85be62005-05-15 14:32:50 +02001222 snd_printdd("unknown ioctl = 0x%x\n", cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 return -ENOTTY;
1224}
1225
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001226static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1227 size_t count, loff_t * offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001229 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 int err = 0;
1231 ssize_t result = 0;
1232
1233 ctl = file->private_data;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001234 if (snd_BUG_ON(!ctl || !ctl->card))
1235 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 if (!ctl->subscribed)
1237 return -EBADFD;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001238 if (count < sizeof(struct snd_ctl_event))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 return -EINVAL;
1240 spin_lock_irq(&ctl->read_lock);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001241 while (count >= sizeof(struct snd_ctl_event)) {
1242 struct snd_ctl_event ev;
1243 struct snd_kctl_event *kev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 while (list_empty(&ctl->events)) {
1245 wait_queue_t wait;
1246 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1247 err = -EAGAIN;
1248 goto __end_lock;
1249 }
1250 init_waitqueue_entry(&wait, current);
1251 add_wait_queue(&ctl->change_sleep, &wait);
1252 set_current_state(TASK_INTERRUPTIBLE);
1253 spin_unlock_irq(&ctl->read_lock);
1254 schedule();
1255 remove_wait_queue(&ctl->change_sleep, &wait);
1256 if (signal_pending(current))
Adrian Bunk0e5d7202006-11-07 13:42:54 +01001257 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 spin_lock_irq(&ctl->read_lock);
1259 }
1260 kev = snd_kctl_event(ctl->events.next);
1261 ev.type = SNDRV_CTL_EVENT_ELEM;
1262 ev.data.elem.mask = kev->mask;
1263 ev.data.elem.id = kev->id;
1264 list_del(&kev->list);
1265 spin_unlock_irq(&ctl->read_lock);
1266 kfree(kev);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001267 if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 err = -EFAULT;
1269 goto __end;
1270 }
1271 spin_lock_irq(&ctl->read_lock);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001272 buffer += sizeof(struct snd_ctl_event);
1273 count -= sizeof(struct snd_ctl_event);
1274 result += sizeof(struct snd_ctl_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 }
1276 __end_lock:
1277 spin_unlock_irq(&ctl->read_lock);
1278 __end:
1279 return result > 0 ? result : err;
1280}
1281
1282static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1283{
1284 unsigned int mask;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001285 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
1287 ctl = file->private_data;
1288 if (!ctl->subscribed)
1289 return 0;
1290 poll_wait(file, &ctl->change_sleep, wait);
1291
1292 mask = 0;
1293 if (!list_empty(&ctl->events))
1294 mask |= POLLIN | POLLRDNORM;
1295
1296 return mask;
1297}
1298
1299/*
1300 * register the device-specific control-ioctls.
1301 * called from each device manager like pcm.c, hwdep.c, etc.
1302 */
1303static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1304{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001305 struct snd_kctl_ioctl *pn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001307 pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 if (pn == NULL)
1309 return -ENOMEM;
1310 pn->fioctl = fcn;
1311 down_write(&snd_ioctl_rwsem);
1312 list_add_tail(&pn->list, lists);
1313 up_write(&snd_ioctl_rwsem);
1314 return 0;
1315}
1316
1317int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1318{
1319 return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1320}
1321
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001322EXPORT_SYMBOL(snd_ctl_register_ioctl);
1323
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324#ifdef CONFIG_COMPAT
1325int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1326{
1327 return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1328}
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001329
1330EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331#endif
1332
1333/*
1334 * de-register the device-specific control-ioctls.
1335 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001336static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1337 struct list_head *lists)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001339 struct snd_kctl_ioctl *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001341 if (snd_BUG_ON(!fcn))
1342 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 down_write(&snd_ioctl_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001344 list_for_each_entry(p, lists, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 if (p->fioctl == fcn) {
1346 list_del(&p->list);
1347 up_write(&snd_ioctl_rwsem);
1348 kfree(p);
1349 return 0;
1350 }
1351 }
1352 up_write(&snd_ioctl_rwsem);
1353 snd_BUG();
1354 return -EINVAL;
1355}
1356
1357int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1358{
1359 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1360}
1361
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001362EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1363
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364#ifdef CONFIG_COMPAT
1365int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1366{
1367 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1368}
1369
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001370EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371#endif
1372
1373static int snd_ctl_fasync(int fd, struct file * file, int on)
1374{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001375 struct snd_ctl_file *ctl;
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001376
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 ctl = file->private_data;
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001378 return fasync_helper(fd, file, on, &ctl->fasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379}
1380
1381/*
1382 * ioctl32 compat
1383 */
1384#ifdef CONFIG_COMPAT
1385#include "control_compat.c"
1386#else
1387#define snd_ctl_ioctl_compat NULL
1388#endif
1389
1390/*
1391 * INIT PART
1392 */
1393
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -08001394static const struct file_operations snd_ctl_f_ops =
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395{
1396 .owner = THIS_MODULE,
1397 .read = snd_ctl_read,
1398 .open = snd_ctl_open,
1399 .release = snd_ctl_release,
Takashi Iwai02f48652010-04-13 11:49:04 +02001400 .llseek = no_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 .poll = snd_ctl_poll,
1402 .unlocked_ioctl = snd_ctl_ioctl,
1403 .compat_ioctl = snd_ctl_ioctl_compat,
1404 .fasync = snd_ctl_fasync,
1405};
1406
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407/*
1408 * registration of the control device
1409 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001410static int snd_ctl_dev_register(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001412 struct snd_card *card = device->device_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 int err, cardnum;
1414 char name[16];
1415
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001416 if (snd_BUG_ON(!card))
1417 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 cardnum = card->number;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001419 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1420 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 sprintf(name, "controlC%i", cardnum);
Clemens Ladischf87135f2005-11-20 14:06:59 +01001422 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1423 &snd_ctl_f_ops, card, name)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 return err;
1425 return 0;
1426}
1427
1428/*
1429 * disconnection of the control device
1430 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001431static int snd_ctl_dev_disconnect(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001433 struct snd_card *card = device->device_data;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001434 struct snd_ctl_file *ctl;
Takashi Iwaic4614822006-06-23 14:38:23 +02001435 int err, cardnum;
1436
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001437 if (snd_BUG_ON(!card))
1438 return -ENXIO;
Takashi Iwaic4614822006-06-23 14:38:23 +02001439 cardnum = card->number;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001440 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1441 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
Takashi Iwaid8009882008-09-07 12:51:13 +02001443 read_lock(&card->ctl_files_rwlock);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001444 list_for_each_entry(ctl, &card->ctl_files, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 wake_up(&ctl->change_sleep);
1446 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1447 }
Takashi Iwaid8009882008-09-07 12:51:13 +02001448 read_unlock(&card->ctl_files_rwlock);
Takashi Iwaic4614822006-06-23 14:38:23 +02001449
1450 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1451 card, -1)) < 0)
1452 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 return 0;
1454}
1455
1456/*
1457 * free all controls
1458 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001459static int snd_ctl_dev_free(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001461 struct snd_card *card = device->device_data;
1462 struct snd_kcontrol *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463
1464 down_write(&card->controls_rwsem);
1465 while (!list_empty(&card->controls)) {
1466 control = snd_kcontrol(card->controls.next);
1467 snd_ctl_remove(card, control);
1468 }
1469 up_write(&card->controls_rwsem);
1470 return 0;
1471}
1472
1473/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 * create control core:
1475 * called from init.c
1476 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001477int snd_ctl_create(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001479 static struct snd_device_ops ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 .dev_free = snd_ctl_dev_free,
1481 .dev_register = snd_ctl_dev_register,
1482 .dev_disconnect = snd_ctl_dev_disconnect,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 };
1484
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001485 if (snd_BUG_ON(!card))
1486 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
1488}
Takashi Iwaib9ed4f22007-07-23 15:41:34 +02001489
1490/*
Clemens Ladisch96007322011-01-10 16:25:44 +01001491 * Frequently used control callbacks/helpers
Takashi Iwaib9ed4f22007-07-23 15:41:34 +02001492 */
1493int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
1494 struct snd_ctl_elem_info *uinfo)
1495{
1496 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1497 uinfo->count = 1;
1498 uinfo->value.integer.min = 0;
1499 uinfo->value.integer.max = 1;
1500 return 0;
1501}
1502
1503EXPORT_SYMBOL(snd_ctl_boolean_mono_info);
1504
1505int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
1506 struct snd_ctl_elem_info *uinfo)
1507{
1508 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1509 uinfo->count = 2;
1510 uinfo->value.integer.min = 0;
1511 uinfo->value.integer.max = 1;
1512 return 0;
1513}
1514
1515EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);
Clemens Ladisch96007322011-01-10 16:25:44 +01001516
1517/**
1518 * snd_ctl_enum_info - fills the info structure for an enumerated control
1519 * @info: the structure to be filled
1520 * @channels: the number of the control's channels; often one
1521 * @items: the number of control values; also the size of @names
1522 * @names: an array containing the names of all control values
1523 *
1524 * Sets all required fields in @info to their appropriate values.
1525 * If the control's accessibility is not the default (readable and writable),
1526 * the caller has to fill @info->access.
1527 */
1528int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
1529 unsigned int items, const char *const names[])
1530{
1531 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1532 info->count = channels;
1533 info->value.enumerated.items = items;
1534 if (info->value.enumerated.item >= items)
1535 info->value.enumerated.item = items - 1;
1536 strlcpy(info->value.enumerated.name,
1537 names[info->value.enumerated.item],
1538 sizeof(info->value.enumerated.name));
1539 return 0;
1540}
1541EXPORT_SYMBOL(snd_ctl_enum_info);