info.c 22.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2
/*
 *  Information interface for ALSA driver
3
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
L
Linus Torvalds 已提交
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

#include <linux/init.h>
#include <linux/time.h>
24
#include <linux/mm.h>
25
#include <linux/slab.h>
26
#include <linux/string.h>
27
#include <linux/module.h>
L
Linus Torvalds 已提交
28 29 30
#include <sound/core.h>
#include <sound/minors.h>
#include <sound/info.h>
31
#include <linux/utsname.h>
L
Linus Torvalds 已提交
32
#include <linux/proc_fs.h>
33
#include <linux/mutex.h>
L
Linus Torvalds 已提交
34 35 36 37 38 39
#include <stdarg.h>

/*
 *
 */

40 41
#ifdef CONFIG_PROC_FS

L
Linus Torvalds 已提交
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
int snd_info_check_reserved_words(const char *str)
{
	static char *reserved[] =
	{
		"version",
		"meminfo",
		"memdebug",
		"detect",
		"devices",
		"oss",
		"cards",
		"timers",
		"synth",
		"pcm",
		"seq",
		NULL
	};
	char **xstr = reserved;

	while (*xstr) {
		if (!strcmp(*xstr, str))
			return 0;
		xstr++;
	}
	if (!strncmp(str, "card", 4))
		return 0;
	return 1;
}

71
static DEFINE_MUTEX(info_mutex);
L
Linus Torvalds 已提交
72

73 74 75 76
struct snd_info_private_data {
	struct snd_info_buffer *rbuffer;
	struct snd_info_buffer *wbuffer;
	struct snd_info_entry *entry;
L
Linus Torvalds 已提交
77
	void *file_private_data;
78
};
L
Linus Torvalds 已提交
79 80 81

static int snd_info_version_init(void);
static int snd_info_version_done(void);
82
static void snd_info_disconnect(struct snd_info_entry *entry);
L
Linus Torvalds 已提交
83 84


85 86 87 88 89 90 91
/* resize the proc r/w buffer */
static int resize_info_buffer(struct snd_info_buffer *buffer,
			      unsigned int nsize)
{
	char *nbuf;

	nsize = PAGE_ALIGN(nsize);
92
	nbuf = krealloc(buffer->buffer, nsize, GFP_KERNEL | __GFP_ZERO);
93 94 95 96 97 98 99 100
	if (! nbuf)
		return -ENOMEM;

	buffer->buffer = nbuf;
	buffer->len = nsize;
	return 0;
}

L
Linus Torvalds 已提交
101 102 103 104 105 106 107
/**
 * snd_iprintf - printf on the procfs buffer
 * @buffer: the procfs buffer
 * @fmt: the printf format
 *
 * Outputs the string on the procfs buffer just like printf().
 *
108
 * Return: The size of output string, or a negative error code.
L
Linus Torvalds 已提交
109
 */
110
int snd_iprintf(struct snd_info_buffer *buffer, const char *fmt, ...)
L
Linus Torvalds 已提交
111 112 113
{
	va_list args;
	int len, res;
114
	int err = 0;
L
Linus Torvalds 已提交
115

116
	might_sleep();
L
Linus Torvalds 已提交
117 118 119 120
	if (buffer->stop || buffer->error)
		return 0;
	len = buffer->len - buffer->size;
	va_start(args, fmt);
121
	for (;;) {
T
Takashi Iwai 已提交
122 123 124 125
		va_list ap;
		va_copy(ap, args);
		res = vsnprintf(buffer->buffer + buffer->curr, len, fmt, ap);
		va_end(ap);
126 127 128 129 130 131
		if (res < len)
			break;
		err = resize_info_buffer(buffer, buffer->len + PAGE_SIZE);
		if (err < 0)
			break;
		len = buffer->len - buffer->size;
L
Linus Torvalds 已提交
132
	}
133 134 135 136
	va_end(args);

	if (err < 0)
		return err;
L
Linus Torvalds 已提交
137 138 139 140 141
	buffer->curr += res;
	buffer->size += res;
	return res;
}

142 143
EXPORT_SYMBOL(snd_iprintf);

L
Linus Torvalds 已提交
144 145 146 147
/*

 */

148 149
static struct proc_dir_entry *snd_proc_root;
struct snd_info_entry *snd_seq_root;
150 151
EXPORT_SYMBOL(snd_seq_root);

L
Linus Torvalds 已提交
152
#ifdef CONFIG_SND_OSSEMUL
153
struct snd_info_entry *snd_oss_root;
L
Linus Torvalds 已提交
154 155 156 157
#endif

static loff_t snd_info_entry_llseek(struct file *file, loff_t offset, int orig)
{
158
	struct snd_info_private_data *data;
L
Linus Torvalds 已提交
159
	struct snd_info_entry *entry;
160
	loff_t ret = -EINVAL, size;
L
Linus Torvalds 已提交
161 162 163

	data = file->private_data;
	entry = data->entry;
T
Takashi Iwai 已提交
164
	mutex_lock(&entry->access);
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
	if (entry->content == SNDRV_INFO_CONTENT_DATA &&
	    entry->c.ops->llseek) {
		offset = entry->c.ops->llseek(entry,
					      data->file_private_data,
					      file, offset, orig);
		goto out;
	}
	if (entry->content == SNDRV_INFO_CONTENT_DATA)
		size = entry->size;
	else
		size = 0;
	switch (orig) {
	case SEEK_SET:
		break;
	case SEEK_CUR:
		offset += file->f_pos;
L
Linus Torvalds 已提交
181
		break;
182 183
	case SEEK_END:
		if (!size)
L
Linus Torvalds 已提交
184
			goto out;
185
		offset += size;
L
Linus Torvalds 已提交
186
		break;
187 188
	default:
		goto out;
L
Linus Torvalds 已提交
189
	}
190 191 192 193 194 195 196
	if (offset < 0)
		goto out;
	if (size && offset > size)
		offset = size;
	file->f_pos = offset;
	ret = offset;
 out:
T
Takashi Iwai 已提交
197
	mutex_unlock(&entry->access);
L
Linus Torvalds 已提交
198 199 200 201 202 203
	return ret;
}

static ssize_t snd_info_entry_read(struct file *file, char __user *buffer,
				   size_t count, loff_t * offset)
{
204
	struct snd_info_private_data *data;
L
Linus Torvalds 已提交
205
	struct snd_info_entry *entry;
206
	struct snd_info_buffer *buf;
L
Linus Torvalds 已提交
207 208 209 210
	size_t size = 0;
	loff_t pos;

	data = file->private_data;
211 212
	if (snd_BUG_ON(!data))
		return -ENXIO;
L
Linus Torvalds 已提交
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
	pos = *offset;
	if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
		return -EIO;
	if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
		return -EIO;
	entry = data->entry;
	switch (entry->content) {
	case SNDRV_INFO_CONTENT_TEXT:
		buf = data->rbuffer;
		if (buf == NULL)
			return -EIO;
		if (pos >= buf->size)
			return 0;
		size = buf->size - pos;
		size = min(count, size);
		if (copy_to_user(buffer, buf->buffer + pos, size))
			return -EFAULT;
		break;
	case SNDRV_INFO_CONTENT_DATA:
232 233 234 235 236
		if (pos >= entry->size)
			return 0;
		if (entry->c.ops->read) {
			size = entry->size - pos;
			size = min(count, size);
L
Linus Torvalds 已提交
237 238
			size = entry->c.ops->read(entry,
						  data->file_private_data,
239 240
						  file, buffer, size, pos);
		}
L
Linus Torvalds 已提交
241 242 243 244 245 246 247 248 249 250
		break;
	}
	if ((ssize_t) size > 0)
		*offset = pos + size;
	return size;
}

static ssize_t snd_info_entry_write(struct file *file, const char __user *buffer,
				    size_t count, loff_t * offset)
{
251
	struct snd_info_private_data *data;
L
Linus Torvalds 已提交
252
	struct snd_info_entry *entry;
253
	struct snd_info_buffer *buf;
254
	ssize_t size = 0;
L
Linus Torvalds 已提交
255 256 257
	loff_t pos;

	data = file->private_data;
258 259
	if (snd_BUG_ON(!data))
		return -ENXIO;
L
Linus Torvalds 已提交
260 261 262 263 264 265 266 267 268 269 270
	entry = data->entry;
	pos = *offset;
	if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
		return -EIO;
	if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
		return -EIO;
	switch (entry->content) {
	case SNDRV_INFO_CONTENT_TEXT:
		buf = data->wbuffer;
		if (buf == NULL)
			return -EIO;
C
Clemens Ladisch 已提交
271
		mutex_lock(&entry->access);
272 273 274 275 276 277 278 279
		if (pos + count >= buf->len) {
			if (resize_info_buffer(buf, pos + count)) {
				mutex_unlock(&entry->access);
				return -ENOMEM;
			}
		}
		if (copy_from_user(buf->buffer + pos, buffer, count)) {
			mutex_unlock(&entry->access);
L
Linus Torvalds 已提交
280
			return -EFAULT;
281 282 283 284
		}
		buf->size = pos + count;
		mutex_unlock(&entry->access);
		size = count;
L
Linus Torvalds 已提交
285 286
		break;
	case SNDRV_INFO_CONTENT_DATA:
287 288 289
		if (entry->c.ops->write && count > 0) {
			size_t maxsize = entry->size - pos;
			count = min(count, maxsize);
L
Linus Torvalds 已提交
290 291 292
			size = entry->c.ops->write(entry,
						   data->file_private_data,
						   file, buffer, count, pos);
293
		}
L
Linus Torvalds 已提交
294 295 296 297 298 299 300 301 302
		break;
	}
	if ((ssize_t) size > 0)
		*offset = pos + size;
	return size;
}

