5 * Main header file for the ALSA driver
6 * Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
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.
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.
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
25 #include <linux/module.h>
26 #include <linux/sched.h> /* wake_up() */
27 #include <linux/mutex.h> /* struct mutex */
28 #include <linux/rwsem.h> /* struct rw_semaphore */
29 #include <linux/pm.h> /* pm_message_t */
30 #include <linux/device.h>
32 /* number of supported soundcards */
33 #ifdef CONFIG_SND_DYNAMIC_MINORS
34 #define SNDRV_CARDS 32
36 #define SNDRV_CARDS 8 /* don't change - minor numbers */
39 #define CONFIG_SND_MAJOR 116 /* standard configuration */
41 /* forward declarations */
49 /* device allocation stuff */
51 #define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000
53 typedef int __bitwise snd_device_type_t;
54 #define SNDRV_DEV_TOPLEVEL ((__force snd_device_type_t) 0)
55 #define SNDRV_DEV_CONTROL ((__force snd_device_type_t) 1)
56 #define SNDRV_DEV_LOWLEVEL_PRE ((__force snd_device_type_t) 2)
57 #define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
58 #define SNDRV_DEV_PCM ((__force snd_device_type_t) 0x1001)
59 #define SNDRV_DEV_RAWMIDI ((__force snd_device_type_t) 0x1002)
60 #define SNDRV_DEV_TIMER ((__force snd_device_type_t) 0x1003)
61 #define SNDRV_DEV_SEQUENCER ((__force snd_device_type_t) 0x1004)
62 #define SNDRV_DEV_HWDEP ((__force snd_device_type_t) 0x1005)
63 #define SNDRV_DEV_INFO ((__force snd_device_type_t) 0x1006)
64 #define SNDRV_DEV_BUS ((__force snd_device_type_t) 0x1007)
65 #define SNDRV_DEV_CODEC ((__force snd_device_type_t) 0x1008)
66 #define SNDRV_DEV_JACK ((__force snd_device_type_t) 0x1009)
67 #define SNDRV_DEV_LOWLEVEL ((__force snd_device_type_t) 0x2000)
69 typedef int __bitwise snd_device_state_t;
70 #define SNDRV_DEV_BUILD ((__force snd_device_state_t) 0)
71 #define SNDRV_DEV_REGISTERED ((__force snd_device_state_t) 1)
72 #define SNDRV_DEV_DISCONNECTED ((__force snd_device_state_t) 2)
74 typedef int __bitwise snd_device_cmd_t;
75 #define SNDRV_DEV_CMD_PRE ((__force snd_device_cmd_t) 0)
76 #define SNDRV_DEV_CMD_NORMAL ((__force snd_device_cmd_t) 1)
77 #define SNDRV_DEV_CMD_POST ((__force snd_device_cmd_t) 2)
81 struct snd_device_ops {
82 int (*dev_free)(struct snd_device *dev);
83 int (*dev_register)(struct snd_device *dev);
84 int (*dev_disconnect)(struct snd_device *dev);
88 struct list_head list; /* list of registered devices */
89 struct snd_card *card; /* card which holds this device */
90 snd_device_state_t state; /* state of the device */
91 snd_device_type_t type; /* device type */
92 void *device_data; /* device structure */
93 struct snd_device_ops *ops; /* operations */
96 #define snd_device(n) list_entry(n, struct snd_device, list)
98 /* monitor files for graceful shutdown (hotplug) */
100 struct snd_monitor_file {
102 struct snd_monitor_file *next;
103 const struct file_operations *disconnected_f_op;
104 struct list_head shutdown_list;
107 /* main structure for soundcard */
110 int number; /* number of soundcard (index to
113 char id[16]; /* id string of this card */
114 char driver[16]; /* driver name */
115 char shortname[32]; /* short name of this soundcard */
116 char longname[80]; /* name of this soundcard */
117 char mixername[80]; /* mixer name */
118 char components[80]; /* card components delimited with
120 struct module *module; /* top-level module */
122 void *private_data; /* private data for soundcard */
123 void (*private_free) (struct snd_card *card); /* callback for freeing of
125 struct list_head devices; /* devices */
127 unsigned int last_numid; /* last used numeric ID */
128 struct rw_semaphore controls_rwsem; /* controls list lock */
129 rwlock_t ctl_files_rwlock; /* ctl_files list lock */
130 int controls_count; /* count of all controls */
131 int user_ctl_count; /* count of all user controls */
132 struct list_head controls; /* all controls for this card */
133 struct list_head ctl_files; /* active control files */
135 struct snd_info_entry *proc_root; /* root for soundcard specific files */
136 struct snd_info_entry *proc_id; /* the card id */
137 struct proc_dir_entry *proc_root_link; /* number link to real id */
139 struct snd_monitor_file *files; /* all files associated to this card */
140 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
142 spinlock_t files_lock; /* lock the files for this card */
143 int shutdown; /* this card is going down */
144 int free_on_last_close; /* free in context of file_release */
145 wait_queue_head_t shutdown_sleep;
146 struct device *dev; /* device assigned to this card */
147 #ifndef CONFIG_SYSFS_DEPRECATED
148 struct device *card_dev; /* cardX object for sysfs */
152 unsigned int power_state; /* power state */
153 struct mutex power_lock; /* power lock */
154 wait_queue_head_t power_sleep;
157 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
158 struct snd_mixer_oss *mixer_oss;
159 int mixer_oss_change_count;
164 static inline void snd_power_lock(struct snd_card *card)
166 mutex_lock(&card->power_lock);
169 static inline void snd_power_unlock(struct snd_card *card)
171 mutex_unlock(&card->power_lock);
174 static inline unsigned int snd_power_get_state(struct snd_card *card)
176 return card->power_state;
179 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
181 card->power_state = state;
182 wake_up(&card->power_sleep);
186 int snd_power_wait(struct snd_card *card, unsigned int power_state);
188 #else /* ! CONFIG_PM */
190 #define snd_power_lock(card) do { (void)(card); } while (0)
191 #define snd_power_unlock(card) do { (void)(card); } while (0)
192 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
193 #define snd_power_get_state(card) SNDRV_CTL_POWER_D0
194 #define snd_power_change_state(card, state) do { (void)(card); } while (0)
196 #endif /* CONFIG_PM */
199 int type; /* SNDRV_DEVICE_TYPE_XXX */
200 int card; /* card number */
201 int device; /* device number */
202 const struct file_operations *f_ops; /* file operations */
203 void *private_data; /* private data for f_ops->open */
204 struct device *dev; /* device for sysfs */
207 /* return a device pointer linked to each sound device as a parent */
208 static inline struct device *snd_card_get_device_link(struct snd_card *card)
210 #ifdef CONFIG_SYSFS_DEPRECATED
211 return card ? card->dev : NULL;
213 return card ? card->card_dev : NULL;
219 extern int snd_major;
220 extern int snd_ecards_limit;
221 extern struct class *sound_class;
223 void snd_request_card(int card);
225 int snd_register_device_for_dev(int type, struct snd_card *card,
227 const struct file_operations *f_ops,
230 struct device *device);
233 * snd_register_device - Register the ALSA device file for the card
234 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
235 * @card: the card instance
236 * @dev: the device index
237 * @f_ops: the file operations
238 * @private_data: user pointer for f_ops->open()
239 * @name: the device file name
241 * Registers an ALSA device file for the given card.
242 * The operators have to be set in reg parameter.
244 * This function uses the card's device pointer to link to the
245 * correct &struct device.
247 * Returns zero if successful, or a negative error code on failure.
249 static inline int snd_register_device(int type, struct snd_card *card, int dev,
250 const struct file_operations *f_ops,
254 return snd_register_device_for_dev(type, card, dev, f_ops,
256 snd_card_get_device_link(card));
259 int snd_unregister_device(int type, struct snd_card *card, int dev);
260 void *snd_lookup_minor_data(unsigned int minor, int type);
261 int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
262 struct device_attribute *attr);
264 #ifdef CONFIG_SND_OSSEMUL
265 int snd_register_oss_device(int type, struct snd_card *card, int dev,
266 const struct file_operations *f_ops, void *private_data,
268 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
269 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
272 int snd_minor_info_init(void);
273 int snd_minor_info_done(void);
277 #ifdef CONFIG_SND_OSSEMUL
278 int snd_minor_info_oss_init(void);
279 int snd_minor_info_oss_done(void);
281 static inline int snd_minor_info_oss_init(void) { return 0; }
282 static inline int snd_minor_info_oss_done(void) { return 0; }
287 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
288 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
292 extern struct snd_card *snd_cards[SNDRV_CARDS];
293 int snd_card_locked(int card);
294 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
295 #define SND_MIXER_OSS_NOTIFY_REGISTER 0
296 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
297 #define SND_MIXER_OSS_NOTIFY_FREE 2
298 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
301 struct snd_card *snd_card_new(int idx, const char *id,
302 struct module *module, int extra_size);
303 int snd_card_disconnect(struct snd_card *card);
304 int snd_card_free(struct snd_card *card);
305 int snd_card_free_when_closed(struct snd_card *card);
306 int snd_card_register(struct snd_card *card);
307 int snd_card_info_init(void);
308 int snd_card_info_done(void);
309 int snd_component_add(struct snd_card *card, const char *component);
310 int snd_card_file_add(struct snd_card *card, struct file *file);
311 int snd_card_file_remove(struct snd_card *card, struct file *file);
313 #ifndef snd_card_set_dev
314 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
319 int snd_device_new(struct snd_card *card, snd_device_type_t type,
320 void *device_data, struct snd_device_ops *ops);
321 int snd_device_register(struct snd_card *card, void *device_data);
322 int snd_device_register_all(struct snd_card *card);
323 int snd_device_disconnect(struct snd_card *card, void *device_data);
324 int snd_device_disconnect_all(struct snd_card *card);
325 int snd_device_free(struct snd_card *card, void *device_data);
326 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
330 #ifdef CONFIG_ISA_DMA_API
331 #define DMA_MODE_NO_ENABLE 0x0100
333 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
334 void snd_dma_disable(unsigned long dma);
335 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
340 void release_and_free_resource(struct resource *res);
342 #ifdef CONFIG_SND_VERBOSE_PRINTK
343 void snd_verbose_printk(const char *file, int line, const char *format, ...)
344 __attribute__ ((format (printf, 3, 4)));
346 #if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK)
347 void snd_verbose_printd(const char *file, int line, const char *format, ...)
348 __attribute__ ((format (printf, 3, 4)));
353 #ifdef CONFIG_SND_VERBOSE_PRINTK
355 * snd_printk - printk wrapper
356 * @fmt: format string
358 * Works like print() but prints the file and the line of the caller
359 * when configured with CONFIG_SND_VERBOSE_PRINTK.
361 #define snd_printk(fmt, args...) \
362 snd_verbose_printk(__FILE__, __LINE__, fmt ,##args)
364 #define snd_printk(fmt, args...) \
368 #ifdef CONFIG_SND_DEBUG
370 #define __ASTRING__(x) #x
372 #ifdef CONFIG_SND_VERBOSE_PRINTK
374 * snd_printd - debug printk
375 * @fmt: format string
377 * Works like snd_printk() for debugging purposes.
378 * Ignored when CONFIG_SND_DEBUG is not set.
380 #define snd_printd(fmt, args...) \
381 snd_verbose_printd(__FILE__, __LINE__, fmt ,##args)
383 #define snd_printd(fmt, args...) \
387 * snd_assert - run-time assertion macro
390 * This macro checks the expression in run-time and invokes the commands
391 * given in the rest arguments if the assertion is failed.
392 * When CONFIG_SND_DEBUG is not set, the expression is executed but
395 #define snd_assert(expr, args...) do { \
396 if (unlikely(!(expr))) { \
397 snd_printk(KERN_ERR "BUG? (%s)\n", __ASTRING__(expr)); \
403 #define snd_BUG() do { \
404 snd_printk(KERN_ERR "BUG?\n"); \
408 #else /* !CONFIG_SND_DEBUG */
410 #define snd_printd(fmt, args...) /* nothing */
411 #define snd_assert(expr, args...) (void)(expr)
412 #define snd_BUG() /* nothing */
414 #endif /* CONFIG_SND_DEBUG */
416 #ifdef CONFIG_SND_DEBUG_VERBOSE
418 * snd_printdd - debug printk
419 * @format: format string
421 * Works like snd_printk() for debugging purposes.
422 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
424 #define snd_printdd(format, args...) snd_printk(format, ##args)
426 #define snd_printdd(format, args...) /* nothing */
430 #define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
432 /* for easier backward-porting */
433 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
434 #ifndef gameport_set_dev_parent
435 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
436 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
437 #define gameport_get_port_data(gp) (gp)->port_data
441 /* PCI quirk list helper */
442 struct snd_pci_quirk {
443 unsigned short subvendor; /* PCI subvendor ID */
444 unsigned short subdevice; /* PCI subdevice ID */
445 int value; /* value */
446 #ifdef CONFIG_SND_DEBUG_VERBOSE
447 const char *name; /* name of the device (optional) */
451 #define _SND_PCI_QUIRK_ID(vend,dev) \
452 .subvendor = (vend), .subdevice = (dev)
453 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
454 #ifdef CONFIG_SND_DEBUG_VERBOSE
455 #define SND_PCI_QUIRK(vend,dev,xname,val) \
456 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
458 #define SND_PCI_QUIRK(vend,dev,xname,val) \
459 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
462 const struct snd_pci_quirk *
463 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
466 #endif /* __SOUND_CORE_H */