Linux Audio

Check our new training course

Loading...
v3.1
  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/module.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/device.h>
 31#include <linux/stringify.h>
 
 32
 33/* number of supported soundcards */
 34#ifdef CONFIG_SND_DYNAMIC_MINORS
 35#define SNDRV_CARDS 32
 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#ifdef CONFIG_PCI
 44struct pci_dev;
 45#endif
 
 46
 47/* device allocation stuff */
 48
 49#define SNDRV_DEV_TYPE_RANGE_SIZE		0x1000
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 50
 51typedef int __bitwise snd_device_type_t;
 52#define	SNDRV_DEV_TOPLEVEL	((__force snd_device_type_t) 0)
 53#define	SNDRV_DEV_CONTROL	((__force snd_device_type_t) 1)
 54#define	SNDRV_DEV_LOWLEVEL_PRE	((__force snd_device_type_t) 2)
 55#define	SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
 56#define	SNDRV_DEV_PCM		((__force snd_device_type_t) 0x1001)
 57#define	SNDRV_DEV_RAWMIDI	((__force snd_device_type_t) 0x1002)
 58#define	SNDRV_DEV_TIMER		((__force snd_device_type_t) 0x1003)
 59#define	SNDRV_DEV_SEQUENCER	((__force snd_device_type_t) 0x1004)
 60#define	SNDRV_DEV_HWDEP		((__force snd_device_type_t) 0x1005)
 61#define	SNDRV_DEV_INFO		((__force snd_device_type_t) 0x1006)
 62#define	SNDRV_DEV_BUS		((__force snd_device_type_t) 0x1007)
 63#define	SNDRV_DEV_CODEC		((__force snd_device_type_t) 0x1008)
 64#define	SNDRV_DEV_JACK          ((__force snd_device_type_t) 0x1009)
 65#define	SNDRV_DEV_LOWLEVEL	((__force snd_device_type_t) 0x2000)
 66
 67typedef int __bitwise snd_device_state_t;
 68#define	SNDRV_DEV_BUILD		((__force snd_device_state_t) 0)
 69#define	SNDRV_DEV_REGISTERED	((__force snd_device_state_t) 1)
 70#define	SNDRV_DEV_DISCONNECTED	((__force snd_device_state_t) 2)
 71
 72typedef int __bitwise snd_device_cmd_t;
 73#define	SNDRV_DEV_CMD_PRE	((__force snd_device_cmd_t) 0)
 74#define	SNDRV_DEV_CMD_NORMAL	((__force snd_device_cmd_t) 1)	
 75#define	SNDRV_DEV_CMD_POST	((__force snd_device_cmd_t) 2)
 76
 77struct snd_device;
 78
 79struct snd_device_ops {
 80	int (*dev_free)(struct snd_device *dev);
 81	int (*dev_register)(struct snd_device *dev);
 82	int (*dev_disconnect)(struct snd_device *dev);
 83};
 84
 85struct snd_device {
 86	struct list_head list;		/* list of registered devices */
 87	struct snd_card *card;		/* card which holds this device */
 88	snd_device_state_t state;	/* state of the device */
 89	snd_device_type_t type;		/* device type */
 90	void *device_data;		/* device structure */
 91	struct snd_device_ops *ops;	/* operations */
 92};
 93
 94#define snd_device(n) list_entry(n, struct snd_device, list)
 95
 96/* main structure for soundcard */
 97
 98struct snd_card {
 99	int number;			/* number of soundcard (index to
100								snd_cards) */
101
102	char id[16];			/* id string of this card */
103	char driver[16];		/* driver name */
104	char shortname[32];		/* short name of this soundcard */
105	char longname[80];		/* name of this soundcard */
 
106	char mixername[80];		/* mixer name */
107	char components[128];		/* card components delimited with
108								space */
109	struct module *module;		/* top-level module */
110
111	void *private_data;		/* private data for soundcard */
112	void (*private_free) (struct snd_card *card); /* callback for freeing of
113								private data */
114	struct list_head devices;	/* devices */
115
 
116	unsigned int last_numid;	/* last used numeric ID */
117	struct rw_semaphore controls_rwsem;	/* controls list lock */
118	rwlock_t ctl_files_rwlock;	/* ctl_files list lock */
119	int controls_count;		/* count of all controls */
120	int user_ctl_count;		/* count of all user controls */
121	struct list_head controls;	/* all controls for this card */
122	struct list_head ctl_files;	/* active control files */
 
 
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	int free_on_last_close;		/* free in context of file_release */
134	wait_queue_head_t shutdown_sleep;
135	struct device *dev;		/* device assigned to this card */
136	struct device *card_dev;	/* cardX object for sysfs */
 
 
137
138#ifdef CONFIG_PM
139	unsigned int power_state;	/* power state */
140	struct mutex power_lock;	/* power lock */
141	wait_queue_head_t power_sleep;
142#endif
143
144#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
145	struct snd_mixer_oss *mixer_oss;
146	int mixer_oss_change_count;
147#endif
148};
149
 
 
150#ifdef CONFIG_PM
151static inline void snd_power_lock(struct snd_card *card)
152{
153	mutex_lock(&card->power_lock);
154}
155
156static inline void snd_power_unlock(struct snd_card *card)
157{
158	mutex_unlock(&card->power_lock);
159}
160
161static inline unsigned int snd_power_get_state(struct snd_card *card)
162{
163	return card->power_state;
164}
165
166static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
167{
168	card->power_state = state;
169	wake_up(&card->power_sleep);
170}
171
172/* init.c */
173int snd_power_wait(struct snd_card *card, unsigned int power_state);
174
175#else /* ! CONFIG_PM */
176
177#define snd_power_lock(card)		do { (void)(card); } while (0)
178#define snd_power_unlock(card)		do { (void)(card); } while (0)
179static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
180#define snd_power_get_state(card)	({ (void)(card); SNDRV_CTL_POWER_D0; })
181#define snd_power_change_state(card, state)	do { (void)(card); } while (0)
182
183#endif /* CONFIG_PM */
184
185struct snd_minor {
186	int type;			/* SNDRV_DEVICE_TYPE_XXX */
187	int card;			/* card number */
188	int device;			/* device number */
189	const struct file_operations *f_ops;	/* file operations */
190	void *private_data;		/* private data for f_ops->open */
191	struct device *dev;		/* device for sysfs */
 
192};
193
194/* return a device pointer linked to each sound device as a parent */
195static inline struct device *snd_card_get_device_link(struct snd_card *card)
196{
197	return card ? card->card_dev : NULL;
198}
199
200/* sound.c */
201
202extern int snd_major;
203extern int snd_ecards_limit;
204extern struct class *sound_class;
205
206void snd_request_card(int card);
207
208int snd_register_device_for_dev(int type, struct snd_card *card,
209				int dev,
210				const struct file_operations *f_ops,
211				void *private_data,
212				const char *name,
213				struct device *device);
214
215/**
216 * snd_register_device - Register the ALSA device file for the card
217 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
218 * @card: the card instance
219 * @dev: the device index
220 * @f_ops: the file operations
221 * @private_data: user pointer for f_ops->open()
222 * @name: the device file name
223 *
224 * Registers an ALSA device file for the given card.
225 * The operators have to be set in reg parameter.
226 *
227 * This function uses the card's device pointer to link to the
228 * correct &struct device.
229 *
230 * Returns zero if successful, or a negative error code on failure.
231 */
232static inline int snd_register_device(int type, struct snd_card *card, int dev,
233				      const struct file_operations *f_ops,
234				      void *private_data,
235				      const char *name)
236{
237	return snd_register_device_for_dev(type, card, dev, f_ops,
238					   private_data, name,
239					   snd_card_get_device_link(card));
240}
241
242int snd_unregister_device(int type, struct snd_card *card, int dev);
 
 
 
