~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/sound/core.h

Version: ~ [ linux-5.4-rc3 ] ~ [ linux-5.3.6 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.79 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.149 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.196 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.196 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.75 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  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/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/stringify.h>
 30 #include <linux/printk.h>
 31 
 32 /* number of supported soundcards */
 33 #ifdef CONFIG_SND_DYNAMIC_MINORS
 34 #define SNDRV_CARDS CONFIG_SND_MAX_CARDS
 35 #else
 36 #define SNDRV_CARDS 8           /* don't change - minor numbers */
 37 #endif
 38 
 39 #define CONFIG_SND_MAJOR        116     /* standard configuration */
 40 
 41 /* forward declarations */
 42 struct pci_dev;
 43 struct module;
 44 struct device;
 45 struct device_attribute;
 46 
 47 /* device allocation stuff */
 48 
 49 #define SNDRV_DEV_TYPE_RANGE_SIZE               0x1000
 50 
 51 typedef 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_COMPRESS      ((__force snd_device_type_t) 0x100A)
 66 #define SNDRV_DEV_LOWLEVEL      ((__force snd_device_type_t) 0x2000)
 67 
 68 typedef int __bitwise snd_device_state_t;
 69 #define SNDRV_DEV_BUILD         ((__force snd_device_state_t) 0)
 70 #define SNDRV_DEV_REGISTERED    ((__force snd_device_state_t) 1)
 71 #define SNDRV_DEV_DISCONNECTED  ((__force snd_device_state_t) 2)
 72 
 73 typedef int __bitwise snd_device_cmd_t;
 74 #define SNDRV_DEV_CMD_PRE       ((__force snd_device_cmd_t) 0)
 75 #define SNDRV_DEV_CMD_NORMAL    ((__force snd_device_cmd_t) 1)  
 76 #define SNDRV_DEV_CMD_POST      ((__force snd_device_cmd_t) 2)
 77 
 78 struct snd_device;
 79 
 80 struct snd_device_ops {
 81         int (*dev_free)(struct snd_device *dev);
 82         int (*dev_register)(struct snd_device *dev);
 83         int (*dev_disconnect)(struct snd_device *dev);
 84 };
 85 
 86 struct snd_device {
 87         struct list_head list;          /* list of registered devices */
 88         struct snd_card *card;          /* card which holds this device */
 89         snd_device_state_t state;       /* state of the device */
 90         snd_device_type_t type;         /* device type */
 91         void *device_data;              /* device structure */
 92         struct snd_device_ops *ops;     /* operations */
 93 };
 94 
 95 #define snd_device(n) list_entry(n, struct snd_device, list)
 96 
 97 /* main structure for soundcard */
 98 
 99 struct 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[128];           /* 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         struct mutex user_ctl_lock;     /* protects user controls against
125                                            concurrent access */
126 
127         struct snd_info_entry *proc_root;       /* root for soundcard specific files */
128         struct snd_info_entry *proc_id; /* the card id */
129         struct proc_dir_entry *proc_root_link;  /* number link to real id */
130 
131         struct list_head files_list;    /* all files associated to this card */
132         struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
133                                                                 state */
134         spinlock_t files_lock;          /* lock the files for this card */
135         int shutdown;                   /* this card is going down */
136         int free_on_last_close;         /* free in context of file_release */
137         wait_queue_head_t shutdown_sleep;
138         atomic_t refcount;              /* refcount for disconnection */
139         struct device *dev;             /* device assigned to this card */
140         struct device *card_dev;        /* cardX object for sysfs */
141 
142 #ifdef CONFIG_PM
143         unsigned int power_state;       /* power state */
144         struct mutex power_lock;        /* power lock */
145         wait_queue_head_t power_sleep;
146 #endif
147 
148 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
149         struct snd_mixer_oss *mixer_oss;
150         int mixer_oss_change_count;
151 #endif
152 };
153 
154 #ifdef CONFIG_PM
155 static inline void snd_power_lock(struct snd_card *card)
156 {
157         mutex_lock(&card->power_lock);
158 }
159 
160 static inline void snd_power_unlock(struct snd_card *card)
161 {
162         mutex_unlock(&card->power_lock);
163 }
164 
165 static inline unsigned int snd_power_get_state(struct snd_card *card)
166 {
167         return card->power_state;
168 }
169 
170 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
171 {
172         card->power_state = state;
173         wake_up(&card->power_sleep);
174 }
175 
176 /* init.c */
177 int snd_power_wait(struct snd_card *card, unsigned int power_state);
178 
179 #else /* ! CONFIG_PM */
180 
181 #define snd_power_lock(card)            do { (void)(card); } while (0)
182 #define snd_power_unlock(card)          do { (void)(card); } while (0)
183 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
184 #define snd_power_get_state(card)       ({ (void)(card); SNDRV_CTL_POWER_D0; })
185 #define snd_power_change_state(card, state)     do { (void)(card); } while (0)
186 
187 #endif /* CONFIG_PM */
188 
189 struct snd_minor {
190         int type;                       /* SNDRV_DEVICE_TYPE_XXX */
191         int card;                       /* card number */
192         int device;                     /* device number */
193         const struct file_operations *f_ops;    /* file operations */
194         void *private_data;             /* private data for f_ops->open */
195         struct device *dev;             /* device for sysfs */
196         struct snd_card *card_ptr;      /* assigned card instance */
197 };
198 
199 /* return a device pointer linked to each sound device as a parent */
200 static inline struct device *snd_card_get_device_link(struct snd_card *card)
201 {
202         return card ? card->card_dev : NULL;
203 }
204 
205 /* sound.c */
206 
207 extern int snd_major;
208 extern int snd_ecards_limit;
209 extern struct class *sound_class;
210 
211 void snd_request_card(int card);
212 
213 int snd_register_device_for_dev(int type, struct snd_card *card,
214                                 int dev,
215                                 const struct file_operations *f_ops,
216                                 void *private_data,
217                                 const char *name,
218                                 struct device *device);
219 
220 /**
221  * snd_register_device - Register the ALSA device file for the card
222  * @type: the device type, SNDRV_DEVICE_TYPE_XXX
223  * @card: the card instance
224  * @dev: the device index
225  * @f_ops: the file operations
226  * @private_data: user pointer for f_ops->open()
227  * @name: the device file name
228  *
229  * Registers an ALSA device file for the given card.
230  * The operators have to be set in reg parameter.
231  *
232  * This function uses the card's device pointer to link to the
233  * correct &struct device.
234  *
235  * Return: Zero if successful, or a negative error code on failure.
236  */
237 static inline int snd_register_device(int type, struct snd_card *card, int dev,
238                                       const struct file_operations *f_ops,
239                                       void *private_data,
240                                       const char *name)
241 {
242         return snd_register_device_for_dev(type, card, dev, f_ops,
243                                            private_data, name,
244                                            snd_card_get_device_link(card));
245 }
246 
247 int snd_unregister_device(int type, struct snd_card *card, int dev);
248 void *snd_lookup_minor_data(unsigned int minor, int type);
249 int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
250                               struct device_attribute *attr);
251 
252 #ifdef CONFIG_SND_OSSEMUL
253 int snd_register_oss_device(int type, struct snd_card *card, int dev,
254                             const struct file_operations *f_ops, void *private_data,
255                             const char *name);
256 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
257 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
258 #endif
259 
260 int snd_minor_info_init(void);
261 int snd_minor_info_done(void);
262 
263 /* sound_oss.c */
264 
265 #ifdef CONFIG_SND_OSSEMUL
266 int snd_minor_info_oss_init(void);
267 int snd_minor_info_oss_done(void);
268 #else
269 static inline int snd_minor_info_oss_init(void) { return 0; }
270 static inline int snd_minor_info_oss_done(void) { return 0; }
271 #endif
272 
273 /* memory.c */
274 
275 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
276 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
277 
278 /* init.c */
279 
280 extern struct snd_card *snd_cards[SNDRV_CARDS];
281 int snd_card_locked(int card);
282 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
283 #define SND_MIXER_OSS_NOTIFY_REGISTER   0
284 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
285 #define SND_MIXER_OSS_NOTIFY_FREE       2
286 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
287 #endif
288 
289 int snd_card_create(int idx, const char *id,
290                     struct module *module, int extra_size,
291                     struct snd_card **card_ret);
292 
293 int snd_card_disconnect(struct snd_card *card);
294 int snd_card_free(struct snd_card *card);
295 int snd_card_free_when_closed(struct snd_card *card);
296 void snd_card_set_id(struct snd_card *card, const char *id);
297 int snd_card_register(struct snd_card *card);
298 int snd_card_info_init(void);
299 int snd_card_info_done(void);
300 int snd_component_add(struct snd_card *card, const char *component);
301 int snd_card_file_add(struct snd_card *card, struct file *file);
302 int snd_card_file_remove(struct snd_card *card, struct file *file);
303 void snd_card_unref(struct snd_card *card);
304 
305 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
306 
307 /* device.c */
308 
309 int snd_device_new(struct snd_card *card, snd_device_type_t type,
310                    void *device_data, struct snd_device_ops *ops);
311 int snd_device_register(struct snd_card *card, void *device_data);
312 int snd_device_register_all(struct snd_card *card);
313 int snd_device_disconnect(struct snd_card *card, void *device_data);
314 int snd_device_disconnect_all(struct snd_card *card);
315 int snd_device_free(struct snd_card *card, void *device_data);
316 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
317 
318 /* isadma.c */
319 
320 #ifdef CONFIG_ISA_DMA_API
321 #define DMA_MODE_NO_ENABLE      0x0100
322 
323 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
324 void snd_dma_disable(unsigned long dma);
325 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
326 #endif
327 
328 /* misc.c */
329 struct resource;
330 void release_and_free_resource(struct resource *res);
331 
332 /* --- */
333 
334 /* sound printk debug levels */
335 enum {
336         SND_PR_ALWAYS,
337         SND_PR_DEBUG,
338         SND_PR_VERBOSE,
339 };
340 
341 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
342 __printf(4, 5)
343 void __snd_printk(unsigned int level, const char *file, int line,
344                   const char *format, ...);
345 #else
346 #define __snd_printk(level, file, line, format, args...) \
347         printk(format, ##args)
348 #endif
349 
350 /**
351  * snd_printk - printk wrapper
352  * @fmt: format string
353  *
354  * Works like printk() but prints the file and the line of the caller
355  * when configured with CONFIG_SND_VERBOSE_PRINTK.
356  */
357 #define snd_printk(fmt, args...) \
358         __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
359 
360 #ifdef CONFIG_SND_DEBUG
361 /**
362  * snd_printd - debug printk
363  * @fmt: format string
364  *
365  * Works like snd_printk() for debugging purposes.
366  * Ignored when CONFIG_SND_DEBUG is not set.
367  */
368 #define snd_printd(fmt, args...) \
369         __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
370 #define _snd_printd(level, fmt, args...) \
371         __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
372 
373 /**
374  * snd_BUG - give a BUG warning message and stack trace
375  *
376  * Calls WARN() if CONFIG_SND_DEBUG is set.
377  * Ignored when CONFIG_SND_DEBUG is not set.
378  */
379 #define snd_BUG()               WARN(1, "BUG?\n")
380 
381 /**
382  * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
383  */
384 #define snd_printd_ratelimit() printk_ratelimit()
385 
386 /**
387  * snd_BUG_ON - debugging check macro
388  * @cond: condition to evaluate
389  *
390  * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
391  * otherwise just evaluates the conditional and returns the value.
392  */
393 #define snd_BUG_ON(cond)        WARN_ON((cond))
394 
395 #else /* !CONFIG_SND_DEBUG */
396 
397 __printf(1, 2)
398 static inline void snd_printd(const char *format, ...) {}
399 __printf(2, 3)
400 static inline void _snd_printd(int level, const char *format, ...) {}
401 
402 #define snd_BUG()                       do { } while (0)
403 
404 #define snd_BUG_ON(condition) ({ \
405         int __ret_warn_on = !!(condition); \
406         unlikely(__ret_warn_on); \
407 })
408 
409 static inline bool snd_printd_ratelimit(void) { return false; }
410 
411 #endif /* CONFIG_SND_DEBUG */
412 
413 #ifdef CONFIG_SND_DEBUG_VERBOSE
414 /**
415  * snd_printdd - debug printk
416  * @format: format string
417  *
418  * Works like snd_printk() for debugging purposes.
419  * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
420  */
421 #define snd_printdd(format, args...) \
422         __snd_printk(2, __FILE__, __LINE__, format, ##args)
423 #else
424 __printf(1, 2)
425 static inline void snd_printdd(const char *format, ...) {}
426 #endif
427 
428 
429 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
430 
431 /* for easier backward-porting */
432 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
433 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
434 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
435 #define gameport_get_port_data(gp) (gp)->port_data
436 #endif
437 
438 #ifdef CONFIG_PCI
439 /* PCI quirk list helper */
440 struct snd_pci_quirk {
441         unsigned short subvendor;       /* PCI subvendor ID */
442         unsigned short subdevice;       /* PCI subdevice ID */
443         unsigned short subdevice_mask;  /* bitmask to match */
444         int value;                      /* value */
445 #ifdef CONFIG_SND_DEBUG_VERBOSE
446         const char *name;               /* name of the device (optional) */
447 #endif
448 };
449 
450 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
451         .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
452 #define _SND_PCI_QUIRK_ID(vend, dev) \
453         _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
454 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
455 #ifdef CONFIG_SND_DEBUG_VERBOSE
456 #define SND_PCI_QUIRK(vend,dev,xname,val) \
457         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
458 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
459         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
460 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
461         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),                       \
462                         .value = (val), .name = (xname)}
463 #define snd_pci_quirk_name(q)   ((q)->name)
464 #else
465 #define SND_PCI_QUIRK(vend,dev,xname,val) \
466         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
467 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
468         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
469 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
470         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
471 #define snd_pci_quirk_name(q)   ""
472 #endif
473 
474 const struct snd_pci_quirk *
475 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
476 
477 const struct snd_pci_quirk *
478 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
479                         const struct snd_pci_quirk *list);
480 #endif
481 
482 #endif /* __SOUND_CORE_H */
483 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp