xref: /linux/include/sound/info.h (revision f3d9478b2ce468c3115b02ecae7e975990697f15)
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@suse.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 
27 /* buffer for information */
28 struct snd_info_buffer {
29 	char *buffer;		/* pointer to begin of buffer */
30 	unsigned int curr;	/* current position in buffer */
31 	unsigned int size;	/* current size */
32 	unsigned int len;	/* total length of buffer */
33 	int stop;		/* stop flag */
34 	int error;		/* error code */
35 };
36 
37 #define SNDRV_INFO_CONTENT_TEXT		0
38 #define SNDRV_INFO_CONTENT_DATA		1
39 
40 struct snd_info_entry;
41 
42 struct snd_info_entry_text {
43 	void (*read) (struct snd_info_entry *entry, struct snd_info_buffer *buffer);
44 	void (*write) (struct snd_info_entry *entry, struct snd_info_buffer *buffer);
45 };
46 
47 struct snd_info_entry_ops {
48 	int (*open) (struct snd_info_entry *entry,
49 		     unsigned short mode, void **file_private_data);
50 	int (*release) (struct snd_info_entry * entry,
51 			unsigned short mode, void *file_private_data);
52 	long (*read) (struct snd_info_entry *entry, void *file_private_data,
53 		      struct file * file, char __user *buf,
54 		      unsigned long count, unsigned long pos);
55 	long (*write) (struct snd_info_entry *entry, void *file_private_data,
56 		       struct file * file, const char __user *buf,
57 		       unsigned long count, unsigned long pos);
58 	long long (*llseek) (struct snd_info_entry *entry, void *file_private_data,
59 			    struct file * file, long long offset, int orig);
60 	unsigned int (*poll) (struct snd_info_entry *entry, void *file_private_data,
61 			      struct file * file, poll_table * wait);
62 	int (*ioctl) (struct snd_info_entry *entry, void *file_private_data,
63 		      struct file * file, unsigned int cmd, unsigned long arg);
64 	int (*mmap) (struct snd_info_entry *entry, void *file_private_data,
65 		     struct inode * inode, struct file * file,
66 		     struct vm_area_struct * vma);
67 };
68 
69 struct snd_info_entry {
70 	const char *name;
71 	mode_t mode;
72 	long size;
73 	unsigned short content;
74 	unsigned short disconnected: 1;
75 	union {
76 		struct snd_info_entry_text text;
77 		struct snd_info_entry_ops *ops;
78 	} c;
79 	struct snd_info_entry *parent;
80 	struct snd_card *card;
81 	struct module *module;
82 	void *private_data;
83 	void (*private_free)(struct snd_info_entry *entry);
84 	struct proc_dir_entry *p;
85 	struct mutex access;
86 };
87 
88 #if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_PROC_FS)
89 int snd_info_minor_register(void);
90 int snd_info_minor_unregister(void);
91 #else
92 #define snd_info_minor_register() /* NOP */
93 #define snd_info_minor_unregister() /* NOP */
94 #endif
95 
96 
97 #ifdef CONFIG_PROC_FS
98 
99 extern struct snd_info_entry *snd_seq_root;
100 #ifdef CONFIG_SND_OSSEMUL
101 extern struct snd_info_entry *snd_oss_root;
102 #else
103 #define snd_oss_root NULL
104 #endif
105 
106 int snd_iprintf(struct snd_info_buffer * buffer, char *fmt,...) __attribute__ ((format (printf, 2, 3)));
107 int snd_info_init(void);
108 int snd_info_done(void);
109 
110 int snd_info_get_line(struct snd_info_buffer * buffer, char *line, int len);
111 char *snd_info_get_str(char *dest, char *src, int len);
112 struct snd_info_entry *snd_info_create_module_entry(struct module * module,
113 					       const char *name,
114 					       struct snd_info_entry * parent);
115 struct snd_info_entry *snd_info_create_card_entry(struct snd_card * card,
116 					     const char *name,
117 					     struct snd_info_entry * parent);
118 void snd_info_free_entry(struct snd_info_entry * entry);
119 int snd_info_store_text(struct snd_info_entry * entry);
120 int snd_info_restore_text(struct snd_info_entry * entry);
121 
122 int snd_info_card_create(struct snd_card * card);
123 int snd_info_card_register(struct snd_card * card);
124 int snd_info_card_free(struct snd_card * card);
125 int snd_info_register(struct snd_info_entry * entry);
126 int snd_info_unregister(struct snd_info_entry * entry);
127 
128 /* for card drivers */
129 int snd_card_proc_new(struct snd_card *card, const char *name, struct snd_info_entry **entryp);
130 
131 static inline void snd_info_set_text_ops(struct snd_info_entry *entry,
132 					 void *private_data,
133 					 void (*read)(struct snd_info_entry *, struct snd_info_buffer *))
134 {
135 	entry->private_data = private_data;
136 	entry->c.text.read = read;
137 }
138 
139 int snd_info_check_reserved_words(const char *str);
140 
141 #else
142 
143 #define snd_seq_root NULL
144 #define snd_oss_root NULL
145 
146 static inline int snd_iprintf(struct snd_info_buffer * buffer, char *fmt,...) { return 0; }
147 static inline int snd_info_init(void) { return 0; }
148 static inline int snd_info_done(void) { return 0; }
149 
150 static inline int snd_info_get_line(struct snd_info_buffer * buffer, char *line, int len) { return 0; }
151 static inline char *snd_info_get_str(char *dest, char *src, int len) { return NULL; }
152 static inline struct snd_info_entry *snd_info_create_module_entry(struct module * module, const char *name, struct snd_info_entry * parent) { return NULL; }
153 static inline struct snd_info_entry *snd_info_create_card_entry(struct snd_card * card, const char *name, struct snd_info_entry * parent) { return NULL; }
154 static inline void snd_info_free_entry(struct snd_info_entry * entry) { ; }
155 
156 static inline int snd_info_card_create(struct snd_card * card) { return 0; }
157 static inline int snd_info_card_register(struct snd_card * card) { return 0; }
158 static inline int snd_info_card_free(struct snd_card * card) { return 0; }
159 static inline int snd_info_register(struct snd_info_entry * entry) { return 0; }
160 static inline int snd_info_unregister(struct snd_info_entry * entry) { return 0; }
161 
162 static inline int snd_card_proc_new(struct snd_card *card, const char *name,
163 				    struct snd_info_entry **entryp) { return -EINVAL; }
164 static inline void snd_info_set_text_ops(struct snd_info_entry *entry __attribute__((unused)),
165 					 void *private_data,
166 					 void (*read)(struct snd_info_entry *, struct snd_info_buffer *)) {}
167 
168 static inline int snd_info_check_reserved_words(const char *str) { return 1; }
169 
170 #endif
171 
172 /*
173  * OSS info part
174  */
175 
176 #if defined(CONFIG_SND_OSSEMUL) && defined(CONFIG_PROC_FS)
177 
178 #define SNDRV_OSS_INFO_DEV_AUDIO	0
179 #define SNDRV_OSS_INFO_DEV_SYNTH	1
180 #define SNDRV_OSS_INFO_DEV_MIDI		2
181 #define SNDRV_OSS_INFO_DEV_TIMERS	4
182 #define SNDRV_OSS_INFO_DEV_MIXERS	5
183 
184 #define SNDRV_OSS_INFO_DEV_COUNT	6
185 
186 int snd_oss_info_register(int dev, int num, char *string);
187 #define snd_oss_info_unregister(dev, num) snd_oss_info_register(dev, num, NULL)
188 
189 #endif /* CONFIG_SND_OSSEMUL && CONFIG_PROC_FS */
190 
191 #endif /* __SOUND_INFO_H */
192