kernel/include/sound/core.h

   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 mixername[80];             /* mixer name */
 103         char components[128];           /* card components delimited with
 104                                                                 space */
 105         struct module *module;          /* top-level module */
 106
 107         void *private_data;             /* private data for soundcard */
 108         void (*private_free) (struct snd_card *card); /* callback for freeing of
 109                                                                 private data */
 110         struct list_head devices;       /* devices */
 111
 112         struct device ctl_dev;          /* control device */
 113         unsigned int last_numid;        /* last used numeric ID */
 114         struct rw_semaphore controls_rwsem;     /* controls list lock */
 115         rwlock_t ctl_files_rwlock;      /* ctl_files list lock */
 116         int controls_count;             /* count of all controls */
 117         int user_ctl_count;             /* count of all user controls */
 118         struct list_head controls;      /* all controls for this card */
 119         struct list_head ctl_files;     /* active control files */
 120         struct mutex user_ctl_lock;     /* protects user controls against
 121                                            concurrent access */
 122
 123         struct snd_info_entry *proc_root;       /* root for soundcard specific files */
 124         struct snd_info_entry *proc_id; /* the card id */
 125         struct proc_dir_entry *proc_root_link;  /* number link to real id */
 126
 127         struct list_head files_list;    /* all files associated to this card */
 128         struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
 129                                                                 state */
 130         spinlock_t files_lock;          /* lock the files for this card */
 131         int shutdown;                   /* this card is going down */
 132         struct completion *release_completion;
 133         struct device *dev;             /* device assigned to this card */
 134         struct device card_dev;         /* cardX object for sysfs */
 135         const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
 136         bool registered;                /* card_dev is registered? */
 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 #define dev_to_snd_card(p)      container_of(p, struct snd_card, card_dev)
 151
 152 #ifdef CONFIG_PM
 153 static inline void snd_power_lock(struct snd_card *card)
 154 {
 155         mutex_lock(&card->power_lock);
 156 }
 157
 158 static inline void snd_power_unlock(struct snd_card *card)
 159 {
 160         mutex_unlock(&card->power_lock);
 161 }
 162
 163 static inline unsigned int snd_power_get_state(struct snd_card *card)
 164 {
 165         return card->power_state;
 166 }
 167
 168 static 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 */
 175 int 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)
 181 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
 182 #define snd_power_get_state(card)       ({ (void)(card); SNDRV_CTL_POWER_D0; })
 183 #define snd_power_change_state(card, state)     do { (void)(card); } while (0)
 184
 185 #endif /* CONFIG_PM */
 186
 187 struct 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         struct snd_card *card_ptr;      /* assigned card instance */
 195 };
 196
 197 /* return a device pointer linked to each sound device as a parent */
 198 static inline struct device *snd_card_get_device_link(struct snd_card *card)
 199 {
 200         return card ? &card->card_dev : NULL;
 201 }
 202
 203 /* sound.c */
 204
 205 extern int snd_major;
 206 extern int snd_ecards_limit;
 207 extern struct class *sound_class;
 208
 209 void snd_request_card(int card);
 210
 211 void snd_device_initialize(struct device *dev, struct snd_card *card);
 212
 213 int snd_register_device(int type, struct snd_card *card, int dev,
 214                         const struct file_operations *f_ops,
 215                         void *private_data, struct device *device);
 216 int snd_unregister_device(struct device *dev);
 217 void *snd_lookup_minor_data(unsigned int minor, int type);
 218
 219 #ifdef CONFIG_SND_OSSEMUL
 220 int snd_register_oss_device(int type, struct snd_card *card, int dev,
 221                             const struct file_operations *f_ops, void *private_data);
 222 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
 223 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
 224 #endif
 225
 226 int snd_minor_info_init(void);
 227 int snd_minor_info_done(void);
 228
 229 /* sound_oss.c */
 230
 231 #ifdef CONFIG_SND_OSSEMUL
 232 int snd_minor_info_oss_init(void);
 233 int snd_minor_info_oss_done(void);
 234 #else
 235 static inline int snd_minor_info_oss_init(void) { return 0; }
 236 static inline int snd_minor_info_oss_done(void) { return 0; }
 237 #endif
 238
 239 /* memory.c */
 240
 241 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
 242 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
 243
 244 /* init.c */
 245
 246 extern struct snd_card *snd_cards[SNDRV_CARDS];
 247 int snd_card_locked(int card);
 248 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
 249 #define SND_MIXER_OSS_NOTIFY_REGISTER   0
 250 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
 251 #define SND_MIXER_OSS_NOTIFY_FREE       2
 252 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
 253 #endif
 254
 255 int snd_card_new(struct device *parent, int idx, const char *xid,
 256                  struct module *module, int extra_size,
 257                  struct snd_card **card_ret);
 258
 259 int snd_card_disconnect(struct snd_card *card);
 260 int snd_card_free(struct snd_card *card);
 261 int snd_card_free_when_closed(struct snd_card *card);
 262 void snd_card_set_id(struct snd_card *card, const char *id);
 263 int snd_card_register(struct snd_card *card);
 264 int snd_card_info_init(void);
 265 int snd_card_info_done(void);
 266 int snd_card_add_dev_attr(struct snd_card *card,
 267                           const struct attribute_group *group);
 268 int snd_component_add(struct snd_card *card, const char *component);
 269 int snd_card_file_add(struct snd_card *card, struct file *file);
 270 int snd_card_file_remove(struct snd_card *card, struct file *file);
 271 #define snd_card_unref(card)    put_device(&(card)->card_dev)
 272
 273 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
 274
 275 /* device.c */
 276
 277 int snd_device_new(struct snd_card *card, enum snd_device_type type,
 278                    void *device_data, struct snd_device_ops *ops);
 279 int snd_device_register(struct snd_card *card, void *device_data);
 280 int snd_device_register_all(struct snd_card *card);
 281 void snd_device_disconnect(struct snd_card *card, void *device_data);
 282 void snd_device_disconnect_all(struct snd_card *card);
 283 void snd_device_free(struct snd_card *card, void *device_data);
 284 void snd_device_free_all(struct snd_card *card);
 285
 286 /* isadma.c */
 287
 288 #ifdef CONFIG_ISA_DMA_API
 289 #define DMA_MODE_NO_ENABLE      0x0100
 290
 291 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
 292 void snd_dma_disable(unsigned long dma);
 293 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
 294 #endif
 295
 296 /* misc.c */
 297 struct resource;
 298 void release_and_free_resource(struct resource *res);
 299
 300 /* --- */
 301
 302 /* sound printk debug levels */
 303 enum {
 304         SND_PR_ALWAYS,
 305         SND_PR_DEBUG,
 306         SND_PR_VERBOSE,
 307 };
 308
 309 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
 310 __printf(4, 5)
 311 void __snd_printk(unsigned int level, const char *file, int line,
 312                   const char *format, ...);
 313 #else
 314 #define __snd_printk(level, file, line, format, args...) \
 315         printk(format, ##args)
 316 #endif
 317
 318 /**
 319  * snd_printk - printk wrapper
 320  * @fmt: format string
 321  *
 322  * Works like printk() but prints the file and the line of the caller
 323  * when configured with CONFIG_SND_VERBOSE_PRINTK.
 324  */
 325 #define snd_printk(fmt, args...) \
 326         __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
 327
 328 #ifdef CONFIG_SND_DEBUG
 329 /**
 330  * snd_printd - debug printk
 331  * @fmt: format string
 332  *
 333  * Works like snd_printk() for debugging purposes.
 334  * Ignored when CONFIG_SND_DEBUG is not set.
 335  */
 336 #define snd_printd(fmt, args...) \
 337         __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
 338 #define _snd_printd(level, fmt, args...) \
 339         __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
 340
 341 /**
 342  * snd_BUG - give a BUG warning message and stack trace
 343  *
 344  * Calls WARN() if CONFIG_SND_DEBUG is set.
 345  * Ignored when CONFIG_SND_DEBUG is not set.
 346  */
 347 #define snd_BUG()               WARN(1, "BUG?\n")
 348
 349 /**
 350  * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
 351  */
 352 #define snd_printd_ratelimit() printk_ratelimit()
 353
 354 /**
 355  * snd_BUG_ON - debugging check macro
 356  * @cond: condition to evaluate
 357  *
 358  * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
 359  * otherwise just evaluates the conditional and returns the value.
 360  */
 361 #define snd_BUG_ON(cond)        WARN_ON((cond))
 362
 363 #else /* !CONFIG_SND_DEBUG */
 364
 365 __printf(1, 2)
 366 static inline void snd_printd(const char *format, ...) {}
 367 __printf(2, 3)
 368 static inline void _snd_printd(int level, const char *format, ...) {}
 369
 370 #define snd_BUG()                       do { } while (0)
 371
 372 #define snd_BUG_ON(condition) ({ \
 373         int __ret_warn_on = !!(condition); \
 374         unlikely(__ret_warn_on); \
 375 })
 376
 377 static inline bool snd_printd_ratelimit(void) { return false; }
 378
 379 #endif /* CONFIG_SND_DEBUG */
 380
 381 #ifdef CONFIG_SND_DEBUG_VERBOSE
 382 /**
 383  * snd_printdd - debug printk
 384  * @format: format string
 385  *
 386  * Works like snd_printk() for debugging purposes.
 387  * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
 388  */
 389 #define snd_printdd(format, args...) \
 390         __snd_printk(2, __FILE__, __LINE__, format, ##args)
 391 #else
 392 __printf(1, 2)
 393 static inline void snd_printdd(const char *format, ...) {}
 394 #endif
 395
 396
 397 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
 398
 399 /* for easier backward-porting */
 400 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
 401 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
 402 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
 403 #define gameport_get_port_data(gp) (gp)->port_data
 404 #endif
 405
 406 /* PCI quirk list helper */
 407 struct snd_pci_quirk {
 408         unsigned short subvendor;       /* PCI subvendor ID */
 409         unsigned short subdevice;       /* PCI subdevice ID */
 410         unsigned short subdevice_mask;  /* bitmask to match */
 411         int value;                      /* value */
 412 #ifdef CONFIG_SND_DEBUG_VERBOSE
 413         const char *name;               /* name of the device (optional) */
 414 #endif
 415 };
 416
 417 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
 418         .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
 419 #define _SND_PCI_QUIRK_ID(vend, dev) \
 420         _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
 421 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
 422 #ifdef CONFIG_SND_DEBUG_VERBOSE
 423 #define SND_PCI_QUIRK(vend,dev,xname,val) \
 424         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
 425 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 426         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
 427 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 428         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),                       \
 429                         .value = (val), .name = (xname)}
 430 #define snd_pci_quirk_name(q)   ((q)->name)
 431 #else
 432 #define SND_PCI_QUIRK(vend,dev,xname,val) \
 433         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
 434 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 435         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
 436 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 437         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
 438 #define snd_pci_quirk_name(q)   ""
 439 #endif
 440
 441 #ifdef CONFIG_PCI
 442 const struct snd_pci_quirk *
 443 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
 444
 445 const struct snd_pci_quirk *
 446 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
 447                         const struct snd_pci_quirk *list);
 448 #else
 449 static inline const struct snd_pci_quirk *
 450 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
 451 {
 452         return NULL;
 453 }
 454
 455 static inline const struct snd_pci_quirk *
 456 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
 457                         const struct snd_pci_quirk *list)
 458 {
 459         return NULL;
 460 }
 461 #endif
 462
 463 #endif /* __SOUND_CORE_H */