static int snd_info_entry_open(struct inode *inode, struct file *file)
{
303 304 305
	struct snd_info_entry *entry;
	struct snd_info_private_data *data;
	struct snd_info_buffer *buffer;
L
Linus Torvalds 已提交
306 307
	int mode, err;

308
	mutex_lock(&info_mutex);
A
Al Viro 已提交
309
	entry = PDE_DATA(inode);
310
	if (entry == NULL || ! entry->p) {
311
		mutex_unlock(&info_mutex);
L
Linus Torvalds 已提交
312 313 314 315 316 317 318 319
		return -ENODEV;
	}
	if (!try_module_get(entry->module)) {
		err = -EFAULT;
		goto __error1;
	}
	mode = file->f_flags & O_ACCMODE;
	if (mode == O_RDONLY || mode == O_RDWR) {
320
		if ((entry->content == SNDRV_INFO_CONTENT_DATA &&
L
Linus Torvalds 已提交
321 322 323 324 325 326
		     entry->c.ops->read == NULL)) {
		    	err = -ENODEV;
		    	goto __error;
		}
	}
	if (mode == O_WRONLY || mode == O_RDWR) {
327
		if ((entry->content == SNDRV_INFO_CONTENT_DATA &&
L
Linus Torvalds 已提交
328 329 330 331 332
		     entry->c.ops->write == NULL)) {
		    	err = -ENODEV;
		    	goto __error;
		}
	}
333
	data = kzalloc(sizeof(*data), GFP_KERNEL);
L
Linus Torvalds 已提交
334 335 336 337 338 339 340 341
	if (data == NULL) {
		err = -ENOMEM;
		goto __error;
	}
	data->entry = entry;
	switch (entry->content) {
	case SNDRV_INFO_CONTENT_TEXT:
		if (mode == O_RDONLY || mode == O_RDWR) {
342
			buffer = kzalloc(sizeof(*buffer), GFP_KERNEL);
343 344
			if (buffer == NULL)
				goto __nomem;
L
Linus Torvalds 已提交
345
			data->rbuffer = buffer;
346
			buffer->len = PAGE_SIZE;
347
			buffer->buffer = kzalloc(buffer->len, GFP_KERNEL);
348 349
			if (buffer->buffer == NULL)
				goto __nomem;
L
Linus Torvalds 已提交
350 351
		}
		if (mode == O_WRONLY || mode == O_RDWR) {
352
			buffer = kzalloc(sizeof(*buffer), GFP_KERNEL);
353 354
			if (buffer == NULL)
				goto __nomem;
L
Linus Torvalds 已提交
355
			data->wbuffer = buffer;
356 357 358 359
			buffer->len = PAGE_SIZE;
			buffer->buffer = kmalloc(buffer->len, GFP_KERNEL);
			if (buffer->buffer == NULL)
				goto __nomem;
L
Linus Torvalds 已提交
360 361 362 363 364 365 366 367 368 369 370 371 372
		}
		break;
	case SNDRV_INFO_CONTENT_DATA:	/* data */
		if (entry->c.ops->open) {
			if ((err = entry->c.ops->open(entry, mode,
						      &data->file_private_data)) < 0) {
				kfree(data);
				goto __error;
			}
		}
		break;
	}
	file->private_data = data;
373
	mutex_unlock(&info_mutex);
L
Linus Torvalds 已提交
374 375 376
	if (entry->content == SNDRV_INFO_CONTENT_TEXT &&
	    (mode == O_RDONLY || mode == O_RDWR)) {
		if (entry->c.text.read) {
377
			mutex_lock(&entry->access);
L
Linus Torvalds 已提交
378
			entry->c.text.read(entry, data->rbuffer);
379
			mutex_unlock(&entry->access);
L
Linus Torvalds 已提交
380 381 382 383
		}
	}
	return 0;

384 385 386 387 388 389 390 391 392 393 394
 __nomem:
	if (data->rbuffer) {
		kfree(data->rbuffer->buffer);
		kfree(data->rbuffer);
	}
	if (data->wbuffer) {
		kfree(data->wbuffer->buffer);
		kfree(data->wbuffer);
	}
	kfree(data);
	err = -ENOMEM;
L
Linus Torvalds 已提交
395 396 397
      __error:
	module_put(entry->module);
      __error1:
398
	mutex_unlock(&info_mutex);
L
Linus Torvalds 已提交
399 400 401 402 403
	return err;
}

