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 */
  28 struct pci_dev;
  29 struct module;
  30 struct completion;
  31
  32 /* device allocation stuff */
  33
  34 /* type of the object used in snd_device_*()
  35  * this also defines the calling order
  36  */
  37 enum 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
  52 enum snd_device_state {
  53         SNDRV_DEV_BUILD,
  54         SNDRV_DEV_REGISTERED,
  55         SNDRV_DEV_DISCONNECTED,
  56 };
  57
  58 struct snd_device;
  59
  60 struct 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
  66 struct 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         const 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
  79 struct 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         int sync_irq;                   /* assigned irq, used for PCM sync */
 121         wait_queue_head_t remove_sleep;
 122
 123         size_t total_pcm_alloc_bytes;   /* total amount of allocated buffers */
 124         struct mutex memory_mutex;      /* protection for the above */
 125
 126 #ifdef CONFIG_PM
 127         unsigned int power_state;       /* power state */
 128         wait_queue_head_t power_sleep;
 129 #endif
 130
 131 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 132         struct snd_mixer_oss *mixer_oss;
 133         int mixer_oss_change_count;
 134 #endif
 135 };
 136
 137 #define dev_to_snd_card(p)      container_of(p, struct snd_card, card_dev)
 138
 139 #ifdef CONFIG_PM
 140 static inline unsigned int snd_power_get_state(struct snd_card *card)
 141 {
 142         return card->power_state;
 143 }
 144
 145 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
 146 {
 147         card->power_state = state;
 148         wake_up(&card->power_sleep);
 149 }
 150
 151 /* init.c */
 152 int snd_power_wait(struct snd_card *card, unsigned int power_state);
 153
 154 #else /* ! CONFIG_PM */
 155
 156 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
 157 #define snd_power_get_state(card)       ({ (void)(card); SNDRV_CTL_POWER_D0; })
 158 #define snd_power_change_state(card, state)     do { (void)(card); } while (0)
 159
 160 #endif /* CONFIG_PM */
 161
 162 struct snd_minor {
 163         int type;                       /* SNDRV_DEVICE_TYPE_XXX */
 164         int card;                       /* card number */
 165         int device;                     /* device number */
 166         const struct file_operations *f_ops;    /* file operations */
 167         void *private_data;             /* private data for f_ops->open */
 168         struct device *dev;             /* device for sysfs */
 169         struct snd_card *card_ptr;      /* assigned card instance */
 170 };
 171
 172 /* return a device pointer linked to each sound device as a parent */
 173 static inline struct device *snd_card_get_device_link(struct snd_card *card)
 174 {
 175         return card ? &card->card_dev : NULL;
 176 }
 177
 178 /* sound.c */
 179
 180 extern int snd_major;
 181 extern int snd_ecards_limit;
 182 extern struct class *sound_class;
 183
 184 void snd_request_card(int card);
 185
 186 void snd_device_initialize(struct device *dev, struct snd_card *card);
 187
 188 int snd_register_device(int type, struct snd_card *card, int dev,
 189                         const struct file_operations *f_ops,
 190                         void *private_data, struct device *device);
 191 int snd_unregister_device(struct device *dev);
 192 void *snd_lookup_minor_data(unsigned int minor, int type);
 193
 194 #ifdef CONFIG_SND_OSSEMUL
 195 int snd_register_oss_device(int type, struct snd_card *card, int dev,
 196                             const struct file_operations *f_ops, void *private_data);
 197 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
 198 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
 199 #endif
 200
 201 int snd_minor_info_init(void);
 202
 203 /* sound_oss.c */
 204
 205 #ifdef CONFIG_SND_OSSEMUL
 206 int snd_minor_info_oss_init(void);
 207 #else
 208 static inline int snd_minor_info_oss_init(void) { return 0; }
 209 #endif
 210
 211 /* memory.c */
 212
 213 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
 214 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
 215
 216 /* init.c */
 217
 218 int snd_card_locked(int card);
 219 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 220 #define SND_MIXER_OSS_NOTIFY_REGISTER   0
 221 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
 222 #define SND_MIXER_OSS_NOTIFY_FREE       2
 223 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
 224 #endif
 225
 226 int snd_card_new(struct device *parent, int idx, const char *xid,
 227                  struct module *module, int extra_size,
 228                  struct snd_card **card_ret);
 229
 230 int snd_card_disconnect(struct snd_card *card);
 231 void snd_card_disconnect_sync(struct snd_card *card);
 232 int snd_card_free(struct snd_card *card);
 233 int snd_card_free_when_closed(struct snd_card *card);
 234 void snd_card_set_id(struct snd_card *card, const char *id);
 235 int snd_card_register(struct snd_card *card);
 236 int snd_card_info_init(void);
 237 int snd_card_add_dev_attr(struct snd_card *card,
 238                           const struct attribute_group *group);
 239 int snd_component_add(struct snd_card *card, const char *component);
 240 int snd_card_file_add(struct snd_card *card, struct file *file);
 241 int snd_card_file_remove(struct snd_card *card, struct file *file);
 242
 243 struct snd_card *snd_card_ref(int card);
 244
 245 /**
 246  * snd_card_unref - Unreference the card object
 247  * @card: the card object to unreference
 248  *
 249  * Call this function for the card object that was obtained via snd_card_ref()
 250  * or snd_lookup_minor_data().
 251  */
 252 static inline void snd_card_unref(struct snd_card *card)
 253 {
 254         put_device(&card->card_dev);
 255 }
 256
 257 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
 258
 259 /* device.c */
 260
 261 int snd_device_new(struct snd_card *card, enum snd_device_type type,
 262                    void *device_data, const struct snd_device_ops *ops);
 263 int snd_device_register(struct snd_card *card, void *device_data);
 264 int snd_device_register_all(struct snd_card *card);
 265 void snd_device_disconnect(struct snd_card *card, void *device_data);
 266 void snd_device_disconnect_all(struct snd_card *card);
 267 void snd_device_free(struct snd_card *card, void *device_data);
 268 void snd_device_free_all(struct snd_card *card);
 269
 270 /* isadma.c */
 271
 272 #ifdef CONFIG_ISA_DMA_API
 273 #define DMA_MODE_NO_ENABLE      0x0100
 274
 275 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
 276 void snd_dma_disable(unsigned long dma);
 277 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
 278 #endif
 279
 280 /* misc.c */
 281 struct resource;
 282 void release_and_free_resource(struct resource *res);
 283
 284 /* --- */
 285
 286 /* sound printk debug levels */
 287 enum {
 288         SND_PR_ALWAYS,
 289         SND_PR_DEBUG,
 290         SND_PR_VERBOSE,
 291 };
 292
 293 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
 294 __printf(4, 5)
 295 void __snd_printk(unsigned int level, const char *file, int line,
 296                   const char *format, ...);
 297 #else
 298 #define __snd_printk(level, file, line, format, ...) \
 299         printk(format, ##__VA_ARGS__)
 300 #endif
 301
 302 /**
 303  * snd_printk - printk wrapper
 304  * @fmt: format string
 305  *
 306  * Works like printk() but prints the file and the line of the caller
 307  * when configured with CONFIG_SND_VERBOSE_PRINTK.
 308  */
 309 #define snd_printk(fmt, ...) \
 310         __snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
 311
 312 #ifdef CONFIG_SND_DEBUG
 313 /**
 314  * snd_printd - debug printk
 315  * @fmt: format string
 316  *
 317  * Works like snd_printk() for debugging purposes.
 318  * Ignored when CONFIG_SND_DEBUG is not set.
 319  */
 320 #define snd_printd(fmt, ...) \
 321         __snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
 322 #define _snd_printd(level, fmt, ...) \
 323         __snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
 324
 325 /**
 326  * snd_BUG - give a BUG warning message and stack trace
 327  *
 328  * Calls WARN() if CONFIG_SND_DEBUG is set.
 329  * Ignored when CONFIG_SND_DEBUG is not set.
 330  */
 331 #define snd_BUG()               WARN(1, "BUG?\n")
 332
 333 /**
 334  * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
 335  */
 336 #define snd_printd_ratelimit() printk_ratelimit()
 337
 338 /**
 339  * snd_BUG_ON - debugging check macro
 340  * @cond: condition to evaluate
 341  *
 342  * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
 343  * otherwise just evaluates the conditional and returns the value.
 344  */
 345 #define snd_BUG_ON(cond)        WARN_ON((cond))
 346
 347 #else /* !CONFIG_SND_DEBUG */
 348
 349 __printf(1, 2)
 350 static inline void snd_printd(const char *format, ...) {}
 351 __printf(2, 3)
 352 static inline void _snd_printd(int level, const char *format, ...) {}
 353
 354 #define snd_BUG()                       do { } while (0)
 355
 356 #define snd_BUG_ON(condition) ({ \
 357         int __ret_warn_on = !!(condition); \
 358         unlikely(__ret_warn_on); \
 359 })
 360
 361 static inline bool snd_printd_ratelimit(void) { return false; }
 362
 363 #endif /* CONFIG_SND_DEBUG */
 364
 365 #ifdef CONFIG_SND_DEBUG_VERBOSE
 366 /**
 367  * snd_printdd - debug printk
 368  * @format: format string
 369  *
 370  * Works like snd_printk() for debugging purposes.
 371  * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
 372  */
 373 #define snd_printdd(format, ...) \
 374         __snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
 375 #else
 376 __printf(1, 2)
 377 static inline void snd_printdd(const char *format, ...) {}
 378 #endif
 379
 380
 381 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
 382
 383 /* for easier backward-porting */
 384 #if IS_ENABLED(CONFIG_GAMEPORT)
 385 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
 386 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
 387 #define gameport_get_port_data(gp) (gp)->port_data
 388 #endif
 389
 390 /* PCI quirk list helper */
 391 struct snd_pci_quirk {
 392         unsigned short subvendor;       /* PCI subvendor ID */
 393         unsigned short subdevice;       /* PCI subdevice ID */
 394         unsigned short subdevice_mask;  /* bitmask to match */
 395         int value;                      /* value */
 396 #ifdef CONFIG_SND_DEBUG_VERBOSE
 397         const char *name;               /* name of the device (optional) */
 398 #endif
 399 };
 400
 401 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
 402         .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
 403 #define _SND_PCI_QUIRK_ID(vend, dev) \
 404         _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
 405 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
 406 #ifdef CONFIG_SND_DEBUG_VERBOSE
 407 #define SND_PCI_QUIRK(vend,dev,xname,val) \
 408         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
 409 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 410         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
 411 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 412         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),                       \
 413                         .value = (val), .name = (xname)}
 414 #define snd_pci_quirk_name(q)   ((q)->name)
 415 #else
 416 #define SND_PCI_QUIRK(vend,dev,xname,val) \
 417         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
 418 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 419         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
 420 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 421         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
 422 #define snd_pci_quirk_name(q)   ""
 423 #endif
 424
 425 #ifdef CONFIG_PCI
 426 const struct snd_pci_quirk *
 427 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
 428
 429 const struct snd_pci_quirk *
 430 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
 431                         const struct snd_pci_quirk *list);
 432 #else
 433 static inline const struct snd_pci_quirk *
 434 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
 435 {
 436         return NULL;
 437 }
 438
 439 static inline const struct snd_pci_quirk *
 440 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
 441                         const struct snd_pci_quirk *list)
 442 {
 443         return NULL;
 444 }
 445 #endif
 446
 447 #endif /* __SOUND_CORE_H */