xref: /openbmc/linux/include/sound/core.h (revision aac5987a)
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_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 
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 	struct mutex user_ctl_lock;	/* protects user controls against
122 					   concurrent access */
123 
124 	struct snd_info_entry *proc_root;	/* root for soundcard specific files */
125 	struct snd_info_entry *proc_id;	/* the card id */
126 	struct proc_dir_entry *proc_root_link;	/* number link to real id */
127 
128 	struct list_head files_list;	/* all files associated to this card */
129 	struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
130 								state */
131 	spinlock_t files_lock;		/* lock the files for this card */
132 	int shutdown;			/* this card is going down */
133 	struct completion *release_completion;
134 	struct device *dev;		/* device assigned to this card */
135 	struct device card_dev;		/* cardX object for sysfs */
136 	const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
137 	bool registered;		/* card_dev is registered? */
138 
139 #ifdef CONFIG_PM
140 	unsigned int power_state;	/* power state */
141 	struct mutex power_lock;	/* 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
154 static inline void snd_power_lock(struct snd_card *card)
155 {
156 	mutex_lock(&card->power_lock);
157 }
158 
159 static inline void snd_power_unlock(struct snd_card *card)
160 {
161 	mutex_unlock(&card->power_lock);
162 }
163 
164 static inline unsigned int snd_power_get_state(struct snd_card *card)
165 {
166 	return card->power_state;
167 }
168 
169 static 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 /* init.c */
176 int snd_power_wait(struct snd_card *card, unsigned int power_state);
177 
178 #else /* ! CONFIG_PM */
179 
180 #define snd_power_lock(card)		do { (void)(card); } while (0)
181 #define snd_power_unlock(card)		do { (void)(card); } while (0)
182 static 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 /* CONFIG_PM */
187 
188 struct snd_minor {
189 	int type;			/* SNDRV_DEVICE_TYPE_XXX */
190 	int card;			/* card number */
191 	int device;			/* device number */
192 	const struct file_operations *f_ops;	/* file operations */
193 	void *private_data;		/* private data for f_ops->open */
194 	struct device *dev;		/* device for sysfs */
195 	struct snd_card *card_ptr;	/* assigned card instance */
196 };
197 
198 /* return a device pointer linked to each sound device as a parent */
199 static inline struct device *snd_card_get_device_link(struct snd_card *card)
200 {
201 	return card ? &card->card_dev : NULL;
202 }
203 
204 /* sound.c */
205 
206 extern int snd_major;
207 extern int snd_ecards_limit;
208 extern struct class *sound_class;
209 
210 void snd_request_card(int card);
211 
212 void snd_device_initialize(struct device *dev, struct snd_card *card);
213 
214 int 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);
217 int snd_unregister_device(struct device *dev);
218 void *snd_lookup_minor_data(unsigned int minor, int type);
219 
220 #ifdef CONFIG_SND_OSSEMUL
221 int snd_register_oss_device(int type, struct snd_card *card, int dev,
222 			    const struct file_operations *f_ops, void *private_data);
223 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
224 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
225 #endif
226 
227 int snd_minor_info_init(void);
228 
229 /* sound_oss.c */
230 
231 #ifdef CONFIG_SND_OSSEMUL
232 int snd_minor_info_oss_init(void);
233 #else
234 static inline int snd_minor_info_oss_init(void) { return 0; }
235 #endif
236 
237 /* memory.c */
238 
239 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
240 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
241 
242 /* init.c */
243 
244 extern struct snd_card *snd_cards[SNDRV_CARDS];
245 int 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
250 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
251 #endif
252 
253 int 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 
257 int snd_card_disconnect(struct snd_card *card);
258 int snd_card_free(struct snd_card *card);
259 int snd_card_free_when_closed(struct snd_card *card);
260 void snd_card_set_id(struct snd_card *card, const char *id);
261 int snd_card_register(struct snd_card *card);
262 int snd_card_info_init(void);
263 int snd_card_add_dev_attr(struct snd_card *card,
264 			  const struct attribute_group *group);
265 int snd_component_add(struct snd_card *card, const char *component);
266 int snd_card_file_add(struct snd_card *card, struct file *file);
267 int 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 /* device.c */
273 
274 int snd_device_new(struct snd_card *card, enum snd_device_type type,
275 		   void *device_data, struct snd_device_ops *ops);
276 int snd_device_register(struct snd_card *card, void *device_data);
277 int snd_device_register_all(struct snd_card *card);
278 void snd_device_disconnect(struct snd_card *card, void *device_data);
279 void snd_device_disconnect_all(struct snd_card *card);
280 void snd_device_free(struct snd_card *card, void *device_data);
281 void snd_device_free_all(struct snd_card *card);
282 
283 /* isadma.c */
284 
285 #ifdef CONFIG_ISA_DMA_API
286 #define DMA_MODE_NO_ENABLE	0x0100
287 
288 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
289 void snd_dma_disable(unsigned long dma);
290 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
291 #endif
292 
293 /* misc.c */
294 struct resource;
295 void release_and_free_resource(struct resource *res);
296 
297 /* --- */
298 
299 /* sound printk debug levels */
300 enum {
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)
308 void __snd_printk(unsigned int level, const char *file, int line,
309 		  const char *format, ...);
310 #else
311 #define __snd_printk(level, file, line, format, ...) \
312 	printk(format, ##__VA_ARGS__)
313 #endif
314 
315 /**
316  * snd_printk - printk wrapper
317  * @fmt: format string
318  *
319  * Works like printk() but prints the file and the line of the caller
320  * when configured with CONFIG_SND_VERBOSE_PRINTK.
321  */
322 #define snd_printk(fmt, ...) \
323 	__snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
324 
325 #ifdef CONFIG_SND_DEBUG
326 /**
327  * snd_printd - debug printk
328  * @fmt: format string
329  *
330  * Works like snd_printk() for debugging purposes.
331  * Ignored when CONFIG_SND_DEBUG is not set.
332  */
333 #define snd_printd(fmt, ...) \
334 	__snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
335 #define _snd_printd(level, fmt, ...) \
336 	__snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
337 
338 /**
339  * snd_BUG - give a BUG warning message and stack trace
340  *
341  * Calls WARN() if CONFIG_SND_DEBUG is set.
342  * Ignored when CONFIG_SND_DEBUG is not set.
343  */
344 #define snd_BUG()		WARN(1, "BUG?\n")
345 
346 /**
347  * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
348  */
349 #define snd_printd_ratelimit() printk_ratelimit()
350 
351 /**
352  * snd_BUG_ON - debugging check macro
353  * @cond: condition to evaluate
354  *
355  * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
356  * otherwise just evaluates the conditional and returns the value.
357  */
358 #define snd_BUG_ON(cond)	WARN_ON((cond))
359 
360 #else /* !CONFIG_SND_DEBUG */
361 
362 __printf(1, 2)
363 static inline void snd_printd(const char *format, ...) {}
364 __printf(2, 3)
365 static 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 
374 static inline bool snd_printd_ratelimit(void) { return false; }
375 
376 #endif /* CONFIG_SND_DEBUG */
377 
378 #ifdef CONFIG_SND_DEBUG_VERBOSE
379 /**
380  * snd_printdd - debug printk
381  * @format: format string
382  *
383  * Works like snd_printk() for debugging purposes.
384  * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
385  */
386 #define snd_printdd(format, ...) \
387 	__snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
388 #else
389 __printf(1, 2)
390 static inline void snd_printdd(const char *format, ...) {}
391 #endif
392 
393 
394 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))	/* 3.8.1a */
395 
396 /* for easier backward-porting */
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 /* PCI quirk list helper */
404 struct snd_pci_quirk {
405 	unsigned short subvendor;	/* PCI subvendor ID */
406 	unsigned short subdevice;	/* PCI subdevice ID */
407 	unsigned short subdevice_mask;	/* bitmask to match */
408 	int value;			/* value */
409 #ifdef CONFIG_SND_DEBUG_VERBOSE
410 	const char *name;		/* name of the device (optional) */
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
439 const struct snd_pci_quirk *
440 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
441 
442 const struct snd_pci_quirk *
443 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
444 			const struct snd_pci_quirk *list);
445 #else
446 static inline const struct snd_pci_quirk *
447 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
448 {
449 	return NULL;
450 }
451 
452 static inline const struct snd_pci_quirk *
453 snd_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 /* __SOUND_CORE_H */
461