[PATCH] mark f_ops const in the inode
[linux-2.6.git] / include / sound / core.h
1 #ifndef __SOUND_CORE_H
2 #define __SOUND_CORE_H
3
4 /*
5  *  Main header file for the ALSA driver
6  *  Copyright (c) 1994-2001 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/sched.h>                /* wake_up() */
26 #include <linux/mutex.h>                /* struct mutex */
27 #include <linux/rwsem.h>                /* struct rw_semaphore */
28 #include <linux/workqueue.h>            /* struct workqueue_struct */
29 #include <linux/pm.h>                   /* pm_message_t */
30
31 /* forward declarations */
32 #ifdef CONFIG_PCI
33 struct pci_dev;
34 #endif
35 #ifdef CONFIG_SBUS
36 struct sbus_dev;
37 #endif
38
39 /* device allocation stuff */
40
41 #define SNDRV_DEV_TYPE_RANGE_SIZE               0x1000
42
43 typedef int __bitwise snd_device_type_t;
44 #define SNDRV_DEV_TOPLEVEL      ((__force snd_device_type_t) 0)
45 #define SNDRV_DEV_CONTROL       ((__force snd_device_type_t) 1)
46 #define SNDRV_DEV_LOWLEVEL_PRE  ((__force snd_device_type_t) 2)
47 #define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
48 #define SNDRV_DEV_PCM           ((__force snd_device_type_t) 0x1001)
49 #define SNDRV_DEV_RAWMIDI       ((__force snd_device_type_t) 0x1002)
50 #define SNDRV_DEV_TIMER         ((__force snd_device_type_t) 0x1003)
51 #define SNDRV_DEV_SEQUENCER     ((__force snd_device_type_t) 0x1004)
52 #define SNDRV_DEV_HWDEP         ((__force snd_device_type_t) 0x1005)
53 #define SNDRV_DEV_INFO          ((__force snd_device_type_t) 0x1006)
54 #define SNDRV_DEV_BUS           ((__force snd_device_type_t) 0x1007)
55 #define SNDRV_DEV_CODEC         ((__force snd_device_type_t) 0x1008)
56 #define SNDRV_DEV_LOWLEVEL      ((__force snd_device_type_t) 0x2000)
57
58 typedef int __bitwise snd_device_state_t;
59 #define SNDRV_DEV_BUILD         ((__force snd_device_state_t) 0)
60 #define SNDRV_DEV_REGISTERED    ((__force snd_device_state_t) 1)
61 #define SNDRV_DEV_DISCONNECTED  ((__force snd_device_state_t) 2)
62
63 typedef int __bitwise snd_device_cmd_t;
64 #define SNDRV_DEV_CMD_PRE       ((__force snd_device_cmd_t) 0)
65 #define SNDRV_DEV_CMD_NORMAL    ((__force snd_device_cmd_t) 1)  
66 #define SNDRV_DEV_CMD_POST      ((__force snd_device_cmd_t) 2)
67
68 struct snd_device;
69
70 struct snd_device_ops {
71         int (*dev_free)(struct snd_device *dev);
72         int (*dev_register)(struct snd_device *dev);
73         int (*dev_disconnect)(struct snd_device *dev);
74         int (*dev_unregister)(struct snd_device *dev);
75 };
76
77 struct snd_device {
78         struct list_head list;          /* list of registered devices */
79         struct snd_card *card;          /* card which holds this device */
80         snd_device_state_t state;       /* state of the device */
81         snd_device_type_t type;         /* device type */
82         void *device_data;              /* device structure */
83         struct snd_device_ops *ops;     /* operations */
84 };
85
86 #define snd_device(n) list_entry(n, struct snd_device, list)
87
88 /* monitor files for graceful shutdown (hotplug) */
89
90 struct snd_monitor_file {
91         struct file *file;
92         struct snd_monitor_file *next;
93 };
94
95 struct snd_shutdown_f_ops;      /* define it later in init.c */
96
97 /* main structure for soundcard */
98
99 struct snd_card {
100         int number;                     /* number of soundcard (index to
101                                                                 snd_cards) */
102
103         char id[16];                    /* id string of this card */
104         char driver[16];                /* driver name */
105         char shortname[32];             /* short name of this soundcard */
106         char longname[80];              /* name of this soundcard */
107         char mixername[80];             /* mixer name */
108         char components[80];            /* card components delimited with
109                                                                 space */
110         struct module *module;          /* top-level module */
111
112         void *private_data;             /* private data for soundcard */
113         void (*private_free) (struct snd_card *card); /* callback for freeing of
114                                                                 private data */
115         struct list_head devices;       /* devices */
116
117         unsigned int last_numid;        /* last used numeric ID */
118         struct rw_semaphore controls_rwsem;     /* controls list lock */
119         rwlock_t ctl_files_rwlock;      /* ctl_files list lock */
120         int controls_count;             /* count of all controls */
121         int user_ctl_count;             /* count of all user controls */
122         struct list_head controls;      /* all controls for this card */
123         struct list_head ctl_files;     /* active control files */
124
125         struct snd_info_entry *proc_root;       /* root for soundcard specific files */
126         struct snd_info_entry *proc_id; /* the card id */
127         struct proc_dir_entry *proc_root_link;  /* number link to real id */
128
129         struct snd_monitor_file *files; /* all files associated to this card */
130         struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
131                                                                 state */
132         spinlock_t files_lock;          /* lock the files for this card */
133         int shutdown;                   /* this card is going down */
134         wait_queue_head_t shutdown_sleep;
135         struct work_struct free_workq;  /* for free in workqueue */
136         struct device *dev;
137
138 #ifdef CONFIG_PM
139         unsigned int power_state;       /* power state */
140         struct mutex power_lock;        /* power lock */
141         wait_queue_head_t power_sleep;
142 #endif
143
144 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
145         struct snd_mixer_oss *mixer_oss;
146         int mixer_oss_change_count;
147 #endif
148 };
149
150 #ifdef CONFIG_PM
151 static inline void snd_power_lock(struct snd_card *card)
152 {
153         mutex_lock(&card->power_lock);
154 }
155
156 static inline void snd_power_unlock(struct snd_card *card)
157 {
158         mutex_unlock(&card->power_lock);
159 }
160
161 static inline unsigned int snd_power_get_state(struct snd_card *card)
162 {
163         return card->power_state;
164 }
165
166 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
167 {
168         card->power_state = state;
169         wake_up(&card->power_sleep);
170 }
171
172 /* init.c */
173 int snd_power_wait(struct snd_card *card, unsigned int power_state, struct file *file);
174
175 #else /* ! CONFIG_PM */
176
177 #define snd_power_lock(card)            do { (void)(card); } while (0)
178 #define snd_power_unlock(card)          do { (void)(card); } while (0)
179 static inline int snd_power_wait(struct snd_card *card, unsigned int state, struct file *file) { return 0; }
180 #define snd_power_get_state(card)       SNDRV_CTL_POWER_D0
181 #define snd_power_change_state(card, state)     do { (void)(card); } while (0)
182
183 #endif /* CONFIG_PM */
184
185 struct snd_minor {
186         int type;                       /* SNDRV_DEVICE_TYPE_XXX */
187         int card;                       /* card number */
188         int device;                     /* device number */
189         const struct file_operations *f_ops;    /* file operations */
190         void *private_data;             /* private data for f_ops->open */
191         char name[0];                   /* device name (keep at the end of
192                                                                 structure) */
193 };
194
195 /* sound.c */
196
197 extern int snd_major;
198 extern int snd_ecards_limit;
199
200 void snd_request_card(int card);
201
202 int snd_register_device(int type, struct snd_card *card, int dev,
203                         const struct file_operations *f_ops, void *private_data,
204                         const char *name);
205 int snd_unregister_device(int type, struct snd_card *card, int dev);
206 void *snd_lookup_minor_data(unsigned int minor, int type);
207
208 #ifdef CONFIG_SND_OSSEMUL
209 int snd_register_oss_device(int type, struct snd_card *card, int dev,
210                             const struct file_operations *f_ops, void *private_data,
211                             const char *name);
212 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
213 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
214 #endif
215
216 int snd_minor_info_init(void);
217 int snd_minor_info_done(void);
218
219 /* sound_oss.c */
220
221 #ifdef CONFIG_SND_OSSEMUL
222 int snd_minor_info_oss_init(void);
223 int snd_minor_info_oss_done(void);
224 #else
225 #define snd_minor_info_oss_init() /*NOP*/
226 #define snd_minor_info_oss_done() /*NOP*/
227 #endif
228
229 /* memory.c */
230
231 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
232 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
233
234 /* init.c */
235
236 extern unsigned int snd_cards_lock;
237 extern struct snd_card *snd_cards[SNDRV_CARDS];
238 extern rwlock_t snd_card_rwlock;
239 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
240 #define SND_MIXER_OSS_NOTIFY_REGISTER   0
241 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
242 #define SND_MIXER_OSS_NOTIFY_FREE       2
243 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
244 #endif
245
246 struct snd_card *snd_card_new(int idx, const char *id,
247                          struct module *module, int extra_size);
248 int snd_card_disconnect(struct snd_card *card);
249 int snd_card_free(struct snd_card *card);
250 int snd_card_free_in_thread(struct snd_card *card);
251 int snd_card_register(struct snd_card *card);
252 int snd_card_info_init(void);
253 int snd_card_info_done(void);
254 int snd_component_add(struct snd_card *card, const char *component);
255 int snd_card_file_add(struct snd_card *card, struct file *file);
256 int snd_card_file_remove(struct snd_card *card, struct file *file);
257
258 #ifndef snd_card_set_dev
259 #define snd_card_set_dev(card,devptr) ((card)->dev = (devptr))
260 #endif
261
262 /* device.c */
263
264 int snd_device_new(struct snd_card *card, snd_device_type_t type,
265                    void *device_data, struct snd_device_ops *ops);
266 int snd_device_register(struct snd_card *card, void *device_data);
267 int snd_device_register_all(struct snd_card *card);
268 int snd_device_disconnect(struct snd_card *card, void *device_data);
269 int snd_device_disconnect_all(struct snd_card *card);
270 int snd_device_free(struct snd_card *card, void *device_data);
271 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
272
273 /* isadma.c */
274
275 #ifdef CONFIG_ISA_DMA_API
276 #define DMA_MODE_NO_ENABLE      0x0100
277
278 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
279 void snd_dma_disable(unsigned long dma);
280 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
281 #endif
282
283 /* misc.c */
284 struct resource;
285 void release_and_free_resource(struct resource *res);
286
287 #ifdef CONFIG_SND_VERBOSE_PRINTK
288 void snd_verbose_printk(const char *file, int line, const char *format, ...)
289      __attribute__ ((format (printf, 3, 4)));
290 #endif
291 #if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK)
292 void snd_verbose_printd(const char *file, int line, const char *format, ...)
293      __attribute__ ((format (printf, 3, 4)));
294 #endif
295
296 /* --- */
297
298 #ifdef CONFIG_SND_VERBOSE_PRINTK
299 /**
300  * snd_printk - printk wrapper
301  * @fmt: format string
302  *
303  * Works like print() but prints the file and the line of the caller
304  * when configured with CONFIG_SND_VERBOSE_PRINTK.
305  */
306 #define snd_printk(fmt, args...) \
307         snd_verbose_printk(__FILE__, __LINE__, fmt ,##args)
308 #else
309 #define snd_printk(fmt, args...) \
310         printk(fmt ,##args)
311 #endif
312
313 #ifdef CONFIG_SND_DEBUG
314
315 #define __ASTRING__(x) #x
316
317 #ifdef CONFIG_SND_VERBOSE_PRINTK
318 /**
319  * snd_printd - debug printk
320  * @fmt: format string
321  *
322  * Compiled only when Works like snd_printk() for debugging purpose.
323  * Ignored when CONFIG_SND_DEBUG is not set.
324  */
325 #define snd_printd(fmt, args...) \
326         snd_verbose_printd(__FILE__, __LINE__, fmt ,##args)
327 #else
328 #define snd_printd(fmt, args...) \
329         printk(fmt ,##args)
330 #endif
331 /**
332  * snd_assert - run-time assertion macro
333  * @expr: expression
334  *
335  * This macro checks the expression in run-time and invokes the commands
336  * given in the rest arguments if the assertion is failed.
337  * When CONFIG_SND_DEBUG is not set, the expression is executed but
338  * not checked.
339  */
340 #define snd_assert(expr, args...) do {                                  \
341         if (unlikely(!(expr))) {                                        \
342                 snd_printk(KERN_ERR "BUG? (%s)\n", __ASTRING__(expr));  \
343                 dump_stack();                                           \
344                 args;                                                   \
345         }                                                               \
346 } while (0)
347
348 #define snd_BUG() do {                          \
349         snd_printk(KERN_ERR "BUG?\n");          \
350         dump_stack();                           \
351 } while (0)
352
353 #else /* !CONFIG_SND_DEBUG */
354
355 #define snd_printd(fmt, args...)        /* nothing */
356 #define snd_assert(expr, args...)       (void)(expr)
357 #define snd_BUG()                       /* nothing */
358
359 #endif /* CONFIG_SND_DEBUG */
360
361 #ifdef CONFIG_SND_DEBUG_DETECT
362 /**
363  * snd_printdd - debug printk
364  * @format: format string
365  *
366  * Compiled only when Works like snd_printk() for debugging purpose.
367  * Ignored when CONFIG_SND_DEBUG_DETECT is not set.
368  */
369 #define snd_printdd(format, args...) snd_printk(format, ##args)
370 #else
371 #define snd_printdd(format, args...) /* nothing */
372 #endif
373
374
375 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
376
377 /* for easier backward-porting */
378 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
379 #ifndef gameport_set_dev_parent
380 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
381 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
382 #define gameport_get_port_data(gp) (gp)->port_data
383 #endif
384 #endif
385
386 #include "typedefs.h"
387
388 #endif /* __SOUND_CORE_H */