static int snd_info_entry_release(struct inode *inode, struct file *file)
{
404 405
	struct snd_info_entry *entry;
	struct snd_info_private_data *data;
L
Linus Torvalds 已提交
406 407 408 409 410 411 412
	int mode;

	mode = file->f_flags & O_ACCMODE;
	data = file->private_data;
	entry = data->entry;
	switch (entry->content) {
	case SNDRV_INFO_CONTENT_TEXT:
413 414
		if (data->rbuffer) {
			kfree(data->rbuffer->buffer);
L
Linus Torvalds 已提交
415 416
			kfree(data->rbuffer);
		}
417
		if (data->wbuffer) {
L
Linus Torvalds 已提交
418 419 420 421 422 423 424 425
			if (entry->c.text.write) {
				entry->c.text.write(entry, data->wbuffer);
				if (data->wbuffer->error) {
					snd_printk(KERN_WARNING "data write error to %s (%i)\n",
						entry->name,
						data->wbuffer->error);
				}
			}
426
			kfree(data->wbuffer->buffer);
L
Linus Torvalds 已提交
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
			kfree(data->wbuffer);
		}
		break;
	case SNDRV_INFO_CONTENT_DATA:
		if (entry->c.ops->release)
			entry->c.ops->release(entry, mode,
					      data->file_private_data);
		break;
	}
	module_put(entry->module);
	kfree(data);
	return 0;
}

static unsigned int snd_info_entry_poll(struct file *file, poll_table * wait)
{
443
	struct snd_info_private_data *data;
L
Linus Torvalds 已提交
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
	struct snd_info_entry *entry;
	unsigned int mask;

	data = file->private_data;
	if (data == NULL)
		return 0;
	entry = data->entry;
	mask = 0;
	switch (entry->content) {
	case SNDRV_INFO_CONTENT_DATA:
		if (entry->c.ops->poll)
			return entry->c.ops->poll(entry,
						  data->file_private_data,
						  file, wait);
		if (entry->c.ops->read)
			mask |= POLLIN | POLLRDNORM;
		if (entry->c.ops->write)
			mask |= POLLOUT | POLLWRNORM;
		break;
	}
	return mask;
}

467 468
static long snd_info_entry_ioctl(struct file *file, unsigned int cmd,
				unsigned long arg)
L
Linus Torvalds 已提交
469
{
470
	struct snd_info_private_data *data;
L
Linus Torvalds 已提交
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
	struct snd_info_entry *entry;

	data = file->private_data;
	if (data == NULL)
		return 0;
	entry = data->entry;
	switch (entry->content) {
	case SNDRV_INFO_CONTENT_DATA:
		if (entry->c.ops->ioctl)
			return entry->c.ops->ioctl(entry,
						   data->file_private_data,
						   file, cmd, arg);
		break;
	}
	return -ENOTTY;
}

static int snd_info_entry_mmap(struct file *file, struct vm_area_struct *vma)
{
A
Al Viro 已提交
490
	struct inode *inode = file_inode(file);
491
	struct snd_info_private_data *data;
L
Linus Torvalds 已提交
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
	struct snd_info_entry *entry;

	data = file->private_data;
	if (data == NULL)
		return 0;
	entry = data->entry;
	switch (entry->content) {
	case SNDRV_INFO_CONTENT_DATA:
		if (entry->c.ops->mmap)
			return entry->c.ops->mmap(entry,
						  data->file_private_data,
						  inode, file, vma);
		break;
	}
	return -ENXIO;
}

