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 */
43 struct pci_dev;
44 struct module;
45 struct completion;
46 
47 /* device allocation stuff */
48 
49 /* type of the object used in snd_device_*()
50  * this also defines the calling order
51  */
52 enum snd_device_type {
53 	SNDRV_DEV_LOWLEVEL,
54 	SNDRV_DEV_INFO,
55 	SNDRV_DEV_BUS,
56 	SNDRV_DEV_CODEC,
57 	SNDRV_DEV_PCM,
58 	SNDRV_DEV_COMPRESS,
59 	SNDRV_DEV_RAWMIDI,
60 	SNDRV_DEV_TIMER,
61 	SNDRV_DEV_SEQUENCER,
62 	SNDRV_DEV_HWDEP,
63 	SNDRV_DEV_JACK,
64 	SNDRV_DEV_CONTROL,	/* NOTE: this must be the last one */
65 };
66 
67 enum snd_device_state {
68 	SNDRV_DEV_BUILD,
69 	SNDRV_DEV_REGISTERED,
70 	SNDRV_DEV_DISCONNECTED,
71 };
72 
73 struct snd_device;
74 
75 struct 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 
81 struct 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 
94 struct 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 
122 	struct snd_info_entry *proc_root;	/* root for soundcard specific files */
123 	struct snd_info_entry *proc_id;	/* the card id */
124 	struct proc_dir_entry *proc_root_link;	/* number link to real id */
125 
126 	struct list_head files_list;	/* all files associated to this card */
127 	struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
128 								state */
129 	spinlock_t files_lock;		/* lock the files for this card */
130 	int shutdown;			/* this card is going down */
131 	struct completion *release_completion;
132 	struct device *dev;		/* device assigned to this card */
133 	struct device card_dev;		/* cardX object for sysfs */
134 	const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
135 	bool registered;		/* card_dev is registered? */
136 	wait_queue_head_t remove_sleep;
137 
138 #ifdef CONFIG_PM
139 	unsigned int power_state;	/* power state */
140 	wait_queue_head_t power_sleep;
141 #endif
142 
143 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
144 	struct snd_mixer_oss *mixer_oss;
145 	int mixer_oss_change_count;
146 #endif
147 };
148 
149 #define dev_to_snd_card(p)	container_of(p, struct snd_card, card_dev)
150 
151 #ifdef CONFIG_PM
snd_power_get_state(struct snd_card * card)152 static inline unsigned int snd_power_get_state(struct snd_card *card)
153 {
154 	return card->power_state;
155 }
156 
snd_power_change_state(struct snd_card * card,unsigned int state)157 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
158 {
159 	card->power_state = state;
160 	wake_up(&card->power_sleep);
161 }
162 
163 /* init.c */
164 int snd_power_wait(struct snd_card *card, unsigned int power_state);
165 
166 #else /* ! CONFIG_PM */
167 
snd_power_wait(struct snd_card * card,unsigned int state)168 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
169 #define snd_power_get_state(card)	({ (void)(card); SNDRV_CTL_POWER_D0; })
170 #define snd_power_change_state(card, state)	do { (void)(card); } while (0)
171 
172 #endif /* CONFIG_PM */
173 
174 struct snd_minor {
175 	int type;			/* SNDRV_DEVICE_TYPE_XXX */
176 	int card;			/* card number */
177 	int device;			/* device number */
178 	const struct file_operations *f_ops;	/* file operations */
179 	void *private_data;		/* private data for f_ops->open */
180 	struct device *dev;		/* device for sysfs */
181 	struct snd_card *card_ptr;	/* assigned card instance */
182 };
183 
184 /* return a device pointer linked to each sound device as a parent */
snd_card_get_device_link(struct snd_card * card)185 static inline struct device *snd_card_get_device_link(struct snd_card *card)
186 {
187 	return card ? &card->card_dev : NULL;
188 }
189 
190 /* sound.c */
191 
192 extern int snd_major;
193 extern int snd_ecards_limit;
194 extern struct class *sound_class;
195 
196 void snd_request_card(int card);
197 
198 void snd_device_initialize(struct device *dev, struct snd_card *card);
199 
200 int snd_register_device(int type, struct snd_card *card, int dev,
201 			const struct file_operations *f_ops,
202 			void *private_data, struct device *device);
203 int snd_unregister_device(struct device *dev);
204 void *snd_lookup_minor_data(unsigned int minor, int type);
205 
206 #ifdef CONFIG_SND_OSSEMUL
207 int snd_register_oss_device(int type, struct snd_card *card, int dev,
208 			    const struct file_operations *f_ops, void *private_data);
209 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
210 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
211 #endif
212 
213 int snd_minor_info_init(void);
214 
215 /* sound_oss.c */
216 
217 #ifdef CONFIG_SND_OSSEMUL
218 int snd_minor_info_oss_init(void);
219 #else
snd_minor_info_oss_init(void)220 static inline int snd_minor_info_oss_init(void) { return 0; }
221 #endif
222 
223 /* memory.c */
224 
225 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
226 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
227 
228 /* init.c */
229 
230 extern struct snd_card *snd_cards[SNDRV_CARDS];
231 int snd_card_locked(int card);
232 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
233 #define SND_MIXER_OSS_NOTIFY_REGISTER	0
234 #define SND_MIXER_OSS_NOTIFY_DISCONNECT	1
235 #define SND_MIXER_OSS_NOTIFY_FREE	2
236 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
237 #endif
238 
239 int snd_card_new(struct device *parent, int idx, const char *xid,
240 		 struct module *module, int extra_size,
241 		 struct snd_card **card_ret);
242 
243 int snd_card_disconnect(struct snd_card *card);
244 void snd_card_disconnect_sync(struct snd_card *card);
245 int snd_card_free(struct snd_card *card);
246 int snd_card_free_when_closed(struct snd_card *card);
247 void snd_card_set_id(struct snd_card *card, const char *id);
248 int snd_card_register(struct snd_card *card);
249 int snd_card_info_init(void);
250 int snd_card_add_dev_attr(struct snd_card *card,
251 			  const struct attribute_group *group);
252 int snd_component_add(struct snd_card *card, const char *component);
253 int snd_card_file_add(struct snd_card *card, struct file *file);
254 int snd_card_file_remove(struct snd_card *card, struct file *file);
255 #define snd_card_unref(card)	put_device(&(card)->card_dev)
256 
257 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
258 
259 /* device.c */
260 
261 int snd_device_new(struct snd_card *card, enum snd_device_type type,
262 		   void *device_data, struct snd_device_ops *ops);
263 int snd_device_register(struct snd_card *card, void *device_data);
264 int snd_device_register_all(struct snd_card *card);
265 void snd_device_disconnect(struct snd_card *card, void *device_data);
266 void snd_device_disconnect_all(struct snd_card *card);
267 void snd_device_free(struct snd_card *card, void *device_data);
268 void snd_device_free_all(struct snd_card *card);
269 
270 /* isadma.c */
271 
272 #ifdef CONFIG_ISA_DMA_API
273 #define DMA_MODE_NO_ENABLE	0x0100
274 
275 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
276 void snd_dma_disable(unsigned long dma);
277 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
278 #endif
279 
280 /* misc.c */
281 struct resource;
282 void release_and_free_resource(struct resource *res);
283 
284 /* --- */
285 
286 /* sound printk debug levels */
287 enum {
288 	SND_PR_ALWAYS,
289 	SND_PR_DEBUG,
290 	SND_PR_VERBOSE,
291 };
292 
293 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
294 __printf(4, 5)
295 void __snd_printk(unsigned int level, const char *file, int line,
296 		  const char *format, ...);
297 #else
298 #define __snd_printk(level, file, line, format, ...) \
299 	printk(format, ##__VA_ARGS__)
300 #endif
301 
302 /**
303  * snd_printk - printk wrapper
304  * @fmt: format string
305  *
306  * Works like printk() but prints the file and the line of the caller
307  * when configured with CONFIG_SND_VERBOSE_PRINTK.
308  */
309 #define snd_printk(fmt, ...) \
310 	__snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
311 
312 #ifdef CONFIG_SND_DEBUG
313 /**
314  * snd_printd - debug printk
315  * @fmt: format string
316  *
317  * Works like snd_printk() for debugging purposes.
318  * Ignored when CONFIG_SND_DEBUG is not set.
319  */
320 #define snd_printd(fmt, ...) \
321 	__snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
322 #define _snd_printd(level, fmt, ...) \
323 	__snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
324 
325 /**
326  * snd_BUG - give a BUG warning message and stack trace
327  *
328  * Calls WARN() if CONFIG_SND_DEBUG is set.
329  * Ignored when CONFIG_SND_DEBUG is not set.
330  */
331 #define snd_BUG()		WARN(1, "BUG?\n")
332 
333 /**
334  * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
335  */
336 #define snd_printd_ratelimit() printk_ratelimit()
337 
338 /**
339  * snd_BUG_ON - debugging check macro
340  * @cond: condition to evaluate
341  *
342  * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
343  * otherwise just evaluates the conditional and returns the value.
344  */
345 #define snd_BUG_ON(cond)	WARN_ON((cond))
346 
347 #else /* !CONFIG_SND_DEBUG */
348 
349 __printf(1, 2)
snd_printd(const char * format,...)350 static inline void snd_printd(const char *format, ...) {}
351 __printf(2, 3)
_snd_printd(int level,const char * format,...)352 static inline void _snd_printd(int level, const char *format, ...) {}
353 
354 #define snd_BUG()			do { } while (0)
355 
356 #define snd_BUG_ON(condition) ({ \
357 	int __ret_warn_on = !!(condition); \
358 	unlikely(__ret_warn_on); \
359 })
360 
snd_printd_ratelimit(void)361 static inline bool snd_printd_ratelimit(void) { return false; }
362 
363 #endif /* CONFIG_SND_DEBUG */
364 
365 #ifdef CONFIG_SND_DEBUG_VERBOSE
366 /**
367  * snd_printdd - debug printk
368  * @format: format string
369  *
370  * Works like snd_printk() for debugging purposes.
371  * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
372  */
373 #define snd_printdd(format, ...) \
374 	__snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
375 #else
376 __printf(1, 2)
snd_printdd(const char * format,...)377 static inline void snd_printdd(const char *format, ...) {}
378 #endif
379 
380 
381 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))	/* 3.8.1a */
382 
383 /* for easier backward-porting */
384 #if IS_ENABLED(CONFIG_GAMEPORT)
385 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
386 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
387 #define gameport_get_port_data(gp) (gp)->port_data
388 #endif
389 
390 /* PCI quirk list helper */
391 struct snd_pci_quirk {
392 	unsigned short subvendor;	/* PCI subvendor ID */
393 	unsigned short subdevice;	/* PCI subdevice ID */
394 	unsigned short subdevice_mask;	/* bitmask to match */
395 	int value;			/* value */
396 #ifdef CONFIG_SND_DEBUG_VERBOSE
397 	const char *name;		/* name of the device (optional) */
398 #endif
399 };
400 
401 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev)	\
402 	.subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
403 #define _SND_PCI_QUIRK_ID(vend, dev) \
404 	_SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
405 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
406 #ifdef CONFIG_SND_DEBUG_VERBOSE
407 #define SND_PCI_QUIRK(vend,dev,xname,val) \
408 	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
409 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)			\
410 	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
411 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)			\
412 	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),			\
413 			.value = (val), .name = (xname)}
414 #define snd_pci_quirk_name(q)	((q)->name)
415 #else
416 #define SND_PCI_QUIRK(vend,dev,xname,val) \
417 	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
418 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)			\
419 	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
420 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)			\
421 	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
422 #define snd_pci_quirk_name(q)	""
423 #endif
424 
425 #ifdef CONFIG_PCI
426 const struct snd_pci_quirk *
427 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
428 
429 const struct snd_pci_quirk *
430 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
431 			const struct snd_pci_quirk *list);
432 #else
433 static inline const struct snd_pci_quirk *
snd_pci_quirk_lookup(struct pci_dev * pci,const struct snd_pci_quirk * list)434 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
435 {
436 	return NULL;
437 }
438 
439 static inline const struct snd_pci_quirk *
snd_pci_quirk_lookup_id(u16 vendor,u16 device,const struct snd_pci_quirk * list)440 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
441 			const struct snd_pci_quirk *list)
442 {
443 	return NULL;
444 }
445 #endif
446 
447 /* async signal helpers */
448 struct snd_fasync;
449 
450 int snd_fasync_helper(int fd, struct file *file, int on,
451 		      struct snd_fasync **fasyncp);
452 void snd_kill_fasync(struct snd_fasync *fasync, int signal, int poll);
453 void snd_fasync_free(struct snd_fasync *fasync);
454 
455 #endif /* __SOUND_CORE_H */
456