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
18/* number of supported soundcards */
19#ifdef CONFIG_SND_DYNAMIC_MINORS
20#define SNDRV_CARDS CONFIG_SND_MAX_CARDS
21#else
22#define SNDRV_CARDS 8 /* don't change - minor numbers */
23#endif
24
25#define CONFIG_SND_MAJOR 116 /* standard configuration */
26
27/* forward declarations */
28struct pci_dev;
29struct module;
30struct completion;
31
32/* device allocation stuff */
33
34/* type of the object used in snd_device_*()
35 * this also defines the calling order
36 */
37enum snd_device_type {
38 SNDRV_DEV_LOWLEVEL,
39 SNDRV_DEV_INFO,
40 SNDRV_DEV_BUS,
41 SNDRV_DEV_CODEC,
42 SNDRV_DEV_PCM,
43 SNDRV_DEV_COMPRESS,
44 SNDRV_DEV_RAWMIDI,
45 SNDRV_DEV_TIMER,
46 SNDRV_DEV_SEQUENCER,
47 SNDRV_DEV_HWDEP,
48 SNDRV_DEV_JACK,
49 SNDRV_DEV_CONTROL, /* NOTE: this must be the last one */
50};
51
52enum snd_device_state {
53 SNDRV_DEV_BUILD,
54 SNDRV_DEV_REGISTERED,
55 SNDRV_DEV_DISCONNECTED,
56};
57
58struct snd_device;
59
60struct 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);
64};
65
66struct snd_device {
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 */
73};
74
75#define snd_device(n) list_entry(n, struct snd_device, list)
76
77/* main structure for soundcard */
78
79struct snd_card {
80 int number; /* number of soundcard (index to
81 snd_cards) */
82
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
90 space */
91 struct module *module; /* top-level module */
92
93 void *private_data; /* private data for soundcard */
94 void (*private_free) (struct snd_card *card); /* callback for freeing of
95 private data */
96 struct list_head devices; /* devices */
97
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 */
106
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 */
109
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
112 state */
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;
121
122#ifdef CONFIG_PM
123 unsigned int power_state; /* power state */
124 wait_queue_head_t power_sleep;
125#endif
126
127#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
128 struct snd_mixer_oss *mixer_oss;
129 int mixer_oss_change_count;
130#endif
131};
132
133#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
134
135#ifdef CONFIG_PM
136static inline unsigned int snd_power_get_state(struct snd_card *card)
137{
138 return card->power_state;
139}
140
141static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
142{
143 card->power_state = state;
144 wake_up(&card->power_sleep);
145}
146
147/* init.c */
148int snd_power_wait(struct snd_card *card, unsigned int power_state);
149
150#else /* ! CONFIG_PM */
151
152static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
153#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
154#define snd_power_change_state(card, state) do { (void)(card); } while (0)
155
156#endif /* CONFIG_PM */
157
158struct snd_minor {
159 int type; /* SNDRV_DEVICE_TYPE_XXX */
160 int card; /* card number */
161 int device; /* device number */
162 const struct file_operations *f_ops; /* file operations */
163 void *private_data; /* private data for f_ops->open */
164 struct device *dev; /* device for sysfs */
165 struct snd_card *card_ptr; /* assigned card instance */
166};
167
168/* return a device pointer linked to each sound device as a parent */
169static inline struct device *snd_card_get_device_link(struct snd_card *card)
170{
171 return card ? &card->card_dev : NULL;
172}
173
174/* sound.c */
175
176extern int snd_major;
177extern int snd_ecards_limit;
178extern struct class *sound_class;
179
180void snd_request_card(int card);
181
182void snd_device_initialize(struct device *dev, struct snd_card *card);
183
184int snd_register_device(int type, struct snd_card *card, int dev,
185 const struct file_operations *f_ops,
186 void *private_data, struct device *device);
187int snd_unregister_device(struct device *dev);
188void *snd_lookup_minor_data(unsigned int minor, int type);
189
190#ifdef CONFIG_SND_OSSEMUL
191int snd_register_oss_device(int type, struct snd_card *card, int dev,
192 const struct file_operations *f_ops, void *private_data);
193int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
194void *snd_lookup_oss_minor_data(unsigned int minor, int type);
195#endif
196
197int snd_minor_info_init(void);
198
199/* sound_oss.c */
200
201#ifdef CONFIG_SND_OSSEMUL
202int snd_minor_info_oss_init(void);
203#else
204static inline int snd_minor_info_oss_init(void) { return 0; }
205#endif
206
207/* memory.c */
208
209int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
210int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
211
212/* init.c */
213
214int snd_card_locked(int card);
215#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
216#define SND_MIXER_OSS_NOTIFY_REGISTER 0
217#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
218#define SND_MIXER_OSS_NOTIFY_FREE 2
219extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
220#endif
221
222int snd_card_new(struct device *parent, int idx, const char *xid,
223 struct module *module, int extra_size,
224 struct snd_card **card_ret);
225
226int snd_card_disconnect(struct snd_card *card);
227void snd_card_disconnect_sync(struct snd_card *card);
228int snd_card_free(struct snd_card *card);
229int snd_card_free_when_closed(struct snd_card *card);
230void snd_card_set_id(struct snd_card *card, const char *id);
231int snd_card_register(struct snd_card *card);
232int snd_card_info_init(void);
233int snd_card_add_dev_attr(struct snd_card *card,
234 const struct attribute_group *group);
235int snd_component_add(struct snd_card *card, const char *component);
236int snd_card_file_add(struct snd_card *card, struct file *file);
237int snd_card_file_remove(struct snd_card *card, struct file *file);
238
239struct snd_card *snd_card_ref(int card);
240
241/**
242 * snd_card_unref - Unreference the card object
243 * @card: the card object to unreference
244 *
245 * Call this function for the card object that was obtained via snd_card_ref()
246 * or snd_lookup_minor_data().
247 */
248static inline void snd_card_unref(struct snd_card *card)
249{
250 put_device(&card->card_dev);
251}
252
253#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
254
255/* device.c */
256
257int snd_device_new(struct snd_card *card, enum snd_device_type type,
258 void *device_data, struct snd_device_ops *ops);
259int snd_device_register(struct snd_card *card, void *device_data);
260int snd_device_register_all(struct snd_card *card);
261void snd_device_disconnect(struct snd_card *card, void *device_data);
262void snd_device_disconnect_all(struct snd_card *card);
263void snd_device_free(struct snd_card *card, void *device_data);
264void snd_device_free_all(struct snd_card *card);
265
266/* isadma.c */
267
268#ifdef CONFIG_ISA_DMA_API
269#define DMA_MODE_NO_ENABLE 0x0100
270
271void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
272void snd_dma_disable(unsigned long dma);
273unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
274#endif
275
276/* misc.c */
277struct resource;
278void release_and_free_resource(struct resource *res);
279
280/* --- */
281
282/* sound printk debug levels */
283enum {
284 SND_PR_ALWAYS,
285 SND_PR_DEBUG,
286 SND_PR_VERBOSE,
287};
288
289#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
290__printf(4, 5)
291void __snd_printk(unsigned int level, const char *file, int line,
292 const char *format, ...);
293#else
294#define __snd_printk(level, file, line, format, ...) \
295 printk(format, ##__VA_ARGS__)
296#endif
297
298/**
299 * snd_printk - printk wrapper
300 * @fmt: format string
301 *
302 * Works like printk() but prints the file and the line of the caller
303 * when configured with CONFIG_SND_VERBOSE_PRINTK.
304 */
305#define snd_printk(fmt, ...) \
306 __snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
307
308#ifdef CONFIG_SND_DEBUG
309/**
310 * snd_printd - debug printk
311 * @fmt: format string
312 *
313 * Works like snd_printk() for debugging purposes.
314 * Ignored when CONFIG_SND_DEBUG is not set.
315 */
316#define snd_printd(fmt, ...) \
317 __snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
318#define _snd_printd(level, fmt, ...) \
319 __snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
320
321/**
322 * snd_BUG - give a BUG warning message and stack trace
323 *
324 * Calls WARN() if CONFIG_SND_DEBUG is set.
325 * Ignored when CONFIG_SND_DEBUG is not set.
326 */
327#define snd_BUG() WARN(1, "BUG?\n")
328
329/**
330 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
331 */
332#define snd_printd_ratelimit() printk_ratelimit()
333
334/**
335 * snd_BUG_ON - debugging check macro
336 * @cond: condition to evaluate
337 *
338 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
339 * otherwise just evaluates the conditional and returns the value.
340 */
341#define snd_BUG_ON(cond) WARN_ON((cond))
342
343#else /* !CONFIG_SND_DEBUG */
344
345__printf(1, 2)
346static inline void snd_printd(const char *format, ...) {}
347__printf(2, 3)
348static inline void _snd_printd(int level, const char *format, ...) {}
349
350#define snd_BUG() do { } while (0)
351
352#define snd_BUG_ON(condition) ({ \
353 int __ret_warn_on = !!(condition); \
354 unlikely(__ret_warn_on); \
355})
356
357static inline bool snd_printd_ratelimit(void) { return false; }
358
359#endif /* CONFIG_SND_DEBUG */
360
361#ifdef CONFIG_SND_DEBUG_VERBOSE
362/**
363 * snd_printdd - debug printk
364 * @format: format string
365 *
366 * Works like snd_printk() for debugging purposes.
367 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
368 */
369#define snd_printdd(format, ...) \
370 __snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
371#else
372__printf(1, 2)
373static inline void snd_printdd(const char *format, ...) {}
374#endif
375
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#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 mixername[80]; /* mixer name */
103 char components[128]; /* card components delimited with
104 space */
105 struct module *module; /* top-level module */
106
107 void *private_data; /* private data for soundcard */
108 void (*private_free) (struct snd_card *card); /* callback for freeing of
109 private data */
110 struct list_head devices; /* devices */
111
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 */
119
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 */
123
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
126 state */
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? */
133
134#ifdef CONFIG_PM
135 unsigned int power_state; /* power state */
136 struct mutex power_lock; /* power lock */
137 wait_queue_head_t power_sleep;
138#endif
139
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;
143#endif
144};
145
146#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
147
148#ifdef CONFIG_PM
149static inline void snd_power_lock(struct snd_card *card)
150{
151 mutex_lock(&card->power_lock);
152}
153
154static inline void snd_power_unlock(struct snd_card *card)
155{
156 mutex_unlock(&card->power_lock);
157}
158
159static inline unsigned int snd_power_get_state(struct snd_card *card)
160{
161 return card->power_state;
162}
163
164static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
165{
166 card->power_state = state;
167 wake_up(&card->power_sleep);
168}
169
170/* init.c */
171int snd_power_wait(struct snd_card *card, unsigned int power_state);
172
173#else /* ! CONFIG_PM */
174
175#define snd_power_lock(card) do { (void)(card); } while (0)
176#define snd_power_unlock(card) do { (void)(card); } while (0)
177static 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)
180
181#endif /* CONFIG_PM */
182
183struct snd_minor {
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 */
191};
192
193/* return a device pointer linked to each sound device as a parent */
194static inline struct device *snd_card_get_device_link(struct snd_card *card)
195{
196 return card ? &card->card_dev : NULL;
197}
198
199/* sound.c */
200
201extern int snd_major;
202extern int snd_ecards_limit;
203extern struct class *sound_class;
204
205void snd_request_card(int card);
206
207int snd_register_device_for_dev(int type, struct snd_card *card,
208 int dev,
209 const struct file_operations *f_ops,
210 void *private_data,
211 const char *name,
212 struct device *device);
213
214/**
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
222 *
223 * Registers an ALSA device file for the given card.
224 * The operators have to be set in reg parameter.
225 *
226 * This function uses the card's device pointer to link to the
227 * correct &struct device.
228 *
229 * Return: Zero if successful, or a negative error code on failure.
230 */
231static inline int snd_register_device(int type, struct snd_card *card, int dev,
232 const struct file_operations *f_ops,
233 void *private_data,
234 const char *name)
235{
236 return snd_register_device_for_dev(type, card, dev, f_ops,
237 private_data, name,
238 snd_card_get_device_link(card));
239}
240
241int snd_unregister_device(int type, struct snd_card *card, int dev);
242void *snd_lookup_minor_data(unsigned int minor, int type);
243struct device *snd_get_device(int type, struct snd_card *card, int dev);
244
245#ifdef CONFIG_SND_OSSEMUL
246int snd_register_oss_device(int type, struct snd_card *card, int dev,
247 const struct file_operations *f_ops, void *private_data);
248int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
249void *snd_lookup_oss_minor_data(unsigned int minor, int type);
250#endif
251
252int snd_minor_info_init(void);
253int snd_minor_info_done(void);
254
255/* sound_oss.c */
256
257#ifdef CONFIG_SND_OSSEMUL
258int snd_minor_info_oss_init(void);
259int snd_minor_info_oss_done(void);
260#else
261static inline int snd_minor_info_oss_init(void) { return 0; }
262static inline int snd_minor_info_oss_done(void) { return 0; }
263#endif
264
265/* memory.c */
266
267int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
268int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
269
270/* init.c */
271
272extern struct snd_card *snd_cards[SNDRV_CARDS];
273int 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
278extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
279#endif
280
281int snd_card_new(struct device *parent, int idx, const char *xid,
282 struct module *module, int extra_size,
283 struct snd_card **card_ret);
284
285static inline int __deprecated
286snd_card_create(int idx, const char *id, struct module *module, int extra_size,
287 struct snd_card **ret)
288{
289 return snd_card_new(NULL, idx, id, module, extra_size, ret);
290}
291
292int snd_card_disconnect(struct snd_card *card);
293int snd_card_free(struct snd_card *card);
294int snd_card_free_when_closed(struct snd_card *card);
295void snd_card_set_id(struct snd_card *card, const char *id);
296int snd_card_register(struct snd_card *card);
297int snd_card_info_init(void);
298int snd_card_info_done(void);
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#define snd_card_unref(card) put_device(&(card)->card_dev)
303
304#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
305
306/* device.c */
307
308int snd_device_new(struct snd_card *card, enum snd_device_type type,
309 void *device_data, struct snd_device_ops *ops);
310int snd_device_register(struct snd_card *card, void *device_data);
311int snd_device_register_all(struct snd_card *card);
312int snd_device_disconnect_all(struct snd_card *card);
313void snd_device_free(struct snd_card *card, void *device_data);
314void snd_device_free_all(struct snd_card *card);
315
316/* isadma.c */
317
318#ifdef CONFIG_ISA_DMA_API
319#define DMA_MODE_NO_ENABLE 0x0100
320
321void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
322void snd_dma_disable(unsigned long dma);
323unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
324#endif
325
326/* misc.c */
327struct resource;
328void release_and_free_resource(struct resource *res);
329
330/* --- */
331
332/* sound printk debug levels */
333enum {
334 SND_PR_ALWAYS,
335 SND_PR_DEBUG,
336 SND_PR_VERBOSE,
337};
338
339#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
340__printf(4, 5)
341void __snd_printk(unsigned int level, const char *file, int line,
342 const char *format, ...);
343#else
344#define __snd_printk(level, file, line, format, args...) \
345 printk(format, ##args)
346#endif
347
348/**
349 * snd_printk - printk wrapper
350 * @fmt: format string
351 *
352 * Works like printk() but prints the file and the line of the caller
353 * when configured with CONFIG_SND_VERBOSE_PRINTK.
354 */
355#define snd_printk(fmt, args...) \
356 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
357
358#ifdef CONFIG_SND_DEBUG
359/**
360 * snd_printd - debug printk
361 * @fmt: format string
362 *
363 * Works like snd_printk() for debugging purposes.
364 * Ignored when CONFIG_SND_DEBUG is not set.
365 */
366#define snd_printd(fmt, args...) \
367 __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
368#define _snd_printd(level, fmt, args...) \
369 __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
370
371/**
372 * snd_BUG - give a BUG warning message and stack trace
373 *
374 * Calls WARN() if CONFIG_SND_DEBUG is set.
375 * Ignored when CONFIG_SND_DEBUG is not set.
376 */
377#define snd_BUG() WARN(1, "BUG?\n")
378
379/**
380 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
381 */
382#define snd_printd_ratelimit() printk_ratelimit()
383
384/**
385 * snd_BUG_ON - debugging check macro
386 * @cond: condition to evaluate
387 *
388 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
389 * otherwise just evaluates the conditional and returns the value.
390 */
391#define snd_BUG_ON(cond) WARN_ON((cond))
392
393#else /* !CONFIG_SND_DEBUG */
394
395__printf(1, 2)
396static inline void snd_printd(const char *format, ...) {}
397__printf(2, 3)
398static inline void _snd_printd(int level, const char *format, ...) {}
399
400#define snd_BUG() do { } while (0)
401
402#define snd_BUG_ON(condition) ({ \
403 int __ret_warn_on = !!(condition); \
404 unlikely(__ret_warn_on); \
405})
406
407static inline bool snd_printd_ratelimit(void) { return false; }
408
409#endif /* CONFIG_SND_DEBUG */
410
411#ifdef CONFIG_SND_DEBUG_VERBOSE
412/**
413 * snd_printdd - debug printk
414 * @format: format string
415 *
416 * Works like snd_printk() for debugging purposes.
417 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
418 */
419#define snd_printdd(format, args...) \
420 __snd_printk(2, __FILE__, __LINE__, format, ##args)
421#else
422__printf(1, 2)
423static inline void snd_printdd(const char *format, ...) {}
424#endif
425
426
427#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
428
429/* for easier backward-porting */
430#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
431#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
432#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
433#define gameport_get_port_data(gp) (gp)->port_data
434#endif
435
436/* PCI quirk list helper */
437struct snd_pci_quirk {
438 unsigned short subvendor; /* PCI subvendor ID */
439 unsigned short subdevice; /* PCI subdevice ID */
440 unsigned short subdevice_mask; /* bitmask to match */
441 int value; /* value */
442#ifdef CONFIG_SND_DEBUG_VERBOSE
443 const char *name; /* name of the device (optional) */
444#endif
445};
446
447#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
448 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
449#define _SND_PCI_QUIRK_ID(vend, dev) \
450 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
451#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
452#ifdef CONFIG_SND_DEBUG_VERBOSE
453#define SND_PCI_QUIRK(vend,dev,xname,val) \
454 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
455#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
456 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
457#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
458 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
459 .value = (val), .name = (xname)}
460#define snd_pci_quirk_name(q) ((q)->name)
461#else
462#define SND_PCI_QUIRK(vend,dev,xname,val) \
463 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
464#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
465 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
466#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
467 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
468#define snd_pci_quirk_name(q) ""
469#endif
470
471#ifdef CONFIG_PCI
472const struct snd_pci_quirk *
473snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
474
475const struct snd_pci_quirk *
476snd_pci_quirk_lookup_id(u16 vendor, u16 device,
477 const struct snd_pci_quirk *list);
478#else
479static inline const struct snd_pci_quirk *
480snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
481{
482 return NULL;
483}
484
485static inline const struct snd_pci_quirk *
486snd_pci_quirk_lookup_id(u16 vendor, u16 device,
487 const struct snd_pci_quirk *list)
488{
489 return NULL;
490}
491#endif
492
493#endif /* __SOUND_CORE_H */