1 /* SPDX-License-Identifier: GPL-2.0-or-later */
6 * Main header file for the ALSA driver
7 * Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
10 #include <linux/device.h>
11 #include <linux/sched.h> /* wake_up() */
12 #include <linux/mutex.h> /* struct mutex */
13 #include <linux/rwsem.h> /* struct rw_semaphore */
14 #include <linux/pm.h> /* pm_message_t */
15 #include <linux/stringify.h>
16 #include <linux/printk.h>
18 /* number of supported soundcards */
19 #ifdef CONFIG_SND_DYNAMIC_MINORS
20 #define SNDRV_CARDS CONFIG_SND_MAX_CARDS
22 #define SNDRV_CARDS 8 /* don't change - minor numbers */
25 #define CONFIG_SND_MAJOR 116 /* standard configuration */
27 /* forward declarations */
32 /* device allocation stuff */
34 /* type of the object used in snd_device_*()
35 * this also defines the calling order
37 enum snd_device_type {
49 SNDRV_DEV_CONTROL, /* NOTE: this must be the last one */
52 enum snd_device_state {
55 SNDRV_DEV_DISCONNECTED,
60 struct snd_device_ops {
61 int (*dev_free)(struct snd_device *dev);
62 int (*dev_register)(struct snd_device *dev);
63 int (*dev_disconnect)(struct snd_device *dev);
67 struct list_head list; /* list of registered devices */
68 struct snd_card *card; /* card which holds this device */
69 enum snd_device_state state; /* state of the device */
70 enum snd_device_type type; /* device type */
71 void *device_data; /* device structure */
72 struct snd_device_ops *ops; /* operations */
75 #define snd_device(n) list_entry(n, struct snd_device, list)
77 /* main structure for soundcard */
80 int number; /* number of soundcard (index to
83 char id[16]; /* id string of this card */
84 char driver[16]; /* driver name */
85 char shortname[32]; /* short name of this soundcard */
86 char longname[80]; /* name of this soundcard */
87 char irq_descr[32]; /* Interrupt description */
88 char mixername[80]; /* mixer name */
89 char components[128]; /* card components delimited with
91 struct module *module; /* top-level module */
93 void *private_data; /* private data for soundcard */
94 void (*private_free) (struct snd_card *card); /* callback for freeing of
96 struct list_head devices; /* devices */
98 struct device ctl_dev; /* control device */
99 unsigned int last_numid; /* last used numeric ID */
100 struct rw_semaphore controls_rwsem; /* controls list lock */
101 rwlock_t ctl_files_rwlock; /* ctl_files list lock */
102 int controls_count; /* count of all controls */
103 int user_ctl_count; /* count of all user controls */
104 struct list_head controls; /* all controls for this card */
105 struct list_head ctl_files; /* active control files */
107 struct snd_info_entry *proc_root; /* root for soundcard specific files */
108 struct proc_dir_entry *proc_root_link; /* number link to real id */
110 struct list_head files_list; /* all files associated to this card */
111 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
113 spinlock_t files_lock; /* lock the files for this card */
114 int shutdown; /* this card is going down */
115 struct completion *release_completion;
116 struct device *dev; /* device assigned to this card */
117 struct device card_dev; /* cardX object for sysfs */
118 const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
119 bool registered; /* card_dev is registered? */
120 wait_queue_head_t remove_sleep;
122 size_t total_pcm_alloc_bytes; /* total amount of allocated buffers */
123 struct mutex memory_mutex; /* protection for the above */
126 unsigned int power_state; /* power state */
127 wait_queue_head_t power_sleep;
130 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
131 struct snd_mixer_oss *mixer_oss;
132 int mixer_oss_change_count;
136 #define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
139 static inline unsigned int snd_power_get_state(struct snd_card *card)
141 return card->power_state;
144 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
146 card->power_state = state;
147 wake_up(&card->power_sleep);
151 int snd_power_wait(struct snd_card *card, unsigned int power_state);
153 #else /* ! CONFIG_PM */
155 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
156 #define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
157 #define snd_power_change_state(card, state) do { (void)(card); } while (0)
159 #endif /* CONFIG_PM */
162 int type; /* SNDRV_DEVICE_TYPE_XXX */
163 int card; /* card number */
164 int device; /* device number */
165 const struct file_operations *f_ops; /* file operations */
166 void *private_data; /* private data for f_ops->open */
167 struct device *dev; /* device for sysfs */
168 struct snd_card *card_ptr; /* assigned card instance */
171 /* return a device pointer linked to each sound device as a parent */
172 static inline struct device *snd_card_get_device_link(struct snd_card *card)
174 return card ? &card->card_dev : NULL;
179 extern int snd_major;
180 extern int snd_ecards_limit;
181 extern struct class *sound_class;
183 void snd_request_card(int card);
185 void snd_device_initialize(struct device *dev, struct snd_card *card);
187 int snd_register_device(int type, struct snd_card *card, int dev,
188 const struct file_operations *f_ops,
189 void *private_data, struct device *device);
190 int snd_unregister_device(struct device *dev);
191 void *snd_lookup_minor_data(unsigned int minor, int type);
193 #ifdef CONFIG_SND_OSSEMUL
194 int snd_register_oss_device(int type, struct snd_card *card, int dev,
195 const struct file_operations *f_ops, void *private_data);
196 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
197 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
200 int snd_minor_info_init(void);
204 #ifdef CONFIG_SND_OSSEMUL
205 int snd_minor_info_oss_init(void);
207 static inline int snd_minor_info_oss_init(void) { return 0; }
212 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
213 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
217 int snd_card_locked(int card);
218 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
219 #define SND_MIXER_OSS_NOTIFY_REGISTER 0
220 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
221 #define SND_MIXER_OSS_NOTIFY_FREE 2
222 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
225 int snd_card_new(struct device *parent, int idx, const char *xid,
226 struct module *module, int extra_size,
227 struct snd_card **card_ret);
229 int snd_card_disconnect(struct snd_card *card);
230 void snd_card_disconnect_sync(struct snd_card *card);
231 int snd_card_free(struct snd_card *card);
232 int snd_card_free_when_closed(struct snd_card *card);
233 void snd_card_set_id(struct snd_card *card, const char *id);
234 int snd_card_register(struct snd_card *card);
235 int snd_card_info_init(void);
236 int snd_card_add_dev_attr(struct snd_card *card,
237 const struct attribute_group *group);
238 int snd_component_add(struct snd_card *card, const char *component);
239 int snd_card_file_add(struct snd_card *card, struct file *file);
240 int snd_card_file_remove(struct snd_card *card, struct file *file);
242 struct snd_card *snd_card_ref(int card);
245 * snd_card_unref - Unreference the card object
246 * @card: the card object to unreference
248 * Call this function for the card object that was obtained via snd_card_ref()
249 * or snd_lookup_minor_data().
251 static inline void snd_card_unref(struct snd_card *card)
253 put_device(&card->card_dev);
256 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
260 int snd_device_new(struct snd_card *card, enum snd_device_type type,
261 void *device_data, struct snd_device_ops *ops);
262 int snd_device_register(struct snd_card *card, void *device_data);
263 int snd_device_register_all(struct snd_card *card);
264 void snd_device_disconnect(struct snd_card *card, void *device_data);
265 void snd_device_disconnect_all(struct snd_card *card);
266 void snd_device_free(struct snd_card *card, void *device_data);
267 void snd_device_free_all(struct snd_card *card);
271 #ifdef CONFIG_ISA_DMA_API
272 #define DMA_MODE_NO_ENABLE 0x0100
274 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
275 void snd_dma_disable(unsigned long dma);
276 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
281 void release_and_free_resource(struct resource *res);
285 /* sound printk debug levels */
292 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
294 void __snd_printk(unsigned int level, const char *file, int line,
295 const char *format, ...);
297 #define __snd_printk(level, file, line, format, ...) \
298 printk(format, ##__VA_ARGS__)
302 * snd_printk - printk wrapper
303 * @fmt: format string
305 * Works like printk() but prints the file and the line of the caller
306 * when configured with CONFIG_SND_VERBOSE_PRINTK.
308 #define snd_printk(fmt, ...) \
309 __snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
311 #ifdef CONFIG_SND_DEBUG
313 * snd_printd - debug printk
314 * @fmt: format string
316 * Works like snd_printk() for debugging purposes.
317 * Ignored when CONFIG_SND_DEBUG is not set.
319 #define snd_printd(fmt, ...) \
320 __snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
321 #define _snd_printd(level, fmt, ...) \
322 __snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
325 * snd_BUG - give a BUG warning message and stack trace
327 * Calls WARN() if CONFIG_SND_DEBUG is set.
328 * Ignored when CONFIG_SND_DEBUG is not set.
330 #define snd_BUG() WARN(1, "BUG?\n")
333 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
335 #define snd_printd_ratelimit() printk_ratelimit()
338 * snd_BUG_ON - debugging check macro
339 * @cond: condition to evaluate
341 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
342 * otherwise just evaluates the conditional and returns the value.
344 #define snd_BUG_ON(cond) WARN_ON((cond))
346 #else /* !CONFIG_SND_DEBUG */
349 static inline void snd_printd(const char *format, ...) {}
351 static inline void _snd_printd(int level, const char *format, ...) {}
353 #define snd_BUG() do { } while (0)
355 #define snd_BUG_ON(condition) ({ \
356 int __ret_warn_on = !!(condition); \
357 unlikely(__ret_warn_on); \
360 static inline bool snd_printd_ratelimit(void) { return false; }
362 #endif /* CONFIG_SND_DEBUG */
364 #ifdef CONFIG_SND_DEBUG_VERBOSE
366 * snd_printdd - debug printk
367 * @format: format string
369 * Works like snd_printk() for debugging purposes.
370 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
372 #define snd_printdd(format, ...) \
373 __snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
376 static inline void snd_printdd(const char *format, ...) {}
380 #define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
382 /* for easier backward-porting */
383 #if IS_ENABLED(CONFIG_GAMEPORT)
384 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
385 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
386 #define gameport_get_port_data(gp) (gp)->port_data
389 /* PCI quirk list helper */
390 struct snd_pci_quirk {
391 unsigned short subvendor; /* PCI subvendor ID */
392 unsigned short subdevice; /* PCI subdevice ID */
393 unsigned short subdevice_mask; /* bitmask to match */
394 int value; /* value */
395 #ifdef CONFIG_SND_DEBUG_VERBOSE
396 const char *name; /* name of the device (optional) */
400 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
401 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
402 #define _SND_PCI_QUIRK_ID(vend, dev) \
403 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
404 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
405 #ifdef CONFIG_SND_DEBUG_VERBOSE
406 #define SND_PCI_QUIRK(vend,dev,xname,val) \
407 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
408 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
409 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
410 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
411 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
412 .value = (val), .name = (xname)}
413 #define snd_pci_quirk_name(q) ((q)->name)
415 #define SND_PCI_QUIRK(vend,dev,xname,val) \
416 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
417 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
418 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
419 #define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
420 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
421 #define snd_pci_quirk_name(q) ""
425 const struct snd_pci_quirk *
426 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
428 const struct snd_pci_quirk *
429 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
430 const struct snd_pci_quirk *list);
432 static inline const struct snd_pci_quirk *
433 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
438 static inline const struct snd_pci_quirk *
439 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
440 const struct snd_pci_quirk *list)
446 /* async signal helpers */
449 int snd_fasync_helper(int fd, struct file *file, int on,
450 struct snd_fasync **fasyncp);
451 void snd_kill_fasync(struct snd_fasync *fasync, int signal, int poll);
452 void snd_fasync_free(struct snd_fasync *fasync);
454 #endif /* __SOUND_CORE_H */