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 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 int user_ctl_count;
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 wait_queue_head_t remove_sleep;
121
122#ifdef CONFIG_PM
123 unsigned int 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
148int snd_power_wait(struct snd_card *card, unsigned int power_state);
149
150#else
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
157
158struct snd_minor {
159 int type;
160 int card;
161 int device;
162 const struct file_operations *f_ops;
163 void *private_data;
164 struct device *dev;
165 struct snd_card *card_ptr;
166};
167
168
169static inline struct device *snd_card_get_device_link(struct snd_card *card)
170{
171 return card ? &card->card_dev : NULL;
172}
173
174
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
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
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
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
243
244
245
246
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
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
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
277struct resource;
278void release_and_free_resource(struct resource *res);
279
280
281
282
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
300
301
302
303
304
305#define snd_printk(fmt, ...) \
306 __snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
307
308#ifdef CONFIG_SND_DEBUG
309
310
311
312
313
314
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
323
324
325
326
327#define snd_BUG() WARN(1, "BUG?\n")
328
329
330
331
332#define snd_printd_ratelimit() printk_ratelimit()
333
334
335
336
337
338
339
340
341#define snd_BUG_ON(cond) WARN_ON((cond))
342
343#else
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
360
361#ifdef CONFIG_SND_DEBUG_VERBOSE
362
363
364
365
366
367
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))
378
379
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
387struct snd_pci_quirk {
388 unsigned short subvendor;
389 unsigned short subdevice;
390 unsigned short subdevice_mask;
391 int value;
392#ifdef CONFIG_SND_DEBUG_VERBOSE
393 const char *name;
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
444