LXR linux/include/sound/core.h

   1/* SPDX-License-Identifier: GPL-2.0-or-later */
   2#ifndef __SOUND_CORE_H
   3#define __SOUND_CORE_H
   4
   5/*
   6 *  Main header file for the ALSA driver
   7 *  Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
   8 */
   9
  10#include <linux/device.h>
  11#include <linux/sched.h>                /* wake_up() */
  12#include <linux/mutex.h>                /* struct mutex */
  13#include <linux/rwsem.h>                /* struct rw_semaphore */
  14#include <linux/pm.h>                   /* pm_message_t */
  15#include <linux/stringify.h>
  16#include <linux/printk.h>
  17
  18/* number of supported soundcards */
  19#ifdef CONFIG_SND_DYNAMIC_MINORS
  20#define SNDRV_CARDS CONFIG_SND_MAX_CARDS
  21#else
  22#define SNDRV_CARDS 8           /* don't change - minor numbers */
  23#endif
  24
  25#define CONFIG_SND_MAJOR        116     /* standard configuration */
  26
  27/* forward declarations */
  28struct pci_dev;
  29struct module;
  30struct completion;
  31
  32/* device allocation stuff */
  33
  34/* type of the object used in snd_device_*()
  35 * this also defines the calling order
  36 */
  37enum snd_device_type {
  38        SNDRV_DEV_LOWLEVEL,
  39        SNDRV_DEV_INFO,
  40        SNDRV_DEV_BUS,
  41        SNDRV_DEV_CODEC,
  42        SNDRV_DEV_PCM,
  43        SNDRV_DEV_COMPRESS,
  44        SNDRV_DEV_RAWMIDI,
  45        SNDRV_DEV_TIMER,
  46        SNDRV_DEV_SEQUENCER,
  47        SNDRV_DEV_HWDEP,
  48        SNDRV_DEV_JACK,
  49        SNDRV_DEV_CONTROL,      /* NOTE: this must be the last one */
  50};
  51
  52enum snd_device_state {
  53        SNDRV_DEV_BUILD,
  54        SNDRV_DEV_REGISTERED,
  55        SNDRV_DEV_DISCONNECTED,
  56};
  57
  58struct snd_device;
  59
  60struct snd_device_ops {
  61        int (*dev_free)(struct snd_device *dev);
  62        int (*dev_register)(struct snd_device *dev);
  63        int (*dev_disconnect)(struct snd_device *dev);
  64};
  65
  66struct snd_device {
  67        struct list_head list;          /* list of registered devices */
  68        struct snd_card *card;          /* card which holds this device */
  69        enum snd_device_state state;    /* state of the device */
  70        enum snd_device_type type;      /* device type */
  71        void *device_data;              /* device structure */
  72        struct snd_device_ops *ops;     /* operations */
  73};
  74
  75#define snd_device(n) list_entry(n, struct snd_device, list)
  76
  77/* main structure for soundcard */
  78
  79struct snd_card {
  80        int number;                     /* number of soundcard (index to
  81                                                                snd_cards) */
  82
  83        char id[16];                    /* id string of this card */
  84        char driver[16];                /* driver name */
  85        char shortname[32];             /* short name of this soundcard */
  86        char longname[80];              /* name of this soundcard */
  87        char irq_descr[32];             /* Interrupt description */
  88        char mixername[80];             /* mixer name */
  89        char components[128];           /* card components delimited with
  90                                                                space */
  91        struct module *module;          /* top-level module */
  92
  93        void *private_data;             /* private data for soundcard */
  94        void (*private_free) (struct snd_card *card); /* callback for freeing of
  95                                                                private data */
  96        struct list_head devices;       /* devices */
  97
  98        struct device ctl_dev;          /* control device */
  99        unsigned int last_numid;        /* last used numeric ID */
 100        struct rw_semaphore controls_rwsem;     /* controls list lock */
 101        rwlock_t ctl_files_rwlock;      /* ctl_files list lock */
 102        int controls_count;             /* count of all controls */
 103        int user_ctl_count;             /* count of all user controls */
 104        struct list_head controls;      /* all controls for this card */
 105        struct list_head ctl_files;     /* active control files */
 106
 107        struct snd_info_entry *proc_root;       /* root for soundcard specific files */
 108        struct proc_dir_entry *proc_root_link;  /* number link to real id */
 109
 110        struct list_head files_list;    /* all files associated to this card */
 111        struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
 112                                                                state */
 113        spinlock_t files_lock;          /* lock the files for this card */
 114        int shutdown;                   /* this card is going down */
 115        struct completion *release_completion;
 116        struct device *dev;             /* device assigned to this card */
 117        struct device card_dev;         /* cardX object for sysfs */
 118        const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
 119        bool registered;                /* card_dev is registered? */
 120        wait_queue_head_t remove_sleep;
 121
 122#ifdef CONFIG_PM
 123        unsigned int power_state;       /* power state */
 124        wait_queue_head_t power_sleep;
 125#endif
 126
 127#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 128        struct snd_mixer_oss *mixer_oss;
 129        int mixer_oss_change_count;
 130#endif
 131};
 132
 133#define dev_to_snd_card(p)      container_of(p, struct snd_card, card_dev)
 134
 135#ifdef CONFIG_PM
 136static inline unsigned int snd_power_get_state(struct snd_card *card)
 137{
 138        return card->power_state;
 139}
 140
 141static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
 142{
 143        card->power_state = state;
 144        wake_up(&card->power_sleep);
 145}
 146
 147/* init.c */
 148int snd_power_wait(struct snd_card *card, unsigned int power_state);
 149
 150#else /* ! CONFIG_PM */
 151
 152static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
 153#define snd_power_get_state(card)       ({ (void)(card); SNDRV_CTL_POWER_D0; })
 154#define snd_power_change_state(card, state)     do { (void)(card); } while (0)
 155
 156#endif /* CONFIG_PM */
 157
 158struct snd_minor {
 159        int type;                       /* SNDRV_DEVICE_TYPE_XXX */
 160        int card;                       /* card number */
 161        int device;                     /* device number */
 162        const struct file_operations *f_ops;    /* file operations */
 163        void *private_data;             /* private data for f_ops->open */
 164        struct device *dev;             /* device for sysfs */
 165        struct snd_card *card_ptr;      /* assigned card instance */
 166};
 167
 168/* return a device pointer linked to each sound device as a parent */
 169static inline struct device *snd_card_get_device_link(struct snd_card *card)
 170{
 171        return card ? &card->card_dev : NULL;
 172}
 173
 174/* sound.c */
 175
 176extern int snd_major;
 177extern int snd_ecards_limit;
 178extern struct class *sound_class;
 179
 180void snd_request_card(int card);
 181
 182void snd_device_initialize(struct device *dev, struct snd_card *card);
 183
 184int snd_register_device(int type, struct snd_card *card, int dev,
 185                        const struct file_operations *f_ops,
 186                        void *private_data, struct device *device);
 187int snd_unregister_device(struct device *dev);
 188void *snd_lookup_minor_data(unsigned int minor, int type);
 189
 190#ifdef CONFIG_SND_OSSEMUL
 191int snd_register_oss_device(int type, struct snd_card *card, int dev,
 192                            const struct file_operations *f_ops, void *private_data);
 193int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
 194void *snd_lookup_oss_minor_data(unsigned int minor, int type);
 195#endif
 196
 197int snd_minor_info_init(void);
 198
 199/* sound_oss.c */
 200
 201#ifdef CONFIG_SND_OSSEMUL
 202int snd_minor_info_oss_init(void);
 203#else
 204static inline int snd_minor_info_oss_init(void) { return 0; }
 205#endif
 206
 207/* memory.c */
 208
 209int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
 210int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
 211
 212/* init.c */
 213
 214int snd_card_locked(int card);
 215#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 216#define SND_MIXER_OSS_NOTIFY_REGISTER   0
 217#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
 218#define SND_MIXER_OSS_NOTIFY_FREE       2
 219extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
 220#endif
 221
 222int snd_card_new(struct device *parent, int idx, const char *xid,
 223                 struct module *module, int extra_size,
 224                 struct snd_card **card_ret);
 225
 226int snd_card_disconnect(struct snd_card *card);
 227void snd_card_disconnect_sync(struct snd_card *card);
 228int snd_card_free(struct snd_card *card);
 229int snd_card_free_when_closed(struct snd_card *card);
 230void snd_card_set_id(struct snd_card *card, const char *id);
 231int snd_card_register(struct snd_card *card);
 232int snd_card_info_init(void);
 233int snd_card_add_dev_attr(struct snd_card *card,
 234                          const struct attribute_group *group);
 235int snd_component_add(struct snd_card *card, const char *component);
 236int snd_card_file_add(struct snd_card *card, struct file *file);
 237int snd_card_file_remove(struct snd_card *card, struct file *file);
 238
 239struct snd_card *snd_card_ref(int card);
 240
 241/**
 242 * snd_card_unref - Unreference the card object
 243 * @card: the card object to unreference
 244 *
 245 * Call this function for the card object that was obtained via snd_card_ref()
 246 * or snd_lookup_minor_data().
 247 */
 248static inline void snd_card_unref(struct snd_card *card)
 249{
 250        put_device(&card->card_dev);
 251}
 252
 253#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
 254
 255/* device.c */
 256
 257int snd_device_new(struct snd_card *card, enum snd_device_type type,
 258                   void *device_data, struct snd_device_ops *ops);
 259int snd_device_register(struct snd_card *card, void *device_data);
 260int snd_device_register_all(struct snd_card *card);
 261void snd_device_disconnect(struct snd_card *card, void *device_data);
 262void snd_device_disconnect_all(struct snd_card *card);
 263void snd_device_free(struct snd_card *card, void *device_data);
 264void snd_device_free_all(struct snd_card *card);
 265
 266/* isadma.c */
 267
 268#ifdef CONFIG_ISA_DMA_API
 269#define DMA_MODE_NO_ENABLE      0x0100
 270
 271void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
 272void snd_dma_disable(unsigned long dma);
 273unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
 274#endif
 275
 276/* misc.c */
 277struct resource;
 278void release_and_free_resource(struct resource *res);
 279
 280/* --- */
 281
 282/* sound printk debug levels */
 283enum {
 284        SND_PR_ALWAYS,
 285        SND_PR_DEBUG,
 286        SND_PR_VERBOSE,
 287};
 288
 289#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
 290__printf(4, 5)
 291void __snd_printk(unsigned int level, const char *file, int line,
 292                  const char *format, ...);
 293#else
 294#define __snd_printk(level, file, line, format, ...) \
 295        printk(format, ##__VA_ARGS__)
 296#endif
 297
 298/**
 299 * snd_printk - printk wrapper
 300 * @fmt: format string
 301 *
 302 * Works like printk() but prints the file and the line of the caller
 303 * when configured with CONFIG_SND_VERBOSE_PRINTK.
 304 */
 305#define snd_printk(fmt, ...) \
 306        __snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
 307
 308#ifdef CONFIG_SND_DEBUG
 309/**
 310 * snd_printd - debug printk
 311 * @fmt: format string
 312 *
 313 * Works like snd_printk() for debugging purposes.
 314 * Ignored when CONFIG_SND_DEBUG is not set.
 315 */
 316#define snd_printd(fmt, ...) \
 317        __snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
 318#define _snd_printd(level, fmt, ...) \
 319        __snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
 320
 321/**
 322 * snd_BUG - give a BUG warning message and stack trace
 323 *
 324 * Calls WARN() if CONFIG_SND_DEBUG is set.
 325 * Ignored when CONFIG_SND_DEBUG is not set.
 326 */
 327#define snd_BUG()               WARN(1, "BUG?\n")
 328
 329/**
 330 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
 331 */
 332#define snd_printd_ratelimit() printk_ratelimit()
 333
 334/**
 335 * snd_BUG_ON - debugging check macro
 336 * @cond: condition to evaluate
 337 *
 338 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
 339 * otherwise just evaluates the conditional and returns the value.
 340 */
 341#define snd_BUG_ON(cond)        WARN_ON((cond))
 342
 343#else /* !CONFIG_SND_DEBUG */
 344
 345__printf(1, 2)
 346static inline void snd_printd(const char *format, ...) {}
 347__printf(2, 3)
 348static inline void _snd_printd(int level, const char *format, ...) {}
 349
 350#define snd_BUG()                       do { } while (0)
 351
 352#define snd_BUG_ON(condition) ({ \
 353        int __ret_warn_on = !!(condition); \
 354        unlikely(__ret_warn_on); \
 355})
 356
 357static inline bool snd_printd_ratelimit(void) { return false; }
 358
 359#endif /* CONFIG_SND_DEBUG */
 360
 361#ifdef CONFIG_SND_DEBUG_VERBOSE
 362/**
 363 * snd_printdd - debug printk
 364 * @format: format string
 365 *
 366 * Works like snd_printk() for debugging purposes.
 367 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
 368 */
 369#define snd_printdd(format, ...) \
 370        __snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
 371#else
 372__printf(1, 2)
 373static inline void snd_printdd(const char *format, ...) {}
 374#endif
 375
 376
 377#define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
 378
 379/* for easier backward-porting */
 380#if IS_ENABLED(CONFIG_GAMEPORT)
 381#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
 382#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
 383#define gameport_get_port_data(gp) (gp)->port_data
 384#endif
 385
 386/* PCI quirk list helper */
 387struct snd_pci_quirk {
 388        unsigned short subvendor;       /* PCI subvendor ID */
 389        unsigned short subdevice;       /* PCI subdevice ID */
 390        unsigned short subdevice_mask;  /* bitmask to match */
 391        int value;                      /* value */
 392#ifdef CONFIG_SND_DEBUG_VERBOSE
 393        const char *name;               /* name of the device (optional) */
 394#endif
 395};
 396
 397#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
 398        .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
 399#define _SND_PCI_QUIRK_ID(vend, dev) \
 400        _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
 401#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
 402#ifdef CONFIG_SND_DEBUG_VERBOSE
 403#define SND_PCI_QUIRK(vend,dev,xname,val) \
 404        {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
 405#define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 406        {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
 407#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 408        {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),                       \
 409                        .value = (val), .name = (xname)}
 410#define snd_pci_quirk_name(q)   ((q)->name)
 411#else
 412#define SND_PCI_QUIRK(vend,dev,xname,val) \
 413        {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
 414#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 415        {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
 416#define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 417        {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
 418#define snd_pci_quirk_name(q)   ""
 419#endif
 420
 421#ifdef CONFIG_PCI
 422const struct snd_pci_quirk *
 423snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
 424
 425const struct snd_pci_quirk *
 426snd_pci_quirk_lookup_id(u16 vendor, u16 device,
 427                        const struct snd_pci_quirk *list);
 428#else
 429static inline const struct snd_pci_quirk *
 430snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
 431{
 432        return NULL;
 433}
 434
 435static inline const struct snd_pci_quirk *
 436snd_pci_quirk_lookup_id(u16 vendor, u16 device,
 437                        const struct snd_pci_quirk *list)
 438{
 439        return NULL;
 440}
 441#endif
 442
 443#endif /* __SOUND_CORE_H */
 444