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@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/sched.h> /* wake_up() */
26 #include <linux/mutex.h> /* struct mutex */
27 #include <linux/rwsem.h> /* struct rw_semaphore */
28 #include <linux/pm.h> /* pm_message_t */
29 #include <linux/stringify.h>
30
31 /* number of supported soundcards */
32 #ifdef CONFIG_SND_DYNAMIC_MINORS
33 #define SNDRV_CARDS 32
34 #else
35 #define SNDRV_CARDS 8 /* don't change - minor numbers */
36 #endif
37
38 #define CONFIG_SND_MAJOR 116 /* standard configuration */
39
40 /* forward declarations */
41 struct pci_dev;
42 struct module;
43 struct device;
44 struct device_attribute;
45
46 /* device allocation stuff */
47
48 #define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000
49
50 typedef int __bitwise snd_device_type_t;
51 #define SNDRV_DEV_TOPLEVEL ((__force snd_device_type_t) 0)
52 #define SNDRV_DEV_CONTROL ((__force snd_device_type_t) 1)
53 #define SNDRV_DEV_LOWLEVEL_PRE ((__force snd_device_type_t) 2)
54 #define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
55 #define SNDRV_DEV_PCM ((__force snd_device_type_t) 0x1001)
56 #define SNDRV_DEV_RAWMIDI ((__force snd_device_type_t) 0x1002)
57 #define SNDRV_DEV_TIMER ((__force snd_device_type_t) 0x1003)
58 #define SNDRV_DEV_SEQUENCER ((__force snd_device_type_t) 0x1004)
59 #define SNDRV_DEV_HWDEP ((__force snd_device_type_t) 0x1005)
60 #define SNDRV_DEV_INFO ((__force snd_device_type_t) 0x1006)
61 #define SNDRV_DEV_BUS ((__force snd_device_type_t) 0x1007)
62 #define SNDRV_DEV_CODEC ((__force snd_device_type_t) 0x1008)
63 #define SNDRV_DEV_JACK ((__force snd_device_type_t) 0x1009)
64 #define SNDRV_DEV_COMPRESS ((__force snd_device_type_t) 0x100A)
65 #define SNDRV_DEV_LOWLEVEL ((__force snd_device_type_t) 0x2000)
66
67 typedef int __bitwise snd_device_state_t;
68 #define SNDRV_DEV_BUILD ((__force snd_device_state_t) 0)
69 #define SNDRV_DEV_REGISTERED ((__force snd_device_state_t) 1)
70 #define SNDRV_DEV_DISCONNECTED ((__force snd_device_state_t) 2)
71
72 typedef int __bitwise snd_device_cmd_t;
73 #define SNDRV_DEV_CMD_PRE ((__force snd_device_cmd_t) 0)
74 #define SNDRV_DEV_CMD_NORMAL ((__force snd_device_cmd_t) 1)
75 #define SNDRV_DEV_CMD_POST ((__force snd_device_cmd_t) 2)
76
77 struct snd_device;
78
79 struct snd_device_ops {
80 int (*dev_free)(struct snd_device *dev);
81 int (*dev_register)(struct snd_device *dev);
82 int (*dev_disconnect)(struct snd_device *dev);
83 };
84
85 struct snd_device {
86 struct list_head list; /* list of registered devices */
87 struct snd_card *card; /* card which holds this device */
88 snd_device_state_t state; /* state of the device */
89 snd_device_type_t type; /* device type */
90 void *device_data; /* device structure */
91 struct snd_device_ops *ops; /* operations */
92 };
93
94 #define snd_device(n) list_entry(n, struct snd_device, list)
95
96 /* main structure for soundcard */
97
98 struct snd_card {
99 int number; /* number of soundcard (index to
100 snd_cards) */
101
102 char id[16]; /* id string of this card */
103 char driver[16]; /* driver name */
104 char shortname[32]; /* short name of this soundcard */
105 char longname[80]; /* name of this soundcard */
106 char mixername[80]; /* mixer name */
107 char components[128]; /* card components delimited with
108 space */
109 struct module *module; /* top-level module */
110
111 void *private_data; /* private data for soundcard */
112 void (*private_free) (struct snd_card *card); /* callback for freeing of
113 private data */
114 struct list_head devices; /* devices */
115
116 unsigned int last_numid; /* last used numeric ID */
117 struct rw_semaphore controls_rwsem; /* controls list lock */
118 rwlock_t ctl_files_rwlock; /* ctl_files list lock */
119 int controls_count; /* count of all controls */
120 int user_ctl_count; /* count of all user controls */
121 struct list_head controls; /* all controls for this card */
122 struct list_head ctl_files; /* active control files */
123 struct mutex user_ctl_lock; /* protects user controls against
124 concurrent access */
125
126 struct snd_info_entry *proc_root; /* root for soundcard specific files */
127 struct snd_info_entry *proc_id; /* the card id */
128 struct proc_dir_entry *proc_root_link; /* number link to real id */
129
130 struct list_head files_list; /* all files associated to this card */
131 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
132 state */
133 spinlock_t files_lock; /* lock the files for this card */
134 int shutdown; /* this card is going down */
135 int free_on_last_close; /* free in context of file_release */
136 wait_queue_head_t shutdown_sleep;
137 atomic_t refcount; /* refcount for disconnection */
138 struct device *dev; /* device assigned to this card */
139 struct device *card_dev; /* cardX object for sysfs */
140
141 #ifdef CONFIG_PM
142 unsigned int power_state; /* power state */
143 struct mutex power_lock; /* power lock */
144 wait_queue_head_t power_sleep;
145 #endif
146
147 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
148 struct snd_mixer_oss *mixer_oss;
149 int mixer_oss_change_count;
150 #endif
151 };
152
153 #ifdef CONFIG_PM
snd_power_lock(struct snd_card * card)154 static inline void snd_power_lock(struct snd_card *card)
155 {
156 mutex_lock(&card->power_lock);
157 }
158
snd_power_unlock(struct snd_card * card)159 static inline void snd_power_unlock(struct snd_card *card)
160 {
161 mutex_unlock(&card->power_lock);
162 }
163
snd_power_get_state(struct snd_card * card)164 static inline unsigned int snd_power_get_state(struct snd_card *card)
165 {
166 return card->power_state;
167 }
168
snd_power_change_state(struct snd_card * card,unsigned int state)169 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
170 {
171 card->power_state = state;
172 wake_up(&card->power_sleep);
173 }
174
175 /* init.c */
176 int snd_power_wait(struct snd_card *card, unsigned int power_state);
177
178 #else /* ! CONFIG_PM */
179
180 #define snd_power_lock(card) do { (void)(card); } while (0)
181 #define snd_power_unlock(card) do { (void)(card); } while (0)
snd_power_wait(struct snd_card * card,unsigned int state)182 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
183 #define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
184 #define snd_power_change_state(card, state) do { (void)(card); } while (0)
185
186 #endif /* CONFIG_PM */
187
188 struct snd_minor {
189 int type; /* SNDRV_DEVICE_TYPE_XXX */
190 int card; /* card number */
191 int device; /* device number */
192 const struct file_operations *f_ops; /* file operations */
193 void *private_data; /* private data for f_ops->open */
194 struct device *dev; /* device for sysfs */
195 struct snd_card *card_ptr; /* assigned card instance */
196 };
197
198 /* return a device pointer linked to each sound device as a parent */
snd_card_get_device_link(struct snd_card * card)199 static inline struct device *snd_card_get_device_link(struct snd_card *card)
200 {
201 return card ? card->card_dev : NULL;
202 }
203
204 /* sound.c */
205
206 extern int snd_major;
207 extern int snd_ecards_limit;
208 extern struct class *sound_class;
209
210 void snd_request_card(int card);
211
212 int snd_register_device_for_dev(int type, struct snd_card *card,
213 int dev,
214 const struct file_operations *f_ops,
215 void *private_data,
216 const char *name,
217 struct device *device);
218
219 /**
220 * snd_register_device - Register the ALSA device file for the card
221 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
222 * @card: the card instance
223 * @dev: the device index
224 * @f_ops: the file operations
225 * @private_data: user pointer for f_ops->open()
226 * @name: the device file name
227 *
228 * Registers an ALSA device file for the given card.
229 * The operators have to be set in reg parameter.
230 *
231 * This function uses the card's device pointer to link to the
232 * correct &struct device.
233 *
234 * Returns zero if successful, or a negative error code on failure.
235 */
snd_register_device(int type,struct snd_card * card,int dev,const struct file_operations * f_ops,void * private_data,const char * name)236 static inline int snd_register_device(int type, struct snd_card *card, int dev,
237 const struct file_operations *f_ops,
238 void *private_data,
239 const char *name)
240 {
241 return snd_register_device_for_dev(type, card, dev, f_ops,
242 private_data, name,
243 snd_card_get_device_link(card));
244 }
245
246 int snd_unregister_device(int type, struct snd_card *card, int dev);
247 void *snd_lookup_minor_data(unsigned int minor, int type);
248 int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
249 struct device_attribute *attr);
250
251 #ifdef CONFIG_SND_OSSEMUL
252 int snd_register_oss_device(int type, struct snd_card *card, int dev,
253 const struct file_operations *f_ops, void *private_data,
254 const char *name);
255 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
256 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
257 #endif
258
259 int snd_minor_info_init(void);
260 int snd_minor_info_done(void);
261
262 /* sound_oss.c */
263
264 #ifdef CONFIG_SND_OSSEMUL
265 int snd_minor_info_oss_init(void);
266 int snd_minor_info_oss_done(void);
267 #else
snd_minor_info_oss_init(void)268 static inline int snd_minor_info_oss_init(void) { return 0; }
snd_minor_info_oss_done(void)269 static inline int snd_minor_info_oss_done(void) { return 0; }
270 #endif
271
272 /* memory.c */
273
274 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
275 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
276
277 /* init.c */
278
279 extern struct snd_card *snd_cards[SNDRV_CARDS];
280 int snd_card_locked(int card);
281 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
282 #define SND_MIXER_OSS_NOTIFY_REGISTER 0
283 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
284 #define SND_MIXER_OSS_NOTIFY_FREE 2
285 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
286 #endif
287
288 int snd_card_create(int idx, const char *id,
289 struct module *module, int extra_size,
290 struct snd_card **card_ret);
291
292 int snd_card_disconnect(struct snd_card *card);
293 int snd_card_free(struct snd_card *card);
294 int snd_card_free_when_closed(struct snd_card *card);
295 void snd_card_set_id(struct snd_card *card, const char *id);
296 int snd_card_register(struct snd_card *card);
297 int snd_card_info_init(void);
298 int snd_card_info_done(void);
299 int snd_component_add(struct snd_card *card, const char *component);
300 int snd_card_file_add(struct snd_card *card, struct file *file);
301 int snd_card_file_remove(struct snd_card *card, struct file *file);
302 void snd_card_unref(struct snd_card *card);
303
304 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
305
306 /* device.c */
307
308 int snd_device_new(struct snd_card *card, snd_device_type_t type,
309 void *device_data, struct snd_device_ops *ops);
310 int snd_device_register(struct snd_card *card, void *device_data);
311 int snd_device_register_all(struct snd_card *card);
312 int snd_device_disconnect(struct snd_card *card, void *device_data);
313 int snd_device_disconnect_all(struct snd_card *card);
314 int snd_device_free(struct snd_card *card, void *device_data);
315 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
316
317 /* isadma.c */
318
319 #ifdef CONFIG_ISA_DMA_API
320 #define DMA_MODE_NO_ENABLE 0x0100
321
322 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
323 void snd_dma_disable(unsigned long dma);
324 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
325 #endif
326
327 /* misc.c */
328 struct resource;
329 void release_and_free_resource(struct resource *res);
330
331 /* --- */
332
333 /* sound printk debug levels */
334 enum {
335 SND_PR_ALWAYS,
336 SND_PR_DEBUG,
337 SND_PR_VERBOSE,
338 };
339
340 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
341 __printf(4, 5)
342 void __snd_printk(unsigned int level, const char *file, int line,
343 const char *format, ...);
344 #else
345 #define __snd_printk(level, file, line, format, args...) \
346 printk(format, ##args)
347 #endif
348
349 /**
350 * snd_printk - printk wrapper
351 * @fmt: format string
352 *
353 * Works like printk() but prints the file and the line of the caller
354 * when configured with CONFIG_SND_VERBOSE_PRINTK.
355 */
356 #define snd_printk(fmt, args...) \
357 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
358
359 #ifdef CONFIG_SND_DEBUG
360 /**
361 * snd_printd - debug printk
362 * @fmt: format string
363 *
364 * Works like snd_printk() for debugging purposes.
365 * Ignored when CONFIG_SND_DEBUG is not set.
366 */
367 #define snd_printd(fmt, args...) \
368 __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
369 #define _snd_printd(level, fmt, args...) \
370 __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
371
372 /**
373 * snd_BUG - give a BUG warning message and stack trace
374 *
375 * Calls WARN() if CONFIG_SND_DEBUG is set.
376 * Ignored when CONFIG_SND_DEBUG is not set.
377 */
378 #define snd_BUG() WARN(1, "BUG?\n")
379
380 /**
381 * snd_BUG_ON - debugging check macro
382 * @cond: condition to evaluate
383 *
384 * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,
385 * and call WARN() and returns the value if it's non-zero.
386 *
387 * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given
388 * condition is ignored.
389 *
390 * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.
391 * Thus, don't put any statement that influences on the code behavior,
392 * such as pre/post increment, to the argument of this macro.
393 * If you want to evaluate and give a warning, use standard WARN_ON().
394 */
395 #define snd_BUG_ON(cond) WARN((cond), "BUG? (%s)\n", __stringify(cond))
396
397 #else /* !CONFIG_SND_DEBUG */
398
399 #define snd_printd(fmt, args...) do { } while (0)
400 #define _snd_printd(level, fmt, args...) do { } while (0)
401 #define snd_BUG() do { } while (0)
__snd_bug_on(int cond)402 static inline int __snd_bug_on(int cond)
403 {
404 return 0;
405 }
406 #define snd_BUG_ON(cond) __snd_bug_on(0 && (cond)) /* always false */
407
408 #endif /* CONFIG_SND_DEBUG */
409
410 #ifdef CONFIG_SND_DEBUG_VERBOSE
411 /**
412 * snd_printdd - debug printk
413 * @format: format string
414 *
415 * Works like snd_printk() for debugging purposes.
416 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
417 */
418 #define snd_printdd(format, args...) \
419 __snd_printk(2, __FILE__, __LINE__, format, ##args)
420 #else
421 #define snd_printdd(format, args...) do { } while (0)
422 #endif
423
424
425 #define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
426
427 /* for easier backward-porting */
428 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
429 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
430 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
431 #define gameport_get_port_data(gp) (gp)->port_data
432 #endif
433
434 #ifdef CONFIG_PCI
435 /* PCI quirk list helper */
436 struct snd_pci_quirk {
437 unsigned short subvendor; /* PCI subvendor ID */
438 unsigned short subdevice; /* PCI subdevice ID */
439 unsigned short subdevice_mask; /* bitmask to match */
440 int value; /* value */
441 #ifdef CONFIG_SND_DEBUG_VERBOSE
442 const char *name; /* name of the device (optional) */
443 #endif
444 };
445
446 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
447 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
448 #define _SND_PCI_QUIRK_ID(vend, dev) \
449 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
450 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
451 #ifdef CONFIG_SND_DEBUG_VERBOSE
452 #define SND_PCI_QUIRK(vend,dev,xname,val) \
453 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
454 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
455 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
456 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
457 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
458 .value = (val), .name = (xname)}
459 #else
460 #define SND_PCI_QUIRK(vend,dev,xname,val) \
461 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
462 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
463 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
464 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
465 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
466 #endif
467
468 const struct snd_pci_quirk *
469 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
470
471 const struct snd_pci_quirk *
472 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
473 const struct snd_pci_quirk *list);
474 #endif
475
476 #endif /* __SOUND_CORE_H */
477