]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - sound/core/control.c
ALSA: Add a helper to initialize device
[mirror_ubuntu-artful-kernel.git] / sound / core / control.c
CommitLineData
1da177e4
LT
1/*
2 * Routines for driver control interface
c1017a4c 3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4
LT
4 *
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
1da177e4
LT
22#include <linux/threads.h>
23#include <linux/interrupt.h>
da155d5b 24#include <linux/module.h>
1da177e4
LT
25#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
5591bf07 35#define MAX_CONTROL_COUNT 1028
1da177e4 36
82e9bae6 37struct snd_kctl_ioctl {
1da177e4
LT
38 struct list_head list; /* list of all ioctls */
39 snd_kctl_ioctl_func_t fioctl;
82e9bae6 40};
1da177e4
LT
41
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{
1da177e4 50 unsigned long flags;
82e9bae6
TI
51 struct snd_card *card;
52 struct snd_ctl_file *ctl;
23c18d4b 53 int i, err;
1da177e4 54
02f4865f
TI
55 err = nonseekable_open(inode, file);
56 if (err < 0)
57 return err;
58
f87135f5 59 card = snd_lookup_minor_data(iminor(inode), SNDRV_DEVICE_TYPE_CONTROL);
1da177e4
LT
60 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 }
ca2c0966 73 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
1da177e4
LT
74 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;
23c18d4b
TI
82 for (i = 0; i < SND_CTL_SUBDEV_ITEMS; i++)
83 ctl->preferred_subdevice[i] = -1;
25d27ede 84 ctl->pid = get_pid(task_pid(current));
1da177e4
LT
85 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);
a0830dbd 89 snd_card_unref(card);
1da177e4
LT
90 return 0;
91
92 __error:
93 module_put(card->module);
94 __error2:
95 snd_card_file_remove(card, file);
96 __error1:
a0830dbd
TI
97 if (card)
98 snd_card_unref(card);
1da177e4
LT
99 return err;
100}
101
82e9bae6 102static void snd_ctl_empty_read_queue(struct snd_ctl_file * ctl)
1da177e4 103{
7507e8da 104 unsigned long flags;
82e9bae6 105 struct snd_kctl_event *cread;
1da177e4 106
7507e8da 107 spin_lock_irqsave(&ctl->read_lock, flags);
1da177e4
LT
108 while (!list_empty(&ctl->events)) {
109 cread = snd_kctl_event(ctl->events.next);
110 list_del(&cread->list);
111 kfree(cread);
112 }
7507e8da 113 spin_unlock_irqrestore(&ctl->read_lock, flags);
1da177e4
LT
114}
115
116static int snd_ctl_release(struct inode *inode, struct file *file)
117{
118 unsigned long flags;
82e9bae6
TI
119 struct snd_card *card;
120 struct snd_ctl_file *ctl;
121 struct snd_kcontrol *control;
1da177e4
LT
122 unsigned int idx;
123
124 ctl = file->private_data;
1da177e4
LT
125 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);
9244b2c3 131 list_for_each_entry(control, &card->controls, list)
1da177e4
LT
132 for (idx = 0; idx < control->count; idx++)
133 if (control->vd[idx].owner == ctl)
134 control->vd[idx].owner = NULL;
1da177e4
LT
135 up_write(&card->controls_rwsem);
136 snd_ctl_empty_read_queue(ctl);
25d27ede 137 put_pid(ctl->pid);
1da177e4
LT
138 kfree(ctl);
139 module_put(card->module);
140 snd_card_file_remove(card, file);
141 return 0;
142}
143
12cddbd8
TI
144/**
145 * snd_ctl_notify - Send notification to user-space for a control change
146 * @card: the card to send notification
147 * @mask: the event mask, SNDRV_CTL_EVENT_*
148 * @id: the ctl element id to send notification
149 *
150 * This function adds an event record with the given id and mask, appends
151 * to the list and wakes up the user-space for notification. This can be
152 * called in the atomic context.
153 */
82e9bae6
TI
154void snd_ctl_notify(struct snd_card *card, unsigned int mask,
155 struct snd_ctl_elem_id *id)
1da177e4
LT
156{
157 unsigned long flags;
82e9bae6
TI
158 struct snd_ctl_file *ctl;
159 struct snd_kctl_event *ev;
1da177e4 160
7eaa943c
TI
161 if (snd_BUG_ON(!card || !id))
162 return;
1da177e4 163 read_lock(&card->ctl_files_rwlock);
8eeaa2f9 164#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
1da177e4
LT
165 card->mixer_oss_change_count++;
166#endif
9244b2c3 167 list_for_each_entry(ctl, &card->ctl_files, list) {
1da177e4
LT
168 if (!ctl->subscribed)
169 continue;
170 spin_lock_irqsave(&ctl->read_lock, flags);
9244b2c3 171 list_for_each_entry(ev, &ctl->events, list) {
1da177e4
LT
172 if (ev->id.numid == id->numid) {
173 ev->mask |= mask;
174 goto _found;
175 }
176 }
ca2c0966 177 ev = kzalloc(sizeof(*ev), GFP_ATOMIC);
1da177e4
LT
178 if (ev) {
179 ev->id = *id;
180 ev->mask = mask;
181 list_add_tail(&ev->list, &ctl->events);
182 } else {
bb009457 183 dev_err(card->dev, "No memory available to allocate event\n");
1da177e4
LT
184 }
185 _found:
186 wake_up(&ctl->change_sleep);
187 spin_unlock_irqrestore(&ctl->read_lock, flags);
188 kill_fasync(&ctl->fasync, SIGIO, POLL_IN);
189 }
190 read_unlock(&card->ctl_files_rwlock);
191}
c0d3fb39
TI
192EXPORT_SYMBOL(snd_ctl_notify);
193
1da177e4
LT
194/**
195 * snd_ctl_new - create a control instance from the template
196 * @control: the control template
197 * @access: the default control access
198 *
82e9bae6 199 * Allocates a new struct snd_kcontrol instance and copies the given template
1da177e4
LT
200 * to the new instance. It does not copy volatile data (access).
201 *
eb7c06e8 202 * Return: The pointer of the new instance, or %NULL on failure.
1da177e4 203 */
0b51ba07
AB
204static struct snd_kcontrol *snd_ctl_new(struct snd_kcontrol *control,
205 unsigned int access)
1da177e4 206{
82e9bae6 207 struct snd_kcontrol *kctl;
1da177e4
LT
208 unsigned int idx;
209
7eaa943c
TI
210 if (snd_BUG_ON(!control || !control->count))
211 return NULL;
5591bf07
DR
212
213 if (control->count > MAX_CONTROL_COUNT)
214 return NULL;
215
82e9bae6 216 kctl = kzalloc(sizeof(*kctl) + sizeof(struct snd_kcontrol_volatile) * control->count, GFP_KERNEL);
73e77ba0 217 if (kctl == NULL) {
bb009457 218 pr_err("ALSA: Cannot allocate control instance\n");
1da177e4 219 return NULL;
73e77ba0 220 }
1da177e4
LT
221 *kctl = *control;
222 for (idx = 0; idx < kctl->count; idx++)
223 kctl->vd[idx].access = access;
224 return kctl;
225}
226
227/**
228 * snd_ctl_new1 - create a control instance from the template
229 * @ncontrol: the initialization record
230 * @private_data: the private data to set
231 *
82e9bae6 232 * Allocates a new struct snd_kcontrol instance and initialize from the given
1da177e4
LT
233 * template. When the access field of ncontrol is 0, it's assumed as
234 * READWRITE access. When the count field is 0, it's assumes as one.
235 *
eb7c06e8 236 * Return: The pointer of the newly generated instance, or %NULL on failure.
1da177e4 237 */
82e9bae6
TI
238struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new *ncontrol,
239 void *private_data)
1da177e4 240{
82e9bae6 241 struct snd_kcontrol kctl;
1da177e4
LT
242 unsigned int access;
243
7eaa943c
TI
244 if (snd_BUG_ON(!ncontrol || !ncontrol->info))
245 return NULL;
1da177e4
LT
246 memset(&kctl, 0, sizeof(kctl));
247 kctl.id.iface = ncontrol->iface;
248 kctl.id.device = ncontrol->device;
249 kctl.id.subdevice = ncontrol->subdevice;
366840d7 250 if (ncontrol->name) {
1da177e4 251 strlcpy(kctl.id.name, ncontrol->name, sizeof(kctl.id.name));
366840d7 252 if (strcmp(ncontrol->name, kctl.id.name) != 0)
bb009457
TI
253 pr_warn("ALSA: Control name '%s' truncated to '%s'\n",
254 ncontrol->name, kctl.id.name);
366840d7 255 }
1da177e4
LT
256 kctl.id.index = ncontrol->index;
257 kctl.count = ncontrol->count ? ncontrol->count : 1;
258 access = ncontrol->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
8aa9b586 259 (ncontrol->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
a8d372f1 260 SNDRV_CTL_ELEM_ACCESS_VOLATILE|
8aa9b586 261 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
a75d7a4c
CL
262 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE|
263 SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND|
264 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK));
1da177e4
LT
265 kctl.info = ncontrol->info;
266 kctl.get = ncontrol->get;
267 kctl.put = ncontrol->put;
8aa9b586 268 kctl.tlv.p = ncontrol->tlv.p;
1da177e4
LT
269 kctl.private_value = ncontrol->private_value;
270 kctl.private_data = private_data;
271 return snd_ctl_new(&kctl, access);
272}
c0d3fb39
TI
273EXPORT_SYMBOL(snd_ctl_new1);
274
1da177e4
LT
275/**
276 * snd_ctl_free_one - release the control instance
277 * @kcontrol: the control instance
278 *
279 * Releases the control instance created via snd_ctl_new()
280 * or snd_ctl_new1().
281 * Don't call this after the control was added to the card.
282 */
82e9bae6 283void snd_ctl_free_one(struct snd_kcontrol *kcontrol)
1da177e4
LT
284{
285 if (kcontrol) {
286 if (kcontrol->private_free)
287 kcontrol->private_free(kcontrol);
288 kfree(kcontrol);
289 }
290}
c0d3fb39
TI
291EXPORT_SYMBOL(snd_ctl_free_one);
292
0e82e5fa
CL
293static bool snd_ctl_remove_numid_conflict(struct snd_card *card,
294 unsigned int count)
1da177e4 295{
82e9bae6 296 struct snd_kcontrol *kctl;
1da177e4 297
ac902c11
LPC
298 /* Make sure that the ids assigned to the control do not wrap around */
299 if (card->last_numid >= UINT_MAX - count)
300 card->last_numid = 0;
301
9244b2c3 302 list_for_each_entry(kctl, &card->controls, list) {
7c733587 303 if (kctl->id.numid < card->last_numid + 1 + count &&
0e82e5fa
CL
304 kctl->id.numid + kctl->count > card->last_numid + 1) {
305 card->last_numid = kctl->id.numid + kctl->count - 1;
306 return true;
307 }
1da177e4 308 }
0e82e5fa 309 return false;
1da177e4
LT
310}
311
82e9bae6 312static int snd_ctl_find_hole(struct snd_card *card, unsigned int count)
1da177e4 313{
0e82e5fa 314 unsigned int iter = 100000;
1da177e4 315
0e82e5fa 316 while (snd_ctl_remove_numid_conflict(card, count)) {
1da177e4
LT
317 if (--iter == 0) {
318 /* this situation is very unlikely */
bb009457 319 dev_err(card->dev, "unable to allocate new control numid\n");
1da177e4
LT
320 return -ENOMEM;
321 }
1da177e4
LT
322 }
323 return 0;
324}
325
326/**
327 * snd_ctl_add - add the control instance to the card
328 * @card: the card instance
329 * @kcontrol: the control instance to add
330 *
331 * Adds the control instance created via snd_ctl_new() or
332 * snd_ctl_new1() to the given card. Assigns also an unique
333 * numid used for fast search.
334 *
1da177e4 335 * It frees automatically the control which cannot be added.
eb7c06e8
YB
336 *
337 * Return: Zero if successful, or a negative error code on failure.
338 *
1da177e4 339 */
82e9bae6 340int snd_ctl_add(struct snd_card *card, struct snd_kcontrol *kcontrol)
1da177e4 341{
82e9bae6 342 struct snd_ctl_elem_id id;
1da177e4 343 unsigned int idx;
fd9f26e4 344 unsigned int count;
c6077b30 345 int err = -EINVAL;
1da177e4 346
73e77ba0 347 if (! kcontrol)
c6077b30 348 return err;
7eaa943c
TI
349 if (snd_BUG_ON(!card || !kcontrol->info))
350 goto error;
1da177e4 351 id = kcontrol->id;
883a1d49
LPC
352 if (id.index > UINT_MAX - kcontrol->count)
353 goto error;
354
1da177e4
LT
355 down_write(&card->controls_rwsem);
356 if (snd_ctl_find_id(card, &id)) {
357 up_write(&card->controls_rwsem);
bb009457 358 dev_err(card->dev, "control %i:%i:%i:%s:%i is already present\n",
1da177e4
LT
359 id.iface,
360 id.device,
361 id.subdevice,
362 id.name,
363 id.index);
c6077b30
TI
364 err = -EBUSY;
365 goto error;
1da177e4
LT
366 }
367 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
368 up_write(&card->controls_rwsem);
c6077b30
TI
369 err = -ENOMEM;
370 goto error;
1da177e4
LT
371 }
372 list_add_tail(&kcontrol->list, &card->controls);
373 card->controls_count += kcontrol->count;
374 kcontrol->id.numid = card->last_numid + 1;
375 card->last_numid += kcontrol->count;
fd9f26e4 376 count = kcontrol->count;
1da177e4 377 up_write(&card->controls_rwsem);
fd9f26e4 378 for (idx = 0; idx < count; idx++, id.index++, id.numid++)
1da177e4
LT
379 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
380 return 0;
c6077b30
TI
381
382 error:
383 snd_ctl_free_one(kcontrol);
384 return err;
1da177e4 385}
c0d3fb39
TI
386EXPORT_SYMBOL(snd_ctl_add);
387
66b5b972
DP
388/**
389 * snd_ctl_replace - replace the control instance of the card
390 * @card: the card instance
391 * @kcontrol: the control instance to replace
392 * @add_on_replace: add the control if not already added
393 *
394 * Replaces the given control. If the given control does not exist
395 * and the add_on_replace flag is set, the control is added. If the
396 * control exists, it is destroyed first.
397 *
66b5b972 398 * It frees automatically the control which cannot be added or replaced.
eb7c06e8
YB
399 *
400 * Return: Zero if successful, or a negative error code on failure.
66b5b972
DP
401 */
402int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol,
403 bool add_on_replace)
404{
405 struct snd_ctl_elem_id id;
fd9f26e4 406 unsigned int count;
66b5b972
DP
407 unsigned int idx;
408 struct snd_kcontrol *old;
409 int ret;
410
411 if (!kcontrol)
412 return -EINVAL;
413 if (snd_BUG_ON(!card || !kcontrol->info)) {
414 ret = -EINVAL;
415 goto error;
416 }
417 id = kcontrol->id;
418 down_write(&card->controls_rwsem);
419 old = snd_ctl_find_id(card, &id);
420 if (!old) {
421 if (add_on_replace)
422 goto add;
423 up_write(&card->controls_rwsem);
424 ret = -EINVAL;
425 goto error;
426 }
427 ret = snd_ctl_remove(card, old);
428 if (ret < 0) {
429 up_write(&card->controls_rwsem);
430 goto error;
431 }
432add:
433 if (snd_ctl_find_hole(card, kcontrol->count) < 0) {
434 up_write(&card->controls_rwsem);
435 ret = -ENOMEM;
436 goto error;
437 }
438 list_add_tail(&kcontrol->list, &card->controls);
439 card->controls_count += kcontrol->count;
440 kcontrol->id.numid = card->last_numid + 1;
441 card->last_numid += kcontrol->count;
fd9f26e4 442 count = kcontrol->count;
66b5b972 443 up_write(&card->controls_rwsem);
fd9f26e4 444 for (idx = 0; idx < count; idx++, id.index++, id.numid++)
66b5b972
DP
445 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_ADD, &id);
446 return 0;
447
448error:
449 snd_ctl_free_one(kcontrol);
450 return ret;
451}
452EXPORT_SYMBOL(snd_ctl_replace);
453
1da177e4
LT
454/**
455 * snd_ctl_remove - remove the control from the card and release it
456 * @card: the card instance
457 * @kcontrol: the control instance to remove
458 *
459 * Removes the control from the card and then releases the instance.
460 * You don't need to call snd_ctl_free_one(). You must be in
461 * the write lock - down_write(&card->controls_rwsem).
eb7c06e8
YB
462 *
463 * Return: 0 if successful, or a negative error code on failure.
1da177e4 464 */
82e9bae6 465int snd_ctl_remove(struct snd_card *card, struct snd_kcontrol *kcontrol)
1da177e4 466{
82e9bae6 467 struct snd_ctl_elem_id id;
1da177e4
LT
468 unsigned int idx;
469
7eaa943c
TI
470 if (snd_BUG_ON(!card || !kcontrol))
471 return -EINVAL;
1da177e4
LT
472 list_del(&kcontrol->list);
473 card->controls_count -= kcontrol->count;
474 id = kcontrol->id;
475 for (idx = 0; idx < kcontrol->count; idx++, id.index++, id.numid++)
476 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_REMOVE, &id);
477 snd_ctl_free_one(kcontrol);
478 return 0;
479}
c0d3fb39
TI
480EXPORT_SYMBOL(snd_ctl_remove);
481
1da177e4
LT
482/**
483 * snd_ctl_remove_id - remove the control of the given id and release it
484 * @card: the card instance
485 * @id: the control id to remove
486 *
487 * Finds the control instance with the given id, removes it from the
488 * card list and releases it.
eb7c06e8
YB
489 *
490 * Return: 0 if successful, or a negative error code on failure.
1da177e4 491 */
82e9bae6 492int snd_ctl_remove_id(struct snd_card *card, struct snd_ctl_elem_id *id)
1da177e4 493{
82e9bae6 494 struct snd_kcontrol *kctl;
1da177e4
LT
495 int ret;
496
497 down_write(&card->controls_rwsem);
498 kctl = snd_ctl_find_id(card, id);
499 if (kctl == NULL) {
500 up_write(&card->controls_rwsem);
501 return -ENOENT;
502 }
503 ret = snd_ctl_remove(card, kctl);
504 up_write(&card->controls_rwsem);
505 return ret;
506}
c0d3fb39
TI
507EXPORT_SYMBOL(snd_ctl_remove_id);
508
1da177e4 509/**
f217ac59 510 * snd_ctl_remove_user_ctl - remove and release the unlocked user control
1da177e4
LT
511 * @file: active control handle
512 * @id: the control id to remove
513 *
514 * Finds the control instance with the given id, removes it from the
515 * card list and releases it.
eb7c06e8
YB
516 *
517 * Return: 0 if successful, or a negative error code on failure.
1da177e4 518 */
f217ac59
CL
519static int snd_ctl_remove_user_ctl(struct snd_ctl_file * file,
520 struct snd_ctl_elem_id *id)
1da177e4 521{
82e9bae6
TI
522 struct snd_card *card = file->card;
523 struct snd_kcontrol *kctl;
1da177e4
LT
524 int idx, ret;
525
526 down_write(&card->controls_rwsem);
527 kctl = snd_ctl_find_id(card, id);
528 if (kctl == NULL) {
317b8081
CL
529 ret = -ENOENT;
530 goto error;
1da177e4 531 }
18dd0aa5
CL
532 if (!(kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_USER)) {
533 ret = -EINVAL;
534 goto error;
535 }
1da177e4
LT
536 for (idx = 0; idx < kctl->count; idx++)
537 if (kctl->vd[idx].owner != NULL && kctl->vd[idx].owner != file) {
317b8081
CL
538 ret = -EBUSY;
539 goto error;
1da177e4
LT
540 }
541 ret = snd_ctl_remove(card, kctl);
f217ac59
CL
542 if (ret < 0)
543 goto error;
544 card->user_ctl_count--;
317b8081 545error:
1da177e4
LT
546 up_write(&card->controls_rwsem);
547 return ret;
548}
549
3cbdd753
TI
550/**
551 * snd_ctl_activate_id - activate/inactivate the control of the given id
552 * @card: the card instance
553 * @id: the control id to activate/inactivate
554 * @active: non-zero to activate
555 *
556 * Finds the control instance with the given id, and activate or
557 * inactivate the control together with notification, if changed.
558 *
eb7c06e8 559 * Return: 0 if unchanged, 1 if changed, or a negative error code on failure.
3cbdd753
TI
560 */
561int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
562 int active)
563{
564 struct snd_kcontrol *kctl;
565 struct snd_kcontrol_volatile *vd;
566 unsigned int index_offset;
567 int ret;
568
569 down_write(&card->controls_rwsem);
570 kctl = snd_ctl_find_id(card, id);
571 if (kctl == NULL) {
572 ret = -ENOENT;
573 goto unlock;
574 }
31584ed1 575 index_offset = snd_ctl_get_ioff(kctl, id);
3cbdd753
TI
576 vd = &kctl->vd[index_offset];
577 ret = 0;
578 if (active) {
579 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE))
580 goto unlock;
581 vd->access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
582 } else {
583 if (vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE)
584 goto unlock;
585 vd->access |= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
586 }
587 ret = 1;
588 unlock:
589 up_write(&card->controls_rwsem);
590 if (ret > 0)
591 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_INFO, id);
592 return ret;
593}
594EXPORT_SYMBOL_GPL(snd_ctl_activate_id);
595
1da177e4
LT
596/**
597 * snd_ctl_rename_id - replace the id of a control on the card
598 * @card: the card instance
599 * @src_id: the old id
600 * @dst_id: the new id
601 *
602 * Finds the control with the old id from the card, and replaces the
603 * id with the new one.
604 *
eb7c06e8 605 * Return: Zero if successful, or a negative error code on failure.
1da177e4 606 */
82e9bae6
TI
607int snd_ctl_rename_id(struct snd_card *card, struct snd_ctl_elem_id *src_id,
608 struct snd_ctl_elem_id *dst_id)
1da177e4 609{
82e9bae6 610 struct snd_kcontrol *kctl;
1da177e4
LT
611
612 down_write(&card->controls_rwsem);
613 kctl = snd_ctl_find_id(card, src_id);
614 if (kctl == NULL) {
615 up_write(&card->controls_rwsem);
616 return -ENOENT;
617 }
618 kctl->id = *dst_id;
619 kctl->id.numid = card->last_numid + 1;
620 card->last_numid += kctl->count;
621 up_write(&card->controls_rwsem);
622 return 0;
623}
c0d3fb39
TI
624EXPORT_SYMBOL(snd_ctl_rename_id);
625
1da177e4
LT
626/**
627 * snd_ctl_find_numid - find the control instance with the given number-id
628 * @card: the card instance
629 * @numid: the number-id to search
630 *
631 * Finds the control instance with the given number-id from the card.
632 *
1da177e4
LT
633 * The caller must down card->controls_rwsem before calling this function
634 * (if the race condition can happen).
eb7c06e8
YB
635 *
636 * Return: The pointer of the instance if found, or %NULL if not.
637 *
1da177e4 638 */
82e9bae6 639struct snd_kcontrol *snd_ctl_find_numid(struct snd_card *card, unsigned int numid)
1da177e4 640{
82e9bae6 641 struct snd_kcontrol *kctl;
1da177e4 642
7eaa943c
TI
643 if (snd_BUG_ON(!card || !numid))
644 return NULL;
9244b2c3 645 list_for_each_entry(kctl, &card->controls, list) {
1da177e4
LT
646 if (kctl->id.numid <= numid && kctl->id.numid + kctl->count > numid)
647 return kctl;
648 }
649 return NULL;
650}
c0d3fb39
TI
651EXPORT_SYMBOL(snd_ctl_find_numid);
652
1da177e4
LT
653/**
654 * snd_ctl_find_id - find the control instance with the given id
655 * @card: the card instance
656 * @id: the id to search
657 *
658 * Finds the control instance with the given id from the card.
659 *
1da177e4
LT
660 * The caller must down card->controls_rwsem before calling this function
661 * (if the race condition can happen).
eb7c06e8
YB
662 *
663 * Return: The pointer of the instance if found, or %NULL if not.
664 *
1da177e4 665 */
82e9bae6
TI
666struct snd_kcontrol *snd_ctl_find_id(struct snd_card *card,
667 struct snd_ctl_elem_id *id)
1da177e4 668{
82e9bae6 669 struct snd_kcontrol *kctl;
1da177e4 670
7eaa943c
TI
671 if (snd_BUG_ON(!card || !id))
672 return NULL;
1da177e4
LT
673 if (id->numid != 0)
674 return snd_ctl_find_numid(card, id->numid);
9244b2c3 675 list_for_each_entry(kctl, &card->controls, list) {
1da177e4
LT
676 if (kctl->id.iface != id->iface)
677 continue;
678 if (kctl->id.device != id->device)
679 continue;
680 if (kctl->id.subdevice != id->subdevice)
681 continue;
682 if (strncmp(kctl->id.name, id->name, sizeof(kctl->id.name)))
683 continue;
684 if (kctl->id.index > id->index)
685 continue;
686 if (kctl->id.index + kctl->count <= id->index)
687 continue;
688 return kctl;
689 }
690 return NULL;
691}
c0d3fb39
TI
692EXPORT_SYMBOL(snd_ctl_find_id);
693
82e9bae6 694static int snd_ctl_card_info(struct snd_card *card, struct snd_ctl_file * ctl,
1da177e4
LT
695 unsigned int cmd, void __user *arg)
696{
82e9bae6 697 struct snd_ctl_card_info *info;
1da177e4 698
ca2c0966 699 info = kzalloc(sizeof(*info), GFP_KERNEL);
1da177e4
LT
700 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);
82e9bae6 711 if (copy_to_user(arg, info, sizeof(struct snd_ctl_card_info))) {
1da177e4
LT
712 kfree(info);
713 return -EFAULT;
714 }
715 kfree(info);
716 return 0;
717}
718
82e9bae6
TI
719static int snd_ctl_elem_list(struct snd_card *card,
720 struct snd_ctl_elem_list __user *_list)
1da177e4
LT
721{
722 struct list_head *plist;
82e9bae6
TI
723 struct snd_ctl_elem_list list;
724 struct snd_kcontrol *kctl;
725 struct snd_ctl_elem_id *dst, *id;
78fa2c4d 726 unsigned int offset, space, jidx;
1da177e4
LT
727
728 if (copy_from_user(&list, _list, sizeof(list)))
729 return -EFAULT;
730 offset = list.offset;
731 space = list.space;
1da177e4
LT
732 /* try limit maximum space */
733 if (space > 16384)
734 return -ENOMEM;
735 if (space > 0) {
736 /* allocate temporary buffer for atomic operation */
82e9bae6 737 dst = vmalloc(space * sizeof(struct snd_ctl_elem_id));
1da177e4
LT
738 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);
82e9bae6
TI
766 if (list.used > 0 &&
767 copy_to_user(list.pids, dst,
768 list.used * sizeof(struct snd_ctl_elem_id))) {
1da177e4
LT
769 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
82e9bae6
TI
783static int snd_ctl_elem_info(struct snd_ctl_file *ctl,
784 struct snd_ctl_elem_info *info)
1da177e4 785{
82e9bae6
TI
786 struct snd_card *card = ctl->card;
787 struct snd_kcontrol *kctl;
788 struct snd_kcontrol_volatile *vd;
1da177e4
LT
789 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) {
7eaa943c 803 snd_BUG_ON(info->access);
1da177e4
LT
804 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;
25d27ede 812 info->owner = pid_vnr(vd->owner->pid);
1da177e4
LT
813 } else {
814 info->owner = -1;
815 }
816 }
817 up_read(&card->controls_rwsem);
818 return result;
819}
820
82e9bae6
TI
821static int snd_ctl_elem_info_user(struct snd_ctl_file *ctl,
822 struct snd_ctl_elem_info __user *_info)
1da177e4 823{
82e9bae6 824 struct snd_ctl_elem_info info;
1da177e4
LT
825 int result;
826
827 if (copy_from_user(&info, _info, sizeof(info)))
828 return -EFAULT;
64649400 829 snd_power_lock(ctl->card);
cbac4b0c 830 result = snd_power_wait(ctl->card, SNDRV_CTL_POWER_D0);
64649400
GP
831 if (result >= 0)
832 result = snd_ctl_elem_info(ctl, &info);
833 snd_power_unlock(ctl->card);
1da177e4
LT
834 if (result >= 0)
835 if (copy_to_user(_info, &info, sizeof(info)))
836 return -EFAULT;
837 return result;
838}
839
d3bd67cd
TI
840static int snd_ctl_elem_read(struct snd_card *card,
841 struct snd_ctl_elem_value *control)
1da177e4 842{
82e9bae6
TI
843 struct snd_kcontrol *kctl;
844 struct snd_kcontrol_volatile *vd;
1da177e4 845 unsigned int index_offset;
8ace4f3c 846 int result;
1da177e4
LT
847
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];
8ace4f3c
TI
855 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;
1da177e4
LT
861 }
862 up_read(&card->controls_rwsem);
863 return result;
864}
865
82e9bae6
TI
866static int snd_ctl_elem_read_user(struct snd_card *card,
867 struct snd_ctl_elem_value __user *_control)
1da177e4 868{
82e9bae6 869 struct snd_ctl_elem_value *control;
1da177e4 870 int result;
ef44a1ec
LZ
871
872 control = memdup_user(_control, sizeof(*control));
873 if (IS_ERR(control))
874 return PTR_ERR(control);
875
64649400 876 snd_power_lock(card);
cbac4b0c 877 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
64649400
GP
878 if (result >= 0)
879 result = snd_ctl_elem_read(card, control);
880 snd_power_unlock(card);
1da177e4
LT
881 if (result >= 0)
882 if (copy_to_user(_control, control, sizeof(*control)))
883 result = -EFAULT;
884 kfree(control);
885 return result;
886}
887
d3bd67cd
TI
888static int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file,
889 struct snd_ctl_elem_value *control)
1da177e4 890{
82e9bae6
TI
891 struct snd_kcontrol *kctl;
892 struct snd_kcontrol_volatile *vd;
1da177e4 893 unsigned int index_offset;
8ace4f3c 894 int result;
1da177e4
LT
895
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];
8ace4f3c
TI
903 if (!(vd->access & SNDRV_CTL_ELEM_ACCESS_WRITE) ||
904 kctl->put == NULL ||
905 (file && vd->owner && vd->owner != file)) {
906 result = -EPERM;
1da177e4 907 } else {
8ace4f3c
TI
908 snd_ctl_build_ioff(&control->id, kctl, index_offset);
909 result = kctl->put(kctl, control);
910 }
911 if (result > 0) {
fd9f26e4 912 struct snd_ctl_elem_id id = control->id;
8ace4f3c 913 up_read(&card->controls_rwsem);
fd9f26e4 914 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE, &id);
8ace4f3c 915 return 0;
1da177e4
LT
916 }
917 }
918 up_read(&card->controls_rwsem);
919 return result;
920}
921
82e9bae6
TI
922static int snd_ctl_elem_write_user(struct snd_ctl_file *file,
923 struct snd_ctl_elem_value __user *_control)
1da177e4 924{
82e9bae6 925 struct snd_ctl_elem_value *control;
64649400 926 struct snd_card *card;
1da177e4
LT
927 int result;
928
ef44a1ec
LZ
929 control = memdup_user(_control, sizeof(*control));
930 if (IS_ERR(control))
931 return PTR_ERR(control);
932
64649400
GP
933 card = file->card;
934 snd_power_lock(card);
cbac4b0c 935 result = snd_power_wait(card, SNDRV_CTL_POWER_D0);
64649400
GP
936 if (result >= 0)
937 result = snd_ctl_elem_write(card, file, control);
938 snd_power_unlock(card);
1da177e4
LT
939 if (result >= 0)
940 if (copy_to_user(_control, control, sizeof(*control)))
941 result = -EFAULT;
942 kfree(control);
943 return result;
944}
945
82e9bae6
TI
946static int snd_ctl_elem_lock(struct snd_ctl_file *file,
947 struct snd_ctl_elem_id __user *_id)
1da177e4 948{
82e9bae6
TI
949 struct snd_card *card = file->card;
950 struct snd_ctl_elem_id id;
951 struct snd_kcontrol *kctl;
952 struct snd_kcontrol_volatile *vd;
1da177e4
LT
953 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;
1da177e4
LT
967 result = 0;
968 }
969 }
970 up_write(&card->controls_rwsem);
971 return result;
972}
973
82e9bae6
TI
974static int snd_ctl_elem_unlock(struct snd_ctl_file *file,
975 struct snd_ctl_elem_id __user *_id)
1da177e4 976{
82e9bae6
TI
977 struct snd_card *card = file->card;
978 struct snd_ctl_elem_id id;
979 struct snd_kcontrol *kctl;
980 struct snd_kcontrol_volatile *vd;
1da177e4
LT
981 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;
1da177e4
LT
997 result = 0;
998 }
999 }
1000 up_write(&card->controls_rwsem);
1001 return result;
1002}
1003
1004struct user_element {
82e9bae6 1005 struct snd_ctl_elem_info info;
07f4d9d7 1006 struct snd_card *card;
1da177e4
LT
1007 void *elem_data; /* element data */
1008 unsigned long elem_data_size; /* size of element data in bytes */
8aa9b586
JK
1009 void *tlv_data; /* TLV data */
1010 unsigned long tlv_data_size; /* TLV data size */
1da177e4 1011 void *priv_data; /* private data (like strings for enumerated type) */
1da177e4
LT
1012};
1013
82e9bae6
TI
1014static int snd_ctl_elem_user_info(struct snd_kcontrol *kcontrol,
1015 struct snd_ctl_elem_info *uinfo)
1da177e4
LT
1016{
1017 struct user_element *ue = kcontrol->private_data;
1018
1019 *uinfo = ue->info;
1020 return 0;
1021}
1022
8d448162
CL
1023static 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
82e9bae6
TI
1045static int snd_ctl_elem_user_get(struct snd_kcontrol *kcontrol,
1046 struct snd_ctl_elem_value *ucontrol)
1da177e4
LT
1047{
1048 struct user_element *ue = kcontrol->private_data;
1049
07f4d9d7 1050 mutex_lock(&ue->card->user_ctl_lock);
1da177e4 1051 memcpy(&ucontrol->value, ue->elem_data, ue->elem_data_size);
07f4d9d7 1052 mutex_unlock(&ue->card->user_ctl_lock);
1da177e4
LT
1053 return 0;
1054}
1055
82e9bae6
TI
1056static int snd_ctl_elem_user_put(struct snd_kcontrol *kcontrol,
1057 struct snd_ctl_elem_value *ucontrol)
1da177e4
LT
1058{
1059 int change;
1060 struct user_element *ue = kcontrol->private_data;
07f4d9d7
LPC
1061
1062 mutex_lock(&ue->card->user_ctl_lock);
1da177e4
LT
1063 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);
07f4d9d7 1066 mutex_unlock(&ue->card->user_ctl_lock);
1da177e4
LT
1067 return change;
1068}
1069
8aa9b586
JK
1070static 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;
ef44a1ec
LZ
1082
1083 new_data = memdup_user(tlv, size);
1084 if (IS_ERR(new_data))
1085 return PTR_ERR(new_data);
07f4d9d7 1086 mutex_lock(&ue->card->user_ctl_lock);
8aa9b586
JK
1087 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;
07f4d9d7 1093 mutex_unlock(&ue->card->user_ctl_lock);
8aa9b586 1094 } else {
07f4d9d7
LPC
1095 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 }
8aa9b586 1106 if (copy_to_user(tlv, ue->tlv_data, ue->tlv_data_size))
07f4d9d7
LPC
1107 ret = -EFAULT;
1108err_unlock:
1109 mutex_unlock(&ue->card->user_ctl_lock);
1110 if (ret)
1111 return ret;
8aa9b586
JK
1112 }
1113 return change;
1114}
1115
8d448162
CL
1116static 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;
447c6f93 1121 const uintptr_t user_ptrval = ue->info.value.enumerated.names_ptr;
8d448162
CL
1122
1123 if (ue->info.value.enumerated.names_length > 64 * 1024)
1124 return -EINVAL;
1125
447c6f93 1126 names = memdup_user((const void __user *)user_ptrval,
8d448162
CL
1127 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
82e9bae6 1150static void snd_ctl_elem_user_free(struct snd_kcontrol *kcontrol)
1da177e4 1151{
8aa9b586 1152 struct user_element *ue = kcontrol->private_data;
8d448162
CL
1153
1154 kfree(ue->tlv_data);
1155 kfree(ue->priv_data);
8aa9b586 1156 kfree(ue);
1da177e4
LT
1157}
1158
82e9bae6
TI
1159static int snd_ctl_elem_add(struct snd_ctl_file *file,
1160 struct snd_ctl_elem_info *info, int replace)
1da177e4 1161{
82e9bae6
TI
1162 struct snd_card *card = file->card;
1163 struct snd_kcontrol kctl, *_kctl;
1da177e4
LT
1164 unsigned int access;
1165 long private_size;
1166 struct user_element *ue;
1167 int idx, err;
983929ca 1168
2a031aed 1169 if (info->count < 1)
1da177e4
LT
1170 return -EINVAL;
1171 access = info->access == 0 ? SNDRV_CTL_ELEM_ACCESS_READWRITE :
82e9bae6 1172 (info->access & (SNDRV_CTL_ELEM_ACCESS_READWRITE|
8aa9b586
JK
1173 SNDRV_CTL_ELEM_ACCESS_INACTIVE|
1174 SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE));
1da177e4
LT
1175 info->id.numid = 0;
1176 memset(&kctl, 0, sizeof(kctl));
82262a46
LPC
1177
1178 if (replace) {
1179 err = snd_ctl_remove_user_ctl(file, &info->id);
1180 if (err)
1181 return err;
1da177e4 1182 }
82262a46
LPC
1183
1184 if (card->user_ctl_count >= MAX_USER_CONTROLS)
1185 return -ENOMEM;
1186
1da177e4
LT
1187 memcpy(&kctl.id, &info->id, sizeof(info->id));
1188 kctl.count = info->owner ? info->owner : 1;
1189 access |= SNDRV_CTL_ELEM_ACCESS_USER;
8d448162
CL
1190 if (info->type == SNDRV_CTL_ELEM_TYPE_ENUMERATED)
1191 kctl.info = snd_ctl_elem_user_enum_info;
1192 else
1193 kctl.info = snd_ctl_elem_user_info;
1da177e4
LT
1194 if (access & SNDRV_CTL_ELEM_ACCESS_READ)
1195 kctl.get = snd_ctl_elem_user_get;
1196 if (access & SNDRV_CTL_ELEM_ACCESS_WRITE)
1197 kctl.put = snd_ctl_elem_user_put;
8aa9b586
JK
1198 if (access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE) {
1199 kctl.tlv.c = snd_ctl_elem_user_tlv;
1200 access |= SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1201 }
1da177e4
LT
1202 switch (info->type) {
1203 case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
1da177e4
LT
1204 case SNDRV_CTL_ELEM_TYPE_INTEGER:
1205 private_size = sizeof(long);
1206 if (info->count > 128)
1207 return -EINVAL;
1208 break;
1209 case SNDRV_CTL_ELEM_TYPE_INTEGER64:
1210 private_size = sizeof(long long);
1211 if (info->count > 64)
1212 return -EINVAL;
1213 break;
8d448162
CL
1214 case SNDRV_CTL_ELEM_TYPE_ENUMERATED:
1215 private_size = sizeof(unsigned int);
1216 if (info->count > 128 || info->value.enumerated.items == 0)
1217 return -EINVAL;
1218 break;
1da177e4
LT
1219 case SNDRV_CTL_ELEM_TYPE_BYTES:
1220 private_size = sizeof(unsigned char);
1221 if (info->count > 512)
1222 return -EINVAL;
1223 break;
1224 case SNDRV_CTL_ELEM_TYPE_IEC958:
82e9bae6 1225 private_size = sizeof(struct snd_aes_iec958);
1da177e4
LT
1226 if (info->count != 1)
1227 return -EINVAL;
1228 break;
1229 default:
1230 return -EINVAL;
1231 }
1232 private_size *= info->count;
ca2c0966 1233 ue = kzalloc(sizeof(struct user_element) + private_size, GFP_KERNEL);
1da177e4
LT
1234 if (ue == NULL)
1235 return -ENOMEM;
07f4d9d7 1236 ue->card = card;
1da177e4 1237 ue->info = *info;
86148e84 1238 ue->info.access = 0;
1da177e4
LT
1239 ue->elem_data = (char *)ue + sizeof(*ue);
1240 ue->elem_data_size = private_size;
8d448162
CL
1241 if (ue->info.type == SNDRV_CTL_ELEM_TYPE_ENUMERATED) {
1242 err = snd_ctl_elem_init_enum_names(ue);
1243 if (err < 0) {
1244 kfree(ue);
1245 return err;
1246 }
1247 }
1da177e4
LT
1248 kctl.private_free = snd_ctl_elem_user_free;
1249 _kctl = snd_ctl_new(&kctl, access);
1250 if (_kctl == NULL) {
8d448162 1251 kfree(ue->priv_data);
2fbf182e 1252 kfree(ue);
1da177e4
LT
1253 return -ENOMEM;
1254 }
1255 _kctl->private_data = ue;
1256 for (idx = 0; idx < _kctl->count; idx++)
1257 _kctl->vd[idx].owner = file;
1258 err = snd_ctl_add(card, _kctl);
2fbf182e 1259 if (err < 0)
1da177e4 1260 return err;
1da177e4
LT
1261
1262 down_write(&card->controls_rwsem);
1263 card->user_ctl_count++;
1264 up_write(&card->controls_rwsem);
1265
1266 return 0;
1267}
1268
82e9bae6
TI
1269static int snd_ctl_elem_add_user(struct snd_ctl_file *file,
1270 struct snd_ctl_elem_info __user *_info, int replace)
1da177e4 1271{
82e9bae6 1272 struct snd_ctl_elem_info info;
1da177e4
LT
1273 if (copy_from_user(&info, _info, sizeof(info)))
1274 return -EFAULT;
1275 return snd_ctl_elem_add(file, &info, replace);
1276}
1277
82e9bae6
TI
1278static int snd_ctl_elem_remove(struct snd_ctl_file *file,
1279 struct snd_ctl_elem_id __user *_id)
1da177e4 1280{
82e9bae6 1281 struct snd_ctl_elem_id id;
1da177e4
LT
1282
1283 if (copy_from_user(&id, _id, sizeof(id)))
1284 return -EFAULT;
f217ac59 1285 return snd_ctl_remove_user_ctl(file, &id);
1da177e4
LT
1286}
1287
82e9bae6 1288static int snd_ctl_subscribe_events(struct snd_ctl_file *file, int __user *ptr)
1da177e4
LT
1289{
1290 int subscribe;
1291 if (get_user(subscribe, ptr))
1292 return -EFAULT;
1293 if (subscribe < 0) {
1294 subscribe = file->subscribed;
1295 if (put_user(subscribe, ptr))
1296 return -EFAULT;
1297 return 0;
1298 }
1299 if (subscribe) {
1300 file->subscribed = 1;
1301 return 0;
1302 } else if (file->subscribed) {
1303 snd_ctl_empty_read_queue(file);
1304 file->subscribed = 0;
1305 }
1306 return 0;
1307}
1308
8aa9b586
JK
1309static int snd_ctl_tlv_ioctl(struct snd_ctl_file *file,
1310 struct snd_ctl_tlv __user *_tlv,
1311 int op_flag)
42750b04 1312{
8aa9b586 1313 struct snd_card *card = file->card;
42750b04
JK
1314 struct snd_ctl_tlv tlv;
1315 struct snd_kcontrol *kctl;
8aa9b586 1316 struct snd_kcontrol_volatile *vd;
42750b04
JK
1317 unsigned int len;
1318 int err = 0;
1319
1320 if (copy_from_user(&tlv, _tlv, sizeof(tlv)))
1321 return -EFAULT;
6123637f 1322 if (tlv.length < sizeof(unsigned int) * 2)
8aa9b586
JK
1323 return -EINVAL;
1324 down_read(&card->controls_rwsem);
1325 kctl = snd_ctl_find_numid(card, tlv.numid);
1326 if (kctl == NULL) {
1327 err = -ENOENT;
1328 goto __kctl_end;
1329 }
1330 if (kctl->tlv.p == NULL) {
1331 err = -ENXIO;
1332 goto __kctl_end;
1333 }
1334 vd = &kctl->vd[tlv.numid - kctl->id.numid];
1335 if ((op_flag == 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) == 0) ||
1336 (op_flag > 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) == 0) ||
1337 (op_flag < 0 && (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND) == 0)) {
1338 err = -ENXIO;
1339 goto __kctl_end;
1340 }
1341 if (vd->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
bec145ae 1342 if (vd->owner != NULL && vd->owner != file) {
8aa9b586
JK
1343 err = -EPERM;
1344 goto __kctl_end;
1345 }
bd483d4c 1346 err = kctl->tlv.c(kctl, op_flag, tlv.length, _tlv->tlv);
8aa9b586 1347 if (err > 0) {
fd9f26e4 1348 struct snd_ctl_elem_id id = kctl->id;
8aa9b586 1349 up_read(&card->controls_rwsem);
fd9f26e4 1350 snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_TLV, &id);
8aa9b586
JK
1351 return 0;
1352 }
1353 } else {
1354 if (op_flag) {
1355 err = -ENXIO;
1356 goto __kctl_end;
1357 }
1358 len = kctl->tlv.p[1] + 2 * sizeof(unsigned int);
1359 if (tlv.length < len) {
1360 err = -ENOMEM;
1361 goto __kctl_end;
1362 }
1363 if (copy_to_user(_tlv->tlv, kctl->tlv.p, len))
1364 err = -EFAULT;
1365 }
42750b04 1366 __kctl_end:
8aa9b586
JK
1367 up_read(&card->controls_rwsem);
1368 return err;
42750b04
JK
1369}
1370
1da177e4
LT
1371static long snd_ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1372{
82e9bae6
TI
1373 struct snd_ctl_file *ctl;
1374 struct snd_card *card;
82e9bae6 1375 struct snd_kctl_ioctl *p;
1da177e4
LT
1376 void __user *argp = (void __user *)arg;
1377 int __user *ip = argp;
1378 int err;
1379
1380 ctl = file->private_data;
1381 card = ctl->card;
7eaa943c
TI
1382 if (snd_BUG_ON(!card))
1383 return -ENXIO;
1da177e4
LT
1384 switch (cmd) {
1385 case SNDRV_CTL_IOCTL_PVERSION:
1386 return put_user(SNDRV_CTL_VERSION, ip) ? -EFAULT : 0;
1387 case SNDRV_CTL_IOCTL_CARD_INFO:
1388 return snd_ctl_card_info(card, ctl, cmd, argp);
1389 case SNDRV_CTL_IOCTL_ELEM_LIST:
42750b04 1390 return snd_ctl_elem_list(card, argp);
1da177e4
LT
1391 case SNDRV_CTL_IOCTL_ELEM_INFO:
1392 return snd_ctl_elem_info_user(ctl, argp);
1393 case SNDRV_CTL_IOCTL_ELEM_READ:
42750b04 1394 return snd_ctl_elem_read_user(card, argp);
1da177e4
LT
1395 case SNDRV_CTL_IOCTL_ELEM_WRITE:
1396 return snd_ctl_elem_write_user(ctl, argp);
1397 case SNDRV_CTL_IOCTL_ELEM_LOCK:
1398 return snd_ctl_elem_lock(ctl, argp);
1399 case SNDRV_CTL_IOCTL_ELEM_UNLOCK:
1400 return snd_ctl_elem_unlock(ctl, argp);
1401 case SNDRV_CTL_IOCTL_ELEM_ADD:
1402 return snd_ctl_elem_add_user(ctl, argp, 0);
1403 case SNDRV_CTL_IOCTL_ELEM_REPLACE:
1404 return snd_ctl_elem_add_user(ctl, argp, 1);
1405 case SNDRV_CTL_IOCTL_ELEM_REMOVE:
1406 return snd_ctl_elem_remove(ctl, argp);
1407 case SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS:
1408 return snd_ctl_subscribe_events(ctl, ip);
8aa9b586 1409 case SNDRV_CTL_IOCTL_TLV_READ:
0cea76f3 1410 return snd_ctl_tlv_ioctl(ctl, argp, SNDRV_CTL_TLV_OP_READ);
8aa9b586 1411 case SNDRV_CTL_IOCTL_TLV_WRITE:
0cea76f3 1412 return snd_ctl_tlv_ioctl(ctl, argp, SNDRV_CTL_TLV_OP_WRITE);
8aa9b586 1413 case SNDRV_CTL_IOCTL_TLV_COMMAND:
0cea76f3 1414 return snd_ctl_tlv_ioctl(ctl, argp, SNDRV_CTL_TLV_OP_CMD);
1da177e4 1415 case SNDRV_CTL_IOCTL_POWER:
a381a7a6 1416 return -ENOPROTOOPT;
1da177e4
LT
1417 case SNDRV_CTL_IOCTL_POWER_STATE:
1418#ifdef CONFIG_PM
1419 return put_user(card->power_state, ip) ? -EFAULT : 0;
1420#else
1421 return put_user(SNDRV_CTL_POWER_D0, ip) ? -EFAULT : 0;
1422#endif
1423 }
1424 down_read(&snd_ioctl_rwsem);
9244b2c3 1425 list_for_each_entry(p, &snd_control_ioctls, list) {
1da177e4
LT
1426 err = p->fioctl(card, ctl, cmd, arg);
1427 if (err != -ENOIOCTLCMD) {
1428 up_read(&snd_ioctl_rwsem);
1429 return err;
1430 }
1431 }
1432 up_read(&snd_ioctl_rwsem);
bb009457 1433 dev_dbg(card->dev, "unknown ioctl = 0x%x\n", cmd);
1da177e4
LT
1434 return -ENOTTY;
1435}
1436
82e9bae6
TI
1437static ssize_t snd_ctl_read(struct file *file, char __user *buffer,
1438 size_t count, loff_t * offset)
1da177e4 1439{
82e9bae6 1440 struct snd_ctl_file *ctl;
1da177e4
LT
1441 int err = 0;
1442 ssize_t result = 0;
1443
1444 ctl = file->private_data;
7eaa943c
TI
1445 if (snd_BUG_ON(!ctl || !ctl->card))
1446 return -ENXIO;
1da177e4
LT
1447 if (!ctl->subscribed)
1448 return -EBADFD;
82e9bae6 1449 if (count < sizeof(struct snd_ctl_event))
1da177e4
LT
1450 return -EINVAL;
1451 spin_lock_irq(&ctl->read_lock);
82e9bae6
TI
1452 while (count >= sizeof(struct snd_ctl_event)) {
1453 struct snd_ctl_event ev;
1454 struct snd_kctl_event *kev;
1da177e4
LT
1455 while (list_empty(&ctl->events)) {
1456 wait_queue_t wait;
1457 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1458 err = -EAGAIN;
1459 goto __end_lock;
1460 }
1461 init_waitqueue_entry(&wait, current);
1462 add_wait_queue(&ctl->change_sleep, &wait);
1463 set_current_state(TASK_INTERRUPTIBLE);
1464 spin_unlock_irq(&ctl->read_lock);
1465 schedule();
1466 remove_wait_queue(&ctl->change_sleep, &wait);
0914f796
TI
1467 if (ctl->card->shutdown)
1468 return -ENODEV;
1da177e4 1469 if (signal_pending(current))
0e5d720c 1470 return -ERESTARTSYS;
1da177e4
LT
1471 spin_lock_irq(&ctl->read_lock);
1472 }
1473 kev = snd_kctl_event(ctl->events.next);
1474 ev.type = SNDRV_CTL_EVENT_ELEM;
1475 ev.data.elem.mask = kev->mask;
1476 ev.data.elem.id = kev->id;
1477 list_del(&kev->list);
1478 spin_unlock_irq(&ctl->read_lock);
1479 kfree(kev);
82e9bae6 1480 if (copy_to_user(buffer, &ev, sizeof(struct snd_ctl_event))) {
1da177e4
LT
1481 err = -EFAULT;
1482 goto __end;
1483 }
1484 spin_lock_irq(&ctl->read_lock);
82e9bae6
TI
1485 buffer += sizeof(struct snd_ctl_event);
1486 count -= sizeof(struct snd_ctl_event);
1487 result += sizeof(struct snd_ctl_event);
1da177e4
LT
1488 }
1489 __end_lock:
1490 spin_unlock_irq(&ctl->read_lock);
1491 __end:
1492 return result > 0 ? result : err;
1493}
1494
1495static unsigned int snd_ctl_poll(struct file *file, poll_table * wait)
1496{
1497 unsigned int mask;
82e9bae6 1498 struct snd_ctl_file *ctl;
1da177e4
LT
1499
1500 ctl = file->private_data;
1501 if (!ctl->subscribed)
1502 return 0;
1503 poll_wait(file, &ctl->change_sleep, wait);
1504
1505 mask = 0;
1506 if (!list_empty(&ctl->events))
1507 mask |= POLLIN | POLLRDNORM;
1508
1509 return mask;
1510}
1511
1512/*
1513 * register the device-specific control-ioctls.
1514 * called from each device manager like pcm.c, hwdep.c, etc.
1515 */
1516static int _snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn, struct list_head *lists)
1517{
82e9bae6 1518 struct snd_kctl_ioctl *pn;
1da177e4 1519
82e9bae6 1520 pn = kzalloc(sizeof(struct snd_kctl_ioctl), GFP_KERNEL);
1da177e4
LT
1521 if (pn == NULL)
1522 return -ENOMEM;
1523 pn->fioctl = fcn;
1524 down_write(&snd_ioctl_rwsem);
1525 list_add_tail(&pn->list, lists);
1526 up_write(&snd_ioctl_rwsem);
1527 return 0;
1528}
1529
12cddbd8
TI
1530/**
1531 * snd_ctl_register_ioctl - register the device-specific control-ioctls
1532 * @fcn: ioctl callback function
1533 *
1534 * called from each device manager like pcm.c, hwdep.c, etc.
1535 */
1da177e4
LT
1536int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn)
1537{
1538 return _snd_ctl_register_ioctl(fcn, &snd_control_ioctls);
1539}
c0d3fb39
TI
1540EXPORT_SYMBOL(snd_ctl_register_ioctl);
1541
1da177e4 1542#ifdef CONFIG_COMPAT
12cddbd8
TI
1543/**
1544 * snd_ctl_register_ioctl_compat - register the device-specific 32bit compat
1545 * control-ioctls
1546 * @fcn: ioctl callback function
1547 */
1da177e4
LT
1548int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1549{
1550 return _snd_ctl_register_ioctl(fcn, &snd_control_compat_ioctls);
1551}
c0d3fb39 1552EXPORT_SYMBOL(snd_ctl_register_ioctl_compat);
1da177e4
LT
1553#endif
1554
1555/*
1556 * de-register the device-specific control-ioctls.
1557 */
82e9bae6
TI
1558static int _snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn,
1559 struct list_head *lists)
1da177e4 1560{
82e9bae6 1561 struct snd_kctl_ioctl *p;
1da177e4 1562
7eaa943c
TI
1563 if (snd_BUG_ON(!fcn))
1564 return -EINVAL;
1da177e4 1565 down_write(&snd_ioctl_rwsem);
9244b2c3 1566 list_for_each_entry(p, lists, list) {
1da177e4
LT
1567 if (p->fioctl == fcn) {
1568 list_del(&p->list);
1569 up_write(&snd_ioctl_rwsem);
1570 kfree(p);
1571 return 0;
1572 }
1573 }
1574 up_write(&snd_ioctl_rwsem);
1575 snd_BUG();
1576 return -EINVAL;
1577}
1578
12cddbd8
TI
1579/**
1580 * snd_ctl_unregister_ioctl - de-register the device-specific control-ioctls
1581 * @fcn: ioctl callback function to unregister
1582 */
1da177e4
LT
1583int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn)
1584{
1585 return _snd_ctl_unregister_ioctl(fcn, &snd_control_ioctls);
1586}
c0d3fb39
TI
1587EXPORT_SYMBOL(snd_ctl_unregister_ioctl);
1588
1da177e4 1589#ifdef CONFIG_COMPAT
12cddbd8
TI
1590/**
1591 * snd_ctl_unregister_ioctl - de-register the device-specific compat 32bit
1592 * control-ioctls
1593 * @fcn: ioctl callback function to unregister
1594 */
1da177e4
LT
1595int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn)
1596{
1597 return _snd_ctl_unregister_ioctl(fcn, &snd_control_compat_ioctls);
1598}
c0d3fb39 1599EXPORT_SYMBOL(snd_ctl_unregister_ioctl_compat);
1da177e4
LT
1600#endif
1601
1602static int snd_ctl_fasync(int fd, struct file * file, int on)
1603{
82e9bae6 1604 struct snd_ctl_file *ctl;
60aa4924 1605
1da177e4 1606 ctl = file->private_data;
60aa4924 1607 return fasync_helper(fd, file, on, &ctl->fasync);
1da177e4
LT
1608}
1609
23c18d4b
TI
1610/* return the preferred subdevice number if already assigned;
1611 * otherwise return -1
1612 */
1613int snd_ctl_get_preferred_subdevice(struct snd_card *card, int type)
1614{
1615 struct snd_ctl_file *kctl;
1616 int subdevice = -1;
1617
1618 read_lock(&card->ctl_files_rwlock);
1619 list_for_each_entry(kctl, &card->ctl_files, list) {
1620 if (kctl->pid == task_pid(current)) {
1621 subdevice = kctl->preferred_subdevice[type];
1622 if (subdevice != -1)
1623 break;
1624 }
1625 }
1626 read_unlock(&card->ctl_files_rwlock);
1627 return subdevice;
1628}
1629EXPORT_SYMBOL_GPL(snd_ctl_get_preferred_subdevice);
1630
1da177e4
LT
1631/*
1632 * ioctl32 compat
1633 */
1634#ifdef CONFIG_COMPAT
1635#include "control_compat.c"
1636#else
1637#define snd_ctl_ioctl_compat NULL
1638#endif
1639
1640/*
1641 * INIT PART
1642 */
1643
9c2e08c5 1644static const struct file_operations snd_ctl_f_ops =
1da177e4
LT
1645{
1646 .owner = THIS_MODULE,
1647 .read = snd_ctl_read,
1648 .open = snd_ctl_open,
1649 .release = snd_ctl_release,
02f4865f 1650 .llseek = no_llseek,
1da177e4
LT
1651 .poll = snd_ctl_poll,
1652 .unlocked_ioctl = snd_ctl_ioctl,
1653 .compat_ioctl = snd_ctl_ioctl_compat,
1654 .fasync = snd_ctl_fasync,
1655};
1656
1da177e4
LT
1657/*
1658 * registration of the control device
1659 */
82e9bae6 1660static int snd_ctl_dev_register(struct snd_device *device)
1da177e4 1661{
82e9bae6 1662 struct snd_card *card = device->device_data;
1da177e4
LT
1663 int err, cardnum;
1664 char name[16];
1665
7eaa943c
TI
1666 if (snd_BUG_ON(!card))
1667 return -ENXIO;
1da177e4 1668 cardnum = card->number;
7eaa943c
TI
1669 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1670 return -ENXIO;
1da177e4 1671 sprintf(name, "controlC%i", cardnum);
f87135f5
CL
1672 if ((err = snd_register_device(SNDRV_DEVICE_TYPE_CONTROL, card, -1,
1673 &snd_ctl_f_ops, card, name)) < 0)
1da177e4
LT
1674 return err;
1675 return 0;
1676}
1677
1678/*
1679 * disconnection of the control device
1680 */
82e9bae6 1681static int snd_ctl_dev_disconnect(struct snd_device *device)
1da177e4 1682{
82e9bae6 1683 struct snd_card *card = device->device_data;
82e9bae6 1684 struct snd_ctl_file *ctl;
c461482c
TI
1685 int err, cardnum;
1686
7eaa943c
TI
1687 if (snd_BUG_ON(!card))
1688 return -ENXIO;
c461482c 1689 cardnum = card->number;
7eaa943c
TI
1690 if (snd_BUG_ON(cardnum < 0 || cardnum >= SNDRV_CARDS))
1691 return -ENXIO;
1da177e4 1692
d8009882 1693 read_lock(&card->ctl_files_rwlock);
9244b2c3 1694 list_for_each_entry(ctl, &card->ctl_files, list) {
1da177e4
LT
1695 wake_up(&ctl->change_sleep);
1696 kill_fasync(&ctl->fasync, SIGIO, POLL_ERR);
1697 }
d8009882 1698 read_unlock(&card->ctl_files_rwlock);
c461482c
TI
1699
1700 if ((err = snd_unregister_device(SNDRV_DEVICE_TYPE_CONTROL,
1701 card, -1)) < 0)
1702 return err;
1da177e4
LT
1703 return 0;
1704}
1705
1706/*
1707 * free all controls
1708 */
82e9bae6 1709static int snd_ctl_dev_free(struct snd_device *device)
1da177e4 1710{
82e9bae6
TI
1711 struct snd_card *card = device->device_data;
1712 struct snd_kcontrol *control;
1da177e4
LT
1713
1714 down_write(&card->controls_rwsem);
1715 while (!list_empty(&card->controls)) {
1716 control = snd_kcontrol(card->controls.next);
1717 snd_ctl_remove(card, control);
1718 }
1719 up_write(&card->controls_rwsem);
1720 return 0;
1721}
1722
1da177e4
LT
1723/*
1724 * create control core:
1725 * called from init.c
1726 */
82e9bae6 1727int snd_ctl_create(struct snd_card *card)
1da177e4 1728{
82e9bae6 1729 static struct snd_device_ops ops = {
1da177e4
LT
1730 .dev_free = snd_ctl_dev_free,
1731 .dev_register = snd_ctl_dev_register,
1732 .dev_disconnect = snd_ctl_dev_disconnect,
1da177e4
LT
1733 };
1734
7eaa943c
TI
1735 if (snd_BUG_ON(!card))
1736 return -ENXIO;
1da177e4
LT
1737 return snd_device_new(card, SNDRV_DEV_CONTROL, card, &ops);
1738}
b9ed4f2b
TI
1739
1740/*
9600732b 1741 * Frequently used control callbacks/helpers
b9ed4f2b 1742 */
12cddbd8
TI
1743
1744/**
1745 * snd_ctl_boolean_mono_info - Helper function for a standard boolean info
1746 * callback with a mono channel
1747 * @kcontrol: the kcontrol instance
1748 * @uinfo: info to store
1749 *
1750 * This is a function that can be used as info callback for a standard
1751 * boolean control with a single mono channel.
1752 */
b9ed4f2b
TI
1753int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
1754 struct snd_ctl_elem_info *uinfo)
1755{
1756 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1757 uinfo->count = 1;
1758 uinfo->value.integer.min = 0;
1759 uinfo->value.integer.max = 1;
1760 return 0;
1761}
b9ed4f2b
TI
1762EXPORT_SYMBOL(snd_ctl_boolean_mono_info);
1763
12cddbd8
TI
1764/**
1765 * snd_ctl_boolean_stereo_info - Helper function for a standard boolean info
1766 * callback with stereo two channels
1767 * @kcontrol: the kcontrol instance
1768 * @uinfo: info to store
1769 *
1770 * This is a function that can be used as info callback for a standard
1771 * boolean control with stereo two channels.
1772 */
b9ed4f2b
TI
1773int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
1774 struct snd_ctl_elem_info *uinfo)
1775{
1776 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1777 uinfo->count = 2;
1778 uinfo->value.integer.min = 0;
1779 uinfo->value.integer.max = 1;
1780 return 0;
1781}
b9ed4f2b 1782EXPORT_SYMBOL(snd_ctl_boolean_stereo_info);
9600732b
CL
1783
1784/**
1785 * snd_ctl_enum_info - fills the info structure for an enumerated control
1786 * @info: the structure to be filled
1787 * @channels: the number of the control's channels; often one
1788 * @items: the number of control values; also the size of @names
1789 * @names: an array containing the names of all control values
1790 *
1791 * Sets all required fields in @info to their appropriate values.
1792 * If the control's accessibility is not the default (readable and writable),
1793 * the caller has to fill @info->access.
eb7c06e8
YB
1794 *
1795 * Return: Zero.
9600732b
CL
1796 */
1797int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
1798 unsigned int items, const char *const names[])
1799{
1800 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1801 info->count = channels;
1802 info->value.enumerated.items = items;
a7e6fb99
TI
1803 if (!items)
1804 return 0;
9600732b
CL
1805 if (info->value.enumerated.item >= items)
1806 info->value.enumerated.item = items - 1;
df803e13
TI
1807 WARN(strlen(names[info->value.enumerated.item]) >= sizeof(info->value.enumerated.name),
1808 "ALSA: too long item name '%s'\n",
1809 names[info->value.enumerated.item]);
9600732b
CL
1810 strlcpy(info->value.enumerated.name,
1811 names[info->value.enumerated.item],
1812 sizeof(info->value.enumerated.name));
1813 return 0;
1814}
1815EXPORT_SYMBOL(snd_ctl_enum_info);