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