blob: f038f5afafe2bfb596af4e4c7f4abec306dba443 [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>
Paul Gortmakerda155d52011-07-15 12:38:28 -040024#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/slab.h>
26#include <linux/vmalloc.h>
27#include <linux/time.h>
28#include <sound/core.h>
29#include <sound/minors.h>
30#include <sound/info.h>
31#include <sound/control.h>
32
33/* max number of user-defined controls */
34#define MAX_USER_CONTROLS 32
Dan Rosenberg5591bf02010-09-28 14:18:20 -040035#define MAX_CONTROL_COUNT 1028
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Takashi Iwai82e9bae2005-11-17 13:53:23 +010037struct snd_kctl_ioctl {
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 struct list_head list; /* list of all ioctls */
39 snd_kctl_ioctl_func_t fioctl;
Takashi Iwai82e9bae2005-11-17 13:53:23 +010040};
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42static DECLARE_RWSEM(snd_ioctl_rwsem);
43static LIST_HEAD(snd_control_ioctls);
44#ifdef CONFIG_COMPAT
45static LIST_HEAD(snd_control_compat_ioctls);
46#endif
47
48static int snd_ctl_open(struct inode *inode, struct file *file)
49{
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 unsigned long flags;
Takashi Iwai82e9bae2005-11-17 13:53:23 +010051 struct snd_card *card;
52 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 int err;
54
Takashi Iwai02f48652010-04-13 11:49:04 +020055 err = nonseekable_open(inode, file);
56 if (err < 0)
57 return err;
58
Clemens Ladischf87135f2005-11-20 14:06:59 +010059 card = snd_lookup_minor_data(iminor(inode), SNDRV_DEVICE_TYPE_CONTROL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 if (!card) {
61 err = -ENODEV;
62 goto __error1;
63 }
64 err = snd_card_file_add(card, file);
65 if (err < 0) {
66 err = -ENODEV;
67 goto __error1;
68 }
69 if (!try_module_get(card->module)) {
70 err = -EFAULT;
71 goto __error2;
72 }
Takashi Iwaica2c0962005-09-09 14:20:23 +020073 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 if (ctl == NULL) {
75 err = -ENOMEM;
76 goto __error;
77 }
78 INIT_LIST_HEAD(&ctl->events);
79 init_waitqueue_head(&ctl->change_sleep);
80 spin_lock_init(&ctl->read_lock);
81 ctl->card = card;
Takashi Iwai2529bba2006-08-04 12:57:19 +020082 ctl->prefer_pcm_subdevice = -1;
83 ctl->prefer_rawmidi_subdevice = -1;
Clemens Ladisch25d27ed2009-11-02 09:35:44 +010084 ctl->pid = get_pid(task_pid(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 file->private_data = ctl;
86 write_lock_irqsave(&card->ctl_files_rwlock, flags);
87 list_add_tail(&ctl->list, &card->ctl_files);
88 write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
Takashi Iwaia0830db2012-10-16 13:05:59 +020089 snd_card_unref(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 return 0;
91
92 __error:
93 module_put(card->module);
94 __error2:
95 snd_card_file_remove(card, file);
96 __error1:
Takashi Iwaia0830db2012-10-16 13:05:59 +020097 if (card)
98 snd_card_unref(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 return err;
100}
101
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100102static void snd_ctl_empty_read_queue(struct snd_ctl_file * ctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103{
Borislav Petkov7507e8d2007-10-22 17:11:09 +0200104 unsigned long flags;
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100105 struct snd_kctl_event *cread;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Borislav Petkov7507e8d2007-10-22 17:11:09 +0200107 spin_lock_irqsave(&ctl->read_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 while (!list_empty(&ctl->events)) {
109 cread = snd_kctl_event(ctl->events.next);
110 list_del(&cread->list);
111 kfree(cread);
112 }
Borislav Petkov7507e8d2007-10-22 17:11:09 +0200113 spin_unlock_irqrestore(&ctl->read_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114}
115
116static int snd_ctl_release(struct inode *inode, struct file *file)
117{
118 unsigned long flags;
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100119 struct snd_card *card;
120 struct snd_ctl_file *ctl;
121 struct snd_kcontrol *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 unsigned int idx;
123
124 ctl = file->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 file->private_data = NULL;
126 card = ctl->card;
127 write_lock_irqsave(&card->ctl_files_rwlock, flags);
128 list_del(&ctl->list);
129 write_unlock_irqrestore(&card->ctl_files_rwlock, flags);
130 down_write(&card->controls_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +0200131 list_for_each_entry(control, &card->controls, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 for (idx = 0; idx < control->count; idx++)
133 if (control->vd[idx].owner == ctl)
134 control->vd[idx].owner = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 up_write(&card->controls_rwsem);
136 snd_ctl_empty_read_queue(ctl);
Clemens Ladisch25d27ed2009-11-02 09:35:44 +0100137 put_pid(ctl->pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 kfree(ctl);
139 module_put(card->module);
140 snd_card_file_remove(card, file);
141 return 0;
142}
143
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100144void snd_ctl_notify(struct snd_card *card, unsigned int mask,
145 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
147 unsigned long flags;
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100148 struct snd_ctl_file *ctl;
149 struct snd_kctl_event *ev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200151 if (snd_BUG_ON(!card || !id))
152 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 read_lock(&card->ctl_files_rwlock);
Takashi Iwai8eeaa2f2014-02-10 09:48:47 +0100154#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 card->mixer_oss_change_count++;
156#endif
Johannes Berg9244b2c2006-10-05 16:02:22 +0200157 list_for_each_entry(ctl, &card->ctl_files, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 if (!ctl->subscribed)
159 continue;
160 spin_lock_irqsave(&ctl->read_lock, flags);
Johannes Berg9244b2c2006-10-05 16:02:22 +0200161 list_for_each_entry(ev, &ctl->events, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 if (ev->id.numid == id->numid) {
163 ev->mask |= mask;
164 goto _found;
165 }
166 }
Takashi Iwaica2c0962005-09-09 14:20:23 +0200167 ev = kzalloc(sizeof(*ev), GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 if (ev) {
169 ev->id = *id;
170 ev->mask = mask;
171 list_add_tail(&ev->list, &ctl->events);
172 } else {
Takashi Iwaibb009452014-02-04 18:18:16 +0100173 dev_err(card->dev, "No memory available to allocate event\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 }
175 _found:
176 wake_up(&ctl->change_sleep);
177 spin_unlock_irqrestore(&ctl->read_lock, flags);
178 kill_fasync(&ctl->fasync, SIGIO, POLL_IN);
179 }
180 read_unlock(&card->ctl_files_rwlock);
181}
182
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200183EXPORT_SYMBOL(snd_ctl_notify);
184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185/**
186 * snd_ctl_new - create a control instance from the template
187 * @control: the control template
188 * @access: the default control access
189 *
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100190 * Allocates a new struct snd_kcontrol instance and copies the given template
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 * to the new instance. It does not copy volatile data (access).
192 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100193 * Return: The pointer of the new instance, or %NULL on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 */
Adrian Bunk0b51ba02006-11-20 17:50:17 +0100195static struct snd_kcontrol *snd_ctl_new(struct snd_kcontrol *control,
196 unsigned int access)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100198 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 unsigned int idx;
200
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200201 if (snd_BUG_ON(!control || !control->count))
202 return NULL;
Dan Rosenberg5591bf02010-09-28 14:18:20 -0400203
204 if (control->count > MAX_CONTROL_COUNT)
205 return NULL;
206
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100207 kctl = kzalloc(sizeof(*kctl) + sizeof(struct snd_kcontrol_volatile) * control->count, GFP_KERNEL);
Takashi Iwai73e77ba2005-11-17 17:44:01 +0100208 if (kctl == NULL) {
Takashi Iwaibb009452014-02-04 18:18:16 +0100209 pr_err("ALSA: Cannot allocate control instance\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 return NULL;
Takashi Iwai73e77ba2005-11-17 17:44:01 +0100211 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 *kctl = *control;
213 for (idx = 0; idx < kctl->count; idx++)
214 kctl->vd[idx].access = access;
215 return kctl;
216}
217
218/**
219 * snd_ctl_new1 - create a control instance from the template
220 * @ncontrol: the initialization record
221 * @private_data: the private data to set
222 *
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100223 * Allocates a new struct snd_kcontrol instance and initialize from the given
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 * template. When the access field of ncontrol is 0, it's assumed as
225 * READWRITE access. When the count field is 0, it's assumes as one.
226 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100227 * Return: The pointer of the newly generated instance, or %NULL on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100229struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new *ncontrol,
230 void *private_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100232 struct snd_kcontrol kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 unsigned int access;
234
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200235 if (snd_BUG_ON(!ncontrol || !ncontrol->info))
236 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 memset(&kctl, 0, sizeof(kctl));
238 kctl.id.iface = ncontrol->iface;
239 kctl.id.device = ncontrol->device;
240 kctl.id.subdevice = ncontrol->subdevice;
Mark Brown366840d2008-10-29 14:40:30 +0000241 if (ncontrol->name) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 strlcpy(kctl.id.name, ncontrol->name, sizeof(kctl.id.name));
Mark Brown366840d2008-10-29 14:40:30 +0000243 if (strcmp(ncontrol->name, kctl.id.name) != 0)
Takashi Iwaibb009452014-02-04 18:18:16 +0100244 pr_warn("ALSA: Control name '%s' truncated to '%s'\n",
245 ncontrol->name, kctl.id.name);
Mark Brown366840d2008-10-29 14:40:30 +0000246 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 kctl.id.index = ncontrol->index;
248 kctl.count = ncontrol->count ? ncontrol->count : 1;
249 access = ncontrol->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200250 (ncontrol->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
Takashi Iwaia8d372f2012-07-30 13:47:07 +0200251 SNDRV_CTL_ELEM_ACCESS_VOLATILE|
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200252 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
Clemens Ladischa75d7a42010-02-01 13:29:50 +0100253 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE|
254 SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND|
255 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 kctl.info = ncontrol->info;
257 kctl.get = ncontrol->get;
258 kctl.put = ncontrol->put;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200259 kctl.tlv.p = ncontrol->tlv.p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 kctl.private_value = ncontrol->private_value;
261 kctl.private_data = private_data;
262 return snd_ctl_new(&kctl, access);
263}
264
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200265EXPORT_SYMBOL(snd_ctl_new1);
266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267/**
268 * snd_ctl_free_one - release the control instance
269 * @kcontrol: the control instance
270 *
271 * Releases the control instance created via snd_ctl_new()
272 * or snd_ctl_new1().
273 * Don't call this after the control was added to the card.
274 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100275void snd_ctl_free_one(struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276{
277 if (kcontrol) {
278 if (kcontrol->private_free)
279 kcontrol->private_free(kcontrol);
280 kfree(kcontrol);
281 }
282}
283
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200284EXPORT_SYMBOL(snd_ctl_free_one);
285
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100286static bool snd_ctl_remove_numid_conflict(struct snd_card *card,
287 unsigned int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100289 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Johannes Berg9244b2c2006-10-05 16:02:22 +0200291 list_for_each_entry(kctl, &card->controls, list) {
Clemens Ladisch7c733582011-03-07 13:22:50 +0100292 if (kctl->id.numid < card->last_numid + 1 + count &&
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100293 kctl->id.numid + kctl->count > card->last_numid + 1) {
294 card->last_numid = kctl->id.numid + kctl->count - 1;
295 return true;
296 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 }
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100298 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299}
300
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100301static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302{
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100303 unsigned int iter = 100000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100305 while (snd_ctl_remove_numid_conflict(card, count)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 if (--iter == 0) {
307 /* this situation is very unlikely */
Takashi Iwaibb009452014-02-04 18:18:16 +0100308 dev_err(card->dev, "unable to allocate new control numid\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 return -ENOMEM;
310 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 }
312 return 0;
313}
314
315/**
316 * snd_ctl_add - add the control instance to the card
317 * @card: the card instance
318 * @kcontrol: the control instance to add
319 *
320 * Adds the control instance created via snd_ctl_new() or
321 * snd_ctl_new1() to the given card. Assigns also an unique
322 * numid used for fast search.
323 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 * It frees automatically the control which cannot be added.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100325 *
326 * Return: Zero if successful, or a negative error code on failure.
327 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100329int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100331 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 unsigned int idx;
Takashi Iwaic6077b32006-03-21 16:07:13 +0100333 int err = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
Takashi Iwai73e77ba2005-11-17 17:44:01 +0100335 if (! kcontrol)
Takashi Iwaic6077b32006-03-21 16:07:13 +0100336 return err;
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200337 if (snd_BUG_ON(!card || !kcontrol->info))
338 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 id = kcontrol->id;
340 down_write(&card->controls_rwsem);
341 if (snd_ctl_find_id(card, &id)) {
342 up_write(&card->controls_rwsem);
Takashi Iwaibb009452014-02-04 18:18:16 +0100343 dev_err(card->dev, "control %i:%i:%i:%s:%i is already present\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 id.iface,
345 id.device,
346 id.subdevice,
347 id.name,
348 id.index);
Takashi Iwaic6077b32006-03-21 16:07:13 +0100349 err = -EBUSY;
350 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 }
352 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
353 up_write(&card->controls_rwsem);
Takashi Iwaic6077b32006-03-21 16:07:13 +0100354 err = -ENOMEM;
355 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 }
357 list_add_tail(&kcontrol->list, &card->controls);
358 card->controls_count += kcontrol->count;
359 kcontrol->id.numid = card->last_numid + 1;
360 card->last_numid += kcontrol->count;
361 up_write(&card->controls_rwsem);
362 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
363 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
364 return 0;
Takashi Iwaic6077b32006-03-21 16:07:13 +0100365
366 error:
367 snd_ctl_free_one(kcontrol);
368 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369}
370
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200371EXPORT_SYMBOL(snd_ctl_add);
372
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373/**
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000374 * snd_ctl_replace - replace the control instance of the card
375 * @card: the card instance
376 * @kcontrol: the control instance to replace
377 * @add_on_replace: add the control if not already added
378 *
379 * Replaces the given control. If the given control does not exist
380 * and the add_on_replace flag is set, the control is added. If the
381 * control exists, it is destroyed first.
382 *
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000383 * It frees automatically the control which cannot be added or replaced.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100384 *
385 * Return: Zero if successful, or a negative error code on failure.
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000386 */
387int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol,
388 bool add_on_replace)
389{
390 struct snd_ctl_elem_id id;
391 unsigned int idx;
392 struct snd_kcontrol *old;
393 int ret;
394
395 if (!kcontrol)
396 return -EINVAL;
397 if (snd_BUG_ON(!card || !kcontrol->info)) {
398 ret = -EINVAL;
399 goto error;
400 }
401 id = kcontrol->id;
402 down_write(&card->controls_rwsem);
403 old = snd_ctl_find_id(card, &id);
404 if (!old) {
405 if (add_on_replace)
406 goto add;
407 up_write(&card->controls_rwsem);
408 ret = -EINVAL;
409 goto error;
410 }
411 ret = snd_ctl_remove(card, old);
412 if (ret < 0) {
413 up_write(&card->controls_rwsem);
414 goto error;
415 }
416add:
417 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
418 up_write(&card->controls_rwsem);
419 ret = -ENOMEM;
420 goto error;
421 }
422 list_add_tail(&kcontrol->list, &card->controls);
423 card->controls_count += kcontrol->count;
424 kcontrol->id.numid = card->last_numid + 1;
425 card->last_numid += kcontrol->count;
426 up_write(&card->controls_rwsem);
427 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
428 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
429 return 0;
430
431error:
432 snd_ctl_free_one(kcontrol);
433 return ret;
434}
435EXPORT_SYMBOL(snd_ctl_replace);
436
437/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 * snd_ctl_remove - remove the control from the card and release it
439 * @card: the card instance
440 * @kcontrol: the control instance to remove
441 *
442 * Removes the control from the card and then releases the instance.
443 * You don't need to call snd_ctl_free_one(). You must be in
444 * the write lock - down_write(&card->controls_rwsem).
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100445 *
446 * Return: 0 if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100448int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100450 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 unsigned int idx;
452
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200453 if (snd_BUG_ON(!card || !kcontrol))
454 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 list_del(&kcontrol->list);
456 card->controls_count -= kcontrol->count;
457 id = kcontrol->id;
458 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
459 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
460 snd_ctl_free_one(kcontrol);
461 return 0;
462}
463
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200464EXPORT_SYMBOL(snd_ctl_remove);
465
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466/**
467 * snd_ctl_remove_id - remove the control of the given id and release it
468 * @card: the card instance
469 * @id: the control id to remove
470 *
471 * Finds the control instance with the given id, removes it from the
472 * card list and releases it.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100473 *
474 * Return: 0 if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100476int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100478 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 int ret;
480
481 down_write(&card->controls_rwsem);
482 kctl = snd_ctl_find_id(card, id);
483 if (kctl == NULL) {
484 up_write(&card->controls_rwsem);
485 return -ENOENT;
486 }
487 ret = snd_ctl_remove(card, kctl);
488 up_write(&card->controls_rwsem);
489 return ret;
490}
491
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200492EXPORT_SYMBOL(snd_ctl_remove_id);
493
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494/**
Clemens Ladischf217ac52009-08-17 12:27:22 +0200495 * snd_ctl_remove_user_ctl - remove and release the unlocked user control
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 * @file: active control handle
497 * @id: the control id to remove
498 *
499 * Finds the control instance with the given id, removes it from the
500 * card list and releases it.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100501 *
502 * Return: 0 if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 */
Clemens Ladischf217ac52009-08-17 12:27:22 +0200504static int snd_ctl_remove_user_ctl(struct snd_ctl_file * file,
505 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100507 struct snd_card *card = file->card;
508 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 int idx, ret;
510
511 down_write(&card->controls_rwsem);
512 kctl = snd_ctl_find_id(card, id);
513 if (kctl == NULL) {
Clemens Ladisch317b8082009-08-17 12:26:34 +0200514 ret = -ENOENT;
515 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 }
Clemens Ladisch18dd0aa2009-08-17 12:28:09 +0200517 if (!(kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_USER)) {
518 ret = -EINVAL;
519 goto error;
520 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 for (idx = 0; idx < kctl->count; idx++)
522 if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
Clemens Ladisch317b8082009-08-17 12:26:34 +0200523 ret = -EBUSY;
524 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 }
526 ret = snd_ctl_remove(card, kctl);
Clemens Ladischf217ac52009-08-17 12:27:22 +0200527 if (ret < 0)
528 goto error;
529 card->user_ctl_count--;
Clemens Ladisch317b8082009-08-17 12:26:34 +0200530error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 up_write(&card->controls_rwsem);
532 return ret;
533}
534
535/**
Takashi Iwai3cbdd752008-08-29 16:09:01 +0200536 * snd_ctl_activate_id - activate/inactivate the control of the given id
537 * @card: the card instance
538 * @id: the control id to activate/inactivate
539 * @active: non-zero to activate
540 *
541 * Finds the control instance with the given id, and activate or
542 * inactivate the control together with notification, if changed.
543 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100544 * Return: 0 if unchanged, 1 if changed, or a negative error code on failure.
Takashi Iwai3cbdd752008-08-29 16:09:01 +0200545 */
546int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
547 int active)
548{
549 struct snd_kcontrol *kctl;
550 struct snd_kcontrol_volatile *vd;
551 unsigned int index_offset;
552 int ret;
553
554 down_write(&card->controls_rwsem);
555 kctl = snd_ctl_find_id(card, id);
556 if (kctl == NULL) {
557 ret = -ENOENT;
558 goto unlock;
559 }
560 index_offset = snd_ctl_get_ioff(kctl, &kctl->id);
561 vd = &kctl->vd[index_offset];
562 ret = 0;
563 if (active) {
564 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE))
565 goto unlock;
566 vd->access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
567 } else {
568 if (vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE)
569 goto unlock;
570 vd->access |= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
571 }
572 ret = 1;
573 unlock:
574 up_write(&card->controls_rwsem);
575 if (ret > 0)
576 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_INFO, id);
577 return ret;
578}
579EXPORT_SYMBOL_GPL(snd_ctl_activate_id);
580
581/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 * snd_ctl_rename_id - replace the id of a control on the card
583 * @card: the card instance
584 * @src_id: the old id
585 * @dst_id: the new id
586 *
587 * Finds the control with the old id from the card, and replaces the
588 * id with the new one.
589 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100590 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100592int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
593 struct snd_ctl_elem_id *dst_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100595 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
597 down_write(&card->controls_rwsem);
598 kctl = snd_ctl_find_id(card, src_id);
599 if (kctl == NULL) {
600 up_write(&card->controls_rwsem);
601 return -ENOENT;
602 }
603 kctl->id = *dst_id;
604 kctl->id.numid = card->last_numid + 1;
605 card->last_numid += kctl->count;
606 up_write(&card->controls_rwsem);
607 return 0;
608}
609
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200610EXPORT_SYMBOL(snd_ctl_rename_id);
611
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612/**
613 * snd_ctl_find_numid - find the control instance with the given number-id
614 * @card: the card instance
615 * @numid: the number-id to search
616 *
617 * Finds the control instance with the given number-id from the card.
618 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 * The caller must down card->controls_rwsem before calling this function
620 * (if the race condition can happen).
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100621 *
622 * Return: The pointer of the instance if found, or %NULL if not.
623 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100625struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100627 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200629 if (snd_BUG_ON(!card || !numid))
630 return NULL;
Johannes Berg9244b2c2006-10-05 16:02:22 +0200631 list_for_each_entry(kctl, &card->controls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
633 return kctl;
634 }
635 return NULL;
636}
637
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200638EXPORT_SYMBOL(snd_ctl_find_numid);
639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640/**
641 * snd_ctl_find_id - find the control instance with the given id
642 * @card: the card instance
643 * @id: the id to search
644 *
645 * Finds the control instance with the given id from the card.
646 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 * The caller must down card->controls_rwsem before calling this function
648 * (if the race condition can happen).
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100649 *
650 * Return: The pointer of the instance if found, or %NULL if not.
651 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100653struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
654 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100656 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200658 if (snd_BUG_ON(!card || !id))
659 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 if (id->numid != 0)
661 return snd_ctl_find_numid(card, id->numid);
Johannes Berg9244b2c2006-10-05 16:02:22 +0200662 list_for_each_entry(kctl, &card->controls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 if (kctl->id.iface != id->iface)
664 continue;
665 if (kctl->id.device != id->device)
666 continue;
667 if (kctl->id.subdevice != id->subdevice)
668 continue;
669 if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
670 continue;
671 if (kctl->id.index > id->index)
672 continue;
673 if (kctl->id.index + kctl->count <= id->index)
674 continue;
675 return kctl;
676 }
677 return NULL;
678}
679
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200680EXPORT_SYMBOL(snd_ctl_find_id);
681
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100682static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 unsigned int cmd, void __user *arg)
684{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100685 struct snd_ctl_card_info *info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
Takashi Iwaica2c0962005-09-09 14:20:23 +0200687 info = kzalloc(sizeof(*info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 if (! info)
689 return -ENOMEM;
690 down_read(&snd_ioctl_rwsem);
691 info->card = card->number;
692 strlcpy(info->id, card->id, sizeof(info->id));
693 strlcpy(info->driver, card->driver, sizeof(info->driver));
694 strlcpy(info->name, card->shortname, sizeof(info->name));
695 strlcpy(info->longname, card->longname, sizeof(info->longname));
696 strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
697 strlcpy(info->components, card->components, sizeof(info->components));
698 up_read(&snd_ioctl_rwsem);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100699 if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 kfree(info);
701 return -EFAULT;
702 }
703 kfree(info);
704 return 0;
705}
706
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100707static int snd_ctl_elem_list(struct snd_card *card,
708 struct snd_ctl_elem_list __user *_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709{
710 struct list_head *plist;
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100711 struct snd_ctl_elem_list list;
712 struct snd_kcontrol *kctl;
713 struct snd_ctl_elem_id *dst, *id;
Luca Tettamanti78fa2c42011-05-25 22:43:27 +0200714 unsigned int offset, space, jidx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
716 if (copy_from_user(&list, _list, sizeof(list)))
717 return -EFAULT;
718 offset = list.offset;
719 space = list.space;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 /* try limit maximum space */
721 if (space > 16384)
722 return -ENOMEM;
723 if (space > 0) {
724 /* allocate temporary buffer for atomic operation */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100725 dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 if (dst == NULL)
727 return -ENOMEM;
728 down_read(&card->controls_rwsem);
729 list.count = card->controls_count;
730 plist = card->controls.next;
731 while (plist != &card->controls) {
732 if (offset == 0)
733 break;
734 kctl = snd_kcontrol(plist);
735 if (offset < kctl->count)
736 break;
737 offset -= kctl->count;
738 plist = plist->next;
739 }
740 list.used = 0;
741 id = dst;
742 while (space > 0 && plist != &card->controls) {
743 kctl = snd_kcontrol(plist);
744 for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
745 snd_ctl_build_ioff(id, kctl, jidx);
746 id++;
747 space--;
748 list.used++;
749 }
750 plist = plist->next;
751 offset = 0;
752 }
753 up_read(&card->controls_rwsem);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100754 if (list.used > 0 &&
755 copy_to_user(list.pids, dst,
756 list.used * sizeof(struct snd_ctl_elem_id))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 vfree(dst);
758 return -EFAULT;
759 }
760 vfree(dst);
761 } else {
762 down_read(&card->controls_rwsem);
763 list.count = card->controls_count;
764 up_read(&card->controls_rwsem);
765 }
766 if (copy_to_user(_list, &list, sizeof(list)))
767 return -EFAULT;
768 return 0;
769}
770
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100771static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
772 struct snd_ctl_elem_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100774 struct snd_card *card = ctl->card;
775 struct snd_kcontrol *kctl;
776 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 unsigned int index_offset;
778 int result;
779
780 down_read(&card->controls_rwsem);
781 kctl = snd_ctl_find_id(card, &info->id);
782 if (kctl == NULL) {
783 up_read(&card->controls_rwsem);
784 return -ENOENT;
785 }
786#ifdef CONFIG_SND_DEBUG
787 info->access = 0;
788#endif
789 result = kctl->info(kctl, info);
790 if (result >= 0) {
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200791 snd_BUG_ON(info->access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 index_offset = snd_ctl_get_ioff(kctl, &info->id);
793 vd = &kctl->vd[index_offset];
794 snd_ctl_build_ioff(&info->id, kctl, index_offset);
795 info->access = vd->access;
796 if (vd->owner) {
797 info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
798 if (vd->owner == ctl)
799 info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
Clemens Ladisch25d27ed2009-11-02 09:35:44 +0100800 info->owner = pid_vnr(vd->owner->pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 } else {
802 info->owner = -1;
803 }
804 }
805 up_read(&card->controls_rwsem);
806 return result;
807}
808
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100809static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
810 struct snd_ctl_elem_info __user *_info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100812 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 int result;
814
815 if (copy_from_user(&info, _info, sizeof(info)))
816 return -EFAULT;
Giuliano Pochini64649402006-03-13 14:11:11 +0100817 snd_power_lock(ctl->card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200818 result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100819 if (result >= 0)
820 result = snd_ctl_elem_info(ctl, &info);
821 snd_power_unlock(ctl->card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 if (result >= 0)
823 if (copy_to_user(_info, &info, sizeof(info)))
824 return -EFAULT;
825 return result;
826}
827
Takashi Iwaid3bd67c2008-06-12 18:17:26 +0200828static int snd_ctl_elem_read(struct snd_card *card,
829 struct snd_ctl_elem_value *control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100831 struct snd_kcontrol *kctl;
832 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 unsigned int index_offset;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100834 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
836 down_read(&card->controls_rwsem);
837 kctl = snd_ctl_find_id(card, &control->id);
838 if (kctl == NULL) {
839 result = -ENOENT;
840 } else {
841 index_offset = snd_ctl_get_ioff(kctl, &control->id);
842 vd = &kctl->vd[index_offset];
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100843 if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) &&
844 kctl->get != NULL) {
845 snd_ctl_build_ioff(&control->id, kctl, index_offset);
846 result = kctl->get(kctl, control);
847 } else
848 result = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 }
850 up_read(&card->controls_rwsem);
851 return result;
852}
853
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100854static int snd_ctl_elem_read_user(struct snd_card *card,
855 struct snd_ctl_elem_value __user *_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100857 struct snd_ctl_elem_value *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 int result;
Li Zefanef44a1e2009-04-10 09:43:08 +0800859
860 control = memdup_user(_control, sizeof(*control));
861 if (IS_ERR(control))
862 return PTR_ERR(control);
863
Giuliano Pochini64649402006-03-13 14:11:11 +0100864 snd_power_lock(card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200865 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100866 if (result >= 0)
867 result = snd_ctl_elem_read(card, control);
868 snd_power_unlock(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 if (result >= 0)
870 if (copy_to_user(_control, control, sizeof(*control)))
871 result = -EFAULT;
872 kfree(control);
873 return result;
874}
875
Takashi Iwaid3bd67c2008-06-12 18:17:26 +0200876static int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
877 struct snd_ctl_elem_value *control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100879 struct snd_kcontrol *kctl;
880 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 unsigned int index_offset;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100882 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
884 down_read(&card->controls_rwsem);
885 kctl = snd_ctl_find_id(card, &control->id);
886 if (kctl == NULL) {
887 result = -ENOENT;
888 } else {
889 index_offset = snd_ctl_get_ioff(kctl, &control->id);
890 vd = &kctl->vd[index_offset];
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100891 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
892 kctl->put == NULL ||
893 (file && vd->owner && vd->owner != file)) {
894 result = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 } else {
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100896 snd_ctl_build_ioff(&control->id, kctl, index_offset);
897 result = kctl->put(kctl, control);
898 }
899 if (result > 0) {
900 up_read(&card->controls_rwsem);
901 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
902 &control->id);
903 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 }
905 }
906 up_read(&card->controls_rwsem);
907 return result;
908}
909
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100910static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
911 struct snd_ctl_elem_value __user *_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100913 struct snd_ctl_elem_value *control;
Giuliano Pochini64649402006-03-13 14:11:11 +0100914 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 int result;
916
Li Zefanef44a1e2009-04-10 09:43:08 +0800917 control = memdup_user(_control, sizeof(*control));
918 if (IS_ERR(control))
919 return PTR_ERR(control);
920
Giuliano Pochini64649402006-03-13 14:11:11 +0100921 card = file->card;
922 snd_power_lock(card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200923 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100924 if (result >= 0)
925 result = snd_ctl_elem_write(card, file, control);
926 snd_power_unlock(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 if (result >= 0)
928 if (copy_to_user(_control, control, sizeof(*control)))
929 result = -EFAULT;
930 kfree(control);
931 return result;
932}
933
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100934static int snd_ctl_elem_lock(struct snd_ctl_file *file,
935 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100937 struct snd_card *card = file->card;
938 struct snd_ctl_elem_id id;
939 struct snd_kcontrol *kctl;
940 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 int result;
942
943 if (copy_from_user(&id, _id, sizeof(id)))
944 return -EFAULT;
945 down_write(&card->controls_rwsem);
946 kctl = snd_ctl_find_id(card, &id);
947 if (kctl == NULL) {
948 result = -ENOENT;
949 } else {
950 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
951 if (vd->owner != NULL)
952 result = -EBUSY;
953 else {
954 vd->owner = file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 result = 0;
956 }
957 }
958 up_write(&card->controls_rwsem);
959 return result;
960}
961
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100962static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
963 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100965 struct snd_card *card = file->card;
966 struct snd_ctl_elem_id id;
967 struct snd_kcontrol *kctl;
968 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 int result;
970
971 if (copy_from_user(&id, _id, sizeof(id)))
972 return -EFAULT;
973 down_write(&card->controls_rwsem);
974 kctl = snd_ctl_find_id(card, &id);
975 if (kctl == NULL) {
976 result = -ENOENT;
977 } else {
978 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
979 if (vd->owner == NULL)
980 result = -EINVAL;
981 else if (vd->owner != file)
982 result = -EPERM;
983 else {
984 vd->owner = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 result = 0;
986 }
987 }
988 up_write(&card->controls_rwsem);
989 return result;
990}
991
992struct user_element {
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100993 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 void *elem_data; /* element data */
995 unsigned long elem_data_size; /* size of element data in bytes */
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200996 void *tlv_data; /* TLV data */
997 unsigned long tlv_data_size; /* TLV data size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 void *priv_data; /* private data (like strings for enumerated type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999};
1000
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001001static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
1002 struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003{
1004 struct user_element *ue = kcontrol->private_data;
1005
1006 *uinfo = ue->info;
1007 return 0;
1008}
1009
Clemens Ladisch8d448162011-10-07 22:38:59 +02001010static int snd_ctl_elem_user_enum_info(struct snd_kcontrol *kcontrol,
1011 struct snd_ctl_elem_info *uinfo)
1012{
1013 struct user_element *ue = kcontrol->private_data;
1014 const char *names;
1015 unsigned int item;
1016
1017 item = uinfo->value.enumerated.item;
1018
1019 *uinfo = ue->info;
1020
1021 item = min(item, uinfo->value.enumerated.items - 1);
1022 uinfo->value.enumerated.item = item;
1023
1024 names = ue->priv_data;
1025 for (; item > 0; --item)
1026 names += strlen(names) + 1;
1027 strcpy(uinfo->value.enumerated.name, names);
1028
1029 return 0;
1030}
1031
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001032static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
1033 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034{
1035 struct user_element *ue = kcontrol->private_data;
1036
1037 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
1038 return 0;
1039}
1040
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001041static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
1042 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043{
1044 int change;
1045 struct user_element *ue = kcontrol->private_data;
1046
1047 change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
1048 if (change)
1049 memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
1050 return change;
1051}
1052
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001053static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
1054 int op_flag,
1055 unsigned int size,
1056 unsigned int __user *tlv)
1057{
1058 struct user_element *ue = kcontrol->private_data;
1059 int change = 0;
1060 void *new_data;
1061
1062 if (op_flag > 0) {
1063 if (size > 1024 * 128) /* sane value */
1064 return -EINVAL;
Li Zefanef44a1e2009-04-10 09:43:08 +08001065
1066 new_data = memdup_user(tlv, size);
1067 if (IS_ERR(new_data))
1068 return PTR_ERR(new_data);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001069 change = ue->tlv_data_size != size;
1070 if (!change)
1071 change = memcmp(ue->tlv_data, new_data, size);
1072 kfree(ue->tlv_data);
1073 ue->tlv_data = new_data;
1074 ue->tlv_data_size = size;
1075 } else {
Takashi Iwai18c1c3f2006-08-25 11:39:34 +02001076 if (! ue->tlv_data_size || ! ue->tlv_data)
1077 return -ENXIO;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001078 if (size < ue->tlv_data_size)
1079 return -ENOSPC;
1080 if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
1081 return -EFAULT;
1082 }
1083 return change;
1084}
1085
Clemens Ladisch8d448162011-10-07 22:38:59 +02001086static int snd_ctl_elem_init_enum_names(struct user_element *ue)
1087{
1088 char *names, *p;
1089 size_t buf_len, name_len;
1090 unsigned int i;
Olof Johansson447c6f92011-11-05 22:51:54 +01001091 const uintptr_t user_ptrval = ue->info.value.enumerated.names_ptr;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001092
1093 if (ue->info.value.enumerated.names_length > 64 * 1024)
1094 return -EINVAL;
1095
Olof Johansson447c6f92011-11-05 22:51:54 +01001096 names = memdup_user((const void __user *)user_ptrval,
Clemens Ladisch8d448162011-10-07 22:38:59 +02001097 ue->info.value.enumerated.names_length);
1098 if (IS_ERR(names))
1099 return PTR_ERR(names);
1100
1101 /* check that there are enough valid names */
1102 buf_len = ue->info.value.enumerated.names_length;
1103 p = names;
1104 for (i = 0; i < ue->info.value.enumerated.items; ++i) {
1105 name_len = strnlen(p, buf_len);
1106 if (name_len == 0 || name_len >= 64 || name_len == buf_len) {
1107 kfree(names);
1108 return -EINVAL;
1109 }
1110 p += name_len + 1;
1111 buf_len -= name_len + 1;
1112 }
1113
1114 ue->priv_data = names;
1115 ue->info.value.enumerated.names_ptr = 0;
1116
1117 return 0;
1118}
1119
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001120static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121{
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001122 struct user_element *ue = kcontrol->private_data;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001123
1124 kfree(ue->tlv_data);
1125 kfree(ue->priv_data);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001126 kfree(ue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127}
1128
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001129static int snd_ctl_elem_add(struct snd_ctl_file *file,
1130 struct snd_ctl_elem_info *info, int replace)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001132 struct snd_card *card = file->card;
1133 struct snd_kcontrol kctl, *_kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 unsigned int access;
1135 long private_size;
1136 struct user_element *ue;
1137 int idx, err;
Lu Guanqun983929c2011-08-24 11:12:34 +08001138
Lu Guanqun08ede032011-08-24 14:45:10 +08001139 if (!replace && card->user_ctl_count >= MAX_USER_CONTROLS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 return -ENOMEM;
Clemens Ladisch2a031ae2009-08-17 12:25:52 +02001141 if (info->count < 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 return -EINVAL;
1143 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001144 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001145 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
1146 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 info->id.numid = 0;
1148 memset(&kctl, 0, sizeof(kctl));
1149 down_write(&card->controls_rwsem);
1150 _kctl = snd_ctl_find_id(card, &info->id);
1151 err = 0;
1152 if (_kctl) {
1153 if (replace)
1154 err = snd_ctl_remove(card, _kctl);
1155 else
1156 err = -EBUSY;
1157 } else {
1158 if (replace)
1159 err = -ENOENT;
1160 }
1161 up_write(&card->controls_rwsem);
1162 if (err < 0)
1163 return err;
1164 memcpy(&kctl.id, &info->id, sizeof(info->id));
1165 kctl.count = info->owner ? info->owner : 1;
1166 access |= SNDRV_CTL_ELEM_ACCESS_USER;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001167 if (info->type == SNDRV_CTL_ELEM_TYPE_ENUMERATED)
1168 kctl.info = snd_ctl_elem_user_enum_info;
1169 else
1170 kctl.info = snd_ctl_elem_user_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
1172 kctl.get = snd_ctl_elem_user_get;
1173 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
1174 kctl.put = snd_ctl_elem_user_put;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001175 if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
1176 kctl.tlv.c = snd_ctl_elem_user_tlv;
1177 access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1178 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 switch (info->type) {
1180 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 case SNDRV_CTL_ELEM_TYPE_INTEGER:
1182 private_size = sizeof(long);
1183 if (info->count > 128)
1184 return -EINVAL;
1185 break;
1186 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1187 private_size = sizeof(long long);
1188 if (info->count > 64)
1189 return -EINVAL;
1190 break;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001191 case SNDRV_CTL_ELEM_TYPE_ENUMERATED:
1192 private_size = sizeof(unsigned int);
1193 if (info->count > 128 || info->value.enumerated.items == 0)
1194 return -EINVAL;
1195 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 case SNDRV_CTL_ELEM_TYPE_BYTES:
1197 private_size = sizeof(unsigned char);
1198 if (info->count > 512)
1199 return -EINVAL;
1200 break;
1201 case SNDRV_CTL_ELEM_TYPE_IEC958:
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001202 private_size = sizeof(struct snd_aes_iec958);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 if (info->count != 1)
1204 return -EINVAL;
1205 break;
1206 default:
1207 return -EINVAL;
1208 }
1209 private_size *= info->count;
Takashi Iwaica2c0962005-09-09 14:20:23 +02001210 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 if (ue == NULL)
1212 return -ENOMEM;
1213 ue->info = *info;
Takashi Iwai86148e82006-08-24 12:36:36 +02001214 ue->info.access = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 ue->elem_data = (char *)ue + sizeof(*ue);
1216 ue->elem_data_size = private_size;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001217 if (ue->info.type == SNDRV_CTL_ELEM_TYPE_ENUMERATED) {
1218 err = snd_ctl_elem_init_enum_names(ue);
1219 if (err < 0) {
1220 kfree(ue);
1221 return err;
1222 }
1223 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 kctl.private_free = snd_ctl_elem_user_free;
1225 _kctl = snd_ctl_new(&kctl, access);
1226 if (_kctl == NULL) {
Clemens Ladisch8d448162011-10-07 22:38:59 +02001227 kfree(ue->priv_data);
Takashi Iwai2fbf1822006-03-06 15:42:51 -08001228 kfree(ue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 return -ENOMEM;
1230 }
1231 _kctl->private_data = ue;
1232 for (idx = 0; idx < _kctl->count; idx++)
1233 _kctl->vd[idx].owner = file;
1234 err = snd_ctl_add(card, _kctl);
Takashi Iwai2fbf1822006-03-06 15:42:51 -08001235 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237
1238 down_write(&card->controls_rwsem);
1239 card->user_ctl_count++;
1240 up_write(&card->controls_rwsem);
1241
1242 return 0;
1243}
1244
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001245static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1246 struct snd_ctl_elem_info __user *_info, int replace)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001248 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 if (copy_from_user(&info, _info, sizeof(info)))
1250 return -EFAULT;
1251 return snd_ctl_elem_add(file, &info, replace);
1252}
1253
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001254static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1255 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001257 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258
1259 if (copy_from_user(&id, _id, sizeof(id)))
1260 return -EFAULT;
Clemens Ladischf217ac52009-08-17 12:27:22 +02001261 return snd_ctl_remove_user_ctl(file, &id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262}
1263
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001264static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265{
1266 int subscribe;
1267 if (get_user(subscribe, ptr))
1268 return -EFAULT;
1269 if (subscribe < 0) {
1270 subscribe = file->subscribed;
1271 if (put_user(subscribe, ptr))
1272 return -EFAULT;
1273 return 0;
1274 }
1275 if (subscribe) {
1276 file->subscribed = 1;
1277 return 0;
1278 } else if (file->subscribed) {
1279 snd_ctl_empty_read_queue(file);
1280 file->subscribed = 0;
1281 }
1282 return 0;
1283}
1284
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001285static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1286 struct snd_ctl_tlv __user *_tlv,
1287 int op_flag)
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001288{
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001289 struct snd_card *card = file->card;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001290 struct snd_ctl_tlv tlv;
1291 struct snd_kcontrol *kctl;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001292 struct snd_kcontrol_volatile *vd;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001293 unsigned int len;
1294 int err = 0;
1295
1296 if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1297 return -EFAULT;
Clemens Ladisch61236372010-02-01 13:30:56 +01001298 if (tlv.length < sizeof(unsigned int) * 2)
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001299 return -EINVAL;
1300 down_read(&card->controls_rwsem);
1301 kctl = snd_ctl_find_numid(card, tlv.numid);
1302 if (kctl == NULL) {
1303 err = -ENOENT;
1304 goto __kctl_end;
1305 }
1306 if (kctl->tlv.p == NULL) {
1307 err = -ENXIO;
1308 goto __kctl_end;
1309 }
1310 vd = &kctl->vd[tlv.numid - kctl->id.numid];
1311 if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1312 (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1313 (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1314 err = -ENXIO;
1315 goto __kctl_end;
1316 }
1317 if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
Dan Carpenterbec145a2009-11-18 10:31:57 +02001318 if (vd->owner != NULL && vd->owner != file) {
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001319 err = -EPERM;
1320 goto __kctl_end;
1321 }
Jeffrin Josebd483d42012-03-07 22:57:39 +05301322 err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001323 if (err > 0) {
1324 up_read(&card->controls_rwsem);
1325 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &kctl->id);
1326 return 0;
1327 }
1328 } else {
1329 if (op_flag) {
1330 err = -ENXIO;
1331 goto __kctl_end;
1332 }
1333 len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1334 if (tlv.length < len) {
1335 err = -ENOMEM;
1336 goto __kctl_end;
1337 }
1338 if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1339 err = -EFAULT;
1340 }
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001341 __kctl_end:
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001342 up_read(&card->controls_rwsem);
1343 return err;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001344}
1345
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1347{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001348 struct snd_ctl_file *ctl;
1349 struct snd_card *card;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001350 struct snd_kctl_ioctl *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 void __user *argp = (void __user *)arg;
1352 int __user *ip = argp;
1353 int err;
1354
1355 ctl = file->private_data;
1356 card = ctl->card;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001357 if (snd_BUG_ON(!card))
1358 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 switch (cmd) {
1360 case SNDRV_CTL_IOCTL_PVERSION:
1361 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1362 case SNDRV_CTL_IOCTL_CARD_INFO:
1363 return snd_ctl_card_info(card, ctl, cmd, argp);
1364 case SNDRV_CTL_IOCTL_ELEM_LIST:
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001365 return snd_ctl_elem_list(card, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 case SNDRV_CTL_IOCTL_ELEM_INFO:
1367 return snd_ctl_elem_info_user(ctl, argp);
1368 case SNDRV_CTL_IOCTL_ELEM_READ:
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001369 return snd_ctl_elem_read_user(card, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1371 return snd_ctl_elem_write_user(ctl, argp);
1372 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1373 return snd_ctl_elem_lock(ctl, argp);
1374 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1375 return snd_ctl_elem_unlock(ctl, argp);
1376 case SNDRV_CTL_IOCTL_ELEM_ADD:
1377 return snd_ctl_elem_add_user(ctl, argp, 0);
1378 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1379 return snd_ctl_elem_add_user(ctl, argp, 1);
1380 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1381 return snd_ctl_elem_remove(ctl, argp);
1382 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1383 return snd_ctl_subscribe_events(ctl, ip);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001384 case SNDRV_CTL_IOCTL_TLV_READ:
1385 return snd_ctl_tlv_ioctl(ctl, argp, 0);
1386 case SNDRV_CTL_IOCTL_TLV_WRITE:
1387 return snd_ctl_tlv_ioctl(ctl, argp, 1);
1388 case SNDRV_CTL_IOCTL_TLV_COMMAND:
1389 return snd_ctl_tlv_ioctl(ctl, argp, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 case SNDRV_CTL_IOCTL_POWER:
Takashi Iwaia381a7a2005-11-17 15:55:49 +01001391 return -ENOPROTOOPT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392 case SNDRV_CTL_IOCTL_POWER_STATE:
1393#ifdef CONFIG_PM
1394 return put_user(card->power_state, ip) ? -EFAULT : 0;
1395#else
1396 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1397#endif
1398 }
1399 down_read(&snd_ioctl_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001400 list_for_each_entry(p, &snd_control_ioctls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 err = p->fioctl(card, ctl, cmd, arg);
1402 if (err != -ENOIOCTLCMD) {
1403 up_read(&snd_ioctl_rwsem);
1404 return err;
1405 }
1406 }
1407 up_read(&snd_ioctl_rwsem);
Takashi Iwaibb009452014-02-04 18:18:16 +01001408 dev_dbg(card->dev, "unknown ioctl = 0x%x\n", cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 return -ENOTTY;
1410}
1411
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001412static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1413 size_t count, loff_t * offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001415 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 int err = 0;
1417 ssize_t result = 0;
1418
1419 ctl = file->private_data;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001420 if (snd_BUG_ON(!ctl || !ctl->card))
1421 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 if (!ctl->subscribed)
1423 return -EBADFD;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001424 if (count < sizeof(struct snd_ctl_event))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 return -EINVAL;
1426 spin_lock_irq(&ctl->read_lock);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001427 while (count >= sizeof(struct snd_ctl_event)) {
1428 struct snd_ctl_event ev;
1429 struct snd_kctl_event *kev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 while (list_empty(&ctl->events)) {
1431 wait_queue_t wait;
1432 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1433 err = -EAGAIN;
1434 goto __end_lock;
1435 }
1436 init_waitqueue_entry(&wait, current);
1437 add_wait_queue(&ctl->change_sleep, &wait);
1438 set_current_state(TASK_INTERRUPTIBLE);
1439 spin_unlock_irq(&ctl->read_lock);
1440 schedule();
1441 remove_wait_queue(&ctl->change_sleep, &wait);
Takashi Iwai0914f792012-10-16 16:43:39 +02001442 if (ctl->card->shutdown)
1443 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 if (signal_pending(current))
Adrian Bunk0e5d7202006-11-07 13:42:54 +01001445 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 spin_lock_irq(&ctl->read_lock);
1447 }
1448 kev = snd_kctl_event(ctl->events.next);
1449 ev.type = SNDRV_CTL_EVENT_ELEM;
1450 ev.data.elem.mask = kev->mask;
1451 ev.data.elem.id = kev->id;
1452 list_del(&kev->list);
1453 spin_unlock_irq(&ctl->read_lock);
1454 kfree(kev);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001455 if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 err = -EFAULT;
1457 goto __end;
1458 }
1459 spin_lock_irq(&ctl->read_lock);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001460 buffer += sizeof(struct snd_ctl_event);
1461 count -= sizeof(struct snd_ctl_event);
1462 result += sizeof(struct snd_ctl_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 }
1464 __end_lock:
1465 spin_unlock_irq(&ctl->read_lock);
1466 __end:
1467 return result > 0 ? result : err;
1468}
1469
1470static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1471{
1472 unsigned int mask;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001473 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474
1475 ctl = file->private_data;
1476 if (!ctl->subscribed)
1477 return 0;
1478 poll_wait(file, &ctl->change_sleep, wait);
1479
1480 mask = 0;
1481 if (!list_empty(&ctl->events))
1482 mask |= POLLIN | POLLRDNORM;
1483
1484 return mask;
1485}
1486
1487/*
1488 * register the device-specific control-ioctls.
1489 * called from each device manager like pcm.c, hwdep.c, etc.
1490 */
1491static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1492{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001493 struct snd_kctl_ioctl *pn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001495 pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 if (pn == NULL)
1497 return -ENOMEM;
1498 pn->fioctl = fcn;
1499 down_write(&snd_ioctl_rwsem);
1500 list_add_tail(&pn->list, lists);
1501 up_write(&snd_ioctl_rwsem);
1502 return 0;
1503}
1504
1505int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1506{
1507 return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1508}
1509
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001510EXPORT_SYMBOL(snd_ctl_register_ioctl);
1511
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512#ifdef CONFIG_COMPAT
1513int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1514{
1515 return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1516}
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001517
1518EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519#endif
1520
1521/*
1522 * de-register the device-specific control-ioctls.
1523 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001524static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1525 struct list_head *lists)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001527 struct snd_kctl_ioctl *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001529 if (snd_BUG_ON(!fcn))
1530 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531 down_write(&snd_ioctl_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001532 list_for_each_entry(p, lists, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 if (p->fioctl == fcn) {
1534 list_del(&p->list);
1535 up_write(&snd_ioctl_rwsem);
1536 kfree(p);
1537 return 0;
1538 }
1539 }
1540 up_write(&snd_ioctl_rwsem);
1541 snd_BUG();
1542 return -EINVAL;
1543}
1544
1545int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1546{
1547 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1548}
1549
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001550EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1551
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552#ifdef CONFIG_COMPAT
1553int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1554{
1555 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1556}
1557
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001558EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559#endif
1560
1561static int snd_ctl_fasync(int fd, struct file * file, int on)
1562{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001563 struct snd_ctl_file *ctl;
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 ctl = file->private_data;
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001566 return fasync_helper(fd, file, on, &ctl->fasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567}
1568
1569/*
1570 * ioctl32 compat
1571 */
1572#ifdef CONFIG_COMPAT
1573#include "control_compat.c"
1574#else
1575#define snd_ctl_ioctl_compat NULL
1576#endif
1577
1578/*
1579 * INIT PART
1580 */
1581
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -08001582static const struct file_operations snd_ctl_f_ops =
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583{
1584 .owner = THIS_MODULE,
1585 .read = snd_ctl_read,
1586 .open = snd_ctl_open,
1587 .release = snd_ctl_release,
Takashi Iwai02f48652010-04-13 11:49:04 +02001588 .llseek = no_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 .poll = snd_ctl_poll,
1590 .unlocked_ioctl = snd_ctl_ioctl,
1591 .compat_ioctl = snd_ctl_ioctl_compat,
1592 .fasync = snd_ctl_fasync,
1593};
1594
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595/*
1596 * registration of the control device
1597 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001598static int snd_ctl_dev_register(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001600 struct snd_card *card = device->device_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 int err, cardnum;
1602 char name[16];
1603
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001604 if (snd_BUG_ON(!card))
1605 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 cardnum = card->number;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001607 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1608 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 sprintf(name, "controlC%i", cardnum);
Clemens Ladischf87135f2005-11-20 14:06:59 +01001610 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1611 &snd_ctl_f_ops, card, name)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 return err;
1613 return 0;
1614}
1615
1616/*
1617 * disconnection of the control device
1618 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001619static int snd_ctl_dev_disconnect(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001621 struct snd_card *card = device->device_data;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001622 struct snd_ctl_file *ctl;
Takashi Iwaic4614822006-06-23 14:38:23 +02001623 int err, cardnum;
1624
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001625 if (snd_BUG_ON(!card))
1626 return -ENXIO;
Takashi Iwaic4614822006-06-23 14:38:23 +02001627 cardnum = card->number;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001628 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1629 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630
Takashi Iwaid8009882008-09-07 12:51:13 +02001631 read_lock(&card->ctl_files_rwlock);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001632 list_for_each_entry(ctl, &card->ctl_files, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 wake_up(&ctl->change_sleep);
1634 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1635 }
Takashi Iwaid8009882008-09-07 12:51:13 +02001636 read_unlock(&card->ctl_files_rwlock);
Takashi Iwaic4614822006-06-23 14:38:23 +02001637
1638 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1639 card, -1)) < 0)
1640 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 return 0;
1642}
1643
1644/*
1645 * free all controls
1646 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001647static int snd_ctl_dev_free(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001649 struct snd_card *card = device->device_data;
1650 struct snd_kcontrol *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
1652 down_write(&card->controls_rwsem);
1653 while (!list_empty(&card->controls)) {
1654 control = snd_kcontrol(card->controls.next);
1655 snd_ctl_remove(card, control);
1656 }
1657 up_write(&card->controls_rwsem);
1658 return 0;
1659}
1660
1661/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 * create control core:
1663 * called from init.c
1664 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001665int snd_ctl_create(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001667 static struct snd_device_ops ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 .dev_free = snd_ctl_dev_free,
1669 .dev_register = snd_ctl_dev_register,
1670 .dev_disconnect = snd_ctl_dev_disconnect,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 };
1672
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001673 if (snd_BUG_ON(!card))
1674 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
1676}
Takashi Iwaib9ed4f22007-07-23 15:41:34 +02001677
1678/*
Clemens Ladisch96007322011-01-10 16:25:44 +01001679 * Frequently used control callbacks/helpers
Takashi Iwaib9ed4f22007-07-23 15:41:34 +02001680 */
1681int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
1682 struct snd_ctl_elem_info *uinfo)
1683{
1684 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1685 uinfo->count = 1;
1686 uinfo->value.integer.min = 0;
1687 uinfo->value.integer.max = 1;
1688 return 0;
1689}
1690
1691EXPORT_SYMBOL(snd_ctl_boolean_mono_info);
1692
1693int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
1694 struct snd_ctl_elem_info *uinfo)
1695{
1696 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1697 uinfo->count = 2;
1698 uinfo->value.integer.min = 0;
1699 uinfo->value.integer.max = 1;
1700 return 0;
1701}
1702
1703EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);
Clemens Ladisch96007322011-01-10 16:25:44 +01001704
1705/**
1706 * snd_ctl_enum_info - fills the info structure for an enumerated control
1707 * @info: the structure to be filled
1708 * @channels: the number of the control's channels; often one
1709 * @items: the number of control values; also the size of @names
1710 * @names: an array containing the names of all control values
1711 *
1712 * Sets all required fields in @info to their appropriate values.
1713 * If the control's accessibility is not the default (readable and writable),
1714 * the caller has to fill @info->access.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001715 *
1716 * Return: Zero.
Clemens Ladisch96007322011-01-10 16:25:44 +01001717 */
1718int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
1719 unsigned int items, const char *const names[])
1720{
1721 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1722 info->count = channels;
1723 info->value.enumerated.items = items;
1724 if (info->value.enumerated.item >= items)
1725 info->value.enumerated.item = items - 1;
1726 strlcpy(info->value.enumerated.name,
1727 names[info->value.enumerated.item],
1728 sizeof(info->value.enumerated.name));
1729 return 0;
1730}
1731EXPORT_SYMBOL(snd_ctl_enum_info);