blob: 5d98194bcad55b6963037d95d35743909517018a [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
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100282static bool snd_ctl_remove_numid_conflict(struct snd_card *card,
283 unsigned int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
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) {
Clemens Ladisch7c733582011-03-07 13:22:50 +0100288 if (kctl->id.numid < card->last_numid + 1 + count &&
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100289 kctl->id.numid + kctl->count > card->last_numid + 1) {
290 card->last_numid = kctl->id.numid + kctl->count - 1;
291 return true;
292 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 }
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100294 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295}
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{
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100299 unsigned int iter = 100000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100301 while (snd_ctl_remove_numid_conflict(card, count)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 if (--iter == 0) {
303 /* this situation is very unlikely */
304 snd_printk(KERN_ERR "unable to allocate new control numid\n");
305 return -ENOMEM;
306 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 }
308 return 0;
309}
310
311/**
312 * snd_ctl_add - add the control instance to the card
313 * @card: the card instance
314 * @kcontrol: the control instance to add
315 *
316 * Adds the control instance created via snd_ctl_new() or
317 * snd_ctl_new1() to the given card. Assigns also an unique
318 * numid used for fast search.
319 *
320 * Returns zero if successful, or a negative error code on failure.
321 *
322 * It frees automatically the control which cannot be added.
323 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100324int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100326 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 unsigned int idx;
Takashi Iwaic6077b32006-03-21 16:07:13 +0100328 int err = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
Takashi Iwai73e77ba2005-11-17 17:44:01 +0100330 if (! kcontrol)
Takashi Iwaic6077b32006-03-21 16:07:13 +0100331 return err;
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200332 if (snd_BUG_ON(!card || !kcontrol->info))
333 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 id = kcontrol->id;
335 down_write(&card->controls_rwsem);
336 if (snd_ctl_find_id(card, &id)) {
337 up_write(&card->controls_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 snd_printd(KERN_ERR "control %i:%i:%i:%s:%i is already present\n",
339 id.iface,
340 id.device,
341 id.subdevice,
342 id.name,
343 id.index);
Takashi Iwaic6077b32006-03-21 16:07:13 +0100344 err = -EBUSY;
345 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 }
347 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
348 up_write(&card->controls_rwsem);
Takashi Iwaic6077b32006-03-21 16:07:13 +0100349 err = -ENOMEM;
350 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 }
352 list_add_tail(&kcontrol->list, &card->controls);
353 card->controls_count += kcontrol->count;
354 kcontrol->id.numid = card->last_numid + 1;
355 card->last_numid += kcontrol->count;
356 up_write(&card->controls_rwsem);
357 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
358 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
359 return 0;
Takashi Iwaic6077b32006-03-21 16:07:13 +0100360
361 error:
362 snd_ctl_free_one(kcontrol);
363 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364}
365
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200366EXPORT_SYMBOL(snd_ctl_add);
367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368/**
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000369 * snd_ctl_replace - replace the control instance of the card
370 * @card: the card instance
371 * @kcontrol: the control instance to replace
372 * @add_on_replace: add the control if not already added
373 *
374 * Replaces the given control. If the given control does not exist
375 * and the add_on_replace flag is set, the control is added. If the
376 * control exists, it is destroyed first.
377 *
378 * Returns zero if successful, or a negative error code on failure.
379 *
380 * It frees automatically the control which cannot be added or replaced.
381 */
382int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol,
383 bool add_on_replace)
384{
385 struct snd_ctl_elem_id id;
386 unsigned int idx;
387 struct snd_kcontrol *old;
388 int ret;
389
390 if (!kcontrol)
391 return -EINVAL;
392 if (snd_BUG_ON(!card || !kcontrol->info)) {
393 ret = -EINVAL;
394 goto error;
395 }
396 id = kcontrol->id;
397 down_write(&card->controls_rwsem);
398 old = snd_ctl_find_id(card, &id);
399 if (!old) {
400 if (add_on_replace)
401 goto add;
402 up_write(&card->controls_rwsem);
403 ret = -EINVAL;
404 goto error;
405 }
406 ret = snd_ctl_remove(card, old);
407 if (ret < 0) {
408 up_write(&card->controls_rwsem);
409 goto error;
410 }
411add:
412 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
413 up_write(&card->controls_rwsem);
414 ret = -ENOMEM;
415 goto error;
416 }
417 list_add_tail(&kcontrol->list, &card->controls);
418 card->controls_count += kcontrol->count;
419 kcontrol->id.numid = card->last_numid + 1;
420 card->last_numid += kcontrol->count;
421 up_write(&card->controls_rwsem);
422 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
423 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
424 return 0;
425
426error:
427 snd_ctl_free_one(kcontrol);
428 return ret;
429}
430EXPORT_SYMBOL(snd_ctl_replace);
431
432/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 * snd_ctl_remove - remove the control from the card and release it
434 * @card: the card instance
435 * @kcontrol: the control instance to remove
436 *
437 * Removes the control from the card and then releases the instance.
438 * You don't need to call snd_ctl_free_one(). You must be in
439 * the write lock - down_write(&card->controls_rwsem).
440 *
441 * Returns 0 if successful, or a negative error code on failure.
442 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100443int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100445 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 unsigned int idx;
447
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200448 if (snd_BUG_ON(!card || !kcontrol))
449 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 list_del(&kcontrol->list);
451 card->controls_count -= kcontrol->count;
452 id = kcontrol->id;
453 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
454 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
455 snd_ctl_free_one(kcontrol);
456 return 0;
457}
458
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200459EXPORT_SYMBOL(snd_ctl_remove);
460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461/**
462 * snd_ctl_remove_id - remove the control of the given id and release it
463 * @card: the card instance
464 * @id: the control id to remove
465 *
466 * Finds the control instance with the given id, removes it from the
467 * card list and releases it.
468 *
469 * Returns 0 if successful, or a negative error code on failure.
470 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100471int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100473 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 int ret;
475
476 down_write(&card->controls_rwsem);
477 kctl = snd_ctl_find_id(card, id);
478 if (kctl == NULL) {
479 up_write(&card->controls_rwsem);
480 return -ENOENT;
481 }
482 ret = snd_ctl_remove(card, kctl);
483 up_write(&card->controls_rwsem);
484 return ret;
485}
486
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200487EXPORT_SYMBOL(snd_ctl_remove_id);
488
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489/**
Clemens Ladischf217ac52009-08-17 12:27:22 +0200490 * snd_ctl_remove_user_ctl - remove and release the unlocked user control
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 * @file: active control handle
492 * @id: the control id to remove
493 *
494 * Finds the control instance with the given id, removes it from the
495 * card list and releases it.
496 *
497 * Returns 0 if successful, or a negative error code on failure.
498 */
Clemens Ladischf217ac52009-08-17 12:27:22 +0200499static int snd_ctl_remove_user_ctl(struct snd_ctl_file * file,
500 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100502 struct snd_card *card = file->card;
503 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 int idx, ret;
505
506 down_write(&card->controls_rwsem);
507 kctl = snd_ctl_find_id(card, id);
508 if (kctl == NULL) {
Clemens Ladisch317b8082009-08-17 12:26:34 +0200509 ret = -ENOENT;
510 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 }
Clemens Ladisch18dd0aa2009-08-17 12:28:09 +0200512 if (!(kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_USER)) {
513 ret = -EINVAL;
514 goto error;
515 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 for (idx = 0; idx < kctl->count; idx++)
517 if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
Clemens Ladisch317b8082009-08-17 12:26:34 +0200518 ret = -EBUSY;
519 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 }
521 ret = snd_ctl_remove(card, kctl);
Clemens Ladischf217ac52009-08-17 12:27:22 +0200522 if (ret < 0)
523 goto error;
524 card->user_ctl_count--;
Clemens Ladisch317b8082009-08-17 12:26:34 +0200525error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 up_write(&card->controls_rwsem);
527 return ret;
528}
529
530/**
Takashi Iwai3cbdd752008-08-29 16:09:01 +0200531 * snd_ctl_activate_id - activate/inactivate the control of the given id
532 * @card: the card instance
533 * @id: the control id to activate/inactivate
534 * @active: non-zero to activate
535 *
536 * Finds the control instance with the given id, and activate or
537 * inactivate the control together with notification, if changed.
538 *
539 * Returns 0 if unchanged, 1 if changed, or a negative error code on failure.
540 */
541int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
542 int active)
543{
544 struct snd_kcontrol *kctl;
545 struct snd_kcontrol_volatile *vd;
546 unsigned int index_offset;
547 int ret;
548
549 down_write(&card->controls_rwsem);
550 kctl = snd_ctl_find_id(card, id);
551 if (kctl == NULL) {
552 ret = -ENOENT;
553 goto unlock;
554 }
555 index_offset = snd_ctl_get_ioff(kctl, &kctl->id);
556 vd = &kctl->vd[index_offset];
557 ret = 0;
558 if (active) {
559 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE))
560 goto unlock;
561 vd->access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
562 } else {
563 if (vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE)
564 goto unlock;
565 vd->access |= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
566 }
567 ret = 1;
568 unlock:
569 up_write(&card->controls_rwsem);
570 if (ret > 0)
571 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_INFO, id);
572 return ret;
573}
574EXPORT_SYMBOL_GPL(snd_ctl_activate_id);
575
576/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 * snd_ctl_rename_id - replace the id of a control on the card
578 * @card: the card instance
579 * @src_id: the old id
580 * @dst_id: the new id
581 *
582 * Finds the control with the old id from the card, and replaces the
583 * id with the new one.
584 *
585 * Returns zero if successful, or a negative error code on failure.
586 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100587int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
588 struct snd_ctl_elem_id *dst_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100590 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
592 down_write(&card->controls_rwsem);
593 kctl = snd_ctl_find_id(card, src_id);
594 if (kctl == NULL) {
595 up_write(&card->controls_rwsem);
596 return -ENOENT;
597 }
598 kctl->id = *dst_id;
599 kctl->id.numid = card->last_numid + 1;
600 card->last_numid += kctl->count;
601 up_write(&card->controls_rwsem);
602 return 0;
603}
604
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200605EXPORT_SYMBOL(snd_ctl_rename_id);
606
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607/**
608 * snd_ctl_find_numid - find the control instance with the given number-id
609 * @card: the card instance
610 * @numid: the number-id to search
611 *
612 * Finds the control instance with the given number-id from the card.
613 *
614 * Returns the pointer of the instance if found, or NULL if not.
615 *
616 * The caller must down card->controls_rwsem before calling this function
617 * (if the race condition can happen).
618 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100619struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100621 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200623 if (snd_BUG_ON(!card || !numid))
624 return NULL;
Johannes Berg9244b2c2006-10-05 16:02:22 +0200625 list_for_each_entry(kctl, &card->controls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
627 return kctl;
628 }
629 return NULL;
630}
631
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200632EXPORT_SYMBOL(snd_ctl_find_numid);
633
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634/**
635 * snd_ctl_find_id - find the control instance with the given id
636 * @card: the card instance
637 * @id: the id to search
638 *
639 * Finds the control instance with the given id from the card.
640 *
641 * Returns the pointer of the instance if found, or NULL if not.
642 *
643 * The caller must down card->controls_rwsem before calling this function
644 * (if the race condition can happen).
645 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100646struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
647 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100649 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200651 if (snd_BUG_ON(!card || !id))
652 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 if (id->numid != 0)
654 return snd_ctl_find_numid(card, id->numid);
Johannes Berg9244b2c2006-10-05 16:02:22 +0200655 list_for_each_entry(kctl, &card->controls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 if (kctl->id.iface != id->iface)
657 continue;
658 if (kctl->id.device != id->device)
659 continue;
660 if (kctl->id.subdevice != id->subdevice)
661 continue;
662 if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
663 continue;
664 if (kctl->id.index > id->index)
665 continue;
666 if (kctl->id.index + kctl->count <= id->index)
667 continue;
668 return kctl;
669 }
670 return NULL;
671}
672
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200673EXPORT_SYMBOL(snd_ctl_find_id);
674
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100675static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 unsigned int cmd, void __user *arg)
677{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100678 struct snd_ctl_card_info *info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
Takashi Iwaica2c0962005-09-09 14:20:23 +0200680 info = kzalloc(sizeof(*info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 if (! info)
682 return -ENOMEM;
683 down_read(&snd_ioctl_rwsem);
684 info->card = card->number;
685 strlcpy(info->id, card->id, sizeof(info->id));
686 strlcpy(info->driver, card->driver, sizeof(info->driver));
687 strlcpy(info->name, card->shortname, sizeof(info->name));
688 strlcpy(info->longname, card->longname, sizeof(info->longname));
689 strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
690 strlcpy(info->components, card->components, sizeof(info->components));
691 up_read(&snd_ioctl_rwsem);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100692 if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 kfree(info);
694 return -EFAULT;
695 }
696 kfree(info);
697 return 0;
698}
699
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100700static int snd_ctl_elem_list(struct snd_card *card,
701 struct snd_ctl_elem_list __user *_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702{
703 struct list_head *plist;
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100704 struct snd_ctl_elem_list list;
705 struct snd_kcontrol *kctl;
706 struct snd_ctl_elem_id *dst, *id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 unsigned int offset, space, first, jidx;
708
709 if (copy_from_user(&list, _list, sizeof(list)))
710 return -EFAULT;
711 offset = list.offset;
712 space = list.space;
713 first = 0;
714 /* try limit maximum space */
715 if (space > 16384)
716 return -ENOMEM;
717 if (space > 0) {
718 /* allocate temporary buffer for atomic operation */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100719 dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 if (dst == NULL)
721 return -ENOMEM;
722 down_read(&card->controls_rwsem);
723 list.count = card->controls_count;
724 plist = card->controls.next;
725 while (plist != &card->controls) {
726 if (offset == 0)
727 break;
728 kctl = snd_kcontrol(plist);
729 if (offset < kctl->count)
730 break;
731 offset -= kctl->count;
732 plist = plist->next;
733 }
734 list.used = 0;
735 id = dst;
736 while (space > 0 && plist != &card->controls) {
737 kctl = snd_kcontrol(plist);
738 for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
739 snd_ctl_build_ioff(id, kctl, jidx);
740 id++;
741 space--;
742 list.used++;
743 }
744 plist = plist->next;
745 offset = 0;
746 }
747 up_read(&card->controls_rwsem);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100748 if (list.used > 0 &&
749 copy_to_user(list.pids, dst,
750 list.used * sizeof(struct snd_ctl_elem_id))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 vfree(dst);
752 return -EFAULT;
753 }
754 vfree(dst);
755 } else {
756 down_read(&card->controls_rwsem);
757 list.count = card->controls_count;
758 up_read(&card->controls_rwsem);
759 }
760 if (copy_to_user(_list, &list, sizeof(list)))
761 return -EFAULT;
762 return 0;
763}
764
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100765static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
766 struct snd_ctl_elem_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100768 struct snd_card *card = ctl->card;
769 struct snd_kcontrol *kctl;
770 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 unsigned int index_offset;
772 int result;
773
774 down_read(&card->controls_rwsem);
775 kctl = snd_ctl_find_id(card, &info->id);
776 if (kctl == NULL) {
777 up_read(&card->controls_rwsem);
778 return -ENOENT;
779 }
780#ifdef CONFIG_SND_DEBUG
781 info->access = 0;
782#endif
783 result = kctl->info(kctl, info);
784 if (result >= 0) {
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200785 snd_BUG_ON(info->access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 index_offset = snd_ctl_get_ioff(kctl, &info->id);
787 vd = &kctl->vd[index_offset];
788 snd_ctl_build_ioff(&info->id, kctl, index_offset);
789 info->access = vd->access;
790 if (vd->owner) {
791 info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
792 if (vd->owner == ctl)
793 info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
Clemens Ladisch25d27ed2009-11-02 09:35:44 +0100794 info->owner = pid_vnr(vd->owner->pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 } else {
796 info->owner = -1;
797 }
798 }
799 up_read(&card->controls_rwsem);
800 return result;
801}
802
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100803static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
804 struct snd_ctl_elem_info __user *_info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100806 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 int result;
808
809 if (copy_from_user(&info, _info, sizeof(info)))
810 return -EFAULT;
Giuliano Pochini64649402006-03-13 14:11:11 +0100811 snd_power_lock(ctl->card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200812 result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100813 if (result >= 0)
814 result = snd_ctl_elem_info(ctl, &info);
815 snd_power_unlock(ctl->card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 if (result >= 0)
817 if (copy_to_user(_info, &info, sizeof(info)))
818 return -EFAULT;
819 return result;
820}
821
Takashi Iwaid3bd67c2008-06-12 18:17:26 +0200822static int snd_ctl_elem_read(struct snd_card *card,
823 struct snd_ctl_elem_value *control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100825 struct snd_kcontrol *kctl;
826 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 unsigned int index_offset;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100828 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
830 down_read(&card->controls_rwsem);
831 kctl = snd_ctl_find_id(card, &control->id);
832 if (kctl == NULL) {
833 result = -ENOENT;
834 } else {
835 index_offset = snd_ctl_get_ioff(kctl, &control->id);
836 vd = &kctl->vd[index_offset];
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100837 if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) &&
838 kctl->get != NULL) {
839 snd_ctl_build_ioff(&control->id, kctl, index_offset);
840 result = kctl->get(kctl, control);
841 } else
842 result = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 }
844 up_read(&card->controls_rwsem);
845 return result;
846}
847
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100848static int snd_ctl_elem_read_user(struct snd_card *card,
849 struct snd_ctl_elem_value __user *_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100851 struct snd_ctl_elem_value *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 int result;
Li Zefanef44a1e2009-04-10 09:43:08 +0800853
854 control = memdup_user(_control, sizeof(*control));
855 if (IS_ERR(control))
856 return PTR_ERR(control);
857
Giuliano Pochini64649402006-03-13 14:11:11 +0100858 snd_power_lock(card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200859 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100860 if (result >= 0)
861 result = snd_ctl_elem_read(card, control);
862 snd_power_unlock(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 if (result >= 0)
864 if (copy_to_user(_control, control, sizeof(*control)))
865 result = -EFAULT;
866 kfree(control);
867 return result;
868}
869
Takashi Iwaid3bd67c2008-06-12 18:17:26 +0200870static int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
871 struct snd_ctl_elem_value *control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100873 struct snd_kcontrol *kctl;
874 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 unsigned int index_offset;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100876 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
878 down_read(&card->controls_rwsem);
879 kctl = snd_ctl_find_id(card, &control->id);
880 if (kctl == NULL) {
881 result = -ENOENT;
882 } else {
883 index_offset = snd_ctl_get_ioff(kctl, &control->id);
884 vd = &kctl->vd[index_offset];
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100885 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
886 kctl->put == NULL ||
887 (file && vd->owner && vd->owner != file)) {
888 result = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 } else {
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100890 snd_ctl_build_ioff(&control->id, kctl, index_offset);
891 result = kctl->put(kctl, control);
892 }
893 if (result > 0) {
894 up_read(&card->controls_rwsem);
895 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
896 &control->id);
897 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 }
899 }
900 up_read(&card->controls_rwsem);
901 return result;
902}
903
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100904static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
905 struct snd_ctl_elem_value __user *_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100907 struct snd_ctl_elem_value *control;
Giuliano Pochini64649402006-03-13 14:11:11 +0100908 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 int result;
910
Li Zefanef44a1e2009-04-10 09:43:08 +0800911 control = memdup_user(_control, sizeof(*control));
912 if (IS_ERR(control))
913 return PTR_ERR(control);
914
Giuliano Pochini64649402006-03-13 14:11:11 +0100915 card = file->card;
916 snd_power_lock(card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200917 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100918 if (result >= 0)
919 result = snd_ctl_elem_write(card, file, control);
920 snd_power_unlock(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 if (result >= 0)
922 if (copy_to_user(_control, control, sizeof(*control)))
923 result = -EFAULT;
924 kfree(control);
925 return result;
926}
927
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100928static int snd_ctl_elem_lock(struct snd_ctl_file *file,
929 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100931 struct snd_card *card = file->card;
932 struct snd_ctl_elem_id id;
933 struct snd_kcontrol *kctl;
934 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 int result;
936
937 if (copy_from_user(&id, _id, sizeof(id)))
938 return -EFAULT;
939 down_write(&card->controls_rwsem);
940 kctl = snd_ctl_find_id(card, &id);
941 if (kctl == NULL) {
942 result = -ENOENT;
943 } else {
944 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
945 if (vd->owner != NULL)
946 result = -EBUSY;
947 else {
948 vd->owner = file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 result = 0;
950 }
951 }
952 up_write(&card->controls_rwsem);
953 return result;
954}
955
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100956static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
957 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100959 struct snd_card *card = file->card;
960 struct snd_ctl_elem_id id;
961 struct snd_kcontrol *kctl;
962 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 int result;
964
965 if (copy_from_user(&id, _id, sizeof(id)))
966 return -EFAULT;
967 down_write(&card->controls_rwsem);
968 kctl = snd_ctl_find_id(card, &id);
969 if (kctl == NULL) {
970 result = -ENOENT;
971 } else {
972 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
973 if (vd->owner == NULL)
974 result = -EINVAL;
975 else if (vd->owner != file)
976 result = -EPERM;
977 else {
978 vd->owner = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 result = 0;
980 }
981 }
982 up_write(&card->controls_rwsem);
983 return result;
984}
985
986struct user_element {
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100987 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 void *elem_data; /* element data */
989 unsigned long elem_data_size; /* size of element data in bytes */
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200990 void *tlv_data; /* TLV data */
991 unsigned long tlv_data_size; /* TLV data size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 void *priv_data; /* private data (like strings for enumerated type) */
993 unsigned long priv_data_size; /* size of private data in bytes */
994};
995
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100996static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
997 struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998{
999 struct user_element *ue = kcontrol->private_data;
1000
1001 *uinfo = ue->info;
1002 return 0;
1003}
1004
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001005static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
1006 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007{
1008 struct user_element *ue = kcontrol->private_data;
1009
1010 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
1011 return 0;
1012}
1013
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001014static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
1015 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016{
1017 int change;
1018 struct user_element *ue = kcontrol->private_data;
1019
1020 change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
1021 if (change)
1022 memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
1023 return change;
1024}
1025
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001026static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
1027 int op_flag,
1028 unsigned int size,
1029 unsigned int __user *tlv)
1030{
1031 struct user_element *ue = kcontrol->private_data;
1032 int change = 0;
1033 void *new_data;
1034
1035 if (op_flag > 0) {
1036 if (size > 1024 * 128) /* sane value */
1037 return -EINVAL;
Li Zefanef44a1e2009-04-10 09:43:08 +08001038
1039 new_data = memdup_user(tlv, size);
1040 if (IS_ERR(new_data))
1041 return PTR_ERR(new_data);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001042 change = ue->tlv_data_size != size;
1043 if (!change)
1044 change = memcmp(ue->tlv_data, new_data, size);
1045 kfree(ue->tlv_data);
1046 ue->tlv_data = new_data;
1047 ue->tlv_data_size = size;
1048 } else {
Takashi Iwai18c1c3f2006-08-25 11:39:34 +02001049 if (! ue->tlv_data_size || ! ue->tlv_data)
1050 return -ENXIO;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001051 if (size < ue->tlv_data_size)
1052 return -ENOSPC;
1053 if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
1054 return -EFAULT;
1055 }
1056 return change;
1057}
1058
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001059static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060{
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001061 struct user_element *ue = kcontrol->private_data;
1062 if (ue->tlv_data)
1063 kfree(ue->tlv_data);
1064 kfree(ue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065}
1066
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001067static int snd_ctl_elem_add(struct snd_ctl_file *file,
1068 struct snd_ctl_elem_info *info, int replace)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001070 struct snd_card *card = file->card;
1071 struct snd_kcontrol kctl, *_kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 unsigned int access;
1073 long private_size;
1074 struct user_element *ue;
1075 int idx, err;
1076
1077 if (card->user_ctl_count >= MAX_USER_CONTROLS)
1078 return -ENOMEM;
Clemens Ladisch2a031ae2009-08-17 12:25:52 +02001079 if (info->count < 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 return -EINVAL;
1081 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001082 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001083 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
1084 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 info->id.numid = 0;
1086 memset(&kctl, 0, sizeof(kctl));
1087 down_write(&card->controls_rwsem);
1088 _kctl = snd_ctl_find_id(card, &info->id);
1089 err = 0;
1090 if (_kctl) {
1091 if (replace)
1092 err = snd_ctl_remove(card, _kctl);
1093 else
1094 err = -EBUSY;
1095 } else {
1096 if (replace)
1097 err = -ENOENT;
1098 }
1099 up_write(&card->controls_rwsem);
1100 if (err < 0)
1101 return err;
1102 memcpy(&kctl.id, &info->id, sizeof(info->id));
1103 kctl.count = info->owner ? info->owner : 1;
1104 access |= SNDRV_CTL_ELEM_ACCESS_USER;
1105 kctl.info = snd_ctl_elem_user_info;
1106 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
1107 kctl.get = snd_ctl_elem_user_get;
1108 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
1109 kctl.put = snd_ctl_elem_user_put;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001110 if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
1111 kctl.tlv.c = snd_ctl_elem_user_tlv;
1112 access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1113 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 switch (info->type) {
1115 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 case SNDRV_CTL_ELEM_TYPE_INTEGER:
1117 private_size = sizeof(long);
1118 if (info->count > 128)
1119 return -EINVAL;
1120 break;
1121 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1122 private_size = sizeof(long long);
1123 if (info->count > 64)
1124 return -EINVAL;
1125 break;
1126 case SNDRV_CTL_ELEM_TYPE_BYTES:
1127 private_size = sizeof(unsigned char);
1128 if (info->count > 512)
1129 return -EINVAL;
1130 break;
1131 case SNDRV_CTL_ELEM_TYPE_IEC958:
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001132 private_size = sizeof(struct snd_aes_iec958);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 if (info->count != 1)
1134 return -EINVAL;
1135 break;
1136 default:
1137 return -EINVAL;
1138 }
1139 private_size *= info->count;
Takashi Iwaica2c0962005-09-09 14:20:23 +02001140 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 if (ue == NULL)
1142 return -ENOMEM;
1143 ue->info = *info;
Takashi Iwai86148e82006-08-24 12:36:36 +02001144 ue->info.access = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 ue->elem_data = (char *)ue + sizeof(*ue);
1146 ue->elem_data_size = private_size;
1147 kctl.private_free = snd_ctl_elem_user_free;
1148 _kctl = snd_ctl_new(&kctl, access);
1149 if (_kctl == NULL) {
Takashi Iwai2fbf1822006-03-06 15:42:51 -08001150 kfree(ue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 return -ENOMEM;
1152 }
1153 _kctl->private_data = ue;
1154 for (idx = 0; idx < _kctl->count; idx++)
1155 _kctl->vd[idx].owner = file;
1156 err = snd_ctl_add(card, _kctl);
Takashi Iwai2fbf1822006-03-06 15:42:51 -08001157 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159
1160 down_write(&card->controls_rwsem);
1161 card->user_ctl_count++;
1162 up_write(&card->controls_rwsem);
1163
1164 return 0;
1165}
1166
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001167static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1168 struct snd_ctl_elem_info __user *_info, int replace)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001170 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 if (copy_from_user(&info, _info, sizeof(info)))
1172 return -EFAULT;
1173 return snd_ctl_elem_add(file, &info, replace);
1174}
1175
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001176static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1177 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001179 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180
1181 if (copy_from_user(&id, _id, sizeof(id)))
1182 return -EFAULT;
Clemens Ladischf217ac52009-08-17 12:27:22 +02001183 return snd_ctl_remove_user_ctl(file, &id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184}
1185
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001186static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187{
1188 int subscribe;
1189 if (get_user(subscribe, ptr))
1190 return -EFAULT;
1191 if (subscribe < 0) {
1192 subscribe = file->subscribed;
1193 if (put_user(subscribe, ptr))
1194 return -EFAULT;
1195 return 0;
1196 }
1197 if (subscribe) {
1198 file->subscribed = 1;
1199 return 0;
1200 } else if (file->subscribed) {
1201 snd_ctl_empty_read_queue(file);
1202 file->subscribed = 0;
1203 }
1204 return 0;
1205}
1206
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001207static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1208 struct snd_ctl_tlv __user *_tlv,
1209 int op_flag)
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001210{
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001211 struct snd_card *card = file->card;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001212 struct snd_ctl_tlv tlv;
1213 struct snd_kcontrol *kctl;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001214 struct snd_kcontrol_volatile *vd;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001215 unsigned int len;
1216 int err = 0;
1217
1218 if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1219 return -EFAULT;
Clemens Ladisch61236372010-02-01 13:30:56 +01001220 if (tlv.length < sizeof(unsigned int) * 2)
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001221 return -EINVAL;
1222 down_read(&card->controls_rwsem);
1223 kctl = snd_ctl_find_numid(card, tlv.numid);
1224 if (kctl == NULL) {
1225 err = -ENOENT;
1226 goto __kctl_end;
1227 }
1228 if (kctl->tlv.p == NULL) {
1229 err = -ENXIO;
1230 goto __kctl_end;
1231 }
1232 vd = &kctl->vd[tlv.numid - kctl->id.numid];
1233 if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1234 (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1235 (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1236 err = -ENXIO;
1237 goto __kctl_end;
1238 }
1239 if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
Dan Carpenterbec145a2009-11-18 10:31:57 +02001240 if (vd->owner != NULL && vd->owner != file) {
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001241 err = -EPERM;
1242 goto __kctl_end;
1243 }
1244 err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
1245 if (err > 0) {
1246 up_read(&card->controls_rwsem);
1247 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &kctl->id);
1248 return 0;
1249 }
1250 } else {
1251 if (op_flag) {
1252 err = -ENXIO;
1253 goto __kctl_end;
1254 }
1255 len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1256 if (tlv.length < len) {
1257 err = -ENOMEM;
1258 goto __kctl_end;
1259 }
1260 if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1261 err = -EFAULT;
1262 }
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001263 __kctl_end:
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001264 up_read(&card->controls_rwsem);
1265 return err;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001266}
1267
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1269{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001270 struct snd_ctl_file *ctl;
1271 struct snd_card *card;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001272 struct snd_kctl_ioctl *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 void __user *argp = (void __user *)arg;
1274 int __user *ip = argp;
1275 int err;
1276
1277 ctl = file->private_data;
1278 card = ctl->card;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001279 if (snd_BUG_ON(!card))
1280 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 switch (cmd) {
1282 case SNDRV_CTL_IOCTL_PVERSION:
1283 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1284 case SNDRV_CTL_IOCTL_CARD_INFO:
1285 return snd_ctl_card_info(card, ctl, cmd, argp);
1286 case SNDRV_CTL_IOCTL_ELEM_LIST:
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001287 return snd_ctl_elem_list(card, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 case SNDRV_CTL_IOCTL_ELEM_INFO:
1289 return snd_ctl_elem_info_user(ctl, argp);
1290 case SNDRV_CTL_IOCTL_ELEM_READ:
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001291 return snd_ctl_elem_read_user(card, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1293 return snd_ctl_elem_write_user(ctl, argp);
1294 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1295 return snd_ctl_elem_lock(ctl, argp);
1296 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1297 return snd_ctl_elem_unlock(ctl, argp);
1298 case SNDRV_CTL_IOCTL_ELEM_ADD:
1299 return snd_ctl_elem_add_user(ctl, argp, 0);
1300 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1301 return snd_ctl_elem_add_user(ctl, argp, 1);
1302 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1303 return snd_ctl_elem_remove(ctl, argp);
1304 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1305 return snd_ctl_subscribe_events(ctl, ip);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001306 case SNDRV_CTL_IOCTL_TLV_READ:
1307 return snd_ctl_tlv_ioctl(ctl, argp, 0);
1308 case SNDRV_CTL_IOCTL_TLV_WRITE:
1309 return snd_ctl_tlv_ioctl(ctl, argp, 1);
1310 case SNDRV_CTL_IOCTL_TLV_COMMAND:
1311 return snd_ctl_tlv_ioctl(ctl, argp, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 case SNDRV_CTL_IOCTL_POWER:
Takashi Iwaia381a7a2005-11-17 15:55:49 +01001313 return -ENOPROTOOPT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 case SNDRV_CTL_IOCTL_POWER_STATE:
1315#ifdef CONFIG_PM
1316 return put_user(card->power_state, ip) ? -EFAULT : 0;
1317#else
1318 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1319#endif
1320 }
1321 down_read(&snd_ioctl_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001322 list_for_each_entry(p, &snd_control_ioctls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 err = p->fioctl(card, ctl, cmd, arg);
1324 if (err != -ENOIOCTLCMD) {
1325 up_read(&snd_ioctl_rwsem);
1326 return err;
1327 }
1328 }
1329 up_read(&snd_ioctl_rwsem);
Takashi Iwai6d85be62005-05-15 14:32:50 +02001330 snd_printdd("unknown ioctl = 0x%x\n", cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 return -ENOTTY;
1332}
1333
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001334static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1335 size_t count, loff_t * offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001337 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 int err = 0;
1339 ssize_t result = 0;
1340
1341 ctl = file->private_data;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001342 if (snd_BUG_ON(!ctl || !ctl->card))
1343 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 if (!ctl->subscribed)
1345 return -EBADFD;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001346 if (count < sizeof(struct snd_ctl_event))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 return -EINVAL;
1348 spin_lock_irq(&ctl->read_lock);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001349 while (count >= sizeof(struct snd_ctl_event)) {
1350 struct snd_ctl_event ev;
1351 struct snd_kctl_event *kev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 while (list_empty(&ctl->events)) {
1353 wait_queue_t wait;
1354 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1355 err = -EAGAIN;
1356 goto __end_lock;
1357 }
1358 init_waitqueue_entry(&wait, current);
1359 add_wait_queue(&ctl->change_sleep, &wait);
1360 set_current_state(TASK_INTERRUPTIBLE);
1361 spin_unlock_irq(&ctl->read_lock);
1362 schedule();
1363 remove_wait_queue(&ctl->change_sleep, &wait);
1364 if (signal_pending(current))
Adrian Bunk0e5d7202006-11-07 13:42:54 +01001365 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 spin_lock_irq(&ctl->read_lock);
1367 }
1368 kev = snd_kctl_event(ctl->events.next);
1369 ev.type = SNDRV_CTL_EVENT_ELEM;
1370 ev.data.elem.mask = kev->mask;
1371 ev.data.elem.id = kev->id;
1372 list_del(&kev->list);
1373 spin_unlock_irq(&ctl->read_lock);
1374 kfree(kev);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001375 if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 err = -EFAULT;
1377 goto __end;
1378 }
1379 spin_lock_irq(&ctl->read_lock);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001380 buffer += sizeof(struct snd_ctl_event);
1381 count -= sizeof(struct snd_ctl_event);
1382 result += sizeof(struct snd_ctl_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 }
1384 __end_lock:
1385 spin_unlock_irq(&ctl->read_lock);
1386 __end:
1387 return result > 0 ? result : err;
1388}
1389
1390static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1391{
1392 unsigned int mask;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001393 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394
1395 ctl = file->private_data;
1396 if (!ctl->subscribed)
1397 return 0;
1398 poll_wait(file, &ctl->change_sleep, wait);
1399
1400 mask = 0;
1401 if (!list_empty(&ctl->events))
1402 mask |= POLLIN | POLLRDNORM;
1403
1404 return mask;
1405}
1406
1407/*
1408 * register the device-specific control-ioctls.
1409 * called from each device manager like pcm.c, hwdep.c, etc.
1410 */
1411static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1412{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001413 struct snd_kctl_ioctl *pn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001415 pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 if (pn == NULL)
1417 return -ENOMEM;
1418 pn->fioctl = fcn;
1419 down_write(&snd_ioctl_rwsem);
1420 list_add_tail(&pn->list, lists);
1421 up_write(&snd_ioctl_rwsem);
1422 return 0;
1423}
1424
1425int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1426{
1427 return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1428}
1429
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001430EXPORT_SYMBOL(snd_ctl_register_ioctl);
1431
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432#ifdef CONFIG_COMPAT
1433int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1434{
1435 return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1436}
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001437
1438EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439#endif
1440
1441/*
1442 * de-register the device-specific control-ioctls.
1443 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001444static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1445 struct list_head *lists)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001447 struct snd_kctl_ioctl *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001449 if (snd_BUG_ON(!fcn))
1450 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 down_write(&snd_ioctl_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001452 list_for_each_entry(p, lists, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 if (p->fioctl == fcn) {
1454 list_del(&p->list);
1455 up_write(&snd_ioctl_rwsem);
1456 kfree(p);
1457 return 0;
1458 }
1459 }
1460 up_write(&snd_ioctl_rwsem);
1461 snd_BUG();
1462 return -EINVAL;
1463}
1464
1465int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1466{
1467 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1468}
1469
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001470EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1471
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472#ifdef CONFIG_COMPAT
1473int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1474{
1475 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1476}
1477
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001478EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479#endif
1480
1481static int snd_ctl_fasync(int fd, struct file * file, int on)
1482{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001483 struct snd_ctl_file *ctl;
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001484
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 ctl = file->private_data;
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001486 return fasync_helper(fd, file, on, &ctl->fasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487}
1488
1489/*
1490 * ioctl32 compat
1491 */
1492#ifdef CONFIG_COMPAT
1493#include "control_compat.c"
1494#else
1495#define snd_ctl_ioctl_compat NULL
1496#endif
1497
1498/*
1499 * INIT PART
1500 */
1501
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -08001502static const struct file_operations snd_ctl_f_ops =
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503{
1504 .owner = THIS_MODULE,
1505 .read = snd_ctl_read,
1506 .open = snd_ctl_open,
1507 .release = snd_ctl_release,
Takashi Iwai02f48652010-04-13 11:49:04 +02001508 .llseek = no_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 .poll = snd_ctl_poll,
1510 .unlocked_ioctl = snd_ctl_ioctl,
1511 .compat_ioctl = snd_ctl_ioctl_compat,
1512 .fasync = snd_ctl_fasync,
1513};
1514
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515/*
1516 * registration of the control device
1517 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001518static int snd_ctl_dev_register(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001520 struct snd_card *card = device->device_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 int err, cardnum;
1522 char name[16];
1523
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001524 if (snd_BUG_ON(!card))
1525 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 cardnum = card->number;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001527 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1528 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 sprintf(name, "controlC%i", cardnum);
Clemens Ladischf87135f2005-11-20 14:06:59 +01001530 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1531 &snd_ctl_f_ops, card, name)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532 return err;
1533 return 0;
1534}
1535
1536/*
1537 * disconnection of the control device
1538 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001539static int snd_ctl_dev_disconnect(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001541 struct snd_card *card = device->device_data;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001542 struct snd_ctl_file *ctl;
Takashi Iwaic4614822006-06-23 14:38:23 +02001543 int err, cardnum;
1544
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001545 if (snd_BUG_ON(!card))
1546 return -ENXIO;
Takashi Iwaic4614822006-06-23 14:38:23 +02001547 cardnum = card->number;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001548 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1549 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550
Takashi Iwaid8009882008-09-07 12:51:13 +02001551 read_lock(&card->ctl_files_rwlock);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001552 list_for_each_entry(ctl, &card->ctl_files, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 wake_up(&ctl->change_sleep);
1554 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1555 }
Takashi Iwaid8009882008-09-07 12:51:13 +02001556 read_unlock(&card->ctl_files_rwlock);
Takashi Iwaic4614822006-06-23 14:38:23 +02001557
1558 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1559 card, -1)) < 0)
1560 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 return 0;
1562}
1563
1564/*
1565 * free all controls
1566 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001567static int snd_ctl_dev_free(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001569 struct snd_card *card = device->device_data;
1570 struct snd_kcontrol *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
1572 down_write(&card->controls_rwsem);
1573 while (!list_empty(&card->controls)) {
1574 control = snd_kcontrol(card->controls.next);
1575 snd_ctl_remove(card, control);
1576 }
1577 up_write(&card->controls_rwsem);
1578 return 0;
1579}
1580
1581/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 * create control core:
1583 * called from init.c
1584 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001585int snd_ctl_create(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001587 static struct snd_device_ops ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 .dev_free = snd_ctl_dev_free,
1589 .dev_register = snd_ctl_dev_register,
1590 .dev_disconnect = snd_ctl_dev_disconnect,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 };
1592
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001593 if (snd_BUG_ON(!card))
1594 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
1596}
Takashi Iwaib9ed4f22007-07-23 15:41:34 +02001597
1598/*
Clemens Ladisch96007322011-01-10 16:25:44 +01001599 * Frequently used control callbacks/helpers
Takashi Iwaib9ed4f22007-07-23 15:41:34 +02001600 */
1601int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
1602 struct snd_ctl_elem_info *uinfo)
1603{
1604 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1605 uinfo->count = 1;
1606 uinfo->value.integer.min = 0;
1607 uinfo->value.integer.max = 1;
1608 return 0;
1609}
1610
1611EXPORT_SYMBOL(snd_ctl_boolean_mono_info);
1612
1613int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
1614 struct snd_ctl_elem_info *uinfo)
1615{
1616 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1617 uinfo->count = 2;
1618 uinfo->value.integer.min = 0;
1619 uinfo->value.integer.max = 1;
1620 return 0;
1621}
1622
1623EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);
Clemens Ladisch96007322011-01-10 16:25:44 +01001624
1625/**
1626 * snd_ctl_enum_info - fills the info structure for an enumerated control
1627 * @info: the structure to be filled
1628 * @channels: the number of the control's channels; often one
1629 * @items: the number of control values; also the size of @names
1630 * @names: an array containing the names of all control values
1631 *
1632 * Sets all required fields in @info to their appropriate values.
1633 * If the control's accessibility is not the default (readable and writable),
1634 * the caller has to fill @info->access.
1635 */
1636int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
1637 unsigned int items, const char *const names[])
1638{
1639 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1640 info->count = channels;
1641 info->value.enumerated.items = items;
1642 if (info->value.enumerated.item >= items)
1643 info->value.enumerated.item = items - 1;
1644 strlcpy(info->value.enumerated.name,
1645 names[info->value.enumerated.item],
1646 sizeof(info->value.enumerated.name));
1647 return 0;
1648}
1649EXPORT_SYMBOL(snd_ctl_enum_info);