1#ifndef __SOUND_CORE_H
2#define __SOUND_CORE_H
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25#include <linux/device.h>
26#include <linux/sched.h>
27#include <linux/mutex.h>
28#include <linux/rwsem.h>
29#include <linux/pm.h>
30#include <linux/stringify.h>
31#include <linux/printk.h>
32
33
34#ifdef CONFIG_SND_DYNAMIC_MINORS
35#define SNDRV_CARDS CONFIG_SND_MAX_CARDS
36#else
37#define SNDRV_CARDS 8
38#endif
39
40#define CONFIG_SND_MAJOR 116
41
42
43struct pci_dev;
44struct module;
45struct completion;
46
47
48
49
50
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;
83 struct snd_card *card;
84 enum snd_device_state state;
85 enum snd_device_type type;
86 void *device_data;
87 struct snd_device_ops *ops;
88};
89
90#define snd_device(n) list_entry(n, struct snd_device, list)
91
92
93
94struct snd_card {
95 int number;
96
97
98 char id[16];
99 char driver[16];
100 char shortname[32];
101 char longname[80];
102 char irq_descr[32];
103 char mixername[80];
104 char components[128];
105
106 struct module *module;
107
108 void *private_data;
109 void (*private_free) (struct snd_card *card);
110
111 struct list_head devices;
112
113 struct device ctl_dev;
114 unsigned int last_numid;
115 struct rw_semaphore controls_rwsem;
116 rwlock_t ctl_files_rwlock;
117 int controls_count;
118 int user_ctl_count;
119 struct list_head controls;
120 struct list_head ctl_files;
121 struct mutex user_ctl_lock;
122
123
124 struct snd_info_entry *proc_root;
125 struct snd_info_entry *proc_id;
126 struct proc_dir_entry *proc_root_link;
127
128 struct list_head files_list;
129 struct snd_shutdown_f_ops *s_f_ops;
130
131 spinlock_t files_lock;
132 int shutdown;
133 struct completion *release_completion;
134 struct device *dev;
135 struct device card_dev;
136 const struct attribute_group *dev_groups[4];
137 bool registered;
138
139#ifdef CONFIG_PM
140 unsigned int power_state;
141 struct mutex 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
176int snd_power_wait(struct snd_card *card, unsigned int power_state);
177
178#else
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
187
188struct snd_minor {
189 int type;
190 int card;
191 int device;
192 const struct file_operations *f_ops;
193 void *private_data;
194 struct device *dev;
195 struct snd_card *card_ptr;
196};
197
198
199static inline struct device *snd_card_get_device_link(struct snd_card *card)
200{
201 return card ? &card->card_dev : NULL;
202}
203
204
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
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
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
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
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
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
294struct resource;
295void release_and_free_resource(struct resource *res);
296
297
298
299
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
317
318
319
320
321
322#define snd_printk(fmt, args...) \
323 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
324
325#ifdef CONFIG_SND_DEBUG
326
327
328
329
330
331
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
340
341
342
343
344#define snd_BUG() WARN(1, "BUG?\n")
345
346
347
348
349#define snd_printd_ratelimit() printk_ratelimit()
350
351
352
353
354
355
356
357
358#define snd_BUG_ON(cond) WARN_ON((cond))
359
360#else
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
377
378#ifdef CONFIG_SND_DEBUG_VERBOSE
379
380
381
382
383
384
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))
395
396
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
404struct snd_pci_quirk {
405 unsigned short subvendor;
406 unsigned short subdevice;
407 unsigned short subdevice_mask;
408 int value;
409#ifdef CONFIG_SND_DEBUG_VERBOSE
410 const char *name;
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
461