Commit | Line | Data |
---|---|---|
1a59d1b8 | 1 | // SPDX-License-Identifier: GPL-2.0-or-later |
1da177e4 LT |
2 | /* |
3 | * Information interface for ALSA driver | |
c1017a4c | 4 | * Copyright (c) by Jaroslav Kysela <perex@perex.cz> |
1da177e4 LT |
5 | */ |
6 | ||
1da177e4 | 7 | #include <linux/init.h> |
1da177e4 | 8 | #include <linux/time.h> |
27ac792c | 9 | #include <linux/mm.h> |
5a0e3ad6 | 10 | #include <linux/slab.h> |
543537bd | 11 | #include <linux/string.h> |
da155d5b | 12 | #include <linux/module.h> |
1da177e4 LT |
13 | #include <sound/core.h> |
14 | #include <sound/minors.h> | |
15 | #include <sound/info.h> | |
42662748 | 16 | #include <linux/utsname.h> |
1da177e4 | 17 | #include <linux/proc_fs.h> |
1a60d4c5 | 18 | #include <linux/mutex.h> |
1da177e4 | 19 | |
1da177e4 LT |
20 | int snd_info_check_reserved_words(const char *str) |
21 | { | |
51d7847a | 22 | static const char * const reserved[] = |
1da177e4 LT |
23 | { |
24 | "version", | |
25 | "meminfo", | |
26 | "memdebug", | |
27 | "detect", | |
28 | "devices", | |
29 | "oss", | |
30 | "cards", | |
31 | "timers", | |
32 | "synth", | |
33 | "pcm", | |
34 | "seq", | |
35 | NULL | |
36 | }; | |
51d7847a | 37 | const char * const *xstr = reserved; |
1da177e4 LT |
38 | |
39 | while (*xstr) { | |
40 | if (!strcmp(*xstr, str)) | |
41 | return 0; | |
42 | xstr++; | |
43 | } | |
44 | if (!strncmp(str, "card", 4)) | |
45 | return 0; | |
46 | return 1; | |
47 | } | |
48 | ||
1a60d4c5 | 49 | static DEFINE_MUTEX(info_mutex); |
1da177e4 | 50 | |
24c1f931 TI |
51 | struct snd_info_private_data { |
52 | struct snd_info_buffer *rbuffer; | |
53 | struct snd_info_buffer *wbuffer; | |
54 | struct snd_info_entry *entry; | |
1da177e4 | 55 | void *file_private_data; |
24c1f931 | 56 | }; |
1da177e4 LT |
57 | |
58 | static int snd_info_version_init(void); | |
746d4a02 | 59 | static void snd_info_disconnect(struct snd_info_entry *entry); |
1da177e4 | 60 | |
1da177e4 LT |
61 | /* |
62 | ||
63 | */ | |
64 | ||
644dbd64 | 65 | static struct snd_info_entry *snd_proc_root; |
6581f4e7 | 66 | struct snd_info_entry *snd_seq_root; |
c0d3fb39 TI |
67 | EXPORT_SYMBOL(snd_seq_root); |
68 | ||
1da177e4 | 69 | #ifdef CONFIG_SND_OSSEMUL |
6581f4e7 | 70 | struct snd_info_entry *snd_oss_root; |
1da177e4 LT |
71 | #endif |
72 | ||
4adb7bcb TI |
73 | static int alloc_info_private(struct snd_info_entry *entry, |
74 | struct snd_info_private_data **ret) | |
75 | { | |
76 | struct snd_info_private_data *data; | |
77 | ||
78 | if (!entry || !entry->p) | |
79 | return -ENODEV; | |
80 | if (!try_module_get(entry->module)) | |
81 | return -EFAULT; | |
82 | data = kzalloc(sizeof(*data), GFP_KERNEL); | |
83 | if (!data) { | |
84 | module_put(entry->module); | |
85 | return -ENOMEM; | |
86 | } | |
87 | data->entry = entry; | |
88 | *ret = data; | |
89 | return 0; | |
90 | } | |
91 | ||
92 | static bool valid_pos(loff_t pos, size_t count) | |
93 | { | |
94 | if (pos < 0 || (long) pos != pos || (ssize_t) count < 0) | |
95 | return false; | |
96 | if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos) | |
97 | return false; | |
98 | return true; | |
99 | } | |
100 | ||
101 | /* | |
102 | * file ops for binary proc files | |
103 | */ | |
1da177e4 LT |
104 | static loff_t snd_info_entry_llseek(struct file *file, loff_t offset, int orig) |
105 | { | |
24c1f931 | 106 | struct snd_info_private_data *data; |
1da177e4 | 107 | struct snd_info_entry *entry; |
73029e0f | 108 | loff_t ret = -EINVAL, size; |
1da177e4 LT |
109 | |
110 | data = file->private_data; | |
111 | entry = data->entry; | |
5b5cd553 | 112 | mutex_lock(&entry->access); |
4adb7bcb | 113 | if (entry->c.ops->llseek) { |
9be080ed AS |
114 | ret = entry->c.ops->llseek(entry, |
115 | data->file_private_data, | |
116 | file, offset, orig); | |
73029e0f TI |
117 | goto out; |
118 | } | |
4adb7bcb TI |
119 | |
120 | size = entry->size; | |
73029e0f TI |
121 | switch (orig) { |
122 | case SEEK_SET: | |
123 | break; | |
124 | case SEEK_CUR: | |
125 | offset += file->f_pos; | |
1da177e4 | 126 | break; |
73029e0f TI |
127 | case SEEK_END: |
128 | if (!size) | |
1da177e4 | 129 | goto out; |
73029e0f | 130 | offset += size; |
1da177e4 | 131 | break; |
73029e0f TI |
132 | default: |
133 | goto out; | |
1da177e4 | 134 | } |
73029e0f TI |
135 | if (offset < 0) |
136 | goto out; | |
137 | if (size && offset > size) | |
138 | offset = size; | |
139 | file->f_pos = offset; | |
140 | ret = offset; | |
141 | out: | |
5b5cd553 | 142 | mutex_unlock(&entry->access); |
1da177e4 LT |
143 | return ret; |
144 | } | |
145 | ||
146 | static ssize_t snd_info_entry_read(struct file *file, char __user *buffer, | |
147 | size_t count, loff_t * offset) | |
148 | { | |
4adb7bcb TI |
149 | struct snd_info_private_data *data = file->private_data; |
150 | struct snd_info_entry *entry = data->entry; | |
151 | size_t size; | |
1da177e4 LT |
152 | loff_t pos; |
153 | ||
1da177e4 | 154 | pos = *offset; |
4adb7bcb | 155 | if (!valid_pos(pos, count)) |
1da177e4 | 156 | return -EIO; |
4adb7bcb TI |
157 | if (pos >= entry->size) |
158 | return 0; | |
159 | size = entry->size - pos; | |
160 | size = min(count, size); | |
161 | size = entry->c.ops->read(entry, data->file_private_data, | |
162 | file, buffer, size, pos); | |
1da177e4 LT |
163 | if ((ssize_t) size > 0) |
164 | *offset = pos + size; | |
165 | return size; | |
166 | } | |
167 | ||
168 | static ssize_t snd_info_entry_write(struct file *file, const char __user *buffer, | |
169 | size_t count, loff_t * offset) | |
170 | { | |
4adb7bcb TI |
171 | struct snd_info_private_data *data = file->private_data; |
172 | struct snd_info_entry *entry = data->entry; | |
7e4eeec8 | 173 | ssize_t size = 0; |
1da177e4 LT |
174 | loff_t pos; |
175 | ||
1da177e4 | 176 | pos = *offset; |
4adb7bcb | 177 | if (!valid_pos(pos, count)) |
1da177e4 | 178 | return -EIO; |
4adb7bcb TI |
179 | if (count > 0) { |
180 | size_t maxsize = entry->size - pos; | |
181 | count = min(count, maxsize); | |
182 | size = entry->c.ops->write(entry, data->file_private_data, | |
183 | file, buffer, count, pos); | |
1da177e4 | 184 | } |
4adb7bcb | 185 | if (size > 0) |
1da177e4 LT |
186 | *offset = pos + size; |
187 | return size; | |
188 | } | |
189 | ||
680ef72a | 190 | static __poll_t snd_info_entry_poll(struct file *file, poll_table *wait) |
4adb7bcb TI |
191 | { |
192 | struct snd_info_private_data *data = file->private_data; | |
193 | struct snd_info_entry *entry = data->entry; | |
680ef72a | 194 | __poll_t mask = 0; |
4adb7bcb TI |
195 | |
196 | if (entry->c.ops->poll) | |
197 | return entry->c.ops->poll(entry, | |
198 | data->file_private_data, | |
199 | file, wait); | |
200 | if (entry->c.ops->read) | |
a9a08845 | 201 | mask |= EPOLLIN | EPOLLRDNORM; |
4adb7bcb | 202 | if (entry->c.ops->write) |
a9a08845 | 203 | mask |= EPOLLOUT | EPOLLWRNORM; |
4adb7bcb TI |
204 | return mask; |
205 | } | |
206 | ||
207 | static long snd_info_entry_ioctl(struct file *file, unsigned int cmd, | |
208 | unsigned long arg) | |
209 | { | |
210 | struct snd_info_private_data *data = file->private_data; | |
211 | struct snd_info_entry *entry = data->entry; | |
212 | ||
213 | if (!entry->c.ops->ioctl) | |
214 | return -ENOTTY; | |
215 | return entry->c.ops->ioctl(entry, data->file_private_data, | |
216 | file, cmd, arg); | |
217 | } | |
218 | ||
219 | static int snd_info_entry_mmap(struct file *file, struct vm_area_struct *vma) | |
1da177e4 | 220 | { |
4adb7bcb TI |
221 | struct inode *inode = file_inode(file); |
222 | struct snd_info_private_data *data; | |
24c1f931 | 223 | struct snd_info_entry *entry; |
4adb7bcb TI |
224 | |
225 | data = file->private_data; | |
226 | if (data == NULL) | |
227 | return 0; | |
228 | entry = data->entry; | |
229 | if (!entry->c.ops->mmap) | |
230 | return -ENXIO; | |
231 | return entry->c.ops->mmap(entry, data->file_private_data, | |
232 | inode, file, vma); | |
233 | } | |
234 | ||
235 | static int snd_info_entry_open(struct inode *inode, struct file *file) | |
236 | { | |
359745d7 | 237 | struct snd_info_entry *entry = pde_data(inode); |
24c1f931 | 238 | struct snd_info_private_data *data; |
1da177e4 LT |
239 | int mode, err; |
240 | ||
1a60d4c5 | 241 | mutex_lock(&info_mutex); |
4adb7bcb TI |
242 | err = alloc_info_private(entry, &data); |
243 | if (err < 0) | |
244 | goto unlock; | |
245 | ||
1da177e4 | 246 | mode = file->f_flags & O_ACCMODE; |
4adb7bcb TI |
247 | if (((mode == O_RDONLY || mode == O_RDWR) && !entry->c.ops->read) || |
248 | ((mode == O_WRONLY || mode == O_RDWR) && !entry->c.ops->write)) { | |
249 | err = -ENODEV; | |
250 | goto error; | |
1da177e4 | 251 | } |
4adb7bcb TI |
252 | |
253 | if (entry->c.ops->open) { | |
254 | err = entry->c.ops->open(entry, mode, &data->file_private_data); | |
255 | if (err < 0) | |
256 | goto error; | |
1da177e4 | 257 | } |
4adb7bcb | 258 | |
1da177e4 | 259 | file->private_data = data; |
1a60d4c5 | 260 | mutex_unlock(&info_mutex); |
1da177e4 LT |
261 | return 0; |
262 | ||
4adb7bcb | 263 | error: |
7e4eeec8 | 264 | kfree(data); |
1da177e4 | 265 | module_put(entry->module); |
4adb7bcb | 266 | unlock: |
1a60d4c5 | 267 | mutex_unlock(&info_mutex); |
1da177e4 LT |
268 | return err; |
269 | } | |
270 | ||
271 | static int snd_info_entry_release(struct inode *inode, struct file *file) | |
272 | { | |
4adb7bcb TI |
273 | struct snd_info_private_data *data = file->private_data; |
274 | struct snd_info_entry *entry = data->entry; | |
1da177e4 | 275 | |
4adb7bcb TI |
276 | if (entry->c.ops->release) |
277 | entry->c.ops->release(entry, file->f_flags & O_ACCMODE, | |
278 | data->file_private_data); | |
1da177e4 LT |
279 | module_put(entry->module); |
280 | kfree(data); | |
281 | return 0; | |
282 | } | |
283 | ||
97a32539 AD |
284 | static const struct proc_ops snd_info_entry_operations = |
285 | { | |
286 | .proc_lseek = snd_info_entry_llseek, | |
287 | .proc_read = snd_info_entry_read, | |
288 | .proc_write = snd_info_entry_write, | |
289 | .proc_poll = snd_info_entry_poll, | |
290 | .proc_ioctl = snd_info_entry_ioctl, | |
291 | .proc_mmap = snd_info_entry_mmap, | |
292 | .proc_open = snd_info_entry_open, | |
293 | .proc_release = snd_info_entry_release, | |
4adb7bcb | 294 | }; |
1da177e4 | 295 | |
4adb7bcb TI |
296 | /* |
297 | * file ops for text proc files | |
298 | */ | |
299 | static ssize_t snd_info_text_entry_write(struct file *file, | |
300 | const char __user *buffer, | |
301 | size_t count, loff_t *offset) | |
302 | { | |
303 | struct seq_file *m = file->private_data; | |
304 | struct snd_info_private_data *data = m->private; | |
305 | struct snd_info_entry *entry = data->entry; | |
306 | struct snd_info_buffer *buf; | |
307 | loff_t pos; | |
308 | size_t next; | |
309 | int err = 0; | |
310 | ||
6809cd68 TI |
311 | if (!entry->c.text.write) |
312 | return -EIO; | |
4adb7bcb TI |
313 | pos = *offset; |
314 | if (!valid_pos(pos, count)) | |
315 | return -EIO; | |
316 | next = pos + count; | |
027a9fe6 TI |
317 | /* don't handle too large text inputs */ |
318 | if (next > 16 * 1024) | |
319 | return -EIO; | |
4adb7bcb TI |
320 | mutex_lock(&entry->access); |
321 | buf = data->wbuffer; | |
322 | if (!buf) { | |
323 | data->wbuffer = buf = kzalloc(sizeof(*buf), GFP_KERNEL); | |
324 | if (!buf) { | |
325 | err = -ENOMEM; | |
326 | goto error; | |
327 | } | |
1da177e4 | 328 | } |
4adb7bcb | 329 | if (next > buf->len) { |
ffb73b08 | 330 | char *nbuf = kvzalloc(PAGE_ALIGN(next), GFP_KERNEL); |
4adb7bcb TI |
331 | if (!nbuf) { |
332 | err = -ENOMEM; | |
333 | goto error; | |
334 | } | |
ffb73b08 | 335 | kvfree(buf->buffer); |
4adb7bcb TI |
336 | buf->buffer = nbuf; |
337 | buf->len = PAGE_ALIGN(next); | |
338 | } | |
339 | if (copy_from_user(buf->buffer + pos, buffer, count)) { | |
340 | err = -EFAULT; | |
341 | goto error; | |
342 | } | |
343 | buf->size = next; | |
344 | error: | |
345 | mutex_unlock(&entry->access); | |
346 | if (err < 0) | |
347 | return err; | |
348 | *offset = next; | |
349 | return count; | |
1da177e4 LT |
350 | } |
351 | ||
4adb7bcb | 352 | static int snd_info_seq_show(struct seq_file *seq, void *p) |
1da177e4 | 353 | { |
4adb7bcb TI |
354 | struct snd_info_private_data *data = seq->private; |
355 | struct snd_info_entry *entry = data->entry; | |
1da177e4 | 356 | |
6809cd68 TI |
357 | if (!entry->c.text.read) { |
358 | return -EIO; | |
359 | } else { | |
4adb7bcb TI |
360 | data->rbuffer->buffer = (char *)seq; /* XXX hack! */ |
361 | entry->c.text.read(entry, data->rbuffer); | |
1da177e4 | 362 | } |
4adb7bcb | 363 | return 0; |
1da177e4 LT |
364 | } |
365 | ||
4adb7bcb | 366 | static int snd_info_text_entry_open(struct inode *inode, struct file *file) |
1da177e4 | 367 | { |
359745d7 | 368 | struct snd_info_entry *entry = pde_data(inode); |
24c1f931 | 369 | struct snd_info_private_data *data; |
4adb7bcb | 370 | int err; |
1da177e4 | 371 | |
4adb7bcb TI |
372 | mutex_lock(&info_mutex); |
373 | err = alloc_info_private(entry, &data); | |
374 | if (err < 0) | |
375 | goto unlock; | |
376 | ||
377 | data->rbuffer = kzalloc(sizeof(*data->rbuffer), GFP_KERNEL); | |
378 | if (!data->rbuffer) { | |
379 | err = -ENOMEM; | |
380 | goto error; | |
381 | } | |
382 | if (entry->size) | |
383 | err = single_open_size(file, snd_info_seq_show, data, | |
384 | entry->size); | |
385 | else | |
386 | err = single_open(file, snd_info_seq_show, data); | |
387 | if (err < 0) | |
388 | goto error; | |
389 | mutex_unlock(&info_mutex); | |
390 | return 0; | |
391 | ||
392 | error: | |
393 | kfree(data->rbuffer); | |
394 | kfree(data); | |
395 | module_put(entry->module); | |
396 | unlock: | |
397 | mutex_unlock(&info_mutex); | |
398 | return err; | |
399 | } | |
400 | ||
401 | static int snd_info_text_entry_release(struct inode *inode, struct file *file) | |
402 | { | |
403 | struct seq_file *m = file->private_data; | |
404 | struct snd_info_private_data *data = m->private; | |
405 | struct snd_info_entry *entry = data->entry; | |
406 | ||
407 | if (data->wbuffer && entry->c.text.write) | |
408 | entry->c.text.write(entry, data->wbuffer); | |
409 | ||
410 | single_release(inode, file); | |
411 | kfree(data->rbuffer); | |
412 | if (data->wbuffer) { | |
ffb73b08 | 413 | kvfree(data->wbuffer->buffer); |
4adb7bcb | 414 | kfree(data->wbuffer); |
1da177e4 | 415 | } |
4adb7bcb TI |
416 | |
417 | module_put(entry->module); | |
418 | kfree(data); | |
419 | return 0; | |
1da177e4 LT |
420 | } |
421 | ||
97a32539 | 422 | static const struct proc_ops snd_info_text_entry_ops = |
1da177e4 | 423 | { |
97a32539 AD |
424 | .proc_open = snd_info_text_entry_open, |
425 | .proc_release = snd_info_text_entry_release, | |
426 | .proc_write = snd_info_text_entry_write, | |
427 | .proc_lseek = seq_lseek, | |
428 | .proc_read = seq_read, | |
1da177e4 LT |
429 | }; |
430 | ||
886364f6 TI |
431 | static struct snd_info_entry *create_subdir(struct module *mod, |
432 | const char *name) | |
433 | { | |
434 | struct snd_info_entry *entry; | |
435 | ||
436 | entry = snd_info_create_module_entry(mod, name, NULL); | |
437 | if (!entry) | |
438 | return NULL; | |
6a73cf46 | 439 | entry->mode = S_IFDIR | 0555; |
886364f6 TI |
440 | if (snd_info_register(entry) < 0) { |
441 | snd_info_free_entry(entry); | |
442 | return NULL; | |
443 | } | |
444 | return entry; | |
445 | } | |
446 | ||
8e7ccb7b | 447 | static struct snd_info_entry * |
a858ee66 TI |
448 | snd_info_create_entry(const char *name, struct snd_info_entry *parent, |
449 | struct module *module); | |
644dbd64 | 450 | |
1da177e4 LT |
451 | int __init snd_info_init(void) |
452 | { | |
a858ee66 | 453 | snd_proc_root = snd_info_create_entry("asound", NULL, THIS_MODULE); |
644dbd64 | 454 | if (!snd_proc_root) |
1da177e4 | 455 | return -ENOMEM; |
6a73cf46 | 456 | snd_proc_root->mode = S_IFDIR | 0555; |
644dbd64 TI |
457 | snd_proc_root->p = proc_mkdir("asound", NULL); |
458 | if (!snd_proc_root->p) | |
459 | goto error; | |
1da177e4 | 460 | #ifdef CONFIG_SND_OSSEMUL |
886364f6 TI |
461 | snd_oss_root = create_subdir(THIS_MODULE, "oss"); |
462 | if (!snd_oss_root) | |
463 | goto error; | |
1da177e4 | 464 | #endif |
8eeaa2f9 | 465 | #if IS_ENABLED(CONFIG_SND_SEQUENCER) |
886364f6 TI |
466 | snd_seq_root = create_subdir(THIS_MODULE, "seq"); |
467 | if (!snd_seq_root) | |
468 | goto error; | |
1da177e4 | 469 | #endif |
b591b6e9 TI |
470 | if (snd_info_version_init() < 0 || |
471 | snd_minor_info_init() < 0 || | |
472 | snd_minor_info_oss_init() < 0 || | |
a0dca822 TI |
473 | snd_card_info_init() < 0 || |
474 | snd_info_minor_register() < 0) | |
b591b6e9 | 475 | goto error; |
1da177e4 | 476 | return 0; |
886364f6 TI |
477 | |
478 | error: | |
644dbd64 | 479 | snd_info_free_entry(snd_proc_root); |
886364f6 | 480 | return -ENOMEM; |
1da177e4 LT |
481 | } |
482 | ||
483 | int __exit snd_info_done(void) | |
484 | { | |
644dbd64 | 485 | snd_info_free_entry(snd_proc_root); |
1da177e4 LT |
486 | return 0; |
487 | } | |
488 | ||
29b2625f TI |
489 | static void snd_card_id_read(struct snd_info_entry *entry, |
490 | struct snd_info_buffer *buffer) | |
491 | { | |
492 | struct snd_card *card = entry->private_data; | |
493 | ||
494 | snd_iprintf(buffer, "%s\n", card->id); | |
495 | } | |
496 | ||
1da177e4 LT |
497 | /* |
498 | * create a card proc file | |
499 | * called from init.c | |
500 | */ | |
24c1f931 | 501 | int snd_info_card_create(struct snd_card *card) |
1da177e4 LT |
502 | { |
503 | char str[8]; | |
24c1f931 | 504 | struct snd_info_entry *entry; |
1da177e4 | 505 | |
7eaa943c TI |
506 | if (snd_BUG_ON(!card)) |
507 | return -ENXIO; | |
1da177e4 LT |
508 | |
509 | sprintf(str, "card%i", card->number); | |
886364f6 TI |
510 | entry = create_subdir(card->module, str); |
511 | if (!entry) | |
1da177e4 | 512 | return -ENOMEM; |
1da177e4 | 513 | card->proc_root = entry; |
29b2625f TI |
514 | |
515 | return snd_card_ro_proc_new(card, "id", card, snd_card_id_read); | |
1da177e4 LT |
516 | } |
517 | ||
518 | /* | |
519 | * register the card proc file | |
520 | * called from init.c | |
2471b6c8 | 521 | * can be called multiple times for reinitialization |
1da177e4 | 522 | */ |
24c1f931 | 523 | int snd_info_card_register(struct snd_card *card) |
1da177e4 LT |
524 | { |
525 | struct proc_dir_entry *p; | |
2471b6c8 | 526 | int err; |
1da177e4 | 527 | |
7eaa943c TI |
528 | if (snd_BUG_ON(!card)) |
529 | return -ENXIO; | |
1da177e4 | 530 | |
348c5ad5 | 531 | err = snd_info_register(card->proc_root); |
2471b6c8 TI |
532 | if (err < 0) |
533 | return err; | |
534 | ||
1da177e4 LT |
535 | if (!strcmp(card->id, card->proc_root->name)) |
536 | return 0; | |
537 | ||
2471b6c8 TI |
538 | if (card->proc_root_link) |
539 | return 0; | |
644dbd64 | 540 | p = proc_symlink(card->id, snd_proc_root->p, card->proc_root->name); |
2471b6c8 | 541 | if (!p) |
1da177e4 LT |
542 | return -ENOMEM; |
543 | card->proc_root_link = p; | |
544 | return 0; | |
545 | } | |
546 | ||
c2eb9c4e JK |
547 | /* |
548 | * called on card->id change | |
549 | */ | |
550 | void snd_info_card_id_change(struct snd_card *card) | |
551 | { | |
552 | mutex_lock(&info_mutex); | |
553 | if (card->proc_root_link) { | |
a8ca16ea | 554 | proc_remove(card->proc_root_link); |
c2eb9c4e JK |
555 | card->proc_root_link = NULL; |
556 | } | |
557 | if (strcmp(card->id, card->proc_root->name)) | |
558 | card->proc_root_link = proc_symlink(card->id, | |
644dbd64 | 559 | snd_proc_root->p, |
c2eb9c4e JK |
560 | card->proc_root->name); |
561 | mutex_unlock(&info_mutex); | |
562 | } | |
563 | ||
1da177e4 LT |
564 | /* |
565 | * de-register the card proc file | |
566 | * called from init.c | |
567 | */ | |
746d4a02 | 568 | void snd_info_card_disconnect(struct snd_card *card) |
1da177e4 | 569 | { |
7eaa943c TI |
570 | if (!card) |
571 | return; | |
746d4a02 | 572 | mutex_lock(&info_mutex); |
a8ca16ea DH |
573 | proc_remove(card->proc_root_link); |
574 | card->proc_root_link = NULL; | |
746d4a02 TI |
575 | if (card->proc_root) |
576 | snd_info_disconnect(card->proc_root); | |
577 | mutex_unlock(&info_mutex); | |
578 | } | |
579 | ||
580 | /* | |
581 | * release the card proc file resources | |
582 | * called from init.c | |
583 | */ | |
584 | int snd_info_card_free(struct snd_card *card) | |
585 | { | |
7eaa943c TI |
586 | if (!card) |
587 | return 0; | |
746d4a02 TI |
588 | snd_info_free_entry(card->proc_root); |
589 | card->proc_root = NULL; | |
1da177e4 LT |
590 | return 0; |
591 | } | |
592 | ||
593 | ||
594 | /** | |
595 | * snd_info_get_line - read one line from the procfs buffer | |
596 | * @buffer: the procfs buffer | |
597 | * @line: the buffer to store | |
ddc64b27 | 598 | * @len: the max. buffer size |
1da177e4 LT |
599 | * |
600 | * Reads one line from the buffer and stores the string. | |
601 | * | |
eb7c06e8 | 602 | * Return: Zero if successful, or 1 if error or EOF. |
1da177e4 | 603 | */ |
24c1f931 | 604 | int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len) |
1da177e4 | 605 | { |
0e023687 | 606 | int c; |
1da177e4 | 607 | |
60379ba0 TI |
608 | if (snd_BUG_ON(!buffer)) |
609 | return 1; | |
610 | if (!buffer->buffer) | |
0bc0ec90 | 611 | return 1; |
1da177e4 LT |
612 | if (len <= 0 || buffer->stop || buffer->error) |
613 | return 1; | |
0bc0ec90 | 614 | while (!buffer->stop) { |
7e4eeec8 | 615 | c = buffer->buffer[buffer->curr++]; |
0bc0ec90 | 616 | if (buffer->curr >= buffer->size) |
1da177e4 | 617 | buffer->stop = 1; |
0bc0ec90 | 618 | if (c == '\n') |
1da177e4 | 619 | break; |
ddc64b27 | 620 | if (len > 1) { |
0bc0ec90 TI |
621 | len--; |
622 | *line++ = c; | |
1da177e4 LT |
623 | } |
624 | } | |
1da177e4 LT |
625 | *line = '\0'; |
626 | return 0; | |
627 | } | |
c0d3fb39 TI |
628 | EXPORT_SYMBOL(snd_info_get_line); |
629 | ||
1da177e4 | 630 | /** |
856def8a | 631 | * snd_info_get_str - parse a string token |
1da177e4 LT |
632 | * @dest: the buffer to store the string token |
633 | * @src: the original string | |
634 | * @len: the max. length of token - 1 | |
635 | * | |
636 | * Parses the original string and copy a token to the given | |
637 | * string buffer. | |
638 | * | |
eb7c06e8 | 639 | * Return: The updated pointer of the original string so that |
1da177e4 LT |
640 | * it can be used for the next call. |
641 | */ | |
4f7454a9 | 642 | const char *snd_info_get_str(char *dest, const char *src, int len) |
1da177e4 LT |
643 | { |
644 | int c; | |
645 | ||
646 | while (*src == ' ' || *src == '\t') | |
647 | src++; | |
648 | if (*src == '"' || *src == '\'') { | |
649 | c = *src++; | |
650 | while (--len > 0 && *src && *src != c) { | |
651 | *dest++ = *src++; | |
652 | } | |
653 | if (*src == c) | |
654 | src++; | |
655 | } else { | |
656 | while (--len > 0 && *src && *src != ' ' && *src != '\t') { | |
657 | *dest++ = *src++; | |
658 | } | |
659 | } | |
660 | *dest = 0; | |
661 | while (*src == ' ' || *src == '\t') | |
662 | src++; | |
663 | return src; | |
664 | } | |
c0d3fb39 TI |
665 | EXPORT_SYMBOL(snd_info_get_str); |
666 | ||
c309c467 | 667 | /* |
1da177e4 LT |
668 | * snd_info_create_entry - create an info entry |
669 | * @name: the proc file name | |
8e7ccb7b | 670 | * @parent: the parent directory |
1da177e4 LT |
671 | * |
672 | * Creates an info entry with the given file name and initializes as | |
673 | * the default state. | |
674 | * | |
675 | * Usually called from other functions such as | |
676 | * snd_info_create_card_entry(). | |
677 | * | |
eb7c06e8 | 678 | * Return: The pointer of the new instance, or %NULL on failure. |
1da177e4 | 679 | */ |
8e7ccb7b | 680 | static struct snd_info_entry * |
a858ee66 TI |
681 | snd_info_create_entry(const char *name, struct snd_info_entry *parent, |
682 | struct module *module) | |
1da177e4 | 683 | { |
24c1f931 | 684 | struct snd_info_entry *entry; |
ca2c0966 | 685 | entry = kzalloc(sizeof(*entry), GFP_KERNEL); |
1da177e4 LT |
686 | if (entry == NULL) |
687 | return NULL; | |
543537bd | 688 | entry->name = kstrdup(name, GFP_KERNEL); |
1da177e4 LT |
689 | if (entry->name == NULL) { |
690 | kfree(entry); | |
691 | return NULL; | |
692 | } | |
6a73cf46 | 693 | entry->mode = S_IFREG | 0444; |
1da177e4 | 694 | entry->content = SNDRV_INFO_CONTENT_TEXT; |
1a60d4c5 | 695 | mutex_init(&entry->access); |
746d4a02 TI |
696 | INIT_LIST_HEAD(&entry->children); |
697 | INIT_LIST_HEAD(&entry->list); | |
8e7ccb7b | 698 | entry->parent = parent; |
a858ee66 | 699 | entry->module = module; |
8c2f8708 TI |
700 | if (parent) { |
701 | mutex_lock(&parent->access); | |
8e7ccb7b | 702 | list_add_tail(&entry->list, &parent->children); |
8c2f8708 TI |
703 | mutex_unlock(&parent->access); |
704 | } | |
1da177e4 LT |
705 | return entry; |
706 | } | |
707 | ||
708 | /** | |
709 | * snd_info_create_module_entry - create an info entry for the given module | |
710 | * @module: the module pointer | |
711 | * @name: the file name | |
712 | * @parent: the parent directory | |
713 | * | |
714 | * Creates a new info entry and assigns it to the given module. | |
715 | * | |
eb7c06e8 | 716 | * Return: The pointer of the new instance, or %NULL on failure. |
1da177e4 | 717 | */ |
24c1f931 | 718 | struct snd_info_entry *snd_info_create_module_entry(struct module * module, |
1da177e4 | 719 | const char *name, |
24c1f931 | 720 | struct snd_info_entry *parent) |
1da177e4 | 721 | { |
3a554371 TI |
722 | if (!parent) |
723 | parent = snd_proc_root; | |
a858ee66 | 724 | return snd_info_create_entry(name, parent, module); |
1da177e4 | 725 | } |
c0d3fb39 TI |
726 | EXPORT_SYMBOL(snd_info_create_module_entry); |
727 | ||
1da177e4 LT |
728 | /** |
729 | * snd_info_create_card_entry - create an info entry for the given card | |
730 | * @card: the card instance | |
731 | * @name: the file name | |
732 | * @parent: the parent directory | |
733 | * | |
734 | * Creates a new info entry and assigns it to the given card. | |
735 | * | |
eb7c06e8 | 736 | * Return: The pointer of the new instance, or %NULL on failure. |
1da177e4 | 737 | */ |
24c1f931 | 738 | struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card, |
1da177e4 | 739 | const char *name, |
24c1f931 | 740 | struct snd_info_entry * parent) |
1da177e4 | 741 | { |
3a554371 TI |
742 | if (!parent) |
743 | parent = card->proc_root; | |
a858ee66 | 744 | return snd_info_create_entry(name, parent, card->module); |
1da177e4 | 745 | } |
c0d3fb39 TI |
746 | EXPORT_SYMBOL(snd_info_create_card_entry); |
747 | ||
746d4a02 | 748 | static void snd_info_disconnect(struct snd_info_entry *entry) |
1da177e4 | 749 | { |
90a409aa | 750 | struct snd_info_entry *p; |
1da177e4 | 751 | |
c560a679 | 752 | if (!entry->p) |
746d4a02 | 753 | return; |
90a409aa | 754 | list_for_each_entry(p, &entry->children, list) |
c560a679 | 755 | snd_info_disconnect(p); |
a8ca16ea | 756 | proc_remove(entry->p); |
746d4a02 | 757 | entry->p = NULL; |
1da177e4 LT |
758 | } |
759 | ||
1da177e4 LT |
760 | /** |
761 | * snd_info_free_entry - release the info entry | |
762 | * @entry: the info entry | |
763 | * | |
c560a679 | 764 | * Releases the info entry. |
1da177e4 | 765 | */ |
24c1f931 | 766 | void snd_info_free_entry(struct snd_info_entry * entry) |
1da177e4 | 767 | { |
c560a679 TI |
768 | struct snd_info_entry *p, *n; |
769 | ||
770 | if (!entry) | |
1da177e4 | 771 | return; |
746d4a02 TI |
772 | if (entry->p) { |
773 | mutex_lock(&info_mutex); | |
774 | snd_info_disconnect(entry); | |
775 | mutex_unlock(&info_mutex); | |
776 | } | |
c560a679 TI |
777 | |
778 | /* free all children at first */ | |
779 | list_for_each_entry_safe(p, n, &entry->children, list) | |
780 | snd_info_free_entry(p); | |
781 | ||
8c2f8708 TI |
782 | p = entry->parent; |
783 | if (p) { | |
784 | mutex_lock(&p->access); | |
785 | list_del(&entry->list); | |
786 | mutex_unlock(&p->access); | |
787 | } | |
1da177e4 LT |
788 | kfree(entry->name); |
789 | if (entry->private_free) | |
790 | entry->private_free(entry); | |
791 | kfree(entry); | |
792 | } | |
c0d3fb39 TI |
793 | EXPORT_SYMBOL(snd_info_free_entry); |
794 | ||
348c5ad5 | 795 | static int __snd_info_register(struct snd_info_entry *entry) |
1da177e4 LT |
796 | { |
797 | struct proc_dir_entry *root, *p = NULL; | |
798 | ||
7eaa943c TI |
799 | if (snd_BUG_ON(!entry)) |
800 | return -ENXIO; | |
644dbd64 | 801 | root = entry->parent == NULL ? snd_proc_root->p : entry->parent->p; |
1a60d4c5 | 802 | mutex_lock(&info_mutex); |
348c5ad5 TI |
803 | if (entry->p || !root) |
804 | goto unlock; | |
aee0c612 AV |
805 | if (S_ISDIR(entry->mode)) { |
806 | p = proc_mkdir_mode(entry->name, entry->mode, root); | |
807 | if (!p) { | |
808 | mutex_unlock(&info_mutex); | |
809 | return -ENOMEM; | |
810 | } | |
811 | } else { | |
97a32539 | 812 | const struct proc_ops *ops; |
4adb7bcb TI |
813 | if (entry->content == SNDRV_INFO_CONTENT_DATA) |
814 | ops = &snd_info_entry_operations; | |
815 | else | |
816 | ops = &snd_info_text_entry_ops; | |
aee0c612 | 817 | p = proc_create_data(entry->name, entry->mode, root, |
4adb7bcb | 818 | ops, entry); |
aee0c612 AV |
819 | if (!p) { |
820 | mutex_unlock(&info_mutex); | |
821 | return -ENOMEM; | |
822 | } | |
271a15ea | 823 | proc_set_size(p, entry->size); |
1da177e4 | 824 | } |
1da177e4 | 825 | entry->p = p; |
348c5ad5 | 826 | unlock: |
1a60d4c5 | 827 | mutex_unlock(&info_mutex); |
1da177e4 LT |
828 | return 0; |
829 | } | |
348c5ad5 TI |
830 | |
831 | /** | |
832 | * snd_info_register - register the info entry | |
833 | * @entry: the info entry | |
834 | * | |
835 | * Registers the proc info entry. | |
836 | * The all children entries are registered recursively. | |
837 | * | |
838 | * Return: Zero if successful, or a negative error code on failure. | |
839 | */ | |
840 | int snd_info_register(struct snd_info_entry *entry) | |
841 | { | |
842 | struct snd_info_entry *p; | |
843 | int err; | |
844 | ||
845 | if (!entry->p) { | |
846 | err = __snd_info_register(entry); | |
847 | if (err < 0) | |
848 | return err; | |
849 | } | |
850 | ||
851 | list_for_each_entry(p, &entry->children, list) { | |
852 | err = snd_info_register(p); | |
853 | if (err < 0) | |
854 | return err; | |
855 | } | |
856 | ||
857 | return 0; | |
858 | } | |
c0d3fb39 TI |
859 | EXPORT_SYMBOL(snd_info_register); |
860 | ||
7453e1da TI |
861 | /** |
862 | * snd_card_rw_proc_new - Create a read/write text proc file entry for the card | |
863 | * @card: the card instance | |
864 | * @name: the file name | |
865 | * @private_data: the arbitrary private data | |
866 | * @read: the read callback | |
867 | * @write: the write callback, NULL for read-only | |
868 | * | |
869 | * This proc file entry will be registered via snd_card_register() call, and | |
870 | * it will be removed automatically at the card removal, too. | |
281dee67 TI |
871 | * |
872 | * Return: zero if successful, or a negative error code | |
7453e1da TI |
873 | */ |
874 | int snd_card_rw_proc_new(struct snd_card *card, const char *name, | |
875 | void *private_data, | |
876 | void (*read)(struct snd_info_entry *, | |
877 | struct snd_info_buffer *), | |
878 | void (*write)(struct snd_info_entry *entry, | |
879 | struct snd_info_buffer *buffer)) | |
880 | { | |
881 | struct snd_info_entry *entry; | |
882 | ||
883 | entry = snd_info_create_card_entry(card, name, card->proc_root); | |
884 | if (!entry) | |
885 | return -ENOMEM; | |
886 | snd_info_set_text_ops(entry, private_data, read); | |
887 | if (write) { | |
888 | entry->mode |= 0200; | |
889 | entry->c.text.write = write; | |
890 | } | |
891 | return 0; | |
892 | } | |
893 | EXPORT_SYMBOL_GPL(snd_card_rw_proc_new); | |
894 | ||
1da177e4 LT |
895 | /* |
896 | ||
897 | */ | |
898 | ||
24c1f931 | 899 | static void snd_info_version_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer) |
1da177e4 LT |
900 | { |
901 | snd_iprintf(buffer, | |
42662748 JK |
902 | "Advanced Linux Sound Architecture Driver Version k%s.\n", |
903 | init_utsname()->release); | |
1da177e4 LT |
904 | } |
905 | ||
906 | static int __init snd_info_version_init(void) | |
907 | { | |
24c1f931 | 908 | struct snd_info_entry *entry; |
1da177e4 LT |
909 | |
910 | entry = snd_info_create_module_entry(THIS_MODULE, "version", NULL); | |
911 | if (entry == NULL) | |
912 | return -ENOMEM; | |
1da177e4 | 913 | entry->c.text.read = snd_info_version_read; |
b591b6e9 | 914 | return snd_info_register(entry); /* freed in error path */ |
1da177e4 | 915 | } |