blob: f2082a35b8905e5f0a234f62a72e9d38eabdae7e [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);
154#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
155 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 {
173 snd_printk(KERN_ERR "No memory available to allocate event\n");
174 }
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) {
209 snd_printk(KERN_ERR "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)
244 snd_printk(KERN_WARNING
245 "Control name '%s' truncated to '%s'\n",
246 ncontrol->name, kctl.id.name);
247 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 kctl.id.index = ncontrol->index;
249 kctl.count = ncontrol->count ? ncontrol->count : 1;
250 access = ncontrol->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200251 (ncontrol->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
Takashi Iwaia8d372f2012-07-30 13:47:07 +0200252 SNDRV_CTL_ELEM_ACCESS_VOLATILE|
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200253 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
Clemens Ladischa75d7a42010-02-01 13:29:50 +0100254 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE|
255 SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND|
256 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 kctl.info = ncontrol->info;
258 kctl.get = ncontrol->get;
259 kctl.put = ncontrol->put;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +0200260 kctl.tlv.p = ncontrol->tlv.p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 kctl.private_value = ncontrol->private_value;
262 kctl.private_data = private_data;
263 return snd_ctl_new(&kctl, access);
264}
265
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200266EXPORT_SYMBOL(snd_ctl_new1);
267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268/**
269 * snd_ctl_free_one - release the control instance
270 * @kcontrol: the control instance
271 *
272 * Releases the control instance created via snd_ctl_new()
273 * or snd_ctl_new1().
274 * Don't call this after the control was added to the card.
275 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100276void snd_ctl_free_one(struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277{
278 if (kcontrol) {
279 if (kcontrol->private_free)
280 kcontrol->private_free(kcontrol);
281 kfree(kcontrol);
282 }
283}
284
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200285EXPORT_SYMBOL(snd_ctl_free_one);
286
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100287static bool snd_ctl_remove_numid_conflict(struct snd_card *card,
288 unsigned int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100290 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Lars-Peter Clausen02557582014-06-18 13:32:34 +0200292 /* Make sure that the ids assigned to the control do not wrap around */
293 if (card->last_numid >= UINT_MAX - count)
294 card->last_numid = 0;
295
Johannes Berg9244b2c2006-10-05 16:02:22 +0200296 list_for_each_entry(kctl, &card->controls, list) {
Clemens Ladisch7c733582011-03-07 13:22:50 +0100297 if (kctl->id.numid < card->last_numid + 1 + count &&
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100298 kctl->id.numid + kctl->count > card->last_numid + 1) {
299 card->last_numid = kctl->id.numid + kctl->count - 1;
300 return true;
301 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 }
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100303 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304}
305
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100306static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307{
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100308 unsigned int iter = 100000;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
Clemens Ladisch0e82e5f2011-03-07 13:24:30 +0100310 while (snd_ctl_remove_numid_conflict(card, count)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 if (--iter == 0) {
312 /* this situation is very unlikely */
313 snd_printk(KERN_ERR "unable to allocate new control numid\n");
314 return -ENOMEM;
315 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 }
317 return 0;
318}
319
320/**
321 * snd_ctl_add - add the control instance to the card
322 * @card: the card instance
323 * @kcontrol: the control instance to add
324 *
325 * Adds the control instance created via snd_ctl_new() or
326 * snd_ctl_new1() to the given card. Assigns also an unique
327 * numid used for fast search.
328 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 * It frees automatically the control which cannot be added.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100330 *
331 * Return: Zero if successful, or a negative error code on failure.
332 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100334int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100336 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 unsigned int idx;
Lars-Peter Clausen9abd9482014-06-18 13:32:33 +0200338 unsigned int count;
Takashi Iwaic6077b32006-03-21 16:07:13 +0100339 int err = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
Takashi Iwai73e77ba2005-11-17 17:44:01 +0100341 if (! kcontrol)
Takashi Iwaic6077b32006-03-21 16:07:13 +0100342 return err;
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200343 if (snd_BUG_ON(!card || !kcontrol->info))
344 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 id = kcontrol->id;
Lars-Peter Clausen7fba24c2014-06-18 13:32:35 +0200346 if (id.index > UINT_MAX - kcontrol->count)
347 goto error;
348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 down_write(&card->controls_rwsem);
350 if (snd_ctl_find_id(card, &id)) {
351 up_write(&card->controls_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 snd_printd(KERN_ERR "control %i:%i:%i:%s:%i is already present\n",
353 id.iface,
354 id.device,
355 id.subdevice,
356 id.name,
357 id.index);
Takashi Iwaic6077b32006-03-21 16:07:13 +0100358 err = -EBUSY;
359 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 }
361 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
362 up_write(&card->controls_rwsem);
Takashi Iwaic6077b32006-03-21 16:07:13 +0100363 err = -ENOMEM;
364 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 }
366 list_add_tail(&kcontrol->list, &card->controls);
367 card->controls_count += kcontrol->count;
368 kcontrol->id.numid = card->last_numid + 1;
369 card->last_numid += kcontrol->count;
Lars-Peter Clausen9abd9482014-06-18 13:32:33 +0200370 count = kcontrol->count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 up_write(&card->controls_rwsem);
Lars-Peter Clausen9abd9482014-06-18 13:32:33 +0200372 for (idx = 0; idx < count; idx++, id.index++, id.numid++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
374 return 0;
Takashi Iwaic6077b32006-03-21 16:07:13 +0100375
376 error:
377 snd_ctl_free_one(kcontrol);
378 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379}
380
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200381EXPORT_SYMBOL(snd_ctl_add);
382
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383/**
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000384 * snd_ctl_replace - replace the control instance of the card
385 * @card: the card instance
386 * @kcontrol: the control instance to replace
387 * @add_on_replace: add the control if not already added
388 *
389 * Replaces the given control. If the given control does not exist
390 * and the add_on_replace flag is set, the control is added. If the
391 * control exists, it is destroyed first.
392 *
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000393 * It frees automatically the control which cannot be added or replaced.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100394 *
395 * Return: Zero if successful, or a negative error code on failure.
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000396 */
397int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol,
398 bool add_on_replace)
399{
400 struct snd_ctl_elem_id id;
Lars-Peter Clausen9abd9482014-06-18 13:32:33 +0200401 unsigned int count;
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000402 unsigned int idx;
403 struct snd_kcontrol *old;
404 int ret;
405
406 if (!kcontrol)
407 return -EINVAL;
408 if (snd_BUG_ON(!card || !kcontrol->info)) {
409 ret = -EINVAL;
410 goto error;
411 }
412 id = kcontrol->id;
413 down_write(&card->controls_rwsem);
414 old = snd_ctl_find_id(card, &id);
415 if (!old) {
416 if (add_on_replace)
417 goto add;
418 up_write(&card->controls_rwsem);
419 ret = -EINVAL;
420 goto error;
421 }
422 ret = snd_ctl_remove(card, old);
423 if (ret < 0) {
424 up_write(&card->controls_rwsem);
425 goto error;
426 }
427add:
428 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
429 up_write(&card->controls_rwsem);
430 ret = -ENOMEM;
431 goto error;
432 }
433 list_add_tail(&kcontrol->list, &card->controls);
434 card->controls_count += kcontrol->count;
435 kcontrol->id.numid = card->last_numid + 1;
436 card->last_numid += kcontrol->count;
Lars-Peter Clausen9abd9482014-06-18 13:32:33 +0200437 count = kcontrol->count;
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000438 up_write(&card->controls_rwsem);
Lars-Peter Clausen9abd9482014-06-18 13:32:33 +0200439 for (idx = 0; idx < count; idx++, id.index++, id.numid++)
Dimitris Papastamos66b5b972011-03-16 12:16:39 +0000440 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
441 return 0;
442
443error:
444 snd_ctl_free_one(kcontrol);
445 return ret;
446}
447EXPORT_SYMBOL(snd_ctl_replace);
448
449/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 * snd_ctl_remove - remove the control from the card and release it
451 * @card: the card instance
452 * @kcontrol: the control instance to remove
453 *
454 * Removes the control from the card and then releases the instance.
455 * You don't need to call snd_ctl_free_one(). You must be in
456 * the write lock - down_write(&card->controls_rwsem).
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100457 *
458 * Return: 0 if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100460int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100462 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 unsigned int idx;
464
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200465 if (snd_BUG_ON(!card || !kcontrol))
466 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 list_del(&kcontrol->list);
468 card->controls_count -= kcontrol->count;
469 id = kcontrol->id;
470 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
471 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
472 snd_ctl_free_one(kcontrol);
473 return 0;
474}
475
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200476EXPORT_SYMBOL(snd_ctl_remove);
477
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478/**
479 * snd_ctl_remove_id - remove the control of the given id and release it
480 * @card: the card instance
481 * @id: the control id to remove
482 *
483 * Finds the control instance with the given id, removes it from the
484 * card list and releases it.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100485 *
486 * Return: 0 if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100488int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100490 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 int ret;
492
493 down_write(&card->controls_rwsem);
494 kctl = snd_ctl_find_id(card, id);
495 if (kctl == NULL) {
496 up_write(&card->controls_rwsem);
497 return -ENOENT;
498 }
499 ret = snd_ctl_remove(card, kctl);
500 up_write(&card->controls_rwsem);
501 return ret;
502}
503
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200504EXPORT_SYMBOL(snd_ctl_remove_id);
505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506/**
Clemens Ladischf217ac52009-08-17 12:27:22 +0200507 * snd_ctl_remove_user_ctl - remove and release the unlocked user control
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 * @file: active control handle
509 * @id: the control id to remove
510 *
511 * Finds the control instance with the given id, removes it from the
512 * card list and releases it.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100513 *
514 * Return: 0 if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 */
Clemens Ladischf217ac52009-08-17 12:27:22 +0200516static int snd_ctl_remove_user_ctl(struct snd_ctl_file * file,
517 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100519 struct snd_card *card = file->card;
520 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 int idx, ret;
522
523 down_write(&card->controls_rwsem);
524 kctl = snd_ctl_find_id(card, id);
525 if (kctl == NULL) {
Clemens Ladisch317b8082009-08-17 12:26:34 +0200526 ret = -ENOENT;
527 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 }
Clemens Ladisch18dd0aa2009-08-17 12:28:09 +0200529 if (!(kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_USER)) {
530 ret = -EINVAL;
531 goto error;
532 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 for (idx = 0; idx < kctl->count; idx++)
534 if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
Clemens Ladisch317b8082009-08-17 12:26:34 +0200535 ret = -EBUSY;
536 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 }
538 ret = snd_ctl_remove(card, kctl);
Clemens Ladischf217ac52009-08-17 12:27:22 +0200539 if (ret < 0)
540 goto error;
541 card->user_ctl_count--;
Clemens Ladisch317b8082009-08-17 12:26:34 +0200542error:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 up_write(&card->controls_rwsem);
544 return ret;
545}
546
547/**
Takashi Iwai3cbdd752008-08-29 16:09:01 +0200548 * snd_ctl_activate_id - activate/inactivate the control of the given id
549 * @card: the card instance
550 * @id: the control id to activate/inactivate
551 * @active: non-zero to activate
552 *
553 * Finds the control instance with the given id, and activate or
554 * inactivate the control together with notification, if changed.
555 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100556 * Return: 0 if unchanged, 1 if changed, or a negative error code on failure.
Takashi Iwai3cbdd752008-08-29 16:09:01 +0200557 */
558int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
559 int active)
560{
561 struct snd_kcontrol *kctl;
562 struct snd_kcontrol_volatile *vd;
563 unsigned int index_offset;
564 int ret;
565
566 down_write(&card->controls_rwsem);
567 kctl = snd_ctl_find_id(card, id);
568 if (kctl == NULL) {
569 ret = -ENOENT;
570 goto unlock;
571 }
572 index_offset = snd_ctl_get_ioff(kctl, &kctl->id);
573 vd = &kctl->vd[index_offset];
574 ret = 0;
575 if (active) {
576 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE))
577 goto unlock;
578 vd->access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
579 } else {
580 if (vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE)
581 goto unlock;
582 vd->access |= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
583 }
584 ret = 1;
585 unlock:
586 up_write(&card->controls_rwsem);
587 if (ret > 0)
588 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_INFO, id);
589 return ret;
590}
591EXPORT_SYMBOL_GPL(snd_ctl_activate_id);
592
593/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 * snd_ctl_rename_id - replace the id of a control on the card
595 * @card: the card instance
596 * @src_id: the old id
597 * @dst_id: the new id
598 *
599 * Finds the control with the old id from the card, and replaces the
600 * id with the new one.
601 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100602 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100604int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
605 struct snd_ctl_elem_id *dst_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100607 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
609 down_write(&card->controls_rwsem);
610 kctl = snd_ctl_find_id(card, src_id);
611 if (kctl == NULL) {
612 up_write(&card->controls_rwsem);
613 return -ENOENT;
614 }
615 kctl->id = *dst_id;
616 kctl->id.numid = card->last_numid + 1;
617 card->last_numid += kctl->count;
618 up_write(&card->controls_rwsem);
619 return 0;
620}
621
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200622EXPORT_SYMBOL(snd_ctl_rename_id);
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624/**
625 * snd_ctl_find_numid - find the control instance with the given number-id
626 * @card: the card instance
627 * @numid: the number-id to search
628 *
629 * Finds the control instance with the given number-id from the card.
630 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 * The caller must down card->controls_rwsem before calling this function
632 * (if the race condition can happen).
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100633 *
634 * Return: The pointer of the instance if found, or %NULL if not.
635 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100637struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100639 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200641 if (snd_BUG_ON(!card || !numid))
642 return NULL;
Johannes Berg9244b2c2006-10-05 16:02:22 +0200643 list_for_each_entry(kctl, &card->controls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
645 return kctl;
646 }
647 return NULL;
648}
649
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200650EXPORT_SYMBOL(snd_ctl_find_numid);
651
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652/**
653 * snd_ctl_find_id - find the control instance with the given id
654 * @card: the card instance
655 * @id: the id to search
656 *
657 * Finds the control instance with the given id from the card.
658 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 * The caller must down card->controls_rwsem before calling this function
660 * (if the race condition can happen).
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100661 *
662 * Return: The pointer of the instance if found, or %NULL if not.
663 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100665struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
666 struct snd_ctl_elem_id *id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100668 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200670 if (snd_BUG_ON(!card || !id))
671 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 if (id->numid != 0)
673 return snd_ctl_find_numid(card, id->numid);
Johannes Berg9244b2c2006-10-05 16:02:22 +0200674 list_for_each_entry(kctl, &card->controls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 if (kctl->id.iface != id->iface)
676 continue;
677 if (kctl->id.device != id->device)
678 continue;
679 if (kctl->id.subdevice != id->subdevice)
680 continue;
681 if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
682 continue;
683 if (kctl->id.index > id->index)
684 continue;
685 if (kctl->id.index + kctl->count <= id->index)
686 continue;
687 return kctl;
688 }
689 return NULL;
690}
691
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200692EXPORT_SYMBOL(snd_ctl_find_id);
693
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100694static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 unsigned int cmd, void __user *arg)
696{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100697 struct snd_ctl_card_info *info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
Takashi Iwaica2c0962005-09-09 14:20:23 +0200699 info = kzalloc(sizeof(*info), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 if (! info)
701 return -ENOMEM;
702 down_read(&snd_ioctl_rwsem);
703 info->card = card->number;
704 strlcpy(info->id, card->id, sizeof(info->id));
705 strlcpy(info->driver, card->driver, sizeof(info->driver));
706 strlcpy(info->name, card->shortname, sizeof(info->name));
707 strlcpy(info->longname, card->longname, sizeof(info->longname));
708 strlcpy(info->mixername, card->mixername, sizeof(info->mixername));
709 strlcpy(info->components, card->components, sizeof(info->components));
710 up_read(&snd_ioctl_rwsem);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100711 if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 kfree(info);
713 return -EFAULT;
714 }
715 kfree(info);
716 return 0;
717}
718
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100719static int snd_ctl_elem_list(struct snd_card *card,
720 struct snd_ctl_elem_list __user *_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721{
722 struct list_head *plist;
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100723 struct snd_ctl_elem_list list;
724 struct snd_kcontrol *kctl;
725 struct snd_ctl_elem_id *dst, *id;
Luca Tettamanti78fa2c42011-05-25 22:43:27 +0200726 unsigned int offset, space, jidx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
728 if (copy_from_user(&list, _list, sizeof(list)))
729 return -EFAULT;
730 offset = list.offset;
731 space = list.space;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 /* try limit maximum space */
733 if (space > 16384)
734 return -ENOMEM;
735 if (space > 0) {
736 /* allocate temporary buffer for atomic operation */
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100737 dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 if (dst == NULL)
739 return -ENOMEM;
740 down_read(&card->controls_rwsem);
741 list.count = card->controls_count;
742 plist = card->controls.next;
743 while (plist != &card->controls) {
744 if (offset == 0)
745 break;
746 kctl = snd_kcontrol(plist);
747 if (offset < kctl->count)
748 break;
749 offset -= kctl->count;
750 plist = plist->next;
751 }
752 list.used = 0;
753 id = dst;
754 while (space > 0 && plist != &card->controls) {
755 kctl = snd_kcontrol(plist);
756 for (jidx = offset; space > 0 && jidx < kctl->count; jidx++) {
757 snd_ctl_build_ioff(id, kctl, jidx);
758 id++;
759 space--;
760 list.used++;
761 }
762 plist = plist->next;
763 offset = 0;
764 }
765 up_read(&card->controls_rwsem);
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100766 if (list.used > 0 &&
767 copy_to_user(list.pids, dst,
768 list.used * sizeof(struct snd_ctl_elem_id))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 vfree(dst);
770 return -EFAULT;
771 }
772 vfree(dst);
773 } else {
774 down_read(&card->controls_rwsem);
775 list.count = card->controls_count;
776 up_read(&card->controls_rwsem);
777 }
778 if (copy_to_user(_list, &list, sizeof(list)))
779 return -EFAULT;
780 return 0;
781}
782
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100783static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
784 struct snd_ctl_elem_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100786 struct snd_card *card = ctl->card;
787 struct snd_kcontrol *kctl;
788 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 unsigned int index_offset;
790 int result;
791
792 down_read(&card->controls_rwsem);
793 kctl = snd_ctl_find_id(card, &info->id);
794 if (kctl == NULL) {
795 up_read(&card->controls_rwsem);
796 return -ENOENT;
797 }
798#ifdef CONFIG_SND_DEBUG
799 info->access = 0;
800#endif
801 result = kctl->info(kctl, info);
802 if (result >= 0) {
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200803 snd_BUG_ON(info->access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 index_offset = snd_ctl_get_ioff(kctl, &info->id);
805 vd = &kctl->vd[index_offset];
806 snd_ctl_build_ioff(&info->id, kctl, index_offset);
807 info->access = vd->access;
808 if (vd->owner) {
809 info->access |= SNDRV_CTL_ELEM_ACCESS_LOCK;
810 if (vd->owner == ctl)
811 info->access |= SNDRV_CTL_ELEM_ACCESS_OWNER;
Clemens Ladisch25d27ed2009-11-02 09:35:44 +0100812 info->owner = pid_vnr(vd->owner->pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 } else {
814 info->owner = -1;
815 }
816 }
817 up_read(&card->controls_rwsem);
818 return result;
819}
820
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100821static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
822 struct snd_ctl_elem_info __user *_info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100824 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 int result;
826
827 if (copy_from_user(&info, _info, sizeof(info)))
828 return -EFAULT;
Giuliano Pochini64649402006-03-13 14:11:11 +0100829 snd_power_lock(ctl->card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200830 result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100831 if (result >= 0)
832 result = snd_ctl_elem_info(ctl, &info);
833 snd_power_unlock(ctl->card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 if (result >= 0)
835 if (copy_to_user(_info, &info, sizeof(info)))
836 return -EFAULT;
837 return result;
838}
839
Takashi Iwaid3bd67c2008-06-12 18:17:26 +0200840static int snd_ctl_elem_read(struct snd_card *card,
841 struct snd_ctl_elem_value *control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100843 struct snd_kcontrol *kctl;
844 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 unsigned int index_offset;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100846 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
848 down_read(&card->controls_rwsem);
849 kctl = snd_ctl_find_id(card, &control->id);
850 if (kctl == NULL) {
851 result = -ENOENT;
852 } else {
853 index_offset = snd_ctl_get_ioff(kctl, &control->id);
854 vd = &kctl->vd[index_offset];
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100855 if ((vd->access & SNDRV_CTL_ELEM_ACCESS_READ) &&
856 kctl->get != NULL) {
857 snd_ctl_build_ioff(&control->id, kctl, index_offset);
858 result = kctl->get(kctl, control);
859 } else
860 result = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 }
862 up_read(&card->controls_rwsem);
863 return result;
864}
865
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100866static int snd_ctl_elem_read_user(struct snd_card *card,
867 struct snd_ctl_elem_value __user *_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100869 struct snd_ctl_elem_value *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 int result;
Li Zefanef44a1e2009-04-10 09:43:08 +0800871
872 control = memdup_user(_control, sizeof(*control));
873 if (IS_ERR(control))
874 return PTR_ERR(control);
875
Giuliano Pochini64649402006-03-13 14:11:11 +0100876 snd_power_lock(card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200877 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100878 if (result >= 0)
879 result = snd_ctl_elem_read(card, control);
880 snd_power_unlock(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 if (result >= 0)
882 if (copy_to_user(_control, control, sizeof(*control)))
883 result = -EFAULT;
884 kfree(control);
885 return result;
886}
887
Takashi Iwaid3bd67c2008-06-12 18:17:26 +0200888static int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
889 struct snd_ctl_elem_value *control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100891 struct snd_kcontrol *kctl;
892 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 unsigned int index_offset;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100894 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
896 down_read(&card->controls_rwsem);
897 kctl = snd_ctl_find_id(card, &control->id);
898 if (kctl == NULL) {
899 result = -ENOENT;
900 } else {
901 index_offset = snd_ctl_get_ioff(kctl, &control->id);
902 vd = &kctl->vd[index_offset];
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100903 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
904 kctl->put == NULL ||
905 (file && vd->owner && vd->owner != file)) {
906 result = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 } else {
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100908 snd_ctl_build_ioff(&control->id, kctl, index_offset);
909 result = kctl->put(kctl, control);
910 }
911 if (result > 0) {
Lars-Peter Clausen9abd9482014-06-18 13:32:33 +0200912 struct snd_ctl_elem_id id = control->id;
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100913 up_read(&card->controls_rwsem);
Lars-Peter Clausen9abd9482014-06-18 13:32:33 +0200914 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE, &id);
Takashi Iwai8ace4f32008-01-08 17:57:26 +0100915 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 }
917 }
918 up_read(&card->controls_rwsem);
919 return result;
920}
921
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100922static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
923 struct snd_ctl_elem_value __user *_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100925 struct snd_ctl_elem_value *control;
Giuliano Pochini64649402006-03-13 14:11:11 +0100926 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 int result;
928
Li Zefanef44a1e2009-04-10 09:43:08 +0800929 control = memdup_user(_control, sizeof(*control));
930 if (IS_ERR(control))
931 return PTR_ERR(control);
932
Giuliano Pochini64649402006-03-13 14:11:11 +0100933 card = file->card;
934 snd_power_lock(card);
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200935 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
Giuliano Pochini64649402006-03-13 14:11:11 +0100936 if (result >= 0)
937 result = snd_ctl_elem_write(card, file, control);
938 snd_power_unlock(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 if (result >= 0)
940 if (copy_to_user(_control, control, sizeof(*control)))
941 result = -EFAULT;
942 kfree(control);
943 return result;
944}
945
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100946static int snd_ctl_elem_lock(struct snd_ctl_file *file,
947 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100949 struct snd_card *card = file->card;
950 struct snd_ctl_elem_id id;
951 struct snd_kcontrol *kctl;
952 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 int result;
954
955 if (copy_from_user(&id, _id, sizeof(id)))
956 return -EFAULT;
957 down_write(&card->controls_rwsem);
958 kctl = snd_ctl_find_id(card, &id);
959 if (kctl == NULL) {
960 result = -ENOENT;
961 } else {
962 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
963 if (vd->owner != NULL)
964 result = -EBUSY;
965 else {
966 vd->owner = file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 result = 0;
968 }
969 }
970 up_write(&card->controls_rwsem);
971 return result;
972}
973
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100974static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
975 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976{
Takashi Iwai82e9bae2005-11-17 13:53:23 +0100977 struct snd_card *card = file->card;
978 struct snd_ctl_elem_id id;
979 struct snd_kcontrol *kctl;
980 struct snd_kcontrol_volatile *vd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 int result;
982
983 if (copy_from_user(&id, _id, sizeof(id)))
984 return -EFAULT;
985 down_write(&card->controls_rwsem);
986 kctl = snd_ctl_find_id(card, &id);
987 if (kctl == NULL) {
988 result = -ENOENT;
989 } else {
990 vd = &kctl->vd[snd_ctl_get_ioff(kctl, &id)];
991 if (vd->owner == NULL)
992 result = -EINVAL;
993 else if (vd->owner != file)
994 result = -EPERM;
995 else {
996 vd->owner = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 result = 0;
998 }
999 }
1000 up_write(&card->controls_rwsem);
1001 return result;
1002}
1003
1004struct user_element {
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001005 struct snd_ctl_elem_info info;
Lars-Peter Clausenbe3bae52014-06-18 13:32:31 +02001006 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 void *elem_data; /* element data */
1008 unsigned long elem_data_size; /* size of element data in bytes */
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001009 void *tlv_data; /* TLV data */
1010 unsigned long tlv_data_size; /* TLV data size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 void *priv_data; /* private data (like strings for enumerated type) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012};
1013
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001014static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
1015 struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016{
1017 struct user_element *ue = kcontrol->private_data;
1018
1019 *uinfo = ue->info;
1020 return 0;
1021}
1022
Clemens Ladisch8d448162011-10-07 22:38:59 +02001023static int snd_ctl_elem_user_enum_info(struct snd_kcontrol *kcontrol,
1024 struct snd_ctl_elem_info *uinfo)
1025{
1026 struct user_element *ue = kcontrol->private_data;
1027 const char *names;
1028 unsigned int item;
1029
1030 item = uinfo->value.enumerated.item;
1031
1032 *uinfo = ue->info;
1033
1034 item = min(item, uinfo->value.enumerated.items - 1);
1035 uinfo->value.enumerated.item = item;
1036
1037 names = ue->priv_data;
1038 for (; item > 0; --item)
1039 names += strlen(names) + 1;
1040 strcpy(uinfo->value.enumerated.name, names);
1041
1042 return 0;
1043}
1044
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001045static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
1046 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047{
1048 struct user_element *ue = kcontrol->private_data;
1049
Lars-Peter Clausenbe3bae52014-06-18 13:32:31 +02001050 mutex_lock(&ue->card->user_ctl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
Lars-Peter Clausenbe3bae52014-06-18 13:32:31 +02001052 mutex_unlock(&ue->card->user_ctl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 return 0;
1054}
1055
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001056static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
1057 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058{
1059 int change;
1060 struct user_element *ue = kcontrol->private_data;
Lars-Peter Clausenbe3bae52014-06-18 13:32:31 +02001061
1062 mutex_lock(&ue->card->user_ctl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 change = memcmp(&ucontrol->value, ue->elem_data, ue->elem_data_size) != 0;
1064 if (change)
1065 memcpy(ue->elem_data, &ucontrol->value, ue->elem_data_size);
Lars-Peter Clausenbe3bae52014-06-18 13:32:31 +02001066 mutex_unlock(&ue->card->user_ctl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 return change;
1068}
1069
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001070static int snd_ctl_elem_user_tlv(struct snd_kcontrol *kcontrol,
1071 int op_flag,
1072 unsigned int size,
1073 unsigned int __user *tlv)
1074{
1075 struct user_element *ue = kcontrol->private_data;
1076 int change = 0;
1077 void *new_data;
1078
1079 if (op_flag > 0) {
1080 if (size > 1024 * 128) /* sane value */
1081 return -EINVAL;
Li Zefanef44a1e2009-04-10 09:43:08 +08001082
1083 new_data = memdup_user(tlv, size);
1084 if (IS_ERR(new_data))
1085 return PTR_ERR(new_data);
Lars-Peter Clausenbe3bae52014-06-18 13:32:31 +02001086 mutex_lock(&ue->card->user_ctl_lock);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001087 change = ue->tlv_data_size != size;
1088 if (!change)
1089 change = memcmp(ue->tlv_data, new_data, size);
1090 kfree(ue->tlv_data);
1091 ue->tlv_data = new_data;
1092 ue->tlv_data_size = size;
Lars-Peter Clausenbe3bae52014-06-18 13:32:31 +02001093 mutex_unlock(&ue->card->user_ctl_lock);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001094 } else {
Lars-Peter Clausenbe3bae52014-06-18 13:32:31 +02001095 int ret = 0;
1096
1097 mutex_lock(&ue->card->user_ctl_lock);
1098 if (!ue->tlv_data_size || !ue->tlv_data) {
1099 ret = -ENXIO;
1100 goto err_unlock;
1101 }
1102 if (size < ue->tlv_data_size) {
1103 ret = -ENOSPC;
1104 goto err_unlock;
1105 }
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001106 if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
Lars-Peter Clausenbe3bae52014-06-18 13:32:31 +02001107 ret = -EFAULT;
1108err_unlock:
1109 mutex_unlock(&ue->card->user_ctl_lock);
1110 if (ret)
1111 return ret;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001112 }
1113 return change;
1114}
1115
Clemens Ladisch8d448162011-10-07 22:38:59 +02001116static int snd_ctl_elem_init_enum_names(struct user_element *ue)
1117{
1118 char *names, *p;
1119 size_t buf_len, name_len;
1120 unsigned int i;
Olof Johansson447c6f92011-11-05 22:51:54 +01001121 const uintptr_t user_ptrval = ue->info.value.enumerated.names_ptr;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001122
1123 if (ue->info.value.enumerated.names_length > 64 * 1024)
1124 return -EINVAL;
1125
Olof Johansson447c6f92011-11-05 22:51:54 +01001126 names = memdup_user((const void __user *)user_ptrval,
Clemens Ladisch8d448162011-10-07 22:38:59 +02001127 ue->info.value.enumerated.names_length);
1128 if (IS_ERR(names))
1129 return PTR_ERR(names);
1130
1131 /* check that there are enough valid names */
1132 buf_len = ue->info.value.enumerated.names_length;
1133 p = names;
1134 for (i = 0; i < ue->info.value.enumerated.items; ++i) {
1135 name_len = strnlen(p, buf_len);
1136 if (name_len == 0 || name_len >= 64 || name_len == buf_len) {
1137 kfree(names);
1138 return -EINVAL;
1139 }
1140 p += name_len + 1;
1141 buf_len -= name_len + 1;
1142 }
1143
1144 ue->priv_data = names;
1145 ue->info.value.enumerated.names_ptr = 0;
1146
1147 return 0;
1148}
1149
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001150static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151{
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001152 struct user_element *ue = kcontrol->private_data;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001153
1154 kfree(ue->tlv_data);
1155 kfree(ue->priv_data);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001156 kfree(ue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157}
1158
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001159static int snd_ctl_elem_add(struct snd_ctl_file *file,
1160 struct snd_ctl_elem_info *info, int replace)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001162 struct snd_card *card = file->card;
1163 struct snd_kcontrol kctl, *_kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 unsigned int access;
1165 long private_size;
1166 struct user_element *ue;
1167 int idx, err;
Lu Guanqun983929c2011-08-24 11:12:34 +08001168
Clemens Ladisch2a031ae2009-08-17 12:25:52 +02001169 if (info->count < 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 return -EINVAL;
Takashi Iwai21a7b4f2015-03-11 18:12:49 +01001171 if (!*info->id.name)
1172 return -EINVAL;
1173 if (strnlen(info->id.name, sizeof(info->id.name)) >= sizeof(info->id.name))
1174 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001176 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001177 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
1178 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 info->id.numid = 0;
1180 memset(&kctl, 0, sizeof(kctl));
Lars-Peter Clausenadbb1442014-06-18 13:32:32 +02001181
1182 if (replace) {
1183 err = snd_ctl_remove_user_ctl(file, &info->id);
1184 if (err)
1185 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 }
Lars-Peter Clausenadbb1442014-06-18 13:32:32 +02001187
1188 if (card->user_ctl_count >= MAX_USER_CONTROLS)
1189 return -ENOMEM;
1190
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 memcpy(&kctl.id, &info->id, sizeof(info->id));
1192 kctl.count = info->owner ? info->owner : 1;
1193 access |= SNDRV_CTL_ELEM_ACCESS_USER;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001194 if (info->type == SNDRV_CTL_ELEM_TYPE_ENUMERATED)
1195 kctl.info = snd_ctl_elem_user_enum_info;
1196 else
1197 kctl.info = snd_ctl_elem_user_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
1199 kctl.get = snd_ctl_elem_user_get;
1200 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
1201 kctl.put = snd_ctl_elem_user_put;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001202 if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
1203 kctl.tlv.c = snd_ctl_elem_user_tlv;
1204 access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1205 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 switch (info->type) {
1207 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 case SNDRV_CTL_ELEM_TYPE_INTEGER:
1209 private_size = sizeof(long);
1210 if (info->count > 128)
1211 return -EINVAL;
1212 break;
1213 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1214 private_size = sizeof(long long);
1215 if (info->count > 64)
1216 return -EINVAL;
1217 break;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001218 case SNDRV_CTL_ELEM_TYPE_ENUMERATED:
1219 private_size = sizeof(unsigned int);
1220 if (info->count > 128 || info->value.enumerated.items == 0)
1221 return -EINVAL;
1222 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 case SNDRV_CTL_ELEM_TYPE_BYTES:
1224 private_size = sizeof(unsigned char);
1225 if (info->count > 512)
1226 return -EINVAL;
1227 break;
1228 case SNDRV_CTL_ELEM_TYPE_IEC958:
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001229 private_size = sizeof(struct snd_aes_iec958);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 if (info->count != 1)
1231 return -EINVAL;
1232 break;
1233 default:
1234 return -EINVAL;
1235 }
1236 private_size *= info->count;
Takashi Iwaica2c0962005-09-09 14:20:23 +02001237 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 if (ue == NULL)
1239 return -ENOMEM;
Lars-Peter Clausenbe3bae52014-06-18 13:32:31 +02001240 ue->card = card;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 ue->info = *info;
Takashi Iwai86148e82006-08-24 12:36:36 +02001242 ue->info.access = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 ue->elem_data = (char *)ue + sizeof(*ue);
1244 ue->elem_data_size = private_size;
Clemens Ladisch8d448162011-10-07 22:38:59 +02001245 if (ue->info.type == SNDRV_CTL_ELEM_TYPE_ENUMERATED) {
1246 err = snd_ctl_elem_init_enum_names(ue);
1247 if (err < 0) {
1248 kfree(ue);
1249 return err;
1250 }
1251 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 kctl.private_free = snd_ctl_elem_user_free;
1253 _kctl = snd_ctl_new(&kctl, access);
1254 if (_kctl == NULL) {
Clemens Ladisch8d448162011-10-07 22:38:59 +02001255 kfree(ue->priv_data);
Takashi Iwai2fbf1822006-03-06 15:42:51 -08001256 kfree(ue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 return -ENOMEM;
1258 }
1259 _kctl->private_data = ue;
1260 for (idx = 0; idx < _kctl->count; idx++)
1261 _kctl->vd[idx].owner = file;
1262 err = snd_ctl_add(card, _kctl);
Takashi Iwai2fbf1822006-03-06 15:42:51 -08001263 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
1266 down_write(&card->controls_rwsem);
1267 card->user_ctl_count++;
1268 up_write(&card->controls_rwsem);
1269
1270 return 0;
1271}
1272
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001273static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1274 struct snd_ctl_elem_info __user *_info, int replace)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001276 struct snd_ctl_elem_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 if (copy_from_user(&info, _info, sizeof(info)))
1278 return -EFAULT;
1279 return snd_ctl_elem_add(file, &info, replace);
1280}
1281
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001282static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1283 struct snd_ctl_elem_id __user *_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001285 struct snd_ctl_elem_id id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
1287 if (copy_from_user(&id, _id, sizeof(id)))
1288 return -EFAULT;
Clemens Ladischf217ac52009-08-17 12:27:22 +02001289 return snd_ctl_remove_user_ctl(file, &id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290}
1291
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001292static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293{
1294 int subscribe;
1295 if (get_user(subscribe, ptr))
1296 return -EFAULT;
1297 if (subscribe < 0) {
1298 subscribe = file->subscribed;
1299 if (put_user(subscribe, ptr))
1300 return -EFAULT;
1301 return 0;
1302 }
1303 if (subscribe) {
1304 file->subscribed = 1;
1305 return 0;
1306 } else if (file->subscribed) {
1307 snd_ctl_empty_read_queue(file);
1308 file->subscribed = 0;
1309 }
1310 return 0;
1311}
1312
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001313static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1314 struct snd_ctl_tlv __user *_tlv,
1315 int op_flag)
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001316{
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001317 struct snd_card *card = file->card;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001318 struct snd_ctl_tlv tlv;
1319 struct snd_kcontrol *kctl;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001320 struct snd_kcontrol_volatile *vd;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001321 unsigned int len;
1322 int err = 0;
1323
1324 if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1325 return -EFAULT;
Clemens Ladisch61236372010-02-01 13:30:56 +01001326 if (tlv.length < sizeof(unsigned int) * 2)
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001327 return -EINVAL;
1328 down_read(&card->controls_rwsem);
1329 kctl = snd_ctl_find_numid(card, tlv.numid);
1330 if (kctl == NULL) {
1331 err = -ENOENT;
1332 goto __kctl_end;
1333 }
1334 if (kctl->tlv.p == NULL) {
1335 err = -ENXIO;
1336 goto __kctl_end;
1337 }
1338 vd = &kctl->vd[tlv.numid - kctl->id.numid];
1339 if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1340 (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1341 (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1342 err = -ENXIO;
1343 goto __kctl_end;
1344 }
1345 if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
Dan Carpenterbec145a2009-11-18 10:31:57 +02001346 if (vd->owner != NULL && vd->owner != file) {
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001347 err = -EPERM;
1348 goto __kctl_end;
1349 }
Jeffrin Josebd483d42012-03-07 22:57:39 +05301350 err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001351 if (err > 0) {
Lars-Peter Clausen9abd9482014-06-18 13:32:33 +02001352 struct snd_ctl_elem_id id = kctl->id;
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001353 up_read(&card->controls_rwsem);
Lars-Peter Clausen9abd9482014-06-18 13:32:33 +02001354 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &id);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001355 return 0;
1356 }
1357 } else {
1358 if (op_flag) {
1359 err = -ENXIO;
1360 goto __kctl_end;
1361 }
1362 len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1363 if (tlv.length < len) {
1364 err = -ENOMEM;
1365 goto __kctl_end;
1366 }
1367 if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1368 err = -EFAULT;
1369 }
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001370 __kctl_end:
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001371 up_read(&card->controls_rwsem);
1372 return err;
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001373}
1374
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1376{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001377 struct snd_ctl_file *ctl;
1378 struct snd_card *card;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001379 struct snd_kctl_ioctl *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 void __user *argp = (void __user *)arg;
1381 int __user *ip = argp;
1382 int err;
1383
1384 ctl = file->private_data;
1385 card = ctl->card;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001386 if (snd_BUG_ON(!card))
1387 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 switch (cmd) {
1389 case SNDRV_CTL_IOCTL_PVERSION:
1390 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1391 case SNDRV_CTL_IOCTL_CARD_INFO:
1392 return snd_ctl_card_info(card, ctl, cmd, argp);
1393 case SNDRV_CTL_IOCTL_ELEM_LIST:
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001394 return snd_ctl_elem_list(card, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 case SNDRV_CTL_IOCTL_ELEM_INFO:
1396 return snd_ctl_elem_info_user(ctl, argp);
1397 case SNDRV_CTL_IOCTL_ELEM_READ:
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001398 return snd_ctl_elem_read_user(card, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1400 return snd_ctl_elem_write_user(ctl, argp);
1401 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1402 return snd_ctl_elem_lock(ctl, argp);
1403 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1404 return snd_ctl_elem_unlock(ctl, argp);
1405 case SNDRV_CTL_IOCTL_ELEM_ADD:
1406 return snd_ctl_elem_add_user(ctl, argp, 0);
1407 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1408 return snd_ctl_elem_add_user(ctl, argp, 1);
1409 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1410 return snd_ctl_elem_remove(ctl, argp);
1411 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1412 return snd_ctl_subscribe_events(ctl, ip);
Jaroslav Kysela8aa9b582006-07-05 17:34:51 +02001413 case SNDRV_CTL_IOCTL_TLV_READ:
1414 return snd_ctl_tlv_ioctl(ctl, argp, 0);
1415 case SNDRV_CTL_IOCTL_TLV_WRITE:
1416 return snd_ctl_tlv_ioctl(ctl, argp, 1);
1417 case SNDRV_CTL_IOCTL_TLV_COMMAND:
1418 return snd_ctl_tlv_ioctl(ctl, argp, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 case SNDRV_CTL_IOCTL_POWER:
Takashi Iwaia381a7a2005-11-17 15:55:49 +01001420 return -ENOPROTOOPT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 case SNDRV_CTL_IOCTL_POWER_STATE:
1422#ifdef CONFIG_PM
1423 return put_user(card->power_state, ip) ? -EFAULT : 0;
1424#else
1425 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1426#endif
1427 }
1428 down_read(&snd_ioctl_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001429 list_for_each_entry(p, &snd_control_ioctls, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 err = p->fioctl(card, ctl, cmd, arg);
1431 if (err != -ENOIOCTLCMD) {
1432 up_read(&snd_ioctl_rwsem);
1433 return err;
1434 }
1435 }
1436 up_read(&snd_ioctl_rwsem);
Takashi Iwai6d85be62005-05-15 14:32:50 +02001437 snd_printdd("unknown ioctl = 0x%x\n", cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 return -ENOTTY;
1439}
1440
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001441static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1442 size_t count, loff_t * offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001444 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 int err = 0;
1446 ssize_t result = 0;
1447
1448 ctl = file->private_data;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001449 if (snd_BUG_ON(!ctl || !ctl->card))
1450 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 if (!ctl->subscribed)
1452 return -EBADFD;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001453 if (count < sizeof(struct snd_ctl_event))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 return -EINVAL;
1455 spin_lock_irq(&ctl->read_lock);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001456 while (count >= sizeof(struct snd_ctl_event)) {
1457 struct snd_ctl_event ev;
1458 struct snd_kctl_event *kev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 while (list_empty(&ctl->events)) {
1460 wait_queue_t wait;
1461 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1462 err = -EAGAIN;
1463 goto __end_lock;
1464 }
1465 init_waitqueue_entry(&wait, current);
1466 add_wait_queue(&ctl->change_sleep, &wait);
1467 set_current_state(TASK_INTERRUPTIBLE);
1468 spin_unlock_irq(&ctl->read_lock);
1469 schedule();
1470 remove_wait_queue(&ctl->change_sleep, &wait);
Takashi Iwai0914f792012-10-16 16:43:39 +02001471 if (ctl->card->shutdown)
1472 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 if (signal_pending(current))
Adrian Bunk0e5d7202006-11-07 13:42:54 +01001474 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 spin_lock_irq(&ctl->read_lock);
1476 }
1477 kev = snd_kctl_event(ctl->events.next);
1478 ev.type = SNDRV_CTL_EVENT_ELEM;
1479 ev.data.elem.mask = kev->mask;
1480 ev.data.elem.id = kev->id;
1481 list_del(&kev->list);
1482 spin_unlock_irq(&ctl->read_lock);
1483 kfree(kev);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001484 if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 err = -EFAULT;
1486 goto __end;
1487 }
1488 spin_lock_irq(&ctl->read_lock);
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001489 buffer += sizeof(struct snd_ctl_event);
1490 count -= sizeof(struct snd_ctl_event);
1491 result += sizeof(struct snd_ctl_event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 }
1493 __end_lock:
1494 spin_unlock_irq(&ctl->read_lock);
1495 __end:
1496 return result > 0 ? result : err;
1497}
1498
1499static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1500{
1501 unsigned int mask;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001502 struct snd_ctl_file *ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
1504 ctl = file->private_data;
1505 if (!ctl->subscribed)
1506 return 0;
1507 poll_wait(file, &ctl->change_sleep, wait);
1508
1509 mask = 0;
1510 if (!list_empty(&ctl->events))
1511 mask |= POLLIN | POLLRDNORM;
1512
1513 return mask;
1514}
1515
1516/*
1517 * register the device-specific control-ioctls.
1518 * called from each device manager like pcm.c, hwdep.c, etc.
1519 */
1520static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1521{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001522 struct snd_kctl_ioctl *pn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001524 pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 if (pn == NULL)
1526 return -ENOMEM;
1527 pn->fioctl = fcn;
1528 down_write(&snd_ioctl_rwsem);
1529 list_add_tail(&pn->list, lists);
1530 up_write(&snd_ioctl_rwsem);
1531 return 0;
1532}
1533
1534int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1535{
1536 return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1537}
1538
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001539EXPORT_SYMBOL(snd_ctl_register_ioctl);
1540
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541#ifdef CONFIG_COMPAT
1542int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1543{
1544 return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1545}
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001546
1547EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548#endif
1549
1550/*
1551 * de-register the device-specific control-ioctls.
1552 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001553static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1554 struct list_head *lists)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001556 struct snd_kctl_ioctl *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001558 if (snd_BUG_ON(!fcn))
1559 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 down_write(&snd_ioctl_rwsem);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001561 list_for_each_entry(p, lists, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 if (p->fioctl == fcn) {
1563 list_del(&p->list);
1564 up_write(&snd_ioctl_rwsem);
1565 kfree(p);
1566 return 0;
1567 }
1568 }
1569 up_write(&snd_ioctl_rwsem);
1570 snd_BUG();
1571 return -EINVAL;
1572}
1573
1574int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1575{
1576 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1577}
1578
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001579EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1580
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581#ifdef CONFIG_COMPAT
1582int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1583{
1584 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1585}
1586
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001587EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588#endif
1589
1590static int snd_ctl_fasync(int fd, struct file * file, int on)
1591{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001592 struct snd_ctl_file *ctl;
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001593
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 ctl = file->private_data;
Jonathan Corbet60aa4922009-02-01 14:52:56 -07001595 return fasync_helper(fd, file, on, &ctl->fasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596}
1597
1598/*
1599 * ioctl32 compat
1600 */
1601#ifdef CONFIG_COMPAT
1602#include "control_compat.c"
1603#else
1604#define snd_ctl_ioctl_compat NULL
1605#endif
1606
1607/*
1608 * INIT PART
1609 */
1610
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -08001611static const struct file_operations snd_ctl_f_ops =
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612{
1613 .owner = THIS_MODULE,
1614 .read = snd_ctl_read,
1615 .open = snd_ctl_open,
1616 .release = snd_ctl_release,
Takashi Iwai02f48652010-04-13 11:49:04 +02001617 .llseek = no_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 .poll = snd_ctl_poll,
1619 .unlocked_ioctl = snd_ctl_ioctl,
1620 .compat_ioctl = snd_ctl_ioctl_compat,
1621 .fasync = snd_ctl_fasync,
1622};
1623
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624/*
1625 * registration of the control device
1626 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001627static int snd_ctl_dev_register(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001629 struct snd_card *card = device->device_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 int err, cardnum;
1631 char name[16];
1632
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001633 if (snd_BUG_ON(!card))
1634 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 cardnum = card->number;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001636 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1637 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 sprintf(name, "controlC%i", cardnum);
Clemens Ladischf87135f2005-11-20 14:06:59 +01001639 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1640 &snd_ctl_f_ops, card, name)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 return err;
1642 return 0;
1643}
1644
1645/*
1646 * disconnection of the control device
1647 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001648static int snd_ctl_dev_disconnect(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001650 struct snd_card *card = device->device_data;
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001651 struct snd_ctl_file *ctl;
Takashi Iwaic4614822006-06-23 14:38:23 +02001652 int err, cardnum;
1653
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001654 if (snd_BUG_ON(!card))
1655 return -ENXIO;
Takashi Iwaic4614822006-06-23 14:38:23 +02001656 cardnum = card->number;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001657 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1658 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
Takashi Iwaid8009882008-09-07 12:51:13 +02001660 read_lock(&card->ctl_files_rwlock);
Johannes Berg9244b2c2006-10-05 16:02:22 +02001661 list_for_each_entry(ctl, &card->ctl_files, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 wake_up(&ctl->change_sleep);
1663 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1664 }
Takashi Iwaid8009882008-09-07 12:51:13 +02001665 read_unlock(&card->ctl_files_rwlock);
Takashi Iwaic4614822006-06-23 14:38:23 +02001666
1667 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1668 card, -1)) < 0)
1669 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 return 0;
1671}
1672
1673/*
1674 * free all controls
1675 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001676static int snd_ctl_dev_free(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001678 struct snd_card *card = device->device_data;
1679 struct snd_kcontrol *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680
1681 down_write(&card->controls_rwsem);
1682 while (!list_empty(&card->controls)) {
1683 control = snd_kcontrol(card->controls.next);
1684 snd_ctl_remove(card, control);
1685 }
1686 up_write(&card->controls_rwsem);
1687 return 0;
1688}
1689
1690/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 * create control core:
1692 * called from init.c
1693 */
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001694int snd_ctl_create(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695{
Takashi Iwai82e9bae2005-11-17 13:53:23 +01001696 static struct snd_device_ops ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 .dev_free = snd_ctl_dev_free,
1698 .dev_register = snd_ctl_dev_register,
1699 .dev_disconnect = snd_ctl_dev_disconnect,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 };
1701
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001702 if (snd_BUG_ON(!card))
1703 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
1705}
Takashi Iwaib9ed4f22007-07-23 15:41:34 +02001706
1707/*
Clemens Ladisch96007322011-01-10 16:25:44 +01001708 * Frequently used control callbacks/helpers
Takashi Iwaib9ed4f22007-07-23 15:41:34 +02001709 */
1710int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
1711 struct snd_ctl_elem_info *uinfo)
1712{
1713 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1714 uinfo->count = 1;
1715 uinfo->value.integer.min = 0;
1716 uinfo->value.integer.max = 1;
1717 return 0;
1718}
1719
1720EXPORT_SYMBOL(snd_ctl_boolean_mono_info);
1721
1722int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
1723 struct snd_ctl_elem_info *uinfo)
1724{
1725 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1726 uinfo->count = 2;
1727 uinfo->value.integer.min = 0;
1728 uinfo->value.integer.max = 1;
1729 return 0;
1730}
1731
1732EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);
Clemens Ladisch96007322011-01-10 16:25:44 +01001733
1734/**
1735 * snd_ctl_enum_info - fills the info structure for an enumerated control
1736 * @info: the structure to be filled
1737 * @channels: the number of the control's channels; often one
1738 * @items: the number of control values; also the size of @names
1739 * @names: an array containing the names of all control values
1740 *
1741 * Sets all required fields in @info to their appropriate values.
1742 * If the control's accessibility is not the default (readable and writable),
1743 * the caller has to fill @info->access.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001744 *
1745 * Return: Zero.
Clemens Ladisch96007322011-01-10 16:25:44 +01001746 */
1747int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
1748 unsigned int items, const char *const names[])
1749{
1750 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1751 info->count = channels;
1752 info->value.enumerated.items = items;
1753 if (info->value.enumerated.item >= items)
1754 info->value.enumerated.item = items - 1;
1755 strlcpy(info->value.enumerated.name,
1756 names[info->value.enumerated.item],
1757 sizeof(info->value.enumerated.name));
1758 return 0;
1759}
1760EXPORT_SYMBOL(snd_ctl_enum_info);