509
static const struct file_operations snd_info_entry_operations =
L
Linus Torvalds 已提交
510
{
511 512 513 514 515 516 517 518 519
	.owner =		THIS_MODULE,
	.llseek =		snd_info_entry_llseek,
	.read =			snd_info_entry_read,
	.write =		snd_info_entry_write,
	.poll =			snd_info_entry_poll,
	.unlocked_ioctl =	snd_info_entry_ioctl,
	.mmap =			snd_info_entry_mmap,
	.open =			snd_info_entry_open,
	.release =		snd_info_entry_release,
L
Linus Torvalds 已提交
520 521 522 523 524 525
};

int __init snd_info_init(void)
{
	struct proc_dir_entry *p;

526
	p = proc_mkdir("asound", NULL);
L
Linus Torvalds 已提交
527 528 529 530 531
	if (p == NULL)
		return -ENOMEM;
	snd_proc_root = p;
#ifdef CONFIG_SND_OSSEMUL
	{
532
		struct snd_info_entry *entry;
L
Linus Torvalds 已提交
533 534 535 536 537 538 539 540 541 542 543 544
		if ((entry = snd_info_create_module_entry(THIS_MODULE, "oss", NULL)) == NULL)
			return -ENOMEM;
		entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
		if (snd_info_register(entry) < 0) {
			snd_info_free_entry(entry);
			return -ENOMEM;
		}
		snd_oss_root = entry;
	}
#endif
#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
	{
545
		struct snd_info_entry *entry;
L
Linus Torvalds 已提交
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
		if ((entry = snd_info_create_module_entry(THIS_MODULE, "seq", NULL)) == NULL)
			return -ENOMEM;
		entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
		if (snd_info_register(entry) < 0) {
			snd_info_free_entry(entry);
			return -ENOMEM;
		}
		snd_seq_root = entry;
	}
#endif
	snd_info_version_init();
	snd_minor_info_init();
	snd_minor_info_oss_init();
	snd_card_info_init();
	return 0;
}

int __exit snd_info_done(void)
{
	snd_card_info_done();
	snd_minor_info_oss_done();
	snd_minor_info_done();
	snd_info_version_done();
	if (snd_proc_root) {
#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
571
		snd_info_free_entry(snd_seq_root);
L
Linus Torvalds 已提交
572 573
#endif
#ifdef CONFIG_SND_OSSEMUL
574
		snd_info_free_entry(snd_oss_root);
L
Linus Torvalds 已提交
575
#endif
576
		proc_remove(snd_proc_root);
L
Linus Torvalds 已提交
577 578 579 580 581 582 583 584 585 586 587 588 589
	}
	return 0;
}

/*

 */


/*
 * create a card proc file
 * called from init.c
 */
590
int snd_info_card_create(struct snd_card *card)
L
Linus Torvalds 已提交
591 592
{
	char str[8];
593
	struct snd_info_entry *entry;
L
Linus Torvalds 已提交
594

595 596
	if (snd_BUG_ON(!card))
		return -ENXIO;
L
Linus Torvalds 已提交
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613

	sprintf(str, "card%i", card->number);
	if ((entry = snd_info_create_module_entry(card->module, str, NULL)) == NULL)
		return -ENOMEM;
	entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
	if (snd_info_register(entry) < 0) {
		snd_info_free_entry(entry);
		return -ENOMEM;
	}
	card->proc_root = entry;
	return 0;
}

/*
 * register the card proc file
 * called from init.c
 */
614
int snd_info_card_register(struct snd_card *card)
L
Linus Torvalds 已提交
615 616 617
{
	struct proc_dir_entry *p;

618 619
	if (snd_BUG_ON(!card))
		return -ENXIO;
L
Linus Torvalds 已提交
620 621 622 623 624 625 626 627 628 629 630

	if (!strcmp(card->id, card->proc_root->name))
		return 0;

	p = proc_symlink(card->id, snd_proc_root, card->proc_root->name);
	if (p == NULL)
		return -ENOMEM;
	card->proc_root_link = p;
	return 0;
}

631 632 633 634 635 636 637
/*
 * called on card->id change
 */
void snd_info_card_id_change(struct snd_card *card)
{
	mutex_lock(&info_mutex);
	if (card->proc_root_link) {
638
		proc_remove(card->proc_root_link);
639 640 641 642 643 644 645 646 647
		card->proc_root_link = NULL;
	}
	if (strcmp(card->id, card->proc_root->name))
		card->proc_root_link = proc_symlink(card->id,
						    snd_proc_root,
						    card->proc_root->name);
	mutex_unlock(&info_mutex);
}

