blob: fe836618fa25ee7949acff599afe1ce38679abbb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Information interface for ALSA driver
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02003 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 */
21
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/time.h>
Andrea Righi27ac7922008-07-23 21:28:13 -070024#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/smp_lock.h>
Paulo Marques543537b2005-06-23 00:09:02 -070026#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <sound/core.h>
28#include <sound/minors.h>
29#include <sound/info.h>
30#include <sound/version.h>
31#include <linux/proc_fs.h>
Ingo Molnar1a60d4c2006-01-16 16:29:08 +010032#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <stdarg.h>
34
35/*
36 *
37 */
38
Takashi Iwaie28563c2005-12-01 10:42:42 +010039#ifdef CONFIG_PROC_FS
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041int snd_info_check_reserved_words(const char *str)
42{
43 static char *reserved[] =
44 {
45 "version",
46 "meminfo",
47 "memdebug",
48 "detect",
49 "devices",
50 "oss",
51 "cards",
52 "timers",
53 "synth",
54 "pcm",
55 "seq",
56 NULL
57 };
58 char **xstr = reserved;
59
60 while (*xstr) {
61 if (!strcmp(*xstr, str))
62 return 0;
63 xstr++;
64 }
65 if (!strncmp(str, "card", 4))
66 return 0;
67 return 1;
68}
69
Ingo Molnar1a60d4c2006-01-16 16:29:08 +010070static DEFINE_MUTEX(info_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Takashi Iwai24c1f932005-11-17 13:58:48 +010072struct snd_info_private_data {
73 struct snd_info_buffer *rbuffer;
74 struct snd_info_buffer *wbuffer;
75 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 void *file_private_data;
Takashi Iwai24c1f932005-11-17 13:58:48 +010077};
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
79static int snd_info_version_init(void);
80static int snd_info_version_done(void);
Takashi Iwai746d4a02006-06-23 14:37:59 +020081static void snd_info_disconnect(struct snd_info_entry *entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83
Takashi Iwai7e4eeec2006-04-28 15:13:40 +020084/* resize the proc r/w buffer */
85static int resize_info_buffer(struct snd_info_buffer *buffer,
86 unsigned int nsize)
87{
88 char *nbuf;
89
90 nsize = PAGE_ALIGN(nsize);
Takashi Iwai9983aa62009-07-06 14:31:59 +020091 nbuf = krealloc(buffer->buffer, nsize, GFP_KERNEL);
Takashi Iwai7e4eeec2006-04-28 15:13:40 +020092 if (! nbuf)
93 return -ENOMEM;
94
Takashi Iwai7e4eeec2006-04-28 15:13:40 +020095 buffer->buffer = nbuf;
96 buffer->len = nsize;
97 return 0;
98}
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100/**
101 * snd_iprintf - printf on the procfs buffer
102 * @buffer: the procfs buffer
103 * @fmt: the printf format
104 *
105 * Outputs the string on the procfs buffer just like printf().
106 *
107 * Returns the size of output string.
108 */
Takashi Iwai4f7454a2009-09-08 14:29:58 +0200109int snd_iprintf(struct snd_info_buffer *buffer, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110{
111 va_list args;
112 int len, res;
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200113 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Takashi Iwaif001c3a2006-04-28 15:13:41 +0200115 might_sleep();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 if (buffer->stop || buffer->error)
117 return 0;
118 len = buffer->len - buffer->size;
119 va_start(args, fmt);
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200120 for (;;) {
Takashi Iwaidbedca32006-10-18 19:09:46 +0200121 va_list ap;
122 va_copy(ap, args);
123 res = vsnprintf(buffer->buffer + buffer->curr, len, fmt, ap);
124 va_end(ap);
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200125 if (res < len)
126 break;
127 err = resize_info_buffer(buffer, buffer->len + PAGE_SIZE);
128 if (err < 0)
129 break;
130 len = buffer->len - buffer->size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 }
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200132 va_end(args);
133
134 if (err < 0)
135 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 buffer->curr += res;
137 buffer->size += res;
138 return res;
139}
140
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200141EXPORT_SYMBOL(snd_iprintf);
142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143/*
144
145 */
146
Takashi Iwai6581f4e2006-05-17 17:14:51 +0200147static struct proc_dir_entry *snd_proc_root;
148struct snd_info_entry *snd_seq_root;
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200149EXPORT_SYMBOL(snd_seq_root);
150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151#ifdef CONFIG_SND_OSSEMUL
Takashi Iwai6581f4e2006-05-17 17:14:51 +0200152struct snd_info_entry *snd_oss_root;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153#endif
154
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155static void snd_remove_proc_entry(struct proc_dir_entry *parent,
156 struct proc_dir_entry *de)
157{
158 if (de)
159 remove_proc_entry(de->name, parent);
160}
161
162static loff_t snd_info_entry_llseek(struct file *file, loff_t offset, int orig)
163{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100164 struct snd_info_private_data *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 struct snd_info_entry *entry;
166 loff_t ret;
167
168 data = file->private_data;
169 entry = data->entry;
Takashi Iwai5b5cd552010-04-07 18:33:57 +0200170 mutex_lock(&entry->access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 switch (entry->content) {
172 case SNDRV_INFO_CONTENT_TEXT:
173 switch (orig) {
Josef 'Jeff' Sipeke6f8f102006-09-21 11:31:58 +0200174 case SEEK_SET:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 file->f_pos = offset;
176 ret = file->f_pos;
177 goto out;
Josef 'Jeff' Sipeke6f8f102006-09-21 11:31:58 +0200178 case SEEK_CUR:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 file->f_pos += offset;
180 ret = file->f_pos;
181 goto out;
Josef 'Jeff' Sipeke6f8f102006-09-21 11:31:58 +0200182 case SEEK_END:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 default:
184 ret = -EINVAL;
185 goto out;
186 }
187 break;
188 case SNDRV_INFO_CONTENT_DATA:
189 if (entry->c.ops->llseek) {
190 ret = entry->c.ops->llseek(entry,
191 data->file_private_data,
192 file, offset, orig);
193 goto out;
194 }
195 break;
196 }
197 ret = -ENXIO;
198out:
Takashi Iwai5b5cd552010-04-07 18:33:57 +0200199 mutex_unlock(&entry->access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 return ret;
201}
202
203static ssize_t snd_info_entry_read(struct file *file, char __user *buffer,
204 size_t count, loff_t * offset)
205{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100206 struct snd_info_private_data *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 struct snd_info_entry *entry;
Takashi Iwai24c1f932005-11-17 13:58:48 +0100208 struct snd_info_buffer *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 size_t size = 0;
210 loff_t pos;
211
212 data = file->private_data;
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200213 if (snd_BUG_ON(!data))
214 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 pos = *offset;
216 if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
217 return -EIO;
218 if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
219 return -EIO;
220 entry = data->entry;
221 switch (entry->content) {
222 case SNDRV_INFO_CONTENT_TEXT:
223 buf = data->rbuffer;
224 if (buf == NULL)
225 return -EIO;
226 if (pos >= buf->size)
227 return 0;
228 size = buf->size - pos;
229 size = min(count, size);
230 if (copy_to_user(buffer, buf->buffer + pos, size))
231 return -EFAULT;
232 break;
233 case SNDRV_INFO_CONTENT_DATA:
234 if (entry->c.ops->read)
235 size = entry->c.ops->read(entry,
236 data->file_private_data,
237 file, buffer, count, pos);
238 break;
239 }
240 if ((ssize_t) size > 0)
241 *offset = pos + size;
242 return size;
243}
244
245static ssize_t snd_info_entry_write(struct file *file, const char __user *buffer,
246 size_t count, loff_t * offset)
247{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100248 struct snd_info_private_data *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 struct snd_info_entry *entry;
Takashi Iwai24c1f932005-11-17 13:58:48 +0100250 struct snd_info_buffer *buf;
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200251 ssize_t size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 loff_t pos;
253
254 data = file->private_data;
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200255 if (snd_BUG_ON(!data))
256 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 entry = data->entry;
258 pos = *offset;
259 if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
260 return -EIO;
261 if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
262 return -EIO;
263 switch (entry->content) {
264 case SNDRV_INFO_CONTENT_TEXT:
265 buf = data->wbuffer;
266 if (buf == NULL)
267 return -EIO;
Clemens Ladischf4a747f2006-05-02 15:33:25 +0200268 mutex_lock(&entry->access);
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200269 if (pos + count >= buf->len) {
270 if (resize_info_buffer(buf, pos + count)) {
271 mutex_unlock(&entry->access);
272 return -ENOMEM;
273 }
274 }
275 if (copy_from_user(buf->buffer + pos, buffer, count)) {
276 mutex_unlock(&entry->access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 return -EFAULT;
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200278 }
279 buf->size = pos + count;
280 mutex_unlock(&entry->access);
281 size = count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 break;
283 case SNDRV_INFO_CONTENT_DATA:
284 if (entry->c.ops->write)
285 size = entry->c.ops->write(entry,
286 data->file_private_data,
287 file, buffer, count, pos);
288 break;
289 }
290 if ((ssize_t) size > 0)
291 *offset = pos + size;
292 return size;
293}
294
295static int snd_info_entry_open(struct inode *inode, struct file *file)
296{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100297 struct snd_info_entry *entry;
298 struct snd_info_private_data *data;
299 struct snd_info_buffer *buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 struct proc_dir_entry *p;
301 int mode, err;
302
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100303 mutex_lock(&info_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 p = PDE(inode);
Takashi Iwai24c1f932005-11-17 13:58:48 +0100305 entry = p == NULL ? NULL : (struct snd_info_entry *)p->data;
Takashi Iwai746d4a02006-06-23 14:37:59 +0200306 if (entry == NULL || ! entry->p) {
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100307 mutex_unlock(&info_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 return -ENODEV;
309 }
310 if (!try_module_get(entry->module)) {
311 err = -EFAULT;
312 goto __error1;
313 }
314 mode = file->f_flags & O_ACCMODE;
315 if (mode == O_RDONLY || mode == O_RDWR) {
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200316 if ((entry->content == SNDRV_INFO_CONTENT_DATA &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 entry->c.ops->read == NULL)) {
318 err = -ENODEV;
319 goto __error;
320 }
321 }
322 if (mode == O_WRONLY || mode == O_RDWR) {
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200323 if ((entry->content == SNDRV_INFO_CONTENT_DATA &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 entry->c.ops->write == NULL)) {
325 err = -ENODEV;
326 goto __error;
327 }
328 }
Takashi Iwaica2c0962005-09-09 14:20:23 +0200329 data = kzalloc(sizeof(*data), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 if (data == NULL) {
331 err = -ENOMEM;
332 goto __error;
333 }
334 data->entry = entry;
335 switch (entry->content) {
336 case SNDRV_INFO_CONTENT_TEXT:
337 if (mode == O_RDONLY || mode == O_RDWR) {
Takashi Iwaica2c0962005-09-09 14:20:23 +0200338 buffer = kzalloc(sizeof(*buffer), GFP_KERNEL);
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200339 if (buffer == NULL)
340 goto __nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 data->rbuffer = buffer;
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200342 buffer->len = PAGE_SIZE;
343 buffer->buffer = kmalloc(buffer->len, GFP_KERNEL);
344 if (buffer->buffer == NULL)
345 goto __nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 }
347 if (mode == O_WRONLY || mode == O_RDWR) {
Takashi Iwaica2c0962005-09-09 14:20:23 +0200348 buffer = kzalloc(sizeof(*buffer), GFP_KERNEL);
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200349 if (buffer == NULL)
350 goto __nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 data->wbuffer = buffer;
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200352 buffer->len = PAGE_SIZE;
353 buffer->buffer = kmalloc(buffer->len, GFP_KERNEL);
354 if (buffer->buffer == NULL)
355 goto __nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 }
357 break;
358 case SNDRV_INFO_CONTENT_DATA: /* data */
359 if (entry->c.ops->open) {
360 if ((err = entry->c.ops->open(entry, mode,
361 &data->file_private_data)) < 0) {
362 kfree(data);
363 goto __error;
364 }
365 }
366 break;
367 }
368 file->private_data = data;
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100369 mutex_unlock(&info_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 if (entry->content == SNDRV_INFO_CONTENT_TEXT &&
371 (mode == O_RDONLY || mode == O_RDWR)) {
372 if (entry->c.text.read) {
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100373 mutex_lock(&entry->access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 entry->c.text.read(entry, data->rbuffer);
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100375 mutex_unlock(&entry->access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 }
377 }
378 return 0;
379
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200380 __nomem:
381 if (data->rbuffer) {
382 kfree(data->rbuffer->buffer);
383 kfree(data->rbuffer);
384 }
385 if (data->wbuffer) {
386 kfree(data->wbuffer->buffer);
387 kfree(data->wbuffer);
388 }
389 kfree(data);
390 err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 __error:
392 module_put(entry->module);
393 __error1:
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100394 mutex_unlock(&info_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 return err;
396}
397
398static int snd_info_entry_release(struct inode *inode, struct file *file)
399{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100400 struct snd_info_entry *entry;
401 struct snd_info_private_data *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 int mode;
403
404 mode = file->f_flags & O_ACCMODE;
405 data = file->private_data;
406 entry = data->entry;
407 switch (entry->content) {
408 case SNDRV_INFO_CONTENT_TEXT:
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200409 if (data->rbuffer) {
410 kfree(data->rbuffer->buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 kfree(data->rbuffer);
412 }
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200413 if (data->wbuffer) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 if (entry->c.text.write) {
415 entry->c.text.write(entry, data->wbuffer);
416 if (data->wbuffer->error) {
417 snd_printk(KERN_WARNING "data write error to %s (%i)\n",
418 entry->name,
419 data->wbuffer->error);
420 }
421 }
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200422 kfree(data->wbuffer->buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 kfree(data->wbuffer);
424 }
425 break;
426 case SNDRV_INFO_CONTENT_DATA:
427 if (entry->c.ops->release)
428 entry->c.ops->release(entry, mode,
429 data->file_private_data);
430 break;
431 }
432 module_put(entry->module);
433 kfree(data);
434 return 0;
435}
436
437static unsigned int snd_info_entry_poll(struct file *file, poll_table * wait)
438{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100439 struct snd_info_private_data *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 struct snd_info_entry *entry;
441 unsigned int mask;
442
443 data = file->private_data;
444 if (data == NULL)
445 return 0;
446 entry = data->entry;
447 mask = 0;
448 switch (entry->content) {
449 case SNDRV_INFO_CONTENT_DATA:
450 if (entry->c.ops->poll)
451 return entry->c.ops->poll(entry,
452 data->file_private_data,
453 file, wait);
454 if (entry->c.ops->read)
455 mask |= POLLIN | POLLRDNORM;
456 if (entry->c.ops->write)
457 mask |= POLLOUT | POLLWRNORM;
458 break;
459 }
460 return mask;
461}
462
Ingo Molnard99e9882006-01-09 16:44:46 +0100463static long snd_info_entry_ioctl(struct file *file, unsigned int cmd,
464 unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100466 struct snd_info_private_data *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 struct snd_info_entry *entry;
468
469 data = file->private_data;
470 if (data == NULL)
471 return 0;
472 entry = data->entry;
473 switch (entry->content) {
474 case SNDRV_INFO_CONTENT_DATA:
475 if (entry->c.ops->ioctl)
476 return entry->c.ops->ioctl(entry,
477 data->file_private_data,
478 file, cmd, arg);
479 break;
480 }
481 return -ENOTTY;
482}
483
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484static int snd_info_entry_mmap(struct file *file, struct vm_area_struct *vma)
485{
Josef Sipek7bc56322006-12-08 02:37:40 -0800486 struct inode *inode = file->f_path.dentry->d_inode;
Takashi Iwai24c1f932005-11-17 13:58:48 +0100487 struct snd_info_private_data *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 struct snd_info_entry *entry;
489
490 data = file->private_data;
491 if (data == NULL)
492 return 0;
493 entry = data->entry;
494 switch (entry->content) {
495 case SNDRV_INFO_CONTENT_DATA:
496 if (entry->c.ops->mmap)
497 return entry->c.ops->mmap(entry,
498 data->file_private_data,
499 inode, file, vma);
500 break;
501 }
502 return -ENXIO;
503}
504
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -0800505static const struct file_operations snd_info_entry_operations =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506{
Ingo Molnard99e9882006-01-09 16:44:46 +0100507 .owner = THIS_MODULE,
508 .llseek = snd_info_entry_llseek,
509 .read = snd_info_entry_read,
510 .write = snd_info_entry_write,
511 .poll = snd_info_entry_poll,
512 .unlocked_ioctl = snd_info_entry_ioctl,
513 .mmap = snd_info_entry_mmap,
514 .open = snd_info_entry_open,
515 .release = snd_info_entry_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516};
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518int __init snd_info_init(void)
519{
520 struct proc_dir_entry *p;
521
Alexey Dobriyan99b76232009-03-25 22:48:06 +0300522 p = create_proc_entry("asound", S_IFDIR | S_IRUGO | S_IXUGO, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 if (p == NULL)
524 return -ENOMEM;
525 snd_proc_root = p;
526#ifdef CONFIG_SND_OSSEMUL
527 {
Takashi Iwai24c1f932005-11-17 13:58:48 +0100528 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 if ((entry = snd_info_create_module_entry(THIS_MODULE, "oss", NULL)) == NULL)
530 return -ENOMEM;
531 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
532 if (snd_info_register(entry) < 0) {
533 snd_info_free_entry(entry);
534 return -ENOMEM;
535 }
536 snd_oss_root = entry;
537 }
538#endif
539#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
540 {
Takashi Iwai24c1f932005-11-17 13:58:48 +0100541 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 if ((entry = snd_info_create_module_entry(THIS_MODULE, "seq", NULL)) == NULL)
543 return -ENOMEM;
544 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
545 if (snd_info_register(entry) < 0) {
546 snd_info_free_entry(entry);
547 return -ENOMEM;
548 }
549 snd_seq_root = entry;
550 }
551#endif
552 snd_info_version_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 snd_minor_info_init();
554 snd_minor_info_oss_init();
555 snd_card_info_init();
556 return 0;
557}
558
559int __exit snd_info_done(void)
560{
561 snd_card_info_done();
562 snd_minor_info_oss_done();
563 snd_minor_info_done();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 snd_info_version_done();
565 if (snd_proc_root) {
566#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
Takashi Iwai746d4a02006-06-23 14:37:59 +0200567 snd_info_free_entry(snd_seq_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568#endif
569#ifdef CONFIG_SND_OSSEMUL
Takashi Iwai746d4a02006-06-23 14:37:59 +0200570 snd_info_free_entry(snd_oss_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571#endif
Alexey Dobriyanc74c1202008-04-29 01:01:44 -0700572 snd_remove_proc_entry(NULL, snd_proc_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 }
574 return 0;
575}
576
577/*
578
579 */
580
581
582/*
583 * create a card proc file
584 * called from init.c
585 */
Takashi Iwai24c1f932005-11-17 13:58:48 +0100586int snd_info_card_create(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587{
588 char str[8];
Takashi Iwai24c1f932005-11-17 13:58:48 +0100589 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200591 if (snd_BUG_ON(!card))
592 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
594 sprintf(str, "card%i", card->number);
595 if ((entry = snd_info_create_module_entry(card->module, str, NULL)) == NULL)
596 return -ENOMEM;
597 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
598 if (snd_info_register(entry) < 0) {
599 snd_info_free_entry(entry);
600 return -ENOMEM;
601 }
602 card->proc_root = entry;
603 return 0;
604}
605
606/*
607 * register the card proc file
608 * called from init.c
609 */
Takashi Iwai24c1f932005-11-17 13:58:48 +0100610int snd_info_card_register(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611{
612 struct proc_dir_entry *p;
613
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200614 if (snd_BUG_ON(!card))
615 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
617 if (!strcmp(card->id, card->proc_root->name))
618 return 0;
619
620 p = proc_symlink(card->id, snd_proc_root, card->proc_root->name);
621 if (p == NULL)
622 return -ENOMEM;
623 card->proc_root_link = p;
624 return 0;
625}
626
627/*
Jaroslav Kyselac2eb9c42008-11-12 16:31:37 +0100628 * called on card->id change
629 */
630void snd_info_card_id_change(struct snd_card *card)
631{
632 mutex_lock(&info_mutex);
633 if (card->proc_root_link) {
634 snd_remove_proc_entry(snd_proc_root, card->proc_root_link);
635 card->proc_root_link = NULL;
636 }
637 if (strcmp(card->id, card->proc_root->name))
638 card->proc_root_link = proc_symlink(card->id,
639 snd_proc_root,
640 card->proc_root->name);
641 mutex_unlock(&info_mutex);
642}
643
644/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 * de-register the card proc file
646 * called from init.c
647 */
Takashi Iwai746d4a02006-06-23 14:37:59 +0200648void snd_info_card_disconnect(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649{
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200650 if (!card)
651 return;
Takashi Iwai746d4a02006-06-23 14:37:59 +0200652 mutex_lock(&info_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 if (card->proc_root_link) {
654 snd_remove_proc_entry(snd_proc_root, card->proc_root_link);
655 card->proc_root_link = NULL;
656 }
Takashi Iwai746d4a02006-06-23 14:37:59 +0200657 if (card->proc_root)
658 snd_info_disconnect(card->proc_root);
659 mutex_unlock(&info_mutex);
660}
661
662/*
663 * release the card proc file resources
664 * called from init.c
665 */
666int snd_info_card_free(struct snd_card *card)
667{
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200668 if (!card)
669 return 0;
Takashi Iwai746d4a02006-06-23 14:37:59 +0200670 snd_info_free_entry(card->proc_root);
671 card->proc_root = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 return 0;
673}
674
675
676/**
677 * snd_info_get_line - read one line from the procfs buffer
678 * @buffer: the procfs buffer
679 * @line: the buffer to store
680 * @len: the max. buffer size - 1
681 *
682 * Reads one line from the buffer and stores the string.
683 *
684 * Returns zero if successful, or 1 if error or EOF.
685 */
Takashi Iwai24c1f932005-11-17 13:58:48 +0100686int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687{
688 int c = -1;
689
690 if (len <= 0 || buffer->stop || buffer->error)
691 return 1;
692 while (--len > 0) {
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200693 c = buffer->buffer[buffer->curr++];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 if (c == '\n') {
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200695 if (buffer->curr >= buffer->size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 buffer->stop = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 break;
698 }
699 *line++ = c;
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200700 if (buffer->curr >= buffer->size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 buffer->stop = 1;
702 break;
703 }
704 }
705 while (c != '\n' && !buffer->stop) {
Takashi Iwai7e4eeec2006-04-28 15:13:40 +0200706 c = buffer->buffer[buffer->curr++];
707 if (buffer->curr >= buffer->size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 buffer->stop = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 }
710 *line = '\0';
711 return 0;
712}
713
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200714EXPORT_SYMBOL(snd_info_get_line);
715
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716/**
Henrik Kretzschmar856def82005-07-08 13:53:42 +0200717 * snd_info_get_str - parse a string token
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 * @dest: the buffer to store the string token
719 * @src: the original string
720 * @len: the max. length of token - 1
721 *
722 * Parses the original string and copy a token to the given
723 * string buffer.
724 *
725 * Returns the updated pointer of the original string so that
726 * it can be used for the next call.
727 */
Takashi Iwai4f7454a2009-09-08 14:29:58 +0200728const char *snd_info_get_str(char *dest, const char *src, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729{
730 int c;
731
732 while (*src == ' ' || *src == '\t')
733 src++;
734 if (*src == '"' || *src == '\'') {
735 c = *src++;
736 while (--len > 0 && *src && *src != c) {
737 *dest++ = *src++;
738 }
739 if (*src == c)
740 src++;
741 } else {
742 while (--len > 0 && *src && *src != ' ' && *src != '\t') {
743 *dest++ = *src++;
744 }
745 }
746 *dest = 0;
747 while (*src == ' ' || *src == '\t')
748 src++;
749 return src;
750}
751
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200752EXPORT_SYMBOL(snd_info_get_str);
753
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754/**
755 * snd_info_create_entry - create an info entry
756 * @name: the proc file name
757 *
758 * Creates an info entry with the given file name and initializes as
759 * the default state.
760 *
761 * Usually called from other functions such as
762 * snd_info_create_card_entry().
763 *
764 * Returns the pointer of the new instance, or NULL on failure.
765 */
Takashi Iwai24c1f932005-11-17 13:58:48 +0100766static struct snd_info_entry *snd_info_create_entry(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100768 struct snd_info_entry *entry;
Takashi Iwaica2c0962005-09-09 14:20:23 +0200769 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 if (entry == NULL)
771 return NULL;
Paulo Marques543537b2005-06-23 00:09:02 -0700772 entry->name = kstrdup(name, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 if (entry->name == NULL) {
774 kfree(entry);
775 return NULL;
776 }
777 entry->mode = S_IFREG | S_IRUGO;
778 entry->content = SNDRV_INFO_CONTENT_TEXT;
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100779 mutex_init(&entry->access);
Takashi Iwai746d4a02006-06-23 14:37:59 +0200780 INIT_LIST_HEAD(&entry->children);
781 INIT_LIST_HEAD(&entry->list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 return entry;
783}
784
785/**
786 * snd_info_create_module_entry - create an info entry for the given module
787 * @module: the module pointer
788 * @name: the file name
789 * @parent: the parent directory
790 *
791 * Creates a new info entry and assigns it to the given module.
792 *
793 * Returns the pointer of the new instance, or NULL on failure.
794 */
Takashi Iwai24c1f932005-11-17 13:58:48 +0100795struct snd_info_entry *snd_info_create_module_entry(struct module * module,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 const char *name,
Takashi Iwai24c1f932005-11-17 13:58:48 +0100797 struct snd_info_entry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100799 struct snd_info_entry *entry = snd_info_create_entry(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 if (entry) {
801 entry->module = module;
802 entry->parent = parent;
803 }
804 return entry;
805}
806
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200807EXPORT_SYMBOL(snd_info_create_module_entry);
808
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809/**
810 * snd_info_create_card_entry - create an info entry for the given card
811 * @card: the card instance
812 * @name: the file name
813 * @parent: the parent directory
814 *
815 * Creates a new info entry and assigns it to the given card.
816 *
817 * Returns the pointer of the new instance, or NULL on failure.
818 */
Takashi Iwai24c1f932005-11-17 13:58:48 +0100819struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 const char *name,
Takashi Iwai24c1f932005-11-17 13:58:48 +0100821 struct snd_info_entry * parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100823 struct snd_info_entry *entry = snd_info_create_entry(name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 if (entry) {
825 entry->module = card->module;
826 entry->card = card;
827 entry->parent = parent;
828 }
829 return entry;
830}
831
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200832EXPORT_SYMBOL(snd_info_create_card_entry);
833
Takashi Iwai746d4a02006-06-23 14:37:59 +0200834static void snd_info_disconnect(struct snd_info_entry *entry)
835{
836 struct list_head *p, *n;
837 struct proc_dir_entry *root;
838
839 list_for_each_safe(p, n, &entry->children) {
840 snd_info_disconnect(list_entry(p, struct snd_info_entry, list));
841 }
842
843 if (! entry->p)
844 return;
845 list_del_init(&entry->list);
846 root = entry->parent == NULL ? snd_proc_root : entry->parent->p;
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200847 snd_BUG_ON(!root);
Takashi Iwai746d4a02006-06-23 14:37:59 +0200848 snd_remove_proc_entry(root, entry->p);
849 entry->p = NULL;
850}
851
Takashi Iwai24c1f932005-11-17 13:58:48 +0100852static int snd_info_dev_free_entry(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100854 struct snd_info_entry *entry = device->device_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 snd_info_free_entry(entry);
856 return 0;
857}
858
Takashi Iwai24c1f932005-11-17 13:58:48 +0100859static int snd_info_dev_register_entry(struct snd_device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100861 struct snd_info_entry *entry = device->device_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 return snd_info_register(entry);
863}
864
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865/**
866 * snd_card_proc_new - create an info entry for the given card
867 * @card: the card instance
868 * @name: the file name
869 * @entryp: the pointer to store the new info entry
870 *
871 * Creates a new info entry and assigns it to the given card.
872 * Unlike snd_info_create_card_entry(), this function registers the
873 * info entry as an ALSA device component, so that it can be
874 * unregistered/released without explicit call.
875 * Also, you don't have to register this entry via snd_info_register(),
876 * since this will be registered by snd_card_register() automatically.
877 *
878 * The parent is assumed as card->proc_root.
879 *
880 * For releasing this entry, use snd_device_free() instead of
881 * snd_info_free_entry().
882 *
883 * Returns zero if successful, or a negative error code on failure.
884 */
Takashi Iwai24c1f932005-11-17 13:58:48 +0100885int snd_card_proc_new(struct snd_card *card, const char *name,
886 struct snd_info_entry **entryp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100888 static struct snd_device_ops ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 .dev_free = snd_info_dev_free_entry,
890 .dev_register = snd_info_dev_register_entry,
Takashi Iwai746d4a02006-06-23 14:37:59 +0200891 /* disconnect is done via snd_info_card_disconnect() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 };
Takashi Iwai24c1f932005-11-17 13:58:48 +0100893 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 int err;
895
896 entry = snd_info_create_card_entry(card, name, card->proc_root);
897 if (! entry)
898 return -ENOMEM;
899 if ((err = snd_device_new(card, SNDRV_DEV_INFO, entry, &ops)) < 0) {
900 snd_info_free_entry(entry);
901 return err;
902 }
903 if (entryp)
904 *entryp = entry;
905 return 0;
906}
907
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200908EXPORT_SYMBOL(snd_card_proc_new);
909
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910/**
911 * snd_info_free_entry - release the info entry
912 * @entry: the info entry
913 *
914 * Releases the info entry. Don't call this after registered.
915 */
Takashi Iwai24c1f932005-11-17 13:58:48 +0100916void snd_info_free_entry(struct snd_info_entry * entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917{
918 if (entry == NULL)
919 return;
Takashi Iwai746d4a02006-06-23 14:37:59 +0200920 if (entry->p) {
921 mutex_lock(&info_mutex);
922 snd_info_disconnect(entry);
923 mutex_unlock(&info_mutex);
924 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 kfree(entry->name);
926 if (entry->private_free)
927 entry->private_free(entry);
928 kfree(entry);
929}
930
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200931EXPORT_SYMBOL(snd_info_free_entry);
932
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933/**
934 * snd_info_register - register the info entry
935 * @entry: the info entry
936 *
937 * Registers the proc info entry.
938 *
939 * Returns zero if successful, or a negative error code on failure.
940 */
Takashi Iwai24c1f932005-11-17 13:58:48 +0100941int snd_info_register(struct snd_info_entry * entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942{
943 struct proc_dir_entry *root, *p = NULL;
944
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200945 if (snd_BUG_ON(!entry))
946 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 root = entry->parent == NULL ? snd_proc_root : entry->parent->p;
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100948 mutex_lock(&info_mutex);
Alexey Dobriyan99b76232009-03-25 22:48:06 +0300949 p = create_proc_entry(entry->name, entry->mode, root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 if (!p) {
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100951 mutex_unlock(&info_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 return -ENOMEM;
953 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 if (!S_ISDIR(entry->mode))
955 p->proc_fops = &snd_info_entry_operations;
956 p->size = entry->size;
957 p->data = entry;
958 entry->p = p;
Takashi Iwai746d4a02006-06-23 14:37:59 +0200959 if (entry->parent)
960 list_add_tail(&entry->list, &entry->parent->children);
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100961 mutex_unlock(&info_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 return 0;
963}
964
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200965EXPORT_SYMBOL(snd_info_register);
966
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967/*
968
969 */
970
Takashi Iwai6581f4e2006-05-17 17:14:51 +0200971static struct snd_info_entry *snd_info_version_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
Takashi Iwai24c1f932005-11-17 13:58:48 +0100973static void snd_info_version_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974{
975 snd_iprintf(buffer,
976 "Advanced Linux Sound Architecture Driver Version "
977 CONFIG_SND_VERSION CONFIG_SND_DATE ".\n"
978 );
979}
980
981static int __init snd_info_version_init(void)
982{
Takashi Iwai24c1f932005-11-17 13:58:48 +0100983 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
985 entry = snd_info_create_module_entry(THIS_MODULE, "version", NULL);
986 if (entry == NULL)
987 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 entry->c.text.read = snd_info_version_read;
989 if (snd_info_register(entry) < 0) {
990 snd_info_free_entry(entry);
991 return -ENOMEM;
992 }
993 snd_info_version_entry = entry;
994 return 0;
995}
996
997static int __exit snd_info_version_done(void)
998{
Takashi Iwai746d4a02006-06-23 14:37:59 +0200999 snd_info_free_entry(snd_info_version_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 return 0;
1001}
1002
1003#endif /* CONFIG_PROC_FS */