blob: 8d6e4bae74074e99749f350bb3d245a1eb5ddc1b [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
Lars-Peter Clausenac902c12014-06-18 13:32:34 +0200291 /* Make sure that the ids assigned to the control do not wrap around */
292 if (card->last_numid >= UINT_MAX - count)
293 card->last_numid = 0;
294
Johannes Berg9244b2c2006-10-05 16:02:22 +0200295 list_for_each_entry(kctl, &card->controls, list) {
Clemens Ladisch7c733582011-03-07 13:22:50 +0100296 if (kctl->id.numid < card->last_numid + 1 + count &&
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100297 kctl->id.numid + kctl->count > card->last_numid + 1) {
298 card->last_numid = kctl->id.numid + kctl->count - 1;
299 return true;
300 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 }
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100302 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303}
304
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100305static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306{
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100307 unsigned int iter = 100000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100309 while (snd_ctl_remove_numid_conflict(card, count)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 if (--iter == 0) {
311 /* this situation is very unlikely */
Takashi Iwaibb009452014-02-04 18:18:16 +0100312 dev_err(card->dev, "unable to allocate new control numid\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 return -ENOMEM;
314 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 }
316 return 0;
317}
318
319/**
320 * snd_ctl_add - add the control instance to the card
321 * @card: the card instance
322 * @kcontrol: the control instance to add
323 *
324 * Adds the control instance created via snd_ctl_new() or
325 * snd_ctl_new1() to the given card. Assigns also an unique
326 * numid used for fast search.
327 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 * It frees automatically the control which cannot be added.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100329 *
330 * Return: Zero if successful, or a negative error code on failure.
331 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100333int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100335 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 unsigned int idx;
Lars-Peter Clausenfd9f26e2014-06-18 13:32:33 +0200337 unsigned int count;
Takashi Iwaic6077b32006-03-21 16:07:13 +0100338 int err = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Takashi Iwai73e77ba2005-11-17 17:44:01 +0100340 if (! kcontrol)
Takashi Iwaic6077b32006-03-21 16:07:13 +0100341 return err;
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200342 if (snd_BUG_ON(!card || !kcontrol->info))
343 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 id = kcontrol->id;
345 down_write(&card->controls_rwsem);
346 if (snd_ctl_find_id(card, &id)) {
347 up_write(&card->controls_rwsem);
Takashi Iwaibb009452014-02-04 18:18:16 +0100348 dev_err(card->dev, "control %i:%i:%i:%s:%i is already present\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 id.iface,
350 id.device,
351 id.subdevice,
352 id.name,
353 id.index);
Takashi Iwaic6077b32006-03-21 16:07:13 +0100354 err = -EBUSY;
355 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 }
357 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
358 up_write(&card->controls_rwsem);
Takashi Iwaic6077b32006-03-21 16:07:13 +0100359 err = -ENOMEM;
360 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 }
362 list_add_tail(&kcontrol->list, &card->controls);
363 card->controls_count += kcontrol->count;
364 kcontrol->id.numid = card->last_numid + 1;
365 card->last_numid += kcontrol->count;
Lars-Peter Clausenfd9f26e2014-06-18 13:32:33 +0200366 count = kcontrol->count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 up_write(&card->controls_rwsem);
Lars-Peter Clausenfd9f26e2014-06-18 13:32:33 +0200368 for (idx = 0; idx < count; idx++, id.index++, id.numid++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
370 return 0;
Takashi Iwaic6077b32006-03-21 16:07:13 +0100371
372 error:
373 snd_ctl_free_one(kcontrol);
374 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375}
376
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200377EXPORT_SYMBOL(snd_ctl_add);
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379/**
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000380 * snd_ctl_replace - replace the control instance of the card
381 * @card: the card instance
382 * @kcontrol: the control instance to replace
383 * @add_on_replace: add the control if not already added
384 *
385 * Replaces the given control. If the given control does not exist
386 * and the add_on_replace flag is set, the control is added. If the
387 * control exists, it is destroyed first.
388 *
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000389 * It frees automatically the control which cannot be added or replaced.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100390 *
391 * Return: Zero if successful, or a negative error code on failure.
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000392 */
393int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol,
394 bool add_on_replace)
395{
396 struct snd_ctl_elem_id id;
Lars-Peter Clausenfd9f26e2014-06-18 13:32:33 +0200397 unsigned int count;
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000398 unsigned int idx;
399 struct snd_kcontrol *old;
400 int ret;
401
402 if (!kcontrol)
403 return -EINVAL;
404 if (snd_BUG_ON(!card || !kcontrol->info)) {
405 ret = -EINVAL;
406 goto error;
407 }
408 id = kcontrol->id;
409 down_write(&card->controls_rwsem);
410 old = snd_ctl_find_id(card, &id);
411 if (!old) {
412 if (add_on_replace)
413 goto add;
414 up_write(&card->controls_rwsem);
415 ret = -EINVAL;
416 goto error;
417 }
418 ret = snd_ctl_remove(card, old);
419 if (ret < 0) {
420 up_write(&card->controls_rwsem);
421 goto error;
422 }
423add:
424 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
425 up_write(&card->controls_rwsem);
426 ret = -ENOMEM;
427 goto error;
428 }
429 list_add_tail(&kcontrol->list, &card->controls);
430 card->controls_count += kcontrol->count;
431 kcontrol->id.numid = card->last_numid + 1;
432 card->last_numid += kcontrol->count;
Lars-Peter Clausenfd9f26e2014-06-18 13:32:33 +0200433 count = kcontrol->count;
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000434 up_write(&card->controls_rwsem);
Lars-Peter Clausenfd9f26e2014-06-18 13:32:33 +0200435 for (idx = 0; idx < count; idx++, id.index++, id.numid++)
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000436 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
437 return 0;
438
439error:
440 snd_ctl_free_one(kcontrol);
441 return ret;
442}
443EXPORT_SYMBOL(snd_ctl_replace);
444
445/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 * snd_ctl_remove - remove the control from the card and release it
447 * @card: the card instance
448 * @kcontrol: the control instance to remove
449 *
450 * Removes the control from the card and then releases the instance.
451 * You don't need to call snd_ctl_free_one(). You must be in
452 * the write lock - down_write(&card->controls_rwsem).
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100453 *
454 * Return: 0 if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100456int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100458 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 unsigned int idx;
460
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200461 if (snd_BUG_ON(!card || !kcontrol))
462 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 list_del(&kcontrol->list);
464 card->controls_count -= kcontrol->count;
465 id = kcontrol->id;
466 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
467 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
468 snd_ctl_free_one(kcontrol);
469 return 0;
470}
471
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200472EXPORT_SYMBOL(snd_ctl_remove);
473
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474/**
475 * snd_ctl_remove_id - remove the control of the given id and release it
476 * @card: the card instance
477 * @id: the control id to remove
478 *
479 * Finds the control instance with the given id, removes it from the
480 * card list and releases it.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100481 *
482 * Return: 0 if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100484int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100486 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 int ret;
488
489 down_write(&card->controls_rwsem);
490 kctl = snd_ctl_find_id(card, id);
491 if (kctl == NULL) {
492 up_write(&card->controls_rwsem);
493 return -ENOENT;
494 }
495 ret = snd_ctl_remove(card, kctl);
496 up_write(&card->controls_rwsem);
497 return ret;
498}
499
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200500EXPORT_SYMBOL(snd_ctl_remove_id);
501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502/**
Clemens Ladischf217ac52009-08-17 12:27:22 +0200503 * snd_ctl_remove_user_ctl - remove and release the unlocked user control
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 * @file: active control handle
505 * @id: the control id to remove
506 *
507 * Finds the control instance with the given id, removes it from the
508 * card list and releases it.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100509 *
510 * Return: 0 if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 */
Clemens Ladischf217ac52009-08-17 12:27:22 +0200512static int snd_ctl_remove_user_ctl(struct snd_ctl_file * file,
513 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100515 struct snd_card *card = file->card;
516 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 int idx, ret;
518
519 down_write(&card->controls_rwsem);
520 kctl = snd_ctl_find_id(card, id);
521 if (kctl == NULL) {
Clemens Ladisch317b8082009-08-17 12:26:34 +0200522 ret = -ENOENT;
523 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 }
Clemens Ladisch18dd0aa2009-08-17 12:28:09 +0200525 if (!(kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_USER)) {
526 ret = -EINVAL;
527 goto error;
528 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 for (idx = 0; idx < kctl->count; idx++)
530 if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
Clemens Ladisch317b8082009-08-17 12:26:34 +0200531 ret = -EBUSY;
532 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 }
534 ret = snd_ctl_remove(card, kctl);
Clemens Ladischf217ac52009-08-17 12:27:22 +0200535 if (ret < 0)
536 goto error;
537 card->user_ctl_count--;
Clemens Ladisch317b8082009-08-17 12:26:34 +0200538error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 up_write(&card->controls_rwsem);
540 return ret;
541}
542
543/**
Takashi Iwai3cbdd752008-08-29 16:09:01 +0200544 * snd_ctl_activate_id - activate/inactivate the control of the given id
545 * @card: the card instance
546 * @id: the control id to activate/inactivate
547 * @active: non-zero to activate
548 *
549 * Finds the control instance with the given id, and activate or
550 * inactivate the control together with notification, if changed.
551 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100552 * Return: 0 if unchanged, 1 if changed, or a negative error code on failure.
Takashi Iwai3cbdd752008-08-29 16:09:01 +0200553 */
554int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
555 int active)
556{
557 struct snd_kcontrol *kctl;
558 struct snd_kcontrol_volatile *vd;
559 unsigned int index_offset;
560 int ret;
561
562 down_write(&card->controls_rwsem);
563 kctl = snd_ctl_find_id(card, id);
564 if (kctl == NULL) {
565 ret = -ENOENT;
566 goto unlock;
567 }
568 index_offset = snd_ctl_get_ioff(kctl, &kctl->id);
569 vd = &kctl->vd[index_offset];
570 ret = 0;
571 if (active) {
572 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE))
573 goto unlock;
574 vd->access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
575 } else {
576 if (vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE)
577 goto unlock;
578 vd->access |= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
579 }
580 ret = 1;
581 unlock:
582 up_write(&card->controls_rwsem);
583 if (ret > 0)
584 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_INFO, id);
585 return ret;
586}
587EXPORT_SYMBOL_GPL(snd_ctl_activate_id);
588
589/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 * snd_ctl_rename_id - replace the id of a control on the card
591 * @card: the card instance
592 * @src_id: the old id
593 * @dst_id: the new id
594 *
595 * Finds the control with the old id from the card, and replaces the
596 * id with the new one.
597 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100598 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100600int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
601 struct snd_ctl_elem_id *dst_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100603 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
605 down_write(&card->controls_rwsem);
606 kctl = snd_ctl_find_id(card, src_id);
607 if (kctl == NULL) {
608 up_write(&card->controls_rwsem);
609 return -ENOENT;
610 }
611 kctl->id = *dst_id;
612 kctl->id.numid = card->last_numid + 1;
613 card->last_numid += kctl->count;
614 up_write(&card->controls_rwsem);
615 return 0;
616}
617
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200618EXPORT_SYMBOL(snd_ctl_rename_id);
619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620/**
621 * snd_ctl_find_numid - find the control instance with the given number-id
622 * @card: the card instance
623 * @numid: the number-id to search
624 *
625 * Finds the control instance with the given number-id from the card.
626 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 * The caller must down card->controls_rwsem before calling this function
628 * (if the race condition can happen).
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100629 *
630 * Return: The pointer of the instance if found, or %NULL if not.
631 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100633struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100635 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200637 if (snd_BUG_ON(!card || !numid))
638 return NULL;
Johannes Berg9244b2c2006-10-05 16:02:22 +0200639 list_for_each_entry(kctl, &card->controls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
641 return kctl;
642 }
643 return NULL;
644}
645
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200646EXPORT_SYMBOL(snd_ctl_find_numid);
647
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648/**
649 * snd_ctl_find_id - find the control instance with the given id
650 * @card: the card instance
651 * @id: the id to search
652 *
653 * Finds the control instance with the given id from the card.
654 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 * The caller must down card->controls_rwsem before calling this function
656 * (if the race condition can happen).
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100657 *
658 * Return: The pointer of the instance if found, or %NULL if not.
659 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100661struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
662 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100664 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200666 if (snd_BUG_ON(!card || !id))
667 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 if (id->numid != 0)
669 return snd_ctl_find_numid(card, id->numid);
Johannes Berg9244b2c2006-10-05 16:02:22 +0200670 list_for_each_entry(kctl, &card->controls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 if (kctl->id.iface != id->iface)
672 continue;
673 if (kctl->id.device != id->device)
674 continue;
675 if (kctl->id.subdevice != id->subdevice)
676 continue;
677 if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
678 continue;
679 if (kctl->id.index > id->index)
680 continue;
681 if (kctl->id.index + kctl->count <= id->index)
682 continue;
683 return kctl;
684 }
685 return NULL;
686}
687
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200688EXPORT_SYMBOL(snd_ctl_find_id);
689
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100690static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 unsigned int cmd, void __user *arg)
692{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100693 struct snd_ctl_card_info *info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Takashi Iwaica2c0962005-09-09 14:20:23 +0200695 info = kzalloc(sizeof(*info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 if (! info)
697 return -ENOMEM;
698 down_read(&snd_ioctl_rwsem);
699 info->card = card->number;
700 strlcpy(info->id, card->id, sizeof(info->id));
701 strlcpy(info->driver, card->driver, sizeof(info->driver));
702 strlcpy(info->name, card->shortname, sizeof(info->name));
703 strlcpy(info->longname, card->longname, sizeof(info->longname));
704 strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
705 strlcpy(info->components, card->components, sizeof(info->components));
706 up_read(&snd_ioctl_rwsem);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100707 if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 kfree(info);
709 return -EFAULT;
710 }
711 kfree(info);
712 return 0;
713}
714
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100715static int snd_ctl_elem_list(struct snd_card *card,
716 struct snd_ctl_elem_list __user *_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717{
718 struct list_head *plist;
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100719 struct snd_ctl_elem_list list;
720 struct snd_kcontrol *kctl;
721 struct snd_ctl_elem_id *dst, *id;
Luca Tettamanti78fa2c42011-05-25 22:43:27 +0200722 unsigned int offset, space, jidx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724 if (copy_from_user(&list, _list, sizeof(list)))
725 return -EFAULT;
726 offset = list.offset;
727 space = list.space;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 /* try limit maximum space */
729 if (space > 16384)
730 return -ENOMEM;
731 if (space > 0) {
732 /* allocate temporary buffer for atomic operation */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100733 dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 if (dst == NULL)
735 return -ENOMEM;
736 down_read(&card->controls_rwsem);
737 list.count = card->controls_count;
738 plist = card->controls.next;
739 while (plist != &card->controls) {
740 if (offset == 0)
741 break;
742 kctl = snd_kcontrol(plist);
743 if (offset < kctl->count)
744 break;
745 offset -= kctl->count;
746 plist = plist->next;
747 }
748 list.used = 0;
749 id = dst;
750 while (space > 0 && plist != &card->controls) {
751 kctl = snd_kcontrol(plist);
752 for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
753 snd_ctl_build_ioff(id, kctl, jidx);
754 id++;
755 space--;
756 list.used++;
757 }
758 plist = plist->next;
759 offset = 0;
760 }
761 up_read(&card->controls_rwsem);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100762 if (list.used > 0 &&
763 copy_to_user(list.pids, dst,
764 list.used * sizeof(struct snd_ctl_elem_id))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 vfree(dst);
766 return -EFAULT;
767 }
768 vfree(dst);
769 } else {
770 down_read(&card->controls_rwsem);
771 list.count = card->controls_count;
772 up_read(&card->controls_rwsem);
773 }
774 if (copy_to_user(_list, &list, sizeof(list)))
775 return -EFAULT;
776 return 0;
777}
778
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100779static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
780 struct snd_ctl_elem_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100782 struct snd_card *card = ctl->card;
783 struct snd_kcontrol *kctl;
784 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 unsigned int index_offset;
786 int result;
787
788 down_read(&card->controls_rwsem);
789 kctl = snd_ctl_find_id(card, &info->id);
790 if (kctl == NULL) {
791 up_read(&card->controls_rwsem);
792 return -ENOENT;
793 }
794#ifdef CONFIG_SND_DEBUG
795 info->access = 0;
796#endif
797 result = kctl->info(kctl, info);
798 if (result >= 0) {
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200799 snd_BUG_ON(info->access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 index_offset = snd_ctl_get_ioff(kctl, &info->id);
801 vd = &kctl->vd[index_offset];
802 snd_ctl_build_ioff(&info->id, kctl, index_offset);
803 info->access = vd->access;
804 if (vd->owner) {
805 info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
806 if (vd->owner == ctl)
807 info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
Clemens Ladisch25d27ed2009-11-02 09:35:44 +0100808 info->owner = pid_vnr(vd->owner->pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 } else {
810 info->owner = -1;
811 }
812 }
813 up_read(&card->controls_rwsem);
814 return result;
815}
816
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100817static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
818 struct snd_ctl_elem_info __user *_info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100820 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 int result;
822
823 if (copy_from_user(&info, _info, sizeof(info)))
824 return -EFAULT;
Giuliano Pochini64649402006-03-13 14:11:11 +0100825 snd_power_lock(ctl->card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200826 result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100827 if (result >= 0)
828 result = snd_ctl_elem_info(ctl, &info);
829 snd_power_unlock(ctl->card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 if (result >= 0)
831 if (copy_to_user(_info, &info, sizeof(info)))
832 return -EFAULT;
833 return result;
834}
835
Takashi Iwaid3bd67c2008-06-12 18:17:26 +0200836static int snd_ctl_elem_read(struct snd_card *card,
837 struct snd_ctl_elem_value *control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100839 struct snd_kcontrol *kctl;
840 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 unsigned int index_offset;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100842 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
844 down_read(&card->controls_rwsem);
845 kctl = snd_ctl_find_id(card, &control->id);
846 if (kctl == NULL) {
847 result = -ENOENT;
848 } else {
849 index_offset = snd_ctl_get_ioff(kctl, &control->id);
850 vd = &kctl->vd[index_offset];
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100851 if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) &&
852 kctl->get != NULL) {
853 snd_ctl_build_ioff(&control->id, kctl, index_offset);
854 result = kctl->get(kctl, control);
855 } else
856 result = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 }
858 up_read(&card->controls_rwsem);
859 return result;
860}
861
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100862static int snd_ctl_elem_read_user(struct snd_card *card,
863 struct snd_ctl_elem_value __user *_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100865 struct snd_ctl_elem_value *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 int result;
Li Zefanef44a1e2009-04-10 09:43:08 +0800867
868 control = memdup_user(_control, sizeof(*control));
869 if (IS_ERR(control))
870 return PTR_ERR(control);
871
Giuliano Pochini64649402006-03-13 14:11:11 +0100872 snd_power_lock(card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200873 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100874 if (result >= 0)
875 result = snd_ctl_elem_read(card, control);
876 snd_power_unlock(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 if (result >= 0)
878 if (copy_to_user(_control, control, sizeof(*control)))
879 result = -EFAULT;
880 kfree(control);
881 return result;
882}
883
Takashi Iwaid3bd67c2008-06-12 18:17:26 +0200884static int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
885 struct snd_ctl_elem_value *control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100887 struct snd_kcontrol *kctl;
888 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 unsigned int index_offset;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100890 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
892 down_read(&card->controls_rwsem);
893 kctl = snd_ctl_find_id(card, &control->id);
894 if (kctl == NULL) {
895 result = -ENOENT;
896 } else {
897 index_offset = snd_ctl_get_ioff(kctl, &control->id);
898 vd = &kctl->vd[index_offset];
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100899 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
900 kctl->put == NULL ||
901 (file && vd->owner && vd->owner != file)) {
902 result = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 } else {
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100904 snd_ctl_build_ioff(&control->id, kctl, index_offset);
905 result = kctl->put(kctl, control);
906 }
907 if (result > 0) {
Lars-Peter Clausenfd9f26e2014-06-18 13:32:33 +0200908 struct snd_ctl_elem_id id = control->id;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100909 up_read(&card->controls_rwsem);
Lars-Peter Clausenfd9f26e2014-06-18 13:32:33 +0200910 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE, &id);
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100911 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 }
913 }
914 up_read(&card->controls_rwsem);
915 return result;
916}
917
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100918static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
919 struct snd_ctl_elem_value __user *_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100921 struct snd_ctl_elem_value *control;
Giuliano Pochini64649402006-03-13 14:11:11 +0100922 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 int result;
924
Li Zefanef44a1e2009-04-10 09:43:08 +0800925 control = memdup_user(_control, sizeof(*control));
926 if (IS_ERR(control))
927 return PTR_ERR(control);
928
Giuliano Pochini64649402006-03-13 14:11:11 +0100929 card = file->card;
930 snd_power_lock(card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200931 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100932 if (result >= 0)
933 result = snd_ctl_elem_write(card, file, control);
934 snd_power_unlock(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 if (result >= 0)
936 if (copy_to_user(_control, control, sizeof(*control)))
937 result = -EFAULT;
938 kfree(control);
939 return result;
940}
941
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100942static int snd_ctl_elem_lock(struct snd_ctl_file *file,
943 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100945 struct snd_card *card = file->card;
946 struct snd_ctl_elem_id id;
947 struct snd_kcontrol *kctl;
948 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 int result;
950
951 if (copy_from_user(&id, _id, sizeof(id)))
952 return -EFAULT;
953 down_write(&card->controls_rwsem);
954 kctl = snd_ctl_find_id(card, &id);
955 if (kctl == NULL) {
956 result = -ENOENT;
957 } else {
958 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
959 if (vd->owner != NULL)
960 result = -EBUSY;
961 else {
962 vd->owner = file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 result = 0;
964 }
965 }
966 up_write(&card->controls_rwsem);
967 return result;
968}
969
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100970static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
971 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100973 struct snd_card *card = file->card;
974 struct snd_ctl_elem_id id;
975 struct snd_kcontrol *kctl;
976 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 int result;
978
979 if (copy_from_user(&id, _id, sizeof(id)))
980 return -EFAULT;
981 down_write(&card->controls_rwsem);
982 kctl = snd_ctl_find_id(card, &id);
983 if (kctl == NULL) {
984 result = -ENOENT;
985 } else {
986 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
987 if (vd->owner == NULL)
988 result = -EINVAL;
989 else if (vd->owner != file)
990 result = -EPERM;
991 else {
992 vd->owner = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 result = 0;
994 }
995 }
996 up_write(&card->controls_rwsem);
997 return result;
998}
999
1000struct user_element {
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001001 struct snd_ctl_elem_info info;
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +02001002 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 void *elem_data; /* element data */
1004 unsigned long elem_data_size; /* size of element data in bytes */
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001005 void *tlv_data; /* TLV data */
1006 unsigned long tlv_data_size; /* TLV data size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 void *priv_data; /* private data (like strings for enumerated type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008};
1009
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001010static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
1011 struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012{
1013 struct user_element *ue = kcontrol->private_data;
1014
1015 *uinfo = ue->info;
1016 return 0;
1017}
1018
Clemens Ladisch8d448162011-10-07 22:38:59 +02001019static int snd_ctl_elem_user_enum_info(struct snd_kcontrol *kcontrol,
1020 struct snd_ctl_elem_info *uinfo)
1021{
1022 struct user_element *ue = kcontrol->private_data;
1023 const char *names;
1024 unsigned int item;
1025
1026 item = uinfo->value.enumerated.item;
1027
1028 *uinfo = ue->info;
1029
1030 item = min(item, uinfo->value.enumerated.items - 1);
1031 uinfo->value.enumerated.item = item;
1032
1033 names = ue->priv_data;
1034 for (; item > 0; --item)
1035 names += strlen(names) + 1;
1036 strcpy(uinfo->value.enumerated.name, names);
1037
1038 return 0;
1039}
1040
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001041static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
1042 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043{
1044 struct user_element *ue = kcontrol->private_data;
1045
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +02001046 mutex_lock(&ue->card->user_ctl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +02001048 mutex_unlock(&ue->card->user_ctl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 return 0;
1050}
1051
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001052static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
1053 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054{
1055 int change;
1056 struct user_element *ue = kcontrol->private_data;
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +02001057
1058 mutex_lock(&ue->card->user_ctl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
1060 if (change)
1061 memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +02001062 mutex_unlock(&ue->card->user_ctl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 return change;
1064}
1065
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001066static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
1067 int op_flag,
1068 unsigned int size,
1069 unsigned int __user *tlv)
1070{
1071 struct user_element *ue = kcontrol->private_data;
1072 int change = 0;
1073 void *new_data;
1074
1075 if (op_flag > 0) {
1076 if (size > 1024 * 128) /* sane value */
1077 return -EINVAL;
Li Zefanef44a1e2009-04-10 09:43:08 +08001078
1079 new_data = memdup_user(tlv, size);
1080 if (IS_ERR(new_data))
1081 return PTR_ERR(new_data);
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +02001082 mutex_lock(&ue->card->user_ctl_lock);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001083 change = ue->tlv_data_size != size;
1084 if (!change)
1085 change = memcmp(ue->tlv_data, new_data, size);
1086 kfree(ue->tlv_data);
1087 ue->tlv_data = new_data;
1088 ue->tlv_data_size = size;
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +02001089 mutex_unlock(&ue->card->user_ctl_lock);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001090 } else {
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +02001091 int ret = 0;
1092
1093 mutex_lock(&ue->card->user_ctl_lock);
1094 if (!ue->tlv_data_size || !ue->tlv_data) {
1095 ret = -ENXIO;
1096 goto err_unlock;
1097 }
1098 if (size < ue->tlv_data_size) {
1099 ret = -ENOSPC;
1100 goto err_unlock;
1101 }
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001102 if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +02001103 ret = -EFAULT;
1104err_unlock:
1105 mutex_unlock(&ue->card->user_ctl_lock);
1106 if (ret)
1107 return ret;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001108 }
1109 return change;
1110}
1111
Clemens Ladisch8d448162011-10-07 22:38:59 +02001112static int snd_ctl_elem_init_enum_names(struct user_element *ue)
1113{
1114 char *names, *p;
1115 size_t buf_len, name_len;
1116 unsigned int i;
Olof Johansson447c6f92011-11-05 22:51:54 +01001117 const uintptr_t user_ptrval = ue->info.value.enumerated.names_ptr;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001118
1119 if (ue->info.value.enumerated.names_length > 64 * 1024)
1120 return -EINVAL;
1121
Olof Johansson447c6f92011-11-05 22:51:54 +01001122 names = memdup_user((const void __user *)user_ptrval,
Clemens Ladisch8d448162011-10-07 22:38:59 +02001123 ue->info.value.enumerated.names_length);
1124 if (IS_ERR(names))
1125 return PTR_ERR(names);
1126
1127 /* check that there are enough valid names */
1128 buf_len = ue->info.value.enumerated.names_length;
1129 p = names;
1130 for (i = 0; i < ue->info.value.enumerated.items; ++i) {
1131 name_len = strnlen(p, buf_len);
1132 if (name_len == 0 || name_len >= 64 || name_len == buf_len) {
1133 kfree(names);
1134 return -EINVAL;
1135 }
1136 p += name_len + 1;
1137 buf_len -= name_len + 1;
1138 }
1139
1140 ue->priv_data = names;
1141 ue->info.value.enumerated.names_ptr = 0;
1142
1143 return 0;
1144}
1145
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001146static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147{
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001148 struct user_element *ue = kcontrol->private_data;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001149
1150 kfree(ue->tlv_data);
1151 kfree(ue->priv_data);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001152 kfree(ue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153}
1154
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001155static int snd_ctl_elem_add(struct snd_ctl_file *file,
1156 struct snd_ctl_elem_info *info, int replace)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001158 struct snd_card *card = file->card;
1159 struct snd_kcontrol kctl, *_kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 unsigned int access;
1161 long private_size;
1162 struct user_element *ue;
1163 int idx, err;
Lu Guanqun983929c2011-08-24 11:12:34 +08001164
Clemens Ladisch2a031ae2009-08-17 12:25:52 +02001165 if (info->count < 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 return -EINVAL;
1167 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001168 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001169 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
1170 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 info->id.numid = 0;
1172 memset(&kctl, 0, sizeof(kctl));
Lars-Peter Clausen82262a462014-06-18 13:32:32 +02001173
1174 if (replace) {
1175 err = snd_ctl_remove_user_ctl(file, &info->id);
1176 if (err)
1177 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 }
Lars-Peter Clausen82262a462014-06-18 13:32:32 +02001179
1180 if (card->user_ctl_count >= MAX_USER_CONTROLS)
1181 return -ENOMEM;
1182
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 memcpy(&kctl.id, &info->id, sizeof(info->id));
1184 kctl.count = info->owner ? info->owner : 1;
1185 access |= SNDRV_CTL_ELEM_ACCESS_USER;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001186 if (info->type == SNDRV_CTL_ELEM_TYPE_ENUMERATED)
1187 kctl.info = snd_ctl_elem_user_enum_info;
1188 else
1189 kctl.info = snd_ctl_elem_user_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
1191 kctl.get = snd_ctl_elem_user_get;
1192 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
1193 kctl.put = snd_ctl_elem_user_put;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001194 if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
1195 kctl.tlv.c = snd_ctl_elem_user_tlv;
1196 access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1197 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 switch (info->type) {
1199 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 case SNDRV_CTL_ELEM_TYPE_INTEGER:
1201 private_size = sizeof(long);
1202 if (info->count > 128)
1203 return -EINVAL;
1204 break;
1205 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1206 private_size = sizeof(long long);
1207 if (info->count > 64)
1208 return -EINVAL;
1209 break;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001210 case SNDRV_CTL_ELEM_TYPE_ENUMERATED:
1211 private_size = sizeof(unsigned int);
1212 if (info->count > 128 || info->value.enumerated.items == 0)
1213 return -EINVAL;
1214 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 case SNDRV_CTL_ELEM_TYPE_BYTES:
1216 private_size = sizeof(unsigned char);
1217 if (info->count > 512)
1218 return -EINVAL;
1219 break;
1220 case SNDRV_CTL_ELEM_TYPE_IEC958:
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001221 private_size = sizeof(struct snd_aes_iec958);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 if (info->count != 1)
1223 return -EINVAL;
1224 break;
1225 default:
1226 return -EINVAL;
1227 }
1228 private_size *= info->count;
Takashi Iwaica2c0962005-09-09 14:20:23 +02001229 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 if (ue == NULL)
1231 return -ENOMEM;
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +02001232 ue->card = card;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 ue->info = *info;
Takashi Iwai86148e82006-08-24 12:36:36 +02001234 ue->info.access = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 ue->elem_data = (char *)ue + sizeof(*ue);
1236 ue->elem_data_size = private_size;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001237 if (ue->info.type == SNDRV_CTL_ELEM_TYPE_ENUMERATED) {
1238 err = snd_ctl_elem_init_enum_names(ue);
1239 if (err < 0) {
1240 kfree(ue);
1241 return err;
1242 }
1243 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 kctl.private_free = snd_ctl_elem_user_free;
1245 _kctl = snd_ctl_new(&kctl, access);
1246 if (_kctl == NULL) {
Clemens Ladisch8d448162011-10-07 22:38:59 +02001247 kfree(ue->priv_data);
Takashi Iwai2fbf1822006-03-06 15:42:51 -08001248 kfree(ue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 return -ENOMEM;
1250 }
1251 _kctl->private_data = ue;
1252 for (idx = 0; idx < _kctl->count; idx++)
1253 _kctl->vd[idx].owner = file;
1254 err = snd_ctl_add(card, _kctl);
Takashi Iwai2fbf1822006-03-06 15:42:51 -08001255 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257
1258 down_write(&card->controls_rwsem);
1259 card->user_ctl_count++;
1260 up_write(&card->controls_rwsem);
1261
1262 return 0;
1263}
1264
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001265static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1266 struct snd_ctl_elem_info __user *_info, int replace)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001268 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 if (copy_from_user(&info, _info, sizeof(info)))
1270 return -EFAULT;
1271 return snd_ctl_elem_add(file, &info, replace);
1272}
1273
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001274static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1275 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001277 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278
1279 if (copy_from_user(&id, _id, sizeof(id)))
1280 return -EFAULT;
Clemens Ladischf217ac52009-08-17 12:27:22 +02001281 return snd_ctl_remove_user_ctl(file, &id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282}
1283
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001284static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285{
1286 int subscribe;
1287 if (get_user(subscribe, ptr))
1288 return -EFAULT;
1289 if (subscribe < 0) {
1290 subscribe = file->subscribed;
1291 if (put_user(subscribe, ptr))
1292 return -EFAULT;
1293 return 0;
1294 }
1295 if (subscribe) {
1296 file->subscribed = 1;
1297 return 0;
1298 } else if (file->subscribed) {
1299 snd_ctl_empty_read_queue(file);
1300 file->subscribed = 0;
1301 }
1302 return 0;
1303}
1304
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001305static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1306 struct snd_ctl_tlv __user *_tlv,
1307 int op_flag)
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001308{
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001309 struct snd_card *card = file->card;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001310 struct snd_ctl_tlv tlv;
1311 struct snd_kcontrol *kctl;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001312 struct snd_kcontrol_volatile *vd;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001313 unsigned int len;
1314 int err = 0;
1315
1316 if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1317 return -EFAULT;
Clemens Ladisch61236372010-02-01 13:30:56 +01001318 if (tlv.length < sizeof(unsigned int) * 2)
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001319 return -EINVAL;
1320 down_read(&card->controls_rwsem);
1321 kctl = snd_ctl_find_numid(card, tlv.numid);
1322 if (kctl == NULL) {
1323 err = -ENOENT;
1324 goto __kctl_end;
1325 }
1326 if (kctl->tlv.p == NULL) {
1327 err = -ENXIO;
1328 goto __kctl_end;
1329 }
1330 vd = &kctl->vd[tlv.numid - kctl->id.numid];
1331 if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1332 (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1333 (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1334 err = -ENXIO;
1335 goto __kctl_end;
1336 }
1337 if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
Dan Carpenterbec145a2009-11-18 10:31:57 +02001338 if (vd->owner != NULL && vd->owner != file) {
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001339 err = -EPERM;
1340 goto __kctl_end;
1341 }
Jeffrin Josebd483d42012-03-07 22:57:39 +05301342 err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001343 if (err > 0) {
Lars-Peter Clausenfd9f26e2014-06-18 13:32:33 +02001344 struct snd_ctl_elem_id id = kctl->id;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001345 up_read(&card->controls_rwsem);
Lars-Peter Clausenfd9f26e2014-06-18 13:32:33 +02001346 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &id);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001347 return 0;
1348 }
1349 } else {
1350 if (op_flag) {
1351 err = -ENXIO;
1352 goto __kctl_end;
1353 }
1354 len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1355 if (tlv.length < len) {
1356 err = -ENOMEM;
1357 goto __kctl_end;
1358 }
1359 if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1360 err = -EFAULT;
1361 }
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001362 __kctl_end:
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001363 up_read(&card->controls_rwsem);
1364 return err;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001365}
1366
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1368{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001369 struct snd_ctl_file *ctl;
1370 struct snd_card *card;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001371 struct snd_kctl_ioctl *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 void __user *argp = (void __user *)arg;
1373 int __user *ip = argp;
1374 int err;
1375
1376 ctl = file->private_data;
1377 card = ctl->card;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001378 if (snd_BUG_ON(!card))
1379 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 switch (cmd) {
1381 case SNDRV_CTL_IOCTL_PVERSION:
1382 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1383 case SNDRV_CTL_IOCTL_CARD_INFO:
1384 return snd_ctl_card_info(card, ctl, cmd, argp);
1385 case SNDRV_CTL_IOCTL_ELEM_LIST:
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001386 return snd_ctl_elem_list(card, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 case SNDRV_CTL_IOCTL_ELEM_INFO:
1388 return snd_ctl_elem_info_user(ctl, argp);
1389 case SNDRV_CTL_IOCTL_ELEM_READ:
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001390 return snd_ctl_elem_read_user(card, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1392 return snd_ctl_elem_write_user(ctl, argp);
1393 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1394 return snd_ctl_elem_lock(ctl, argp);
1395 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1396 return snd_ctl_elem_unlock(ctl, argp);
1397 case SNDRV_CTL_IOCTL_ELEM_ADD:
1398 return snd_ctl_elem_add_user(ctl, argp, 0);
1399 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1400 return snd_ctl_elem_add_user(ctl, argp, 1);
1401 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1402 return snd_ctl_elem_remove(ctl, argp);
1403 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1404 return snd_ctl_subscribe_events(ctl, ip);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001405 case SNDRV_CTL_IOCTL_TLV_READ:
1406 return snd_ctl_tlv_ioctl(ctl, argp, 0);
1407 case SNDRV_CTL_IOCTL_TLV_WRITE:
1408 return snd_ctl_tlv_ioctl(ctl, argp, 1);
1409 case SNDRV_CTL_IOCTL_TLV_COMMAND:
1410 return snd_ctl_tlv_ioctl(ctl, argp, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 case SNDRV_CTL_IOCTL_POWER:
Takashi Iwaia381a7a2005-11-17 15:55:49 +01001412 return -ENOPROTOOPT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 case SNDRV_CTL_IOCTL_POWER_STATE:
1414#ifdef CONFIG_PM
1415 return put_user(card->power_state, ip) ? -EFAULT : 0;
1416#else
1417 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1418#endif
1419 }
1420 down_read(&snd_ioctl_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001421 list_for_each_entry(p, &snd_control_ioctls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 err = p->fioctl(card, ctl, cmd, arg);
1423 if (err != -ENOIOCTLCMD) {
1424 up_read(&snd_ioctl_rwsem);
1425 return err;
1426 }
1427 }
1428 up_read(&snd_ioctl_rwsem);
Takashi Iwaibb009452014-02-04 18:18:16 +01001429 dev_dbg(card->dev, "unknown ioctl = 0x%x\n", cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 return -ENOTTY;
1431}
1432
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001433static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1434 size_t count, loff_t * offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001436 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 int err = 0;
1438 ssize_t result = 0;
1439
1440 ctl = file->private_data;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001441 if (snd_BUG_ON(!ctl || !ctl->card))
1442 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 if (!ctl->subscribed)
1444 return -EBADFD;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001445 if (count < sizeof(struct snd_ctl_event))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 return -EINVAL;
1447 spin_lock_irq(&ctl->read_lock);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001448 while (count >= sizeof(struct snd_ctl_event)) {
1449 struct snd_ctl_event ev;
1450 struct snd_kctl_event *kev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 while (list_empty(&ctl->events)) {
1452 wait_queue_t wait;
1453 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1454 err = -EAGAIN;
1455 goto __end_lock;
1456 }
1457 init_waitqueue_entry(&wait, current);
1458 add_wait_queue(&ctl->change_sleep, &wait);
1459 set_current_state(TASK_INTERRUPTIBLE);
1460 spin_unlock_irq(&ctl->read_lock);
1461 schedule();
1462 remove_wait_queue(&ctl->change_sleep, &wait);
Takashi Iwai0914f792012-10-16 16:43:39 +02001463 if (ctl->card->shutdown)
1464 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 if (signal_pending(current))
Adrian Bunk0e5d7202006-11-07 13:42:54 +01001466 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 spin_lock_irq(&ctl->read_lock);
1468 }
1469 kev = snd_kctl_event(ctl->events.next);
1470 ev.type = SNDRV_CTL_EVENT_ELEM;
1471 ev.data.elem.mask = kev->mask;
1472 ev.data.elem.id = kev->id;
1473 list_del(&kev->list);
1474 spin_unlock_irq(&ctl->read_lock);
1475 kfree(kev);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001476 if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 err = -EFAULT;
1478 goto __end;
1479 }
1480 spin_lock_irq(&ctl->read_lock);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001481 buffer += sizeof(struct snd_ctl_event);
1482 count -= sizeof(struct snd_ctl_event);
1483 result += sizeof(struct snd_ctl_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 }
1485 __end_lock:
1486 spin_unlock_irq(&ctl->read_lock);
1487 __end:
1488 return result > 0 ? result : err;
1489}
1490
1491static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1492{
1493 unsigned int mask;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001494 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
1496 ctl = file->private_data;
1497 if (!ctl->subscribed)
1498 return 0;
1499 poll_wait(file, &ctl->change_sleep, wait);
1500
1501 mask = 0;
1502 if (!list_empty(&ctl->events))
1503 mask |= POLLIN | POLLRDNORM;
1504
1505 return mask;
1506}
1507
1508/*
1509 * register the device-specific control-ioctls.
1510 * called from each device manager like pcm.c, hwdep.c, etc.
1511 */
1512static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1513{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001514 struct snd_kctl_ioctl *pn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001516 pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 if (pn == NULL)
1518 return -ENOMEM;
1519 pn->fioctl = fcn;
1520 down_write(&snd_ioctl_rwsem);
1521 list_add_tail(&pn->list, lists);
1522 up_write(&snd_ioctl_rwsem);
1523 return 0;
1524}
1525
1526int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1527{
1528 return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1529}
1530
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001531EXPORT_SYMBOL(snd_ctl_register_ioctl);
1532
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533#ifdef CONFIG_COMPAT
1534int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1535{
1536 return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1537}
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001538
1539EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540#endif
1541
1542/*
1543 * de-register the device-specific control-ioctls.
1544 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001545static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1546 struct list_head *lists)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001548 struct snd_kctl_ioctl *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001550 if (snd_BUG_ON(!fcn))
1551 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 down_write(&snd_ioctl_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001553 list_for_each_entry(p, lists, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 if (p->fioctl == fcn) {
1555 list_del(&p->list);
1556 up_write(&snd_ioctl_rwsem);
1557 kfree(p);
1558 return 0;
1559 }
1560 }
1561 up_write(&snd_ioctl_rwsem);
1562 snd_BUG();
1563 return -EINVAL;
1564}
1565
1566int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1567{
1568 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1569}
1570
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001571EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1572
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573#ifdef CONFIG_COMPAT
1574int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1575{
1576 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1577}
1578
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001579EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580#endif
1581
1582static int snd_ctl_fasync(int fd, struct file * file, int on)
1583{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001584 struct snd_ctl_file *ctl;
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001585
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 ctl = file->private_data;
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001587 return fasync_helper(fd, file, on, &ctl->fasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588}
1589
1590/*
1591 * ioctl32 compat
1592 */
1593#ifdef CONFIG_COMPAT
1594#include "control_compat.c"
1595#else
1596#define snd_ctl_ioctl_compat NULL
1597#endif
1598
1599/*
1600 * INIT PART
1601 */
1602
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -08001603static const struct file_operations snd_ctl_f_ops =
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604{
1605 .owner = THIS_MODULE,
1606 .read = snd_ctl_read,
1607 .open = snd_ctl_open,
1608 .release = snd_ctl_release,
Takashi Iwai02f48652010-04-13 11:49:04 +02001609 .llseek = no_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 .poll = snd_ctl_poll,
1611 .unlocked_ioctl = snd_ctl_ioctl,
1612 .compat_ioctl = snd_ctl_ioctl_compat,
1613 .fasync = snd_ctl_fasync,
1614};
1615
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616/*
1617 * registration of the control device
1618 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001619static int snd_ctl_dev_register(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;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 int err, cardnum;
1623 char name[16];
1624
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001625 if (snd_BUG_ON(!card))
1626 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 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 sprintf(name, "controlC%i", cardnum);
Clemens Ladischf87135f2005-11-20 14:06:59 +01001631 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1632 &snd_ctl_f_ops, card, name)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 return err;
1634 return 0;
1635}
1636
1637/*
1638 * disconnection of the control device
1639 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001640static int snd_ctl_dev_disconnect(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001642 struct snd_card *card = device->device_data;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001643 struct snd_ctl_file *ctl;
Takashi Iwaic4614822006-06-23 14:38:23 +02001644 int err, cardnum;
1645
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001646 if (snd_BUG_ON(!card))
1647 return -ENXIO;
Takashi Iwaic4614822006-06-23 14:38:23 +02001648 cardnum = card->number;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001649 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1650 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
Takashi Iwaid8009882008-09-07 12:51:13 +02001652 read_lock(&card->ctl_files_rwlock);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001653 list_for_each_entry(ctl, &card->ctl_files, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 wake_up(&ctl->change_sleep);
1655 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1656 }
Takashi Iwaid8009882008-09-07 12:51:13 +02001657 read_unlock(&card->ctl_files_rwlock);
Takashi Iwaic4614822006-06-23 14:38:23 +02001658
1659 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1660 card, -1)) < 0)
1661 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 return 0;
1663}
1664
1665/*
1666 * free all controls
1667 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001668static int snd_ctl_dev_free(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001670 struct snd_card *card = device->device_data;
1671 struct snd_kcontrol *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672
1673 down_write(&card->controls_rwsem);
1674 while (!list_empty(&card->controls)) {
1675 control = snd_kcontrol(card->controls.next);
1676 snd_ctl_remove(card, control);
1677 }
1678 up_write(&card->controls_rwsem);
1679 return 0;
1680}
1681
1682/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 * create control core:
1684 * called from init.c
1685 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001686int snd_ctl_create(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001688 static struct snd_device_ops ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 .dev_free = snd_ctl_dev_free,
1690 .dev_register = snd_ctl_dev_register,
1691 .dev_disconnect = snd_ctl_dev_disconnect,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 };
1693
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001694 if (snd_BUG_ON(!card))
1695 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
1697}
Takashi Iwaib9ed4f22007-07-23 15:41:34 +02001698
1699/*
Clemens Ladisch96007322011-01-10 16:25:44 +01001700 * Frequently used control callbacks/helpers
Takashi Iwaib9ed4f22007-07-23 15:41:34 +02001701 */
1702int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
1703 struct snd_ctl_elem_info *uinfo)
1704{
1705 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1706 uinfo->count = 1;
1707 uinfo->value.integer.min = 0;
1708 uinfo->value.integer.max = 1;
1709 return 0;
1710}
1711
1712EXPORT_SYMBOL(snd_ctl_boolean_mono_info);
1713
1714int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
1715 struct snd_ctl_elem_info *uinfo)
1716{
1717 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1718 uinfo->count = 2;
1719 uinfo->value.integer.min = 0;
1720 uinfo->value.integer.max = 1;
1721 return 0;
1722}
1723
1724EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);
Clemens Ladisch96007322011-01-10 16:25:44 +01001725
1726/**
1727 * snd_ctl_enum_info - fills the info structure for an enumerated control
1728 * @info: the structure to be filled
1729 * @channels: the number of the control's channels; often one
1730 * @items: the number of control values; also the size of @names
1731 * @names: an array containing the names of all control values
1732 *
1733 * Sets all required fields in @info to their appropriate values.
1734 * If the control's accessibility is not the default (readable and writable),
1735 * the caller has to fill @info->access.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001736 *
1737 * Return: Zero.
Clemens Ladisch96007322011-01-10 16:25:44 +01001738 */
1739int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
1740 unsigned int items, const char *const names[])
1741{
1742 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1743 info->count = channels;
1744 info->value.enumerated.items = items;
1745 if (info->value.enumerated.item >= items)
1746 info->value.enumerated.item = items - 1;
1747 strlcpy(info->value.enumerated.name,
1748 names[info->value.enumerated.item],
1749 sizeof(info->value.enumerated.name));
1750 return 0;
1751}
1752EXPORT_SYMBOL(snd_ctl_enum_info);