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/device.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/stringify.h>
31 #include <linux/printk.h>
33 /* number of supported soundcards */
34 #ifdef CONFIG_SND_DYNAMIC_MINORS
35 #define SNDRV_CARDS CONFIG_SND_MAX_CARDS
37 #define SNDRV_CARDS 8 /* don't change - minor numbers */
40 #define CONFIG_SND_MAJOR 116 /* standard configuration */
42 /* forward declarations */
47 /* device allocation stuff */
49 /* type of the object used in snd_device_*()
50 * this also defines the calling order
52 enum snd_device_type {
67 enum snd_device_state {
70 SNDRV_DEV_DISCONNECTED,
75 struct snd_device_ops {
76 int (*dev_free)(struct snd_device *dev);
77 int (*dev_register)(struct snd_device *dev);
78 int (*dev_disconnect)(struct snd_device *dev);
82 struct list_head list; /* list of registered devices */
83 struct snd_card *card; /* card which holds this device */
84 enum snd_device_state state; /* state of the device */
85 enum snd_device_type type; /* device type */
86 void *device_data; /* device structure */
87 struct snd_device_ops *ops; /* operations */
90 #define snd_device(n) list_entry(n, struct snd_device, list)
92 /* main structure for soundcard */
95 int number; /* number of soundcard (index to
98 char id[16]; /* id string of this card */
99 char driver[16]; /* driver name */
100 char shortname[32]; /* short name of this soundcard */
101 char longname[80]; /* name of this soundcard */
102 char mixername[80]; /* mixer name */
103 char components[128]; /* card components delimited with
105 struct module *module; /* top-level module */
107 void *private_data; /* private data for soundcard */
108 void (*private_free) (struct snd_card *card); /* callback for freeing of
110 struct list_head devices; /* devices */
112 unsigned int last_numid; /* last used numeric ID */
113 struct rw_semaphore controls_rwsem; /* controls list lock */
114 rwlock_t ctl_files_rwlock; /* ctl_files list lock */
115 int controls_count; /* count of all controls */
116 int user_ctl_count; /* count of all user controls */
117 struct list_head controls; /* all controls for this card */
118 struct list_head ctl_files; /* active control files */
120 struct snd_info_entry *proc_root; /* root for soundcard specific files */
121 struct snd_info_entry *proc_id; /* the card id */
122 struct proc_dir_entry *proc_root_link; /* number link to real id */
124 struct list_head files_list; /* all files associated to this card */
125 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
127 spinlock_t files_lock; /* lock the files for this card */
128 int shutdown; /* this card is going down */
129 struct completion *release_completion;
130 struct device *dev; /* device assigned to this card */
131 struct device card_dev; /* cardX object for sysfs */
132 bool registered; /* card_dev is registered? */
135 unsigned int power_state; /* power state */
136 struct mutex power_lock; /* power lock */
137 wait_queue_head_t power_sleep;
140 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
141 struct snd_mixer_oss *mixer_oss;
142 int mixer_oss_change_count;
146 #define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
149 static inline void snd_power_lock(struct snd_card *card)
151 mutex_lock(&card->power_lock);
154 static inline void snd_power_unlock(struct snd_card *card)
156 mutex_unlock(&card->power_lock);
159 static inline unsigned int snd_power_get_state(struct snd_card *card)
161 return card->power_state;
164 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
166 card->power_state = state;
167 wake_up(&card->power_sleep);
171 int snd_power_wait(struct snd_card *card, unsigned int power_state);
173 #else /* ! CONFIG_PM */
175 #define snd_power_lock(card) do { (void)(card); } while (0)
176 #define snd_power_unlock(card) do { (void)(card); } while (0)
177 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
178 #define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
179 #define snd_power_change_state(card, state) do { (void)(card); } while (0)
181 #endif /* CONFIG_PM */
184 int type; /* SNDRV_DEVICE_TYPE_XXX */
185 int card; /* card number */
186 int device; /* device number */
187 const struct file_operations *f_ops; /* file operations */
188 void *private_data; /* private data for f_ops->open */
189 struct device *dev; /* device for sysfs */
190 struct snd_card *card_ptr; /* assigned card instance */
193 /* return a device pointer linked to each sound device as a parent */
194 static inline struct device *snd_card_get_device_link(struct snd_card *card)
196 return card ? &card->card_dev : NULL;
201 extern int snd_major;
202 extern int snd_ecards_limit;
203 extern struct class *sound_class;
205 void snd_request_card(int card);
207 int snd_register_device_for_dev(int type, struct snd_card *card,
209 const struct file_operations *f_ops,
212 struct device *device);
215 * snd_register_device - Register the ALSA device file for the card
216 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
217 * @card: the card instance
218 * @dev: the device index
219 * @f_ops: the file operations
220 * @private_data: user pointer for f_ops->open()
221 * @name: the device file name
223 * Registers an ALSA device file for the given card.
224 * The operators have to be set in reg parameter.
226 * This function uses the card's device pointer to link to the
227 * correct &struct device.
229 * Return: Zero if successful, or a negative error code on failure.
231 static inline int snd_register_device(int type, struct snd_card *card, int dev,
232 const struct file_operations *f_ops,
236 return snd_register_device_for_dev(type, card, dev, f_ops,
238 snd_card_get_device_link(card));
241 int snd_unregister_device(int type, struct snd_card *card, int dev);
242 void *snd_lookup_minor_data(unsigned int minor, int type);
243 struct device *snd_get_device(int type, struct snd_card *card, int dev);
245 #ifdef CONFIG_SND_OSSEMUL
246 int snd_register_oss_device(int type, struct snd_card *card, int dev,
247 const struct file_operations *f_ops, void *private_data);
248 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
249 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
252 int snd_minor_info_init(void);
253 int snd_minor_info_done(void);
257 #ifdef CONFIG_SND_OSSEMUL
258 int snd_minor_info_oss_init(void);
259 int snd_minor_info_oss_done(void);
261 static inline int snd_minor_info_oss_init(void) { return 0; }
262 static inline int snd_minor_info_oss_done(void) { return 0; }
267 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
268 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
272 extern struct snd_card *snd_cards[SNDRV_CARDS];
273 int snd_card_locked(int card);
274 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
275 #define SND_MIXER_OSS_NOTIFY_REGISTER 0
276 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
277 #define SND_MIXER_OSS_NOTIFY_FREE 2
278 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
281 int snd_card_new(struct device *parent, int idx, const char *xid,
282 struct module *module, int extra_size,
283 struct snd_card **card_ret);
285 int snd_card_disconnect(struct snd_card *card);
286 int snd_card_free(struct snd_card *card);
287 int snd_card_free_when_closed(struct snd_card *card);
288 void snd_card_set_id(struct snd_card *card, const char *id);
289 int snd_card_register(struct snd_card *card);
290 int snd_card_info_init(void);
291 int snd_card_info_done(void);
292 int snd_component_add(struct snd_card *card, const char *component);
293 int snd_card_file_add(struct snd_card *card, struct file *file);
294 int snd_card_file_remove(struct snd_card *card, struct file *file);
295 #define snd_card_unref(card) put_device(&(card)->card_dev)
297 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
301 int snd_device_new(struct snd_card *card, enum snd_device_type type,
302 void *device_data, struct snd_device_ops *ops);
303 int snd_device_register(struct snd_card *card, void *device_data);
304 int snd_device_register_all(struct snd_card *card);
305 int snd_device_disconnect_all(struct snd_card *card);
306 void snd_device_free(struct snd_card *card, void *device_data);
307 void snd_device_free_all(struct snd_card *card);
311 #ifdef CONFIG_ISA_DMA_API
312 #define DMA_MODE_NO_ENABLE 0x0100
314 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
315 void snd_dma_disable(unsigned long dma);
316 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
321 void release_and_free_resource(struct resource *res);
325 /* sound printk debug levels */
332 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
334 void __snd_printk(unsigned int level, const char *file, int line,
335 const char *format, ...);
337 #define __snd_printk(level, file, line, format, args...) \
338 printk(format, ##args)
342 * snd_printk - printk wrapper
343 * @fmt: format string
345 * Works like printk() but prints the file and the line of the caller
346 * when configured with CONFIG_SND_VERBOSE_PRINTK.
348 #define snd_printk(fmt, args...) \
349 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
351 #ifdef CONFIG_SND_DEBUG
353 * snd_printd - debug printk
354 * @fmt: format string
356 * Works like snd_printk() for debugging purposes.
357 * Ignored when CONFIG_SND_DEBUG is not set.
359 #define snd_printd(fmt, args...) \
360 __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
361 #define _snd_printd(level, fmt, args...) \
362 __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
365 * snd_BUG - give a BUG warning message and stack trace
367 * Calls WARN() if CONFIG_SND_DEBUG is set.
368 * Ignored when CONFIG_SND_DEBUG is not set.
370 #define snd_BUG() WARN(1, "BUG?\n")
373 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
375 #define snd_printd_ratelimit() printk_ratelimit()
378 * snd_BUG_ON - debugging check macro
379 * @cond: condition to evaluate
381 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
382 * otherwise just evaluates the conditional and returns the value.
384 #define snd_BUG_ON(cond) WARN_ON((cond))
386 #else /* !CONFIG_SND_DEBUG */
389 static inline void snd_printd(const char *format, ...) {}
391 static inline void _snd_printd(int level, const char *format, ...) {}
393 #define snd_BUG() do { } while (0)
395 #define snd_BUG_ON(condition) ({ \
396 int __ret_warn_on = !!(condition); \
397 unlikely(__ret_warn_on); \
400 static inline bool snd_printd_ratelimit(void) { return false; }
402 #endif /* CONFIG_SND_DEBUG */
404 #ifdef CONFIG_SND_DEBUG_VERBOSE
406 * snd_printdd - debug printk
407 * @format: format string
409 * Works like snd_printk() for debugging purposes.
410 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
412 #define snd_printdd(format, args...) \
413 __snd_printk(2, __FILE__, __LINE__, format, ##args)
416 static inline void snd_printdd(const char *format, ...) {}
420 #define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
422 /* for easier backward-porting */
423 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
424 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
425 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
426 #define gameport_get_port_data(gp) (gp)->port_data
429 /* PCI quirk list helper */
430 struct snd_pci_quirk {
431 unsigned short subvendor; /* PCI subvendor ID */
432 unsigned short subdevice; /* PCI subdevice ID */
433 unsigned short subdevice_mask; /* bitmask to match */
434 int value; /* value */
435 #ifdef CONFIG_SND_DEBUG_VERBOSE
436 const char *name; /* name of the device (optional) */
440 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
441 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
442 #define _SND_PCI_QUIRK_ID(vend, dev) \
443 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
444 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
445 #ifdef CONFIG_SND_DEBUG_VERBOSE
446 #define SND_PCI_QUIRK(vend,dev,xname,val) \
447 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
448 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
449 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
450 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
451 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
452 .value = (val), .name = (xname)}
453 #define snd_pci_quirk_name(q) ((q)->name)
455 #define SND_PCI_QUIRK(vend,dev,xname,val) \
456 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
457 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
458 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
459 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
460 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
461 #define snd_pci_quirk_name(q) ""
465 const struct snd_pci_quirk *
466 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
468 const struct snd_pci_quirk *
469 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
470 const struct snd_pci_quirk *list);
472 static inline const struct snd_pci_quirk *
473 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
478 static inline const struct snd_pci_quirk *
479 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
480 const struct snd_pci_quirk *list)
486 #endif /* __SOUND_CORE_H */