243void *snd_lookup_minor_data(unsigned int minor, int type);
244int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
245			      struct device_attribute *attr);
246
247#ifdef CONFIG_SND_OSSEMUL
248int snd_register_oss_device(int type, struct snd_card *card, int dev,
249			    const struct file_operations *f_ops, void *private_data,
250			    const char *name);
251int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
252void *snd_lookup_oss_minor_data(unsigned int minor, int type);
253#endif
254
255int snd_minor_info_init(void);
256int snd_minor_info_done(void);
257
258/* sound_oss.c */
259
260#ifdef CONFIG_SND_OSSEMUL
261int snd_minor_info_oss_init(void);
262int snd_minor_info_oss_done(void);
263#else
264static inline int snd_minor_info_oss_init(void) { return 0; }
265static inline int snd_minor_info_oss_done(void) { return 0; }
266#endif
267
268/* memory.c */
269
270int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
271int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
272
273/* init.c */
274
275extern struct snd_card *snd_cards[SNDRV_CARDS];
276int snd_card_locked(int card);
277#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
278#define SND_MIXER_OSS_NOTIFY_REGISTER	0
279#define SND_MIXER_OSS_NOTIFY_DISCONNECT	1
280#define SND_MIXER_OSS_NOTIFY_FREE	2
281extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
282#endif
283
284int snd_card_create(int idx, const char *id,
285		    struct module *module, int extra_size,
286		    struct snd_card **card_ret);
287
288int snd_card_disconnect(struct snd_card *card);
289int snd_card_free(struct snd_card *card);
290int snd_card_free_when_closed(struct snd_card *card);
291void snd_card_set_id(struct snd_card *card, const char *id);
292int snd_card_register(struct snd_card *card);
293int snd_card_info_init(void);
294int snd_card_info_done(void);
 
