1
2#ifndef __SOUND_CORE_H
3#define __SOUND_CORE_H
4
5
6
7
8
9
10#include <linux/device.h>
11#include <linux/sched.h>
12#include <linux/mutex.h>
13#include <linux/rwsem.h>
14#include <linux/pm.h>
15#include <linux/stringify.h>
16#include <linux/printk.h>
17
18
19#ifdef CONFIG_SND_DYNAMIC_MINORS
20#define SNDRV_CARDS CONFIG_SND_MAX_CARDS
21#else
22#define SNDRV_CARDS 8
23#endif
24
25#define CONFIG_SND_MAJOR 116
26
27
28struct pci_dev;
29struct module;
30struct completion;
31
32
33
34
35
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,
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;
68 struct snd_card *card;
69 enum snd_device_state state;
70 enum snd_device_type type;
71 void *device_data;
72 const struct snd_device_ops *ops;
73};
74
75#define snd_device(n) list_entry(n, struct snd_device, list)
76
77
78
79struct snd_card {
80 int number;
81
82
83 char id[16];
84 char driver[16];
85 char shortname[32];
86 char longname[80];
87 char irq_descr[32];
88 char mixername[80];
89 char components[128];
90
91 struct module *module;
92
93 void *private_data;
94 void (*private_free) (struct snd_card *card);
95
96 struct list_head devices;
97
98 struct device ctl_dev;
99 unsigned int last_numid;
100 struct rw_semaphore controls_rwsem;
101 rwlock_t ctl_files_rwlock;
102 int controls_count;
103 size_t user_ctl_alloc_size;
104 struct list_head controls;
105 struct list_head ctl_files;
106
107 struct snd_info_entry *proc_root;
108 struct proc_dir_entry *proc_root_link;
109
110 struct list_head files_list;
111 struct snd_shutdown_f_ops *s_f_ops;
112
113 spinlock_t files_lock;
114 int shutdown;
115 struct completion *release_completion;
116 struct device *dev;
117 struct device card_dev;
118 const struct attribute_group *dev_groups[4];
119 bool registered;
120 int sync_irq;
121 wait_queue_head_t remove_sleep;
122
123 size_t total_pcm_alloc_bytes;
124 struct mutex memory_mutex;
125#ifdef CONFIG_SND_DEBUG
126 struct dentry *debugfs_root;
127#endif
128
129#ifdef CONFIG_PM
130 unsigned int power_state;
131 atomic_t power_ref;
132 wait_queue_head_t power_sleep;
133 wait_queue_head_t power_ref_sleep;
134#endif
135
136#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
137 struct snd_mixer_oss *mixer_oss;
138 int mixer_oss_change_count;
139#endif
140};
141
142#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
143
144#ifdef CONFIG_PM
145static inline unsigned int snd_power_get_state(struct snd_card *card)
146{
147 return READ_ONCE(card->power_state);
148}
149
150static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
151{
152 WRITE_ONCE(card->power_state, state);
153 wake_up(&card->power_sleep);
154}
155
156
157
158
159
160
161
162
163
164static inline void snd_power_ref(struct snd_card *card)
165{
166 atomic_inc(&card->power_ref);
167}
168
169
170
171
172
173static inline void snd_power_unref(struct snd_card *card)
174{
175 if (atomic_dec_and_test(&card->power_ref))
176 wake_up(&card->power_ref_sleep);
177}
178
179
180
181
182
183
184
185
186static inline void snd_power_sync_ref(struct snd_card *card)
187{
188 wait_event(card->power_ref_sleep, !atomic_read(&card->power_ref));
189}
190
191
192int snd_power_wait(struct snd_card *card);
193int snd_power_ref_and_wait(struct snd_card *card);
194
195#else
196
197static inline int snd_power_wait(struct snd_card *card) { return 0; }
198static inline void snd_power_ref(struct snd_card *card) {}
199static inline void snd_power_unref(struct snd_card *card) {}
200static inline int snd_power_ref_and_wait(struct snd_card *card) { return 0; }
201static inline void snd_power_sync_ref(struct snd_card *card) {}
202#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
203#define snd_power_change_state(card, state) do { (void)(card); } while (0)
204
205#endif
206
207struct snd_minor {
208 int type;
209 int card;
210 int device;
211 const struct file_operations *f_ops;
212 void *private_data;
213 struct device *dev;
214 struct snd_card *card_ptr;
215};
216
217
218static inline struct device *snd_card_get_device_link(struct snd_card *card)
219{
220 return card ? &card->card_dev : NULL;
221}
222
223
224
225extern int snd_major;
226extern int snd_ecards_limit;
227extern struct class *sound_class;
228#ifdef CONFIG_SND_DEBUG
229extern struct dentry *sound_debugfs_root;
230#endif
231
232void snd_request_card(int card);
233
234void snd_device_initialize(struct device *dev, struct snd_card *card);
235
236int snd_register_device(int type, struct snd_card *card, int dev,
237 const struct file_operations *f_ops,
238 void *private_data, struct device *device);
239int snd_unregister_device(struct device *dev);
240void *snd_lookup_minor_data(unsigned int minor, int type);
241
242#ifdef CONFIG_SND_OSSEMUL
243int snd_register_oss_device(int type, struct snd_card *card, int dev,
244 const struct file_operations *f_ops, void *private_data);
245int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
246void *snd_lookup_oss_minor_data(unsigned int minor, int type);
247#endif
248
249int snd_minor_info_init(void);
250
251
252
253#ifdef CONFIG_SND_OSSEMUL
254int snd_minor_info_oss_init(void);
255#else
256static inline int snd_minor_info_oss_init(void) { return 0; }
257#endif
258
259
260
261int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
262int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
263
264
265
266int snd_card_locked(int card);
267#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
268#define SND_MIXER_OSS_NOTIFY_REGISTER 0
269#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
270#define SND_MIXER_OSS_NOTIFY_FREE 2
271extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
272#endif
273
274int snd_card_new(struct device *parent, int idx, const char *xid,
275 struct module *module, int extra_size,
276 struct snd_card **card_ret);
277
278int snd_card_disconnect(struct snd_card *card);
279void snd_card_disconnect_sync(struct snd_card *card);
280int snd_card_free(struct snd_card *card);
281int snd_card_free_when_closed(struct snd_card *card);
282void snd_card_set_id(struct snd_card *card, const char *id);
283int snd_card_register(struct snd_card *card);
284int snd_card_info_init(void);
285int snd_card_add_dev_attr(struct snd_card *card,
286 const struct attribute_group *group);
287int snd_component_add(struct snd_card *card, const char *component);
288int snd_card_file_add(struct snd_card *card, struct file *file);
289int snd_card_file_remove(struct snd_card *card, struct file *file);
290
291struct snd_card *snd_card_ref(int card);
292
293
294
295
296
297
298
299
300static inline void snd_card_unref(struct snd_card *card)
301{
302 put_device(&card->card_dev);
303}
304
305#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
306
307
308
309int snd_device_new(struct snd_card *card, enum snd_device_type type,
310 void *device_data, const struct snd_device_ops *ops);
311int snd_device_register(struct snd_card *card, void *device_data);
312int snd_device_register_all(struct snd_card *card);
313void snd_device_disconnect(struct snd_card *card, void *device_data);
314void snd_device_disconnect_all(struct snd_card *card);
315void snd_device_free(struct snd_card *card, void *device_data);
316void snd_device_free_all(struct snd_card *card);
317int snd_device_get_state(struct snd_card *card, void *device_data);
318
319
320
321#ifdef CONFIG_ISA_DMA_API
322#define DMA_MODE_NO_ENABLE 0x0100
323
324void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
325void snd_dma_disable(unsigned long dma);
326unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
327#endif
328
329
330struct resource;
331void release_and_free_resource(struct resource *res);
332
333
334
335
336enum {
337 SND_PR_ALWAYS,
338 SND_PR_DEBUG,
339 SND_PR_VERBOSE,
340};
341
342#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
343__printf(4, 5)
344void __snd_printk(unsigned int level, const char *file, int line,
345 const char *format, ...);
346#else
347#define __snd_printk(level, file, line, format, ...) \
348 printk(format, ##__VA_ARGS__)
349#endif
350
351
352
353
354
355
356
357
358#define snd_printk(fmt, ...) \
359 __snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
360
361#ifdef CONFIG_SND_DEBUG
362
363
364
365
366
367
368
369#define snd_printd(fmt, ...) \
370 __snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
371#define _snd_printd(level, fmt, ...) \
372 __snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
373
374
375
376
377
378
379
380#define snd_BUG() WARN(1, "BUG?\n")
381
382
383
384
385
386#define snd_printd_ratelimit() printk_ratelimit()
387
388
389
390
391
392
393
394
395#define snd_BUG_ON(cond) WARN_ON((cond))
396
397#else
398
399__printf(1, 2)
400static inline void snd_printd(const char *format, ...) {}
401__printf(2, 3)
402static inline void _snd_printd(int level, const char *format, ...) {}
403
404#define snd_BUG() do { } while (0)
405
406#define snd_BUG_ON(condition) ({ \
407 int __ret_warn_on = !!(condition); \
408 unlikely(__ret_warn_on); \
409})
410
411static inline bool snd_printd_ratelimit(void) { return false; }
412
413#endif
414
415#ifdef CONFIG_SND_DEBUG_VERBOSE
416
417
418
419
420
421
422
423#define snd_printdd(format, ...) \
424 __snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
425#else
426__printf(1, 2)
427static inline void snd_printdd(const char *format, ...) {}
428#endif
429
430
431#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0))
432
433
434#if IS_ENABLED(CONFIG_GAMEPORT)
435#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
436#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
437#define gameport_get_port_data(gp) (gp)->port_data
438#endif
439
440
441struct snd_pci_quirk {
442 unsigned short subvendor;
443 unsigned short subdevice;
444 unsigned short subdevice_mask;
445 int value;
446#ifdef CONFIG_SND_DEBUG_VERBOSE
447 const char *name;
448#endif
449};
450
451#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
452 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
453#define _SND_PCI_QUIRK_ID(vend, dev) \
454 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
455#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
456#ifdef CONFIG_SND_DEBUG_VERBOSE
457#define SND_PCI_QUIRK(vend,dev,xname,val) \
458 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
459#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
460 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
461#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
462 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
463 .value = (val), .name = (xname)}
464#define snd_pci_quirk_name(q) ((q)->name)
465#else
466#define SND_PCI_QUIRK(vend,dev,xname,val) \
467 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
468#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
469 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
470#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
471 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
472#define snd_pci_quirk_name(q) ""
473#endif
474
475#ifdef CONFIG_PCI
476const struct snd_pci_quirk *
477snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
478
479const struct snd_pci_quirk *
480snd_pci_quirk_lookup_id(u16 vendor, u16 device,
481 const struct snd_pci_quirk *list);
482#else
483static inline const struct snd_pci_quirk *
484snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
485{
486 return NULL;
487}
488
489static inline const struct snd_pci_quirk *
490snd_pci_quirk_lookup_id(u16 vendor, u16 device,
491 const struct snd_pci_quirk *list)
492{
493 return NULL;
494}
495#endif
496
497#endif
498