L
Linus Torvalds 已提交
648 649 650 651
/*
 * de-register the card proc file
 * called from init.c
 */
652
void snd_info_card_disconnect(struct snd_card *card)
L
Linus Torvalds 已提交
653
{
654 655
	if (!card)
		return;
656
	mutex_lock(&info_mutex);
657 658
	proc_remove(card->proc_root_link);
	card->proc_root_link = NULL;
659 660 661 662 663 664 665 666 667 668 669
	if (card->proc_root)
		snd_info_disconnect(card->proc_root);
	mutex_unlock(&info_mutex);
}

/*
 * release the card proc file resources
 * called from init.c
 */
int snd_info_card_free(struct snd_card *card)
{
670 671
	if (!card)
		return 0;
672 673
	snd_info_free_entry(card->proc_root);
	card->proc_root = NULL;
L
Linus Torvalds 已提交
674 675 676 677 678 679 680 681 682 683 684 685
	return 0;
}


/**
 * snd_info_get_line - read one line from the procfs buffer
 * @buffer: the procfs buffer
 * @line: the buffer to store
 * @len: the max. buffer size - 1
 *
 * Reads one line from the buffer and stores the string.
 *
686
 * Return: Zero if successful, or 1 if error or EOF.
L
Linus Torvalds 已提交
687
 */
688
int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len)
L
Linus Torvalds 已提交
689 690 691
{
	int c = -1;

692 693
	if (snd_BUG_ON(!buffer || !buffer->buffer))
		return 1;
L
Linus Torvalds 已提交
694 695
	if (len <= 0 || buffer->stop || buffer->error)
		return 1;
696
	while (!buffer->stop) {
697
		c = buffer->buffer[buffer->curr++];
698
		if (buffer->curr >= buffer->size)
L
Linus Torvalds 已提交
699
			buffer->stop = 1;
700
		if (c == '\n')
L
Linus Torvalds 已提交
701
			break;
702 703 704
		if (len) {
			len--;
			*line++ = c;
L
Linus Torvalds 已提交
705 706 707 708 709 710
		}
	}
	*line = '\0';
	return 0;
}

711 712
EXPORT_SYMBOL(snd_info_get_line);

L
Linus Torvalds 已提交
713
/**
714
 * snd_info_get_str - parse a string token
L
Linus Torvalds 已提交
715 716 717 718 719 720 721
 * @dest: the buffer to store the string token
 * @src: the original string
 * @len: the max. length of token - 1
 *
 * Parses the original string and copy a token to the given
 * string buffer.
 *
722
 * Return: The updated pointer of the original string so that
L
Linus Torvalds 已提交
723 724
 * it can be used for the next call.
 */
725
const char *snd_info_get_str(char *dest, const char *src, int len)
L
Linus Torvalds 已提交
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
{
	int c;

	while (*src == ' ' || *src == '\t')
		src++;
	if (*src == '"' || *src == '\'') {
		c = *src++;
		while (--len > 0 && *src && *src != c) {
			*dest++ = *src++;
		}
		if (*src == c)
			src++;
	} else {
		while (--len > 0 && *src && *src != ' ' && *src != '\t') {
			*dest++ = *src++;
		}
	}
	*dest = 0;
	while (*src == ' ' || *src == '\t')
		src++;
	return src;
}

749 750
EXPORT_SYMBOL(snd_info_get_str);

L
Linus Torvalds 已提交
751 752 753 754 755 756 757 758 759 760
/**
 * snd_info_create_entry - create an info entry
 * @name: the proc file name
 *
 * Creates an info entry with the given file name and initializes as
 * the default state.
 *
 * Usually called from other functions such as
 * snd_info_create_card_entry().
 *
761
 * Return: The pointer of the new instance, or %NULL on failure.
L
Linus Torvalds 已提交
762
 */
763
static struct snd_info_entry *snd_info_create_entry(const char *name)
L
Linus Torvalds 已提交
764
{
765
	struct snd_info_entry *entry;
766
	entry = kzalloc(sizeof(*entry), GFP_KERNEL);
L
Linus Torvalds 已提交
767 768
	if (entry == NULL)
		return NULL;
769
	entry->name = kstrdup(name, GFP_KERNEL);
L
Linus Torvalds 已提交
770 771 772 773 774 775
	if (entry->name == NULL) {
		kfree(entry);
		return NULL;
	}
	entry->mode = S_IFREG | S_IRUGO;
	entry->content = SNDRV_INFO_CONTENT_TEXT;
776
	mutex_init(&entry->access);
777 778
	INIT_LIST_HEAD(&entry->children);
	INIT_LIST_HEAD(&entry->list);
L
Linus Torvalds 已提交
779 780 781 782 783 784 785 786 787 788 789
	return entry;
}

