Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef __SOUND_INFO_H
2#define __SOUND_INFO_H
3
4/*
5 * Header file for info interface
6 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7 *
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 *
23 */
24
25#include <linux/poll.h>
26#include <linux/seq_file.h>
27#include <sound/core.h>
28
29/* buffer for information */
30struct snd_info_buffer {
31 char *buffer; /* pointer to begin of buffer */
32 unsigned int curr; /* current position in buffer */
33 unsigned int size; /* current size */
34 unsigned int len; /* total length of buffer */
35 int stop; /* stop flag */
36 int error; /* error code */
37};
38
39#define SNDRV_INFO_CONTENT_TEXT 0
40#define SNDRV_INFO_CONTENT_DATA 1
41
42struct snd_info_entry;
43
44struct snd_info_entry_text {
45 void (*read)(struct snd_info_entry *entry,
46 struct snd_info_buffer *buffer);
47 void (*write)(struct snd_info_entry *entry,
48 struct snd_info_buffer *buffer);
49};
50
51struct snd_info_entry_ops {
52 int (*open)(struct snd_info_entry *entry,
53 unsigned short mode, void **file_private_data);
54 int (*release)(struct snd_info_entry *entry,
55 unsigned short mode, void *file_private_data);
56 ssize_t (*read)(struct snd_info_entry *entry, void *file_private_data,
57 struct file *file, char __user *buf,
58 size_t count, loff_t pos);
59 ssize_t (*write)(struct snd_info_entry *entry, void *file_private_data,
60 struct file *file, const char __user *buf,
61 size_t count, loff_t pos);
62 loff_t (*llseek)(struct snd_info_entry *entry,
63 void *file_private_data, struct file *file,
64 loff_t offset, int orig);
65 __poll_t (*poll)(struct snd_info_entry *entry,
66 void *file_private_data, struct file *file,
67 poll_table *wait);
68 int (*ioctl)(struct snd_info_entry *entry, void *file_private_data,
69 struct file *file, unsigned int cmd, unsigned long arg);
70 int (*mmap)(struct snd_info_entry *entry, void *file_private_data,
71 struct inode *inode, struct file *file,
72 struct vm_area_struct *vma);
73};
74
75struct snd_info_entry {
76 const char *name;
77 umode_t mode;
78 long size;
79 unsigned short content;
80 union {
81 struct snd_info_entry_text text;
82 struct snd_info_entry_ops *ops;
83 } c;
84 struct snd_info_entry *parent;
85 struct module *module;
86 void *private_data;
87 void (*private_free)(struct snd_info_entry *entry);
88 struct proc_dir_entry *p;
89 struct mutex access;
90 struct list_head children;
91 struct list_head list;
92};
93
94#if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_SND_PROC_FS)
95int snd_info_minor_register(void);
96#else
97#define snd_info_minor_register() 0
98#endif
99
100
101#ifdef CONFIG_SND_PROC_FS
102
103extern struct snd_info_entry *snd_seq_root;
104#ifdef CONFIG_SND_OSSEMUL
105extern struct snd_info_entry *snd_oss_root;
106void snd_card_info_read_oss(struct snd_info_buffer *buffer);
107#else
108#define snd_oss_root NULL
109static inline void snd_card_info_read_oss(struct snd_info_buffer *buffer) {}
110#endif
111
112/**
113 * snd_iprintf - printf on the procfs buffer
114 * @buf: the procfs buffer
115 * @fmt: the printf format
116 *
117 * Outputs the string on the procfs buffer just like printf().
118 *
119 * Return: zero for success, or a negative error code.
120 */
121#define snd_iprintf(buf, fmt, args...) \
122 seq_printf((struct seq_file *)(buf)->buffer, fmt, ##args)
123
124int snd_info_init(void);
125int snd_info_done(void);
126
127int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len);
128const char *snd_info_get_str(char *dest, const char *src, int len);
129struct snd_info_entry *snd_info_create_module_entry(struct module *module,
130 const char *name,
131 struct snd_info_entry *parent);
132struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card,
133 const char *name,
134 struct snd_info_entry *parent);
135void snd_info_free_entry(struct snd_info_entry *entry);
136int snd_info_store_text(struct snd_info_entry *entry);
137int snd_info_restore_text(struct snd_info_entry *entry);
138
139int snd_info_card_create(struct snd_card *card);
140int snd_info_card_register(struct snd_card *card);
141int snd_info_card_free(struct snd_card *card);
142void snd_info_card_disconnect(struct snd_card *card);
143void snd_info_card_id_change(struct snd_card *card);
144int snd_info_register(struct snd_info_entry *entry);
145
146/* for card drivers */
147static inline int snd_card_proc_new(struct snd_card *card, const char *name,
148 struct snd_info_entry **entryp)
149{
150 *entryp = snd_info_create_card_entry(card, name, card->proc_root);
151 return *entryp ? 0 : -ENOMEM;
152}
153
154static inline void snd_info_set_text_ops(struct snd_info_entry *entry,
155 void *private_data,
156 void (*read)(struct snd_info_entry *, struct snd_info_buffer *))
157{
158 entry->private_data = private_data;
159 entry->c.text.read = read;
160}
161
162int snd_card_rw_proc_new(struct snd_card *card, const char *name,
163 void *private_data,
164 void (*read)(struct snd_info_entry *,
165 struct snd_info_buffer *),
166 void (*write)(struct snd_info_entry *entry,
167 struct snd_info_buffer *buffer));
168
169int snd_info_check_reserved_words(const char *str);
170
171#else
172
173#define snd_seq_root NULL
174#define snd_oss_root NULL
175
176static inline int snd_iprintf(struct snd_info_buffer *buffer, char *fmt, ...) { return 0; }
177static inline int snd_info_init(void) { return 0; }
178static inline int snd_info_done(void) { return 0; }
179
180static inline int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len) { return 0; }
181static inline char *snd_info_get_str(char *dest, char *src, int len) { return NULL; }
182static inline struct snd_info_entry *snd_info_create_module_entry(struct module *module, const char *name, struct snd_info_entry *parent) { return NULL; }
183static inline struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card, const char *name, struct snd_info_entry *parent) { return NULL; }
184static inline void snd_info_free_entry(struct snd_info_entry *entry) { ; }
185
186static inline int snd_info_card_create(struct snd_card *card) { return 0; }
187static inline int snd_info_card_register(struct snd_card *card) { return 0; }
188static inline int snd_info_card_free(struct snd_card *card) { return 0; }
189static inline void snd_info_card_disconnect(struct snd_card *card) { }
190static inline void snd_info_card_id_change(struct snd_card *card) { }
191static inline int snd_info_register(struct snd_info_entry *entry) { return 0; }
192
193static inline int snd_card_proc_new(struct snd_card *card, const char *name,
194 struct snd_info_entry **entryp) { return -EINVAL; }
195static inline void snd_info_set_text_ops(struct snd_info_entry *entry __attribute__((unused)),
196 void *private_data,
197 void (*read)(struct snd_info_entry *, struct snd_info_buffer *)) {}
198static inline int snd_card_rw_proc_new(struct snd_card *card, const char *name,
199 void *private_data,
200 void (*read)(struct snd_info_entry *,
201 struct snd_info_buffer *),
202 void (*write)(struct snd_info_entry *entry,
203 struct snd_info_buffer *buffer))
204{
205 return 0;
206}
207static inline int snd_info_check_reserved_words(const char *str) { return 1; }
208
209#endif
210
211/**
212 * snd_card_ro_proc_new - Create a read-only text proc file entry for the card
213 * @card: the card instance
214 * @name: the file name
215 * @private_data: the arbitrary private data
216 * @read: the read callback
217 *
218 * This proc file entry will be registered via snd_card_register() call, and
219 * it will be removed automatically at the card removal, too.
220 */
221static inline int
222snd_card_ro_proc_new(struct snd_card *card, const char *name,
223 void *private_data,
224 void (*read)(struct snd_info_entry *,
225 struct snd_info_buffer *))
226{
227 return snd_card_rw_proc_new(card, name, private_data, read, NULL);
228}
229
230/*
231 * OSS info part
232 */
233
234#if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_SND_PROC_FS)
235
236#define SNDRV_OSS_INFO_DEV_AUDIO 0
237#define SNDRV_OSS_INFO_DEV_SYNTH 1
238#define SNDRV_OSS_INFO_DEV_MIDI 2
239#define SNDRV_OSS_INFO_DEV_TIMERS 4
240#define SNDRV_OSS_INFO_DEV_MIXERS 5
241
242#define SNDRV_OSS_INFO_DEV_COUNT 6
243
244int snd_oss_info_register(int dev, int num, char *string);
245#define snd_oss_info_unregister(dev, num) snd_oss_info_register(dev, num, NULL)
246
247#endif /* CONFIG_SND_OSSEMUL && CONFIG_SND_PROC_FS */
248
249#endif /* __SOUND_INFO_H */