Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2#ifndef __SOUND_CORE_H
3#define __SOUND_CORE_H
4
5/*
6 * Main header file for the ALSA driver
7 * Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
8 */
9
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>
17#include <linux/xarray.h>
18
19/* number of supported soundcards */
20#ifdef CONFIG_SND_DYNAMIC_MINORS
21#define SNDRV_CARDS CONFIG_SND_MAX_CARDS
22#else
23#define SNDRV_CARDS 8 /* don't change - minor numbers */
24#endif
25
26#define CONFIG_SND_MAJOR 116 /* standard configuration */
27
28/* forward declarations */
29struct pci_dev;
30struct module;
31struct completion;
32
33/* device allocation stuff */
34
35/* type of the object used in snd_device_*()
36 * this also defines the calling order
37 */
38enum snd_device_type {
39 SNDRV_DEV_LOWLEVEL,
40 SNDRV_DEV_INFO,
41 SNDRV_DEV_BUS,
42 SNDRV_DEV_CODEC,
43 SNDRV_DEV_PCM,
44 SNDRV_DEV_COMPRESS,
45 SNDRV_DEV_RAWMIDI,
46 SNDRV_DEV_TIMER,
47 SNDRV_DEV_SEQUENCER,
48 SNDRV_DEV_HWDEP,
49 SNDRV_DEV_JACK,
50 SNDRV_DEV_CONTROL, /* NOTE: this must be the last one */
51};
52
53enum snd_device_state {
54 SNDRV_DEV_BUILD,
55 SNDRV_DEV_REGISTERED,
56 SNDRV_DEV_DISCONNECTED,
57};
58
59struct snd_device;
60
61struct snd_device_ops {
62 int (*dev_free)(struct snd_device *dev);
63 int (*dev_register)(struct snd_device *dev);
64 int (*dev_disconnect)(struct snd_device *dev);
65};
66
67struct snd_device {
68 struct list_head list; /* list of registered devices */
69 struct snd_card *card; /* card which holds this device */
70 enum snd_device_state state; /* state of the device */
71 enum snd_device_type type; /* device type */
72 void *device_data; /* device structure */
73 const struct snd_device_ops *ops; /* operations */
74};
75
76#define snd_device(n) list_entry(n, struct snd_device, list)
77
78/* main structure for soundcard */
79
80struct snd_card {
81 int number; /* number of soundcard (index to
82 snd_cards) */
83
84 char id[16]; /* id string of this card */
85 char driver[16]; /* driver name */
86 char shortname[32]; /* short name of this soundcard */
87 char longname[80]; /* name of this soundcard */
88 char irq_descr[32]; /* Interrupt description */
89 char mixername[80]; /* mixer name */
90 char components[128]; /* card components delimited with
91 space */
92 struct module *module; /* top-level module */
93
94 void *private_data; /* private data for soundcard */
95 void (*private_free) (struct snd_card *card); /* callback for freeing of
96 private data */
97 struct list_head devices; /* devices */
98
99 struct device *ctl_dev; /* control device */
100 unsigned int last_numid; /* last used numeric ID */
101 struct rw_semaphore controls_rwsem; /* controls lock (list and values) */
102 rwlock_t controls_rwlock; /* lock for lookup and ctl_files list */
103 int controls_count; /* count of all controls */
104 size_t user_ctl_alloc_size; // current memory allocation by user controls.
105 struct list_head controls; /* all controls for this card */
106 struct list_head ctl_files; /* active control files */
107#ifdef CONFIG_SND_CTL_FAST_LOOKUP
108 struct xarray ctl_numids; /* hash table for numids */
109 struct xarray ctl_hash; /* hash table for ctl id matching */
110 bool ctl_hash_collision; /* ctl_hash collision seen? */
111#endif
112
113 struct snd_info_entry *proc_root; /* root for soundcard specific files */
114 struct proc_dir_entry *proc_root_link; /* number link to real id */
115
116 struct list_head files_list; /* all files associated to this card */
117 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
118 state */
119 spinlock_t files_lock; /* lock the files for this card */
120 int shutdown; /* this card is going down */
121 struct completion *release_completion;
122 struct device *dev; /* device assigned to this card */
123 struct device card_dev; /* cardX object for sysfs */
124 const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
125 bool registered; /* card_dev is registered? */
126 bool managed; /* managed via devres */
127 bool releasing; /* during card free process */
128 int sync_irq; /* assigned irq, used for PCM sync */
129 wait_queue_head_t remove_sleep;
130
131 size_t total_pcm_alloc_bytes; /* total amount of allocated buffers */
132 struct mutex memory_mutex; /* protection for the above */
133#ifdef CONFIG_SND_DEBUG
134 struct dentry *debugfs_root; /* debugfs root for card */
135#endif
136
137#ifdef CONFIG_PM
138 unsigned int power_state; /* power state */
139 atomic_t power_ref;
140 wait_queue_head_t power_sleep;
141 wait_queue_head_t power_ref_sleep;
142#endif
143
144#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
145 struct snd_mixer_oss *mixer_oss;
146 int mixer_oss_change_count;
147#endif
148};
149
150#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
151
152#ifdef CONFIG_PM
153static inline unsigned int snd_power_get_state(struct snd_card *card)
154{
155 return READ_ONCE(card->power_state);
156}
157
158static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
159{
160 WRITE_ONCE(card->power_state, state);
161 wake_up(&card->power_sleep);
162}
163
164/**
165 * snd_power_ref - Take the reference count for power control
166 * @card: sound card object
167 *
168 * The power_ref reference of the card is used for managing to block
169 * the snd_power_sync_ref() operation. This function increments the reference.
170 * The counterpart snd_power_unref() has to be called appropriately later.
171 */
172static inline void snd_power_ref(struct snd_card *card)
173{
174 atomic_inc(&card->power_ref);
175}
176
177/**
178 * snd_power_unref - Release the reference count for power control
179 * @card: sound card object
180 */
181static inline void snd_power_unref(struct snd_card *card)
182{
183 if (atomic_dec_and_test(&card->power_ref))
184 wake_up(&card->power_ref_sleep);
185}
186
187/**
188 * snd_power_sync_ref - wait until the card power_ref is freed
189 * @card: sound card object
190 *
191 * This function is used to synchronize with the pending power_ref being
192 * released.
193 */
194static inline void snd_power_sync_ref(struct snd_card *card)
195{
196 wait_event(card->power_ref_sleep, !atomic_read(&card->power_ref));
197}
198
199/* init.c */
200int snd_power_wait(struct snd_card *card);
201int snd_power_ref_and_wait(struct snd_card *card);
202
203#else /* ! CONFIG_PM */
204
205static inline int snd_power_wait(struct snd_card *card) { return 0; }
206static inline void snd_power_ref(struct snd_card *card) {}
207static inline void snd_power_unref(struct snd_card *card) {}
208static inline int snd_power_ref_and_wait(struct snd_card *card) { return 0; }
209static inline void snd_power_sync_ref(struct snd_card *card) {}
210#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
211#define snd_power_change_state(card, state) do { (void)(card); } while (0)
212
213#endif /* CONFIG_PM */
214
215struct snd_minor {
216 int type; /* SNDRV_DEVICE_TYPE_XXX */
217 int card; /* card number */
218 int device; /* device number */
219 const struct file_operations *f_ops; /* file operations */
220 void *private_data; /* private data for f_ops->open */
221 struct device *dev; /* device for sysfs */
222 struct snd_card *card_ptr; /* assigned card instance */
223};
224
225/* return a device pointer linked to each sound device as a parent */
226static inline struct device *snd_card_get_device_link(struct snd_card *card)
227{
228 return card ? &card->card_dev : NULL;
229}
230
231/* sound.c */
232
233extern int snd_major;
234extern int snd_ecards_limit;
235extern const struct class sound_class;
236#ifdef CONFIG_SND_DEBUG
237extern struct dentry *sound_debugfs_root;
238#endif
239
240void snd_request_card(int card);
241
242int snd_device_alloc(struct device **dev_p, struct snd_card *card);
243
244int snd_register_device(int type, struct snd_card *card, int dev,
245 const struct file_operations *f_ops,
246 void *private_data, struct device *device);
247int snd_unregister_device(struct device *dev);
248void *snd_lookup_minor_data(unsigned int minor, int type);
249
250#ifdef CONFIG_SND_OSSEMUL
251int snd_register_oss_device(int type, struct snd_card *card, int dev,
252 const struct file_operations *f_ops, void *private_data);
253int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
254void *snd_lookup_oss_minor_data(unsigned int minor, int type);
255#endif
256
257int snd_minor_info_init(void);
258
259/* sound_oss.c */
260
261#ifdef CONFIG_SND_OSSEMUL
262int snd_minor_info_oss_init(void);
263#else
264static inline int snd_minor_info_oss_init(void) { return 0; }
265#endif
266
267/* memory.c */
268
269int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
270int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
271
272/* init.c */
273
274int snd_card_locked(int card);
275#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
276#define SND_MIXER_OSS_NOTIFY_REGISTER 0
277#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
278#define SND_MIXER_OSS_NOTIFY_FREE 2
279extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
280#endif
281
282int snd_card_new(struct device *parent, int idx, const char *xid,
283 struct module *module, int extra_size,
284 struct snd_card **card_ret);
285int snd_devm_card_new(struct device *parent, int idx, const char *xid,
286 struct module *module, size_t extra_size,
287 struct snd_card **card_ret);
288
289void snd_card_disconnect(struct snd_card *card);
290void snd_card_disconnect_sync(struct snd_card *card);
291void snd_card_free(struct snd_card *card);
292void snd_card_free_when_closed(struct snd_card *card);
293int snd_card_free_on_error(struct device *dev, int ret);
294void snd_card_set_id(struct snd_card *card, const char *id);
295int snd_card_register(struct snd_card *card);
296int snd_card_info_init(void);
297int snd_card_add_dev_attr(struct snd_card *card,
298 const struct attribute_group *group);
299int snd_component_add(struct snd_card *card, const char *component);
300int snd_card_file_add(struct snd_card *card, struct file *file);
301int snd_card_file_remove(struct snd_card *card, struct file *file);
302
303struct snd_card *snd_card_ref(int card);
304
305/**
306 * snd_card_unref - Unreference the card object
307 * @card: the card object to unreference
308 *
309 * Call this function for the card object that was obtained via snd_card_ref()
310 * or snd_lookup_minor_data().
311 */
312static inline void snd_card_unref(struct snd_card *card)
313{
314 put_device(&card->card_dev);
315}
316
317#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
318
319/* device.c */
320
321int snd_device_new(struct snd_card *card, enum snd_device_type type,
322 void *device_data, const struct snd_device_ops *ops);
323int snd_device_register(struct snd_card *card, void *device_data);
324int snd_device_register_all(struct snd_card *card);
325void snd_device_disconnect(struct snd_card *card, void *device_data);
326void snd_device_disconnect_all(struct snd_card *card);
327void snd_device_free(struct snd_card *card, void *device_data);
328void snd_device_free_all(struct snd_card *card);
329int snd_device_get_state(struct snd_card *card, void *device_data);
330
331/* isadma.c */
332
333#ifdef CONFIG_ISA_DMA_API
334#define DMA_MODE_NO_ENABLE 0x0100
335
336void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
337void snd_dma_disable(unsigned long dma);
338unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
339int snd_devm_request_dma(struct device *dev, int dma, const char *name);
340#endif
341
342/* misc.c */
343struct resource;
344void release_and_free_resource(struct resource *res);
345
346/* --- */
347
348#ifdef CONFIG_SND_DEBUG
349/**
350 * snd_BUG - give a BUG warning message and stack trace
351 *
352 * Calls WARN() if CONFIG_SND_DEBUG is set.
353 * Ignored when CONFIG_SND_DEBUG is not set.
354 */
355#define snd_BUG() WARN(1, "BUG?\n")
356
357/**
358 * snd_BUG_ON - debugging check macro
359 * @cond: condition to evaluate
360 *
361 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
362 * otherwise just evaluates the conditional and returns the value.
363 */
364#define snd_BUG_ON(cond) WARN_ON((cond))
365
366#else /* !CONFIG_SND_DEBUG */
367
368#define snd_BUG() do { } while (0)
369
370#define snd_BUG_ON(condition) ({ \
371 int __ret_warn_on = !!(condition); \
372 unlikely(__ret_warn_on); \
373})
374
375#endif /* CONFIG_SND_DEBUG */
376
377#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
378
379/* for easier backward-porting */
380#if IS_ENABLED(CONFIG_GAMEPORT)
381#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
382#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
383#define gameport_get_port_data(gp) (gp)->port_data
384#endif
385
386/* PCI quirk list helper */
387struct snd_pci_quirk {
388 unsigned short subvendor; /* PCI subvendor ID */
389 unsigned short subdevice; /* PCI subdevice ID */
390 unsigned short subdevice_mask; /* bitmask to match */
391 int value; /* value */
392#ifdef CONFIG_SND_DEBUG_VERBOSE
393 const char *name; /* name of the device (optional) */
394#endif
395};
396
397#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
398 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
399#define _SND_PCI_QUIRK_ID(vend, dev) \
400 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
401#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
402#ifdef CONFIG_SND_DEBUG_VERBOSE
403#define SND_PCI_QUIRK(vend,dev,xname,val) \
404 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
405#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
406 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
407#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
408 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
409 .value = (val), .name = (xname)}
410#define snd_pci_quirk_name(q) ((q)->name)
411#else
412#define SND_PCI_QUIRK(vend,dev,xname,val) \
413 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
414#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
415 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
416#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
417 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
418#define snd_pci_quirk_name(q) ""
419#endif
420
421#ifdef CONFIG_PCI
422const struct snd_pci_quirk *
423snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
424
425const struct snd_pci_quirk *
426snd_pci_quirk_lookup_id(u16 vendor, u16 device,
427 const struct snd_pci_quirk *list);
428#else
429static inline const struct snd_pci_quirk *
430snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
431{
432 return NULL;
433}
434
435static inline const struct snd_pci_quirk *
436snd_pci_quirk_lookup_id(u16 vendor, u16 device,
437 const struct snd_pci_quirk *list)
438{
439 return NULL;
440}
441#endif
442
443/* async signal helpers */
444struct snd_fasync;
445
446int snd_fasync_helper(int fd, struct file *file, int on,
447 struct snd_fasync **fasyncp);
448void snd_kill_fasync(struct snd_fasync *fasync, int signal, int poll);
449void snd_fasync_free(struct snd_fasync *fasync);
450
451#endif /* __SOUND_CORE_H */
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/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>
32
33/* number of supported soundcards */
34#ifdef CONFIG_SND_DYNAMIC_MINORS
35#define SNDRV_CARDS CONFIG_SND_MAX_CARDS
36#else
37#define SNDRV_CARDS 8 /* don't change - minor numbers */
38#endif
39
40#define CONFIG_SND_MAJOR 116 /* standard configuration */
41
42/* forward declarations */
43struct pci_dev;
44struct module;
45struct completion;
46
47/* device allocation stuff */
48
49/* type of the object used in snd_device_*()
50 * this also defines the calling order
51 */
52enum snd_device_type {
53 SNDRV_DEV_LOWLEVEL,
54 SNDRV_DEV_CONTROL,
55 SNDRV_DEV_INFO,
56 SNDRV_DEV_BUS,
57 SNDRV_DEV_CODEC,
58 SNDRV_DEV_PCM,
59 SNDRV_DEV_COMPRESS,
60 SNDRV_DEV_RAWMIDI,
61 SNDRV_DEV_TIMER,
62 SNDRV_DEV_SEQUENCER,
63 SNDRV_DEV_HWDEP,
64 SNDRV_DEV_JACK,
65};
66
67enum snd_device_state {
68 SNDRV_DEV_BUILD,
69 SNDRV_DEV_REGISTERED,
70 SNDRV_DEV_DISCONNECTED,
71};
72
73struct snd_device;
74
75struct 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);
79};
80
81struct snd_device {
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 */
88};
89
90#define snd_device(n) list_entry(n, struct snd_device, list)
91
92/* main structure for soundcard */
93
94struct snd_card {
95 int number; /* number of soundcard (index to
96 snd_cards) */
97
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
105 space */
106 struct module *module; /* top-level module */
107
108 void *private_data; /* private data for soundcard */
109 void (*private_free) (struct snd_card *card); /* callback for freeing of
110 private data */
111 struct list_head devices; /* devices */
112
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 */
121 struct mutex user_ctl_lock; /* protects user controls against
122 concurrent access */
123
124 struct snd_info_entry *proc_root; /* root for soundcard specific files */
125 struct snd_info_entry *proc_id; /* the card id */
126 struct proc_dir_entry *proc_root_link; /* number link to real id */
127
128 struct list_head files_list; /* all files associated to this card */
129 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
130 state */
131 spinlock_t files_lock; /* lock the files for this card */
132 int shutdown; /* this card is going down */
133 struct completion *release_completion;
134 struct device *dev; /* device assigned to this card */
135 struct device card_dev; /* cardX object for sysfs */
136 const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
137 bool registered; /* card_dev is registered? */
138
139#ifdef CONFIG_PM
140 unsigned int power_state; /* power state */
141 struct mutex power_lock; /* power lock */
142 wait_queue_head_t power_sleep;
143#endif
144
145#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
146 struct snd_mixer_oss *mixer_oss;
147 int mixer_oss_change_count;
148#endif
149};
150
151#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
152
153#ifdef CONFIG_PM
154static inline void snd_power_lock(struct snd_card *card)
155{
156 mutex_lock(&card->power_lock);
157}
158
159static inline void snd_power_unlock(struct snd_card *card)
160{
161 mutex_unlock(&card->power_lock);
162}
163
164static inline unsigned int snd_power_get_state(struct snd_card *card)
165{
166 return card->power_state;
167}
168
169static 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 */
176int 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)
182static 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
188struct 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 */
199static 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
206extern int snd_major;
207extern int snd_ecards_limit;
208extern struct class *sound_class;
209
210void snd_request_card(int card);
211
212void snd_device_initialize(struct device *dev, struct snd_card *card);
213
214int snd_register_device(int type, struct snd_card *card, int dev,
215 const struct file_operations *f_ops,
216 void *private_data, struct device *device);
217int snd_unregister_device(struct device *dev);
218void *snd_lookup_minor_data(unsigned int minor, int type);
219
220#ifdef CONFIG_SND_OSSEMUL
221int snd_register_oss_device(int type, struct snd_card *card, int dev,
222 const struct file_operations *f_ops, void *private_data);
223int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
224void *snd_lookup_oss_minor_data(unsigned int minor, int type);
225#endif
226
227int snd_minor_info_init(void);
228
229/* sound_oss.c */
230
231#ifdef CONFIG_SND_OSSEMUL
232int snd_minor_info_oss_init(void);
233#else
234static inline int snd_minor_info_oss_init(void) { return 0; }
235#endif
236
237/* memory.c */
238
239int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
240int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
241
242/* init.c */
243
244extern struct snd_card *snd_cards[SNDRV_CARDS];
245int snd_card_locked(int card);
246#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
247#define SND_MIXER_OSS_NOTIFY_REGISTER 0
248#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
249#define SND_MIXER_OSS_NOTIFY_FREE 2
250extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
251#endif
252
253int snd_card_new(struct device *parent, int idx, const char *xid,
254 struct module *module, int extra_size,
255 struct snd_card **card_ret);
256
257int snd_card_disconnect(struct snd_card *card);
258int snd_card_free(struct snd_card *card);
259int snd_card_free_when_closed(struct snd_card *card);
260void snd_card_set_id(struct snd_card *card, const char *id);
261int snd_card_register(struct snd_card *card);
262int snd_card_info_init(void);
263int snd_card_add_dev_attr(struct snd_card *card,
264 const struct attribute_group *group);
265int snd_component_add(struct snd_card *card, const char *component);
266int snd_card_file_add(struct snd_card *card, struct file *file);
267int snd_card_file_remove(struct snd_card *card, struct file *file);
268#define snd_card_unref(card) put_device(&(card)->card_dev)
269
270#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
271
272/* device.c */
273
274int snd_device_new(struct snd_card *card, enum snd_device_type type,
275 void *device_data, struct snd_device_ops *ops);
276int snd_device_register(struct snd_card *card, void *device_data);
277int snd_device_register_all(struct snd_card *card);
278void snd_device_disconnect(struct snd_card *card, void *device_data);
279void snd_device_disconnect_all(struct snd_card *card);
280void snd_device_free(struct snd_card *card, void *device_data);
281void snd_device_free_all(struct snd_card *card);
282
283/* isadma.c */
284
285#ifdef CONFIG_ISA_DMA_API
286#define DMA_MODE_NO_ENABLE 0x0100
287
288void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
289void snd_dma_disable(unsigned long dma);
290unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
291#endif
292
293/* misc.c */
294struct resource;
295void release_and_free_resource(struct resource *res);
296
297/* --- */
298
299/* sound printk debug levels */
300enum {
301 SND_PR_ALWAYS,
302 SND_PR_DEBUG,
303 SND_PR_VERBOSE,
304};
305
306#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
307__printf(4, 5)
308void __snd_printk(unsigned int level, const char *file, int line,
309 const char *format, ...);
310#else
311#define __snd_printk(level, file, line, format, args...) \
312 printk(format, ##args)
313#endif
314
315/**
316 * snd_printk - printk wrapper
317 * @fmt: format string
318 *
319 * Works like printk() but prints the file and the line of the caller
320 * when configured with CONFIG_SND_VERBOSE_PRINTK.
321 */
322#define snd_printk(fmt, args...) \
323 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
324
325#ifdef CONFIG_SND_DEBUG
326/**
327 * snd_printd - debug printk
328 * @fmt: format string
329 *
330 * Works like snd_printk() for debugging purposes.
331 * Ignored when CONFIG_SND_DEBUG is not set.
332 */
333#define snd_printd(fmt, args...) \
334 __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
335#define _snd_printd(level, fmt, args...) \
336 __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
337
338/**
339 * snd_BUG - give a BUG warning message and stack trace
340 *
341 * Calls WARN() if CONFIG_SND_DEBUG is set.
342 * Ignored when CONFIG_SND_DEBUG is not set.
343 */
344#define snd_BUG() WARN(1, "BUG?\n")
345
346/**
347 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
348 */
349#define snd_printd_ratelimit() printk_ratelimit()
350
351/**
352 * snd_BUG_ON - debugging check macro
353 * @cond: condition to evaluate
354 *
355 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
356 * otherwise just evaluates the conditional and returns the value.
357 */
358#define snd_BUG_ON(cond) WARN_ON((cond))
359
360#else /* !CONFIG_SND_DEBUG */
361
362__printf(1, 2)
363static inline void snd_printd(const char *format, ...) {}
364__printf(2, 3)
365static inline void _snd_printd(int level, const char *format, ...) {}
366
367#define snd_BUG() do { } while (0)
368
369#define snd_BUG_ON(condition) ({ \
370 int __ret_warn_on = !!(condition); \
371 unlikely(__ret_warn_on); \
372})
373
374static inline bool snd_printd_ratelimit(void) { return false; }
375
376#endif /* CONFIG_SND_DEBUG */
377
378#ifdef CONFIG_SND_DEBUG_VERBOSE
379/**
380 * snd_printdd - debug printk
381 * @format: format string
382 *
383 * Works like snd_printk() for debugging purposes.
384 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
385 */
386#define snd_printdd(format, args...) \
387 __snd_printk(2, __FILE__, __LINE__, format, ##args)
388#else
389__printf(1, 2)
390static inline void snd_printdd(const char *format, ...) {}
391#endif
392
393
394#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
395
396/* for easier backward-porting */
397#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
398#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
399#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
400#define gameport_get_port_data(gp) (gp)->port_data
401#endif
402
403/* PCI quirk list helper */
404struct snd_pci_quirk {
405 unsigned short subvendor; /* PCI subvendor ID */
406 unsigned short subdevice; /* PCI subdevice ID */
407 unsigned short subdevice_mask; /* bitmask to match */
408 int value; /* value */
409#ifdef CONFIG_SND_DEBUG_VERBOSE
410 const char *name; /* name of the device (optional) */
411#endif
412};
413
414#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
415 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
416#define _SND_PCI_QUIRK_ID(vend, dev) \
417 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
418#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
419#ifdef CONFIG_SND_DEBUG_VERBOSE
420#define SND_PCI_QUIRK(vend,dev,xname,val) \
421 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
422#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
423 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
424#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
425 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
426 .value = (val), .name = (xname)}
427#define snd_pci_quirk_name(q) ((q)->name)
428#else
429#define SND_PCI_QUIRK(vend,dev,xname,val) \
430 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
431#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
432 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
433#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
434 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
435#define snd_pci_quirk_name(q) ""
436#endif
437
438#ifdef CONFIG_PCI
439const struct snd_pci_quirk *
440snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
441
442const struct snd_pci_quirk *
443snd_pci_quirk_lookup_id(u16 vendor, u16 device,
444 const struct snd_pci_quirk *list);
445#else
446static inline const struct snd_pci_quirk *
447snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
448{
449 return NULL;
450}
451
452static inline const struct snd_pci_quirk *
453snd_pci_quirk_lookup_id(u16 vendor, u16 device,
454 const struct snd_pci_quirk *list)
455{
456 return NULL;
457}
458#endif
459
460#endif /* __SOUND_CORE_H */