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