Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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@suse.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/sched.h> /* wake_up() */
26#include <linux/mutex.h> /* struct mutex */
27#include <linux/rwsem.h> /* struct rw_semaphore */
28#include <linux/pm.h> /* pm_message_t */
29#include <linux/device.h>
30
31/* forward declarations */
32#ifdef CONFIG_PCI
33struct pci_dev;
34#endif
35#ifdef CONFIG_SBUS
36struct sbus_dev;
37#endif
38
39/* device allocation stuff */
40
41#define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000
42
43typedef int __bitwise snd_device_type_t;
44#define SNDRV_DEV_TOPLEVEL ((__force snd_device_type_t) 0)
45#define SNDRV_DEV_CONTROL ((__force snd_device_type_t) 1)
46#define SNDRV_DEV_LOWLEVEL_PRE ((__force snd_device_type_t) 2)
47#define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
48#define SNDRV_DEV_PCM ((__force snd_device_type_t) 0x1001)
49#define SNDRV_DEV_RAWMIDI ((__force snd_device_type_t) 0x1002)
50#define SNDRV_DEV_TIMER ((__force snd_device_type_t) 0x1003)
51#define SNDRV_DEV_SEQUENCER ((__force snd_device_type_t) 0x1004)
52#define SNDRV_DEV_HWDEP ((__force snd_device_type_t) 0x1005)
53#define SNDRV_DEV_INFO ((__force snd_device_type_t) 0x1006)
54#define SNDRV_DEV_BUS ((__force snd_device_type_t) 0x1007)
55#define SNDRV_DEV_CODEC ((__force snd_device_type_t) 0x1008)
56#define SNDRV_DEV_LOWLEVEL ((__force snd_device_type_t) 0x2000)
57
58typedef int __bitwise snd_device_state_t;
59#define SNDRV_DEV_BUILD ((__force snd_device_state_t) 0)
60#define SNDRV_DEV_REGISTERED ((__force snd_device_state_t) 1)
61#define SNDRV_DEV_DISCONNECTED ((__force snd_device_state_t) 2)
62
63typedef int __bitwise snd_device_cmd_t;
64#define SNDRV_DEV_CMD_PRE ((__force snd_device_cmd_t) 0)
65#define SNDRV_DEV_CMD_NORMAL ((__force snd_device_cmd_t) 1)
66#define SNDRV_DEV_CMD_POST ((__force snd_device_cmd_t) 2)
67
68struct snd_device;
69
70struct snd_device_ops {
71 int (*dev_free)(struct snd_device *dev);
72 int (*dev_register)(struct snd_device *dev);
73 int (*dev_disconnect)(struct snd_device *dev);
74};
75
76struct snd_device {
77 struct list_head list; /* list of registered devices */
78 struct snd_card *card; /* card which holds this device */
79 snd_device_state_t state; /* state of the device */
80 snd_device_type_t type; /* device type */
81 void *device_data; /* device structure */
82 struct snd_device_ops *ops; /* operations */
83};
84
85#define snd_device(n) list_entry(n, struct snd_device, list)
86
87/* monitor files for graceful shutdown (hotplug) */
88
89struct snd_monitor_file {
90 struct file *file;
91 struct snd_monitor_file *next;
92 const struct file_operations *disconnected_f_op;
93 struct list_head shutdown_list;
94};
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[80]; /* 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 snd_monitor_file *files; /* 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#ifndef CONFIG_SYSFS_DEPRECATED
137 struct device *card_dev; /* cardX object for sysfs */
138#endif
139
140#ifdef CONFIG_PM
141 unsigned int power_state; /* power state */
142 struct mutex power_lock; /* power lock */
143 wait_queue_head_t power_sleep;
144#endif
145
146#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
147 struct snd_mixer_oss *mixer_oss;
148 int mixer_oss_change_count;
149#endif
150};
151
152#ifdef CONFIG_PM
153static inline void snd_power_lock(struct snd_card *card)
154{
155 mutex_lock(&card->power_lock);
156}
157
158static inline void snd_power_unlock(struct snd_card *card)
159{
160 mutex_unlock(&card->power_lock);
161}
162
163static inline unsigned int snd_power_get_state(struct snd_card *card)
164{
165 return card->power_state;
166}
167
168static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
169{
170 card->power_state = state;
171 wake_up(&card->power_sleep);
172}
173
174/* init.c */
175int snd_power_wait(struct snd_card *card, unsigned int power_state);
176
177#else /* ! CONFIG_PM */
178
179#define snd_power_lock(card) do { (void)(card); } while (0)
180#define snd_power_unlock(card) do { (void)(card); } while (0)
181static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
182#define snd_power_get_state(card) SNDRV_CTL_POWER_D0
183#define snd_power_change_state(card, state) do { (void)(card); } while (0)
184
185#endif /* CONFIG_PM */
186
187struct snd_minor {
188 int type; /* SNDRV_DEVICE_TYPE_XXX */
189 int card; /* card number */
190 int device; /* device number */
191 const struct file_operations *f_ops; /* file operations */
192 void *private_data; /* private data for f_ops->open */
193 struct device *dev; /* device for sysfs */
194};
195
196/* return a device pointer linked to each sound device as a parent */
197static inline struct device *snd_card_get_device_link(struct snd_card *card)
198{
199#ifdef CONFIG_SYSFS_DEPRECATED
200 return card ? card->dev : NULL;
201#else
202 return card ? card->card_dev : NULL;
203#endif
204}
205
206/* sound.c */
207
208extern int snd_major;
209extern int snd_ecards_limit;
210extern struct class *sound_class;
211
212void snd_request_card(int card);
213
214int snd_register_device(int type, struct snd_card *card, int dev,
215 const struct file_operations *f_ops, void *private_data,
216 const char *name);
217int snd_unregister_device(int type, struct snd_card *card, int dev);
218void *snd_lookup_minor_data(unsigned int minor, int type);
219int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
220 struct device_attribute *attr);
221
222#ifdef CONFIG_SND_OSSEMUL
223int snd_register_oss_device(int type, struct snd_card *card, int dev,
224 const struct file_operations *f_ops, void *private_data,
225 const char *name);
226int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
227void *snd_lookup_oss_minor_data(unsigned int minor, int type);
228#endif
229
230int snd_minor_info_init(void);
231int snd_minor_info_done(void);
232
233/* sound_oss.c */
234
235#ifdef CONFIG_SND_OSSEMUL
236int snd_minor_info_oss_init(void);
237int snd_minor_info_oss_done(void);
238#else
239#define snd_minor_info_oss_init() /*NOP*/
240#define snd_minor_info_oss_done() /*NOP*/
241#endif
242
243/* memory.c */
244
245int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
246int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
247
248/* init.c */
249
250extern struct snd_card *snd_cards[SNDRV_CARDS];
251int snd_card_locked(int card);
252#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
253#define SND_MIXER_OSS_NOTIFY_REGISTER 0
254#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
255#define SND_MIXER_OSS_NOTIFY_FREE 2
256extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
257#endif
258
259struct snd_card *snd_card_new(int idx, const char *id,
260 struct module *module, int extra_size);
261int snd_card_disconnect(struct snd_card *card);
262int snd_card_free(struct snd_card *card);
263int snd_card_free_when_closed(struct snd_card *card);
264int snd_card_register(struct snd_card *card);
265int snd_card_info_init(void);
266int snd_card_info_done(void);
267int snd_component_add(struct snd_card *card, const char *component);
268int snd_card_file_add(struct snd_card *card, struct file *file);
269int snd_card_file_remove(struct snd_card *card, struct file *file);
270
271#ifndef snd_card_set_dev
272#define snd_card_set_dev(card,devptr) ((card)->dev = (devptr))
273#endif
274
275/* device.c */
276
277int snd_device_new(struct snd_card *card, snd_device_type_t type,
278 void *device_data, struct snd_device_ops *ops);
279int snd_device_register(struct snd_card *card, void *device_data);
280int snd_device_register_all(struct snd_card *card);
281int snd_device_disconnect(struct snd_card *card, void *device_data);
282int snd_device_disconnect_all(struct snd_card *card);
283int snd_device_free(struct snd_card *card, void *device_data);
284int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
285
286/* isadma.c */
287
288#ifdef CONFIG_ISA_DMA_API
289#define DMA_MODE_NO_ENABLE 0x0100
290
291void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
292void snd_dma_disable(unsigned long dma);
293unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
294#endif
295
296/* misc.c */
297struct resource;
298void release_and_free_resource(struct resource *res);
299
300#ifdef CONFIG_SND_VERBOSE_PRINTK
301void snd_verbose_printk(const char *file, int line, const char *format, ...)
302 __attribute__ ((format (printf, 3, 4)));
303#endif
304#if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK)
305void snd_verbose_printd(const char *file, int line, const char *format, ...)
306 __attribute__ ((format (printf, 3, 4)));
307#endif
308
309/* --- */
310
311#ifdef CONFIG_SND_VERBOSE_PRINTK
312/**
313 * snd_printk - printk wrapper
314 * @fmt: format string
315 *
316 * Works like print() but prints the file and the line of the caller
317 * when configured with CONFIG_SND_VERBOSE_PRINTK.
318 */
319#define snd_printk(fmt, args...) \
320 snd_verbose_printk(__FILE__, __LINE__, fmt ,##args)
321#else
322#define snd_printk(fmt, args...) \
323 printk(fmt ,##args)
324#endif
325
326#ifdef CONFIG_SND_DEBUG
327
328#define __ASTRING__(x) #x
329
330#ifdef CONFIG_SND_VERBOSE_PRINTK
331/**
332 * snd_printd - debug printk
333 * @fmt: format string
334 *
335 * Compiled only when Works like snd_printk() for debugging purpose.
336 * Ignored when CONFIG_SND_DEBUG is not set.
337 */
338#define snd_printd(fmt, args...) \
339 snd_verbose_printd(__FILE__, __LINE__, fmt ,##args)
340#else
341#define snd_printd(fmt, args...) \
342 printk(fmt ,##args)
343#endif
344/**
345 * snd_assert - run-time assertion macro
346 * @expr: expression
347 *
348 * This macro checks the expression in run-time and invokes the commands
349 * given in the rest arguments if the assertion is failed.
350 * When CONFIG_SND_DEBUG is not set, the expression is executed but
351 * not checked.
352 */
353#define snd_assert(expr, args...) do { \
354 if (unlikely(!(expr))) { \
355 snd_printk(KERN_ERR "BUG? (%s)\n", __ASTRING__(expr)); \
356 dump_stack(); \
357 args; \
358 } \
359} while (0)
360
361#define snd_BUG() do { \
362 snd_printk(KERN_ERR "BUG?\n"); \
363 dump_stack(); \
364} while (0)
365
366#else /* !CONFIG_SND_DEBUG */
367
368#define snd_printd(fmt, args...) /* nothing */
369#define snd_assert(expr, args...) (void)(expr)
370#define snd_BUG() /* nothing */
371
372#endif /* CONFIG_SND_DEBUG */
373
374#ifdef CONFIG_SND_DEBUG_DETECT
375/**
376 * snd_printdd - debug printk
377 * @format: format string
378 *
379 * Compiled only when Works like snd_printk() for debugging purpose.
380 * Ignored when CONFIG_SND_DEBUG_DETECT is not set.
381 */
382#define snd_printdd(format, args...) snd_printk(format, ##args)
383#else
384#define snd_printdd(format, args...) /* nothing */
385#endif
386
387
388#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
389
390/* for easier backward-porting */
391#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
392#ifndef gameport_set_dev_parent
393#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
394#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
395#define gameport_get_port_data(gp) (gp)->port_data
396#endif
397#endif
398
399#include "typedefs.h"
400
401#endif /* __SOUND_CORE_H */