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