/**
 * snd_info_create_module_entry - create an info entry for the given module
 * @module: the module pointer
 * @name: the file name
 * @parent: the parent directory
 *
 * Creates a new info entry and assigns it to the given module.
 *
790
 * Return: The pointer of the new instance, or %NULL on failure.
L
Linus Torvalds 已提交
791
 */
792
struct snd_info_entry *snd_info_create_module_entry(struct module * module,
L
Linus Torvalds 已提交
793
					       const char *name,
794
					       struct snd_info_entry *parent)
L
Linus Torvalds 已提交
795
{
796
	struct snd_info_entry *entry = snd_info_create_entry(name);
L
Linus Torvalds 已提交
797 798 799 800 801 802 803
	if (entry) {
		entry->module = module;
		entry->parent = parent;
	}
	return entry;
}

804 805
EXPORT_SYMBOL(snd_info_create_module_entry);

L
Linus Torvalds 已提交
806 807 808 809 810 811 812 813
/**
 * snd_info_create_card_entry - create an info entry for the given card
 * @card: the card instance
 * @name: the file name
 * @parent: the parent directory
 *
 * Creates a new info entry and assigns it to the given card.
 *
814
 * Return: The pointer of the new instance, or %NULL on failure.
L
Linus Torvalds 已提交
815
 */
816
struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card,
L
Linus Torvalds 已提交
817
					     const char *name,
818
					     struct snd_info_entry * parent)
L
Linus Torvalds 已提交
819
{
820
	struct snd_info_entry *entry = snd_info_create_entry(name);
L
Linus Torvalds 已提交
821 822 823 824 825 826 827 828
	if (entry) {
		entry->module = card->module;
		entry->card = card;
		entry->parent = parent;
	}
	return entry;
}

829 830
EXPORT_SYMBOL(snd_info_create_card_entry);

831
static void snd_info_disconnect(struct snd_info_entry *entry)
L
Linus Torvalds 已提交
832
{
833 834
	struct list_head *p, *n;
	struct proc_dir_entry *root;
L
Linus Torvalds 已提交
835

836 837 838 839 840 841 842 843
	list_for_each_safe(p, n, &entry->children) {
		snd_info_disconnect(list_entry(p, struct snd_info_entry, list));
	}

	if (! entry->p)
		return;
	list_del_init(&entry->list);
	root = entry->parent == NULL ? snd_proc_root : entry->parent->p;
844
	snd_BUG_ON(!root);
845
	proc_remove(entry->p);
846
	entry->p = NULL;
L
Linus Torvalds 已提交
847 848
}

849
static int snd_info_dev_free_entry(struct snd_device *device)
L
Linus Torvalds 已提交
850
{
851
	struct snd_info_entry *entry = device->device_data;
852
	snd_info_free_entry(entry);
L
Linus Torvalds 已提交
853 854 855
	return 0;
}

856
static int snd_info_dev_register_entry(struct snd_device *device)
L
Linus Torvalds 已提交
857
{
858
	struct snd_info_entry *entry = device->device_data;
859
	return snd_info_register(entry);
L
Linus Torvalds 已提交
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
}

/**
 * snd_card_proc_new - create an info entry for the given card
 * @card: the card instance
 * @name: the file name
 * @entryp: the pointer to store the new info entry
 *
 * Creates a new info entry and assigns it to the given card.
 * Unlike snd_info_create_card_entry(), this function registers the
 * info entry as an ALSA device component, so that it can be
 * unregistered/released without explicit call.
 * Also, you don't have to register this entry via snd_info_register(),
 * since this will be registered by snd_card_register() automatically.
 *
 * The parent is assumed as card->proc_root.
 *
 * For releasing this entry, use snd_device_free() instead of
 * snd_info_free_entry(). 
 *
880
 * Return: Zero if successful, or a negative error code on failure.
L
Linus Torvalds 已提交
881
 */
882 883
int snd_card_proc_new(struct snd_card *card, const char *name,
		      struct snd_info_entry **entryp)
