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/workqueue.h> /* struct workqueue_struct */
29#include <linux/pm.h> /* pm_message_t */
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 int (*dev_unregister)(struct snd_device *dev);
75};
76
77struct snd_device {
78 struct list_head list; /* list of registered devices */
79 struct snd_card *card; /* card which holds this device */
80 snd_device_state_t state; /* state of the device */
81 snd_device_type_t type; /* device type */
82 void *device_data; /* device structure */
83 struct snd_device_ops *ops; /* operations */
84};
85
86#define snd_device(n) list_entry(n, struct snd_device, list)
87
88/* monitor files for graceful shutdown (hotplug) */
89
90struct snd_monitor_file {
91 struct file *file;
92 struct snd_monitor_file *next;
93};
94
95struct snd_shutdown_f_ops; /* define it later in init.c */
96
97/* main structure for soundcard */
98
99struct snd_card {
100 int number; /* number of soundcard (index to
101 snd_cards) */
102
103 char id[16]; /* id string of this card */
104 char driver[16]; /* driver name */
105 char shortname[32]; /* short name of this soundcard */
106 char longname[80]; /* name of this soundcard */
107 char mixername[80]; /* mixer name */
108 char components[80]; /* card components delimited with
109 space */
110 struct module *module; /* top-level module */
111
112 void *private_data; /* private data for soundcard */
113 void (*private_free) (struct snd_card *card); /* callback for freeing of
114 private data */
115 struct list_head devices; /* devices */
116
117 unsigned int last_numid; /* last used numeric ID */
118 struct rw_semaphore controls_rwsem; /* controls list lock */
119 rwlock_t ctl_files_rwlock; /* ctl_files list lock */
120 int controls_count; /* count of all controls */
121 int user_ctl_count; /* count of all user controls */
122 struct list_head controls; /* all controls for this card */
123 struct list_head ctl_files; /* active control files */
124
125 struct snd_info_entry *proc_root; /* root for soundcard specific files */
126 struct snd_info_entry *proc_id; /* the card id */
127 struct proc_dir_entry *proc_root_link; /* number link to real id */
128
129 struct snd_monitor_file *files; /* all files associated to this card */
130 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
131 state */
132 spinlock_t files_lock; /* lock the files for this card */
133 int shutdown; /* this card is going down */
134 wait_queue_head_t shutdown_sleep;
135 struct work_struct free_workq; /* for free in workqueue */
136 struct device *dev;
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) 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};
192
193/* sound.c */
194
195extern int snd_major;
196extern int snd_ecards_limit;
197
198void snd_request_card(int card);
199
200int snd_register_device(int type, struct snd_card *card, int dev,
201 const struct file_operations *f_ops, void *private_data,
202 const char *name);
203int snd_unregister_device(int type, struct snd_card *card, int dev);
204void *snd_lookup_minor_data(unsigned int minor, int type);
205
206#ifdef CONFIG_SND_OSSEMUL
207int snd_register_oss_device(int type, struct snd_card *card, int dev,
208 const struct file_operations *f_ops, void *private_data,
209 const char *name);
210int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
211void *snd_lookup_oss_minor_data(unsigned int minor, int type);
212#endif
213
214int snd_minor_info_init(void);
215int snd_minor_info_done(void);
216
217/* sound_oss.c */
218
219#ifdef CONFIG_SND_OSSEMUL
220int snd_minor_info_oss_init(void);
221int snd_minor_info_oss_done(void);
222#else
223#define snd_minor_info_oss_init() /*NOP*/
224#define snd_minor_info_oss_done() /*NOP*/
225#endif
226
227/* memory.c */
228
229int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
230int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
231
232/* init.c */
233
234extern struct snd_card *snd_cards[SNDRV_CARDS];
235int snd_card_locked(int card);
236#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
237#define SND_MIXER_OSS_NOTIFY_REGISTER 0
238#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
239#define SND_MIXER_OSS_NOTIFY_FREE 2
240extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
241#endif
242
243struct snd_card *snd_card_new(int idx, const char *id,
244 struct module *module, int extra_size);
245int snd_card_disconnect(struct snd_card *card);
246int snd_card_free(struct snd_card *card);
247int snd_card_free_in_thread(struct snd_card *card);
248int snd_card_register(struct snd_card *card);
249int snd_card_info_init(void);
250int snd_card_info_done(void);
251int snd_component_add(struct snd_card *card, const char *component);
252int snd_card_file_add(struct snd_card *card, struct file *file);
253int snd_card_file_remove(struct snd_card *card, struct file *file);
254
255#ifndef snd_card_set_dev
256#define snd_card_set_dev(card,devptr) ((card)->dev = (devptr))
257#endif
258
259/* device.c */
260
261int snd_device_new(struct snd_card *card, snd_device_type_t type,
262 void *device_data, struct snd_device_ops *ops);
263int snd_device_register(struct snd_card *card, void *device_data);
264int snd_device_register_all(struct snd_card *card);
265int snd_device_disconnect(struct snd_card *card, void *device_data);
266int snd_device_disconnect_all(struct snd_card *card);
267int snd_device_free(struct snd_card *card, void *device_data);
268int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
269
270/* isadma.c */
271
272#ifdef CONFIG_ISA_DMA_API
273#define DMA_MODE_NO_ENABLE 0x0100
274
275void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
276void snd_dma_disable(unsigned long dma);
277unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
278#endif
279
280/* misc.c */
281struct resource;
282void release_and_free_resource(struct resource *res);
283
284#ifdef CONFIG_SND_VERBOSE_PRINTK
285void snd_verbose_printk(const char *file, int line, const char *format, ...)
286 __attribute__ ((format (printf, 3, 4)));
287#endif
288#if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK)
289void snd_verbose_printd(const char *file, int line, const char *format, ...)
290 __attribute__ ((format (printf, 3, 4)));
291#endif
292
293/* --- */
294
295#ifdef CONFIG_SND_VERBOSE_PRINTK
296/**
297 * snd_printk - printk wrapper
298 * @fmt: format string
299 *
300 * Works like print() but prints the file and the line of the caller
301 * when configured with CONFIG_SND_VERBOSE_PRINTK.
302 */
303#define snd_printk(fmt, args...) \
304 snd_verbose_printk(__FILE__, __LINE__, fmt ,##args)
305#else
306#define snd_printk(fmt, args...) \
307 printk(fmt ,##args)
308#endif
309
310#ifdef CONFIG_SND_DEBUG
311
312#define __ASTRING__(x) #x
313
314#ifdef CONFIG_SND_VERBOSE_PRINTK
315/**
316 * snd_printd - debug printk
317 * @fmt: format string
318 *
319 * Compiled only when Works like snd_printk() for debugging purpose.
320 * Ignored when CONFIG_SND_DEBUG is not set.
321 */
322#define snd_printd(fmt, args...) \
323 snd_verbose_printd(__FILE__, __LINE__, fmt ,##args)
324#else
325#define snd_printd(fmt, args...) \
326 printk(fmt ,##args)
327#endif
328/**
329 * snd_assert - run-time assertion macro
330 * @expr: expression
331 *
332 * This macro checks the expression in run-time and invokes the commands
333 * given in the rest arguments if the assertion is failed.
334 * When CONFIG_SND_DEBUG is not set, the expression is executed but
335 * not checked.
336 */
337#define snd_assert(expr, args...) do { \
338 if (unlikely(!(expr))) { \
339 snd_printk(KERN_ERR "BUG? (%s)\n", __ASTRING__(expr)); \
340 dump_stack(); \
341 args; \
342 } \
343} while (0)
344
345#define snd_BUG() do { \
346 snd_printk(KERN_ERR "BUG?\n"); \
347 dump_stack(); \
348} while (0)
349
350#else /* !CONFIG_SND_DEBUG */
351
352#define snd_printd(fmt, args...) /* nothing */
353#define snd_assert(expr, args...) (void)(expr)
354#define snd_BUG() /* nothing */
355
356#endif /* CONFIG_SND_DEBUG */
357
358#ifdef CONFIG_SND_DEBUG_DETECT
359/**
360 * snd_printdd - debug printk
361 * @format: format string
362 *
363 * Compiled only when Works like snd_printk() for debugging purpose.
364 * Ignored when CONFIG_SND_DEBUG_DETECT is not set.
365 */
366#define snd_printdd(format, args...) snd_printk(format, ##args)
367#else
368#define snd_printdd(format, args...) /* nothing */
369#endif
370
371
372#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
373
374/* for easier backward-porting */
375#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
376#ifndef gameport_set_dev_parent
377#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
378#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
379#define gameport_get_port_data(gp) (gp)->port_data
380#endif
381#endif
382
383#include "typedefs.h"
384
385#endif /* __SOUND_CORE_H */