295int snd_component_add(struct snd_card *card, const char *component);
296int snd_card_file_add(struct snd_card *card, struct file *file);
297int snd_card_file_remove(struct snd_card *card, struct file *file);
 
298
299#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
300
301/* device.c */
302
303int snd_device_new(struct snd_card *card, snd_device_type_t type,
304		   void *device_data, struct snd_device_ops *ops);
305int snd_device_register(struct snd_card *card, void *device_data);
306int snd_device_register_all(struct snd_card *card);
307int snd_device_disconnect(struct snd_card *card, void *device_data);
308int snd_device_disconnect_all(struct snd_card *card);
309int snd_device_free(struct snd_card *card, void *device_data);
310int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
311
312/* isadma.c */
313
314#ifdef CONFIG_ISA_DMA_API
315#define DMA_MODE_NO_ENABLE	0x0100
316
317void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
318void snd_dma_disable(unsigned long dma);
319unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
320#endif
321
322/* misc.c */
323struct resource;
324void release_and_free_resource(struct resource *res);
325
326/* --- */
327
 
 
 
 
 
 
 
328#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
 
329void __snd_printk(unsigned int level, const char *file, int line,
330		  const char *format, ...)
331     __attribute__ ((format (printf, 4, 5)));
332#else
333#define __snd_printk(level, file, line, format, args...) \
334	printk(format, ##args)
335#endif
336
337/**
338 * snd_printk - printk wrapper
339 * @fmt: format string
340 *
341 * Works like printk() but prints the file and the line of the caller
342 * when configured with CONFIG_SND_VERBOSE_PRINTK.
343 */
344#define snd_printk(fmt, args...) \
345	__snd_printk(0, __FILE__, __LINE__, fmt, ##args)
346
347#ifdef CONFIG_SND_DEBUG
348/**
349 * snd_printd - debug printk
350 * @fmt: format string
351 *
352 * Works like snd_printk() for debugging purposes.
353 * Ignored when CONFIG_SND_DEBUG is not set.
354 */
355#define snd_printd(fmt, args...) \
356	__snd_printk(1, __FILE__, __LINE__, fmt, ##args)
 
 
357
358/**
359 * snd_BUG - give a BUG warning message and stack trace
360 *
361 * Calls WARN() if CONFIG_SND_DEBUG is set.
362 * Ignored when CONFIG_SND_DEBUG is not set.
363 */
364#define snd_BUG()		WARN(1, "BUG?\n")
365
366/**
 
 
 
 
 
367 * snd_BUG_ON - debugging check macro
368 * @cond: condition to evaluate
369 *
370 * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,
371 * and call WARN() and returns the value if it's non-zero.
372 * 
373 * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given
374 * condition is ignored.
375 *
376 * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.
377 * Thus, don't put any statement that influences on the code behavior,
378 * such as pre/post increment, to the argument of this macro.
379 * If you want to evaluate and give a warning, use standard WARN_ON().
380 */
381#define snd_BUG_ON(cond)	WARN((cond), "BUG? (%s)\n", __stringify(cond))
382
383#else /* !CONFIG_SND_DEBUG */
384
385#define snd_printd(fmt, args...)	do { } while (0)
 
 
 
 
386#define snd_BUG()			do { } while (0)
387static inline int __snd_bug_on(int cond)
388{
389	return 0;
390}
391#define snd_BUG_ON(cond)	__snd_bug_on(0 && (cond))  /* always false */
 
 
392
393#endif /* CONFIG_SND_DEBUG */
394
395#ifdef CONFIG_SND_DEBUG_VERBOSE
396/**
397 * snd_printdd - debug printk
398 * @format: format string
399 *
400 * Works like snd_printk() for debugging purposes.
401 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
402 */
403#define snd_printdd(format, args...) \
404	__snd_printk(2, __FILE__, __LINE__, format, ##args)
405#else
406#define snd_printdd(format, args...)	do { } while (0)
 
407#endif
408
409
410#define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))	/* 3.8.1a */
411
412/* for easier backward-porting */
413#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
414#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
415#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
416#define gameport_get_port_data(gp) (gp)->port_data
417#endif
418
419/* PCI quirk list helper */
420struct snd_pci_quirk {
421	unsigned short subvendor;	/* PCI subvendor ID */
422	unsigned short subdevice;	/* PCI subdevice ID */
423	unsigned short subdevice_mask;	/* bitmask to match */
424	int value;			/* value */
425#ifdef CONFIG_SND_DEBUG_VERBOSE
426	const char *name;		/* name of the device (optional) */
427#endif
428};
429
430#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev)	\
431	.subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
432#define _SND_PCI_QUIRK_ID(vend, dev) \
433	_SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
434#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
435#ifdef CONFIG_SND_DEBUG_VERBOSE
436#define SND_PCI_QUIRK(vend,dev,xname,val) \
437	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
438#define SND_PCI_QUIRK_VENDOR(vend, xname, val)			\
439	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
440#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)			\
441	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),			\
442			.value = (val), .name = (xname)}
 
443#else
444#define SND_PCI_QUIRK(vend,dev,xname,val) \
445	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
446#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)			\
447	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
448#define SND_PCI_QUIRK_VENDOR(vend, xname, val)			\
449	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
 
450#endif
451
 
452const struct snd_pci_quirk *
453snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
454
455const struct snd_pci_quirk *
456snd_pci_quirk_lookup_id(u16 vendor, u16 device,
457			const struct snd_pci_quirk *list);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
458
459#endif /* __SOUND_CORE_H */
v4.10.11
  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 */
 
 43struct pci_dev;
 44struct module;
 45struct completion;
 46
 47/* device allocation stuff */
 48
 49/* type of the object used in snd_device_*()
 50 * this also defines the calling order
 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;		/* 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
 94struct 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
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/* init.c */
176int 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)
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 /* CONFIG_PM */
187
188struct 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 */
199static 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
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/* sound_oss.c */
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/* memory.c */
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/* init.c */
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/* device.c */
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/* isadma.c */
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/* misc.c */
294struct resource;
295void release_and_free_resource(struct resource *res);
296
297/* --- */
298
299/* sound printk debug levels */
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, ...) \
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)
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 /* 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)
390static 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 */
404struct 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
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 /* __SOUND_CORE_H */