L
Linus Torvalds 已提交
884
{
885
	static struct snd_device_ops ops = {
L
Linus Torvalds 已提交
886 887
		.dev_free = snd_info_dev_free_entry,
		.dev_register =	snd_info_dev_register_entry,
888
		/* disconnect is done via snd_info_card_disconnect() */
L
Linus Torvalds 已提交
889
	};
890
	struct snd_info_entry *entry;
L
Linus Torvalds 已提交
891 892 893 894 895 896 897 898 899 900 901 902 903 904
	int err;

	entry = snd_info_create_card_entry(card, name, card->proc_root);
	if (! entry)
		return -ENOMEM;
	if ((err = snd_device_new(card, SNDRV_DEV_INFO, entry, &ops)) < 0) {
		snd_info_free_entry(entry);
		return err;
	}
	if (entryp)
		*entryp = entry;
	return 0;
}

905 906
EXPORT_SYMBOL(snd_card_proc_new);

L
Linus Torvalds 已提交
907 908 909 910 911 912
/**
 * snd_info_free_entry - release the info entry
 * @entry: the info entry
 *
 * Releases the info entry.  Don't call this after registered.
 */
913
void snd_info_free_entry(struct snd_info_entry * entry)
L
Linus Torvalds 已提交
914 915 916
{
	if (entry == NULL)
		return;
917 918 919 920 921
	if (entry->p) {
		mutex_lock(&info_mutex);
		snd_info_disconnect(entry);
		mutex_unlock(&info_mutex);
	}
L
Linus Torvalds 已提交
922 923 924 925 926 927
	kfree(entry->name);
	if (entry->private_free)
		entry->private_free(entry);
	kfree(entry);
}

928 929
EXPORT_SYMBOL(snd_info_free_entry);

L
Linus Torvalds 已提交
930 931 932 933 934 935
/**
 * snd_info_register - register the info entry
 * @entry: the info entry
 *
 * Registers the proc info entry.
 *
936
 * Return: Zero if successful, or a negative error code on failure.
L
Linus Torvalds 已提交
937
 */
938
int snd_info_register(struct snd_info_entry * entry)
L
Linus Torvalds 已提交
939 940 941
{
	struct proc_dir_entry *root, *p = NULL;

942 943
	if (snd_BUG_ON(!entry))
		return -ENXIO;
L
Linus Torvalds 已提交
944
	root = entry->parent == NULL ? snd_proc_root : entry->parent->p;
945
	mutex_lock(&info_mutex);
946 947 948 949 950 951 952 953 954 955 956 957 958
	if (S_ISDIR(entry->mode)) {
		p = proc_mkdir_mode(entry->name, entry->mode, root);
		if (!p) {
			mutex_unlock(&info_mutex);
			return -ENOMEM;
		}
	} else {
		p = proc_create_data(entry->name, entry->mode, root,
					&snd_info_entry_operations, entry);
		if (!p) {
			mutex_unlock(&info_mutex);
			return -ENOMEM;
		}
959
		proc_set_size(p, entry->size);
L
Linus Torvalds 已提交
960 961
	}
	entry->p = p;
962 963
	if (entry->parent)
		list_add_tail(&entry->list, &entry->parent->children);
964
	mutex_unlock(&info_mutex);
L
Linus Torvalds 已提交
965 966 967
	return 0;
}

968 969
EXPORT_SYMBOL(snd_info_register);

L
Linus Torvalds 已提交
970 971 972 973
/*

 */

974
static struct snd_info_entry *snd_info_version_entry;
L
Linus Torvalds 已提交
975

976
static void snd_info_version_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
L
Linus Torvalds 已提交
977 978
{
	snd_iprintf(buffer,
979 980
		    "Advanced Linux Sound Architecture Driver Version k%s.\n",
		    init_utsname()->release);
L
Linus Torvalds 已提交
981 982 983 984
}

static int __init snd_info_version_init(void)
{
985
	struct snd_info_entry *entry;
L
Linus Torvalds 已提交
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000

	entry = snd_info_create_module_entry(THIS_MODULE, "version", NULL);
	if (entry == NULL)
		return -ENOMEM;
	entry->c.text.read = snd_info_version_read;
	if (snd_info_register(entry) < 0) {
		snd_info_free_entry(entry);
		return -ENOMEM;
	}
	snd_info_version_entry = entry;
	return 0;
}

static int __exit snd_info_version_done(void)
{
1001
	snd_info_free_entry(snd_info_version_entry);
L
Linus Torvalds 已提交
1002 1003 1004 1005
	return 0;
}

#endif /* CONFIG_PROC_FS */