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 {
64 SNDRV_DEV_CONTROL, /* NOTE: this must be the last one */
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 irq_descr[32]; /* Interrupt description */
103 char mixername[80]; /* mixer name */
104 char components[128]; /* card components delimited with
106 struct module *module; /* top-level module */
108 void *private_data; /* private data for soundcard */
109 void (*private_free) (struct snd_card *card); /* callback for freeing of
111 struct list_head devices; /* devices */
113 struct device ctl_dev; /* control device */
114 unsigned int last_numid; /* last used numeric ID */
115 struct rw_semaphore controls_rwsem; /* controls list lock */
116 rwlock_t ctl_files_rwlock; /* ctl_files list lock */
117 int controls_count; /* count of all controls */
118 int user_ctl_count; /* count of all user controls */
119 struct list_head controls; /* all controls for this card */
120 struct list_head ctl_files; /* active control files */
122 struct snd_info_entry *proc_root; /* root for soundcard specific files */
123 struct proc_dir_entry *proc_root_link; /* number link to real id */
125 struct list_head files_list; /* all files associated to this card */
126 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
128 spinlock_t files_lock; /* lock the files for this card */
129 int shutdown; /* this card is going down */
130 struct completion *release_completion;
131 struct device *dev; /* device assigned to this card */
132 struct device card_dev; /* cardX object for sysfs */
133 const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
134 bool registered; /* card_dev is registered? */
135 wait_queue_head_t remove_sleep;
138 unsigned int power_state; /* power state */
139 wait_queue_head_t power_sleep;
142 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
143 struct snd_mixer_oss *mixer_oss;
144 int mixer_oss_change_count;
148 #define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
151 static inline unsigned int snd_power_get_state(struct snd_card *card)
153 return card->power_state;
156 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
158 card->power_state = state;
159 wake_up(&card->power_sleep);
163 int snd_power_wait(struct snd_card *card, unsigned int power_state);
165 #else /* ! CONFIG_PM */
167 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
168 #define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
169 #define snd_power_change_state(card, state) do { (void)(card); } while (0)
171 #endif /* CONFIG_PM */
174 int type; /* SNDRV_DEVICE_TYPE_XXX */
175 int card; /* card number */
176 int device; /* device number */
177 const struct file_operations *f_ops; /* file operations */
178 void *private_data; /* private data for f_ops->open */
179 struct device *dev; /* device for sysfs */
180 struct snd_card *card_ptr; /* assigned card instance */
183 /* return a device pointer linked to each sound device as a parent */
184 static inline struct device *snd_card_get_device_link(struct snd_card *card)
186 return card ? &card->card_dev : NULL;
191 extern int snd_major;
192 extern int snd_ecards_limit;
193 extern struct class *sound_class;
195 void snd_request_card(int card);
197 void snd_device_initialize(struct device *dev, struct snd_card *card);
199 int snd_register_device(int type, struct snd_card *card, int dev,
200 const struct file_operations *f_ops,
201 void *private_data, struct device *device);
202 int snd_unregister_device(struct device *dev);
203 void *snd_lookup_minor_data(unsigned int minor, int type);
205 #ifdef CONFIG_SND_OSSEMUL
206 int snd_register_oss_device(int type, struct snd_card *card, int dev,
207 const struct file_operations *f_ops, void *private_data);
208 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
209 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
212 int snd_minor_info_init(void);
216 #ifdef CONFIG_SND_OSSEMUL
217 int snd_minor_info_oss_init(void);
219 static inline int snd_minor_info_oss_init(void) { return 0; }
224 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
225 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
229 int snd_card_locked(int card);
230 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
231 #define SND_MIXER_OSS_NOTIFY_REGISTER 0
232 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
233 #define SND_MIXER_OSS_NOTIFY_FREE 2
234 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
237 int snd_card_new(struct device *parent, int idx, const char *xid,
238 struct module *module, int extra_size,
239 struct snd_card **card_ret);
241 int snd_card_disconnect(struct snd_card *card);
242 void snd_card_disconnect_sync(struct snd_card *card);
243 int snd_card_free(struct snd_card *card);
244 int snd_card_free_when_closed(struct snd_card *card);
245 void snd_card_set_id(struct snd_card *card, const char *id);
246 int snd_card_register(struct snd_card *card);
247 int snd_card_info_init(void);
248 int snd_card_add_dev_attr(struct snd_card *card,
249 const struct attribute_group *group);
250 int snd_component_add(struct snd_card *card, const char *component);
251 int snd_card_file_add(struct snd_card *card, struct file *file);
252 int snd_card_file_remove(struct snd_card *card, struct file *file);
254 struct snd_card *snd_card_ref(int card);
257 * snd_card_unref - Unreference the card object
258 * @card: the card object to unreference
260 * Call this function for the card object that was obtained via snd_card_ref()
261 * or snd_lookup_minor_data().
263 static inline void snd_card_unref(struct snd_card *card)
265 put_device(&card->card_dev);
268 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
272 int snd_device_new(struct snd_card *card, enum snd_device_type type,
273 void *device_data, struct snd_device_ops *ops);
274 int snd_device_register(struct snd_card *card, void *device_data);
275 int snd_device_register_all(struct snd_card *card);
276 void snd_device_disconnect(struct snd_card *card, void *device_data);
277 void snd_device_disconnect_all(struct snd_card *card);
278 void snd_device_free(struct snd_card *card, void *device_data);
279 void snd_device_free_all(struct snd_card *card);
283 #ifdef CONFIG_ISA_DMA_API
284 #define DMA_MODE_NO_ENABLE 0x0100
286 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
287 void snd_dma_disable(unsigned long dma);
288 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
293 void release_and_free_resource(struct resource *res);
297 /* sound printk debug levels */
304 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
306 void __snd_printk(unsigned int level, const char *file, int line,
307 const char *format, ...);
309 #define __snd_printk(level, file, line, format, ...) \
310 printk(format, ##__VA_ARGS__)
314 * snd_printk - printk wrapper
315 * @fmt: format string
317 * Works like printk() but prints the file and the line of the caller
318 * when configured with CONFIG_SND_VERBOSE_PRINTK.
320 #define snd_printk(fmt, ...) \
321 __snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
323 #ifdef CONFIG_SND_DEBUG
325 * snd_printd - debug printk
326 * @fmt: format string
328 * Works like snd_printk() for debugging purposes.
329 * Ignored when CONFIG_SND_DEBUG is not set.
331 #define snd_printd(fmt, ...) \
332 __snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
333 #define _snd_printd(level, fmt, ...) \
334 __snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
337 * snd_BUG - give a BUG warning message and stack trace
339 * Calls WARN() if CONFIG_SND_DEBUG is set.
340 * Ignored when CONFIG_SND_DEBUG is not set.
342 #define snd_BUG() WARN(1, "BUG?\n")
345 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
347 #define snd_printd_ratelimit() printk_ratelimit()
350 * snd_BUG_ON - debugging check macro
351 * @cond: condition to evaluate
353 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
354 * otherwise just evaluates the conditional and returns the value.
356 #define snd_BUG_ON(cond) WARN_ON((cond))
358 #else /* !CONFIG_SND_DEBUG */
361 static inline void snd_printd(const char *format, ...) {}
363 static inline void _snd_printd(int level, const char *format, ...) {}
365 #define snd_BUG() do { } while (0)
367 #define snd_BUG_ON(condition) ({ \
368 int __ret_warn_on = !!(condition); \
369 unlikely(__ret_warn_on); \
372 static inline bool snd_printd_ratelimit(void) { return false; }
374 #endif /* CONFIG_SND_DEBUG */
376 #ifdef CONFIG_SND_DEBUG_VERBOSE
378 * snd_printdd - debug printk
379 * @format: format string
381 * Works like snd_printk() for debugging purposes.
382 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
384 #define snd_printdd(format, ...) \
385 __snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
388 static inline void snd_printdd(const char *format, ...) {}
392 #define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
394 /* for easier backward-porting */
395 #if IS_ENABLED(CONFIG_GAMEPORT)
396 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
397 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
398 #define gameport_get_port_data(gp) (gp)->port_data
401 /* PCI quirk list helper */
402 struct snd_pci_quirk {
403 unsigned short subvendor; /* PCI subvendor ID */
404 unsigned short subdevice; /* PCI subdevice ID */
405 unsigned short subdevice_mask; /* bitmask to match */
406 int value; /* value */
407 #ifdef CONFIG_SND_DEBUG_VERBOSE
408 const char *name; /* name of the device (optional) */
412 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
413 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
414 #define _SND_PCI_QUIRK_ID(vend, dev) \
415 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
416 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
417 #ifdef CONFIG_SND_DEBUG_VERBOSE
418 #define SND_PCI_QUIRK(vend,dev,xname,val) \
419 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
420 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
421 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
422 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
423 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
424 .value = (val), .name = (xname)}
425 #define snd_pci_quirk_name(q) ((q)->name)
427 #define SND_PCI_QUIRK(vend,dev,xname,val) \
428 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
429 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
430 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
431 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
432 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
433 #define snd_pci_quirk_name(q) ""
437 const struct snd_pci_quirk *
438 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
440 const struct snd_pci_quirk *
441 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
442 const struct snd_pci_quirk *list);
444 static inline const struct snd_pci_quirk *
445 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
450 static inline const struct snd_pci_quirk *
451 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
452 const struct snd_pci_quirk *list)
458 #endif /* __SOUND_CORE_H */